2 * State diagram and cleanup
3 * -------------------------
5 * If the program exits while a temporary file is active, we want to
6 * make sure that we remove it. This is done by remembering the active
7 * temporary files in a linked list, `tempfile_list`. An `atexit(3)`
8 * handler and a signal handler are registered, to clean up any active
11 * Because the signal handler can run at any time, `tempfile_list` and
12 * the `tempfile` objects that comprise it must be kept in
13 * self-consistent states at all times.
15 * The possible states of a `tempfile` object are as follows:
17 * - Uninitialized. In this state the object's `on_list` field must be
18 * zero but the rest of its contents need not be initialized. As
19 * soon as the object is used in any way, it is irrevocably
20 * registered in `tempfile_list`, and `on_list` is set.
22 * - Active, file open (after `create_tempfile()` or
23 * `reopen_tempfile()`). In this state:
25 * - the temporary file exists
27 * - `filename` holds the filename of the temporary file
28 * - `fd` holds a file descriptor open for writing to it
29 * - `fp` holds a pointer to an open `FILE` object if and only if
30 * `fdopen_tempfile()` has been called on the object
31 * - `owner` holds the PID of the process that created the file
33 * - Active, file closed (after `close_tempfile_gently()`). Same
34 * as the previous state, except that the temporary file is closed,
35 * `fd` is -1, and `fp` is `NULL`.
37 * - Inactive (after `delete_tempfile()`, `rename_tempfile()`, or a
38 * failed attempt to create a temporary file). In this state:
41 * - `filename` is empty (usually, though there are transitory
42 * states in which this condition doesn't hold). Client code should
43 * *not* rely on the filename being empty in this state.
44 * - `fd` is -1 and `fp` is `NULL`
45 * - the object is left registered in the `tempfile_list`, and
48 * A temporary file is owned by the process that created it. The
49 * `tempfile` has an `owner` field that records the owner's PID. This
50 * field is used to prevent a forked process from deleting a temporary
51 * file created by its parent.
58 static struct tempfile
*volatile tempfile_list
;
60 static void remove_tempfiles(int in_signal_handler
)
63 struct tempfile
*volatile p
;
65 for (p
= tempfile_list
; p
; p
= p
->next
) {
66 if (!is_tempfile_active(p
) || p
->owner
!= me
)
72 if (in_signal_handler
)
73 unlink(p
->filename
.buf
);
75 unlink_or_warn(p
->filename
.buf
);
81 static void remove_tempfiles_on_exit(void)
86 static void remove_tempfiles_on_signal(int signo
)
94 * Initialize *tempfile if necessary and add it to tempfile_list.
96 static void prepare_tempfile_object(struct tempfile
*tempfile
)
99 /* One-time initialization */
100 sigchain_push_common(remove_tempfiles_on_signal
);
101 atexit(remove_tempfiles_on_exit
);
104 if (is_tempfile_active(tempfile
))
105 BUG("prepare_tempfile_object called for active object");
106 if (!tempfile
->on_list
) {
107 /* Initialize *tempfile and add it to tempfile_list: */
110 tempfile
->active
= 0;
112 strbuf_init(&tempfile
->filename
, 0);
113 tempfile
->next
= tempfile_list
;
114 tempfile_list
= tempfile
;
115 tempfile
->on_list
= 1;
116 } else if (tempfile
->filename
.len
) {
117 /* This shouldn't happen, but better safe than sorry. */
118 BUG("prepare_tempfile_object called for improperly-reset object");
122 static void activate_tempfile(struct tempfile
*tempfile
)
124 tempfile
->owner
= getpid();
125 tempfile
->active
= 1;
128 static void deactivate_tempfile(struct tempfile
*tempfile
)
130 tempfile
->active
= 0;
131 strbuf_reset(&tempfile
->filename
);
134 /* Make sure errno contains a meaningful value on error */
135 int create_tempfile(struct tempfile
*tempfile
, const char *path
)
137 prepare_tempfile_object(tempfile
);
139 strbuf_add_absolute_path(&tempfile
->filename
, path
);
140 tempfile
->fd
= open(tempfile
->filename
.buf
,
141 O_RDWR
| O_CREAT
| O_EXCL
| O_CLOEXEC
, 0666);
142 if (O_CLOEXEC
&& tempfile
->fd
< 0 && errno
== EINVAL
)
143 /* Try again w/o O_CLOEXEC: the kernel might not support it */
144 tempfile
->fd
= open(tempfile
->filename
.buf
,
145 O_RDWR
| O_CREAT
| O_EXCL
, 0666);
146 if (tempfile
->fd
< 0) {
147 deactivate_tempfile(tempfile
);
150 activate_tempfile(tempfile
);
151 if (adjust_shared_perm(tempfile
->filename
.buf
)) {
152 int save_errno
= errno
;
153 error("cannot fix permission bits on %s", tempfile
->filename
.buf
);
154 delete_tempfile(tempfile
);
161 void register_tempfile(struct tempfile
*tempfile
, const char *path
)
163 prepare_tempfile_object(tempfile
);
164 strbuf_add_absolute_path(&tempfile
->filename
, path
);
165 activate_tempfile(tempfile
);
168 int mks_tempfile_sm(struct tempfile
*tempfile
,
169 const char *template, int suffixlen
, int mode
)
171 prepare_tempfile_object(tempfile
);
173 strbuf_add_absolute_path(&tempfile
->filename
, template);
174 tempfile
->fd
= git_mkstemps_mode(tempfile
->filename
.buf
, suffixlen
, mode
);
175 if (tempfile
->fd
< 0) {
176 deactivate_tempfile(tempfile
);
179 activate_tempfile(tempfile
);
183 int mks_tempfile_tsm(struct tempfile
*tempfile
,
184 const char *template, int suffixlen
, int mode
)
188 prepare_tempfile_object(tempfile
);
190 tmpdir
= getenv("TMPDIR");
194 strbuf_addf(&tempfile
->filename
, "%s/%s", tmpdir
, template);
195 tempfile
->fd
= git_mkstemps_mode(tempfile
->filename
.buf
, suffixlen
, mode
);
196 if (tempfile
->fd
< 0) {
197 deactivate_tempfile(tempfile
);
200 activate_tempfile(tempfile
);
204 int xmks_tempfile_m(struct tempfile
*tempfile
, const char *template, int mode
)
207 struct strbuf full_template
= STRBUF_INIT
;
209 strbuf_add_absolute_path(&full_template
, template);
210 fd
= mks_tempfile_m(tempfile
, full_template
.buf
, mode
);
212 die_errno("Unable to create temporary file '%s'",
215 strbuf_release(&full_template
);
219 FILE *fdopen_tempfile(struct tempfile
*tempfile
, const char *mode
)
221 if (!is_tempfile_active(tempfile
))
222 BUG("fdopen_tempfile() called for inactive object");
224 BUG("fdopen_tempfile() called for open object");
226 tempfile
->fp
= fdopen(tempfile
->fd
, mode
);
230 const char *get_tempfile_path(struct tempfile
*tempfile
)
232 if (!is_tempfile_active(tempfile
))
233 BUG("get_tempfile_path() called for inactive object");
234 return tempfile
->filename
.buf
;
237 int get_tempfile_fd(struct tempfile
*tempfile
)
239 if (!is_tempfile_active(tempfile
))
240 BUG("get_tempfile_fd() called for inactive object");
244 FILE *get_tempfile_fp(struct tempfile
*tempfile
)
246 if (!is_tempfile_active(tempfile
))
247 BUG("get_tempfile_fp() called for inactive object");
251 int close_tempfile_gently(struct tempfile
*tempfile
)
257 if (!is_tempfile_active(tempfile
) || tempfile
->fd
< 0)
279 int reopen_tempfile(struct tempfile
*tempfile
)
281 if (!is_tempfile_active(tempfile
))
282 BUG("reopen_tempfile called for an inactive object");
283 if (0 <= tempfile
->fd
)
284 BUG("reopen_tempfile called for an open object");
285 tempfile
->fd
= open(tempfile
->filename
.buf
, O_WRONLY
);
289 int rename_tempfile(struct tempfile
*tempfile
, const char *path
)
291 if (!is_tempfile_active(tempfile
))
292 BUG("rename_tempfile called for inactive object");
294 if (close_tempfile_gently(tempfile
)) {
295 delete_tempfile(tempfile
);
299 if (rename(tempfile
->filename
.buf
, path
)) {
300 int save_errno
= errno
;
301 delete_tempfile(tempfile
);
306 deactivate_tempfile(tempfile
);
310 void delete_tempfile(struct tempfile
*tempfile
)
312 if (!is_tempfile_active(tempfile
))
315 close_tempfile_gently(tempfile
);
316 unlink_or_warn(tempfile
->filename
.buf
);
317 deactivate_tempfile(tempfile
);