mirror of
https://github.com/DeusData/codebase-memory-mcp.git
synced 2026-11-04 10:48:20 +00:00
Martin Vogel
435a88be62
A worker resource limit is enforced by the supervisor, but only the worker
replaces the serving database, and it does so before the persistence
artifact export. A limit observed in that window stopped a worker that had
already published, and the response still said serving_index_preserved=true
while the previous index had been replaced.
Publication and resource termination now coordinate through a per-attempt
publication fence: a never-created path next to a reserved unique file in
the private worker directory, which both sides claim by creating it
exclusively (cbm_fopen "wbx": O_EXCL on POSIX, CREATE_NEW on Windows), so
exactly one of them can win.
- The worker claims it through a new pipeline publication gate that
cbm_pipeline_run calls once, after the last pre-publication check and
before the serving database is touched. Losing means the supervisor
already stopped the attempt for a limit: the run aborts before
publication and the previous generation stays in place.
- The supervisor claims it before it terminates the worker for a limit or
a failed RSS probe. Losing means the worker already committed to
publishing: the limit is no longer enforced for that attempt, which runs
to completion, and index.supervisor.resource_limit_after_publication is
logged instead. A claim that can be neither won nor lost is retried on
the next poll rather than risk stopping a committed worker.
- At terminal the supervisor settles the fence into
result.publication_committed. An unquiesced tree keeps the fence, so a
surviving member can never publish after the report.
serving_index_preserved now describes the request, not only its last
attempt: a servable index existed when the request began, no attempt of
the request committed to publishing (an earlier attempt can publish and
then crash into recovery), and that index is still servable. The direct
path and the daemon job both fold every attempt into these request facts;
cbm_mcp_index_worker_resource_response takes them as a third argument, and
NULL claims nothing.
The fence path travels as an optional last pair of the exact worker grammar
(--index-worker-publish-fence), accepted by the worker argv parser and by
the daemon bootstrap role check, stripped by the CLI and installed by both
worker entries.
Limits stay opt-in: without index_max_rss_mb or index_max_duration_seconds
there is no fence, no extra argv, no claim and no extra database read.
Graph content is unchanged either way.
RED (c78c077a plus only the new end-to-end test): a FIFO at the artifact
temp path holds the real worker after the rename, and the duration clock
crosses its limit only once the serving database has been replaced. The
supervisor stops the worker there and answers resource_limit_exceeded with
serving_index_preserved=true over a replaced database. GREEN: the worker
claimed first, the supervisor logs the limit as not enforced, and the
released worker finishes and reports the published index.
Signed-off-by: Martin Vogel <martin.vogel.tech@gmail.com>
134 lines
6.2 KiB
Markdown
134 lines
6.2 KiB
Markdown
# Index resource limits
|
|
|
|
Index resource limits are optional operator controls for repositories whose
|
|
discovery breadth or worker runtime is not known in advance. They are disabled
|
|
by default so existing large-repository workloads retain their current behavior.
|
|
|
|
## Discovery settings
|
|
|
|
| Key | Default | Accepted value | Protects |
|
|
|---|---:|---:|---|
|
|
| `index_max_files` | `off` | `off` or `1..10000000` | Accepted source-file count |
|
|
| `index_max_source_mb` | `off` | `off` or `1..1048576` | Accepted source-file bytes |
|
|
|
|
Set or reset them with the normal configuration command:
|
|
|
|
```bash
|
|
codebase-memory-mcp config set index_max_files 250000
|
|
codebase-memory-mcp config set index_max_source_mb 16384
|
|
codebase-memory-mcp config reset index_max_files
|
|
```
|
|
|
|
Values use base-10 integers. MiB means 1,048,576 bytes. Empty values, zero,
|
|
negative values, suffixes, trailing characters, and values outside the stated
|
|
ranges are rejected without changing the stored value.
|
|
|
|
## Worker settings
|
|
|
|
| Key | Default | Accepted value | Protects |
|
|
|---|---:|---:|---|
|
|
| `index_max_rss_mb` | `off` | `off` or `64..1048576` | Charged memory of the complete worker process tree |
|
|
| `index_max_duration_seconds` | `off` | `off` or `1..86400` | Wall-clock duration of the whole index request |
|
|
|
|
```bash
|
|
codebase-memory-mcp config set index_max_rss_mb 8192
|
|
codebase-memory-mcp config set index_max_duration_seconds 3600
|
|
```
|
|
|
|
RSS is the charged memory of the contained worker and every descendant, not
|
|
the worker's allocation budget and not peak memory. On macOS that quantity is
|
|
`phys_footprint` (the same number `cbm_mem_charged()` enforces), not
|
|
`resident_size`, which still counts pages the allocator has already handed
|
|
back. Linux and Windows use RSS / working set. This hard watchdog is
|
|
separate from the internal `CBM_MEM_BUDGET_MB` soft budget. The supervisor
|
|
samples the tree at most once every 250 milliseconds so the watchdog does not
|
|
turn full process-table enumeration into a busy loop.
|
|
|
|
Duration is per request: the clock starts at the first worker spawn and is
|
|
not reset when crash/hang recovery starts a later attempt. Continuous log
|
|
progress does not reset it. It is independent of the existing 15-minute quiet
|
|
timeout, which still identifies a worker that stops making progress. A
|
|
duration limit shorter than that quiet timeout kills a hung worker before hang
|
|
quarantine can name the in-flight file, so the next attempt may hang on the
|
|
same file.
|
|
|
|
Equality is allowed. The first RSS or elapsed-duration observation above its
|
|
limit starts the existing graceful-to-force process-tree shutdown. CBM reports
|
|
terminal only after the tree is quiescent or a bounded containment failure is
|
|
explicitly surfaced. Resource termination is not retried and does not
|
|
quarantine a source file.
|
|
|
|
A worker limit never stops a worker after it has started to publish. The
|
|
supervisor enforces the limits, but only the worker replaces the serving
|
|
database, so the two coordinate through a per-attempt publication claim that
|
|
exactly one of them can win. The worker claims it immediately before it
|
|
replaces the serving database; the supervisor claims it before it stops the
|
|
worker for a limit. If the limit is reached first, the worker can no longer
|
|
publish and the previous index stays untouched. If the worker claimed first,
|
|
the limits no longer apply to that attempt: the new index is published and the
|
|
rest of the attempt, including the persistence artifact export, runs to
|
|
completion. The supervisor then logs `index.supervisor.resource_limit_after_publication`
|
|
instead of stopping it. With both worker limits `off` there is no claim.
|
|
|
|
If RSS is enabled and three consecutive probes cannot obtain any trustworthy
|
|
tree measurement while the root worker is still running, CBM fails closed with
|
|
`code=resource_probe_failed`. A probe is untrustworthy as soon as one member of
|
|
the tree cannot be measured: only a process that exits between the listing and
|
|
its measurement is skipped, because a total without a live member would
|
|
under-report. On Linux the probe reads every `/proc/<pid>/stat` to find the
|
|
tree's members, so a `/proc` mounted with `hidepid=1` makes it fail closed.
|
|
|
|
## Counting and failure semantics
|
|
|
|
`index_max_files` counts a file only after it passes directory pruning, ignore
|
|
rules, filename and suffix filters, language detection, and the existing
|
|
per-file size rule. `index_max_source_mb` sums the filesystem sizes of that same
|
|
accepted set.
|
|
|
|
Equality is allowed. The first file or byte that makes an observed value greater
|
|
than its limit stops discovery. CBM discards the partial file list and does not
|
|
publish a partial graph as a complete index.
|
|
|
|
For an explicit MCP request the error payload contains:
|
|
|
|
```json
|
|
{
|
|
"status": "error",
|
|
"code": "resource_limit_exceeded",
|
|
"stage": "discovery",
|
|
"resource": "files",
|
|
"observed": 250001,
|
|
"limit": 250000,
|
|
"unit": "files",
|
|
"retryable": true,
|
|
"serving_index_preserved": true,
|
|
"message": "Index discovery exceeded index_max_files"
|
|
}
|
|
```
|
|
|
|
The previous database remains available because publication occurs only after a
|
|
complete discovery and successful staged build. If no previous database exists,
|
|
`serving_index_preserved` is false.
|
|
|
|
Worker limit failures use the same shape with `stage=worker`,
|
|
`resource=rss_bytes` and `unit=bytes`, or `resource=duration_ms` and
|
|
`unit=milliseconds`. RSS measurement failures use `code=resource_probe_failed`
|
|
and omit `observed`, `limit`, and `unit` because no trustworthy observation was
|
|
available. For a worker failure `serving_index_preserved` describes the whole
|
|
request: it is true only when a servable index existed when the request began,
|
|
no attempt of the request (including an earlier one that crashed and was
|
|
recovered) claimed publication, and that index still serves.
|
|
|
|
## Trust and compatibility
|
|
|
|
Limits are read from the CLI-managed `_config.db`; they are not MCP request
|
|
arguments. A supervised parent replaces any caller-supplied internal policy
|
|
before spawning its worker, and the worker rejects a missing or incomplete
|
|
parent policy.
|
|
|
|
These settings do not replace or increase `auto_index_limit`, change the 512 MiB
|
|
single-file cap, alter workspace-root authorization, or affect
|
|
`cross-repo-intelligence`. With all settings `off`, discovery follows the
|
|
existing path and the supervisor performs no periodic RSS probe or total-duration
|
|
termination.
|