Zig: Pointer Stability for ArrayLists

(ziglang.org)

69 points | by tosh 7 hours ago

7 comments

  • amluto 3 hours ago
    This seems weak.

    In a language like Rust, the compiler will “lock” the pointers for you, and you can’t forget.

    In a language like C++ (and presumably Zig), one could, in theory at least, have the iterators and slices that reference the storage of a dynamic array hold some sort of lock that pins the storage.

    But this API requires the programmer to remember to lock the pointers and also requires the programmer to keep the lock alive for the correct region of code. And it looks to me like even the example in the blog post has the lock taken completely outside the function that requires stability, so there is nothing whatsoever that gets the lock scoping right. Even the type system can’t help — the offending parse function can’t declare that it wants a pointer-locked ArrayList parameter.

    • Someone 2 hours ago
      I agree. https://news.ycombinator.com/item?id=49501582 says:

      “I use it in a lot of places where I know the max capacity ahead of time -- ensureCapacity() followed by a lot of AssumeCapacity()-styled commands. It's convenient for all of the ... convenience ... methods (append() requires some bookkeeping somewhere, appendSlice() requires more, and so on). In those usages, it's basically syntactic sugar over a slice”*

      I suspect “where I know the max capacity ahead of time” covers most if not all use cases (if it you use this without knowing max capacity, you either accept your code may panic, or you do some unlock, grow, lock again dance when you discover your initial estimate is wrong)

      If so, wouldn’t adding a growable container where you specify capacity at construction time and removing access to the internal pointers of ArrayList be a better way to handle this?

    • frmdstryr 2 hours ago
      Do any languages have a notion of "relative pointers"? So in the example if instead of appending "line" as ptr & len, it'd instead be appending an offset & len which could in theory be used to safely compute the actual location even with relocations.
      • amluto 48 minutes ago
        Languages with dependent types can express things like “this offset is in bounds relative to this other array”, which is maybe what you’re thinking of.
      • Someone 1 hour ago
        If you squeeze your eyes a bit, C compilers for Windows used to have them, with far pointers (https://en.wikipedia.org/wiki/Far_pointer)

        Similarly, CPU architectures that use descriptors can (have to?) have languages with that notion.

        • frmdstryr 42 minutes ago
          After more searching I found this article https://www.gingerbill.org/article/2020/05/17/relative-point...

          A far pointer sounds like the global based pointer described in that article. The far pointer Wikipedia article says they are problematic but doesn't give much reasoning as to why.

          • sparkie 10 minutes ago
            Far pointers are for accessing memory in different segments. They're basically obsolete now. They were necessary in older machines with limited sized pointers or address spaces.

            GCC still supports `__seg_fs` and `__seg_gs`, which behave similar to `far` in the example on the wiki page, as the FS and GS segment registers are still valid in x86-64 and used for TLS. Clang uses attributes `address_space(257)` and `address_space(256)` for the same thing.

            The `__based` pointer in MSVC exploits the `[base+index*scale+displacement]` addressing mode by pinning the base. It's unrelated to segmentation.

        • sparkie 55 minutes ago
          The FS and GS segment selectors are still used in x86-64, typically for `thread_local` storage, but they can be repurposed.

          `thread_local` is an example of a "relative pointer" though. Instructions to access the thread local are prefixed with `fs:` or `gs:`, and point relative to the address in the respective segment register.

    • pron 2 hours ago
      I reach for a low-level language only when I want low-level control over what operations happen and when, what memory is used and when etc.. At present, no language offers me this control and safety at the same time. With Rust, when I need such control (which is always, otherwise I would use a higher-level language), I need to give up safety, anyway, at which point I have no safety and the complexity of a language that offers safety.

      So right now, when we want control, we need to give up some safety, but weaker things are still helpful.

      Also, in low-level code, the problem of "I might forget to do something" sometimes clashes with the problem of "I need to see exactly what operations are done and where". Various kinds of implicitness help with the former at the expense of the latter.

      I'm not saying this is universally better than other approaches, but many people who do serious low-level programming would prefer this.

      • xeonmc 1 hour ago

            Those who would give up low-level control to purchase a little memory safety, deserve neither control nor safety.”
        
        - Benjamin Franklin, or something like that
      • duped 2 hours ago
        What are some examples of things you "always" need that require unsafe Rust?
      • pjmlp 2 hours ago
        Except the point that Zig should do better than Object Pascal, Modula-2, with solutions already available on Insure++ and friends for use after free, 30 years ago.
  • _bohm 4 hours ago
    It's a nice feature but I can't help feeling like, if you need a stable pointer to an item in a collection, ArrayList is the wrong data structure to use? Maybe someone can chime in and give me an example of when you'd do this instead of, e.g., just storing an index. Alternatively, you could use an Unrolled Linked List (FKA SegmentedList in Zig before it was removed in 0.16, not sure why).
    • hansvm 3 hours ago
      I use it in a lot of places where I know the max capacity ahead of time -- ensureCapacity() followed by a lot of *AssumeCapacity()-styled commands. It's convenient for all of the ... convenience ... methods (append() requires some bookkeeping somewhere, appendSlice() requires more, and so on). In those usages, it's basically syntactic sugar over a slice. That's not a perfect solution, but it's reasonably good often enough that I keep doing it.

      The proposed change doesn't do much for me personally (memory safety is ensured in other ways, and if it weren't I wouldn't be annoyed debugging the allocator-observed errors), but I could see myself using it at some other point in time for the same class of usages, or I could see other people relying on it when they choose that class of coding.

    • nvme0n1p1 4 hours ago
      SegmentedList had a weird API, especially the way you control the list growth factor by the size of an inline array. And it hadn't kept up with stdlib norms in recent versions. I do hope it comes back eventually with an improved API.

      At least we got Deque in exchange. I use that far more often than I used SegmentedList.

      • _bohm 4 hours ago
        Aha, gotcha. To tell you the truth, I don't think I ever used it. I have a custom implementation I wrote because I didn't realize at the time that SegmentedList was an unrolled linked list :p
    • dataflow 3 hours ago
      I don't know Zig, but conceptually: a direct pointer is the fastest way to access an object. An arraylist is the fastest dynamic sequence of objects (fattest in access, not in growth). You use these when you need the performance. It's not often but it certainly happens. The most trivial example is a string that you append to but still need to pass to a C API in between that expects it to be contagious, but it's far more useful than just for storing characters.
      • _bohm 2 hours ago
        Sure, in cases where you need elements to be contiguous in memory then certainly an unrolled linked list is not appropriate. There's usually not a meaningful performance difference between a pointer deref and an indexed array access, however.
    • bvrmn 3 hours ago
      ArrayList is a very generic (pun not intended) structure and could be stretched quite freely in any direction with useful property of owning underlying slice. Like readonly preallocated ArrayList is a thing.
      • _bohm 3 hours ago
        That's a good point. Using lockPointers would be a good way to enforce at runtime that your ArrayList is truly read-only.
    • the__alchemist 3 hours ago
      My mental model of Zig is that it is explicitly the language for developers who prefer using pointers in business logic (instead of just in MMIMO, and are looking for something with improvements over C); i.e. exactly this class of abstraction.
      • _bohm 3 hours ago
        Having written a bunch of Zig, I wouldn't say that the language design or culture explicitly encourages the use of pointers over indices in such situations. I would say it's more a language which trusts the programmer to make correct decisions about which constructs are appropriate in any given circumstance.
        • svachalek 2 hours ago
          Hasn't the past 30 years of the Internet age taught us that given such trust, programmers will make the incorrect decision with horrifying predictability? The most trivial level of software security requires that pointer safety needs to be mathematically proven not up to human (or LLM) judgment.
    • beepbooptheory 3 hours ago
      Maybe one use case is if you are interfacing with external C library and you're stuck with pointers?
  • portly 1 hour ago
    This makes a lot of sense if you consider that it is consistent with the rest of the language. It is one more way to set up tripwires in your code to to catch your own programming errors. Similar to using asserts in your functions to vet input and output.

    I use Array list a lot so excited to add this throughout the code to harden them.

    I can imagine this is not everyone's cup of tea, but then you probably also wouldn't enjoy any of the other explicitness.

  • Rendello 2 hours ago
    Aside: one Zig (syntax) feature that I really missed in Rust is shown in the second code block, namely prefixed multi-line string literals à la:

        const text =
            \\This is a long comment
            \\But I can split it among lines arbitrarily
            \\And keep my indentation.
        ;
    
    I've started using the Rust macro library `docstr` [1], which does the same thing:

        const TEXT: &'static str = docstr!(
            /// Now I can do it in Rust, too.
            /// I prefer this style a lot of the time
            /// for long texts.
        );
    
    It even works with macros (example from the docs):

        let greeting: String = docstr!(format!
            /// Hello, my name is {name}.
            /// I am {} years old!
            age
        );
    
    1. https://docs.rs/docstr/latest/docstr/
  • boricj 1 hour ago
    It took me a minute to understand that this asserts on pointer change within the container, rather than lock/unlock the data structure like a SDL surface.

    I recently implemented a custom C++ container for a path whose components could be iterated, backed by a std::string. I just store indices and a reference to the string, such that my iterators are not invalidated if the std::string gets reallocated after being modified. Far less error prone for little added cost.

  • afdbcreid 2 hours ago
    They forgot to add (I believe this was not deliberate, maybe their users already infer that) that this only actually performs the check on Debug and ReleaseSafe modes, not on ReleaseFast mode. Which is reasonable I guess because this is a memory write/read/branch in a super hot code path, but undermines a large part of the guarantee in my opinion (doesn't Zig have a debug allocator that could catch the mistake in the example just as well?).
  • duped 1 hour ago
    This is a gripe of mine, and I will admit it is weak.

    Changing a segfault to a panic with a stack trace is an improvement in developer experience. It does not make better software. The advantage of automatic strategies to mitigate memory safety mistakes either by using GC to make the program sound or static analysis to prevent the mistake by construction is plainly better.

    There is a direction in some systems programming circles away from this by eschewing "complexity" (in other words, fixing the damn problems) for programs that have better error messages when the programmer made a mistake. I don't see that as better software.