src/rules/suspicious/fuel.bend source

src/rules/suspicious/fuel.bend on the hub · documented module

# rule fuel: a call to a def of the same file, its name then `(`, passes a Nat# literal (`1000n`: digits, then `n`) where that def takes its fuel. A fuel# parameter is known by its name alone (its first lowercase name before the# colon): `fuel`, `gas`, `steps` or `budget`, or any name starting with# `fuel`. The fuel-0 arm returns what it has, so input past the literal comes# out cut short, with no error (a JSON printer that stopped at 1000 tasks).# Inside a law, the checker unrolls the fixed fuel and hangs. Derive the fuel# from the input's size (`Nat.mul(size, 4n)`) or take it as a parameter. A# literal of any size counts, an exact repeat count such as `3n` included.# Only an argument that is one literal token alone counts: `U32.to_nat(1000)`,# a let-bound literal and a parenthesized `(7n)` are not seen. A def's own# calls are exempt: its step passes `fuel - 1`, not a literal.import Baseimport ../../src.bend as Srcimport ../../lazy/lazy.bend as Lazyimport ../../finding.bend as Fimport ../../syntax/lex.bend as Leximport ../../syntax/tree.bend as Treeimport ../../syntax/bind.bend as Bindimport ../calls.bend as Callsimport ../tokens.bend as T# a def of the file and the position of a fuel parametertype Fuel is Data:  Fuel{name: String, at: Nat}# is it a fuel parameter's name?def is_fuel(+nn: String) -> Bool:  Bool.or(String.starts_with(nn, "fuel"),    List.contains(~String, ~String.eq, ["gas", "steps", "budget"], nn))# the fuel parameters among a def's parameters, from position i ondef fuels.params(ps: List<&2, Tree.Node>, +name: String, +ii: Nat) -> List<&2, Fuel>:  match ps:    case Nil{}:      Nil{}    case Con{p, rest}:      +more = fuels.params(rest, name, 1n+ii)      Bool.pick(List<&2, Fuel>, is_fuel(Calls.param_name(p)), Fuel{name, ii} <> more, more)# every fuel parameter of every def of the filedef fuels(ds: List<&2, Calls.Def>) -> List<&2, Fuel>:  match ds:    case Nil{}:      Nil{}    case Con{Calls.Def{name, sig, body}, rest}:      List.append(&2, Fuel, fuels.params(Calls.params(sig), name, 0n), fuels(rest))# an argument that is a Nat literal alone (digits, then `n`), as a findingdef literal(aa: Tree.Node, +path: String) -> List<&2, F.Finding>:  match aa:    case Tree.NCons{Tree.Leaf{Lex.Tok{Lex.TNum{}, +t, l, c}}, Tree.NNil{}}:      Bool.pick(List<&2, F.Finding>, T.nat_ok(String.to_list(t)),        [F.Finding{path, l, c, U32.from_nat(String.length(t)), "fuel",          "The fuel is fixed at " ++ t ++ ", so longer input is silently cut short; derive the fuel from the input size."}],        [])    case other:      Nil{}# a call to name with these arguments, against every fuel parameterdef call(fs: List<&2, Fuel>, +name: String, +as: List<&2, Tree.Node>, +path: String) -> List<&2, F.Finding>:  match fs:    case Nil{}:      Nil{}    case Con{Fuel{+fn, at}, rest}:      +more = call(rest, name, as, path)      Lazy.stop(List<&2, F.Finding>, Bool.not(String.eq(fn, name)), more,        _u => List.append(&2, F.Finding, literal(Calls.arg(as, at), path), more))# every call at any depth of a chain, but the def's own (self)def calls(nn: Tree.Node, +fs: List<&2, Fuel>, +self: String, +path: String) -> List<&2, F.Finding>:  match nn:    case Tree.NCons{Tree.Leaf{Lex.Tok{k, +t, l, c}}, Tree.NCons{Tree.Group{Lex.Tok{_, +o, _, _}, +kids, _}, rest}}:      +more = List.concat(&2, F.Finding, [calls(kids, fs, self, path), calls(rest, fs, self, path)])      +hit = Bool.and(Bool.and(Lex.is_name(k), String.eq(o, "(")), Bool.not(String.eq(t, self)))      Lazy.stop(List<&2, F.Finding>, Bool.not(hit), more,        _u => List.append(&2, F.Finding, call(fs, t, Calls.args(kids), path), more))    case Tree.NCons{Tree.Group{open, kids, close}, rest}:      List.concat(&2, F.Finding, [calls(kids, fs, self, path), calls(rest, fs, self, path)])    case Tree.NCons{Tree.Stmt{kind, kids, body}, rest}:      List.concat(&2, F.Finding, [calls(kids, fs, self, path), calls(body, fs, self, path),        calls(rest, fs, self, path)])    case Tree.NCons{h, rest}:      calls(rest, fs, self, path)    case other:      Nil{}# a def's (or a law's) name, "" when it has nonedef own(mm: Maybe<&2, String>) -> String:  match mm:    case None{}:      ""    case Some{n}:      n# each top-level statement, walked as its own defdef check.go(root: Tree.Node, +fs: List<&2, Fuel>, +path: String) -> List<&2, F.Finding>:  match root:    case Tree.NCons{Tree.Stmt{kind, +kids, body}, rest}:      +self = own(Bind.declared(kids))      List.concat(&2, F.Finding, [calls(kids, fs, self, path), calls(body, fs, self, path), check.go(rest, fs, path)])    case Tree.NCons{h, rest}:      check.go(rest, fs, path)    case other:      Nil{}# the ruledef check(ss: Src.Src) -> List<&2, F.Finding>:  Src.Src{path, text, toks, +tree, bound, items} = ss  check.go(tree, fuels(Calls.defs(tree)), path)