src/ubik/ubik.p.h

   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 #ifndef UBIK_H
  11 #define UBIK_H
  12
  13 #include <stdarg.h>
  14
  15 #include <ubik_int.h>
  16
  17 /*! \name ubik_trans types */
  18 #define UBIK_READTRANS      0
  19 #define UBIK_WRITETRANS     1
  20 /*\}*/
  21
  22 /*! \name ubik_lock types */
  23 #define LOCKREAD            1
  24 #define LOCKWRITE           2
  25 #define LOCKWAIT            3
  26 /*\}*/
  27
  28 /*! \name ubik client flags */
  29 #define UPUBIKONLY          1   /*!< only check servers presumed functional */
  30 #define UBIK_CALL_NEW       2   /*!< use the semantics of ubik_Call_New */
  31 /*\}*/
  32
  33 /*! \name RX services types */
  34 #define VOTE_SERVICE_ID     50
  35 #define DISK_SERVICE_ID     51
  36 #define USER_SERVICE_ID     52  /*!< Since most applications use same port! */
  37 /*\}*/
  38
  39 #define UBIK_MAGIC      0x354545
  40
  41 /*! \name global ubik parameters */
  42 #define MAXSERVERS          20  /*!< max number of servers */
  43 /*\}*/
  44
  45 /*! version comparison macro */
  46 #define vcmp(a,b) ((a).epoch == (b).epoch? ((a).counter - (b).counter) : ((a).epoch - (b).epoch))
  47
  48 /*! \name ubik_client state bits */
  49 #define CFLastFailed        1   /*!< last call failed to this guy (to detect down hosts) */
  50 /*\}*/
  51
  52 #ifdef AFS_PTHREAD_ENV
  53 #include <pthread.h>
  54 #else
  55 #include <lwp.h>
  56 #endif
  57
  58 /*!
  59  * \brief per-client structure for ubik
  60  */
  61 struct ubik_client {
  62     short initializationState;  /*!< ubik client init state */
  63     short states[MAXSERVERS];   /*!< state bits */
  64     struct rx_connection *conns[MAXSERVERS];
  65     afs_int32 syncSite;
  66 #ifdef AFS_PTHREAD_ENV
  67     pthread_mutex_t cm;
  68 #endif
  69 };
  70
  71 #ifdef AFS_PTHREAD_ENV
  72 #define LOCK_UBIK_CLIENT(client) MUTEX_ENTER(&client->cm)
  73 #define UNLOCK_UBIK_CLIENT(client) MUTEX_EXIT(&client->cm)
  74 #else
  75 #define LOCK_UBIK_CLIENT(client)
  76 #define UNLOCK_UBIK_CLIENT(client)
  77 #endif
  78
  79 #define ubik_GetRPCConn(astr,aindex)    ((aindex) >= MAXSERVERS? 0 : (astr)->conns[aindex])
  80 #define ubik_GetRPCHost(astr,aindex)    ((aindex) >= MAXSERVERS? 0 : (astr)->hosts[aindex])
  81
  82 /*!
  83  * \brief ubik header file structure
  84  */
  85 struct ubik_hdr {
  86     afs_int32 magic;            /*!< magic number */
  87     short pad1;                 /*!< some 0-initd padding */
  88     short size;                 /*!< header allocation size */
  89     struct ubik_version version;        /*!< the version for this file */
  90 };
  91
  92 /*!
  93  * \brief representation of a ubik transaction
  94  */
  95 struct ubik_trans {
  96     struct ubik_dbase *dbase;   /*!< corresponding database */
  97     struct ubik_trans *next;    /*!< in the list */
  98     afs_int32 locktype;         /*!< transaction lock */
  99     struct ubik_trunc *activeTruncs;    /*!< queued truncates */
 100     struct ubik_tid tid;        /*!< transaction id of this trans (if write trans.) */
 101     afs_int32 minCommitTime;    /*!< time before which this trans can't commit */
 102     afs_int32 seekFile;         /*!< seek ptr: file number */
 103     afs_int32 seekPos;          /*!< seek ptr: offset therein */
 104     short flags;                /*!< trans flag bits */
 105     char type;                  /*!< type of trans */
 106     iovec_wrt iovec_info;
 107     iovec_buf iovec_data;
 108 };
 109
 110 /*!
 111  * \brief representation of a truncation operation
 112  */
 113 struct ubik_trunc {
 114     struct ubik_trunc *next;
 115     afs_int32 file;             /*!< file to truncate */
 116     afs_int32 length;           /*!< new size */
 117 };
 118
 119 struct ubik_stat {
 120     afs_int32 size;
 121     afs_int32 mtime;
 122 };
 123
 124 #if defined(UKERNEL)
 125 #include "afs/lock.h"
 126 #else /* defined(UKERNEL) */
 127 #include <lock.h>               /* just to make sure we've got this */
 128 #endif /* defined(UKERNEL) */
 129
 130 /*!
 131  * \brief representation of a ubik database.
 132  *
 133  * Contains info on low-level disk access routines
 134  * for use by disk transaction module.
 135  */
 136 struct ubik_dbase {
 137     char *pathName;             /*!< root name for dbase */
 138     struct ubik_trans *activeTrans;     /*!< active transaction list */
 139     struct ubik_version version;        /*!< version number */
 140 #ifdef AFS_PTHREAD_ENV
 141     pthread_mutex_t versionLock;        /*!< lock on version number */
 142 #elif defined(UKERNEL)
 143     struct afs_lock versionLock;        /*!< lock on version number */
 144 #else                           /* defined(UKERNEL) */
 145     struct Lock versionLock;    /*!< lock on version number */
 146 #endif                          /* defined(UKERNEL) */
 147     afs_int32 tidCounter;       /*!< last RW or RO trans tid counter */
 148     afs_int32 writeTidCounter;  /*!< last write trans tid counter */
 149     afs_int32 flags;            /*!< flags */
 150     /* physio procedures */
 151     int (*read) (struct ubik_dbase * adbase, afs_int32 afile, void *abuffer,
 152                  afs_int32 apos, afs_int32 alength);
 153     int (*write) (struct ubik_dbase * adbase, afs_int32 afile, void *abuffer,
 154                   afs_int32 apos, afs_int32 alength);
 155     int (*truncate) (struct ubik_dbase * adbase, afs_int32 afile,
 156                      afs_int32 asize);
 157     int (*sync) (struct ubik_dbase * adbase, afs_int32 afile);
 158     int (*stat) (struct ubik_dbase * adbase, afs_int32 afid,
 159                  struct ubik_stat * astat);
 160     void (*open) (struct ubik_dbase * adbase, afs_int32 afid);
 161     int (*setlabel) (struct ubik_dbase * adbase, afs_int32 afile, struct ubik_version * aversion);      /*!< set the version label */
 162     int (*getlabel) (struct ubik_dbase * adbase, afs_int32 afile, struct ubik_version * aversion);      /*!< retrieve the version label */
 163     int (*getnfiles) (struct ubik_dbase * adbase);      /*!< find out number of files */
 164     short readers;              /*!< number of current read transactions */
 165     struct ubik_version cachedVersion;  /*!< version of caller's cached data */
 166 #ifdef UKERNEL
 167     struct afs_lock cache_lock;
 168 #else
 169     struct Lock cache_lock; /*!< protects cached application data */
 170 #endif
 171 #ifdef AFS_PTHREAD_ENV
 172     pthread_cond_t version_cond;    /*!< condition variable to manage changes to version */
 173     pthread_cond_t flags_cond;      /*!< condition variable to manage changes to flags */
 174 #endif
 175 };
 176
 177 /**
 178  * ubik_CheckCache callback function.
 179  *
 180  * @param[in] atrans  ubik transaction
 181  * @param[in] rock    rock passed to ubik_CheckCache
 182  *
 183  * @return operation status
 184  *   @retval 0        cache was read properly
 185  */
 186 typedef int (*ubik_updatecache_func) (struct ubik_trans *atrans, void *rock);
 187
 188 /*! \name procedures for automatically authenticating ubik connections */
 189 extern int (*ubik_CRXSecurityProc) (void *, struct rx_securityClass **,
 190                                     afs_int32 *);
 191 extern void *ubik_CRXSecurityRock;
 192 extern int (*ubik_SRXSecurityProc) (void *, struct rx_securityClass **,
 193                                     afs_int32 *);
 194 extern void *ubik_SRXSecurityRock;
 195 extern int (*ubik_CheckRXSecurityProc) (void *, struct rx_call *);
 196 extern void *ubik_CheckRXSecurityRock;
 197
 198 extern void ubik_SetClientSecurityProcs(int (*scproc)(void *,
 199                                                       struct rx_securityClass **,
 200                                                       afs_int32 *),
 201                                         int (*checkproc) (void *),
 202                                         void *rock);
 203 extern void ubik_SetServerSecurityProcs
 204                 (void (*buildproc) (void *,
 205                                     struct rx_securityClass ***,
 206                                     afs_int32 *),
 207                  int (*checkproc) (void *, struct rx_call *),
 208                  void *rock);
 209
 210 /*\}*/
 211
 212 /*
 213  * For applications that make use of ubik_BeginTransReadAnyWrite, writing
 214  * processes must not update the application-level cache as they write,
 215  * or else readers can read the new cache before the data is committed to
 216  * the db. So, when a commit occurs, the cache must be updated right then.
 217  * If set, this function will be called during commits of write transactions,
 218  * to update the application-level cache after a write. This will be called
 219  * immediately after the local disk commit succeeds, and it will be called
 220  * with a lock held that prevents other threads from reading from the cache
 221  * or the db in general.
 222  *
 223  * Note that this function MUST be set in order to make use of
 224  * ubik_BeginTransReadAnyWrite.
 225  */
 226 extern int (*ubik_SyncWriterCacheProc) (void);
 227
 228 /****************INTERNALS BELOW ****************/
 229
 230 #ifdef UBIK_INTERNALS
 231 /*! \name some ubik parameters */
 232 #define UBIK_PAGESIZE       1024        /*!< fits in current r packet */
 233 #define UBIK_LOGPAGESIZE    10  /*!< base 2 log thereof */
 234 #define NBUFFERS            20  /*!< number of 1K buffers */
 235 #define HDRSIZE             64  /*!< bytes of header per dbfile */
 236 /*\}*/
 237
 238 /*! \name ubik_dbase flags */
 239 #define DBWRITING           1   /*!< are any write trans. in progress */
 240 /*\}*/
 241
 242 /*!\name ubik trans flags */
 243 #define TRDONE              1   /*!< commit or abort done */
 244 #define TRABORT             2   /*!< if #TRDONE, tells if aborted */
 245 #define TRREADANY           4   /*!< read any data available in trans */
 246 #define TRCACHELOCKED       32  /*!< this trans has locked dbase->cache_lock
 247                                  *   (meaning, this trans has called
 248                                  *   ubik_CheckCache at some point */
 249 #define TRREADWRITE         64  /*!< read even if there's a conflicting ubik-
 250                                  *   level write lock */
 251 /*\}*/
 252
 253 /*! \name ubik_lock flags */
 254 #define LWANT               1
 255 /*\}*/
 256
 257 /*! \name ubik system database numbers */
 258 #define LOGFILE             (-1)
 259 /*\}*/
 260
 261 /*! \name define log opcodes */
 262 #define LOGNEW              100 /*!< start transaction */
 263 #define LOGEND              101 /*!< commit (good) end transaction */
 264 #define LOGABORT            102 /*!< abort (fail) transaction */
 265 #define LOGDATA             103 /*!< data */
 266 #define LOGTRUNCATE         104 /*!< truncate operation */
 267 /*\}*/
 268
 269 /*!
 270  * \name timer constants
 271  * time constant for replication algorithms: the R time period is 20 seconds.  Both
 272  * #SMALLTIME and #BIGTIME must be larger than #RPCTIMEOUT+max(#RPCTIMEOUT, #POLLTIME),
 273  * so that timeouts do not prevent us from getting through to our servers in time.
 274  *
 275  * We use multi-R to time out multiple down hosts concurrently.
 276  * The only other restrictions:  #BIGTIME > #SMALLTIME and
 277  * #BIGTIME-#SMALLTIME > #MAXSKEW (the clock skew).
 278  */
 279 #define MAXSKEW 10
 280 #define POLLTIME 15
 281 #define RPCTIMEOUT 20
 282 #define BIGTIME 75
 283 #define SMALLTIME 60
 284 /*\}*/
 285
 286 /*!
 287  * \brief the per-server state, used by the sync site to keep track of its charges
 288  */
 289 struct ubik_server {
 290     struct ubik_server *next;   /*!< next ptr */
 291     afs_uint32 addr[UBIK_MAX_INTERFACE_ADDR];   /*!< network order, addr[0] is primary */
 292     afs_int32 lastVoteTime;     /*!< last time yes vote received */
 293     afs_int32 lastBeaconSent;   /*!< last time beacon attempted */
 294     struct ubik_version version;        /*!< version, only used during recovery */
 295     struct rx_connection *vote_rxcid;   /*!< cid to use to contact dude for votes */
 296     struct rx_connection *disk_rxcid;   /*!< cid to use to contact dude for disk reqs */
 297     char lastVote;              /*!< true if last vote was yes */
 298     char up;                    /*!< is it up? */
 299     char beaconSinceDown;       /*!< did beacon get through since last crash? */
 300     char currentDB;             /*!< is dbase up-to-date */
 301     char magic;                 /*!< the one whose vote counts twice */
 302     char isClone;               /*!< is only a clone, doesn't vote */
 303 };
 304
 305 /*! \name hold and release functions on a database */
 306 #ifdef AFS_PTHREAD_ENV
 307 # define        DBHOLD(a)       MUTEX_ENTER(&((a)->versionLock))
 308 # define        DBRELE(a)       MUTEX_EXIT(&((a)->versionLock))
 309 #else /* !AFS_PTHREAD_ENV */
 310 # define        DBHOLD(a)       ObtainWriteLock(&((a)->versionLock))
 311 # define        DBRELE(a)       ReleaseWriteLock(&((a)->versionLock))
 312 #endif /* !AFS_PTHREAD_ENV */
 313 /*\}*/
 314
 315 /* globals */
 316
 317 /*!name list of all servers in the system */
 318 extern struct ubik_server *ubik_servers;
 319 extern char amIClone;
 320 /*\}*/
 321
 322 /*! \name network port info */
 323 extern short ubik_callPortal;
 324 /*\}*/
 325
 326 /*! \name urecovery state bits for sync site */
 327 #define UBIK_RECSYNCSITE        1       /* am sync site */
 328 #define UBIK_RECFOUNDDB         2       /* found acceptable dbase from quorum */
 329 #define UBIK_RECHAVEDB          4       /* fetched best dbase */
 330 #define UBIK_RECLABELDB         8       /* relabelled dbase */
 331 #define UBIK_RECSENTDB          0x10    /* sent best db to *everyone* */
 332 #define UBIK_RECSBETTER         UBIK_RECLABELDB /* last state */
 333 /*\}*/
 334
 335 extern afs_int32 ubik_quorum;   /* min hosts in quorum */
 336 extern struct ubik_dbase *ubik_dbase;   /* the database handled by this server */
 337 extern afs_uint32 ubik_host[UBIK_MAX_INTERFACE_ADDR];   /* this host addr, in net order */
 338 extern int ubik_amSyncSite;     /* sleep on this waiting to be sync site */
 339 extern struct ubik_stats {      /* random stats */
 340     afs_int32 escapes;
 341 } ubik_stats;
 342 extern afs_int32 urecovery_state;       /* sync site recovery process state */
 343 extern struct ubik_trans *ubik_currentTrans;    /* current trans */
 344 extern afs_int32 ubik_debugFlag;        /* ubik debug flag */
 345 extern int ubikPrimaryAddrOnly; /* use only primary address */
 346
 347 /*
 348  * Lock ordering
 349  *
 350  * Any of the locks may be acquired singly; when acquiring multiple locks, they
 351  * should be acquired in the listed order:
 352  *      application cache lock  (dbase->cache_lock)
 353  *      database lock           DBHOLD/DBRELE
 354  *      beacon lock             UBIK_BEACON_LOCK/UNLOCK
 355  *      vote lock               UBIK_VOTE_LOCK/UNLOCK
 356  *      version lock            UBIK_VERSION_LOCK/UNLOCK
 357  *      server address lock     UBIK_ADDR_LOCK/UNLOCK
 358  */
 359
 360 /*!
 361  * \brief Global beacon data.  All values are protected by beacon_lock
 362  * This lock also protects some values in the ubik_server structures:
 363  *      lastVoteTime
 364  *      lastBeaconSent
 365  *      lastVote
 366  *      up
 367  *      beaconSinceDown
 368  */
 369 struct beacon_data {
 370 #ifdef AFS_PTHREAD_ENV
 371     pthread_mutex_t beacon_lock;
 372 #endif
 373     int ubik_amSyncSite;                /*!< flag telling if I'm sync site */
 374     afs_int32 syncSiteUntil;            /*!< valid only if amSyncSite */
 375 };
 376
 377 #define UBIK_BEACON_LOCK MUTEX_ENTER(&beacon_globals.beacon_lock)
 378 #define UBIK_BEACON_UNLOCK MUTEX_EXIT(&beacon_globals.beacon_lock)
 379
 380 /*!
 381  * \brief Global vote data.  All values are protected by vote_lock
 382  */
 383 struct vote_data {
 384 #ifdef AFS_PTHREAD_ENV
 385     pthread_mutex_t vote_lock;
 386 #endif
 387     struct ubik_version ubik_dbVersion; /* sync site's dbase version */
 388     struct ubik_tid ubik_dbTid;         /* sync site's tid, or 0 if none */
 389     /* Used by all sites in nominating new sync sites */
 390     afs_int32 ubik_lastYesTime;         /* time we sent the last yes vote */
 391     afs_uint32 lastYesHost;             /* host to which we sent yes vote */
 392     /* Next is time sync site began this vote: guarantees sync site until this + SMALLTIME */
 393     afs_int32 lastYesClaim;
 394     int lastYesState;                   /* did last site we voted for claim to be sync site? */
 395     /* Used to guarantee that nomination process doesn't loop */
 396     afs_int32 lowestTime;
 397     afs_uint32 lowestHost;
 398     afs_int32 syncTime;
 399     afs_int32 syncHost;
 400 };
 401
 402 #define UBIK_VOTE_LOCK MUTEX_ENTER(&vote_globals.vote_lock)
 403 #define UBIK_VOTE_UNLOCK MUTEX_EXIT(&vote_globals.vote_lock)
 404
 405 /*!
 406  * \brief Server address data.  All values are protected by addr_lock
 407  *
 408  * This lock also protects:
 409  *     ubik_server: addr[], vote_rxcid, disk_rxcid
 410  *
 411  */
 412 struct addr_data {
 413 #ifdef AFS_PTHREAD_ENV
 414     pthread_mutex_t addr_lock;
 415 #endif
 416     afs_int32 ubikSecIndex;
 417     struct rx_securityClass *ubikSecClass;
 418 };
 419
 420 #define UBIK_ADDR_LOCK MUTEX_ENTER(&addr_globals.addr_lock)
 421 #define UBIK_ADDR_UNLOCK MUTEX_EXIT(&addr_globals.addr_lock)
 422
 423 /*!
 424  * \brief The version lock protects the structure member, as well as
 425  * the database version, flags, tidCounter, writeTidCounter
 426  */
 427 struct version_data {
 428 #ifdef AFS_PTHREAD_ENV
 429     pthread_mutex_t version_lock;
 430 #endif
 431     afs_int32 ubik_epochTime;   /* time when this site started */
 432 };
 433
 434 #define UBIK_VERSION_LOCK MUTEX_ENTER(&version_globals.version_lock)
 435 #define UBIK_VERSION_UNLOCK MUTEX_EXIT(&version_globals.version_lock)
 436
 437 /* phys.c */
 438 extern int uphys_stat(struct ubik_dbase *adbase, afs_int32 afid,
 439                       struct ubik_stat *astat);
 440 extern int uphys_read(struct ubik_dbase *adbase, afs_int32 afile,
 441                       void *abuffer, afs_int32 apos,
 442                       afs_int32 alength);
 443 extern int uphys_write(struct ubik_dbase *adbase, afs_int32 afile,
 444                        void *abuffer, afs_int32 apos,
 445                        afs_int32 alength);
 446 extern int uphys_truncate(struct ubik_dbase *adbase, afs_int32 afile,
 447                           afs_int32 asize);
 448 extern int uphys_getnfiles(struct ubik_dbase *adbase);
 449 extern int uphys_getlabel(struct ubik_dbase *adbase, afs_int32 afile,
 450                           struct ubik_version *aversion);
 451 extern int uphys_setlabel(struct ubik_dbase *adbase, afs_int32 afile,
 452                           struct ubik_version *aversion);
 453 extern int uphys_sync(struct ubik_dbase *adbase, afs_int32 afile);
 454 extern void uphys_invalidate(struct ubik_dbase *adbase,
 455                              afs_int32 afid);
 456
 457 /*! \name recovery.c */
 458 extern int urecovery_ResetState(void);
 459 extern int urecovery_LostServer(struct ubik_server *server);
 460 extern int urecovery_AllBetter(struct ubik_dbase *adbase,
 461                                int areadAny);
 462 extern int urecovery_AbortAll(struct ubik_dbase *adbase);
 463 extern int urecovery_CheckTid(struct ubik_tid *atid, int abortalways);
 464 extern int urecovery_Initialize(struct ubik_dbase *adbase);
 465 extern void *urecovery_Interact(void *);
 466 extern int DoProbe(struct ubik_server *server);
 467 /*\}*/
 468
 469 /*! \name ubik.c */
 470 extern afs_int32 ContactQuorum_NoArguments(afs_int32 (*proc)
 471                                                        (struct rx_connection *,
 472                                                         ubik_tid *),
 473                                            struct ubik_trans *atrans,
 474                                            int aflags);
 475
 476 extern afs_int32 ContactQuorum_DISK_Lock(struct ubik_trans *atrans,
 477                                          int aflags,
 478                                          afs_int32 file, afs_int32 position,
 479                                          afs_int32 length, afs_int32 type);
 480
 481 extern afs_int32 ContactQuorum_DISK_Write(struct ubik_trans *atrans,
 482                                           int aflags,
 483                                           afs_int32 file, afs_int32 position,
 484                                           bulkdata *data);
 485
 486 extern afs_int32 ContactQuorum_DISK_Truncate(struct ubik_trans *atrans,
 487                                              int aflags,
 488                                              afs_int32 file, afs_int32 length);
 489
 490 extern afs_int32 ContactQuorum_DISK_WriteV(struct ubik_trans *atrans,
 491                                            int aflags,
 492                                            iovec_wrt * io_vector,
 493                                            iovec_buf *io_buffer);
 494
 495 extern afs_int32 ContactQuorum_DISK_SetVersion(struct ubik_trans *atrans,
 496                                                int aflags,
 497                                                ubik_version *OldVersion,
 498                                                ubik_version *NewVersion);
 499
 500 extern void panic(char *format, ...)
 501     AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
 502
 503 extern afs_uint32 ubikGetPrimaryInterfaceAddr(afs_uint32 addr);
 504
 505 extern int ubik_CheckAuth(struct rx_call *);
 506
 507 /*\}*/
 508
 509 /*! \name beacon.c */
 510 struct afsconf_cell;
 511 extern void ubeacon_InitSecurityClass(void);
 512 extern void ubeacon_ReinitServer(struct ubik_server *ts);
 513 extern void ubeacon_Debug(struct ubik_debug *aparm);
 514 extern int ubeacon_AmSyncSite(void);
 515 extern int ubeacon_InitServerListByInfo(afs_uint32 ame,
 516                                         struct afsconf_cell *info,
 517                                         char clones[]);
 518 extern int ubeacon_InitServerList(afs_uint32 ame, afs_uint32 aservers[]);
 519 extern void *ubeacon_Interact(void *);
 520 extern int ubeacon_updateUbikNetworkAddress(afs_uint32 ubik_host[]);
 521 extern struct beacon_data beacon_globals;
 522 extern struct addr_data addr_globals;
 523
 524 /*\}*/
 525
 526 /*! \name disk.c */
 527 extern int udisk_Init(int nBUffers);
 528 extern void udisk_Debug(struct ubik_debug *aparm);
 529 extern int udisk_Invalidate(struct ubik_dbase *adbase, afs_int32 afid);
 530 extern int udisk_read(struct ubik_trans *atrans, afs_int32 afile,
 531                       void *abuffer, afs_int32 apos, afs_int32 alen);
 532 extern int udisk_truncate(struct ubik_trans *atrans, afs_int32 afile,
 533                           afs_int32 alength);
 534 extern int udisk_write(struct ubik_trans *atrans, afs_int32 afile,
 535                        void *abuffer, afs_int32 apos, afs_int32 alen);
 536 extern int udisk_begin(struct ubik_dbase *adbase, int atype,
 537                        struct ubik_trans **atrans);
 538 extern int udisk_commit(struct ubik_trans *atrans);
 539 extern int udisk_abort(struct ubik_trans *atrans);
 540 extern int udisk_end(struct ubik_trans *atrans);
 541 /*\}*/
 542
 543 /*! \name lock.c */
 544 extern void ulock_Init(void);
 545 extern int  ulock_getLock(struct ubik_trans *atrans, int atype, int await);
 546 extern void ulock_relLock(struct ubik_trans *atrans);
 547 extern void ulock_Debug(struct ubik_debug *aparm);
 548 /*\}*/
 549
 550 /*! \name vote.c */
 551 extern int uvote_ShouldIRun(void);
 552 extern afs_int32 uvote_GetSyncSite(void);
 553 extern int uvote_Init(void);
 554 extern void ubik_vprint(const char *format, va_list ap)
 555     AFS_ATTRIBUTE_FORMAT(__printf__, 1, 0);
 556
 557 extern void ubik_print(const char *format, ...)
 558     AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
 559
 560 extern void ubik_dprint(const char *format, ...)
 561     AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
 562
 563 extern void ubik_dprint_25(const char *format, ...)
 564     AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
 565 extern struct vote_data vote_globals;
 566 extern void uvote_set_dbVersion(struct ubik_version);
 567 extern int uvote_eq_dbVersion(struct ubik_version);
 568 extern int uvote_HaveSyncAndVersion(struct ubik_version);
 569 /*\}*/
 570
 571 #endif /* UBIK_INTERNALS */
 572
 573 extern afs_int32 ubik_nBuffers;
 574
 575 /*!
 576  * \name Public function prototypes
 577  */
 578
 579 /*! \name ubik.c */
 580 struct afsconf_cell;
 581 extern int ubik_ServerInitByInfo(afs_uint32 myHost, short myPort,
 582                                  struct afsconf_cell *info, char clones[],
 583                                  const char *pathName,
 584                                  struct ubik_dbase **dbase);
 585 extern int ubik_ServerInit(afs_uint32 myHost, short myPort,
 586                            afs_uint32 serverList[],
 587                            const char *pathName, struct ubik_dbase **dbase);
 588 extern int ubik_BeginTrans(struct ubik_dbase *dbase,
 589                            afs_int32 transMode, struct ubik_trans **transPtr);
 590 extern int ubik_BeginTransReadAny(struct ubik_dbase *dbase,
 591                                   afs_int32 transMode,
 592                                   struct ubik_trans **transPtr);
 593 extern int ubik_BeginTransReadAnyWrite(struct ubik_dbase *dbase,
 594                                        afs_int32 transMode,
 595                                        struct ubik_trans **transPtr);
 596 extern int ubik_AbortTrans(struct ubik_trans *transPtr);
 597
 598 extern int ubik_EndTrans(struct ubik_trans *transPtr);
 599 extern int ubik_Read(struct ubik_trans *transPtr, void *buffer,
 600                      afs_int32 length);
 601 extern int ubik_Flush(struct ubik_trans *transPtr);
 602 extern int ubik_Write(struct ubik_trans *transPtr, void *buffer,
 603                       afs_int32 length);
 604 extern int ubik_Seek(struct ubik_trans *transPtr, afs_int32 fileid,
 605                      afs_int32 position);
 606 extern int ubik_Tell(struct ubik_trans *transPtr, afs_int32 * fileid,
 607                      afs_int32 * position);
 608 extern int ubik_Truncate(struct ubik_trans *transPtr,
 609                          afs_int32 length);
 610 extern int ubik_SetLock(struct ubik_trans *atrans, afs_int32 apos,
 611                         afs_int32 alen, int atype);
 612 extern int ubik_WaitVersion(struct ubik_dbase *adatabase,
 613                             struct ubik_version *aversion);
 614 extern int ubik_GetVersion(struct ubik_trans *atrans,
 615                            struct ubik_version *avers);
 616 extern int ubik_CheckCache(struct ubik_trans *atrans,
 617                            ubik_updatecache_func check,
 618                            void *rock);
 619 extern struct version_data version_globals;
 620 /*\}*/
 621
 622 /*! \name ubikclient.c */
 623
 624 extern int ubik_ParseClientList(int argc, char **argv, afs_uint32 * aothers);
 625 extern unsigned int afs_random(void);
 626 extern int ubik_ClientInit(struct rx_connection **serverconns,
 627                            struct ubik_client **aclient);
 628 extern afs_int32 ubik_ClientDestroy(struct ubik_client *aclient);
 629 extern struct rx_connection *ubik_RefreshConn(struct rx_connection *tc);
 630 #ifdef UBIK_LEGACY_CALLITER
 631 extern afs_int32 ubik_CallIter(int (*aproc) (), struct ubik_client *aclient,
 632                                afs_int32 aflags, int *apos, long p1, long p2,
 633                                long p3, long p4, long p5, long p6, long p7,
 634                                long p8, long p9, long p10, long p11, long p12,
 635                                long p13, long p14, long p15, long p16);
 636 extern afs_int32 ubik_Call_New(int (*aproc) (), struct ubik_client
 637                                *aclient, afs_int32 aflags, long p1, long p2,
 638                                long p3, long p4, long p5, long p6, long p7,
 639                                long p8, long p9, long p10, long p11, long p12,
 640                                long p13, long p14, long p15, long p16);
 641 #endif
 642 /*\}*/
 643
 644 /* \name ubikcmd.c */
 645 extern int ubik_ParseServerList(int argc, char **argv, afs_uint32 *ahost,
 646                                 afs_uint32 *aothers);
 647 /*\}*/
 648
 649 /* \name uinit.c */
 650
 651 struct rx_securityClass;
 652 struct afsconf_dir;
 653 extern int ugen_ClientInitCell(struct afsconf_dir *dir,
 654                                struct afsconf_cell *info,
 655                                int secFlags,
 656                                struct ubik_client **uclientp,
 657                                int maxservers, const char *serviceid,
 658                                int deadtime);
 659 extern int ugen_ClientInitServer(const char *confDir, char *cellName,
 660                                  int secFlags, struct ubik_client **uclientp,
 661                                  int maxservers, char *serviceid,
 662                                  int deadtime, afs_uint32 server,
 663                                  afs_uint32 port);
 664 extern int ugen_ClientInitFlags(const char *confDir, char *cellName,
 665                                 int secFlags, struct ubik_client **uclientp,
 666                                 int (*secproc) (struct rx_securityClass *,
 667                                                 afs_int32),
 668                                 int maxservers, char *serviceid,
 669                                 int deadtime);
 670 extern afs_int32 ugen_ClientInit(int noAuthFlag, const char *confDir,
 671                                  char *cellName, afs_int32 sauth,
 672                                  struct ubik_client **uclientp,
 673                                  int (*secproc) (struct rx_securityClass *sc,
 674                                                  afs_int32 scIndex),
 675                                  char *funcName,
 676                                  afs_int32 gen_rxkad_level,
 677                                  afs_int32 maxservers, char *serviceid,
 678                                  afs_int32 deadtime, afs_uint32 server,
 679                                  afs_uint32 port, afs_int32 usrvid);
 680
 681 #endif /* UBIK_H */