chiark / gitweb /
e00309db51de72b2043445381eb0dbcb754b7b30
[chiark-utils.git] / cprogs / with-lock-ex.c
1 /*
2  * File locker
3  *
4  * Usage:
5  *  with-lock-ex -<mode> <lockfile> <command> <args>...
6  *  with-lock-ex -l      <lockfile>
7  *
8  * modes are
9  *  w    wait for the lock
10  *  f    fail if the lock cannot be acquired
11  *  q    silently do nothing if the lock cannot be acquired
12  *  l    show who is waiting (print "none" or "read <pid>"
13  *         or "write <pid>"; lockfile opened for reading;
14  *         no command may be specified)
15  *
16  * with-lock-ex will open and lock the lockfile for writing and
17  * then feed the remainder of its arguments to exec(2); when
18  * that process terminates the fd will be closed and the file
19  * unlocked automatically by the kernel.
20  *
21  * If invoked as with-lock, behaves like with-lock-ex -f (for backward
22  * compatibility with an earlier version).
23  *
24  * This file written by me, Ian Jackson, in 1993, 1994, 1995, 1996,
25  * 1998, 1999, 2016.
26  *
27  * Copyright 1993-2016 Ian Jackson in some jurisdictions
28  * Copyright 2017      Ian Jackson in all jurisdictions
29  * Copyright 2017      Genome Research Ltd
30  *
31  * (MIT licence:)
32  *
33  * Permission is hereby granted, free of charge, to any person obtaining a
34  * copy of this software and associated documentation files (the "Software"),
35  * to deal in the Software without restriction, including without limitation
36  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
37  * and/or sell copies of the Software, and to permit persons to whom the
38  * Software is furnished to do so, subject to the following conditions:
39  *
40  * The above copyright notice and this permission notice shall be included in
41  * all copies or substantial portions of the Software.
42  *
43  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
44  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
45  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
46  * SOFTWARE IN THE PUBLIC INTEREST, INC. BE LIABLE FOR ANY CLAIM, DAMAGES OR
47  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
48  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
49  * DEALINGS IN THE SOFTWARE.
50  */
51
52 #include <errno.h>
53 #include <fcntl.h>
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <unistd.h>
57 #include <string.h>
58 #include <sys/stat.h>
59
60 static const char *cmd;
61
62 static void fail(const char *why) __attribute__((noreturn));
63
64 static void fail(const char *why) {
65   fprintf(stderr,"with-lock-ex %s: %s: %s\n",cmd,why,strerror(errno));
66   exit(255);
67 }
68
69 static void badusage(void) __attribute__((noreturn));
70
71 static void badusage(void) {
72     fputs("usage: with-lock-ex -w|-q|-f [-t <secs>] <lockfile> <command> <args>...\n"
73           "       with-lock-ex -l       <lockfile>\n"
74           "       with-lock             <lockfile> <command> <args>...\n",
75           stderr);
76     exit(255);
77 }
78
79 static int mode;
80
81 int main(int argc, char **argv) {
82   int fd, um, c;
83   struct stat stab, fstab;
84   long cloexec;
85   struct flock fl;
86
87   mode='x';
88   while ((c = getopt(argc,argv,"+wfqlt:")) != -1)
89     switch(c) {
90     case 'l':
91     case 'w':
92     case 'f':
93     case 'q':
94       if (mode != 'x') badusage();
95       mode = c;
96       break;
97     default:
98       badusage();
99     }
100
101   argv += optind-1; argc -= optind-1;
102   if (argc < 2) badusage();
103
104   cmd= argv[2];
105   um= umask(0777); if (um==-1) fail("find umask");
106   if (umask(um)==-1) fail("reset umask");
107
108   for (;;) {
109
110     int openmode = mode=='l' ? O_RDONLY : O_RDWR|O_CREAT;
111
112     fd= open(argv[1],openmode,0666&~(um|((um&0222)<<1)));
113     if (fd<0) fail(argv[1]);
114   
115     for (;;) {
116       fl.l_type= F_WRLCK;
117       fl.l_whence= SEEK_SET;
118       fl.l_start= 0;
119       fl.l_len= mode=='l' ? 0 : 1;
120       if (fcntl(fd,
121                 mode=='l' ? F_GETLK :
122                 mode=='w' ? F_SETLKW :
123                 F_SETLK,
124                 &fl) != -1) break;
125       if (mode=='q' &&
126           (errno == EAGAIN || errno == EWOULDBLOCK || errno == EBUSY))
127         exit(0);
128       if (errno != EINTR) fail("could not acquire lock");
129     }
130     if (mode=='l') {
131       if (fl.l_pid) {
132         printf("%s %lu\n",
133                fl.l_type == F_WRLCK ? "write" :
134                fl.l_type == F_RDLCK ? "read" : "unknown",
135                (unsigned long)fl.l_pid);
136       } else {
137         printf("none\n");
138       }
139       if (ferror(stdout)) fail("print to stdout\n");
140       exit(0);
141     }
142
143     if (fstat(fd, &fstab)) fail("could not fstat lock fd");
144     if (stat(argv[1], &stab)) {
145       if (errno != ENOENT) fail("could not stat lockfile");
146     } else {
147       if (stab.st_dev == fstab.st_dev &&
148           stab.st_ino == fstab.st_ino) break;
149     }
150     close(fd);
151   }
152
153   cloexec= fcntl(fd, F_GETFD); if (cloexec==-1) fail("fcntl F_GETFD");
154   cloexec &= ~1;
155   if (fcntl(fd, F_SETFD, cloexec)==-1) fail("fcntl F_SETFD");
156
157   execvp(cmd,argv+2);
158   fail("unable to execute command");
159 }