BSON_CROSS_PLATFORM_NOTES(3)

📦
version 1.26.0 · 3 versions
, in ubuntu noble

💫 BSON_CROSS_PLATFORM_NOTES 💫

okay bestie, pull up a chair 🫶 this is the libbson page alllll about how this library behaves when it's out here living its life on every kind of machine — different byte orders, different thread setups, the whole vibe. no cap, it's shorter than it sounds but every line matters. let's go 💅

🌍 ENDIANNESS 🌍

so the BSON spec is very clear about this, periodt: the encoding format is little-endian. that's the law. 💖

and here's the thing — a lot of implementations just straight up ignore endianness entirely 😭 and assume they're gonna be run on a little-endian system. like, bold of them honestly.

libbson is NOT like that. it supports both Big and Little Endian systems, slay 💅 which means instead of being messy and dereferencing pointers all willy-nilly, we use memcpy() when that's the appropriate move, and we properly convert to and from the host endian format. ✨

and the lil cherry on top? we expect the compiler intrinsics to optimize that memcpy() into a plain dereference when possible. iconic behavior, no notes. 🎀

🧵 THREADING 🧵

okay this part is important so listen up fr fr:

libbson's data structures are NOT thread-safe. 🚨

that's not a typo, bestie. NOT. you — yes, you — are responsible for accessing and mutating these structures from one thread at a time. that's the deal. one. at. a. time. 💀

now, on the platform side of things:

  • on all UNIX-like platforms, libbson requires POSIX threads (pthreads). no pthreads, no party. 🧚
  • on Windows, the native threading interface is used instead.

and what does libbson actually do with your system's threading library, you ask? two things:

  1. it uses it to safely generate unique ObjectIds 👑
  2. it uses it to provide a fallback implementation for atomic operations on platforms that don't have built-in atomics 🌸

so like, it's not just vibing in there, it's doing real work. main character energy honestly. 💜

✍️ AUTHOR ✍️

MongoDB, Inc

2017-present, MongoDB, Inc

and that's the whole page, bestie!! 🎀 no more notes, you're officially caught up on cross-platform behavior. go forth and be endian-aware and thread-cautious. i'm obsessed with you for reading the whole thing 🫶💖

this was libbson version 1.26.0, dated Mar 31, 2024 — signing off, mwah 💋✨

📦 where this page comes from