See ChangeLog: Sun Jan 3 15:28:44 CET 1999 Werner Koch
[gnupg.git] / util / dotlock.c
1 /* dotlock.c - dotfile locking
2  *      Copyright (C) 1998 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <ctype.h>
26 #include <errno.h>
27 #include <unistd.h>
28 #include <sys/utsname.h>
29 #include <sys/types.h>
30 #include <sys/time.h>
31 #include <sys/stat.h>
32 #include <fcntl.h>
33 #include "types.h"
34 #include "util.h"
35 #include "memory.h"
36
37
38 static int read_lockfile( const char *name );
39
40 /****************
41  * Create a lockfile with the given name. A TIMEOUT of 0
42  * returns immediately, -1 waits forever (hopefully not), other
43  * values are timeouts in milliseconds.
44  * Returns: a char pointer used as handle for release lock
45  *          or NULL in case of an error.
46  *
47  * Notes: This function creates a lock file in the same directory
48  *        as file_to_lock with the name "file_to_lock.lock"
49  *        A temporary file ".#lk.<hostname>.pid[.threadid] is used.
50  *        This function does nothing for Windoze.
51  */
52 const char *
53 make_dotlock( const char *file_to_lock, long timeout )
54 {
55     int  fd=-1, pid;
56     char pidstr[16];
57     const char *handle = NULL;
58     char *lockname = NULL;
59     char *tname = NULL;
60     int have_tfile = 0;
61     struct utsname uts;
62     const char *nodename;
63     const char *dirpart;
64     int dirpartlen;
65     const char *maybe_dead="";
66     int backoff=0;
67
68     sprintf( pidstr, "%10d\n", getpid() );
69     /* fixme: add the hostname to the second line (FQDN or IP addr?) */
70
71     /* create a temporary file */
72     if( uname( &uts ) )
73         nodename = "unknown";
74     else
75         nodename = uts.nodename;
76
77     if( !(dirpart = strrchr( file_to_lock, '/' )) ) {
78         dirpart = ".";
79         dirpartlen = 1;
80     }
81     else {
82         dirpartlen = dirpart - file_to_lock;
83         dirpart = file_to_lock;
84     }
85
86   #ifdef _THREAD_SAFE
87     tname = m_alloc( dirpartlen + 6 + strlen(nodename) + 11+ 20 );
88     sprintf( tname, "%.*s/.#lk.%s.%d.%p",
89                     dirpartlen, dirpart, nodename, getpid(), &pid );
90   #else
91     tname = m_alloc( dirpartlen + 6 + strlen(nodename) + 11 );
92     sprintf( tname, "%.*s/.#lk.%s.%d",
93                     dirpartlen, dirpart, nodename, getpid() );
94   #endif
95     do {
96         errno = 0;
97         fd = open( tname, O_WRONLY|O_CREAT|O_EXCL,
98                           S_IRUSR|S_IRGRP|S_IROTH|S_IWUSR );
99     } while( fd == -1 && errno == EINTR );
100     if( fd == -1 ) {
101         log_error( "failed to create temporary file `%s': %s\n",
102                                               tname, strerror(errno));
103         goto leave;
104     }
105     have_tfile = 1;
106     if( write(fd, pidstr, 11 ) != 11 ) {
107         log_fatal( "error writing to `%s': %s\n", tname, strerror(errno) );
108         goto leave;
109     }
110     if( close(fd) ) {
111         log_error( "error closing `%s': %s\n", tname, strerror(errno));
112         goto leave;
113     }
114     fd = -1;
115
116     lockname = m_alloc( strlen(file_to_lock) + 6 );
117     strcpy(stpcpy(lockname, file_to_lock), ".lock");
118
119   retry:
120     if( !link(tname, lockname) ) {/* fixme: better use stat to check the link count */
121         handle = lockname;
122         lockname = NULL;
123     }
124     else if( errno == EEXIST ) {
125         if( (pid = read_lockfile(lockname)) == -1 ) {
126             if( errno == ENOENT ) {
127                 log_info( "lockfile disappeared\n");
128                 goto retry;
129             }
130             log_info("cannot read lockfile\n");
131         }
132         else if( pid == getpid() ) {
133             log_info( "Oops: lock already hold by us\n");
134             handle = lockname;
135             lockname = NULL;
136         }
137         else if( kill(pid, 0) && errno == ESRCH ) {
138             maybe_dead = " - probably dead";
139          #if 0 /* we should not do this without checking the permissions */
140                /* and the hostname */
141             log_info( "removing stale lockfile (created by %d)", pid );
142             remove( lockname );
143             goto retry;
144          #endif
145         }
146         if( timeout == -1 ) {
147             struct timeval tv;
148             log_info( "waiting for lock (hold by %d%s) ...\n", pid, maybe_dead );
149             /* can't use sleep, cause signals may be blocked */
150             tv.tv_sec = 1 + backoff;
151             tv.tv_usec = 0;
152             select(0, NULL, NULL, NULL, &tv);
153             if( backoff < 10 )
154                 backoff++ ;
155             goto retry;
156         }
157         /* fixme: implement timeouts */
158     }
159     else
160         log_error( "lock not made: link() failed: %s\n", strerror(errno) );
161
162   leave:
163     if( fd != -1 )
164         close(fd);
165     if( have_tfile )
166         remove(tname);
167     m_free(tname);
168     m_free(lockname);
169     return handle;
170 }
171
172 /****************
173  * Create a lockfile for a existing file
174  * Returns: a char pointer used as handle for release lock
175  *          or NULL in case of an error.
176  *
177  * Notes: This function creates a lock file in the same directory
178  *        as file_to_lock with the name "lock.<inode-no>"
179  *
180  * int
181  * make_inodelock( const char *file_to_lock )
182  *
183  */
184
185
186
187
188 /****************
189  * release a lock
190  * Returns: 0 := success
191  */
192 int
193 release_dotlock( const char *lockfile )
194 {
195     int pid = read_lockfile( lockfile );
196     if( pid == -1 ) {
197         log_error( "release_dotlock: lockfile error");
198         return -1;
199     }
200     if( pid != getpid() ) {
201         log_error( "release_dotlock: not our lock (pid=%d)", pid);
202         return -1;
203     }
204     if( remove( lockfile ) ) {
205         log_error( "release_dotlock: error removing lockfile `%s'",
206                                                             lockfile);
207         return -1;
208     }
209     m_free( (char*)lockfile );
210     return 0;
211 }
212
213
214 /****************
215  * Read the lock file and return the pid, returns -1 on error.
216  */
217 static int
218 read_lockfile( const char *name )
219 {
220     int fd, pid;
221     char pidstr[16];
222
223     if( (fd = open(name, O_RDONLY)) == -1 ) {
224         int e = errno;
225         log_debug("error opening lockfile `%s': %s\n", name, strerror(errno) );
226         errno = e;
227         return -1;
228     }
229     if( read(fd, pidstr, 10 ) != 10 ) {
230         log_debug("error reading lockfile `%s'", name );
231         close(fd);
232         errno = 0;
233         return -1;
234     }
235     close(fd);
236     pid = atoi(pidstr);
237     if( !pid || pid == -1 ) {
238         log_error("invalid pid %d in lockfile `%s'", pid, name );
239         errno = 0;
240         return -1;
241     }
242     return pid;
243 }
244