git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 6/6] reftable: introduce "reftable-system.h" header

From
Junio C Hamano <gitster@pobox.com>
Date
Mar 31, 2026, 18:26 UTC
Message-ID
<xmqqwlyrzwh0.fsf@gitster.g>
In-Reply-To
<20260331-pks-reftable-portability-fixes-v1-6-46bfae55c68c@pks.im>
Patrick Steinhardt <ps@pks.im> writes:
Show 5 quoted lines
> We're including a couple of standard headers like <stdint.h> in a bunch
> of locations, which makes it hard for a project to plug in their own
> logic for making required functionality available. For us this is for
> example via "compat/posix.h", which already includes all of the system
> headers relevant to us.
Hmmm.  This is interesting.
Show 13 quoted lines
> diff --git a/reftable/reftable-system.h b/reftable/reftable-system.h
> new file mode 100644
> index 0000000000..f90c415182
> --- /dev/null
> +++ b/reftable/reftable-system.h
> @@ -0,0 +1,7 @@
> +#ifndef REFTABLE_SYSTEM_H
> +#define REFTABLE_SYSTEM_H
> +
> +#define MINGW_DONT_HANDLE_IN_USE_ERROR
> +#include "compat/posix.h"
> +
> +#endif

This one is clearly tailored to be used in the context of our system.

Show 14 quoted lines
> diff --git a/reftable/system.h b/reftable/system.h
> index dffc717bd4..52f964c04b 100644
> --- a/reftable/system.h
> +++ b/reftable/system.h
> @@ -11,8 +11,7 @@
>  
>  /* This header glues the reftable library to the rest of Git */
>  
> -#define MINGW_DONT_HANDLE_IN_USE_ERROR
> -#include "compat/posix.h"
> +#include "reftable-system.h"
>  #include "compat/zlib-compat.h"
>  
>  #define REFTABLE_INLINE(type) static inline type

And so far in this series, I was getting the impression that reftable/system.c and reftable/system.h are where the target system specific definitions are stored.

The implementation detail of how we obtain the wallclock time at millisecond resolution is in reftable/system.c, the implementation detail of how our mmap() emulation can work to build reftable_mmap() is in reftable/system.c, for example.

But the corresponding reftable/system.h does not seem to be specific to the target system at all---it describes the common abstraction, like "reftable code proper is expected call reftable_mmap() on any system" and "the way for reftable code is expected to read the wallclock is by calling reftable_time_ms()".

So <reftable-system.h>, just like <reftable/system.c>, is expected to have a target platform specific "implementation", and not like <reftable/system.h> that is expected to be platform neutral (this neutrality comes from the fact that <reftable/system.c> will implement the interface specified in <reftable/system.h> for the target platform).

Which somehow feels confusing.

Besides, the definition of "REFTABLE_INLINE(type)" being "static inline type", according to the explanation in [1/6], is valid only in the context of this project, so shouldn't it be done inside <reftable-system.h>, not <reftable/system.h>"? For that matter, what about inclusion of "compat/zlib-compat.h"? Is it widely applicable across target platforms, or very specific to our codebase where this library is used/embedded in?

Previous: Patrick SteinhardtNext: Patrick Steinhardt
Message 17 of 28 in “reftable: some more portability improvements”
  1. 0/6 reftable: some more portability improvementsPatrick Steinhardt, Mar 31, 2026
  2. 1/6 reftable/system: provide `REFTABLE_INLINE()` macroPatrick Steinhardt, Mar 31, 2026
  3. Junio C HamanoMar 31, 2026
  4. René ScharfeMar 31, 2026
  5. Junio C HamanoMar 31, 2026
  6. René ScharfeMar 31, 2026
  7. brian m. carlsonMar 31, 2026
  8. Patrick SteinhardtApr 1, 2026
  9. 2/6 reftable/stack: don't call fsync(3p) unless providedPatrick Steinhardt, Mar 31, 2026
  10. Junio C HamanoMar 31, 2026
  11. Patrick SteinhardtApr 1, 2026
  12. 3/6 reftable/fsck: use REFTABLE_UNUSED instead of UNUSEDPatrick Steinhardt, Mar 31, 2026
  13. Junio C HamanoMar 31, 2026
  14. 4/6 reftable/system: add abstraction to retrieve time in millisecondsPatrick Steinhardt, Mar 31, 2026
  15. 5/6 reftable/system: add abstraction to mmap filesPatrick Steinhardt, Mar 31, 2026
  16. 6/6 reftable: introduce "reftable-system.h" headerPatrick Steinhardt, Mar 31, 2026
  17. Junio C HamanoMar 31, 2026
  18. Patrick SteinhardtApr 1, 2026
  19. Junio C HamanoApr 1, 2026
  20. Patrick SteinhardtApr 2, 2026
  21. 0/5 reftable: some more portability improvementsPatrick Steinhardt, Apr 2, 2026
  22. 1/5 reftable: introduce "reftable-system.h" headerPatrick Steinhardt, Apr 2, 2026
  23. 2/5 reftable/stack: provide fsync(3p) via system headerPatrick Steinhardt, Apr 2, 2026
  24. Junio C HamanoApr 2, 2026
  25. 3/5 reftable/fsck: use REFTABLE_UNUSED instead of UNUSEDPatrick Steinhardt, Apr 2, 2026
  26. 4/5 reftable/system: add abstraction to retrieve time in millisecondsPatrick Steinhardt, Apr 2, 2026
  27. Junio C HamanoApr 2, 2026
  28. 5/5 reftable/system: add abstraction to mmap filesPatrick Steinhardt, Apr 2, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.