Commit | Line | Data |
---|---|---|
b97771fc | 1 | /* Lock files for editing. |
0b5538bd | 2 | Copyright (C) 1985, 1986, 1987, 1993, 1994, 1996, 1998, 1999, 2000, 2001, |
5df4f04c | 3 | 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 |
8cabe764 | 4 | Free Software Foundation, Inc. |
8489eb67 RS |
5 | |
6 | This file is part of GNU Emacs. | |
7 | ||
9ec0b715 | 8 | GNU Emacs is free software: you can redistribute it and/or modify |
8489eb67 | 9 | it under the terms of the GNU General Public License as published by |
9ec0b715 GM |
10 | the Free Software Foundation, either version 3 of the License, or |
11 | (at your option) any later version. | |
8489eb67 RS |
12 | |
13 | GNU Emacs is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
9ec0b715 | 19 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
8489eb67 RS |
20 | |
21 | ||
68c45bf0 | 22 | #include <config.h> |
8489eb67 RS |
23 | #include <sys/types.h> |
24 | #include <sys/stat.h> | |
dfcf069d | 25 | #include <signal.h> |
2decc5a9 | 26 | #include <stdio.h> |
d7306fe6 | 27 | #include <setjmp.h> |
bfb61299 | 28 | |
5b9c0a1d | 29 | #ifdef HAVE_PWD_H |
8489eb67 | 30 | #include <pwd.h> |
5b9c0a1d | 31 | #endif |
bfb61299 | 32 | |
8489eb67 | 33 | #include <sys/file.h> |
8489eb67 | 34 | #include <fcntl.h> |
dfcf069d | 35 | #include <unistd.h> |
dfcf069d | 36 | |
f805a125 | 37 | #ifdef __FreeBSD__ |
f805a125 KH |
38 | #include <sys/sysctl.h> |
39 | #endif /* __FreeBSD__ */ | |
40 | ||
e5ef3cdf | 41 | #include <errno.h> |
e5ef3cdf | 42 | |
8489eb67 | 43 | #include "lisp.h" |
8489eb67 | 44 | #include "buffer.h" |
d2f6dae8 | 45 | #include "character.h" |
f4a4528d | 46 | #include "coding.h" |
9177d978 | 47 | #include "systime.h" |
8489eb67 | 48 | |
8489eb67 | 49 | #ifdef CLASH_DETECTION |
e788eecc | 50 | |
c6d09b8d | 51 | #ifdef HAVE_UTMP_H |
e788eecc | 52 | #include <utmp.h> |
c6d09b8d | 53 | #endif |
77e544a4 | 54 | |
fa5c314d RS |
55 | #if !defined (S_ISLNK) && defined (S_IFLNK) |
56 | #define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK) | |
57 | #endif | |
58 | ||
a48de9b2 PE |
59 | /* A file whose last-modified time is just after the most recent boot. |
60 | Define this to be NULL to disable checking for this file. */ | |
61 | #ifndef BOOT_TIME_FILE | |
62 | #define BOOT_TIME_FILE "/var/run/random-seed" | |
63 | #endif | |
64 | ||
77e544a4 RS |
65 | #ifndef WTMP_FILE |
66 | #define WTMP_FILE "/var/log/wtmp" | |
67 | #endif | |
177c0ea7 | 68 | |
8dbbc384 RS |
69 | /* The strategy: to lock a file FN, create a symlink .#FN in FN's |
70 | directory, with link data `user@host.pid'. This avoids a single | |
71 | mount (== failure) point for lock files. | |
72 | ||
73 | When the host in the lock data is the current host, we can check if | |
74 | the pid is valid with kill. | |
177c0ea7 | 75 | |
8dbbc384 RS |
76 | Otherwise, we could look at a separate file that maps hostnames to |
77 | reboot times to see if the remote pid can possibly be valid, since we | |
78 | don't want Emacs to have to communicate via pipes or sockets or | |
79 | whatever to other processes, either locally or remotely; rms says | |
80 | that's too unreliable. Hence the separate file, which could | |
81 | theoretically be updated by daemons running separately -- but this | |
82 | whole idea is unimplemented; in practice, at least in our | |
1c4f857c | 83 | environment, it seems such stale locks arise fairly infrequently, and |
8dbbc384 RS |
84 | Emacs' standard methods of dealing with clashes suffice. |
85 | ||
86 | We use symlinks instead of normal files because (1) they can be | |
87 | stored more efficiently on the filesystem, since the kernel knows | |
88 | they will be small, and (2) all the info about the lock can be read | |
89 | in a single system call (readlink). Although we could use regular | |
1c4f857c | 90 | files to be useful on old systems lacking symlinks, nowadays |
8dbbc384 RS |
91 | virtually all such systems are probably single-user anyway, so it |
92 | didn't seem worth the complication. | |
177c0ea7 | 93 | |
8dbbc384 RS |
94 | Similarly, we don't worry about a possible 14-character limit on |
95 | file names, because those are all the same systems that don't have | |
96 | symlinks. | |
177c0ea7 | 97 | |
8dbbc384 RS |
98 | This is compatible with the locking scheme used by Interleaf (which |
99 | has contributed this implementation for Emacs), and was designed by | |
100 | Ethan Jacobson, Kimbo Mundy, and others. | |
177c0ea7 | 101 | |
8dbbc384 | 102 | --karl@cs.umb.edu/karl@hq.ileaf.com. */ |
8489eb67 | 103 | |
8dbbc384 | 104 | \f |
15e88d21 RS |
105 | /* Return the time of the last system boot. */ |
106 | ||
107 | static time_t boot_time; | |
b97771fc | 108 | static int boot_time_initialized; |
15e88d21 | 109 | |
2f2500ef | 110 | #ifdef BOOT_TIME |
8ea90aa3 | 111 | static void get_boot_time_1 (const char *, int); |
2f2500ef DL |
112 | #endif |
113 | ||
15e88d21 | 114 | static time_t |
971de7fb | 115 | get_boot_time (void) |
15e88d21 | 116 | { |
9d2818d6 | 117 | #if defined (BOOT_TIME) |
9177d978 | 118 | int counter; |
2decc5a9 | 119 | #endif |
15e88d21 | 120 | |
b97771fc | 121 | if (boot_time_initialized) |
15e88d21 | 122 | return boot_time; |
b97771fc | 123 | boot_time_initialized = 1; |
15e88d21 | 124 | |
f805a125 KH |
125 | #if defined (CTL_KERN) && defined (KERN_BOOTTIME) |
126 | { | |
127 | int mib[2]; | |
128 | size_t size; | |
129 | struct timeval boottime_val; | |
130 | ||
131 | mib[0] = CTL_KERN; | |
132 | mib[1] = KERN_BOOTTIME; | |
133 | size = sizeof (boottime_val); | |
134 | ||
135 | if (sysctl (mib, 2, &boottime_val, &size, NULL, 0) >= 0) | |
136 | { | |
137 | boot_time = boottime_val.tv_sec; | |
138 | return boot_time; | |
139 | } | |
140 | } | |
141 | #endif /* defined (CTL_KERN) && defined (KERN_BOOTTIME) */ | |
9177d978 | 142 | |
a48de9b2 PE |
143 | if (BOOT_TIME_FILE) |
144 | { | |
145 | struct stat st; | |
146 | if (stat (BOOT_TIME_FILE, &st) == 0) | |
147 | { | |
148 | boot_time = st.st_mtime; | |
149 | return boot_time; | |
150 | } | |
151 | } | |
152 | ||
9d2818d6 | 153 | #if defined (BOOT_TIME) |
b97771fc RS |
154 | #ifndef CANNOT_DUMP |
155 | /* The utmp routines maintain static state. | |
156 | Don't touch that state unless we are initialized, | |
157 | since it might not survive dumping. */ | |
158 | if (! initialized) | |
159 | return boot_time; | |
160 | #endif /* not CANNOT_DUMP */ | |
161 | ||
162 | /* Try to get boot time from utmp before wtmp, | |
163 | since utmp is typically much smaller than wtmp. | |
164 | Passing a null pointer causes get_boot_time_1 | |
165 | to inspect the default file, namely utmp. */ | |
166 | get_boot_time_1 ((char *) 0, 0); | |
167 | if (boot_time) | |
168 | return boot_time; | |
169 | ||
9177d978 | 170 | /* Try to get boot time from the current wtmp file. */ |
b97771fc | 171 | get_boot_time_1 (WTMP_FILE, 1); |
9177d978 RS |
172 | |
173 | /* If we did not find a boot time in wtmp, look at wtmp, and so on. */ | |
b97771fc | 174 | for (counter = 0; counter < 20 && ! boot_time; counter++) |
9177d978 RS |
175 | { |
176 | char cmd_string[100]; | |
177 | Lisp_Object tempname, filename; | |
178 | int delete_flag = 0; | |
179 | ||
180 | filename = Qnil; | |
181 | ||
77e544a4 | 182 | sprintf (cmd_string, "%s.%d", WTMP_FILE, counter); |
9177d978 | 183 | tempname = build_string (cmd_string); |
29a2adb0 | 184 | if (! NILP (Ffile_exists_p (tempname))) |
9177d978 RS |
185 | filename = tempname; |
186 | else | |
187 | { | |
77e544a4 | 188 | sprintf (cmd_string, "%s.%d.gz", WTMP_FILE, counter); |
9177d978 RS |
189 | tempname = build_string (cmd_string); |
190 | if (! NILP (Ffile_exists_p (tempname))) | |
191 | { | |
192 | Lisp_Object args[6]; | |
f1d367aa GM |
193 | |
194 | /* The utmp functions on mescaline.gnu.org accept only | |
195 | file names up to 8 characters long. Choose a 2 | |
196 | character long prefix, and call make_temp_file with | |
197 | second arg non-zero, so that it will add not more | |
198 | than 6 characters to the prefix. */ | |
199 | tempname = Fexpand_file_name (build_string ("wt"), | |
5f8d6a10 | 200 | Vtemporary_file_directory); |
f1d367aa | 201 | tempname = make_temp_name (tempname, 1); |
9177d978 RS |
202 | args[0] = Vshell_file_name; |
203 | args[1] = Qnil; | |
204 | args[2] = Qnil; | |
205 | args[3] = Qnil; | |
206 | args[4] = build_string ("-c"); | |
77e544a4 | 207 | sprintf (cmd_string, "gunzip < %s.%d.gz > %s", |
d5db4077 | 208 | WTMP_FILE, counter, SDATA (tempname)); |
9177d978 RS |
209 | args[5] = build_string (cmd_string); |
210 | Fcall_process (6, args); | |
211 | filename = tempname; | |
212 | delete_flag = 1; | |
213 | } | |
214 | } | |
215 | ||
216 | if (! NILP (filename)) | |
217 | { | |
d5db4077 | 218 | get_boot_time_1 (SDATA (filename), 1); |
9177d978 | 219 | if (delete_flag) |
d5db4077 | 220 | unlink (SDATA (filename)); |
9177d978 RS |
221 | } |
222 | } | |
223 | ||
224 | return boot_time; | |
225 | #else | |
226 | return 0; | |
227 | #endif | |
228 | } | |
229 | ||
e9f22ced | 230 | #ifdef BOOT_TIME |
9177d978 RS |
231 | /* Try to get the boot time from wtmp file FILENAME. |
232 | This succeeds if that file contains a reboot record. | |
9177d978 | 233 | |
b97771fc RS |
234 | If FILENAME is zero, use the same file as before; |
235 | if no FILENAME has ever been specified, this is the utmp file. | |
236 | Use the newest reboot record if NEWEST is nonzero, | |
237 | the first reboot record otherwise. | |
238 | Ignore all reboot records on or before BOOT_TIME. | |
239 | Success is indicated by setting BOOT_TIME to a larger value. */ | |
240 | ||
2f2500ef | 241 | void |
8ea90aa3 | 242 | get_boot_time_1 (const char *filename, int newest) |
9177d978 RS |
243 | { |
244 | struct utmp ut, *utp; | |
77e544a4 RS |
245 | int desc; |
246 | ||
b97771fc RS |
247 | if (filename) |
248 | { | |
249 | /* On some versions of IRIX, opening a nonexistent file name | |
250 | is likely to crash in the utmp routines. */ | |
68c45bf0 | 251 | desc = emacs_open (filename, O_RDONLY, 0); |
b97771fc RS |
252 | if (desc < 0) |
253 | return; | |
254 | ||
68c45bf0 | 255 | emacs_close (desc); |
b97771fc RS |
256 | |
257 | utmpname (filename); | |
258 | } | |
9177d978 | 259 | |
c321b190 | 260 | setutent (); |
b97771fc | 261 | |
c321b190 RS |
262 | while (1) |
263 | { | |
264 | /* Find the next reboot record. */ | |
265 | ut.ut_type = BOOT_TIME; | |
266 | utp = getutid (&ut); | |
267 | if (! utp) | |
268 | break; | |
269 | /* Compare reboot times and use the newest one. */ | |
270 | if (utp->ut_time > boot_time) | |
b97771fc RS |
271 | { |
272 | boot_time = utp->ut_time; | |
273 | if (! newest) | |
274 | break; | |
275 | } | |
c321b190 RS |
276 | /* Advance on element in the file |
277 | so that getutid won't repeat the same one. */ | |
278 | utp = getutent (); | |
279 | if (! utp) | |
280 | break; | |
281 | } | |
15e88d21 | 282 | endutent (); |
15e88d21 | 283 | } |
e9f22ced | 284 | #endif /* BOOT_TIME */ |
15e88d21 | 285 | \f |
8dbbc384 | 286 | /* Here is the structure that stores information about a lock. */ |
32676c08 | 287 | |
8dbbc384 RS |
288 | typedef struct |
289 | { | |
290 | char *user; | |
291 | char *host; | |
9005cb4f | 292 | unsigned long pid; |
15e88d21 | 293 | time_t boot_time; |
8dbbc384 | 294 | } lock_info_type; |
32676c08 | 295 | |
49b6d120 RS |
296 | /* When we read the info back, we might need this much more, |
297 | enough for decimal representation plus null. */ | |
298 | #define LOCK_PID_MAX (4 * sizeof (unsigned long)) | |
32676c08 | 299 | |
8dbbc384 RS |
300 | /* Free the two dynamically-allocated pieces in PTR. */ |
301 | #define FREE_LOCK_INFO(i) do { xfree ((i).user); xfree ((i).host); } while (0) | |
e31fbc7a | 302 | |
e31fbc7a | 303 | |
8dbbc384 | 304 | /* Write the name of the lock file for FN into LFNAME. Length will be |
c1355e1f GM |
305 | that of FN plus two more for the leading `.#' plus 1 for the |
306 | trailing period plus one for the digit after it plus one for the | |
307 | null. */ | |
7b92975f | 308 | #define MAKE_LOCK_NAME(lock, file) \ |
d5db4077 | 309 | (lock = (char *) alloca (SBYTES (file) + 2 + 1 + 1 + 1), \ |
8dbbc384 | 310 | fill_in_lock_file_name (lock, (file))) |
e31fbc7a | 311 | |
8dbbc384 | 312 | static void |
971de7fb | 313 | fill_in_lock_file_name (register char *lockfile, register Lisp_Object fn) |
e31fbc7a | 314 | { |
8dbbc384 | 315 | register char *p; |
c1355e1f GM |
316 | struct stat st; |
317 | int count = 0; | |
8dbbc384 | 318 | |
d5db4077 | 319 | strcpy (lockfile, SDATA (fn)); |
8dbbc384 RS |
320 | |
321 | /* Shift the nondirectory part of the file name (including the null) | |
322 | right two characters. Here is one of the places where we'd have to | |
323 | do something to support 14-character-max file names. */ | |
324 | for (p = lockfile + strlen (lockfile); p != lockfile && *p != '/'; p--) | |
325 | p[2] = *p; | |
177c0ea7 | 326 | |
8dbbc384 RS |
327 | /* Insert the `.#'. */ |
328 | p[1] = '.'; | |
329 | p[2] = '#'; | |
c1355e1f GM |
330 | |
331 | p = p + strlen (p); | |
332 | ||
333 | while (lstat (lockfile, &st) == 0 && !S_ISLNK (st.st_mode)) | |
334 | { | |
335 | if (count > 9) | |
336 | { | |
337 | *p = '\0'; | |
338 | return; | |
339 | } | |
340 | sprintf (p, ".%d", count++); | |
341 | } | |
8dbbc384 | 342 | } |
e31fbc7a | 343 | |
8dbbc384 RS |
344 | /* Lock the lock file named LFNAME. |
345 | If FORCE is nonzero, we do so even if it is already locked. | |
346 | Return 1 if successful, 0 if not. */ | |
e31fbc7a | 347 | |
8dbbc384 | 348 | static int |
971de7fb | 349 | lock_file_1 (char *lfname, int force) |
8dbbc384 RS |
350 | { |
351 | register int err; | |
bd26d5a3 | 352 | time_t boot_time; |
8ea90aa3 DN |
353 | const char *user_name; |
354 | const char *host_name; | |
662c2ef2 RS |
355 | char *lock_info_str; |
356 | ||
4ba93ac0 AS |
357 | /* Call this first because it can GC. */ |
358 | boot_time = get_boot_time (); | |
359 | ||
662c2ef2 | 360 | if (STRINGP (Fuser_login_name (Qnil))) |
d5db4077 | 361 | user_name = (char *)SDATA (Fuser_login_name (Qnil)); |
662c2ef2 RS |
362 | else |
363 | user_name = ""; | |
364 | if (STRINGP (Fsystem_name ())) | |
d5db4077 | 365 | host_name = (char *)SDATA (Fsystem_name ()); |
662c2ef2 RS |
366 | else |
367 | host_name = ""; | |
266d7a00 | 368 | lock_info_str = (char *)alloca (strlen (user_name) + strlen (host_name) |
4ba93ac0 | 369 | + LOCK_PID_MAX + 30); |
8dbbc384 | 370 | |
bd26d5a3 RS |
371 | if (boot_time) |
372 | sprintf (lock_info_str, "%s@%s.%lu:%lu", user_name, host_name, | |
373 | (unsigned long) getpid (), (unsigned long) boot_time); | |
374 | else | |
375 | sprintf (lock_info_str, "%s@%s.%lu", user_name, host_name, | |
177c0ea7 | 376 | (unsigned long) getpid ()); |
8dbbc384 RS |
377 | |
378 | err = symlink (lock_info_str, lfname); | |
379 | if (errno == EEXIST && force) | |
e31fbc7a | 380 | { |
8dbbc384 RS |
381 | unlink (lfname); |
382 | err = symlink (lock_info_str, lfname); | |
e31fbc7a | 383 | } |
e31fbc7a | 384 | |
8dbbc384 RS |
385 | return err == 0; |
386 | } | |
e31fbc7a | 387 | |
9177d978 | 388 | /* Return 1 if times A and B are no more than one second apart. */ |
32676c08 | 389 | |
9177d978 | 390 | int |
971de7fb | 391 | within_one_second (time_t a, time_t b) |
9177d978 RS |
392 | { |
393 | return (a - b >= -1 && a - b <= 1); | |
394 | } | |
8dbbc384 RS |
395 | \f |
396 | /* Return 0 if nobody owns the lock file LFNAME or the lock is obsolete, | |
397 | 1 if another process owns it (and set OWNER (if non-null) to info), | |
398 | 2 if the current process owns it, | |
399 | or -1 if something is wrong with the locking mechanism. */ | |
e31fbc7a | 400 | |
8dbbc384 | 401 | static int |
971de7fb | 402 | current_lock_owner (lock_info_type *owner, char *lfname) |
32676c08 | 403 | { |
5f8d6a10 | 404 | int len, ret; |
8dbbc384 | 405 | int local_owner = 0; |
15e88d21 | 406 | char *at, *dot, *colon; |
8dbbc384 RS |
407 | char *lfinfo = 0; |
408 | int bufsize = 50; | |
409 | /* Read arbitrarily-long contents of symlink. Similar code in | |
410 | file-symlink-p in fileio.c. */ | |
411 | do | |
412 | { | |
413 | bufsize *= 2; | |
414 | lfinfo = (char *) xrealloc (lfinfo, bufsize); | |
620c4704 | 415 | errno = 0; |
8dbbc384 | 416 | len = readlink (lfname, lfinfo, bufsize); |
b6e97b0a GM |
417 | #ifdef ERANGE |
418 | /* HP-UX reports ERANGE if the buffer is too small. */ | |
419 | if (len == -1 && errno == ERANGE) | |
63680feb | 420 | len = bufsize; |
b6e97b0a | 421 | #endif |
8dbbc384 RS |
422 | } |
423 | while (len >= bufsize); | |
177c0ea7 | 424 | |
8dbbc384 RS |
425 | /* If nonexistent lock file, all is well; otherwise, got strange error. */ |
426 | if (len == -1) | |
427 | { | |
428 | xfree (lfinfo); | |
429 | return errno == ENOENT ? 0 : -1; | |
430 | } | |
32676c08 | 431 | |
8dbbc384 RS |
432 | /* Link info exists, so `len' is its length. Null terminate. */ |
433 | lfinfo[len] = 0; | |
177c0ea7 | 434 | |
8dbbc384 RS |
435 | /* Even if the caller doesn't want the owner info, we still have to |
436 | read it to determine return value, so allocate it. */ | |
437 | if (!owner) | |
438 | { | |
3609a53b | 439 | owner = (lock_info_type *) alloca (sizeof (lock_info_type)); |
8dbbc384 RS |
440 | local_owner = 1; |
441 | } | |
177c0ea7 | 442 | |
15e88d21 | 443 | /* Parse USER@HOST.PID:BOOT_TIME. If can't parse, return -1. */ |
50624218 | 444 | /* The USER is everything before the last @. */ |
8966b757 AS |
445 | at = strrchr (lfinfo, '@'); |
446 | dot = strrchr (lfinfo, '.'); | |
15e88d21 RS |
447 | if (!at || !dot) |
448 | { | |
449 | xfree (lfinfo); | |
450 | return -1; | |
451 | } | |
8dbbc384 RS |
452 | len = at - lfinfo; |
453 | owner->user = (char *) xmalloc (len + 1); | |
454 | strncpy (owner->user, lfinfo, len); | |
455 | owner->user[len] = 0; | |
177c0ea7 | 456 | |
15e88d21 | 457 | /* The PID is everything from the last `.' to the `:'. */ |
8dbbc384 | 458 | owner->pid = atoi (dot + 1); |
15e88d21 RS |
459 | colon = dot; |
460 | while (*colon && *colon != ':') | |
461 | colon++; | |
462 | /* After the `:', if there is one, comes the boot time. */ | |
463 | if (*colon == ':') | |
464 | owner->boot_time = atoi (colon + 1); | |
465 | else | |
466 | owner->boot_time = 0; | |
32676c08 | 467 | |
8dbbc384 RS |
468 | /* The host is everything in between. */ |
469 | len = dot - at - 1; | |
470 | owner->host = (char *) xmalloc (len + 1); | |
471 | strncpy (owner->host, at + 1, len); | |
472 | owner->host[len] = 0; | |
32676c08 | 473 | |
8dbbc384 RS |
474 | /* We're done looking at the link info. */ |
475 | xfree (lfinfo); | |
177c0ea7 | 476 | |
8dbbc384 | 477 | /* On current host? */ |
662c2ef2 | 478 | if (STRINGP (Fsystem_name ()) |
d5db4077 | 479 | && strcmp (owner->host, SDATA (Fsystem_name ())) == 0) |
32676c08 | 480 | { |
8dbbc384 RS |
481 | if (owner->pid == getpid ()) |
482 | ret = 2; /* We own it. */ | |
72dcef0e | 483 | else if (owner->pid > 0 |
15e88d21 RS |
484 | && (kill (owner->pid, 0) >= 0 || errno == EPERM) |
485 | && (owner->boot_time == 0 | |
9177d978 | 486 | || within_one_second (owner->boot_time, get_boot_time ()))) |
8dbbc384 | 487 | ret = 1; /* An existing process on this machine owns it. */ |
8dbbc384 RS |
488 | /* The owner process is dead or has a strange pid (<=0), so try to |
489 | zap the lockfile. */ | |
72dcef0e | 490 | else if (unlink (lfname) < 0) |
8dbbc384 | 491 | ret = -1; |
72dcef0e RS |
492 | else |
493 | ret = 0; | |
32676c08 | 494 | } |
8dbbc384 RS |
495 | else |
496 | { /* If we wanted to support the check for stale locks on remote machines, | |
497 | here's where we'd do it. */ | |
498 | ret = 1; | |
499 | } | |
177c0ea7 | 500 | |
8dbbc384 RS |
501 | /* Avoid garbage. */ |
502 | if (local_owner || ret <= 0) | |
503 | { | |
504 | FREE_LOCK_INFO (*owner); | |
505 | } | |
506 | return ret; | |
32676c08 JB |
507 | } |
508 | ||
8dbbc384 RS |
509 | \f |
510 | /* Lock the lock named LFNAME if possible. | |
511 | Return 0 in that case. | |
512 | Return positive if some other process owns the lock, and info about | |
513 | that process in CLASHER. | |
514 | Return -1 if cannot lock for any other reason. */ | |
8489eb67 | 515 | |
8dbbc384 | 516 | static int |
971de7fb | 517 | lock_if_free (lock_info_type *clasher, register char *lfname) |
8dbbc384 | 518 | { |
cfc01fa7 | 519 | while (lock_file_1 (lfname, 0) == 0) |
8dbbc384 RS |
520 | { |
521 | int locker; | |
e0e0205b | 522 | |
8dbbc384 RS |
523 | if (errno != EEXIST) |
524 | return -1; | |
177c0ea7 | 525 | |
8dbbc384 RS |
526 | locker = current_lock_owner (clasher, lfname); |
527 | if (locker == 2) | |
528 | { | |
529 | FREE_LOCK_INFO (*clasher); | |
530 | return 0; /* We ourselves locked it. */ | |
531 | } | |
532 | else if (locker == 1) | |
533 | return 1; /* Someone else has it. */ | |
5df0b2fa | 534 | else if (locker == -1) |
ae1ef097 | 535 | return -1; /* current_lock_owner returned strange error. */ |
8dbbc384 | 536 | |
cfc01fa7 | 537 | /* We deleted a stale lock; try again to lock the file. */ |
8dbbc384 RS |
538 | } |
539 | return 0; | |
8489eb67 RS |
540 | } |
541 | ||
8dbbc384 | 542 | /* lock_file locks file FN, |
8489eb67 RS |
543 | meaning it serves notice on the world that you intend to edit that file. |
544 | This should be done only when about to modify a file-visiting | |
545 | buffer previously unmodified. | |
8dbbc384 | 546 | Do not (normally) call this for a buffer already modified, |
8489eb67 RS |
547 | as either the file is already locked, or the user has already |
548 | decided to go ahead without locking. | |
549 | ||
8dbbc384 | 550 | When this returns, either the lock is locked for us, |
8489eb67 RS |
551 | or the user has said to go ahead without locking. |
552 | ||
8dbbc384 | 553 | If the file is locked by someone else, this calls |
8489eb67 | 554 | ask-user-about-lock (a Lisp function) with two arguments, |
8dbbc384 | 555 | the file name and info about the user who did the locking. |
8489eb67 RS |
556 | This function can signal an error, or return t meaning |
557 | take away the lock, or return nil meaning ignore the lock. */ | |
558 | ||
8489eb67 | 559 | void |
971de7fb | 560 | lock_file (Lisp_Object fn) |
8489eb67 | 561 | { |
f4a4528d | 562 | register Lisp_Object attack, orig_fn, encoded_fn; |
8dbbc384 RS |
563 | register char *lfname, *locker; |
564 | lock_info_type lock_info; | |
3edc33a4 | 565 | struct gcpro gcpro1; |
8489eb67 | 566 | |
33bae690 RS |
567 | /* Don't do locking while dumping Emacs. |
568 | Uncompressing wtmp files uses call-process, which does not work | |
569 | in an uninitialized Emacs. */ | |
570 | if (! NILP (Vpurify_flag)) | |
571 | return; | |
572 | ||
5383bc6d | 573 | orig_fn = fn; |
8af8a9ca | 574 | GCPRO1 (fn); |
1e89de84 | 575 | fn = Fexpand_file_name (fn, Qnil); |
f4a4528d | 576 | encoded_fn = ENCODE_FILE (fn); |
1e89de84 | 577 | |
8dbbc384 | 578 | /* Create the name of the lock-file for file fn */ |
f4a4528d | 579 | MAKE_LOCK_NAME (lfname, encoded_fn); |
8489eb67 | 580 | |
32676c08 JB |
581 | /* See if this file is visited and has changed on disk since it was |
582 | visited. */ | |
8489eb67 | 583 | { |
a57bc488 | 584 | register Lisp_Object subject_buf; |
3036594f | 585 | |
5383bc6d | 586 | subject_buf = get_truename_buffer (orig_fn); |
3036594f | 587 | |
265a9e55 JB |
588 | if (!NILP (subject_buf) |
589 | && NILP (Fverify_visited_file_modtime (subject_buf)) | |
590 | && !NILP (Ffile_exists_p (fn))) | |
8489eb67 | 591 | call1 (intern ("ask-user-about-supersession-threat"), fn); |
3036594f | 592 | |
8489eb67 | 593 | } |
8af8a9ca | 594 | UNGCPRO; |
8489eb67 RS |
595 | |
596 | /* Try to lock the lock. */ | |
8dbbc384 RS |
597 | if (lock_if_free (&lock_info, lfname) <= 0) |
598 | /* Return now if we have locked it, or if lock creation failed */ | |
8489eb67 RS |
599 | return; |
600 | ||
601 | /* Else consider breaking the lock */ | |
266d7a00 RS |
602 | locker = (char *) alloca (strlen (lock_info.user) + strlen (lock_info.host) |
603 | + LOCK_PID_MAX + 9); | |
79e51eeb | 604 | sprintf (locker, "%s@%s (pid %lu)", lock_info.user, lock_info.host, |
8dbbc384 RS |
605 | lock_info.pid); |
606 | FREE_LOCK_INFO (lock_info); | |
177c0ea7 | 607 | |
8dbbc384 | 608 | attack = call2 (intern ("ask-user-about-lock"), fn, build_string (locker)); |
265a9e55 | 609 | if (!NILP (attack)) |
8489eb67 RS |
610 | /* User says take the lock */ |
611 | { | |
8dbbc384 | 612 | lock_file_1 (lfname, 1); |
8489eb67 RS |
613 | return; |
614 | } | |
615 | /* User says ignore the lock */ | |
616 | } | |
617 | ||
8489eb67 | 618 | void |
971de7fb | 619 | unlock_file (register Lisp_Object fn) |
8489eb67 RS |
620 | { |
621 | register char *lfname; | |
622 | ||
1e89de84 | 623 | fn = Fexpand_file_name (fn, Qnil); |
88eace34 | 624 | fn = ENCODE_FILE (fn); |
1e89de84 | 625 | |
7b92975f | 626 | MAKE_LOCK_NAME (lfname, fn); |
8489eb67 | 627 | |
8dbbc384 | 628 | if (current_lock_owner (0, lfname) == 2) |
8489eb67 | 629 | unlink (lfname); |
8489eb67 RS |
630 | } |
631 | ||
632 | void | |
971de7fb | 633 | unlock_all_files (void) |
8489eb67 RS |
634 | { |
635 | register Lisp_Object tail; | |
636 | register struct buffer *b; | |
637 | ||
8e50cc2d | 638 | for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail)) |
8489eb67 | 639 | { |
03699b14 | 640 | b = XBUFFER (XCDR (XCAR (tail))); |
5757b805 | 641 | if (STRINGP (b->file_truename) && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)) |
1c343051 | 642 | { |
4fa09beb | 643 | unlock_file(b->file_truename); |
1c343051 | 644 | } |
8489eb67 RS |
645 | } |
646 | } | |
8489eb67 RS |
647 | \f |
648 | DEFUN ("lock-buffer", Flock_buffer, Slock_buffer, | |
335c5470 PJ |
649 | 0, 1, 0, |
650 | doc: /* Lock FILE, if current buffer is modified. | |
651 | FILE defaults to current buffer's visited file, | |
652 | or else nothing is done if current buffer isn't visiting a file. */) | |
5842a27b | 653 | (Lisp_Object file) |
8489eb67 | 654 | { |
e9319ef2 EN |
655 | if (NILP (file)) |
656 | file = current_buffer->file_truename; | |
8489eb67 | 657 | else |
b7826503 | 658 | CHECK_STRING (file); |
6a140159 | 659 | if (SAVE_MODIFF < MODIFF |
e9319ef2 EN |
660 | && !NILP (file)) |
661 | lock_file (file); | |
177c0ea7 | 662 | return Qnil; |
8489eb67 RS |
663 | } |
664 | ||
665 | DEFUN ("unlock-buffer", Funlock_buffer, Sunlock_buffer, | |
335c5470 | 666 | 0, 0, 0, |
3bfb8921 RS |
667 | doc: /* Unlock the file visited in the current buffer. |
668 | If the buffer is not modified, this does nothing because the file | |
669 | should not be locked in that case. */) | |
5842a27b | 670 | (void) |
8489eb67 | 671 | { |
6a140159 | 672 | if (SAVE_MODIFF < MODIFF |
5757b805 RS |
673 | && STRINGP (current_buffer->file_truename)) |
674 | unlock_file (current_buffer->file_truename); | |
8489eb67 RS |
675 | return Qnil; |
676 | } | |
677 | ||
8489eb67 RS |
678 | /* Unlock the file visited in buffer BUFFER. */ |
679 | ||
d07e0802 | 680 | void |
971de7fb | 681 | unlock_buffer (struct buffer *buffer) |
8489eb67 | 682 | { |
6a140159 | 683 | if (BUF_SAVE_MODIFF (buffer) < BUF_MODIFF (buffer) |
5757b805 RS |
684 | && STRINGP (buffer->file_truename)) |
685 | unlock_file (buffer->file_truename); | |
8489eb67 RS |
686 | } |
687 | ||
8105cbf7 | 688 | DEFUN ("file-locked-p", Ffile_locked_p, Sfile_locked_p, 1, 1, 0, |
3bfb8921 RS |
689 | doc: /* Return a value indicating whether FILENAME is locked. |
690 | The value is nil if the FILENAME is not locked, | |
691 | t if it is locked by you, else a string saying which user has locked it. */) | |
5842a27b | 692 | (Lisp_Object filename) |
8489eb67 | 693 | { |
8dbbc384 | 694 | Lisp_Object ret; |
8489eb67 RS |
695 | register char *lfname; |
696 | int owner; | |
8dbbc384 | 697 | lock_info_type locker; |
8489eb67 | 698 | |
e9319ef2 | 699 | filename = Fexpand_file_name (filename, Qnil); |
8489eb67 | 700 | |
e9319ef2 | 701 | MAKE_LOCK_NAME (lfname, filename); |
8489eb67 | 702 | |
8dbbc384 | 703 | owner = current_lock_owner (&locker, lfname); |
8489eb67 | 704 | if (owner <= 0) |
8dbbc384 RS |
705 | ret = Qnil; |
706 | else if (owner == 2) | |
707 | ret = Qt; | |
708 | else | |
709 | ret = build_string (locker.user); | |
710 | ||
711 | if (owner > 0) | |
712 | FREE_LOCK_INFO (locker); | |
713 | ||
714 | return ret; | |
8489eb67 | 715 | } |
32676c08 JB |
716 | \f |
717 | /* Initialization functions. */ | |
718 | ||
a3fd58aa | 719 | void |
971de7fb | 720 | init_filelock (void) |
a3fd58aa KH |
721 | { |
722 | boot_time = 0; | |
b97771fc | 723 | boot_time_initialized = 0; |
a3fd58aa KH |
724 | } |
725 | ||
ffe75e6b EZ |
726 | #endif /* CLASH_DETECTION */ |
727 | ||
dfcf069d | 728 | void |
971de7fb | 729 | syms_of_filelock (void) |
8489eb67 | 730 | { |
29208e82 | 731 | DEFVAR_LISP ("temporary-file-directory", Vtemporary_file_directory, |
335c5470 | 732 | doc: /* The directory for writing temporary files. */); |
5f8d6a10 RS |
733 | Vtemporary_file_directory = Qnil; |
734 | ||
ffe75e6b | 735 | #ifdef CLASH_DETECTION |
8489eb67 RS |
736 | defsubr (&Sunlock_buffer); |
737 | defsubr (&Slock_buffer); | |
738 | defsubr (&Sfile_locked_p); | |
ffe75e6b | 739 | #endif |
8489eb67 RS |
740 | } |
741 |