src/ubik/ubik.c

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 #include <afsconfig.h>
  11 #include <afs/param.h>
  12
  13 #include <roken.h>
  14
  15 #include <lock.h>
  16 #include <rx/xdr.h>
  17 #include <rx/rx.h>
  18 #include <afs/cellconfig.h>
  19
  20 #define UBIK_INTERNALS
  21 #include "ubik.h"
  22 #include "ubik_int.h"
  23
  24 #include <lwp.h>   /* temporary hack by klm */
  25
  26 #define ERROR_EXIT(code) do { \
  27     error = (code); \
  28     goto error_exit; \
  29 } while (0)
  30
  31 /*!
  32  * \file
  33  * This system is organized in a hierarchical set of related modules.  Modules
  34  * at one level can only call modules at the same level or below.
  35  *
  36  * At the bottom level (0) we have R, RFTP, LWP and IOMGR, i.e. the basic
  37  * operating system primitives.
  38  *
  39  * At the next level (1) we have
  40  *
  41  * \li VOTER--The module responsible for casting votes when asked.  It is also
  42  * responsible for determining whether this server should try to become
  43  * a synchronization site.
  44  * \li BEACONER--The module responsible for sending keep-alives out when a
  45  * server is actually the sync site, or trying to become a sync site.
  46  * \li DISK--The module responsible for representing atomic transactions
  47  * on the local disk.  It maintains a new-value only log.
  48  * \li LOCK--The module responsible for locking byte ranges in the database file.
  49  *
  50  * At the next level (2) we have
  51  *
  52  * \li RECOVERY--The module responsible for ensuring that all members of a quorum
  53  * have the same up-to-date database after a new synchronization site is
  54  * elected.  This module runs only on the synchronization site.
  55  *
  56  * At the next level (3) we have
  57  *
  58  * \li REMOTE--The module responsible for interpreting requests from the sync
  59  * site and applying them to the database, after obtaining the appropriate
  60  * locks.
  61  *
  62  * At the next level (4) we have
  63  *
  64  * \li UBIK--The module users call to perform operations on the database.
  65  */
  66
  67
  68 /* some globals */
  69 afs_int32 ubik_quorum = 0;
  70 struct ubik_dbase *ubik_dbase = 0;
  71 struct ubik_stats ubik_stats;
  72 afs_uint32 ubik_host[UBIK_MAX_INTERFACE_ADDR];
  73 afs_int32 ubik_epochTime = 0;
  74 afs_int32 urecovery_state = 0;
  75 int (*ubik_SyncWriterCacheProc) (void);
  76 struct ubik_server *ubik_servers;
  77 short ubik_callPortal;
  78
  79 /* These global variables were used to control the server security layers.
  80  * They are retained for backwards compatibility with legacy callers.
  81  *
  82  * The ubik_SetServerSecurityProcs() interface should be used instead.
  83  */
  84
  85 int (*ubik_SRXSecurityProc) (void *, struct rx_securityClass **, afs_int32 *);
  86 void *ubik_SRXSecurityRock;
  87 int (*ubik_CheckRXSecurityProc) (void *, struct rx_call *);
  88 void *ubik_CheckRXSecurityRock;
  89
  90
  91
  92 static int BeginTrans(struct ubik_dbase *dbase, afs_int32 transMode,
  93                       struct ubik_trans **transPtr, int readAny);
  94
  95 static struct rx_securityClass **ubik_sc = NULL;
  96 static void (*buildSecClassesProc)(void *, struct rx_securityClass ***,
  97                                    afs_int32 *) = NULL;
  98 static int (*checkSecurityProc)(void *, struct rx_call *) = NULL;
  99 static void *securityRock = NULL;
 100
 101 struct version_data version_globals;
 102
 103 #define CStampVersion       1   /* meaning set ts->version */
 104
 105 static_inline struct rx_connection *
 106 Quorum_StartIO(struct ubik_trans *atrans, struct ubik_server *as)
 107 {
 108     struct rx_connection *conn;
 109
 110     UBIK_ADDR_LOCK;
 111     conn = as->disk_rxcid;
 112
 113 #ifdef AFS_PTHREAD_ENV
 114     rx_GetConnection(conn);
 115     UBIK_ADDR_UNLOCK;
 116     DBRELE(atrans->dbase);
 117 #else
 118     UBIK_ADDR_UNLOCK;
 119 #endif /* AFS_PTHREAD_ENV */
 120
 121     return conn;
 122 }
 123
 124 static_inline void
 125 Quorum_EndIO(struct ubik_trans *atrans, struct rx_connection *aconn)
 126 {
 127 #ifdef AFS_PTHREAD_ENV
 128     DBHOLD(atrans->dbase);
 129     rx_PutConnection(aconn);
 130 #endif /* AFS_PTHREAD_ENV */
 131 }
 132
 133
 134 /*
 135  * Iterate over all servers.  Callers pass in *ts which is used to track
 136  * the current server.
 137  * - Returns 1 if there are no more servers
 138  * - Returns 0 with conn set to the connection for the current server if
 139  *   it's up and current
 140  */
 141 static int
 142 ContactQuorum_iterate(struct ubik_trans *atrans, int aflags, struct ubik_server **ts,
 143                          struct rx_connection **conn, afs_int32 *rcode,
 144                          afs_int32 *okcalls, afs_int32 code)
 145 {
 146     if (!*ts) {
 147         /* Initial call - start iterating over servers */
 148         *ts = ubik_servers;
 149         *conn = NULL;
 150         *rcode = 0;
 151         *okcalls = 0;
 152     } else {
 153         if (*conn) {
 154             Quorum_EndIO(atrans, *conn);
 155             *conn = NULL;
 156             if (code) {         /* failure */
 157                 *rcode = code;
 158                 UBIK_BEACON_LOCK;
 159                 (*ts)->up = 0;          /* mark as down now; beacons will no longer be sent */
 160                 (*ts)->beaconSinceDown = 0;
 161                 UBIK_BEACON_UNLOCK;
 162                 (*ts)->currentDB = 0;
 163                 urecovery_LostServer(*ts);      /* tell recovery to try to resend dbase later */
 164             } else {            /* success */
 165                 if (!(*ts)->isClone)
 166                     (*okcalls)++;       /* count up how many worked */
 167                 if (aflags & CStampVersion) {
 168                     (*ts)->version = atrans->dbase->version;
 169                 }
 170             }
 171         }
 172         *ts = (*ts)->next;
 173     }
 174     if (!(*ts))
 175         return 1;
 176     UBIK_BEACON_LOCK;
 177     if (!(*ts)->up || !(*ts)->currentDB) {
 178         UBIK_BEACON_UNLOCK;
 179         (*ts)->currentDB = 0;   /* db is no longer current; we just missed an update */
 180         return 0;               /* not up-to-date, don't bother.  NULL conn will tell caller not to use */
 181     }
 182     UBIK_BEACON_UNLOCK;
 183     *conn = Quorum_StartIO(atrans, *ts);
 184     return 0;
 185 }
 186
 187 static int
 188 ContactQuorum_rcode(int okcalls, afs_int32 rcode)
 189 {
 190     /*
 191      * return 0 if we successfully contacted a quorum, otherwise return error code.
 192      * We don't have to contact ourselves (that was done locally)
 193      */
 194     if (okcalls + 1 >= ubik_quorum)
 195         return 0;
 196     else
 197         return rcode;
 198 }
 199
 200 /*!
 201  * \brief Perform an operation at a quorum, handling error conditions.
 202  * \return 0 if all worked and a quorum was contacted successfully
 203  * \return otherwise mark failing server as down and return #UERROR
 204  *
 205  * \note If any server misses an update, we must wait #BIGTIME seconds before
 206  * allowing the transaction to commit, to ensure that the missing and
 207  * possibly still functioning server times out and stops handing out old
 208  * data.  This is done in the commit code, where we wait for a server marked
 209  * down to have stayed down for #BIGTIME seconds before we allow a transaction
 210  * to commit.  A server that fails but comes back up won't give out old data
 211  * because it is sent the sync count along with the beacon message that
 212  * marks it as \b really up (\p beaconSinceDown).
 213  */
 214 afs_int32
 215 ContactQuorum_NoArguments(afs_int32 (*proc)(struct rx_connection *, ubik_tid *),
 216                           struct ubik_trans *atrans, int aflags)
 217 {
 218     struct ubik_server *ts = NULL;
 219     afs_int32 code = 0, rcode, okcalls;
 220     struct rx_connection *conn;
 221     int done;
 222
 223     done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 224     while (!done) {
 225         if (conn)
 226             code = (*proc)(conn, &atrans->tid);
 227         done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 228     }
 229     return ContactQuorum_rcode(okcalls, rcode);
 230 }
 231
 232
 233 afs_int32
 234 ContactQuorum_DISK_Lock(struct ubik_trans *atrans, int aflags,afs_int32 file,
 235                         afs_int32 position, afs_int32 length, afs_int32 type)
 236 {
 237     struct ubik_server *ts = NULL;
 238     afs_int32 code = 0, rcode, okcalls;
 239     struct rx_connection *conn;
 240     int done;
 241
 242     done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 243     while (!done) {
 244         if (conn)
 245             code = DISK_Lock(conn, &atrans->tid, file, position, length, type);
 246         done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 247     }
 248     return ContactQuorum_rcode(okcalls, rcode);
 249 }
 250
 251
 252 afs_int32
 253 ContactQuorum_DISK_Write(struct ubik_trans *atrans, int aflags,
 254                          afs_int32 file, afs_int32 position, bulkdata *data)
 255 {
 256     struct ubik_server *ts = NULL;
 257     afs_int32 code = 0, rcode, okcalls;
 258     struct rx_connection *conn;
 259     int done;
 260
 261     done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 262     while (!done) {
 263         if (conn)
 264             code = DISK_Write(conn, &atrans->tid, file, position, data);
 265         done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 266     }
 267     return ContactQuorum_rcode(okcalls, rcode);
 268 }
 269
 270
 271 afs_int32
 272 ContactQuorum_DISK_Truncate(struct ubik_trans *atrans, int aflags,
 273                             afs_int32 file, afs_int32 length)
 274 {
 275     struct ubik_server *ts = NULL;
 276     afs_int32 code = 0, rcode, okcalls;
 277     struct rx_connection *conn;
 278     int done;
 279
 280     done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 281     while (!done) {
 282         if (conn)
 283             code = DISK_Truncate(conn, &atrans->tid, file, length);
 284         done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 285     }
 286     return ContactQuorum_rcode(okcalls, rcode);
 287 }
 288
 289
 290 afs_int32
 291 ContactQuorum_DISK_WriteV(struct ubik_trans *atrans, int aflags,
 292                           iovec_wrt * io_vector, iovec_buf *io_buffer)
 293 {
 294     struct ubik_server *ts = NULL;
 295     afs_int32 code = 0, rcode, okcalls;
 296     struct rx_connection *conn;
 297     int done;
 298
 299     done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 300     while (!done) {
 301         if (conn) {
 302             code = DISK_WriteV(conn, &atrans->tid, io_vector, io_buffer);
 303             if ((code <= -450) && (code > -500)) {
 304                 /* An RPC interface mismatch (as defined in comerr/error_msg.c).
 305                  * Un-bulk the entries and do individual DISK_Write calls
 306                  * instead of DISK_WriteV.
 307                  */
 308                 struct ubik_iovec *iovec =
 309                         (struct ubik_iovec *)io_vector->iovec_wrt_val;
 310                 char *iobuf = (char *)io_buffer->iovec_buf_val;
 311                 bulkdata tcbs;
 312                 afs_int32 i, offset;
 313
 314                 for (i = 0, offset = 0; i < io_vector->iovec_wrt_len; i++) {
 315                     /* Sanity check for going off end of buffer */
 316                     if ((offset + iovec[i].length) > io_buffer->iovec_buf_len) {
 317                         code = UINTERNAL;
 318                         break;
 319                     }
 320                     tcbs.bulkdata_len = iovec[i].length;
 321                     tcbs.bulkdata_val = &iobuf[offset];
 322                     code = DISK_Write(conn, &atrans->tid, iovec[i].file,
 323                            iovec[i].position, &tcbs);
 324                     if (code)
 325                         break;
 326                     offset += iovec[i].length;
 327                 }
 328             }
 329         }
 330         done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 331     }
 332     return ContactQuorum_rcode(okcalls, rcode);
 333 }
 334
 335
 336 afs_int32
 337 ContactQuorum_DISK_SetVersion(struct ubik_trans *atrans, int aflags,
 338                               ubik_version *OldVersion,
 339                               ubik_version *NewVersion)
 340 {
 341     struct ubik_server *ts = NULL;
 342     afs_int32 code = 0, rcode, okcalls;
 343     struct rx_connection *conn;
 344     int done;
 345
 346     done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 347     while (!done) {
 348         if (conn)
 349             code = DISK_SetVersion(conn, &atrans->tid, OldVersion, NewVersion);
 350         done = ContactQuorum_iterate(atrans, aflags, &ts, &conn, &rcode, &okcalls, code);
 351     }
 352     return ContactQuorum_rcode(okcalls, rcode);
 353 }
 354
 355 #if defined(AFS_PTHREAD_ENV)
 356 static int
 357 ubik_thread_create(pthread_attr_t *tattr, pthread_t *thread, void *proc) {
 358     osi_Assert(pthread_attr_init(tattr) == 0);
 359     osi_Assert(pthread_attr_setdetachstate(tattr, PTHREAD_CREATE_DETACHED) == 0);
 360     osi_Assert(pthread_create(thread, tattr, proc, NULL) == 0);
 361     return 0;
 362 }
 363 #endif
 364
 365 /*!
 366  * \brief This routine initializes the ubik system for a set of servers.
 367  * \return 0 for success, or an error code on failure.
 368  * \param serverList set of servers specified; nServers gives the number of entries in this array.
 369  * \param pathName provides an initial prefix used for naming storage files used by this system.
 370  * \param dbase the returned structure representing this instance of an ubik; it is passed to various calls below.
 371  *
 372  * \todo This routine should perhaps be generalized to a low-level disk interface providing read, write, file enumeration and sync operations.
 373  *
 374  * \warning The host named by myHost should not also be listed in serverList.
 375  *
 376  * \see ubik_ServerInit(), ubik_ServerInitByInfo()
 377  */
 378 static int
 379 ubik_ServerInitCommon(afs_uint32 myHost, short myPort,
 380                       struct afsconf_cell *info, char clones[],
 381                       afs_uint32 serverList[], const char *pathName,
 382                       struct ubik_dbase **dbase)
 383 {
 384     struct ubik_dbase *tdb;
 385     afs_int32 code;
 386 #ifdef AFS_PTHREAD_ENV
 387     pthread_t rxServerThread;        /* pthread variables */
 388     pthread_t ubeacon_InteractThread;
 389     pthread_t urecovery_InteractThread;
 390     pthread_attr_t rxServer_tattr;
 391     pthread_attr_t ubeacon_Interact_tattr;
 392     pthread_attr_t urecovery_Interact_tattr;
 393 #else
 394     PROCESS junk;
 395     extern int rx_stackSize;
 396 #endif
 397
 398     afs_int32 secIndex;
 399     struct rx_securityClass *secClass;
 400     int numClasses;
 401
 402     struct rx_service *tservice;
 403
 404     initialize_U_error_table();
 405
 406     tdb = malloc(sizeof(struct ubik_dbase));
 407     tdb->pathName = strdup(pathName);
 408     tdb->activeTrans = (struct ubik_trans *)0;
 409     memset(&tdb->version, 0, sizeof(struct ubik_version));
 410     memset(&tdb->cachedVersion, 0, sizeof(struct ubik_version));
 411 #ifdef AFS_PTHREAD_ENV
 412     MUTEX_INIT(&tdb->versionLock, "version lock", MUTEX_DEFAULT, 0);
 413     MUTEX_INIT(&beacon_globals.beacon_lock, "beacon lock", MUTEX_DEFAULT, 0);
 414     MUTEX_INIT(&vote_globals.vote_lock, "vote lock", MUTEX_DEFAULT, 0);
 415     MUTEX_INIT(&addr_globals.addr_lock, "address lock", MUTEX_DEFAULT, 0);
 416     MUTEX_INIT(&version_globals.version_lock, "version lock", MUTEX_DEFAULT, 0);
 417 #else
 418     Lock_Init(&tdb->versionLock);
 419 #endif
 420     Lock_Init(&tdb->cache_lock);
 421     tdb->flags = 0;
 422     tdb->read = uphys_read;
 423     tdb->write = uphys_write;
 424     tdb->truncate = uphys_truncate;
 425     tdb->open = uphys_invalidate;       /* this function isn't used any more */
 426     tdb->sync = uphys_sync;
 427     tdb->stat = uphys_stat;
 428     tdb->getlabel = uphys_getlabel;
 429     tdb->setlabel = uphys_setlabel;
 430     tdb->getnfiles = uphys_getnfiles;
 431     tdb->readers = 0;
 432     tdb->tidCounter = tdb->writeTidCounter = 0;
 433     *dbase = tdb;
 434     ubik_dbase = tdb;           /* for now, only one db per server; can fix later when we have names for the other dbases */
 435
 436 #ifdef AFS_PTHREAD_ENV
 437     CV_INIT(&tdb->version_cond, "version", CV_DEFAULT, 0);
 438     CV_INIT(&tdb->flags_cond, "flags", CV_DEFAULT, 0);
 439 #endif /* AFS_PTHREAD_ENV */
 440
 441     /* initialize RX */
 442
 443     /* the following call is idempotent so when/if it got called earlier,
 444      * by whatever called us, it doesn't really matter -- klm */
 445     code = rx_Init(myPort);
 446     if (code < 0)
 447         return code;
 448
 449     ubik_callPortal = myPort;
 450
 451     udisk_Init(ubik_nBuffers);
 452     ulock_Init();
 453
 454     code = uvote_Init();
 455     if (code)
 456         return code;
 457     code = urecovery_Initialize(tdb);
 458     if (code)
 459         return code;
 460     if (info)
 461         code = ubeacon_InitServerListByInfo(myHost, info, clones);
 462     else
 463         code = ubeacon_InitServerList(myHost, serverList);
 464     if (code)
 465         return code;
 466
 467     /* try to get an additional security object */
 468     if (buildSecClassesProc == NULL) {
 469         numClasses = 3;
 470         ubik_sc = calloc(numClasses, sizeof(struct rx_securityClass *));
 471         ubik_sc[0] = rxnull_NewServerSecurityObject();
 472         if (ubik_SRXSecurityProc) {
 473             code = (*ubik_SRXSecurityProc) (ubik_SRXSecurityRock,
 474                                             &secClass,
 475                                             &secIndex);
 476             if (code == 0) {
 477                  ubik_sc[secIndex] = secClass;
 478             }
 479         }
 480     } else {
 481         (*buildSecClassesProc) (securityRock, &ubik_sc, &numClasses);
 482     }
 483     /* for backwards compat this should keep working as it does now
 484        and not host bind */
 485
 486     tservice =
 487         rx_NewService(0, VOTE_SERVICE_ID, "VOTE", ubik_sc, numClasses,
 488                       VOTE_ExecuteRequest);
 489     if (tservice == (struct rx_service *)0) {
 490         ubik_dprint("Could not create VOTE rx service!\n");
 491         return -1;
 492     }
 493     rx_SetMinProcs(tservice, 2);
 494     rx_SetMaxProcs(tservice, 3);
 495
 496     tservice =
 497         rx_NewService(0, DISK_SERVICE_ID, "DISK", ubik_sc, numClasses,
 498                       DISK_ExecuteRequest);
 499     if (tservice == (struct rx_service *)0) {
 500         ubik_dprint("Could not create DISK rx service!\n");
 501         return -1;
 502     }
 503     rx_SetMinProcs(tservice, 2);
 504     rx_SetMaxProcs(tservice, 3);
 505
 506     /* start an rx_ServerProc to handle incoming RPC's in particular the
 507      * UpdateInterfaceAddr RPC that occurs in ubeacon_InitServerList. This avoids
 508      * the "steplock" problem in ubik initialization. Defect 11037.
 509      */
 510 #ifdef AFS_PTHREAD_ENV
 511     ubik_thread_create(&rxServer_tattr, &rxServerThread, (void *)rx_ServerProc);
 512 #else
 513     LWP_CreateProcess(rx_ServerProc, rx_stackSize, RX_PROCESS_PRIORITY,
 514               NULL, "rx_ServerProc", &junk);
 515 #endif
 516
 517     /* send addrs to all other servers */
 518     code = ubeacon_updateUbikNetworkAddress(ubik_host);
 519     if (code)
 520         return code;
 521
 522     /* now start up async processes */
 523 #ifdef AFS_PTHREAD_ENV
 524     ubik_thread_create(&ubeacon_Interact_tattr, &ubeacon_InteractThread,
 525                 (void *)ubeacon_Interact);
 526 #else
 527     code = LWP_CreateProcess(ubeacon_Interact, 16384 /*8192 */ ,
 528                              LWP_MAX_PRIORITY - 1, (void *)0, "beacon",
 529                              &junk);
 530     if (code)
 531         return code;
 532 #endif
 533
 534 #ifdef AFS_PTHREAD_ENV
 535     ubik_thread_create(&urecovery_Interact_tattr, &urecovery_InteractThread,
 536                 (void *)urecovery_Interact);
 537     return 0;  /* is this correct?  - klm */
 538 #else
 539     code = LWP_CreateProcess(urecovery_Interact, 16384 /*8192 */ ,
 540                              LWP_MAX_PRIORITY - 1, (void *)0, "recovery",
 541                              &junk);
 542     return code;
 543 #endif
 544
 545 }
 546
 547 /*!
 548  * \see ubik_ServerInitCommon()
 549  */
 550 int
 551 ubik_ServerInitByInfo(afs_uint32 myHost, short myPort,
 552                       struct afsconf_cell *info, char clones[],
 553                       const char *pathName, struct ubik_dbase **dbase)
 554 {
 555     afs_int32 code;
 556
 557     code =
 558         ubik_ServerInitCommon(myHost, myPort, info, clones, 0, pathName,
 559                               dbase);
 560     return code;
 561 }
 562
 563 /*!
 564  * \see ubik_ServerInitCommon()
 565  */
 566 int
 567 ubik_ServerInit(afs_uint32 myHost, short myPort, afs_uint32 serverList[],
 568                 const char *pathName, struct ubik_dbase **dbase)
 569 {
 570     afs_int32 code;
 571
 572     code =
 573         ubik_ServerInitCommon(myHost, myPort, (struct afsconf_cell *)0, 0,
 574                               serverList, pathName, dbase);
 575     return code;
 576 }
 577
 578 /*!
 579  * \brief This routine begins a read or write transaction on the transaction
 580  * identified by transPtr, in the dbase named by dbase.
 581  *
 582  * An open mode of ubik_READTRANS identifies this as a read transaction,
 583  * while a mode of ubik_WRITETRANS identifies this as a write transaction.
 584  * transPtr is set to the returned transaction control block.
 585  * The readAny flag is set to 0 or 1 or 2 by the wrapper functions
 586  * ubik_BeginTrans() or ubik_BeginTransReadAny() or
 587  * ubik_BeginTransReadAnyWrite() below.
 588  *
 589  * \note We can only begin transaction when we have an up-to-date database.
 590  */
 591 static int
 592 BeginTrans(struct ubik_dbase *dbase, afs_int32 transMode,
 593            struct ubik_trans **transPtr, int readAny)
 594 {
 595     struct ubik_trans *jt;
 596     struct ubik_trans *tt;
 597     afs_int32 code;
 598
 599     if (readAny > 1 && ubik_SyncWriterCacheProc == NULL) {
 600         /* it's not safe to use ubik_BeginTransReadAnyWrite without a
 601          * cache-syncing function; fall back to ubik_BeginTransReadAny,
 602          * which is safe but slower */
 603         ubik_print("ubik_BeginTransReadAnyWrite called, but "
 604                    "ubik_SyncWriterCacheProc not set; pretending "
 605                    "ubik_BeginTransReadAny was called instead\n");
 606         readAny = 1;
 607     }
 608
 609     if ((transMode != UBIK_READTRANS) && readAny)
 610         return UBADTYPE;
 611     DBHOLD(dbase);
 612     if (urecovery_AllBetter(dbase, readAny) == 0) {
 613         DBRELE(dbase);
 614         return UNOQUORUM;
 615     }
 616     /* otherwise we have a quorum, use it */
 617
 618     /* make sure that at most one write transaction occurs at any one time.  This
 619      * has nothing to do with transaction locking; that's enforced by the lock package.  However,
 620      * we can't even handle two non-conflicting writes, since our log and recovery modules
 621      * don't know how to restore one without possibly picking up some data from the other. */
 622     if (transMode == UBIK_WRITETRANS) {
 623         /* if we're writing already, wait */
 624         while (dbase->flags & DBWRITING) {
 625 #ifdef AFS_PTHREAD_ENV
 626             CV_WAIT(&dbase->flags_cond, &dbase->versionLock);
 627 #else
 628             DBRELE(dbase);
 629             LWP_WaitProcess(&dbase->flags);
 630             DBHOLD(dbase);
 631 #endif
 632         }
 633
 634         if (!ubeacon_AmSyncSite()) {
 635             DBRELE(dbase);
 636             return UNOTSYNC;
 637         }
 638     }
 639
 640     /* create the transaction */
 641     code = udisk_begin(dbase, transMode, &jt);  /* can't take address of register var */
 642     tt = jt;                    /* move to a register */
 643     if (code || tt == (struct ubik_trans *)NULL) {
 644         DBRELE(dbase);
 645         return code;
 646     }
 647     UBIK_VERSION_LOCK;
 648     if (readAny) {
 649         tt->flags |= TRREADANY;
 650         if (readAny > 1) {
 651             tt->flags |= TRREADWRITE;
 652         }
 653     }
 654     /* label trans and dbase with new tid */
 655     tt->tid.epoch = ubik_epochTime;
 656     /* bump by two, since tidCounter+1 means trans id'd by tidCounter has finished */
 657     tt->tid.counter = (dbase->tidCounter += 2);
 658
 659     if (transMode == UBIK_WRITETRANS) {
 660         /* for a write trans, we have to keep track of the write tid counter too */
 661         dbase->writeTidCounter = tt->tid.counter;
 662
 663         /* next try to start transaction on appropriate number of machines */
 664         code = ContactQuorum_NoArguments(DISK_Begin, tt, 0);
 665         if (code) {
 666             /* we must abort the operation */
 667             udisk_abort(tt);
 668             ContactQuorum_NoArguments(DISK_Abort, tt, 0); /* force aborts to the others */
 669             udisk_end(tt);
 670             UBIK_VERSION_UNLOCK;
 671             DBRELE(dbase);
 672             return code;
 673         }
 674     }
 675
 676     *transPtr = tt;
 677     UBIK_VERSION_UNLOCK;
 678     DBRELE(dbase);
 679     return 0;
 680 }
 681
 682 /*!
 683  * \see BeginTrans()
 684  */
 685 int
 686 ubik_BeginTrans(struct ubik_dbase *dbase, afs_int32 transMode,
 687                 struct ubik_trans **transPtr)
 688 {
 689     return BeginTrans(dbase, transMode, transPtr, 0);
 690 }
 691
 692 /*!
 693  * \see BeginTrans()
 694  */
 695 int
 696 ubik_BeginTransReadAny(struct ubik_dbase *dbase, afs_int32 transMode,
 697                        struct ubik_trans **transPtr)
 698 {
 699     return BeginTrans(dbase, transMode, transPtr, 1);
 700 }
 701
 702 /*!
 703  * \see BeginTrans()
 704  */
 705 int
 706 ubik_BeginTransReadAnyWrite(struct ubik_dbase *dbase, afs_int32 transMode,
 707                             struct ubik_trans **transPtr)
 708 {
 709     return BeginTrans(dbase, transMode, transPtr, 2);
 710 }
 711
 712 /*!
 713  * \brief This routine ends a read or write transaction by aborting it.
 714  */
 715 int
 716 ubik_AbortTrans(struct ubik_trans *transPtr)
 717 {
 718     afs_int32 code;
 719     afs_int32 code2;
 720     struct ubik_dbase *dbase;
 721
 722     dbase = transPtr->dbase;
 723
 724     if (transPtr->flags & TRCACHELOCKED) {
 725         ReleaseReadLock(&dbase->cache_lock);
 726         transPtr->flags &= ~TRCACHELOCKED;
 727     }
 728
 729     ObtainWriteLock(&dbase->cache_lock);
 730
 731     DBHOLD(dbase);
 732     memset(&dbase->cachedVersion, 0, sizeof(struct ubik_version));
 733
 734     ReleaseWriteLock(&dbase->cache_lock);
 735
 736     /* see if we're still up-to-date */
 737     if (!urecovery_AllBetter(dbase, transPtr->flags & TRREADANY)) {
 738         udisk_abort(transPtr);
 739         udisk_end(transPtr);
 740         DBRELE(dbase);
 741         return UNOQUORUM;
 742     }
 743
 744     if (transPtr->type == UBIK_READTRANS) {
 745         code = udisk_abort(transPtr);
 746         udisk_end(transPtr);
 747         DBRELE(dbase);
 748         return code;
 749     }
 750
 751     /* below here, we know we're doing a write transaction */
 752     if (!ubeacon_AmSyncSite()) {
 753         udisk_abort(transPtr);
 754         udisk_end(transPtr);
 755         DBRELE(dbase);
 756         return UNOTSYNC;
 757     }
 758
 759     /* now it is safe to try remote abort */
 760     code = ContactQuorum_NoArguments(DISK_Abort, transPtr, 0);
 761     code2 = udisk_abort(transPtr);
 762     udisk_end(transPtr);
 763     DBRELE(dbase);
 764     return (code ? code : code2);
 765 }
 766
 767 static void
 768 WritebackApplicationCache(struct ubik_dbase *dbase)
 769 {
 770     int code = 0;
 771     if (ubik_SyncWriterCacheProc) {
 772         code = ubik_SyncWriterCacheProc();
 773     }
 774     if (code) {
 775         /* we failed to sync the local cache, so just invalidate the cache;
 776          * we'll try to read the cache in again on the next read */
 777         memset(&dbase->cachedVersion, 0, sizeof(dbase->cachedVersion));
 778     } else {
 779         memcpy(&dbase->cachedVersion, &dbase->version,
 780                sizeof(dbase->cachedVersion));
 781     }
 782 }
 783
 784 /*!
 785  * \brief This routine ends a read or write transaction on the open transaction identified by transPtr.
 786  * \return an error code.
 787  */
 788 int
 789 ubik_EndTrans(struct ubik_trans *transPtr)
 790 {
 791     afs_int32 code;
 792     struct timeval tv;
 793     afs_int32 realStart;
 794     struct ubik_server *ts;
 795     afs_int32 now;
 796     int cachelocked = 0;
 797     struct ubik_dbase *dbase;
 798
 799     if (transPtr->type == UBIK_WRITETRANS) {
 800         code = ubik_Flush(transPtr);
 801         if (code) {
 802             ubik_AbortTrans(transPtr);
 803             return (code);
 804         }
 805     }
 806
 807     dbase = transPtr->dbase;
 808
 809     if (transPtr->flags & TRCACHELOCKED) {
 810         ReleaseReadLock(&dbase->cache_lock);
 811         transPtr->flags &= ~TRCACHELOCKED;
 812     }
 813
 814     if (transPtr->type != UBIK_READTRANS) {
 815         /* must hold cache_lock before DBHOLD'ing */
 816         ObtainWriteLock(&dbase->cache_lock);
 817         cachelocked = 1;
 818     }
 819
 820     DBHOLD(dbase);
 821
 822     /* give up if no longer current */
 823     if (!urecovery_AllBetter(dbase, transPtr->flags & TRREADANY)) {
 824         udisk_abort(transPtr);
 825         udisk_end(transPtr);
 826         DBRELE(dbase);
 827         code = UNOQUORUM;
 828         goto error;
 829     }
 830
 831     if (transPtr->type == UBIK_READTRANS) {     /* reads are easy */
 832         code = udisk_commit(transPtr);
 833         if (code == 0)
 834             goto success;       /* update cachedVersion correctly */
 835         udisk_end(transPtr);
 836         DBRELE(dbase);
 837         goto error;
 838     }
 839
 840     if (!ubeacon_AmSyncSite()) {        /* no longer sync site */
 841         udisk_abort(transPtr);
 842         udisk_end(transPtr);
 843         DBRELE(dbase);
 844         code = UNOTSYNC;
 845         goto error;
 846     }
 847
 848     /* now it is safe to do commit */
 849     code = udisk_commit(transPtr);
 850     if (code == 0) {
 851         /* db data has been committed locally; update the local cache so
 852          * readers can get at it */
 853         WritebackApplicationCache(dbase);
 854
 855         ReleaseWriteLock(&dbase->cache_lock);
 856
 857         code = ContactQuorum_NoArguments(DISK_Commit, transPtr, CStampVersion);
 858
 859     } else {
 860         memset(&dbase->cachedVersion, 0, sizeof(struct ubik_version));
 861         ReleaseWriteLock(&dbase->cache_lock);
 862     }
 863     cachelocked = 0;
 864     if (code) {
 865         /* failed to commit, so must return failure.  Try to clear locks first, just for fun
 866          * Note that we don't know if this transaction will eventually commit at this point.
 867          * If it made it to a site that will be present in the next quorum, we win, otherwise
 868          * we lose.  If we contact a majority of sites, then we won't be here: contacting
 869          * a majority guarantees commit, since it guarantees that one dude will be a
 870          * member of the next quorum. */
 871         ContactQuorum_NoArguments(DISK_ReleaseLocks, transPtr, 0);
 872         udisk_end(transPtr);
 873         DBRELE(dbase);
 874         goto error;
 875     }
 876     /* before we can start sending unlock messages, we must wait until all servers
 877      * that are possibly still functioning on the other side of a network partition
 878      * have timed out.  Check the server structures, compute how long to wait, then
 879      * start the unlocks */
 880     realStart = FT_ApproxTime();
 881     while (1) {
 882         /* wait for all servers to time out */
 883         code = 0;
 884         now = FT_ApproxTime();
 885         /* check if we're still sync site, the guy should either come up
 886          * to us, or timeout.  Put safety check in anyway */
 887         if (now - realStart > 10 * BIGTIME) {
 888             ubik_stats.escapes++;
 889             ubik_print("ubik escaping from commit wait\n");
 890             break;
 891         }
 892         for (ts = ubik_servers; ts; ts = ts->next) {
 893             UBIK_BEACON_LOCK;
 894             if (!ts->beaconSinceDown && now <= ts->lastBeaconSent + BIGTIME) {
 895                 UBIK_BEACON_UNLOCK;
 896
 897                 /* this guy could have some damaged data, wait for him */
 898                 code = 1;
 899                 tv.tv_sec = 1;  /* try again after a while (ha ha) */
 900                 tv.tv_usec = 0;
 901
 902 #ifdef AFS_PTHREAD_ENV
 903                 /* we could release the dbase outside of the loop, but we do
 904                  * it here, in the loop, to avoid an unnecessary RELE/HOLD
 905                  * if all sites are up */
 906                 DBRELE(dbase);
 907                 select(0, 0, 0, 0, &tv);
 908                 DBHOLD(dbase);
 909 #else
 910                 IOMGR_Select(0, 0, 0, 0, &tv);  /* poll, should we wait on something? */
 911 #endif
 912
 913                 break;
 914             }
 915             UBIK_BEACON_UNLOCK;
 916         }
 917         if (code == 0)
 918             break;              /* no down ones still pseudo-active */
 919     }
 920
 921     /* finally, unlock all the dudes.  We can return success independent of the number of servers
 922      * that really unlock the dbase; the others will do it if/when they elect a new sync site.
 923      * The transaction is committed anyway, since we succeeded in contacting a quorum
 924      * at the start (when invoking the DiskCommit function).
 925      */
 926     ContactQuorum_NoArguments(DISK_ReleaseLocks, transPtr, 0);
 927
 928   success:
 929     udisk_end(transPtr);
 930     /* don't update cachedVersion here; it should have been updated way back
 931      * in ubik_CheckCache, and earlier in this function for writes */
 932     DBRELE(dbase);
 933     if (cachelocked) {
 934         ReleaseWriteLock(&dbase->cache_lock);
 935     }
 936     return 0;
 937
 938   error:
 939     if (!cachelocked) {
 940         ObtainWriteLock(&dbase->cache_lock);
 941     }
 942     memset(&dbase->cachedVersion, 0, sizeof(struct ubik_version));
 943     ReleaseWriteLock(&dbase->cache_lock);
 944     return code;
 945 }
 946
 947 /*!
 948  * \brief This routine reads length bytes into buffer from the current position in the database.
 949  *
 950  * The file pointer is updated appropriately (by adding the number of bytes actually transferred), and the length actually transferred is stored in the long integer pointed to by length.  A short read returns zero for an error code.
 951  *
 952  * \note *length is an INOUT parameter: at the start it represents the size of the buffer, and when done, it contains the number of bytes actually transferred.
 953  */
 954 int
 955 ubik_Read(struct ubik_trans *transPtr, void *buffer,
 956           afs_int32 length)
 957 {
 958     afs_int32 code;
 959
 960     /* reads are easy to do: handle locally */
 961     DBHOLD(transPtr->dbase);
 962     if (!urecovery_AllBetter(transPtr->dbase, transPtr->flags & TRREADANY)) {
 963         DBRELE(transPtr->dbase);
 964         return UNOQUORUM;
 965     }
 966
 967     code =
 968         udisk_read(transPtr, transPtr->seekFile, buffer, transPtr->seekPos,
 969                    length);
 970     if (code == 0) {
 971         transPtr->seekPos += length;
 972     }
 973     DBRELE(transPtr->dbase);
 974     return code;
 975 }
 976
 977 /*!
 978  * \brief This routine will flush the io data in the iovec structures.
 979  *
 980  * It first flushes to the local disk and then uses ContactQuorum to write it
 981  * to the other servers.
 982  */
 983 int
 984 ubik_Flush(struct ubik_trans *transPtr)
 985 {
 986     afs_int32 code, error = 0;
 987
 988     if (transPtr->type != UBIK_WRITETRANS)
 989         return UBADTYPE;
 990
 991     DBHOLD(transPtr->dbase);
 992     if (!transPtr->iovec_info.iovec_wrt_len
 993         || !transPtr->iovec_info.iovec_wrt_val) {
 994         DBRELE(transPtr->dbase);
 995         return 0;
 996     }
 997
 998     if (!urecovery_AllBetter(transPtr->dbase, transPtr->flags & TRREADANY))
 999         ERROR_EXIT(UNOQUORUM);
1000     if (!ubeacon_AmSyncSite())  /* only sync site can write */
1001         ERROR_EXIT(UNOTSYNC);
1002
1003     /* Update the rest of the servers in the quorum */
1004     code =
1005         ContactQuorum_DISK_WriteV(transPtr, 0, &transPtr->iovec_info,
1006                                   &transPtr->iovec_data);
1007     if (code) {
1008         udisk_abort(transPtr);
1009         ContactQuorum_NoArguments(DISK_Abort, transPtr, 0); /* force aborts to the others */
1010         transPtr->iovec_info.iovec_wrt_len = 0;
1011         transPtr->iovec_data.iovec_buf_len = 0;
1012         ERROR_EXIT(code);
1013     }
1014
1015     /* Wrote the buffers out, so start at scratch again */
1016     transPtr->iovec_info.iovec_wrt_len = 0;
1017     transPtr->iovec_data.iovec_buf_len = 0;
1018
1019   error_exit:
1020     DBRELE(transPtr->dbase);
1021     return error;
1022 }
1023
1024 int
1025 ubik_Write(struct ubik_trans *transPtr, void *vbuffer,
1026            afs_int32 length)
1027 {
1028     struct ubik_iovec *iovec;
1029     afs_int32 code, error = 0;
1030     afs_int32 pos, len, size;
1031     char * buffer = (char *)vbuffer;
1032
1033     if (transPtr->type != UBIK_WRITETRANS)
1034         return UBADTYPE;
1035     if (!length)
1036         return 0;
1037
1038     if (length > IOVEC_MAXBUF) {
1039         for (pos = 0, len = length; len > 0; len -= size, pos += size) {
1040             size = ((len < IOVEC_MAXBUF) ? len : IOVEC_MAXBUF);
1041             code = ubik_Write(transPtr, buffer+pos, size);
1042             if (code)
1043                 return (code);
1044         }
1045         return 0;
1046     }
1047
1048     DBHOLD(transPtr->dbase);
1049     if (!transPtr->iovec_info.iovec_wrt_val) {
1050         transPtr->iovec_info.iovec_wrt_len = 0;
1051         transPtr->iovec_info.iovec_wrt_val =
1052             malloc(IOVEC_MAXWRT * sizeof(struct ubik_iovec));
1053         transPtr->iovec_data.iovec_buf_len = 0;
1054         transPtr->iovec_data.iovec_buf_val = malloc(IOVEC_MAXBUF);
1055         if (!transPtr->iovec_info.iovec_wrt_val
1056             || !transPtr->iovec_data.iovec_buf_val) {
1057             if (transPtr->iovec_info.iovec_wrt_val)
1058                 free(transPtr->iovec_info.iovec_wrt_val);
1059             transPtr->iovec_info.iovec_wrt_val = 0;
1060             if (transPtr->iovec_data.iovec_buf_val)
1061                 free(transPtr->iovec_data.iovec_buf_val);
1062             transPtr->iovec_data.iovec_buf_val = 0;
1063             DBRELE(transPtr->dbase);
1064             return UNOMEM;
1065         }
1066     }
1067
1068     /* If this write won't fit in the structure, then flush it out and start anew */
1069     if ((transPtr->iovec_info.iovec_wrt_len >= IOVEC_MAXWRT)
1070         || ((length + transPtr->iovec_data.iovec_buf_len) > IOVEC_MAXBUF)) {
1071         /* Can't hold the DB lock over ubik_Flush */
1072         DBRELE(transPtr->dbase);
1073         code = ubik_Flush(transPtr);
1074         if (code)
1075             return (code);
1076         DBHOLD(transPtr->dbase);
1077     }
1078
1079     if (!urecovery_AllBetter(transPtr->dbase, transPtr->flags & TRREADANY))
1080         ERROR_EXIT(UNOQUORUM);
1081     if (!ubeacon_AmSyncSite())  /* only sync site can write */
1082         ERROR_EXIT(UNOTSYNC);
1083
1084     /* Write to the local disk */
1085     code =
1086         udisk_write(transPtr, transPtr->seekFile, buffer, transPtr->seekPos,
1087                     length);
1088     if (code) {
1089         udisk_abort(transPtr);
1090         transPtr->iovec_info.iovec_wrt_len = 0;
1091         transPtr->iovec_data.iovec_buf_len = 0;
1092         DBRELE(transPtr->dbase);
1093         return (code);
1094     }
1095
1096     /* Collect writes for the other ubik servers (to be done in bulk) */
1097     iovec = (struct ubik_iovec *)transPtr->iovec_info.iovec_wrt_val;
1098     iovec[transPtr->iovec_info.iovec_wrt_len].file = transPtr->seekFile;
1099     iovec[transPtr->iovec_info.iovec_wrt_len].position = transPtr->seekPos;
1100     iovec[transPtr->iovec_info.iovec_wrt_len].length = length;
1101
1102     memcpy(&transPtr->iovec_data.
1103            iovec_buf_val[transPtr->iovec_data.iovec_buf_len], buffer, length);
1104
1105     transPtr->iovec_info.iovec_wrt_len++;
1106     transPtr->iovec_data.iovec_buf_len += length;
1107     transPtr->seekPos += length;
1108
1109   error_exit:
1110     DBRELE(transPtr->dbase);
1111     return error;
1112 }
1113
1114 /*!
1115  * \brief This sets the file pointer associated with the current transaction
1116  * to the appropriate file and byte position.
1117  *
1118  * Unlike Unix files, a transaction is labelled by both a file number \p fileid
1119  * and a byte position relative to the specified file \p position.
1120  */
1121 int
1122 ubik_Seek(struct ubik_trans *transPtr, afs_int32 fileid,
1123           afs_int32 position)
1124 {
1125     afs_int32 code;
1126
1127     DBHOLD(transPtr->dbase);
1128     if (!urecovery_AllBetter(transPtr->dbase, transPtr->flags & TRREADANY)) {
1129         code = UNOQUORUM;
1130     } else {
1131         transPtr->seekFile = fileid;
1132         transPtr->seekPos = position;
1133         code = 0;
1134     }
1135     DBRELE(transPtr->dbase);
1136     return code;
1137 }
1138
1139 /*!
1140  * \brief This call returns the file pointer associated with the specified
1141  * transaction in \p fileid and \p position.
1142  */
1143 int
1144 ubik_Tell(struct ubik_trans *transPtr, afs_int32 * fileid,
1145           afs_int32 * position)
1146 {
1147     DBHOLD(transPtr->dbase);
1148     *fileid = transPtr->seekFile;
1149     *position = transPtr->seekPos;
1150     DBRELE(transPtr->dbase);
1151     return 0;
1152 }
1153
1154 /*!
1155  * \brief This sets the file size for the currently-selected file to \p length
1156  * bytes, if length is less than the file's current size.
1157  */
1158 int
1159 ubik_Truncate(struct ubik_trans *transPtr, afs_int32 length)
1160 {
1161     afs_int32 code, error = 0;
1162
1163     /* Will also catch if not UBIK_WRITETRANS */
1164     code = ubik_Flush(transPtr);
1165     if (code)
1166         return (code);
1167
1168     DBHOLD(transPtr->dbase);
1169     /* first, check that quorum is still good, and that dbase is up-to-date */
1170     if (!urecovery_AllBetter(transPtr->dbase, transPtr->flags & TRREADANY))
1171         ERROR_EXIT(UNOQUORUM);
1172     if (!ubeacon_AmSyncSite())
1173         ERROR_EXIT(UNOTSYNC);
1174
1175     /* now do the operation locally, and propagate it out */
1176     code = udisk_truncate(transPtr, transPtr->seekFile, length);
1177     if (!code) {
1178         code =
1179             ContactQuorum_DISK_Truncate(transPtr, 0, transPtr->seekFile,
1180                                         length);
1181     }
1182     if (code) {
1183         /* we must abort the operation */
1184         udisk_abort(transPtr);
1185         ContactQuorum_NoArguments(DISK_Abort, transPtr, 0); /* force aborts to the others */
1186         ERROR_EXIT(code);
1187     }
1188
1189   error_exit:
1190     DBRELE(transPtr->dbase);
1191     return error;
1192 }
1193
1194 /*!
1195  * \brief set a lock; all locks are released on transaction end (commit/abort)
1196  */
1197 int
1198 ubik_SetLock(struct ubik_trans *atrans, afs_int32 apos, afs_int32 alen,
1199              int atype)
1200 {
1201     afs_int32 code = 0, error = 0;
1202
1203     if (atype == LOCKWRITE) {
1204         if (atrans->type == UBIK_READTRANS)
1205             return UBADTYPE;
1206         code = ubik_Flush(atrans);
1207         if (code)
1208             return (code);
1209     }
1210
1211     DBHOLD(atrans->dbase);
1212     if (atype == LOCKREAD) {
1213         code = ulock_getLock(atrans, atype, 1);
1214         if (code)
1215             ERROR_EXIT(code);
1216     } else {
1217         /* first, check that quorum is still good, and that dbase is up-to-date */
1218         if (!urecovery_AllBetter(atrans->dbase, atrans->flags & TRREADANY))
1219             ERROR_EXIT(UNOQUORUM);
1220         if (!ubeacon_AmSyncSite())
1221             ERROR_EXIT(UNOTSYNC);
1222
1223         /* now do the operation locally, and propagate it out */
1224         code = ulock_getLock(atrans, atype, 1);
1225         if (code == 0) {
1226             code = ContactQuorum_DISK_Lock(atrans, 0, 0, 1 /*unused */ ,
1227                                            1 /*unused */ , LOCKWRITE);
1228         }
1229         if (code) {
1230             /* we must abort the operation */
1231             udisk_abort(atrans);
1232             ContactQuorum_NoArguments(DISK_Abort, atrans, 0); /* force aborts to the others */
1233             ERROR_EXIT(code);
1234         }
1235     }
1236
1237   error_exit:
1238     DBRELE(atrans->dbase);
1239     return error;
1240 }
1241
1242 /*!
1243  * \brief utility to wait for a version # to change
1244  */
1245 int
1246 ubik_WaitVersion(struct ubik_dbase *adatabase,
1247                  struct ubik_version *aversion)
1248 {
1249     DBHOLD(adatabase);
1250     while (1) {
1251         /* wait until version # changes, and then return */
1252         if (vcmp(*aversion, adatabase->version) != 0) {
1253             DBRELE(adatabase);
1254             return 0;
1255         }
1256 #ifdef AFS_PTHREAD_ENV
1257         CV_WAIT(&adatabase->version_cond, &adatabase->versionLock);
1258 #else
1259         DBRELE(adatabase);
1260         LWP_WaitProcess(&adatabase->version);   /* same vers, just wait */
1261         DBHOLD(adatabase);
1262 #endif
1263     }
1264 }
1265
1266 /*!
1267  * \brief utility to get the version of the dbase a transaction is dealing with
1268  */
1269 int
1270 ubik_GetVersion(struct ubik_trans *atrans,
1271                 struct ubik_version *avers)
1272 {
1273     DBHOLD(atrans->dbase);
1274     *avers = atrans->dbase->version;
1275     DBRELE(atrans->dbase);
1276     return 0;
1277 }
1278
1279 /*!
1280  * \brief Facility to simplify database caching.
1281  * \return zero if last trans was done on the local server and was successful.
1282  * \return -1 means bad (NULL) argument.
1283  *
1284  * If return value is non-zero and the caller is a server caching part of the
1285  * Ubik database, it should invalidate that cache.
1286  */
1287 static int
1288 ubik_CacheUpdate(struct ubik_trans *atrans)
1289 {
1290     if (!(atrans && atrans->dbase))
1291         return -1;
1292     return vcmp(atrans->dbase->cachedVersion, atrans->dbase->version) != 0;
1293 }
1294
1295 /**
1296  * check and possibly update cache of ubik db.
1297  *
1298  * If the version of the cached db data is out of date, this calls (*check) to
1299  * update the cache. If (*check) returns success, we update the version of the
1300  * cached db data.
1301  *
1302  * Checking the version of the cached db data is done under a read lock;
1303  * updating the cache (and thus calling (*check)) is done under a write lock
1304  * so is guaranteed not to interfere with another thread's (*check). On
1305  * successful return, a read lock on the cached db data is obtained, which
1306  * will be released by ubik_EndTrans or ubik_AbortTrans.
1307  *
1308  * @param[in] atrans ubik transaction
1309  * @param[in] check  function to call to check/update cache
1310  * @param[in] rock   rock to pass to *check
1311  *
1312  * @return operation status
1313  *   @retval 0       success
1314  *   @retval nonzero error; cachedVersion not updated
1315  *
1316  * @post On success, application cache is read-locked, and cache data is
1317  *       up-to-date
1318  */
1319 int
1320 ubik_CheckCache(struct ubik_trans *atrans, ubik_updatecache_func cbf, void *rock)
1321 {
1322     int ret = 0;
1323
1324     if (!(atrans && atrans->dbase))
1325         return -1;
1326
1327     ObtainReadLock(&atrans->dbase->cache_lock);
1328
1329     while (ubik_CacheUpdate(atrans) != 0) {
1330
1331         ReleaseReadLock(&atrans->dbase->cache_lock);
1332         ObtainSharedLock(&atrans->dbase->cache_lock);
1333
1334         if (ubik_CacheUpdate(atrans) != 0) {
1335
1336             BoostSharedLock(&atrans->dbase->cache_lock);
1337
1338             ret = (*cbf) (atrans, rock);
1339             if (ret == 0) {
1340                 memcpy(&atrans->dbase->cachedVersion, &atrans->dbase->version,
1341                        sizeof(atrans->dbase->cachedVersion));
1342             }
1343         }
1344
1345         /* It would be nice if we could convert from a shared lock to a read
1346          * lock... instead, just release the shared and acquire the read */
1347         ReleaseSharedLock(&atrans->dbase->cache_lock);
1348
1349         if (ret) {
1350             /* if we have an error, don't retry, and don't hold any locks */
1351             return ret;
1352         }
1353
1354         ObtainReadLock(&atrans->dbase->cache_lock);
1355     }
1356
1357     atrans->flags |= TRCACHELOCKED;
1358
1359     return 0;
1360 }
1361
1362 /*!
1363  * "Who said anything about panicking?" snapped Arthur.
1364  * "This is still just the culture shock. You wait till I've settled down
1365  * into the situation and found my bearings. \em Then I'll start panicking!"
1366  * --Authur Dent
1367  *
1368  * \returns There is no return from panic.
1369  */
1370 void
1371 panic(char *format, ...)
1372 {
1373     va_list ap;
1374
1375     va_start(ap, format);
1376     ubik_print("Ubik PANIC: ");
1377     ubik_vprint(format, ap);
1378     va_end(ap);
1379
1380     abort();
1381     ubik_print("BACK FROM ABORT\n");    /* shouldn't come back */
1382     exit(1);                    /* never know, though  */
1383 }
1384
1385 /*!
1386  * This function takes an IP addresses as its parameter. It returns the
1387  * the primary IP address that is on the host passed in, or 0 if not found.
1388  */
1389 afs_uint32
1390 ubikGetPrimaryInterfaceAddr(afs_uint32 addr)
1391 {
1392     struct ubik_server *ts;
1393     int j;
1394
1395     UBIK_ADDR_LOCK;
1396     for (ts = ubik_servers; ts; ts = ts->next)
1397         for (j = 0; j < UBIK_MAX_INTERFACE_ADDR; j++)
1398             if (ts->addr[j] == addr) {
1399                 UBIK_ADDR_UNLOCK;
1400                 return ts->addr[0];     /* net byte order */
1401             }
1402     UBIK_ADDR_UNLOCK;
1403     return 0;                   /* if not in server database, return error */
1404 }
1405
1406 int
1407 ubik_CheckAuth(struct rx_call *acall)
1408 {
1409     if (checkSecurityProc)
1410         return (*checkSecurityProc) (securityRock, acall);
1411     else if (ubik_CheckRXSecurityProc) {
1412         return (*ubik_CheckRXSecurityProc) (ubik_CheckRXSecurityRock, acall);
1413     } else
1414         return 0;
1415 }
1416
1417 void
1418 ubik_SetServerSecurityProcs(void (*buildproc) (void *,
1419                                                struct rx_securityClass ***,
1420                                                afs_int32 *),
1421                             int (*checkproc) (void *, struct rx_call *),
1422                             void *rock)
1423 {
1424     buildSecClassesProc = buildproc;
1425     checkSecurityProc = checkproc;
1426     securityRock = rock;
1427 }