const char paths for ubik_ServerInit
[openafs.git] / 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 /* these are now appended by the error table compiler */
16 #if 0
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 */
36
37 #endif
38
39 #if defined(UKERNEL)
40 #include "ubik_int.h"
41 #else /* defined(UKERNEL) */
42 #include <ubik_int.h>
43 #endif /* defined(UKERNEL) */
44
45 /*! \name ubik_trans types */
46 #define UBIK_READTRANS      0
47 #define UBIK_WRITETRANS     1
48 /*\}*/
49
50 /*! \name ubik_lock types */
51 #define LOCKREAD            1
52 #define LOCKWRITE           2
53 #if !defined(UBIK_PAUSE)
54 #define LOCKWAIT            3
55 #endif /* UBIK_PAUSE */
56 /*\}*/
57
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 */
61 /*\}*/
62
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! */
67 /*\}*/
68
69 #define UBIK_MAGIC      0x354545
70
71 /*! \name global ubik parameters */
72 #define MAXSERVERS          20  /*!< max number of servers */
73 /*\}*/
74
75 /*! version comparison macro */
76 #define vcmp(a,b) ((a).epoch == (b).epoch? ((a).counter - (b).counter) : ((a).epoch - (b).epoch))
77
78 /*! \name ubik_client state bits */
79 #define CFLastFailed        1   /*!< last call failed to this guy (to detect down hosts) */
80 /*\}*/
81
82 #ifdef AFS_PTHREAD_ENV
83 #include <pthread.h>
84 #include <assert.h>
85 #else
86 #include <lwp.h>
87 #endif
88
89 /*!
90  * \brief per-client structure for ubik
91  */
92 struct ubik_client {
93     short initializationState;  /*!< ubik client init state */
94     short states[MAXSERVERS];   /*!< state bits */
95     struct rx_connection *conns[MAXSERVERS];
96     afs_int32 syncSite;
97 #ifdef AFS_PTHREAD_ENV
98     pthread_mutex_t cm;
99 #endif
100 };
101
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)
105 #else
106 #define LOCK_UBIK_CLIENT(client)
107 #define UNLOCK_UBIK_CLIENT(client)
108 #endif
109
110 #define ubik_GetRPCConn(astr,aindex)    ((aindex) >= MAXSERVERS? 0 : (astr)->conns[aindex])
111 #define ubik_GetRPCHost(astr,aindex)    ((aindex) >= MAXSERVERS? 0 : (astr)->hosts[aindex])
112
113 /*!
114  * \brief ubik header file structure
115  */
116 struct ubik_hdr {
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 */
121 };
122
123 /*!
124  * \brief representation of a ubik transaction
125  */
126 struct ubik_trans {
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;
139 };
140
141 /*!
142  * \brief representation of a truncation operation
143  */
144 struct ubik_trunc {
145     struct ubik_trunc *next;
146     afs_int32 file;             /*!< file to truncate */
147     afs_int32 length;           /*!< new size */
148 };
149
150 struct ubik_stat {
151     afs_int32 size;
152     afs_int32 mtime;
153 };
154
155 #if defined(UKERNEL)
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) */
160
161 /*!
162  * \brief representation of a ubik database.
163  *
164  * Contains info on low-level disk access routines 
165  * for use by disk transaction module.
166  */
167 struct ubik_dbase {
168     char *pathName;             /*!< root name for dbase */
169     struct ubik_trans *activeTrans;     /*!< active transaction list */
170     struct ubik_version version;        /*!< version number */
171 #if defined(UKERNEL)
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,
185                      afs_int32 asize);
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;
200 #endif
201 };
202
203 /*! \name procedures for automatically authenticating ubik connections */
204 extern int (*ubik_CRXSecurityProc) (void *, struct rx_securityClass **,
205                                     afs_int32 *);
206 extern void *ubik_CRXSecurityRock;
207 extern int (*ubik_SRXSecurityProc) (void *, struct rx_securityClass **,
208                                     afs_int32 *);
209 extern void *ubik_SRXSecurityRock;
210 extern int (*ubik_CheckRXSecurityProc) (void *, struct rx_call *);
211 extern void *ubik_CheckRXSecurityRock;
212 /*\}*/
213
214 /****************INTERNALS BELOW ****************/
215
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 */
222 /*\}*/
223
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 */
229 /*\}*/
230
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 */
239 /*\}*/
240
241 /*! \name ubik_lock flags */
242 #define LWANT               1
243 /*\}*/
244
245 /*! \name ubik system database numbers */
246 #define LOGFILE             (-1)
247 /*\}*/
248
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 */
255 /*\}*/
256
257 /*!
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.
262  *
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).
266  */
267 #define MAXSKEW 10
268 #define POLLTIME 15
269 #define RPCTIMEOUT 20
270 #define BIGTIME 75
271 #define SMALLTIME 60
272 /*\}*/
273
274 /*!
275  * \brief the per-server state, used by the sync site to keep track of its charges
276  */
277 struct ubik_server {
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 */
291 };
292
293 /*! \name hold and release functions on a database */
294 #define DBHOLD(a)       ObtainWriteLock(&((a)->versionLock))
295 #define DBRELE(a)       ReleaseWriteLock(&((a)->versionLock))
296 /*\}*/
297
298 /* globals */
299
300 /*!name list of all servers in the system */
301 extern struct ubik_server *ubik_servers;
302 extern char amIClone;
303 /*\}*/
304
305 /*! \name network port info */
306 extern short ubik_callPortal;
307 /*\}*/
308
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 */
316 /*\}*/
317
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 */
323     afs_int32 escapes;
324 } ubik_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 */
331
332 /* this extern gives the sync site's db version, with epoch of 0 if none yet */
333
334 /* phys.c */
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,
340                       afs_int32 alength);
341 extern int uphys_write(register struct ubik_dbase *adbase, afs_int32 afile,
342                        register void *abuffer, afs_int32 apos,
343                        afs_int32 alength);
344 extern int uphys_truncate(register struct ubik_dbase *adbase, afs_int32 afile,
345                           afs_int32 asize);
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, 
353                              afs_int32 afid);
354
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,
359                                int areadAny);
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);
365 /*\}*/
366
367 /*! \name ubik.c */
368 extern afs_int32 ContactQuorum_NoArguments(afs_int32 (*proc)
369                                                        (struct rx_connection *, 
370                                                         ubik_tid *),
371                                            struct ubik_trans *atrans,
372                                            int aflags);
373
374 extern afs_int32 ContactQuorum_DISK_Lock(struct ubik_trans *atrans,
375                                          int aflags,
376                                          afs_int32 file, afs_int32 position, 
377                                          afs_int32 length, afs_int32 type);
378
379 extern afs_int32 ContactQuorum_DISK_Write(struct ubik_trans *atrans,
380                                           int aflags, 
381                                           afs_int32 file, afs_int32 position, 
382                                           bulkdata *data);
383
384 extern afs_int32 ContactQuorum_DISK_Truncate(struct ubik_trans *atrans,
385                                              int aflags,
386                                              afs_int32 file, afs_int32 length);
387
388 extern afs_int32 ContactQuorum_DISK_WriteV(struct ubik_trans *atrans,
389                                            int aflags,
390                                            iovec_wrt * io_vector, 
391                                            iovec_buf *io_buffer);
392
393 extern afs_int32 ContactQuorum_DISK_SetVersion(struct ubik_trans *atrans, 
394                                                int aflags,
395                                                ubik_version *OldVersion,
396                                                ubik_version *NewVersion);
397                                               
398 extern void panic(char *format, ...); 
399
400 extern afs_uint32 ubikGetPrimaryInterfaceAddr(afs_uint32 addr); 
401 /*\}*/
402
403 /*! \name beacon.c */
404 struct afsconf_cell;
405 extern void ubeacon_Debug(struct ubik_debug *aparm);
406 extern int ubeacon_AmSyncSite(void);
407 extern int ubeacon_InitServerListByInfo(afs_int32 ame, 
408                                         struct afsconf_cell *info, 
409                                         char clones[]);
410 extern int ubeacon_InitServerList(afs_int32 ame, afs_int32 aservers[]);
411 extern void *ubeacon_Interact(void *);
412 /*\}*/
413
414 /*! \name disk.c */
415 extern void udisk_Debug(struct ubik_debug *aparm);
416 extern int udisk_Invalidate(struct ubik_dbase *adbase, afs_int32 afid);
417 extern int udisk_read(struct ubik_trans *atrans, afs_int32 afile, 
418                       void *abuffer, afs_int32 apos, afs_int32 alen);
419 extern int udisk_truncate(struct ubik_trans *atrans, afs_int32 afile, 
420                           afs_int32 alength);
421 extern int udisk_write(struct ubik_trans *atrans, afs_int32 afile, 
422                        void *abuffer, afs_int32 apos, afs_int32 alen);
423 extern int udisk_begin(struct ubik_dbase *adbase, int atype, 
424                        struct ubik_trans **atrans);
425 extern int udisk_commit(struct ubik_trans *atrans);
426 extern int udisk_abort(struct ubik_trans *atrans);
427 extern int udisk_end(struct ubik_trans *atrans);
428 /*\}*/
429
430 /*! \name lock.c */
431 extern int  ulock_getLock(struct ubik_trans *atrans, int atype, int await);
432 extern void ulock_relLock(struct ubik_trans *atrans);
433 extern void ulock_Debug(struct ubik_debug *aparm);
434 /*\}*/
435
436 /*! \name vote.c */
437 extern int uvote_ShouldIRun(void);
438 extern afs_int32 uvote_GetSyncSite(void);
439 extern int uvote_Init(void);
440 extern void ubik_vprint(const char *format, va_list ap);
441 extern void ubik_print(const char *format, ...);
442 extern void ubik_dprint(const char *format, ...);
443 extern void ubik_dprint_25(const char *format, ...);
444 /*\}*/
445
446 #endif /* UBIK_INTERNALS */
447
448 extern afs_int32 ubik_nBuffers;
449
450 /*!
451  * \name Public function prototypes
452  */
453
454 /*! \name ubik.c */
455 struct afsconf_cell;
456 extern int ubik_ServerInitByInfo(afs_int32 myHost, short myPort,
457                                  struct afsconf_cell *info, char clones[],
458                                  const char *pathName,
459                                  struct ubik_dbase **dbase);
460 extern int ubik_ServerInit(afs_int32 myHost, short myPort, 
461                            afs_int32 serverList[],
462                            const char *pathName, struct ubik_dbase **dbase);
463 extern int ubik_BeginTrans(register struct ubik_dbase *dbase,
464                            afs_int32 transMode, struct ubik_trans **transPtr);
465 extern int ubik_BeginTransReadAny(register struct ubik_dbase *dbase,
466                                   afs_int32 transMode,
467                                   struct ubik_trans **transPtr);
468 extern int ubik_AbortTrans(register struct ubik_trans *transPtr);             
469
470 extern int ubik_EndTrans(register struct ubik_trans *transPtr);
471 extern int ubik_Read(register struct ubik_trans *transPtr, void *buffer,
472                      afs_int32 length);
473 extern int ubik_Flush(struct ubik_trans *transPtr);
474 extern int ubik_Write(register struct ubik_trans *transPtr, void *buffer,
475                       afs_int32 length);                        
476 extern int ubik_Seek(register struct ubik_trans *transPtr, afs_int32 fileid,
477                      afs_int32 position);
478 extern int ubik_Tell(register struct ubik_trans *transPtr, afs_int32 * fileid,
479                      afs_int32 * position);
480 extern int ubik_Truncate(register struct ubik_trans *transPtr, 
481                          afs_int32 length);
482 extern int ubik_SetLock(struct ubik_trans *atrans, afs_int32 apos, 
483                         afs_int32 alen, int atype);
484 extern int ubik_WaitVersion(register struct ubik_dbase *adatabase,
485                             register struct ubik_version *aversion);
486 extern int ubik_GetVersion(register struct ubik_trans *atrans,
487                            register struct ubik_version *avers);
488 extern int ubik_CacheUpdate(register struct ubik_trans *atrans);
489 /*\}*/
490
491 /*! \name ubikclient.c */
492
493 extern int ubik_ParseClientList(int argc, char **argv, afs_int32 * aothers);
494 extern unsigned int afs_random(void);
495 extern int ubik_ClientInit(register struct rx_connection **serverconns,
496                            struct ubik_client **aclient);
497 extern afs_int32 ubik_ClientDestroy(struct ubik_client *aclient);
498 extern struct rx_connection *ubik_RefreshConn(struct rx_connection *tc);
499 #ifdef UBIK_LEGACY_CALLITER
500 extern afs_int32 ubik_CallIter(int (*aproc) (), struct ubik_client *aclient,
501                                afs_int32 aflags, int *apos, long p1, long p2,
502                                long p3, long p4, long p5, long p6, long p7,
503                                long p8, long p9, long p10, long p11, long p12,
504                                long p13, long p14, long p15, long p16);
505 extern afs_int32 ubik_Call_New(int (*aproc) (), register struct ubik_client
506                                *aclient, afs_int32 aflags, long p1, long p2,
507                                long p3, long p4, long p5, long p6, long p7,
508                                long p8, long p9, long p10, long p11, long p12,
509                                long p13, long p14, long p15, long p16);
510 #endif
511 /*\}*/
512
513 /* \name ubikcmd.c */
514 extern int ubik_ParseServerList(int argc, char **argv, afs_int32 *ahost, 
515                                 afs_int32 *aothers);
516 /*\}*/
517
518 /* \name uinit.c */
519
520 struct rx_securityClass;
521 extern afs_int32 ugen_ClientInit(int noAuthFlag, const char *confDir,
522                                  char *cellName, afs_int32 sauth,
523                                  struct ubik_client **uclientp,
524                                  int (*secproc) (struct rx_securityClass *sc,
525                                                  afs_int32 scIndex), 
526                                  char *funcName, 
527                                  afs_int32 gen_rxkad_level, 
528                                  afs_int32 maxservers, char *serviceid, 
529                                  afs_int32 deadtime, afs_uint32 server, 
530                                  afs_uint32 port, afs_int32 usrvid);
531
532 #endif /* UBIK_H */