]>
Commit | Line | Data |
---|---|---|
021b6e45 JH |
1 | /* |
2 | * Copyright (c) 2005, Junio C Hamano | |
3 | */ | |
021b6e45 JH |
4 | #include "cache.h" |
5 | ||
6 | static struct lock_file *lock_file_list; | |
5e7f56ac | 7 | static const char *alternate_index_output; |
021b6e45 JH |
8 | |
9 | static void remove_lock_file(void) | |
10 | { | |
5e635e39 JH |
11 | pid_t me = getpid(); |
12 | ||
021b6e45 | 13 | while (lock_file_list) { |
5e635e39 | 14 | if (lock_file_list->owner == me && |
4723ee99 | 15 | lock_file_list->filename[0]) { |
d6cf61bf BC |
16 | if (lock_file_list->fd >= 0) |
17 | close(lock_file_list->fd); | |
021b6e45 | 18 | unlink(lock_file_list->filename); |
4723ee99 | 19 | } |
021b6e45 JH |
20 | lock_file_list = lock_file_list->next; |
21 | } | |
22 | } | |
23 | ||
24 | static void remove_lock_file_on_signal(int signo) | |
25 | { | |
26 | remove_lock_file(); | |
a1292939 | 27 | signal(signo, SIG_DFL); |
021b6e45 JH |
28 | raise(signo); |
29 | } | |
30 | ||
5d5a7a67 BS |
31 | /* |
32 | * p = absolute or relative path name | |
33 | * | |
34 | * Return a pointer into p showing the beginning of the last path name | |
35 | * element. If p is empty or the root directory ("/"), just return p. | |
36 | */ | |
37 | static char *last_path_elm(char *p) | |
38 | { | |
39 | /* r starts pointing to null at the end of the string */ | |
40 | char *r = strchr(p, '\0'); | |
41 | ||
42 | if (r == p) | |
43 | return p; /* just return empty string */ | |
44 | ||
45 | r--; /* back up to last non-null character */ | |
46 | ||
47 | /* back up past trailing slashes, if any */ | |
48 | while (r > p && *r == '/') | |
49 | r--; | |
50 | ||
51 | /* | |
52 | * then go backwards until I hit a slash, or the beginning of | |
53 | * the string | |
54 | */ | |
55 | while (r > p && *(r-1) != '/') | |
56 | r--; | |
57 | return r; | |
58 | } | |
59 | ||
60 | ||
61 | /* We allow "recursive" symbolic links. Only within reason, though */ | |
62 | #define MAXDEPTH 5 | |
63 | ||
64 | /* | |
65 | * p = path that may be a symlink | |
66 | * s = full size of p | |
67 | * | |
68 | * If p is a symlink, attempt to overwrite p with a path to the real | |
69 | * file or directory (which may or may not exist), following a chain of | |
70 | * symlinks if necessary. Otherwise, leave p unmodified. | |
71 | * | |
72 | * This is a best-effort routine. If an error occurs, p will either be | |
73 | * left unmodified or will name a different symlink in a symlink chain | |
74 | * that started with p's initial contents. | |
75 | * | |
76 | * Always returns p. | |
77 | */ | |
78 | ||
79 | static char *resolve_symlink(char *p, size_t s) | |
80 | { | |
81 | int depth = MAXDEPTH; | |
82 | ||
83 | while (depth--) { | |
84 | char link[PATH_MAX]; | |
85 | int link_len = readlink(p, link, sizeof(link)); | |
86 | if (link_len < 0) { | |
87 | /* not a symlink anymore */ | |
88 | return p; | |
89 | } | |
90 | else if (link_len < sizeof(link)) | |
91 | /* readlink() never null-terminates */ | |
92 | link[link_len] = '\0'; | |
93 | else { | |
94 | warning("%s: symlink too long", p); | |
95 | return p; | |
96 | } | |
97 | ||
ecf4831d | 98 | if (is_absolute_path(link)) { |
5d5a7a67 BS |
99 | /* absolute path simply replaces p */ |
100 | if (link_len < s) | |
101 | strcpy(p, link); | |
102 | else { | |
103 | warning("%s: symlink too long", p); | |
104 | return p; | |
105 | } | |
106 | } else { | |
107 | /* | |
108 | * link is a relative path, so I must replace the | |
109 | * last element of p with it. | |
110 | */ | |
111 | char *r = (char*)last_path_elm(p); | |
112 | if (r - p + link_len < s) | |
113 | strcpy(r, link); | |
114 | else { | |
115 | warning("%s: symlink too long", p); | |
116 | return p; | |
117 | } | |
118 | } | |
119 | } | |
120 | return p; | |
121 | } | |
122 | ||
123 | ||
40aaae88 | 124 | static int lock_file(struct lock_file *lk, const char *path) |
021b6e45 | 125 | { |
5d5a7a67 BS |
126 | if (strlen(path) >= sizeof(lk->filename)) return -1; |
127 | strcpy(lk->filename, path); | |
128 | /* | |
129 | * subtract 5 from size to make sure there's room for adding | |
130 | * ".lock" for the lock file name | |
131 | */ | |
132 | resolve_symlink(lk->filename, sizeof(lk->filename)-5); | |
133 | strcat(lk->filename, ".lock"); | |
4723ee99 JS |
134 | lk->fd = open(lk->filename, O_RDWR | O_CREAT | O_EXCL, 0666); |
135 | if (0 <= lk->fd) { | |
9a4cbdca SV |
136 | if (!lock_file_list) { |
137 | signal(SIGINT, remove_lock_file_on_signal); | |
ad5fa3cc PB |
138 | signal(SIGHUP, remove_lock_file_on_signal); |
139 | signal(SIGTERM, remove_lock_file_on_signal); | |
140 | signal(SIGQUIT, remove_lock_file_on_signal); | |
9a4cbdca SV |
141 | atexit(remove_lock_file); |
142 | } | |
5e635e39 | 143 | lk->owner = getpid(); |
1084b845 | 144 | if (!lk->on_list) { |
138086a7 JH |
145 | lk->next = lock_file_list; |
146 | lock_file_list = lk; | |
1084b845 JH |
147 | lk->on_list = 1; |
148 | } | |
138086a7 JH |
149 | if (adjust_shared_perm(lk->filename)) |
150 | return error("cannot fix permission bits on %s", | |
151 | lk->filename); | |
021b6e45 | 152 | } |
1084b845 JH |
153 | else |
154 | lk->filename[0] = 0; | |
4723ee99 | 155 | return lk->fd; |
021b6e45 JH |
156 | } |
157 | ||
40aaae88 JH |
158 | int hold_lock_file_for_update(struct lock_file *lk, const char *path, int die_on_error) |
159 | { | |
160 | int fd = lock_file(lk, path); | |
161 | if (fd < 0 && die_on_error) | |
f9e8a43a | 162 | die("unable to create '%s.lock': %s", path, strerror(errno)); |
40aaae88 JH |
163 | return fd; |
164 | } | |
165 | ||
ea3cd5c7 DB |
166 | int hold_lock_file_for_append(struct lock_file *lk, const char *path, int die_on_error) |
167 | { | |
168 | int fd, orig_fd; | |
169 | ||
170 | fd = lock_file(lk, path); | |
171 | if (fd < 0) { | |
172 | if (die_on_error) | |
173 | die("unable to create '%s.lock': %s", path, strerror(errno)); | |
174 | return fd; | |
175 | } | |
176 | ||
177 | orig_fd = open(path, O_RDONLY); | |
178 | if (orig_fd < 0) { | |
179 | if (errno != ENOENT) { | |
180 | if (die_on_error) | |
181 | die("cannot open '%s' for copying", path); | |
182 | close(fd); | |
183 | return error("cannot open '%s' for copying", path); | |
184 | } | |
185 | } else if (copy_fd(orig_fd, fd)) { | |
186 | if (die_on_error) | |
187 | exit(128); | |
188 | close(fd); | |
189 | return -1; | |
190 | } | |
191 | return fd; | |
192 | } | |
193 | ||
d6cf61bf BC |
194 | int close_lock_file(struct lock_file *lk) |
195 | { | |
196 | int fd = lk->fd; | |
197 | lk->fd = -1; | |
198 | return close(fd); | |
199 | } | |
200 | ||
021b6e45 JH |
201 | int commit_lock_file(struct lock_file *lk) |
202 | { | |
203 | char result_file[PATH_MAX]; | |
d6cf61bf BC |
204 | size_t i; |
205 | if (lk->fd >= 0 && close_lock_file(lk)) | |
206 | return -1; | |
021b6e45 JH |
207 | strcpy(result_file, lk->filename); |
208 | i = strlen(result_file) - 5; /* .lock */ | |
209 | result_file[i] = 0; | |
d6cf61bf BC |
210 | if (rename(lk->filename, result_file)) |
211 | return -1; | |
021b6e45 | 212 | lk->filename[0] = 0; |
d6cf61bf | 213 | return 0; |
021b6e45 JH |
214 | } |
215 | ||
30ca07a2 JH |
216 | int hold_locked_index(struct lock_file *lk, int die_on_error) |
217 | { | |
218 | return hold_lock_file_for_update(lk, get_index_file(), die_on_error); | |
219 | } | |
220 | ||
5e7f56ac JH |
221 | void set_alternate_index_output(const char *name) |
222 | { | |
223 | alternate_index_output = name; | |
224 | } | |
225 | ||
30ca07a2 JH |
226 | int commit_locked_index(struct lock_file *lk) |
227 | { | |
5e7f56ac | 228 | if (alternate_index_output) { |
d6cf61bf BC |
229 | if (lk->fd >= 0 && close_lock_file(lk)) |
230 | return -1; | |
231 | if (rename(lk->filename, alternate_index_output)) | |
232 | return -1; | |
30ca07a2 | 233 | lk->filename[0] = 0; |
d6cf61bf | 234 | return 0; |
30ca07a2 JH |
235 | } |
236 | else | |
237 | return commit_lock_file(lk); | |
238 | } | |
239 | ||
021b6e45 JH |
240 | void rollback_lock_file(struct lock_file *lk) |
241 | { | |
4723ee99 | 242 | if (lk->filename[0]) { |
d6cf61bf BC |
243 | if (lk->fd >= 0) |
244 | close(lk->fd); | |
021b6e45 | 245 | unlink(lk->filename); |
4723ee99 | 246 | } |
021b6e45 JH |
247 | lk->filename[0] = 0; |
248 | } |