fluffos/docs/driver/malloc.md
Yucong Sun c914f03d66
Add local search and documentation guide for docs site (#1221)
* docs: add local full-text search and a contributor README

Add @easyops-cn/docusaurus-search-local to the Docusaurus site so the
docs get an offline search bar (index built at build time, no external
service). English and zh-CN pages are both indexed, and matched terms
are highlighted on the target page.

Add docs/README.md describing the Docusaurus setup, local dev/build
commands, search behavior, directory layout, and gotchas; exclude it
from the published site alongside CLAUDE.md. Point the root README's
docs/ entry at it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

* docs: remove dead framework leftovers, fix index generation, complete the nav

Delete the VitePress (.vitepress/) and Jekyll (_layouts/, css/) leftovers,
the one-shot migration scripts (fix_md_header.py, fix_seealso.py), and the
stale keywords.json snapshot; prune the matching .gitignore entries and
docusaurus exclude patterns.

Rewrite gen_index.py for Docusaurus: it emitted dead .html links and
legacy 'layout: doc' frontmatter, choked on non-markdown entries, and
dropped nested categories — regenerating an index would have broken it.
It now emits the extension-less links the site actually uses, links
nested category indexes (restoring apply/* on the zh-CN index), and
refuses to run on the docs root. Fix update_index.sh's copy-paste titles
(zh-CN efun/build were titled 'APPLY'), stop it clobbering the
hand-written lpc/index.md, and cover cli/. Regenerated indexes pick up
the missing driver/ffi-plan entry. add_missing_efuns.py now takes the
keywords.json path as an argument instead of requiring a stale copy.

Move CNAME and the Google site-verification file into static/ so they
actually reach the published build output.

Complete the sidebar: link the CLI category to cli/index and add the
missing portbind/symbol/generate_keywords pages, and expose the
previously orphaned stdlib section under Reference.

Promote onBrokenLinks to 'throw' now the build is warning-free, and drop
the empty Demo section from the landing page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

* docs: strip legacy 'layout: doc' frontmatter from all pages

Mechanical sweep removing the Jekyll-era 'layout: doc' line from every
doc page's frontmatter (Docusaurus ignores it), and the matching line
from the templates in docs/CLAUDE.md so new pages don't reintroduce it.
No content changes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-07-09 22:09:55 -04:00

1.5 KiB

title
general / malloc

malloc

Note: some machines don't allow the system calls to be replaced with a function of the same name. In particular, the compile will fail during the link phase with a 'duplicate symbol' error. Most of the machines I've seen that exhibit this behavior use shared libraries (NeXT, RS/6000). Also note that smalloc.c uses sbrk() and brk() and these routines cannot be used in a program that uses malloc() (read the sbrk() man page for more information). Even if the program doesn't explicitly call malloc, it will fail if it calls system calls that internally use malloc. Thus the only truly safe way to use sbrk and brk is to replace the definition of system malloc. And some machines do not allow system malloc to be replaced.

Note: if you plan to hack on the driver, you should use MALLOC(x, ...), FREE(x, ...), REALLOC(x, ...), and CALLOC(x, ...) instead of the lowercase counterparts. Be sure to look at how these macros are used in the driver source itself in order to figure out the right syntax. The uppercase versions are macros that get replaced with the proper function names depending upon which malloc package is chosen. This change was made in order to provide for those machines that complain when functions are added with the same names as system calls. The change also allows some stats to be collected even when using system malloc. Various debug version of these macros also exist. Look at the macros defined near the end of the file config.h in the src directory.