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

[PATCH v7 01/45] wrapper: implement xopen()

From
Paul Tan <pyokagan@gmail.com>
Date
Aug 4, 2015, 13:51 UTC
Message-ID
<1438696326-19590-2-git-send-email-pyokagan@gmail.com>
In-Reply-To
<1438696326-19590-1-git-send-email-pyokagan@gmail.com>

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>
Helped-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Paul Tan <pyokagan@gmail.com>
---
 git-compat-util.h |  1 +
 wrapper.c         | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 36 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..0a4502d 100644
--- a/wrapper.c
+++ b/wrapper.c
@@ -189,6 +189,41 @@ 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_arg() will have undefined behavior if the specified type is not
+	 * compatible with the argument type. Since integers are promoted to
+	 * ints, we fetch the next argument as an int, and then cast it to a
+	 * mode_t to avoid undefined behavior.
+	 */
+	va_start(ap, oflag);
+	if (oflag & O_CREAT)
+		mode = va_arg(ap, int);
+	va_end(ap);
+
+	for (;;) {
+		int fd = open(path, oflag, mode);
+		if (fd >= 0)
+			return fd;
+		if (errno == EINTR)
+			continue;
+
+		if ((oflag & O_RDWR) == O_RDWR)
+			die_errno(_("could not open '%s' for reading and writing"), path);
+		else if ((oflag & O_WRONLY) == O_WRONLY)
+			die_errno(_("could not open '%s' for writing"), path);
+		else
+			die_errno(_("could not open '%s' for reading"), path);
+	}
+}
+
 /*
  * xread() is the same a read(), but it automatically restarts read()
  * operations with a recoverable error (EAGAIN and EINTR). xread()
-- 
2.5.0.280.gd88bd6e
Previous: Paul TanNext: Paul Tan
Message 2 of 46 in “Make git-am a builtin”
  1. 00/45 Make git-am a builtinPaul Tan, Aug 4, 2015
  2. 01/45 wrapper: implement xopen()Paul Tan, Aug 4, 2015
  3. 02/45 wrapper: implement xfopen()Paul Tan, Aug 4, 2015
  4. 03/45 builtin-am: implement skeletal builtin amPaul Tan, Aug 4, 2015
  5. 04/45 builtin-am: implement patch queue mechanismPaul Tan, Aug 4, 2015
  6. 05/45 builtin-am: split out mbox/maildir patches with git-mailsplitPaul Tan, Aug 4, 2015
  7. 06/45 builtin-am: auto-detect mbox patchesPaul Tan, Aug 4, 2015
  8. 07/45 builtin-am: extract patch and commit info with git-mailinfoPaul Tan, Aug 4, 2015
  9. 08/45 builtin-am: apply patch with git-applyPaul Tan, Aug 4, 2015
  10. 09/45 builtin-am: implement committing applied patchPaul Tan, Aug 4, 2015
  11. 10/45 builtin-am: refuse to apply patches if index is dirtyPaul Tan, Aug 4, 2015
  12. 11/45 builtin-am: implement --resolved/--continuePaul Tan, Aug 4, 2015
  13. 12/45 builtin-am: don't parse mail when resumingPaul Tan, Aug 4, 2015
  14. 13/45 builtin-am: implement --skipPaul Tan, Aug 4, 2015
  15. 14/45 builtin-am: implement --abortPaul Tan, Aug 4, 2015
  16. 15/45 builtin-am: reject patches when there's a session in progressPaul Tan, Aug 4, 2015
  17. 16/45 builtin-am: implement -q/--quietPaul Tan, Aug 4, 2015
  18. 17/45 builtin-am: exit with user friendly message on failurePaul Tan, Aug 4, 2015
  19. 18/45 builtin-am: implement -s/--signoffPaul Tan, Aug 4, 2015
  20. 19/45 cache-tree: introduce write_index_as_tree()Paul Tan, Aug 4, 2015
  21. 20/45 builtin-am: implement --3wayPaul Tan, Aug 4, 2015
  22. 21/45 builtin-am: implement --rebasing modePaul Tan, Aug 4, 2015
  23. 22/45 builtin-am: bypass git-mailinfo when --rebasingPaul Tan, Aug 4, 2015
  24. 23/45 builtin-am: handle stray state directoryPaul Tan, Aug 4, 2015
  25. 24/45 builtin-am: implement -u/--utf8Paul Tan, Aug 4, 2015
  26. 25/45 builtin-am: implement -k/--keep, --keep-non-patchPaul Tan, Aug 4, 2015
  27. 26/45 builtin-am: implement --[no-]message-id, am.messageidPaul Tan, Aug 4, 2015
  28. 27/45 builtin-am: support --keep-cr, am.keepcrPaul Tan, Aug 4, 2015
  29. 28/45 builtin-am: implement --[no-]scissorsPaul Tan, Aug 4, 2015
  30. 29/45 builtin-am: pass git-apply's options to git-applyPaul Tan, Aug 4, 2015
  31. 30/45 builtin-am: implement --ignore-datePaul Tan, Aug 4, 2015
  32. 31/45 builtin-am: implement --committer-date-is-author-datePaul Tan, Aug 4, 2015
  33. 32/45 builtin-am: implement -S/--gpg-sign, commit.gpgsignPaul Tan, Aug 4, 2015
  34. 33/45 builtin-am: invoke post-rewrite hookPaul Tan, Aug 4, 2015
  35. 34/45 builtin-am: support automatic notes copyingPaul Tan, Aug 4, 2015
  36. 35/45 builtin-am: invoke applypatch-msg hookPaul Tan, Aug 4, 2015
  37. 36/45 builtin-am: invoke pre-applypatch hookPaul Tan, Aug 4, 2015
  38. 37/45 builtin-am: invoke post-applypatch hookPaul Tan, Aug 4, 2015
  39. 38/45 builtin-am: rerere supportPaul Tan, Aug 4, 2015
  40. 39/45 builtin-am: support and auto-detect StGit patchesPaul Tan, Aug 4, 2015
  41. 40/45 builtin-am: support and auto-detect StGit series filesPaul Tan, Aug 4, 2015
  42. 41/45 builtin-am: support and auto-detect mercurial patchesPaul Tan, Aug 4, 2015
  43. 42/45 builtin-am: implement -i/--interactivePaul Tan, Aug 4, 2015
  44. 43/45 builtin-am: implement legacy -b/--binary optionPaul Tan, Aug 4, 2015
  45. 44/45 builtin-am: check for valid committer identPaul Tan, Aug 4, 2015
  46. 45/45 builtin-am: remove redirection to git-am.shPaul Tan, Aug 4, 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.