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