Skip to content

Commit

Permalink
Merge branch 'rs/xopen-reports-open-failures'
Browse files Browse the repository at this point in the history
Error diagnostics improvement.

* rs/xopen-reports-open-failures:
  use xopen() to handle fatal open(2) failures
  xopen: explicitly report creation failures
  • Loading branch information
gitster committed Sep 8, 2021
2 parents c8f4916 + 66e905b commit 7b06222
Show file tree
Hide file tree
Showing 16 changed files with 36 additions and 53 deletions.
4 changes: 1 addition & 3 deletions builtin/add.c
Original file line number Diff line number Diff line change
Expand Up @@ -319,9 +319,7 @@ static int edit_patch(int argc, const char **argv, const char *prefix)
rev.diffopt.output_format = DIFF_FORMAT_PATCH;
rev.diffopt.use_color = 0;
rev.diffopt.flags.ignore_dirty_submodules = 1;
out = open(file, O_CREAT | O_WRONLY | O_TRUNC, 0666);
if (out < 0)
die(_("Could not open '%s' for writing."), file);
out = xopen(file, O_CREAT | O_WRONLY | O_TRUNC, 0666);
rev.diffopt.file = xfdopen(out, "w");
rev.diffopt.close_file = 1;
if (run_diff_files(&rev, 0))
Expand Down
4 changes: 1 addition & 3 deletions builtin/archive.c
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@

static void create_output_file(const char *output_file)
{
int output_fd = open(output_file, O_CREAT | O_WRONLY | O_TRUNC, 0666);
if (output_fd < 0)
die_errno(_("could not create archive file '%s'"), output_file);
int output_fd = xopen(output_file, O_CREAT | O_WRONLY | O_TRUNC, 0666);
if (output_fd != 1) {
if (dup2(output_fd, 1) < 0)
die_errno(_("could not redirect output"));
Expand Down
5 changes: 1 addition & 4 deletions builtin/bugreport.c
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,7 @@ int cmd_bugreport(int argc, const char **argv, const char *prefix)
get_populated_hooks(&buffer, !startup_info->have_repository);

/* fopen doesn't offer us an O_EXCL alternative, except with glibc. */
report = open(report_path.buf, O_CREAT | O_EXCL | O_WRONLY, 0666);

if (report < 0)
die(_("couldn't create a new file at '%s'"), report_path.buf);
report = xopen(report_path.buf, O_CREAT | O_EXCL | O_WRONLY, 0666);

if (write_in_full(report, buffer.buf, buffer.len) < 0)
die_errno(_("unable to write to %s"), report_path.buf);
Expand Down
4 changes: 1 addition & 3 deletions builtin/commit-tree.c
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,7 @@ static int parse_file_arg_callback(const struct option *opt,
if (!strcmp(arg, "-"))
fd = 0;
else {
fd = open(arg, O_RDONLY);
if (fd < 0)
die_errno(_("git commit-tree: failed to open '%s'"), arg);
fd = xopen(arg, O_RDONLY);
}
if (strbuf_read(buf, fd, 0) < 0)
die_errno(_("git commit-tree: failed to read '%s'"), arg);
Expand Down
4 changes: 1 addition & 3 deletions builtin/hash-object.c
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ static void hash_object(const char *path, const char *type, const char *vpath,
unsigned flags, int literally)
{
int fd;
fd = open(path, O_RDONLY);
if (fd < 0)
die_errno("Cannot open '%s'", path);
fd = xopen(path, O_RDONLY);
hash_fd(fd, type, vpath, flags, literally);
}

Expand Down
8 changes: 2 additions & 6 deletions builtin/index-pack.c
Original file line number Diff line number Diff line change
Expand Up @@ -338,15 +338,11 @@ static const char *open_pack_file(const char *pack_name)
"pack/tmp_pack_XXXXXX");
pack_name = strbuf_detach(&tmp_file, NULL);
} else {
output_fd = open(pack_name, O_CREAT|O_EXCL|O_RDWR, 0600);
if (output_fd < 0)
die_errno(_("unable to create '%s'"), pack_name);
output_fd = xopen(pack_name, O_CREAT|O_EXCL|O_RDWR, 0600);
}
nothread_data.pack_fd = output_fd;
} else {
input_fd = open(pack_name, O_RDONLY);
if (input_fd < 0)
die_errno(_("cannot open packfile '%s'"), pack_name);
input_fd = xopen(pack_name, O_RDONLY);
output_fd = -1;
nothread_data.pack_fd = input_fd;
}
Expand Down
4 changes: 1 addition & 3 deletions builtin/mailsplit.c
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,7 @@ static int split_one(FILE *mbox, const char *name, int allow_bare)
fprintf(stderr, "corrupt mailbox\n");
exit(1);
}
fd = open(name, O_WRONLY | O_CREAT | O_EXCL, 0666);
if (fd < 0)
die_errno("cannot open output file '%s'", name);
fd = xopen(name, O_WRONLY | O_CREAT | O_EXCL, 0666);
output = xfdopen(fd, "w");

/* Copy it out, while searching for a line that begins with
Expand Down
4 changes: 1 addition & 3 deletions builtin/merge.c
Original file line number Diff line number Diff line change
Expand Up @@ -1138,9 +1138,7 @@ static void handle_fetch_head(struct commit_list **remotes, struct strbuf *merge
merge_names = &fetch_head_file;

filename = git_path_fetch_head(the_repository);
fd = open(filename, O_RDONLY);
if (fd < 0)
die_errno(_("could not open '%s' for reading"), filename);
fd = xopen(filename, O_RDONLY);

if (strbuf_read(merge_names, fd, 0) < 0)
die_errno(_("could not read '%s'"), filename);
Expand Down
4 changes: 1 addition & 3 deletions builtin/notes.c
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,7 @@ static void prepare_note_data(const struct object_id *object, struct note_data *

/* write the template message before editing: */
d->edit_path = git_pathdup("NOTES_EDITMSG");
fd = open(d->edit_path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
if (fd < 0)
die_errno(_("could not create file '%s'"), d->edit_path);
fd = xopen(d->edit_path, O_CREAT | O_TRUNC | O_WRONLY, 0600);

if (d->given)
write_or_die(fd, d->buf.buf, d->buf.len);
Expand Down
4 changes: 1 addition & 3 deletions builtin/tag.c
Original file line number Diff line number Diff line change
Expand Up @@ -293,9 +293,7 @@ static void create_tag(const struct object_id *object, const char *object_ref,

/* write the template message before editing: */
path = git_pathdup("TAG_EDITMSG");
fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
if (fd < 0)
die_errno(_("could not create file '%s'"), path);
fd = xopen(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);

if (opt->message_given) {
write_or_die(fd, buf->buf, buf->len);
Expand Down
4 changes: 1 addition & 3 deletions builtin/update-index.c
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,7 @@ static int create_file(const char *path)
{
int fd;
path = get_mtime_path(path);
fd = open(path, O_CREAT | O_RDWR, 0644);
if (fd < 0)
die_errno(_("failed to create file %s"), path);
fd = xopen(path, O_CREAT | O_RDWR, 0644);
return fd;
}

Expand Down
16 changes: 16 additions & 0 deletions contrib/coccinelle/xopen.cocci
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
@@
identifier fd;
identifier die_fn =~ "^(die|die_errno)$";
@@
(
fd =
- open
+ xopen
(...);
|
int fd =
- open
+ xopen
(...);
)
- if ( \( fd < 0 \| fd == -1 \) ) { die_fn(...); }
8 changes: 2 additions & 6 deletions csum-file.c
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,8 @@ struct hashfile *hashfd_check(const char *name)
int sink, check;
struct hashfile *f;

sink = open("/dev/null", O_WRONLY);
if (sink < 0)
die_errno("unable to open /dev/null");
check = open(name, O_RDONLY);
if (check < 0)
die_errno("unable to open '%s'", name);
sink = xopen("/dev/null", O_WRONLY);
check = xopen(name, O_RDONLY);
f = hashfd(sink, name);
f->check_fd = check;
f->check_buffer = xmalloc(f->buffer_len);
Expand Down
8 changes: 2 additions & 6 deletions pack-write.c
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,7 @@ const char *write_idx_file(const char *index_name, struct pack_idx_entry **objec
index_name = strbuf_detach(&tmp_file, NULL);
} else {
unlink(index_name);
fd = open(index_name, O_CREAT|O_EXCL|O_WRONLY, 0600);
if (fd < 0)
die_errno("unable to create '%s'", index_name);
fd = xopen(index_name, O_CREAT|O_EXCL|O_WRONLY, 0600);
}
f = hashfd(fd, index_name);
}
Expand Down Expand Up @@ -256,9 +254,7 @@ const char *write_rev_file_order(const char *rev_name,
rev_name = strbuf_detach(&tmp_file, NULL);
} else {
unlink(rev_name);
fd = open(rev_name, O_CREAT|O_EXCL|O_WRONLY, 0600);
if (fd < 0)
die_errno("unable to create '%s'", rev_name);
fd = xopen(rev_name, O_CREAT|O_EXCL|O_WRONLY, 0600);
}
f = hashfd(fd, rev_name);
} else if (flags & WRITE_REV_VERIFY) {
Expand Down
4 changes: 1 addition & 3 deletions run-command.c
Original file line number Diff line number Diff line change
Expand Up @@ -761,9 +761,7 @@ int start_command(struct child_process *cmd)
notify_pipe[0] = notify_pipe[1] = -1;

if (cmd->no_stdin || cmd->no_stdout || cmd->no_stderr) {
null_fd = open("/dev/null", O_RDWR | O_CLOEXEC);
if (null_fd < 0)
die_errno(_("open /dev/null failed"));
null_fd = xopen("/dev/null", O_RDWR | O_CLOEXEC);
set_cloexec(null_fd);
}

Expand Down
4 changes: 3 additions & 1 deletion wrapper.c
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,9 @@ int xopen(const char *path, int oflag, ...)
if (errno == EINTR)
continue;

if ((oflag & O_RDWR) == O_RDWR)
if ((oflag & (O_CREAT | O_EXCL)) == (O_CREAT | O_EXCL))
die_errno(_("unable to create '%s'"), path);
else 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);
Expand Down

0 comments on commit 7b06222

Please sign in to comment.