Andrew Kesterson
f1283e21a3
Reservations were advisory bookkeeping: any component could name any status, so the registry only detected declared-range overlap between components that both opted in. Naming a status now requires a reservation. akerr_register_status_name() checks that the range belongs to the caller, and the legacy two-argument akerr_name_for_status() set path, which cannot identify its caller, requires that some reservation covers the status. Every refusal is logged and names the real owner, because a name that fails to register degrades that code to "Unknown Error" in every later stack trace. Fix a reservation made before the first PREPARE_ERROR being silently discarded. akerr_init() clears the tables, so whichever component first triggered it wiped an earlier reservation and the next component to claim the same range was told it was free, producing exactly the undetected aliasing the registry exists to prevent. Every registry entry point now calls akerr_init(), which sets its guard before doing any work so those calls do not recurse. Replace the linear-scan name array with an open-addressed hash table, taking lookup from O(n) to O(1) and raising usable capacity from 512 entries (366 free to consumers after errno registration) to 3072 (~2900 free). Both table sizes are build-time overridable and applied PRIVATE: they live entirely in src/error.c, so raising them cannot desynchronize a library from its consumers the way AKERR_MAX_ERR_VALUE could. Exhausting either table is now logged and returned to the caller rather than silently dropping the entry. No dynamic allocation is introduced; both tables remain file-scope arrays, and the library's undefined-symbol set gains only strcmp and strlen. Register names for AKERR_EOF, AKERR_ITERATOR_BREAK and AKERR_NOT_IMPLEMENTED, which had none and rendered as "Unknown Error" in every stack trace carrying them. err_error_names.c now sweeps the whole AKERR_* offset span so a code added without a name fails there instead of in production traces. Add static assertions that the slot count is a power of two and that AKERR_BADEXC stays inside the library's own 0-255 band, the latter guarding against a host errno space large enough to push library codes into the range consumers are told to allocate from. Set a project version and soname (1.0.0 / libakerror.so.1) so a stale installed library can no longer be silently paired with newer headers, and so akerror.pc ships a real Version field instead of an empty one. Mutation testing surfaced an out-of-bounds probe in the new table that the suite did not catch: masking with SLOTS rather than SLOTS-1 indexes past the array, and err_maxval.c asserted only that some names registered before the table filled, which a collapsed probe sequence still satisfies. It now requires a substantial entry count and reads every entry back by its own distinct name. Tests: 28/28 pass. Coverage 99.4% line / 86.8% branch. Mutation score for src/error.c 74% -> 77.3%. Compatibility: source and ABI break. AKERR_MAX_ERR_VALUE and the __AKERR_ERROR_NAMES data symbol are gone, custom codes must move out of 0-255, and names must be registered against a reserved range. README.md carries the migration steps. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
75 lines
2.9 KiB
C
75 lines
2.9 KiB
C
#include "akerror.h"
|
|
#include "err_capture.h"
|
|
#include <string.h>
|
|
|
|
/*
|
|
* akerr_init() registers a human-readable name for each library error code.
|
|
* Verify the names are actually installed (mutation testing showed the
|
|
* registration calls could be deleted without any test noticing).
|
|
*
|
|
* This list must stay exhaustive. AKERR_EOF, AKERR_ITERATOR_BREAK and
|
|
* AKERR_NOT_IMPLEMENTED were previously valid codes with no registered name, so
|
|
* they rendered as "Unknown Error" in every stack trace that carried them --
|
|
* the same class of silent gap that a too-small AKERR_MAX_ERR_VALUE used to
|
|
* cause. The sweep below walks the whole AKERR_* offset span so a newly added
|
|
* code without a name fails here rather than showing up in production traces.
|
|
*/
|
|
|
|
static const struct {
|
|
int code;
|
|
const char *name;
|
|
} expected[] = {
|
|
{ AKERR_NULLPOINTER, "Null Pointer Error" },
|
|
{ AKERR_OUTOFBOUNDS, "Out Of Bounds Error" },
|
|
{ AKERR_API, "API Error" },
|
|
{ AKERR_ATTRIBUTE, "Attribute Error" },
|
|
{ AKERR_TYPE, "Type Error" },
|
|
{ AKERR_KEY, "Key Error" },
|
|
{ AKERR_INDEX, "Index Error" },
|
|
{ AKERR_FORMAT, "Format Error" },
|
|
{ AKERR_IO, "Input Output Error" },
|
|
{ AKERR_VALUE, "Value Error" },
|
|
{ AKERR_RELATIONSHIP, "Relationship Error" },
|
|
{ AKERR_EOF, "End Of File" },
|
|
{ AKERR_CIRCULAR_REFERENCE, "Circular Reference Error" },
|
|
{ AKERR_ITERATOR_BREAK, "Iterator Break" },
|
|
{ AKERR_NOT_IMPLEMENTED, "Not Implemented" },
|
|
{ AKERR_BADEXC, "Invalid akerr_ErrorContext" },
|
|
};
|
|
|
|
int main(void)
|
|
{
|
|
akerr_init();
|
|
|
|
for ( unsigned i = 0; i < sizeof(expected) / sizeof(expected[0]); i++ ) {
|
|
char *nm = akerr_name_for_status(expected[i].code, NULL);
|
|
AKERR_CHECK(nm != NULL);
|
|
AKERR_CHECK(strcmp(nm, expected[i].name) == 0);
|
|
}
|
|
|
|
/*
|
|
* Every value in the library's own offset span must resolve to a real name.
|
|
* AKERR_LAST_ERRNO_VALUE + 7 is the one deliberate hole (a removed code);
|
|
* anything else nameless is a code someone added without registering it.
|
|
*/
|
|
for ( int offset = 1; offset <= AKERR_BADEXC - AKERR_LAST_ERRNO_VALUE; offset++ ) {
|
|
int code = AKERR_LAST_ERRNO_VALUE + offset;
|
|
char *nm = akerr_name_for_status(code, NULL);
|
|
if ( offset == 7 ) {
|
|
AKERR_CHECK(strcmp(nm, "Unknown Error") == 0);
|
|
continue;
|
|
}
|
|
if ( strcmp(nm, "Unknown Error") == 0 || nm[0] == '\0' ) {
|
|
fprintf(stderr, "AKERR_LAST_ERRNO_VALUE + %d (%d) has no name\n",
|
|
offset, code);
|
|
return 1;
|
|
}
|
|
}
|
|
|
|
/* Every AKERR_* code must sit inside the band the library reserves. */
|
|
AKERR_CHECK(AKERR_BADEXC < AKERR_FIRST_CONSUMER_STATUS);
|
|
|
|
fprintf(stderr, "err_error_names ok\n");
|
|
return 0;
|
|
}
|