reference > Rule options

dynamic_timeout_max_multiplier

Value

an integer

See also

--dynamic-timeout-max-multiplier, dynamic_timeout

When dynamic_timeout scales this rule's time limit with the size of a file, the factor is the size divided by dynamic_timeout_unit_kb, but never more than this value.

The option requires --allow-rule-timeout-control, like the other timeout options of a rule. A rule that does not set it uses --dynamic-timeout-max-multiplier, whose default is 20.

## Examples

### A 10 KB file with and without a cap

Opengrep logs the limit it sets for each file, as an info message from the semgrep.engine log source, which OPENGREP_LOG_SRCS turns on.

rules:  - id: find-eval    pattern: eval(...)    message: found eval    languages: [python]    severity: WARNING    options:      timeout: 2      dynamic_timeout: true      dynamic_timeout_unit_kb: 1

rules:  - id: find-eval    pattern: eval(...)    message: found eval    languages: [python]    severity: WARNING    options:      timeout: 2      dynamic_timeout: true      dynamic_timeout_unit_kb: 1      dynamic_timeout_max_multiplier: 4

$ python3 -c "open('ten.py','w').write('eval(1)\n' + '#' * 10240 + '\n')"
$ OPENGREP_LOG_SRCS=semgrep.engine opengrep scan --config uncapped.yaml --allow-rule-timeout-control --verbose ten.py 2>&1 | grep -o 'for .* derived from the file size'
for ten.py to 20.02s using a factor of 10.01 derived from the file size
$ OPENGREP_LOG_SRCS=semgrep.engine opengrep scan --config capped.yaml --allow-rule-timeout-control --verbose ten.py 2>&1 | grep -o 'for .* derived from the file size'
for ten.py to 8.00s using a factor of 4.00 derived from the file size

The file is about 10 KB, ten units of 1 KB. The factor of the first rule, 10, is below the default limit of 20; the second rule limits it to 4.