git.marmaro.de Git - mmh/blob - sbr/lock_file.c

   1 /*
   2 ** lock.c -- routines to lock/unlock files
   3 **
   4 ** This code is Copyright (c) 2002, by the authors of nmh.  See the
   5 ** COPYRIGHT file in the root directory of the nmh distribution for
   6 ** complete copyright information.
   7 */
   8
   9 /*
  10 ** Modified by Ruud de Rooij to support Miquel van Smoorenburg's liblockfile
  11 **
  12 ** Since liblockfile locking shares most of its code with dot locking, it
  13 ** is enabled by defining both DOT_LOCKING and HAVE_LIBLOCKFILE.
  14 **
  15 ** Ruud de Rooij <ruud@debian.org>  Sun, 28 Mar 1999 15:34:03 +0200
  16 */
  17
  18 #include <h/mh.h>
  19 #include <h/signals.h>
  20 #include <h/utils.h>
  21
  22 #ifdef TIME_WITH_SYS_TIME
  23 # include <sys/time.h>
  24 # include <time.h>
  25 #else
  26 # ifdef TM_IN_SYS_TIME
  27 #  include <sys/time.h>
  28 # else
  29 #  include <time.h>
  30 # endif
  31 #endif
  32
  33 #ifdef HAVE_ERRNO_H
  34 # include <errno.h>
  35 #endif
  36
  37 #ifdef HAVE_FCNTL_H
  38 # include <fcntl.h>
  39 #else
  40 # include <sys/file.h>
  41 #endif
  42
  43 #if defined(LOCKF_LOCKING) || defined(FLOCK_LOCKING)
  44 # include <sys/file.h>
  45 #endif
  46
  47 #include <signal.h>
  48
  49 #if defined(HAVE_LIBLOCKFILE)
  50 #include <lockfile.h>
  51 #endif
  52
  53 #ifdef LOCKDIR
  54 char *lockdir = LOCKDIR;
  55 #endif
  56
  57 /* Are we using any kernel locking? */
  58 #if defined (FLOCK_LOCKING) || defined(LOCKF_LOCKING) || defined(FCNTL_LOCKING)
  59 # define KERNEL_LOCKING
  60 #endif
  61
  62 #ifdef DOT_LOCKING
  63
  64 /* struct for getting name of lock file to create */
  65 struct lockinfo {
  66         char curlock[BUFSIZ];
  67 #if !defined(HAVE_LIBLOCKFILE)
  68         char tmplock[BUFSIZ];
  69 #endif
  70 };
  71
  72 /*
  73 ** Amount of time to wait before
  74 ** updating ctime of lock file.
  75 */
  76 #define NSECS 20
  77
  78 #if !defined(HAVE_LIBLOCKFILE)
  79 /*
  80 ** How old does a lock file need to be
  81 ** before we remove it.
  82 */
  83 #define RSECS 180
  84 #endif /* HAVE_LIBLOCKFILE */
  85
  86 /* struct for recording and updating locks */
  87 struct lock {
  88         int l_fd;
  89         char *l_lock;
  90         struct lock *l_next;
  91 };
  92
  93 /* top of list containing all open locks */
  94 static struct lock *l_top = NULL;
  95 #endif /* DOT_LOCKING */
  96
  97 /*
  98 ** static prototypes
  99 */
 100 #ifdef KERNEL_LOCKING
 101 static int lkopen_kernel (char *, int, mode_t);
 102 #endif
 103
 104 #ifdef DOT_LOCKING
 105 static int lkopen_dot (char *, int, mode_t);
 106 static void lockname (char *, struct lockinfo *, int);
 107 static void timerON (char *, int);
 108 static void timerOFF (int);
 109 static RETSIGTYPE alrmser (int);
 110 #endif
 111
 112 #if !defined(HAVE_LIBLOCKFILE)
 113 static int lockit (struct lockinfo *);
 114 #endif
 115
 116 /*
 117 ** Base routine to open and lock a file,
 118 ** and return a file descriptor.
 119 */
 120
 121 int
 122 lkopen (char *file, int access, mode_t mode)
 123 {
 124 #ifdef KERNEL_LOCKING
 125         return lkopen_kernel(file, access, mode);
 126 #endif
 127
 128 #ifdef DOT_LOCKING
 129         return lkopen_dot(file, access, mode);
 130 #endif
 131 }
 132
 133
 134 /*
 135 ** Base routine to close and unlock a file,
 136 ** given a file descriptor.
 137 */
 138
 139 int
 140 lkclose (int fd, char *file)
 141 {
 142 #ifdef FCNTL_LOCKING
 143         struct flock buf;
 144 #endif
 145
 146 #ifdef DOT_LOCKING
 147         struct lockinfo lkinfo;
 148 #endif
 149
 150         if (fd == -1)
 151                 return 0;
 152
 153 #ifdef FCNTL_LOCKING
 154         buf.l_type   = F_UNLCK;
 155         buf.l_whence = SEEK_SET;
 156         buf.l_start  = 0;
 157         buf.l_len = 0;
 158         fcntl(fd, F_SETLK, &buf);
 159 #endif
 160
 161 #ifdef FLOCK_LOCKING
 162         flock (fd, LOCK_UN);
 163 #endif
 164
 165 #ifdef LOCKF_LOCKING
 166         /* make sure we unlock the whole thing */
 167         lseek (fd, (off_t) 0, SEEK_SET);
 168         lockf (fd, F_ULOCK, 0L);
 169 #endif
 170
 171 #ifdef DOT_LOCKING
 172         lockname (file, &lkinfo, 0);  /* get name of lock file */
 173 #if !defined(HAVE_LIBLOCKFILE)
 174         unlink (lkinfo.curlock);  /* remove lock file */
 175 #else
 176         lockfile_remove(lkinfo.curlock);
 177 #endif /* HAVE_LIBLOCKFILE */
 178         timerOFF (fd);  /* turn off lock timer   */
 179 #endif /* DOT_LOCKING */
 180
 181         return (close (fd));
 182 }
 183
 184
 185 /*
 186 ** Base routine to open and lock a file,
 187 ** and return a FILE pointer
 188 */
 189
 190 FILE *
 191 lkfopen (char *file, char *mode)
 192 {
 193         int fd, access;
 194         FILE *fp;
 195
 196         if (strcmp (mode, "r") == 0)
 197                 access = O_RDONLY;
 198         else if (strcmp (mode, "r+") == 0)
 199                 access = O_RDWR;
 200         else if (strcmp (mode, "w") == 0)
 201                 access = O_WRONLY | O_CREAT | O_TRUNC;
 202         else if (strcmp (mode, "w+") == 0)
 203                 access = O_RDWR | O_CREAT | O_TRUNC;
 204         else if (strcmp (mode, "a") == 0)
 205                 access = O_WRONLY | O_CREAT | O_APPEND;
 206         else if (strcmp (mode, "a+") == 0)
 207                 access = O_RDWR | O_CREAT | O_APPEND;
 208         else {
 209                 errno = EINVAL;
 210                 return NULL;
 211         }
 212
 213         if ((fd = lkopen (file, access, 0666)) == -1)
 214                 return NULL;
 215
 216         if ((fp = fdopen (fd, mode)) == NULL) {
 217                 close (fd);
 218                 return NULL;
 219         }
 220
 221         return fp;
 222 }
 223
 224
 225 /*
 226 ** Base routine to close and unlock a file,
 227 ** given a FILE pointer
 228 */
 229
 230 int
 231 lkfclose (FILE *fp, char *file)
 232 {
 233 #ifdef FCNTL_LOCKING
 234         struct flock buf;
 235 #endif
 236
 237 #ifdef DOT_LOCKING
 238         struct lockinfo lkinfo;
 239 #endif
 240
 241         if (fp == NULL)
 242                 return 0;
 243
 244 #ifdef FCNTL_LOCKING
 245         buf.l_type   = F_UNLCK;
 246         buf.l_whence = SEEK_SET;
 247         buf.l_start  = 0;
 248         buf.l_len = 0;
 249         fcntl(fileno(fp), F_SETLK, &buf);
 250 #endif
 251
 252 #ifdef FLOCK_LOCKING
 253         flock (fileno(fp), LOCK_UN);
 254 #endif
 255
 256 #ifdef LOCKF_LOCKING
 257         /* make sure we unlock the whole thing */
 258         fseek (fp, 0L, SEEK_SET);
 259         lockf (fileno(fp), F_ULOCK, 0L);
 260 #endif
 261
 262 #ifdef DOT_LOCKING
 263         lockname (file, &lkinfo, 0);  /* get name of lock file */
 264 #if !defined(HAVE_LIBLOCKFILE)
 265         unlink (lkinfo.curlock);  /* remove lock file */
 266 #else
 267         lockfile_remove(lkinfo.curlock);
 268 #endif /* HAVE_LIBLOCKFILE */
 269         timerOFF (fileno(fp));  /* turn off lock timer   */
 270 #endif /* DOT_LOCKING */
 271
 272         return (fclose (fp));
 273 }
 274
 275
 276 #ifdef KERNEL_LOCKING
 277
 278 /*
 279 ** open and lock a file, using kernel locking
 280 */
 281
 282 static int
 283 lkopen_kernel (char *file, int access, mode_t mode)
 284 {
 285         int fd, i, j;
 286
 287 # ifdef FCNTL_LOCKING
 288         struct flock buf;
 289 # endif /* FCNTL_LOCKING */
 290
 291         for (i = 0; i < 5; i++) {
 292
 293 # if defined(LOCKF_LOCKING) || defined(FCNTL_LOCKING)
 294                 /* remember the original mode */
 295                 j = access;
 296
 297                 /* make sure we open at the beginning */
 298                 access &= ~O_APPEND;
 299
 300                 /*
 301                 ** We MUST have write permission or
 302                 ** lockf/fcntl() won't work
 303                 */
 304                 if ((access & 03) == O_RDONLY) {
 305                         access &= ~O_RDONLY;
 306                         access |= O_RDWR;
 307                 }
 308 # endif /* LOCKF_LOCKING || FCNTL_LOCKING */
 309
 310                 if ((fd = open (file, access | O_NDELAY, mode)) == -1)
 311                         return -1;
 312
 313 # ifdef FCNTL_LOCKING
 314                 buf.l_type   = F_WRLCK;
 315                 buf.l_whence = SEEK_SET;
 316                 buf.l_start  = 0;
 317                 buf.l_len = 0;
 318                 if (fcntl (fd, F_SETLK, &buf) != -1)
 319                         return fd;
 320 # endif
 321
 322 # ifdef FLOCK_LOCKING
 323                 if (flock (fd, (((access & 03) == O_RDONLY) ? LOCK_SH :
 324                         LOCK_EX) | LOCK_NB) != -1)
 325                         return fd;
 326 # endif
 327
 328 # ifdef LOCKF_LOCKING
 329                 if (lockf (fd, F_TLOCK, 0L) != -1) {
 330                         /* see if we should be at the end */
 331                         if (j & O_APPEND)
 332                                 lseek (fd, (off_t) 0, SEEK_END);
 333                         return fd;
 334                 }
 335 # endif
 336
 337                 j = errno;
 338                 close (fd);
 339                 sleep (5);
 340         }
 341
 342         close (fd);
 343         errno = j;
 344         return -1;
 345 }
 346
 347 #endif /* KERNEL_LOCKING */
 348
 349
 350 #ifdef DOT_LOCKING
 351
 352 /*
 353 ** open and lock a file, using dot locking
 354 */
 355
 356 static int
 357 lkopen_dot (char *file, int access, mode_t mode)
 358 {
 359         int fd;
 360         struct lockinfo lkinfo;
 361
 362         /* open the file */
 363         if ((fd = open (file, access, mode)) == -1)
 364                 return -1;
 365
 366         /*
 367         ** Get the name of the eventual lock file, as well
 368         ** as a name for a temporary lock file.
 369         */
 370         lockname (file, &lkinfo, 1);
 371
 372 #if !defined(HAVE_LIBLOCKFILE)
 373         {
 374                 int i;
 375                 for (i = 0;;) {
 376                         /* attempt to create lock file */
 377                         if (lockit (&lkinfo) == 0) {
 378                                 /* if successful, turn on timer and return */
 379                                 timerON (lkinfo.curlock, fd);
 380                                 return fd;
 381                         } else {
 382                                 /*
 383                                 ** Abort locking, if we fail to lock after 5
 384                                 ** attempts and are never able to stat the
 385                                 ** lock file.
 386                                 */
 387                                 struct stat st;
 388                                 if (stat (lkinfo.curlock, &st) == -1) {
 389                                         if (i++ > 5)
 390                                                 return -1;
 391                                         sleep (5);
 392                                 } else {
 393                                         time_t curtime;
 394                                         i = 0;
 395                                         time (&curtime);
 396
 397                                         /*
 398                                         ** check for stale lockfile,
 399                                         ** else sleep
 400                                         */
 401                                         if (curtime > st.st_ctime + RSECS)
 402                                                 unlink (lkinfo.curlock);
 403                                         else
 404                                                 sleep (5);
 405                                 }
 406                                 lockname (file, &lkinfo, 1);
 407                         }
 408                 }
 409         }
 410 #else
 411         if (lockfile_create(lkinfo.curlock, 5, 0) == L_SUCCESS) {
 412                 timerON(lkinfo.curlock, fd);
 413                 return fd;
 414         } else {
 415                 close(fd);
 416                 return -1;
 417         }
 418 #endif /* HAVE_LIBLOCKFILE */
 419 }
 420
 421 #if !defined(HAVE_LIBLOCKFILE)
 422 /*
 423 ** Routine that actually tries to create
 424 ** the lock file.
 425 */
 426
 427 static int
 428 lockit (struct lockinfo *li)
 429 {
 430         int fd;
 431         char *curlock, *tmplock;
 432
 433 #if 0
 434         char buffer[128];
 435 #endif
 436
 437         curlock = li->curlock;
 438         tmplock = li->tmplock;
 439
 440 #ifdef HAVE_MKSTEMP
 441         if ((fd = mkstemp(tmplock)) == -1)
 442                 return -1;
 443 #else
 444         if (mktemp(tmplock) == NULL)
 445                 return -1;
 446         if (unlink(tmplock) == -1 && errno != ENOENT)
 447                 return -1;
 448         /* create the temporary lock file */
 449         if ((fd = creat(tmplock, 0600)) == -1)
 450                 return -1;
 451 #endif
 452
 453 #if 0
 454         /* write our process id into lock file */
 455         snprintf (buffer, sizeof(buffer), "nmh lock: pid %d\n", (int) getpid());
 456         write(fd, buffer, strlen(buffer) + 1);
 457 #endif
 458
 459         close (fd);
 460
 461         /*
 462         ** Now try to create the real lock file
 463         ** by linking to the temporary file.
 464         */
 465         fd = link(tmplock, curlock);
 466         unlink(tmplock);
 467
 468         return (fd == -1 ? -1 : 0);
 469 }
 470 #endif /* HAVE_LIBLOCKFILE */
 471
 472 /*
 473 ** Get name of lock file, and temporary lock file
 474 */
 475
 476 static void
 477 lockname (char *file, struct lockinfo *li, int isnewlock)
 478 {
 479         int bplen, tmplen;
 480         char *bp, *cp;
 481
 482 #if 0
 483         struct stat st;
 484 #endif
 485
 486         if ((cp = strrchr (file, '/')) == NULL || *++cp == 0)
 487                 cp = file;
 488
 489         bp = li->curlock;
 490         bplen = 0;
 491 #ifdef LOCKDIR
 492         snprintf (bp, sizeof(li->curlock), "%s/", lockdir);
 493         tmplen = strlen (bp);
 494         bp += tmplen;
 495         bplen += tmplen;
 496 #else
 497         if (cp != file) {
 498                 snprintf (bp, sizeof(li->curlock), "%.*s", (int)(cp - file), file);
 499                 tmplen = strlen (bp);
 500                 bp += tmplen;
 501                 bplen += tmplen;
 502         }
 503 #endif
 504
 505 #if 0
 506         /*
 507         ** mmdf style dot locking.  Currently not supported.
 508         ** If we start supporting mmdf style dot locking,
 509         ** we will need to change the return value of lockname
 510         */
 511         if (stat (file, &st) == -1)
 512                 return -1;
 513
 514         snprintf (bp, sizeof(li->curlock) - bplen, "LCK%05d.%05d",
 515                 st.st_dev, st.st_ino);
 516 #endif
 517
 518         snprintf (bp, sizeof(li->curlock) - bplen, "%s.lock", cp);
 519
 520 #if !defined(HAVE_LIBLOCKFILE)
 521         /*
 522         ** If this is for a new lock, create a name for
 523         ** the temporary lock file for lockit()
 524         */
 525         if (isnewlock) {
 526                 if ((cp = strrchr (li->curlock, '/')) == NULL || *++cp == 0)
 527                         strncpy (li->tmplock, ",LCK.XXXXXX", sizeof(li->tmplock));
 528                 else
 529                         snprintf (li->tmplock, sizeof(li->tmplock), "%.*s,LCK.XXXXXX",
 530                                  (int)(cp - li->curlock), li->curlock);
 531         }
 532 #endif
 533 }
 534
 535
 536 /*
 537 ** Add new lockfile to the list of open lockfiles
 538 ** and start the lock file timer.
 539 */
 540
 541 static void
 542 timerON (char *curlock, int fd)
 543 {
 544         struct lock *lp;
 545         size_t len;
 546
 547         lp = (struct lock *) mh_xmalloc (sizeof(*lp));
 548
 549         len = strlen(curlock) + 1;
 550         lp->l_fd = fd;
 551         lp->l_lock = mh_xmalloc (len);
 552         memcpy (lp->l_lock, curlock, len);
 553         lp->l_next = l_top;
 554
 555         if (!l_top) {
 556                 /* perhaps SIGT{STP,TIN,TOU} ? */
 557                 SIGNAL (SIGALRM, alrmser);
 558                 alarm (NSECS);
 559         }
 560
 561         l_top = lp;
 562 }
 563
 564
 565 /*
 566 ** Search through the list of lockfiles for the
 567 ** current lockfile, and remove it from the list.
 568 */
 569
 570 static void
 571 timerOFF (int fd)
 572 {
 573         struct lock *pp, *lp;
 574
 575         alarm(0);
 576
 577         if (l_top) {
 578                 for (pp = lp = l_top; lp; pp = lp, lp = lp->l_next) {
 579                         if (lp->l_fd == fd)
 580                                 break;
 581                 }
 582                 if (lp) {
 583                         if (lp == l_top)
 584                                 l_top = lp->l_next;
 585                         else
 586                                 pp->l_next = lp->l_next;
 587
 588                         free (lp->l_lock);
 589                         free (lp);
 590                 }
 591         }
 592
 593         /* if there are locks left, restart timer */
 594         if (l_top)
 595                 alarm (NSECS);
 596 }
 597
 598
 599 /*
 600 ** If timer goes off, we update the ctime of all open
 601 ** lockfiles, so another command doesn't remove them.
 602 */
 603
 604 static RETSIGTYPE
 605 alrmser (int sig)
 606 {
 607         char *lockfile;
 608         struct lock *lp;
 609
 610 #ifndef RELIABLE_SIGNALS
 611         SIGNAL (SIGALRM, alrmser);
 612 #endif
 613
 614         /* update the ctime of all the lock files */
 615         for (lp = l_top; lp; lp = lp->l_next) {
 616                 lockfile = lp->l_lock;
 617 #if !defined(HAVE_LIBLOCKFILE)
 618                 {
 619                         int j;
 620                         if (*lockfile && (j = creat (lockfile, 0600)) != -1)
 621                                 close (j);
 622                 }
 623 #else
 624         lockfile_touch(lockfile);
 625 #endif
 626         }
 627
 628         /* restart the alarm */
 629         alarm (NSECS);
 630 }
 631
 632 #endif /* DOT_LOCKING */