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 */
172 struct afs_lock versionLock; /*!< lock on version number */
173 #else /* defined(UKERNEL) */
174 struct Lock versionLock; /*!< lock on version number */
175 #endif /* defined(UKERNEL) */
176 afs_int32 tidCounter; /*!< last RW or RO trans tid counter */
177 afs_int32 writeTidCounter; /*!< last write trans tid counter */
178 afs_int32 flags; /*!< flags */
179 /* physio procedures */
180 int (*read) (struct ubik_dbase * adbase, afs_int32 afile, void *abuffer,
181 afs_int32 apos, afs_int32 alength);
182 int (*write) (struct ubik_dbase * adbase, afs_int32 afile, void *abuffer,
183 afs_int32 apos, afs_int32 alength);
184 int (*truncate) (struct ubik_dbase * adbase, afs_int32 afile,
186 int (*sync) (struct ubik_dbase * adbase, afs_int32 afile);
187 int (*stat) (struct ubik_dbase * adbase, afs_int32 afid,
188 struct ubik_stat * astat);
189 void (*open) (struct ubik_dbase * adbase, afs_int32 afid);
190 int (*setlabel) (struct ubik_dbase * adbase, afs_int32 afile, struct ubik_version * aversion); /*!< set the version label */
191 int (*getlabel) (struct ubik_dbase * adbase, afs_int32 afile, struct ubik_version * aversion); /*!< retrieve the version label */
192 int (*getnfiles) (struct ubik_dbase * adbase); /*!< find out number of files */
193 short readers; /*!< number of current read transactions */
194 struct ubik_version cachedVersion; /*!< version of caller's cached data */
195 #ifdef AFS_PTHREAD_ENV
196 pthread_cond_t version_cond; /*!< condition variable to manage changes to version */
197 pthread_cond_t flags_cond; /*!< condition variable to manage changes to flags */
198 pthread_mutex_t version_mutex;
199 pthread_mutex_t flags_mutex;
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 #define DBHOLD(a) ObtainWriteLock(&((a)->versionLock))
295 #define DBRELE(a) ReleaseWriteLock(&((a)->versionLock))
300 /*!name list of all servers in the system */
301 extern struct ubik_server *ubik_servers;
302 extern char amIClone;
305 /*! \name network port info */
306 extern short ubik_callPortal;
309 /*! \name urecovery state bits for sync site */
310 #define UBIK_RECSYNCSITE 1 /* am sync site */
311 #define UBIK_RECFOUNDDB 2 /* found acceptable dbase from quorum */
312 #define UBIK_RECHAVEDB 4 /* fetched best dbase */
313 #define UBIK_RECLABELDB 8 /* relabelled dbase */
314 #define UBIK_RECSENTDB 0x10 /* sent best db to *everyone* */
315 #define UBIK_RECSBETTER UBIK_RECLABELDB /* last state */
318 extern afs_int32 ubik_quorum; /* min hosts in quorum */
319 extern struct ubik_dbase *ubik_dbase; /* the database handled by this server */
320 extern afs_uint32 ubik_host[UBIK_MAX_INTERFACE_ADDR]; /* this host addr, in net order */
321 extern int ubik_amSyncSite; /* sleep on this waiting to be sync site */
322 extern struct ubik_stats { /* random stats */
325 extern afs_int32 ubik_epochTime; /* time when this site started */
326 extern afs_int32 urecovery_state; /* sync site recovery process state */
327 extern struct ubik_trans *ubik_currentTrans; /* current trans */
328 extern struct ubik_version ubik_dbVersion; /* sync site's dbase version */
329 extern afs_int32 ubik_debugFlag; /* ubik debug flag */
330 extern int ubikPrimaryAddrOnly; /* use only primary address */
332 /* this extern gives the sync site's db version, with epoch of 0 if none yet */
335 extern int uphys_close(register int afd);
336 extern int uphys_stat(struct ubik_dbase *adbase, afs_int32 afid,
337 struct ubik_stat *astat);
338 extern int uphys_read(register struct ubik_dbase *adbase, afs_int32 afile,
339 register void *abuffer, afs_int32 apos,
341 extern int uphys_write(register struct ubik_dbase *adbase, afs_int32 afile,
342 register void *abuffer, afs_int32 apos,
344 extern int uphys_truncate(register struct ubik_dbase *adbase, afs_int32 afile,
346 extern int uphys_getnfiles(register struct ubik_dbase *adbase);
347 extern int uphys_getlabel(register struct ubik_dbase *adbase, afs_int32 afile,
348 struct ubik_version *aversion);
349 extern int uphys_setlabel(register struct ubik_dbase *adbase, afs_int32 afile,
350 struct ubik_version *aversion);
351 extern int uphys_sync(register struct ubik_dbase *adbase, afs_int32 afile);
352 extern void uphys_invalidate(register struct ubik_dbase *adbase,
355 /*! \name recovery.c */
356 extern int urecovery_ResetState(void);
357 extern int urecovery_LostServer(void);
358 extern int urecovery_AllBetter(register struct ubik_dbase *adbase,
360 extern int urecovery_AbortAll(struct ubik_dbase *adbase);
361 extern int urecovery_CheckTid(register struct ubik_tid *atid);
362 extern int urecovery_Initialize(register struct ubik_dbase *adbase);
363 extern void *urecovery_Interact(void *);
364 extern int DoProbe(struct ubik_server *server);
368 extern afs_int32 ContactQuorum_NoArguments(afs_int32 (*proc)
369 (struct rx_connection *,
371 struct ubik_trans *atrans,
374 extern afs_int32 ContactQuorum_DISK_Lock(struct ubik_trans *atrans,
376 afs_int32 file, afs_int32 position,
377 afs_int32 length, afs_int32 type);
379 extern afs_int32 ContactQuorum_DISK_Write(struct ubik_trans *atrans,
381 afs_int32 file, afs_int32 position,
384 extern afs_int32 ContactQuorum_DISK_Truncate(struct ubik_trans *atrans,
386 afs_int32 file, afs_int32 length);
388 extern afs_int32 ContactQuorum_DISK_WriteV(struct ubik_trans *atrans,
390 iovec_wrt * io_vector,
391 iovec_buf *io_buffer);
393 extern afs_int32 ContactQuorum_DISK_SetVersion(struct ubik_trans *atrans,
395 ubik_version *OldVersion,
396 ubik_version *NewVersion);
398 extern void panic(char *format, ...)
399 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
401 extern afs_uint32 ubikGetPrimaryInterfaceAddr(afs_uint32 addr);
404 /*! \name beacon.c */
406 extern void ubeacon_Debug(struct ubik_debug *aparm);
407 extern int ubeacon_AmSyncSite(void);
408 extern int ubeacon_InitServerListByInfo(afs_int32 ame,
409 struct afsconf_cell *info,
411 extern int ubeacon_InitServerList(afs_int32 ame, afs_int32 aservers[]);
412 extern void *ubeacon_Interact(void *);
416 extern void udisk_Debug(struct ubik_debug *aparm);
417 extern int udisk_Invalidate(struct ubik_dbase *adbase, afs_int32 afid);
418 extern int udisk_read(struct ubik_trans *atrans, afs_int32 afile,
419 void *abuffer, afs_int32 apos, afs_int32 alen);
420 extern int udisk_truncate(struct ubik_trans *atrans, afs_int32 afile,
422 extern int udisk_write(struct ubik_trans *atrans, afs_int32 afile,
423 void *abuffer, afs_int32 apos, afs_int32 alen);
424 extern int udisk_begin(struct ubik_dbase *adbase, int atype,
425 struct ubik_trans **atrans);
426 extern int udisk_commit(struct ubik_trans *atrans);
427 extern int udisk_abort(struct ubik_trans *atrans);
428 extern int udisk_end(struct ubik_trans *atrans);
432 extern int ulock_getLock(struct ubik_trans *atrans, int atype, int await);
433 extern void ulock_relLock(struct ubik_trans *atrans);
434 extern void ulock_Debug(struct ubik_debug *aparm);
438 extern int uvote_ShouldIRun(void);
439 extern afs_int32 uvote_GetSyncSite(void);
440 extern int uvote_Init(void);
441 extern void ubik_vprint(const char *format, va_list ap)
442 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 0);
444 extern void ubik_print(const char *format, ...)
445 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
447 extern void ubik_dprint(const char *format, ...)
448 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
450 extern void ubik_dprint_25(const char *format, ...)
451 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
454 #endif /* UBIK_INTERNALS */
456 extern afs_int32 ubik_nBuffers;
459 * \name Public function prototypes
464 extern int ubik_ServerInitByInfo(afs_int32 myHost, short myPort,
465 struct afsconf_cell *info, char clones[],
466 const char *pathName,
467 struct ubik_dbase **dbase);
468 extern int ubik_ServerInit(afs_int32 myHost, short myPort,
469 afs_int32 serverList[],
470 const char *pathName, struct ubik_dbase **dbase);
471 extern int ubik_BeginTrans(register struct ubik_dbase *dbase,
472 afs_int32 transMode, struct ubik_trans **transPtr);
473 extern int ubik_BeginTransReadAny(register struct ubik_dbase *dbase,
475 struct ubik_trans **transPtr);
476 extern int ubik_AbortTrans(register struct ubik_trans *transPtr);
478 extern int ubik_EndTrans(register struct ubik_trans *transPtr);
479 extern int ubik_Read(register struct ubik_trans *transPtr, void *buffer,
481 extern int ubik_Flush(struct ubik_trans *transPtr);
482 extern int ubik_Write(register struct ubik_trans *transPtr, void *buffer,
484 extern int ubik_Seek(register struct ubik_trans *transPtr, afs_int32 fileid,
486 extern int ubik_Tell(register struct ubik_trans *transPtr, afs_int32 * fileid,
487 afs_int32 * position);
488 extern int ubik_Truncate(register struct ubik_trans *transPtr,
490 extern int ubik_SetLock(struct ubik_trans *atrans, afs_int32 apos,
491 afs_int32 alen, int atype);
492 extern int ubik_WaitVersion(register struct ubik_dbase *adatabase,
493 register struct ubik_version *aversion);
494 extern int ubik_GetVersion(register struct ubik_trans *atrans,
495 register struct ubik_version *avers);
496 extern int ubik_CacheUpdate(register struct ubik_trans *atrans);
499 /*! \name ubikclient.c */
501 extern int ubik_ParseClientList(int argc, char **argv, afs_int32 * aothers);
502 extern unsigned int afs_random(void);
503 extern int ubik_ClientInit(register struct rx_connection **serverconns,
504 struct ubik_client **aclient);
505 extern afs_int32 ubik_ClientDestroy(struct ubik_client *aclient);
506 extern struct rx_connection *ubik_RefreshConn(struct rx_connection *tc);
507 #ifdef UBIK_LEGACY_CALLITER
508 extern afs_int32 ubik_CallIter(int (*aproc) (), struct ubik_client *aclient,
509 afs_int32 aflags, int *apos, long p1, long p2,
510 long p3, long p4, long p5, long p6, long p7,
511 long p8, long p9, long p10, long p11, long p12,
512 long p13, long p14, long p15, long p16);
513 extern afs_int32 ubik_Call_New(int (*aproc) (), register struct ubik_client
514 *aclient, afs_int32 aflags, 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);
521 /* \name ubikcmd.c */
522 extern int ubik_ParseServerList(int argc, char **argv, afs_int32 *ahost,
528 struct rx_securityClass;
529 extern afs_int32 ugen_ClientInit(int noAuthFlag, const char *confDir,
530 char *cellName, afs_int32 sauth,
531 struct ubik_client **uclientp,
532 int (*secproc) (struct rx_securityClass *sc,
535 afs_int32 gen_rxkad_level,
536 afs_int32 maxservers, char *serviceid,
537 afs_int32 deadtime, afs_uint32 server,
538 afs_uint32 port, afs_int32 usrvid);