Commit a695757
committed
docs: multi-agent review and fix for architecture docs and specs
Architecture docs (simplified + full versions):
- Fix API signatures: ff_kevent_do_each (3→7 params), ff_route_ctl (2→5 params),
ff_rtioctl, ff_zc_mbuf_get, ff_sysctl, ff_log/ff_vlog (add level+logtype)
- Fix Socket API: struct sockaddr → struct linux_sockaddr throughout
- Fix ff_openlog_stream → ff_log_reset_stream / ff_log_open_set
- Fix global vars: enable_kni (static→non-static), nb_dev_ports (uint32_t→int),
idle_sleep (uint32_t→unsigned, remove default), pktmbuf_pool (MAX_LCORE→NB_SOCKETS)
- Fix struct ff_tx_offload and ff_dispatcher_context fields per source
- Fix main_loop pseudocode: TX drain before RX, add idle sleep step
- Fix code block language markers (8 blocks)
- Fix markdown syntax (unclosed bold, list spacing)
- Fix typo: unctions_default → functions_default
Specs documents:
- P0: Unify eventfd design (single evfd → dual eventfd_req/eventfd_rsp) across SPEC-002/003
- P0: Unify function naming (ff_create_ring_zone → ff_create_sc_ring_zone) across SPEC-002/003
- P0: Reconcile throughput targets (1.5x→1.2x micro, ≥10% Nginx) across SPEC-001/004
- P1: Fix ring entries count (32→64) in SPEC-001 NFR-004
- P1: Fix ff_thread_handle offset (68→72, 8-byte alignment) in SPEC-003
- P1: Add clarifying comment for ACQUIRE_ZONE_LOCK macro in Ring mode
- P1: Fix operator precedence bug (++spin_count & 0xFF == 0) in SPEC-003
- P1: Annotate 72h stability test vs 24h acceptance criteria
Stats: Update SUMMARY.txt line counts to match modified files1 parent e5628d1 commit a695757
12 files changed
Lines changed: 119 additions & 125 deletions
File tree
- docs
- specs
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
52 | | - | |
| 52 | + | |
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
| |||
123 | 123 | | |
124 | 124 | | |
125 | 125 | | |
126 | | - | |
| 126 | + | |
127 | 127 | | |
128 | 128 | | |
129 | 129 | | |
| |||
151 | 151 | | |
152 | 152 | | |
153 | 153 | | |
154 | | - | |
| 154 | + | |
155 | 155 | | |
156 | 156 | | |
157 | 157 | | |
| |||
164 | 164 | | |
165 | 165 | | |
166 | 166 | | |
167 | | - | |
| 167 | + | |
168 | 168 | | |
169 | 169 | | |
170 | 170 | | |
| |||
179 | 179 | | |
180 | 180 | | |
181 | 181 | | |
182 | | - | |
| 182 | + | |
183 | 183 | | |
184 | 184 | | |
185 | 185 | | |
| |||
241 | 241 | | |
242 | 242 | | |
243 | 243 | | |
244 | | - | |
| 244 | + | |
245 | 245 | | |
246 | 246 | | |
247 | 247 | | |
| |||
253 | 253 | | |
254 | 254 | | |
255 | 255 | | |
256 | | - | |
| 256 | + | |
257 | 257 | | |
258 | 258 | | |
259 | 259 | | |
| |||
335 | 335 | | |
336 | 336 | | |
337 | 337 | | |
338 | | - | |
| 338 | + | |
| 339 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
| 30 | + | |
31 | 31 | | |
32 | | - | |
33 | | - | |
34 | | - | |
35 | | - | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
42 | 42 | | |
43 | 43 | | |
44 | | - | |
| 44 | + | |
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
48 | | - | |
| 48 | + | |
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
| |||
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
66 | | - | |
67 | | - | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
68 | 69 | | |
69 | 70 | | |
70 | 71 | | |
| |||
86 | 87 | | |
87 | 88 | | |
88 | 89 | | |
89 | | - | |
90 | | - | |
| 90 | + | |
| 91 | + | |
91 | 92 | | |
92 | 93 | | |
93 | 94 | | |
94 | 95 | | |
95 | 96 | | |
96 | | - | |
97 | | - | |
98 | | - | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
99 | 102 | | |
100 | 103 | | |
101 | | - | |
102 | | - | |
103 | | - | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
104 | 107 | | |
105 | 108 | | |
106 | 109 | | |
107 | 110 | | |
108 | 111 | | |
109 | | - | |
110 | | - | |
111 | | - | |
112 | | - | |
113 | | - | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
114 | 117 | | |
115 | 118 | | |
116 | 119 | | |
| |||
379 | 382 | | |
380 | 383 | | |
381 | 384 | | |
382 | | - | |
383 | | - | |
384 | | - | |
385 | | - | |
386 | | - | |
387 | | - | |
388 | | - | |
389 | | - | |
390 | | - | |
| 385 | + | |
391 | 386 | | |
392 | 387 | | |
393 | 388 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
74 | 74 | | |
75 | 75 | | |
76 | 76 | | |
77 | | - | |
| 77 | + | |
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
101 | | - | |
102 | | - | |
103 | | - | |
104 | | - | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
109 | 109 | | |
110 | 110 | | |
111 | 111 | | |
| |||
261 | 261 | | |
262 | 262 | | |
263 | 263 | | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
264 | 268 | | |
265 | | - | |
266 | | - | |
267 | | - | |
268 | | - | |
269 | 269 | | |
270 | 270 | | |
271 | 271 | | |
| |||
295 | 295 | | |
296 | 296 | | |
297 | 297 | | |
| 298 | + | |
| 299 | + | |
298 | 300 | | |
299 | 301 | | |
300 | | - | |
301 | | - | |
302 | | - | |
303 | | - | |
304 | | - | |
305 | | - | |
306 | | - | |
307 | | - | |
308 | | - | |
309 | | - | |
310 | | - | |
311 | | - | |
312 | | - | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
313 | 306 | | |
314 | 307 | | |
315 | 308 | | |
| |||
405 | 398 | | |
406 | 399 | | |
407 | 400 | | |
408 | | - | |
409 | | - | |
410 | | - | |
411 | | - | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
412 | 405 | | |
413 | 406 | | |
414 | 407 | | |
| |||
446 | 439 | | |
447 | 440 | | |
448 | 441 | | |
449 | | - | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
450 | 445 | | |
451 | 446 | | |
452 | 447 | | |
453 | 448 | | |
454 | 449 | | |
455 | | - | |
456 | 450 | | |
457 | 451 | | |
458 | | - | |
459 | | - | |
460 | | - | |
461 | | - | |
462 | | - | |
463 | | - | |
464 | | - | |
465 | | - | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
466 | 457 | | |
| 458 | + | |
467 | 459 | | |
468 | 460 | | |
469 | | - | |
470 | | - | |
471 | | - | |
472 | | - | |
473 | | - | |
474 | | - | |
475 | | - | |
476 | | - | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| 467 | + | |
477 | 468 | | |
478 | 469 | | |
479 | 470 | | |
480 | 471 | | |
481 | | - | |
482 | | - | |
483 | | - | |
484 | | - | |
| 472 | + | |
| 473 | + | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
| 477 | + | |
485 | 478 | | |
486 | 479 | | |
487 | 480 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
673 | 673 | | |
674 | 674 | | |
675 | 675 | | |
676 | | - | |
| 676 | + | |
677 | 677 | | |
678 | 678 | | |
679 | 679 | | |
| |||
0 commit comments