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

Re: [PATCH v4 01/44] wrapper: implement xopen()

From
Stefan Beller <sbeller@google.com>
Date
Jun 29, 2015, 05:04 UTC
Message-ID
<CAGZ79kYYGpB6wGO6r67P0NLP9fda_UjZtLfwqmrWZrCKOYqZWQ@mail.gmail.com>
In-Reply-To
<5590CE10.3020104@web.de>
On Sun, Jun 28, 2015 at 9:48 PM, Torsten Bögershausen <tboegi@web.de> wrote:
Show 60 quoted lines
> On 06/28/2015 04:05 PM, Paul Tan wrote:
>>
>> A common usage pattern of open() is to check if it was successful, and
>> die() if it was not:
>>
>>         int fd = open(path, O_WRONLY | O_CREAT, 0777);
>>         if (fd < 0)
>>                 die_errno(_("Could not open '%s' for writing."), path);
>>
>> Implement a wrapper function xopen() that does the above so that we can
>> save a few lines of code, and make the die() messages consistent.
>>
>> Helped-by: Torsten Bögershausen <tboegi@web.de>
>> Helped-by: Jeff King <peff@peff.net>
>> Signed-off-by: Paul Tan <pyokagan@gmail.com>
>> ---
>>   git-compat-util.h |  1 +
>>   wrapper.c         | 25 +++++++++++++++++++++++++
>>   2 files changed, 26 insertions(+)
>>
>> diff --git a/git-compat-util.h b/git-compat-util.h
>> index c6d391f..e168dfd 100644
>> --- a/git-compat-util.h
>> +++ b/git-compat-util.h
>> @@ -717,6 +717,7 @@ extern void *xrealloc(void *ptr, size_t size);
>>   extern void *xcalloc(size_t nmemb, size_t size);
>>   extern void *xmmap(void *start, size_t length, int prot, int flags, int
>> fd, off_t offset);
>>   extern void *xmmap_gently(void *start, size_t length, int prot, int
>> flags, int fd, off_t offset);
>> +extern int xopen(const char *path, int flags, ...);
>>   extern ssize_t xread(int fd, void *buf, size_t len);
>>   extern ssize_t xwrite(int fd, const void *buf, size_t len);
>>   extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
>> diff --git a/wrapper.c b/wrapper.c
>> index ff49807..7e13ae0 100644
>> --- a/wrapper.c
>> +++ b/wrapper.c
>> @@ -189,6 +189,31 @@ void *xcalloc(size_t nmemb, size_t size)
>>   # endif
>>   #endif
>>   +/**
>> + * xopen() is the same as open(), but it die()s if the open() fails.
>> + */
>> +int xopen(const char *path, int oflag, ...)
>> +{
>> +       mode_t mode = 0;
>> +       va_list ap;
>> +
>> +       va_start(ap, oflag);
>> +       if (oflag & O_CREAT)
>> +               mode = va_arg(ap, mode_t);
>> +       va_end(ap);
>> +
>> +       assert(path);
>> +
>
> 2 remarks:
> - I don't know if and why we need the assert() here (but don't know if we
> have a strategie in Git for assert())
Yeah I think we usually do
    if (!assertion)
        die("BUG: assertion not met");
Show 32 quoted lines
> - Having xopen() with 2 or 3 parameter is good, but the current may need
> some tweaks for better portability:
>
> int xopen(const char *path, int oflag, ...)
> {
>         mode_t mode = 0;
>         if (oflag & O_CREAT) {
>                 va_list ap;
>                 va_start(ap, oflag);
>                 mode = va_arg(ap, int);
>                 va_end(ap);
>
>             }
>
> See e.g.
> <http://blitiri.com.ar/git/r/libfiu/c/37f6a98110e3bb59bbb4971241baa3a385c3f724/>
> why va_arg(ap, int) should be used:
>
>
> +
> +               /* va_arg() can only take fully promoted types, and mode_t
> +                * sometimes is smaller than an int, so we should always
> pass
> +                * int to it, and not mode_t. Not doing so would may result
> in
> +                * a compile-time warning and run-time error. We asume that
> it
> +                * is never bigger than an int, which holds in practise. */
> +               mode = va_arg(l, int);
> +
>
>
Previous: Torsten BögershausenNext: Junio C Hamano
Message 4 of 74 in “Make git-am a builtin”
  1. 00/44 Make git-am a builtinPaul Tan, Jun 28, 2015
  2. 01/44 wrapper: implement xopen()Paul Tan, Jun 28, 2015
  3. Torsten BögershausenJun 29, 2015
  4. Stefan BellerJun 29, 2015
  5. Junio C HamanoJun 29, 2015
  6. Paul TanJul 1, 2015
  7. Paul TanJul 1, 2015
  8. 02/44 wrapper: implement xfopen()Paul Tan, Jun 28, 2015
  9. 03/44 builtin-am: implement skeletal builtin amPaul Tan, Jun 28, 2015
  10. 04/44 builtin-am: implement patch queue mechanismPaul Tan, Jun 28, 2015
  11. Stefan BellerJun 29, 2015
  12. Paul TanJul 7, 2015
  13. 05/44 builtin-am: split out mbox/maildir patches with git-mailsplitPaul Tan, Jun 28, 2015
  14. 06/44 builtin-am: auto-detect mbox patchesPaul Tan, Jun 28, 2015
  15. 07/44 builtin-am: extract patch and commit info with git-mailinfoPaul Tan, Jun 28, 2015
  16. 08/44 builtin-am: apply patch with git-applyPaul Tan, Jun 28, 2015
  17. 09/44 builtin-am: implement committing applied patchPaul Tan, Jun 28, 2015
  18. 10/44 builtin-am: refuse to apply patches if index is dirtyPaul Tan, Jun 28, 2015
  19. 11/44 builtin-am: implement --resolved/--continuePaul Tan, Jun 28, 2015
  20. 12/44 builtin-am: implement --skipPaul Tan, Jun 28, 2015
  21. 13/44 builtin-am: implement --abortPaul Tan, Jun 28, 2015
  22. 14/44 builtin-am: reject patches when there's a session in progressPaul Tan, Jun 28, 2015
  23. 15/44 builtin-am: implement -q/--quiet, GIT_QUIETPaul Tan, Jun 28, 2015
  24. 16/44 builtin-am: exit with user friendly message on failurePaul Tan, Jun 28, 2015
  25. 17/44 builtin-am: implement -s/--signoffPaul Tan, Jun 28, 2015
  26. 18/44 cache-tree: introduce write_index_as_tree()Paul Tan, Jun 28, 2015
  27. 19/44 builtin-am: implement --3way, am.threewayPaul Tan, Jun 28, 2015
  28. Stefan BellerJun 30, 2015
  29. 20/44 builtin-am: implement --rebasing modePaul Tan, Jun 28, 2015
  30. 21/44 builtin-am: bypass git-mailinfo when --rebasingPaul Tan, Jun 28, 2015
  31. 22/44 builtin-am: handle stray state directoryPaul Tan, Jun 28, 2015
  32. 23/44 builtin-am: implement -u/--utf8Paul Tan, Jun 28, 2015
  33. 24/44 builtin-am: implement -k/--keep, --keep-non-patchPaul Tan, Jun 28, 2015
  34. 25/44 builtin-am: implement --[no-]message-id, am.messageidPaul Tan, Jun 28, 2015
  35. 26/44 builtin-am: support --keep-cr, am.keepcrPaul Tan, Jun 28, 2015
  36. 27/44 builtin-am: implement --[no-]scissorsPaul Tan, Jun 28, 2015
  37. Paul TanJul 7, 2015
  38. 28/44 builtin-am: pass git-apply's options to git-applyPaul Tan, Jun 28, 2015
  39. Stefan BellerJun 29, 2015
  40. Paul TanJul 1, 2015
  41. Stefan BellerJul 1, 2015
  42. 29/44 builtin-am: implement --ignore-datePaul Tan, Jun 28, 2015
  43. 30/44 builtin-am: implement --committer-date-is-author-datePaul Tan, Jun 28, 2015
  44. 31/44 builtin-am: implement -S/--gpg-sign, commit.gpgsignPaul Tan, Jun 28, 2015
  45. Stefan BellerJun 29, 2015
  46. Paul TanJul 1, 2015
  47. Stefan BellerJul 1, 2015
  48. 32/44 builtin-am: invoke post-rewrite hookPaul Tan, Jun 28, 2015
  49. 33/44 builtin-am: support automatic notes copyingPaul Tan, Jun 28, 2015
  50. 34/44 builtin-am: invoke applypatch-msg hookPaul Tan, Jun 28, 2015
  51. 35/44 builtin-am: invoke pre-applypatch hookPaul Tan, Jun 28, 2015
  52. 36/44 builtin-am: invoke post-applypatch hookPaul Tan, Jun 28, 2015
  53. 37/44 builtin-am: rerere supportPaul Tan, Jun 28, 2015
  54. 38/44 builtin-am: support and auto-detect StGit patchesPaul Tan, Jun 28, 2015
  55. Stefan BellerJun 29, 2015
  56. Eric SunshineJun 29, 2015
  57. Junio C HamanoJun 29, 2015
  58. Paul TanJul 1, 2015
  59. 39/44 builtin-am: support and auto-detect StGit series filesPaul Tan, Jun 28, 2015
  60. 40/44 builtin-am: support and auto-detect mercurial patchesPaul Tan, Jun 28, 2015
  61. Stefan BellerJun 29, 2015
  62. Stefan BellerJun 29, 2015
  63. Paul TanJul 1, 2015
  64. Paul TanJul 1, 2015
  65. 41/44 builtin-am: implement -i/--interactivePaul Tan, Jun 28, 2015
  66. 42/44 builtin-am: implement legacy -b/--binary optionPaul Tan, Jun 28, 2015
  67. Stefan BellerJun 29, 2015
  68. 43/44 builtin-am: check for valid committer identPaul Tan, Jun 28, 2015
  69. Stefan BellerJun 29, 2015
  70. Paul TanJul 1, 2015
  71. 44/44 builtin-am: remove redirection to git-am.shPaul Tan, Jun 28, 2015
  72. Stefan BellerJun 29, 2015
  73. Stefan BellerJun 30, 2015
  74. Paul TanJul 14, 2015

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.