libatalk/adouble/ad_lock.c

   1 /*
   2  * $Id: ad_lock.c,v 1.11.6.4.2.2 2008-11-25 15:16:33 didg Exp $
   3  *
   4  * Copyright (c) 1998,1999 Adrian Sun (asun@zoology.washington.edu)
   5  * All Rights Reserved. See COPYRIGHT for more information.
   6  *
   7  * Byte-range locks. This uses either whole-file flocks to fake byte
   8  * locks or fcntl-based actual byte locks. Because fcntl locks are
   9  * process-oriented, we need to keep around a list of file descriptors
  10  * that refer to the same file. Currently, this doesn't serialize access
  11  * to the locks. as a result, there's the potential for race conditions.
  12  *
  13  * TODO: fix the race when reading/writing.
  14  *       keep a pool of both locks and reference counters around so that
  15  *       we can save on mallocs. we should also use a tree to keep things
  16  *       sorted.
  17  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 #include "config.h"
  21 #endif /* HAVE_CONFIG_H */
  22
  23 #include <atalk/adouble.h>
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <errno.h>
  28
  29 #include <string.h>
  30
  31 #include "ad_private.h"
  32
  33 /* translate between ADLOCK styles and specific locking mechanisms */
  34 #define XLATE_FLOCK(type) ((type) == ADLOCK_RD ? LOCK_SH : \
  35 ((type) == ADLOCK_WR ? LOCK_EX : \
  36  ((type) == ADLOCK_CLR ? LOCK_UN : -1)))
  37
  38 #ifdef DISABLE_LOCKING
  39 #define fcntl(a, b, c ) (0)
  40 #endif
  41
  42 /* ----------------------- */
  43 static int XLATE_FCNTL_LOCK(int type)
  44 {
  45     switch(type) {
  46     case ADLOCK_RD:
  47         return F_RDLCK;
  48     case ADLOCK_WR:
  49          return F_WRLCK;
  50     case ADLOCK_CLR:
  51          return F_UNLCK;
  52     }
  53     return -1;
  54 }
  55
  56 /* ----------------------- */
  57 static int OVERLAP(off_t a, off_t alen, off_t b, off_t blen)
  58 {
  59  return (!alen && a <= b) ||
  60         (!blen && b <= a) ||
  61         ( (a + alen > b) && (b + blen > a) );
  62 }
  63
  64 /* allocation for lock regions. we allocate aggressively and shrink
  65  * only in large chunks. */
  66 #define ARRAY_BLOCK_SIZE 10
  67 #define ARRAY_FREE_DELTA 100
  68
  69 /* remove a lock and compact space if necessary */
  70 static void adf_freelock(struct ad_fd *ad, const int i)
  71 {
  72     adf_lock_t *lock = ad->adf_lock + i;
  73
  74     if (--(*lock->refcount) < 1) {
  75         free(lock->refcount);
  76         if (!ad->adf_excl) {
  77             lock->lock.l_type = F_UNLCK;
  78             fcntl(ad->adf_fd, F_SETLK, &lock->lock); /* unlock */
  79         }
  80     }
  81
  82     ad->adf_lockcount--;
  83
  84     /* move another lock into the empty space */
  85     if (i < ad->adf_lockcount) {
  86         memcpy(lock, lock + ad->adf_lockcount - i, sizeof(adf_lock_t));
  87     }
  88
  89     /* free extra cruft if we go past a boundary. we always want to
  90      * keep at least some stuff around for allocations. this wastes
  91      * a bit of space to save time on reallocations. */
  92     if ((ad->adf_lockmax > ARRAY_FREE_DELTA) &&
  93         (ad->adf_lockcount + ARRAY_FREE_DELTA < ad->adf_lockmax)) {
  94             struct adf_lock_t *tmp;
  95
  96             tmp = (struct adf_lock_t *)
  97                     realloc(ad->adf_lock, sizeof(adf_lock_t)*
  98                             (ad->adf_lockcount + ARRAY_FREE_DELTA));
  99             if (tmp) {
 100                 ad->adf_lock = tmp;
 101                 ad->adf_lockmax = ad->adf_lockcount + ARRAY_FREE_DELTA;
 102             }
 103     }
 104 }
 105
 106
 107 /* this needs to deal with the following cases:
 108  * 1) user is the only user of the lock
 109  * 2) user shares a read lock with another user
 110  *
 111  * i converted to using arrays of locks. everytime a lock
 112  * gets removed, we shift all of the locks down.
 113  */
 114 static void adf_unlock(struct ad_fd *ad, const int user)
 115 {
 116     adf_lock_t *lock = ad->adf_lock;
 117     int i;
 118
 119     for (i = 0; i < ad->adf_lockcount; i++) {
 120       if (lock[i].user == user) {
 121         /* we're really going to delete this lock. note: read locks
 122            are the only ones that allow refcounts > 1 */
 123          adf_freelock(ad, i);
 124          i--; /* we shifted things down, so we need to backtrack */
 125        }
 126     }
 127 }
 128
 129 /* relock any byte lock that overlaps off/len. unlock everything
 130  * else. */
 131 static void adf_relockrange(struct ad_fd *ad, int fd,
 132                                        const off_t off, const off_t len)
 133 {
 134     adf_lock_t *lock = ad->adf_lock;
 135     int i;
 136
 137     if (!ad->adf_excl) for (i = 0; i < ad->adf_lockcount; i++) {
 138       if (OVERLAP(off, len, lock[i].lock.l_start, lock[i].lock.l_len))
 139         fcntl(fd, F_SETLK, &lock[i].lock);
 140     }
 141 }
 142
 143
 144 /* find a byte lock that overlaps off/len for a particular user */
 145 static int adf_findlock(struct ad_fd *ad,
 146                                    const int user, const int type,
 147                                    const off_t off,
 148                                    const off_t len)
 149 {
 150   adf_lock_t *lock = ad->adf_lock;
 151   int i;
 152
 153   for (i = 0; i < ad->adf_lockcount; i++) {
 154     if ((((type & ADLOCK_RD) && (lock[i].lock.l_type == F_RDLCK)) ||
 155         ((type & ADLOCK_WR) && (lock[i].lock.l_type == F_WRLCK))) &&
 156         (lock[i].user == user) &&
 157         OVERLAP(off, len, lock[i].lock.l_start, lock[i].lock.l_len)) {
 158       return i;
 159     }
 160   }
 161
 162   return -1;
 163 }
 164
 165
 166 /* search other user lock lists */
 167 static int adf_findxlock(struct ad_fd *ad,
 168                                      const int user, const int type,
 169                                      const off_t off,
 170                                      const off_t len)
 171 {
 172   adf_lock_t *lock = ad->adf_lock;
 173   int i;
 174
 175   for (i = 0; i < ad->adf_lockcount; i++) {
 176     if ((((type & ADLOCK_RD) && (lock[i].lock.l_type == F_RDLCK)) ||
 177          ((type & ADLOCK_WR) && (lock[i].lock.l_type == F_WRLCK))) &&
 178         (lock[i].user != user) &&
 179         OVERLAP(off, len, lock[i].lock.l_start, lock[i].lock.l_len))
 180             return i;
 181   }
 182   return -1;
 183 }
 184
 185 /* okay, this needs to do the following:
 186  * 1) check current list of locks. error on conflict.
 187  * 2) apply the lock. error on conflict with another process.
 188  * 3) update the list of locks this file has.
 189  *
 190  * NOTE: this treats synchronization locks a little differently. we
 191  *       do the following things for those:
 192  *       1) if the header file exists, all the locks go in the beginning
 193  *          of that.
 194  *       2) if the header file doesn't exist, we stick the locks
 195  *          in the locations specified by AD_FILELOCK_RD/WR.
 196  */
 197 #define LOCK_RSRC_RD (0)
 198 #define LOCK_RSRC_WR (1)
 199 #define LOCK_DATA_RD (2)
 200 #define LOCK_DATA_WR (3)
 201
 202 #define LOCK_RSRC_DRD (4)
 203 #define LOCK_RSRC_DWR (5)
 204 #define LOCK_DATA_DRD (6)
 205 #define LOCK_DATA_DWR (7)
 206
 207 #define LOCK_RSRC_NONE (8)
 208 #define LOCK_DATA_NONE (9)
 209
 210 /* --------------
 211         translate a data fork lock to an offset
 212 */
 213
 214 static off_t df2off(int off)
 215 {
 216 int start = off;
 217         if (off == AD_FILELOCK_OPEN_WR)
 218                 start = LOCK_DATA_WR;
 219         else if (off == AD_FILELOCK_OPEN_RD)
 220                 start = LOCK_DATA_RD;
 221     else if (off == AD_FILELOCK_DENY_RD)
 222                 start = LOCK_DATA_DRD;
 223         else if (off == AD_FILELOCK_DENY_WR)
 224                 start = LOCK_DATA_DWR;
 225         else if (off == AD_FILELOCK_OPEN_NONE)
 226                 start = LOCK_DATA_NONE;
 227         return start;
 228 }
 229
 230 /* --------------
 231         translate a resource fork lock to an offset
 232 */
 233
 234 static off_t hf2off(int off)
 235 {
 236 int start = off;
 237         if (off == AD_FILELOCK_OPEN_WR)
 238                 start = LOCK_RSRC_WR;
 239         else if (off == AD_FILELOCK_OPEN_RD)
 240                 start = LOCK_RSRC_RD;
 241     else if (off == AD_FILELOCK_DENY_RD)
 242                 start = LOCK_RSRC_DRD;
 243         else if (off == AD_FILELOCK_DENY_WR)
 244                 start = LOCK_RSRC_DWR;
 245         else if (off == AD_FILELOCK_OPEN_NONE)
 246                 start = LOCK_RSRC_NONE;
 247         return start;
 248 }
 249
 250 /* ------------------ */
 251 int ad_fcntl_lock(struct adouble *ad, const u_int32_t eid, const int locktype,
 252                   const off_t off, const off_t len, const int user)
 253 {
 254   struct flock lock;
 255   struct ad_fd *adf;
 256   adf_lock_t *adflock;
 257   int oldlock;
 258   int i;
 259   int type;
 260
 261   lock.l_start = off;
 262   type = locktype;
 263   if (eid == ADEID_DFORK) {
 264     adf = &ad->ad_df;
 265     if ((type & ADLOCK_FILELOCK)) {
 266         if (ad_hfileno(ad) != -1) {
 267             lock.l_start = df2off(off);
 268             adf = &ad->ad_hf;
 269         }
 270     }
 271   } else { /* rfork */
 272     adf = &ad->ad_hf;
 273     if (adf->adf_fd == -1) {
 274         /* there's no resource fork. return a lock error
 275          * otherwise if a second process is able to create it
 276          * locks are a mess.
 277          */
 278         errno = EACCES;
 279         return -1;
 280     }
 281     if (type & ADLOCK_FILELOCK)
 282       lock.l_start = hf2off(off);
 283     else
 284       lock.l_start += ad_getentryoff(ad, eid);
 285   }
 286   /* NOTE: we can't write lock a read-only file. on those, we just
 287     * make sure that we have a read lock set. that way, we at least prevent
 288     * someone else from really setting a deny read/write on the file.
 289     */
 290   if (!(adf->adf_flags & O_RDWR) && (type & ADLOCK_WR)) {
 291       type = (type & ~ADLOCK_WR) | ADLOCK_RD;
 292   }
 293
 294   lock.l_type = XLATE_FCNTL_LOCK(type & ADLOCK_MASK);
 295   lock.l_whence = SEEK_SET;
 296   lock.l_len = len;
 297
 298   /* byte_lock(len=-1) lock whole file */
 299   if (len == BYTELOCK_MAX) {
 300       lock.l_len -= lock.l_start; /* otherwise  EOVERFLOW error */
 301   }
 302
 303   /* see if it's locked by another user.
 304    * NOTE: this guarantees that any existing locks must be at most
 305    * read locks. we use ADLOCK_WR/RD because F_RD/WRLCK aren't
 306    * guaranteed to be ORable. */
 307   if (adf_findxlock(adf, user, ADLOCK_WR |
 308                     ((type & ADLOCK_WR) ? ADLOCK_RD : 0),
 309                     lock.l_start, lock.l_len) > -1) {
 310     errno = EACCES;
 311     return -1;
 312   }
 313
 314   /* look for any existing lock that we may have */
 315   i = adf_findlock(adf, user, ADLOCK_RD | ADLOCK_WR, lock.l_start, lock.l_len);
 316   adflock = (i < 0) ? NULL : adf->adf_lock + i;
 317
 318   /* here's what we check for:
 319      1) we're trying to re-lock a lock, but we didn't specify an update.
 320      2) we're trying to free only part of a lock.
 321      3) we're trying to free a non-existent lock. */
 322   if ((!adflock && (lock.l_type == F_UNLCK)) ||
 323       (adflock && !(type & ADLOCK_UPGRADE) &&
 324        ((lock.l_type != F_UNLCK) || (adflock->lock.l_start != lock.l_start) ||
 325         (adflock->lock.l_len != lock.l_len)))) {
 326     errno = EINVAL;
 327     return -1;
 328   }
 329
 330
 331   /* now, update our list of locks */
 332   /* clear the lock */
 333   if (lock.l_type == F_UNLCK) {
 334     adf_freelock(adf, i);
 335     return 0;
 336   }
 337
 338   /* attempt to lock the file. */
 339   if (!adf->adf_excl && fcntl(adf->adf_fd, F_SETLK, &lock) < 0)
 340     return -1;
 341
 342   /* we upgraded this lock. */
 343   if (adflock && (type & ADLOCK_UPGRADE)) {
 344     memcpy(&adflock->lock, &lock, sizeof(lock));
 345     return 0;
 346   }
 347
 348   /* it wasn't an upgrade */
 349   oldlock = -1;
 350   if (lock.l_type == F_RDLCK) {
 351     oldlock = adf_findxlock(adf, user, ADLOCK_RD, lock.l_start, lock.l_len);
 352   }
 353
 354   /* no more space. this will also happen if lockmax == lockcount == 0 */
 355   if (adf->adf_lockmax == adf->adf_lockcount) {
 356     adf_lock_t *tmp = (adf_lock_t *)
 357             realloc(adf->adf_lock, sizeof(adf_lock_t)*
 358                     (adf->adf_lockmax + ARRAY_BLOCK_SIZE));
 359     if (!tmp)
 360       goto fcntl_lock_err;
 361     adf->adf_lock = tmp;
 362     adf->adf_lockmax += ARRAY_BLOCK_SIZE;
 363   }
 364   adflock = adf->adf_lock + adf->adf_lockcount;
 365
 366   /* fill in fields */
 367   memcpy(&adflock->lock, &lock, sizeof(lock));
 368   adflock->user = user;
 369   if (oldlock > -1) {
 370     adflock->refcount = (adf->adf_lock + oldlock)->refcount;
 371   } else if ((adflock->refcount = calloc(1, sizeof(int))) == NULL) {
 372     goto fcntl_lock_err;
 373   }
 374
 375   (*adflock->refcount)++;
 376   adf->adf_lockcount++;
 377   return 0;
 378
 379 fcntl_lock_err:
 380   lock.l_type = F_UNLCK;
 381   if (!adf->adf_excl) fcntl(adf->adf_fd, F_SETLK, &lock);
 382   return -1;
 383 }
 384
 385 /* -------------------------
 386    we are using lock as tristate variable
 387
 388    we have a lock ==> 1
 389    no             ==> 0
 390    error          ==> -1
 391
 392 */
 393 int ad_testlock(struct adouble *ad, int eid, const off_t off)
 394 {
 395   struct flock lock;
 396   struct ad_fd *adf;
 397   adf_lock_t *plock;
 398   int i;
 399
 400   lock.l_start = off;
 401   if (eid == ADEID_DFORK) {
 402     adf = &ad->ad_df;
 403     if ((ad_hfileno(ad) != -1)) {
 404         adf = &ad->ad_hf;
 405         lock.l_start = df2off(off);
 406     }
 407   }
 408   else { /* rfork */
 409     if ((ad_hfileno(ad) == -1)) {
 410         /* there's no resource fork. return no lock */
 411         return 0;
 412     }
 413     adf = &ad->ad_hf;
 414     lock.l_start = hf2off(off);
 415   }
 416
 417   plock = adf->adf_lock;
 418   /* Does we have a lock? */
 419   lock.l_whence = SEEK_SET;
 420   lock.l_len = 1;
 421   for (i = 0; i < adf->adf_lockcount; i++) {
 422     if (OVERLAP(lock.l_start, 1, plock[i].lock.l_start, plock[i].lock.l_len))
 423         return 1;   /* */
 424   }
 425   /* Does another process have a lock?
 426      FIXME F_GETLK ?
 427   */
 428   lock.l_type = (adf->adf_flags & O_RDWR) ?F_WRLCK : F_RDLCK;
 429
 430   if (fcntl(adf->adf_fd, F_SETLK, &lock) < 0) {
 431     return (errno == EACCES || errno == EAGAIN)?1:-1;
 432   }
 433
 434   lock.l_type = F_UNLCK;
 435   return fcntl(adf->adf_fd, F_SETLK, &lock);
 436 }
 437
 438 /* -------------------------
 439 */
 440 int ad_fcntl_tmplock(struct adouble *ad, const u_int32_t eid, const int locktype,
 441                      const off_t off, const off_t len, const int user)
 442 {
 443   struct flock lock;
 444   struct ad_fd *adf;
 445   int err;
 446   int type;
 447
 448   lock.l_start = off;
 449   type = locktype;
 450   if (eid == ADEID_DFORK) {
 451     adf = &ad->ad_df;
 452   } else {
 453     adf = &ad->ad_hf;
 454     if (adf->adf_fd == -1) {
 455         /* there's no resource fork. return success */
 456         return 0;
 457     }
 458     /* if ADLOCK_FILELOCK we want a lock from offset 0
 459      * it's used when deleting a file:
 460      * in open we put read locks on meta datas
 461      * in delete a write locks on the whole file
 462      * so if the file is open by somebody else it fails
 463     */
 464     if (!(type & ADLOCK_FILELOCK))
 465         lock.l_start += ad_getentryoff(ad, eid);
 466   }
 467
 468   if (!(adf->adf_flags & O_RDWR) && (type & ADLOCK_WR)) {
 469       type = (type & ~ADLOCK_WR) | ADLOCK_RD;
 470   }
 471
 472   lock.l_type = XLATE_FCNTL_LOCK(type & ADLOCK_MASK);
 473   lock.l_whence = SEEK_SET;
 474   lock.l_len = len;
 475
 476   /* see if it's locked by another user. */
 477   if (user && adf_findxlock(adf, user, ADLOCK_WR |
 478                     ((type & ADLOCK_WR) ? ADLOCK_RD : 0),
 479                     lock.l_start, lock.l_len) > -1) {
 480     errno = EACCES;
 481     return -1;
 482   }
 483
 484   /* okay, we might have ranges byte-locked. we need to make sure that
 485    * we restore the appropriate ranges once we're done. so, we check
 486    * for overlap on an unlock and relock.
 487    * XXX: in the future, all the byte locks will be sorted and contiguous.
 488    *      we just want to upgrade all the locks and then downgrade them
 489    *      here. */
 490   if (!adf->adf_excl) {
 491        err = fcntl(adf->adf_fd, F_SETLK, &lock);
 492   }
 493   else {
 494       err = 0;
 495   }
 496   if (!err && (lock.l_type == F_UNLCK))
 497     adf_relockrange(adf, adf->adf_fd, lock.l_start, len);
 498
 499   return err;
 500 }
 501
 502 /* -------------------------
 503    the fork is opened in Read Write, Deny Read, Deny Write mode
 504    lock the whole file once
 505 */
 506 int ad_excl_lock(struct adouble *ad, const u_int32_t eid)
 507 {
 508   struct ad_fd *adf;
 509   struct flock lock;
 510   int    err;
 511
 512   lock.l_start = 0;
 513   lock.l_type = F_WRLCK;
 514   lock.l_whence = SEEK_SET;
 515   lock.l_len = 0;
 516
 517   if (eid == ADEID_DFORK) {
 518     adf = &ad->ad_df;
 519   } else {
 520     adf = &ad->ad_hf;
 521     lock.l_start = ad_getentryoff(ad, eid);
 522   }
 523
 524   err = fcntl(adf->adf_fd, F_SETLK, &lock);
 525   if (!err)
 526       adf->adf_excl = 1;
 527   return err;
 528 }
 529
 530 /* --------------------- */
 531 void ad_fcntl_unlock(struct adouble *ad, const int user)
 532 {
 533   if (ad->ad_df.adf_fd != -1) {
 534     adf_unlock(&ad->ad_df, user);
 535   }
 536   if (ad->ad_hf.adf_fd != -1) {
 537     adf_unlock(&ad->ad_hf, user);
 538   }
 539 }