Skip to content

Commit 435baf6

Browse files
committed
fix(ruby-lsp): survive allocation failure in the stdlib seed
The REG_* macros wrote through the return-type vector without checking the allocation, and registered entries whose formatted QN came back NULL. A shared ruby_seed_signature helper now leaves a failed vector out, so the signature types as unknown (the fallback ruby_register_method already uses), and REG_METHOD / REG_SMETHOD skip an entry whose formatted name is NULL, since a NULL QN would reach strcmp in finalize and in every lookup. rubylsp_stdlib_seed_survives_alloc_failure seeds a registry from an arena that cannot allocate. Before: UBSan reported a store to a null pointer and the run crashed with SEGV at ruby_stdlib_data.c:163. After: every registered entry carries a name, the registry finalizes, and the Kernel built-ins with literal names still resolve. Signed-off-by: Martin Vogel <[email protected]>
1 parent 214a9ac commit 435baf6

2 files changed

Lines changed: 74 additions & 43 deletions

File tree

‎internal/cbm/lsp/generated/ruby_stdlib_data.c‎

Lines changed: 47 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -40,55 +40,59 @@
4040
cbm_registry_add_type(reg, rt); \
4141
} while (0)
4242

43-
/* Register an instance method on receiver type `recv_` returning `ret_`. */
44-
#define REG_METHOD(recv_, name_, ret_) \
45-
do { \
46-
memset(&rf, 0, sizeof(rf)); \
47-
rf.min_params = -1; \
48-
rf.qualified_name = cbm_arena_sprintf(arena, "%s.%s", (recv_), (name_)); \
49-
rf.short_name = (name_); \
50-
rf.receiver_type = (recv_); \
51-
{ \
52-
const CBMType **rets = (const CBMType **)cbm_arena_alloc(arena, 2 * sizeof(*rets)); \
53-
rets[0] = (ret_); \
54-
rets[1] = NULL; \
55-
rf.signature = cbm_type_func(arena, NULL, NULL, rets); \
56-
} \
57-
cbm_registry_add_func(reg, rf); \
43+
/* Signature `() -> ret`. Every seed allocation can fail (arena exhausted):
44+
* a NULL return vector is left out, so the signature types as unknown (the
45+
* same fallback ruby_register_method uses) instead of being written through. */
46+
static const CBMType *ruby_seed_signature(CBMArena *arena, const CBMType *ret) {
47+
const CBMType **rets = (const CBMType **)cbm_arena_alloc(arena, 2 * sizeof(*rets));
48+
if (rets) {
49+
rets[0] = ret;
50+
rets[1] = NULL;
51+
}
52+
return cbm_type_func(arena, NULL, NULL, rets);
53+
}
54+
55+
/* Register an instance method on receiver type `recv_` returning `ret_`.
56+
* An entry whose formatted QN came back NULL is not registered: a NULL QN
57+
* would reach strcmp in finalize and in every later lookup. */
58+
#define REG_METHOD(recv_, name_, ret_) \
59+
do { \
60+
memset(&rf, 0, sizeof(rf)); \
61+
rf.min_params = -1; \
62+
rf.qualified_name = cbm_arena_sprintf(arena, "%s.%s", (recv_), (name_)); \
63+
if (!rf.qualified_name) \
64+
break; \
65+
rf.short_name = (name_); \
66+
rf.receiver_type = (recv_); \
67+
rf.signature = ruby_seed_signature(arena, (ret_)); \
68+
cbm_registry_add_func(reg, rf); \
5869
} while (0)
5970

6071
/* Register a singleton (class-side) method: receiver key "<qn>.self"
61-
* matches ruby_lookup_singleton_method's keying convention. */
62-
#define REG_SMETHOD(recv_, name_, ret_) \
63-
do { \
64-
memset(&rf, 0, sizeof(rf)); \
65-
rf.min_params = -1; \
66-
rf.qualified_name = cbm_arena_sprintf(arena, "%s.%s", (recv_), (name_)); \
67-
rf.short_name = (name_); \
68-
rf.receiver_type = cbm_arena_sprintf(arena, "%s.self", (recv_)); \
69-
{ \
70-
const CBMType **rets = (const CBMType **)cbm_arena_alloc(arena, 2 * sizeof(*rets)); \
71-
rets[0] = (ret_); \
72-
rets[1] = NULL; \
73-
rf.signature = cbm_type_func(arena, NULL, NULL, rets); \
74-
} \
75-
cbm_registry_add_func(reg, rf); \
72+
* matches ruby_lookup_singleton_method's keying convention. Skipped when
73+
* either formatted name came back NULL (see REG_METHOD). */
74+
#define REG_SMETHOD(recv_, name_, ret_) \
75+
do { \
76+
memset(&rf, 0, sizeof(rf)); \
77+
rf.min_params = -1; \
78+
rf.qualified_name = cbm_arena_sprintf(arena, "%s.%s", (recv_), (name_)); \
79+
rf.receiver_type = cbm_arena_sprintf(arena, "%s.self", (recv_)); \
80+
if (!rf.qualified_name || !rf.receiver_type) \
81+
break; \
82+
rf.short_name = (name_); \
83+
rf.signature = ruby_seed_signature(arena, (ret_)); \
84+
cbm_registry_add_func(reg, rf); \
7685
} while (0)
7786

7887
/* Register a global (Kernel) built-in function returning `ret_`. */
79-
#define REG_BUILTIN(name_, ret_) \
80-
do { \
81-
memset(&rf, 0, sizeof(rf)); \
82-
rf.min_params = -1; \
83-
rf.qualified_name = (name_); \
84-
rf.short_name = (name_); \
85-
{ \
86-
const CBMType **rets = (const CBMType **)cbm_arena_alloc(arena, 2 * sizeof(*rets)); \
87-
rets[0] = (ret_); \
88-
rets[1] = NULL; \
89-
rf.signature = cbm_type_func(arena, NULL, NULL, rets); \
90-
} \
91-
cbm_registry_add_func(reg, rf); \
88+
#define REG_BUILTIN(name_, ret_) \
89+
do { \
90+
memset(&rf, 0, sizeof(rf)); \
91+
rf.min_params = -1; \
92+
rf.qualified_name = (name_); \
93+
rf.short_name = (name_); \
94+
rf.signature = ruby_seed_signature(arena, (ret_)); \
95+
cbm_registry_add_func(reg, rf); \
9296
} while (0)
9397

9498
void cbm_ruby_stdlib_register(CBMTypeRegistry *reg, CBMArena *arena) {

‎tests/test_ruby_lsp.c‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1498,6 +1498,32 @@ TEST(rubylsp_const_path_is_linear) {
14981498
PASS();
14991499
}
15001500

1501+
/* Review ask (c): the stdlib seed must survive allocation failure. A
1502+
* zero-initialised arena has no blocks and no grow size, so every
1503+
* allocation from it returns NULL. The seed must not write through a NULL
1504+
* return-type vector, and must not register an entry whose formatted name
1505+
* came back NULL (a NULL QN would reach strcmp in finalize and in every later
1506+
* lookup). */
1507+
TEST(rubylsp_stdlib_seed_survives_alloc_failure) {
1508+
CBMArena reg_arena;
1509+
cbm_arena_init(&reg_arena);
1510+
CBMTypeRegistry reg;
1511+
cbm_registry_init(&reg, &reg_arena);
1512+
CBMArena dead;
1513+
memset(&dead, 0, sizeof(dead));
1514+
cbm_ruby_stdlib_register(&reg, &dead);
1515+
ASSERT(reg.type_count > 0);
1516+
ASSERT(reg.func_count > 0); /* Kernel built-ins carry literal names */
1517+
for (int i = 0; i < reg.func_count; i++) {
1518+
ASSERT(reg.funcs[i].qualified_name != NULL);
1519+
ASSERT(reg.funcs[i].short_name != NULL);
1520+
}
1521+
cbm_registry_finalize(&reg);
1522+
ASSERT(cbm_registry_lookup_func(&reg, "puts") != NULL);
1523+
cbm_arena_destroy(&reg_arena);
1524+
PASS();
1525+
}
1526+
15011527
/* ── suite ──────────────────────────────────────────────────────── */
15021528

15031529
void suite_ruby_lsp(void) {
@@ -1536,4 +1562,5 @@ void suite_ruby_lsp(void) {
15361562
RUN_TEST(rubylsp_self_rebinding_blocks_no_edge);
15371563
RUN_TEST(rubylsp_mixin_walk_visits_each_module_once);
15381564
RUN_TEST(rubylsp_const_path_is_linear);
1565+
RUN_TEST(rubylsp_stdlib_seed_survives_alloc_failure);
15391566
}

0 commit comments

Comments
 (0)