LD.HUGETLBFS(1)

📦 version 2.24.0.g1322884, in debian bookworm, debian trixie, nixpkgs unstable, opensuse-leap 16.0, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 LD.HUGETLBFS 💖

okay bestie, gather round, because this is ld.hugetlbfs(1) from the General Commands Manual and it's literally the glow-up your linker never knew it needed 🦋

✨ NAME ✨

ld.hugetlbfs — link a program for huge pages 👑

🌸 SYNOPSIS 🌸

ld.hugetlbfs [options]

💅 DESCRIPTION 💅

so here's the tea: ld.hugetlbfs is a straight-up replacement for your normal ld command, except it links programs so they can use hugepages. iconic behavior, no notes.

when you're building under gcc, you want to pass the option -B /usr/share/libhugetlbfs — that's you telling gcc "hey babe, go look in a non-standard location for the linker" 🫶. and you could totally set that in the CFLAGS environment variable if you want it to just live there rent-free.

🎀 -Wl,--hugetlbfs-align

this linking method gives you greater flexibility at runtime, fr fr. by using HUGETLB_ELFMAP, you get to control exactly which program segments get dropped into hugepages. the following four settings will cause the indicated segments to be placed in hugepages:

  • HUGETLB_ELFMAP=R — read-only segments (text) 📖
  • HUGETLB_ELFMAP=W — writable segments (data/BSS) ✍️
  • HUGETLB_ELFMAP=RW — all segments (text/data/BSS) 🌈
  • HUGETLB_ELFMAP=no — no segments 💀

and if you wanna be extra extra, you can pick specific huge page sizes for the read-only and writable segments using this advanced syntax:

HUGETLB_ELFMAP=[R[=<pagesize>]:[W[=<pagesize>]]

periodt. 💅

under binutils 2.16 or older, this option links the application to store BSS data (only) into hugepages. just BSS. nothing else. she's minimal like that.

under binutils 2.16 or older, this option links the application to store text, initialized data and BSS data into hugepages. she's doing the MOST and honestly? we love her for it.

📁 FILES 📁

  • [DESTDIR|/usr/share]/doc/libhugetlbfs/HOWTO

like, go read the HOWTO bestie, it's right there 🍓

👀 SEE ALSO 👀

the whole friend group, honestly 💜

🫶 AUTHORS 🫶

libhugetlbfs was written by various people on the libhugetlbfs-devel mailing list. a collective effort, a group project that actually got finished (unlike ours 😭), we stan 💖

and that's the whole page!! this version dropped on March 12, 2012 and it's giving libhugetlbfs manual page energy from the jump. mwah, go link something huge 🌸✨👑

📦 where this page comes from