2 * Copyright 2000, International Business Machines Corporation and others.
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
15 /* these are now appended by the error table compiler */
17 /* ubik error codes */
18 #define UMINCODE 100000 /* lowest ubik error code */
19 #define UNOQUORUM 100000 /* no quorum elected */
20 #define UNOTSYNC 100001 /* not synchronization site (should work on sync site) */
21 #define UNHOSTS 100002 /* too many hosts */
22 #define UIOERROR 100003 /* I/O error writing dbase or log */
23 #define UINTERNAL 100004 /* mysterious internal error */
24 #define USYNC 100005 /* major synchronization error */
25 #define UNOENT 100006 /* file not found when processing dbase */
26 #define UBADLOCK 100007 /* bad lock range size (must be 1) */
27 #define UBADLOG 100008 /* read error reprocessing log */
28 #define UBADHOST 100009 /* problems with host name */
29 #define UBADTYPE 100010 /* bad operation for this transaction type */
30 #define UTWOENDS 100011 /* two commits or aborts done to transaction */
31 #define UDONE 100012 /* operation done after abort (or commmit) */
32 #define UNOSERVERS 100013 /* no servers appear to be up */
33 #define UEOF 100014 /* premature EOF */
34 #define ULOGIO 100015 /* error writing log file */
35 #define UMAXCODE 100100 /* largest ubik error code */
41 #else /* defined(UKERNEL) */
43 #endif /* defined(UKERNEL) */
45 /*! \name ubik_trans types */
46 #define UBIK_READTRANS 0
47 #define UBIK_WRITETRANS 1
50 /*! \name ubik_lock types */
53 #if !defined(UBIK_PAUSE)
55 #endif /* UBIK_PAUSE */
58 /*! \name ubik client flags */
59 #define UPUBIKONLY 1 /*!< only check servers presumed functional */
60 #define UBIK_CALL_NEW 2 /*!< use the semantics of ubik_Call_New */
63 /*! \name RX services types */
64 #define VOTE_SERVICE_ID 50
65 #define DISK_SERVICE_ID 51
66 #define USER_SERVICE_ID 52 /*!< Since most applications use same port! */
69 #define UBIK_MAGIC 0x354545
71 /*! \name global ubik parameters */
72 #define MAXSERVERS 20 /*!< max number of servers */
75 /*! version comparison macro */
76 #define vcmp(a,b) ((a).epoch == (b).epoch? ((a).counter - (b).counter) : ((a).epoch - (b).epoch))
78 /*! \name ubik_client state bits */
79 #define CFLastFailed 1 /*!< last call failed to this guy (to detect down hosts) */
82 #ifdef AFS_PTHREAD_ENV
90 * \brief per-client structure for ubik
93 short initializationState; /*!< ubik client init state */
94 short states[MAXSERVERS]; /*!< state bits */
95 struct rx_connection *conns[MAXSERVERS];
97 #ifdef AFS_PTHREAD_ENV
102 #ifdef AFS_PTHREAD_ENV
103 #define LOCK_UBIK_CLIENT(client) assert(pthread_mutex_lock(&client->cm)==0)
104 #define UNLOCK_UBIK_CLIENT(client) assert(pthread_mutex_unlock(&client->cm)==0)
106 #define LOCK_UBIK_CLIENT(client)
107 #define UNLOCK_UBIK_CLIENT(client)
110 #define ubik_GetRPCConn(astr,aindex) ((aindex) >= MAXSERVERS? 0 : (astr)->conns[aindex])
111 #define ubik_GetRPCHost(astr,aindex) ((aindex) >= MAXSERVERS? 0 : (astr)->hosts[aindex])
114 * \brief ubik header file structure
117 afs_int32 magic; /*!< magic number */
118 short pad1; /*!< some 0-initd padding */
119 short size; /*!< header allocation size */
120 struct ubik_version version; /*!< the version for this file */
124 * \brief representation of a ubik transaction
127 struct ubik_dbase *dbase; /*!< corresponding database */
128 struct ubik_trans *next; /*!< in the list */
129 afs_int32 locktype; /*!< transaction lock */
130 struct ubik_trunc *activeTruncs; /*!< queued truncates */
131 struct ubik_tid tid; /*!< transaction id of this trans (if write trans.) */
132 afs_int32 minCommitTime; /*!< time before which this trans can't commit */
133 afs_int32 seekFile; /*!< seek ptr: file number */
134 afs_int32 seekPos; /*!< seek ptr: offset therein */
135 short flags; /*!< trans flag bits */
136 char type; /*!< type of trans */
137 iovec_wrt iovec_info;
138 iovec_buf iovec_data;
142 * \brief representation of a truncation operation
145 struct ubik_trunc *next;
146 afs_int32 file; /*!< file to truncate */
147 afs_int32 length; /*!< new size */
156 #include "afs/lock.h"
157 #else /* defined(UKERNEL) */
158 #include <lock.h> /* just to make sure we've got this */
159 #endif /* defined(UKERNEL) */
162 * \brief representation of a ubik database.
164 * Contains info on low-level disk access routines
165 * for use by disk transaction module.
168 char *pathName; /*!< root name for dbase */
169 struct ubik_trans *activeTrans; /*!< active transaction list */
170 struct ubik_version version; /*!< version number */
171 #ifdef AFS_PTHREAD_ENV
172 pthread_mutex_t versionLock; /*!< lock on version number */
173 #elif defined(UKERNEL)
174 struct afs_lock versionLock; /*!< lock on version number */
175 #else /* defined(UKERNEL) */
176 struct Lock versionLock; /*!< lock on version number */
177 #endif /* defined(UKERNEL) */
178 afs_int32 tidCounter; /*!< last RW or RO trans tid counter */
179 afs_int32 writeTidCounter; /*!< last write trans tid counter */
180 afs_int32 flags; /*!< flags */
181 /* physio procedures */
182 int (*read) (struct ubik_dbase * adbase, afs_int32 afile, void *abuffer,
183 afs_int32 apos, afs_int32 alength);
184 int (*write) (struct ubik_dbase * adbase, afs_int32 afile, void *abuffer,
185 afs_int32 apos, afs_int32 alength);
186 int (*truncate) (struct ubik_dbase * adbase, afs_int32 afile,
188 int (*sync) (struct ubik_dbase * adbase, afs_int32 afile);
189 int (*stat) (struct ubik_dbase * adbase, afs_int32 afid,
190 struct ubik_stat * astat);
191 void (*open) (struct ubik_dbase * adbase, afs_int32 afid);
192 int (*setlabel) (struct ubik_dbase * adbase, afs_int32 afile, struct ubik_version * aversion); /*!< set the version label */
193 int (*getlabel) (struct ubik_dbase * adbase, afs_int32 afile, struct ubik_version * aversion); /*!< retrieve the version label */
194 int (*getnfiles) (struct ubik_dbase * adbase); /*!< find out number of files */
195 short readers; /*!< number of current read transactions */
196 struct ubik_version cachedVersion; /*!< version of caller's cached data */
197 #ifdef AFS_PTHREAD_ENV
198 pthread_cond_t version_cond; /*!< condition variable to manage changes to version */
199 pthread_cond_t flags_cond; /*!< condition variable to manage changes to flags */
203 /*! \name procedures for automatically authenticating ubik connections */
204 extern int (*ubik_CRXSecurityProc) (void *, struct rx_securityClass **,
206 extern void *ubik_CRXSecurityRock;
207 extern int (*ubik_SRXSecurityProc) (void *, struct rx_securityClass **,
209 extern void *ubik_SRXSecurityRock;
210 extern int (*ubik_CheckRXSecurityProc) (void *, struct rx_call *);
211 extern void *ubik_CheckRXSecurityRock;
214 /****************INTERNALS BELOW ****************/
216 #ifdef UBIK_INTERNALS
217 /*! \name some ubik parameters */
218 #define UBIK_PAGESIZE 1024 /*!< fits in current r packet */
219 #define UBIK_LOGPAGESIZE 10 /*!< base 2 log thereof */
220 #define NBUFFERS 20 /*!< number of 1K buffers */
221 #define HDRSIZE 64 /*!< bytes of header per dbfile */
224 /*! \name ubik_dbase flags */
225 #define DBWRITING 1 /*!< are any write trans. in progress */
226 #if defined(UBIK_PAUSE)
227 #define DBVOTING 2 /*!< the beacon task is polling */
228 #endif /* UBIK_PAUSE */
231 /*!\name ubik trans flags */
232 #define TRDONE 1 /*!< commit or abort done */
233 #define TRABORT 2 /*!< if #TRDONE, tells if aborted */
234 #define TRREADANY 4 /*!< read any data available in trans */
235 #if defined(UBIK_PAUSE)
236 #define TRSETLOCK 8 /*!< SetLock is using trans */
237 #define TRSTALE 16 /*!< udisk_end during getLock */
238 #endif /* UBIK_PAUSE */
241 /*! \name ubik_lock flags */
245 /*! \name ubik system database numbers */
249 /*! \name define log opcodes */
250 #define LOGNEW 100 /*!< start transaction */
251 #define LOGEND 101 /*!< commit (good) end transaction */
252 #define LOGABORT 102 /*!< abort (fail) transaction */
253 #define LOGDATA 103 /*!< data */
254 #define LOGTRUNCATE 104 /*!< truncate operation */
258 * \name timer constants
259 * time constant for replication algorithms: the R time period is 20 seconds. Both
260 * #SMALLTIME and #BIGTIME must be larger than #RPCTIMEOUT+max(#RPCTIMEOUT, #POLLTIME),
261 * so that timeouts do not prevent us from getting through to our servers in time.
263 * We use multi-R to time out multiple down hosts concurrently.
264 * The only other restrictions: #BIGTIME > #SMALLTIME and
265 * #BIGTIME-#SMALLTIME > #MAXSKEW (the clock skew).
269 #define RPCTIMEOUT 20
275 * \brief the per-server state, used by the sync site to keep track of its charges
278 struct ubik_server *next; /*!< next ptr */
279 afs_uint32 addr[UBIK_MAX_INTERFACE_ADDR]; /*!< network order, addr[0] is primary */
280 afs_int32 lastVoteTime; /*!< last time yes vote received */
281 afs_int32 lastBeaconSent; /*!< last time beacon attempted */
282 struct ubik_version version; /*!< version, only used during recovery */
283 struct rx_connection *vote_rxcid; /*!< cid to use to contact dude for votes */
284 struct rx_connection *disk_rxcid; /*!< cid to use to contact dude for disk reqs */
285 char lastVote; /*!< true if last vote was yes */
286 char up; /*!< is it up? */
287 char beaconSinceDown; /*!< did beacon get through since last crash? */
288 char currentDB; /*!< is dbase up-to-date */
289 char magic; /*!< the one whose vote counts twice */
290 char isClone; /*!< is only a clone, doesn't vote */
293 /*! \name hold and release functions on a database */
294 #ifdef AFS_PTHREAD_ENV
295 # define DBHOLD(a) assert(pthread_mutex_lock(&((a)->versionLock)) == 0)
296 # define DBRELE(a) assert(pthread_mutex_unlock(&((a)->versionLock)) == 0)
297 #else /* !AFS_PTHREAD_ENV */
298 # define DBHOLD(a) ObtainWriteLock(&((a)->versionLock))
299 # define DBRELE(a) ReleaseWriteLock(&((a)->versionLock))
300 #endif /* !AFS_PTHREAD_ENV */
305 /*!name list of all servers in the system */
306 extern struct ubik_server *ubik_servers;
307 extern char amIClone;
310 /*! \name network port info */
311 extern short ubik_callPortal;
314 /*! \name urecovery state bits for sync site */
315 #define UBIK_RECSYNCSITE 1 /* am sync site */
316 #define UBIK_RECFOUNDDB 2 /* found acceptable dbase from quorum */
317 #define UBIK_RECHAVEDB 4 /* fetched best dbase */
318 #define UBIK_RECLABELDB 8 /* relabelled dbase */
319 #define UBIK_RECSENTDB 0x10 /* sent best db to *everyone* */
320 #define UBIK_RECSBETTER UBIK_RECLABELDB /* last state */
323 extern afs_int32 ubik_quorum; /* min hosts in quorum */
324 extern struct ubik_dbase *ubik_dbase; /* the database handled by this server */
325 extern afs_uint32 ubik_host[UBIK_MAX_INTERFACE_ADDR]; /* this host addr, in net order */
326 extern int ubik_amSyncSite; /* sleep on this waiting to be sync site */
327 extern struct ubik_stats { /* random stats */
330 extern afs_int32 ubik_epochTime; /* time when this site started */
331 extern afs_int32 urecovery_state; /* sync site recovery process state */
332 extern struct ubik_trans *ubik_currentTrans; /* current trans */
333 extern struct ubik_version ubik_dbVersion; /* sync site's dbase version */
334 extern afs_int32 ubik_debugFlag; /* ubik debug flag */
335 extern int ubikPrimaryAddrOnly; /* use only primary address */
337 /* this extern gives the sync site's db version, with epoch of 0 if none yet */
340 extern int uphys_close(register int afd);
341 extern int uphys_stat(struct ubik_dbase *adbase, afs_int32 afid,
342 struct ubik_stat *astat);
343 extern int uphys_read(register struct ubik_dbase *adbase, afs_int32 afile,
344 register void *abuffer, afs_int32 apos,
346 extern int uphys_write(register struct ubik_dbase *adbase, afs_int32 afile,
347 register void *abuffer, afs_int32 apos,
349 extern int uphys_truncate(register struct ubik_dbase *adbase, afs_int32 afile,
351 extern int uphys_getnfiles(register struct ubik_dbase *adbase);
352 extern int uphys_getlabel(register struct ubik_dbase *adbase, afs_int32 afile,
353 struct ubik_version *aversion);
354 extern int uphys_setlabel(register struct ubik_dbase *adbase, afs_int32 afile,
355 struct ubik_version *aversion);
356 extern int uphys_sync(register struct ubik_dbase *adbase, afs_int32 afile);
357 extern void uphys_invalidate(register struct ubik_dbase *adbase,
360 /*! \name recovery.c */
361 extern int urecovery_ResetState(void);
362 extern int urecovery_LostServer(void);
363 extern int urecovery_AllBetter(register struct ubik_dbase *adbase,
365 extern int urecovery_AbortAll(struct ubik_dbase *adbase);
366 extern int urecovery_CheckTid(register struct ubik_tid *atid);
367 extern int urecovery_Initialize(register struct ubik_dbase *adbase);
368 extern void *urecovery_Interact(void *);
369 extern int DoProbe(struct ubik_server *server);
373 extern afs_int32 ContactQuorum_NoArguments(afs_int32 (*proc)
374 (struct rx_connection *,
376 struct ubik_trans *atrans,
379 extern afs_int32 ContactQuorum_DISK_Lock(struct ubik_trans *atrans,
381 afs_int32 file, afs_int32 position,
382 afs_int32 length, afs_int32 type);
384 extern afs_int32 ContactQuorum_DISK_Write(struct ubik_trans *atrans,
386 afs_int32 file, afs_int32 position,
389 extern afs_int32 ContactQuorum_DISK_Truncate(struct ubik_trans *atrans,
391 afs_int32 file, afs_int32 length);
393 extern afs_int32 ContactQuorum_DISK_WriteV(struct ubik_trans *atrans,
395 iovec_wrt * io_vector,
396 iovec_buf *io_buffer);
398 extern afs_int32 ContactQuorum_DISK_SetVersion(struct ubik_trans *atrans,
400 ubik_version *OldVersion,
401 ubik_version *NewVersion);
403 extern void panic(char *format, ...)
404 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
406 extern afs_uint32 ubikGetPrimaryInterfaceAddr(afs_uint32 addr);
409 /*! \name beacon.c */
411 extern void ubeacon_Debug(struct ubik_debug *aparm);
412 extern int ubeacon_AmSyncSite(void);
413 extern int ubeacon_InitServerListByInfo(afs_int32 ame,
414 struct afsconf_cell *info,
416 extern int ubeacon_InitServerList(afs_int32 ame, afs_int32 aservers[]);
417 extern void *ubeacon_Interact(void *);
421 extern void udisk_Debug(struct ubik_debug *aparm);
422 extern int udisk_Invalidate(struct ubik_dbase *adbase, afs_int32 afid);
423 extern int udisk_read(struct ubik_trans *atrans, afs_int32 afile,
424 void *abuffer, afs_int32 apos, afs_int32 alen);
425 extern int udisk_truncate(struct ubik_trans *atrans, afs_int32 afile,
427 extern int udisk_write(struct ubik_trans *atrans, afs_int32 afile,
428 void *abuffer, afs_int32 apos, afs_int32 alen);
429 extern int udisk_begin(struct ubik_dbase *adbase, int atype,
430 struct ubik_trans **atrans);
431 extern int udisk_commit(struct ubik_trans *atrans);
432 extern int udisk_abort(struct ubik_trans *atrans);
433 extern int udisk_end(struct ubik_trans *atrans);
437 extern int ulock_getLock(struct ubik_trans *atrans, int atype, int await);
438 extern void ulock_relLock(struct ubik_trans *atrans);
439 extern void ulock_Debug(struct ubik_debug *aparm);
443 extern int uvote_ShouldIRun(void);
444 extern afs_int32 uvote_GetSyncSite(void);
445 extern int uvote_Init(void);
446 extern void ubik_vprint(const char *format, va_list ap)
447 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 0);
449 extern void ubik_print(const char *format, ...)
450 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
452 extern void ubik_dprint(const char *format, ...)
453 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
455 extern void ubik_dprint_25(const char *format, ...)
456 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
459 #endif /* UBIK_INTERNALS */
461 extern afs_int32 ubik_nBuffers;
464 * \name Public function prototypes
469 extern int ubik_ServerInitByInfo(afs_int32 myHost, short myPort,
470 struct afsconf_cell *info, char clones[],
471 const char *pathName,
472 struct ubik_dbase **dbase);
473 extern int ubik_ServerInit(afs_int32 myHost, short myPort,
474 afs_int32 serverList[],
475 const char *pathName, struct ubik_dbase **dbase);
476 extern int ubik_BeginTrans(register struct ubik_dbase *dbase,
477 afs_int32 transMode, struct ubik_trans **transPtr);
478 extern int ubik_BeginTransReadAny(register struct ubik_dbase *dbase,
480 struct ubik_trans **transPtr);
481 extern int ubik_AbortTrans(register struct ubik_trans *transPtr);
483 extern int ubik_EndTrans(register struct ubik_trans *transPtr);
484 extern int ubik_Read(register struct ubik_trans *transPtr, void *buffer,
486 extern int ubik_Flush(struct ubik_trans *transPtr);
487 extern int ubik_Write(register struct ubik_trans *transPtr, void *buffer,
489 extern int ubik_Seek(register struct ubik_trans *transPtr, afs_int32 fileid,
491 extern int ubik_Tell(register struct ubik_trans *transPtr, afs_int32 * fileid,
492 afs_int32 * position);
493 extern int ubik_Truncate(register struct ubik_trans *transPtr,
495 extern int ubik_SetLock(struct ubik_trans *atrans, afs_int32 apos,
496 afs_int32 alen, int atype);
497 extern int ubik_WaitVersion(register struct ubik_dbase *adatabase,
498 register struct ubik_version *aversion);
499 extern int ubik_GetVersion(register struct ubik_trans *atrans,
500 register struct ubik_version *avers);
501 extern int ubik_CacheUpdate(register struct ubik_trans *atrans);
504 /*! \name ubikclient.c */
506 extern int ubik_ParseClientList(int argc, char **argv, afs_int32 * aothers);
507 extern unsigned int afs_random(void);
508 extern int ubik_ClientInit(register struct rx_connection **serverconns,
509 struct ubik_client **aclient);
510 extern afs_int32 ubik_ClientDestroy(struct ubik_client *aclient);
511 extern struct rx_connection *ubik_RefreshConn(struct rx_connection *tc);
512 #ifdef UBIK_LEGACY_CALLITER
513 extern afs_int32 ubik_CallIter(int (*aproc) (), struct ubik_client *aclient,
514 afs_int32 aflags, int *apos, long p1, long p2,
515 long p3, long p4, long p5, long p6, long p7,
516 long p8, long p9, long p10, long p11, long p12,
517 long p13, long p14, long p15, long p16);
518 extern afs_int32 ubik_Call_New(int (*aproc) (), register struct ubik_client
519 *aclient, afs_int32 aflags, long p1, long p2,
520 long p3, long p4, long p5, long p6, long p7,
521 long p8, long p9, long p10, long p11, long p12,
522 long p13, long p14, long p15, long p16);
526 /* \name ubikcmd.c */
527 extern int ubik_ParseServerList(int argc, char **argv, afs_int32 *ahost,
533 struct rx_securityClass;
534 extern afs_int32 ugen_ClientInit(int noAuthFlag, const char *confDir,
535 char *cellName, afs_int32 sauth,
536 struct ubik_client **uclientp,
537 int (*secproc) (struct rx_securityClass *sc,
540 afs_int32 gen_rxkad_level,
541 afs_int32 maxservers, char *serviceid,
542 afs_int32 deadtime, afs_uint32 server,
543 afs_uint32 port, afs_int32 usrvid);