/cygdrive/c/src/openafs/openafs.git/repo/src/ubik/ubik.p.h

/*
 * Copyright 2000, International Business Machines Corporation and others.
 * All Rights Reserved.
 *
 * This software has been released under the terms of the IBM Public
 * License.  For details, see the LICENSE file in the top-level source
 * directory or online at http://www.openafs.org/dl/license10.html
 */

#ifndef UBIK_H
#define UBIK_H

#include <stdarg.h>

#include <ubik_int.h>

#define UBIK_READTRANS      0
#define UBIK_WRITETRANS     1
/*\}*/

#define LOCKREAD            1
#define LOCKWRITE           2
#define LOCKWAIT            3
/*\}*/

#define UPUBIKONLY          1   
#define UBIK_CALL_NEW       2   
/*\}*/

#define VOTE_SERVICE_ID     50
#define DISK_SERVICE_ID     51
#define USER_SERVICE_ID     52  
/*\}*/

#define UBIK_MAGIC      0x354545

#define MAXSERVERS          20  
/*\}*/

#define vcmp(a,b) ((a).epoch == (b).epoch? ((a).counter - (b).counter) : ((a).epoch - (b).epoch))

#define CFLastFailed        1   
/*\}*/

#ifdef AFS_PTHREAD_ENV
#include <pthread.h>
#else
#include <lwp.h>
#endif

struct ubik_client {
    short initializationState;  
    short states[MAXSERVERS];   
    struct rx_connection *conns[MAXSERVERS];
    afs_int32 syncSite;
#ifdef AFS_PTHREAD_ENV
    pthread_mutex_t cm;
#endif
};

#ifdef AFS_PTHREAD_ENV
#define LOCK_UBIK_CLIENT(client) MUTEX_ENTER(&client->cm)
#define UNLOCK_UBIK_CLIENT(client) MUTEX_EXIT(&client->cm)
#else
#define LOCK_UBIK_CLIENT(client)
#define UNLOCK_UBIK_CLIENT(client)
#endif

#define ubik_GetRPCConn(astr,aindex)    ((aindex) >= MAXSERVERS? 0 : (astr)->conns[aindex])
#define ubik_GetRPCHost(astr,aindex)    ((aindex) >= MAXSERVERS? 0 : (astr)->hosts[aindex])

struct ubik_hdr {
    afs_int32 magic;            
    short pad1;                 
    short size;                 
    struct ubik_version version;        
};

struct ubik_trans {
    struct ubik_dbase *dbase;   
    struct ubik_trans *next;    
    afs_int32 locktype;         
    struct ubik_trunc *activeTruncs;    
    struct ubik_tid tid;        
    afs_int32 minCommitTime;    
    afs_int32 seekFile;         
    afs_int32 seekPos;          
    short flags;                
    char type;                  
    iovec_wrt iovec_info;
    iovec_buf iovec_data;
};

struct ubik_trunc {
    struct ubik_trunc *next;
    afs_int32 file;             
    afs_int32 length;           
};

struct ubik_stat {
    afs_int32 size;
    afs_int32 mtime;
};

#if defined(UKERNEL)
#include "afs/lock.h"
#else /* defined(UKERNEL) */
#include <lock.h>               /* just to make sure we've got this */
#endif /* defined(UKERNEL) */

struct ubik_dbase {
    char *pathName;             
    struct ubik_trans *activeTrans;     
    struct ubik_version version;        
#ifdef AFS_PTHREAD_ENV
    pthread_mutex_t versionLock;        
#elif defined(UKERNEL)
    struct afs_lock versionLock;        
#else                           /* defined(UKERNEL) */
    struct Lock versionLock;    
#endif                          /* defined(UKERNEL) */
    afs_int32 tidCounter;       
    afs_int32 writeTidCounter;  
    afs_int32 flags;            
    /* physio procedures */
    int (*read) (struct ubik_dbase * adbase, afs_int32 afile, void *abuffer,
                 afs_int32 apos, afs_int32 alength);
    int (*write) (struct ubik_dbase * adbase, afs_int32 afile, void *abuffer,
                  afs_int32 apos, afs_int32 alength);
    int (*truncate) (struct ubik_dbase * adbase, afs_int32 afile,
                     afs_int32 asize);
    int (*sync) (struct ubik_dbase * adbase, afs_int32 afile);
    int (*stat) (struct ubik_dbase * adbase, afs_int32 afid,
                 struct ubik_stat * astat);
    void (*open) (struct ubik_dbase * adbase, afs_int32 afid);
    int (*setlabel) (struct ubik_dbase * adbase, afs_int32 afile, struct ubik_version * aversion);      
    int (*getlabel) (struct ubik_dbase * adbase, afs_int32 afile, struct ubik_version * aversion);      
    int (*getnfiles) (struct ubik_dbase * adbase);      
    short readers;              
    struct ubik_version cachedVersion;  
#ifdef UKERNEL
    struct afs_lock cache_lock;
#else
    struct Lock cache_lock; 
#endif
#ifdef AFS_PTHREAD_ENV
    pthread_cond_t version_cond;    
    pthread_cond_t flags_cond;      
#endif
};

typedef int (*ubik_updatecache_func) (struct ubik_trans *atrans, void *rock);

extern int (*ubik_CRXSecurityProc) (void *, struct rx_securityClass **,
                                    afs_int32 *);
extern void *ubik_CRXSecurityRock;
extern int (*ubik_SRXSecurityProc) (void *, struct rx_securityClass **,
                                    afs_int32 *);
extern void *ubik_SRXSecurityRock;
extern int (*ubik_CheckRXSecurityProc) (void *, struct rx_call *);
extern void *ubik_CheckRXSecurityRock;

extern void ubik_SetClientSecurityProcs(int (*scproc)(void *,
                                                      struct rx_securityClass **,
                                                      afs_int32 *),
                                        int (*checkproc) (void *),
                                        void *rock);
extern void ubik_SetServerSecurityProcs
                (void (*buildproc) (void *,
                                    struct rx_securityClass ***,
                                    afs_int32 *),
                 int (*checkproc) (void *, struct rx_call *),
                 void *rock);

/*\}*/

/*
 * For applications that make use of ubik_BeginTransReadAnyWrite, writing
 * processes must not update the application-level cache as they write,
 * or else readers can read the new cache before the data is committed to
 * the db. So, when a commit occurs, the cache must be updated right then.
 * If set, this function will be called during commits of write transactions,
 * to update the application-level cache after a write. This will be called
 * immediately after the local disk commit succeeds, and it will be called
 * with a lock held that prevents other threads from reading from the cache
 * or the db in general.
 *
 * Note that this function MUST be set in order to make use of
 * ubik_BeginTransReadAnyWrite.
 */
extern int (*ubik_SyncWriterCacheProc) (void);

/****************INTERNALS BELOW ****************/

#ifdef UBIK_INTERNALS

#define UBIK_PAGESIZE       1024        
#define UBIK_LOGPAGESIZE    10  
#define NBUFFERS            20  
#define HDRSIZE             64  
/*\}*/

#define DBWRITING           1   
/*\}*/

#define TRDONE              1   
#define TRABORT             2   
#define TRREADANY           4   
#define TRCACHELOCKED       32  
#define TRREADWRITE         64  
/*\}*/

#define LWANT               1
/*\}*/

#define LOGFILE             (-1)
/*\}*/

#define LOGNEW              100 
#define LOGEND              101 
#define LOGABORT            102 
#define LOGDATA             103 
#define LOGTRUNCATE         104 
/*\}*/

#define MAXSKEW 10
#define POLLTIME 15
#define RPCTIMEOUT 20
#define BIGTIME 75
#define SMALLTIME 60
/*\}*/

struct ubik_server {
    struct ubik_server *next;   
    afs_uint32 addr[UBIK_MAX_INTERFACE_ADDR];   
    afs_int32 lastVoteTime;     
    afs_int32 lastBeaconSent;   
    struct ubik_version version;        
    struct rx_connection *vote_rxcid;   
    struct rx_connection *disk_rxcid;   
    char lastVote;              
    char up;                    
    char beaconSinceDown;       
    char currentDB;             
    char magic;                 
    char isClone;               
};

#ifdef AFS_PTHREAD_ENV
# define        DBHOLD(a)       MUTEX_ENTER(&((a)->versionLock))
# define        DBRELE(a)       MUTEX_EXIT(&((a)->versionLock))
#else /* !AFS_PTHREAD_ENV */
# define        DBHOLD(a)       ObtainWriteLock(&((a)->versionLock))
# define        DBRELE(a)       ReleaseWriteLock(&((a)->versionLock))
#endif /* !AFS_PTHREAD_ENV */
/*\}*/

/* globals */

extern struct ubik_server *ubik_servers;
extern char amIClone;
/*\}*/

extern short ubik_callPortal;
/*\}*/

#define UBIK_RECSYNCSITE        1       /* am sync site */
#define UBIK_RECFOUNDDB         2       /* found acceptable dbase from quorum */
#define UBIK_RECHAVEDB          4       /* fetched best dbase */
#define UBIK_RECLABELDB         8       /* relabelled dbase */
#define UBIK_RECSENTDB          0x10    /* sent best db to *everyone* */
#define UBIK_RECSBETTER         UBIK_RECLABELDB /* last state */
/*\}*/

extern afs_int32 ubik_quorum;   /* min hosts in quorum */
extern struct ubik_dbase *ubik_dbase;   /* the database handled by this server */
extern afs_uint32 ubik_host[UBIK_MAX_INTERFACE_ADDR];   /* this host addr, in net order */
extern int ubik_amSyncSite;     /* sleep on this waiting to be sync site */
extern struct ubik_stats {      /* random stats */
    afs_int32 escapes;
} ubik_stats;
extern afs_int32 urecovery_state;       /* sync site recovery process state */
extern struct ubik_trans *ubik_currentTrans;    /* current trans */
extern afs_int32 ubik_debugFlag;        /* ubik debug flag */
extern int ubikPrimaryAddrOnly; /* use only primary address */

/*
 * Lock ordering
 *
 * Any of the locks may be acquired singly; when acquiring multiple locks, they
 * should be acquired in the listed order:
 *      application cache lock  (dbase->cache_lock)
 *      database lock           DBHOLD/DBRELE
 *      beacon lock             UBIK_BEACON_LOCK/UNLOCK
 *      vote lock               UBIK_VOTE_LOCK/UNLOCK
 *      version lock            UBIK_VERSION_LOCK/UNLOCK
 *      server address lock     UBIK_ADDR_LOCK/UNLOCK
 */

struct beacon_data {
#ifdef AFS_PTHREAD_ENV
    pthread_mutex_t beacon_lock;
#endif
    int ubik_amSyncSite;                
    afs_int32 syncSiteUntil;            
};

#define UBIK_BEACON_LOCK MUTEX_ENTER(&beacon_globals.beacon_lock)
#define UBIK_BEACON_UNLOCK MUTEX_EXIT(&beacon_globals.beacon_lock)

struct vote_data {
#ifdef AFS_PTHREAD_ENV
    pthread_mutex_t vote_lock;
#endif
    struct ubik_version ubik_dbVersion; /* sync site's dbase version */
    struct ubik_tid ubik_dbTid;         /* sync site's tid, or 0 if none */
    /* Used by all sites in nominating new sync sites */
    afs_int32 ubik_lastYesTime;         /* time we sent the last yes vote */
    afs_uint32 lastYesHost;             /* host to which we sent yes vote */
    /* Next is time sync site began this vote: guarantees sync site until this + SMALLTIME */
    afs_int32 lastYesClaim;
    int lastYesState;                   /* did last site we voted for claim to be sync site? */
    /* Used to guarantee that nomination process doesn't loop */
    afs_int32 lowestTime;
    afs_uint32 lowestHost;
    afs_int32 syncTime;
    afs_int32 syncHost;
};

#define UBIK_VOTE_LOCK MUTEX_ENTER(&vote_globals.vote_lock)
#define UBIK_VOTE_UNLOCK MUTEX_EXIT(&vote_globals.vote_lock)

struct addr_data {
#ifdef AFS_PTHREAD_ENV
    pthread_mutex_t addr_lock;
#endif
    afs_int32 ubikSecIndex;
    struct rx_securityClass *ubikSecClass;
};

#define UBIK_ADDR_LOCK MUTEX_ENTER(&addr_globals.addr_lock)
#define UBIK_ADDR_UNLOCK MUTEX_EXIT(&addr_globals.addr_lock)

struct version_data {
#ifdef AFS_PTHREAD_ENV
    pthread_mutex_t version_lock;
#endif
    afs_int32 ubik_epochTime;   /* time when this site started */
};

#define UBIK_VERSION_LOCK MUTEX_ENTER(&version_globals.version_lock)
#define UBIK_VERSION_UNLOCK MUTEX_EXIT(&version_globals.version_lock)

/* phys.c */
extern int uphys_stat(struct ubik_dbase *adbase, afs_int32 afid,
                      struct ubik_stat *astat);
extern int uphys_read(struct ubik_dbase *adbase, afs_int32 afile,
                      void *abuffer, afs_int32 apos,
                      afs_int32 alength);
extern int uphys_write(struct ubik_dbase *adbase, afs_int32 afile,
                       void *abuffer, afs_int32 apos,
                       afs_int32 alength);
extern int uphys_truncate(struct ubik_dbase *adbase, afs_int32 afile,
                          afs_int32 asize);
extern int uphys_getnfiles(struct ubik_dbase *adbase);
extern int uphys_getlabel(struct ubik_dbase *adbase, afs_int32 afile,
                          struct ubik_version *aversion);
extern int uphys_setlabel(struct ubik_dbase *adbase, afs_int32 afile,
                          struct ubik_version *aversion);
extern int uphys_sync(struct ubik_dbase *adbase, afs_int32 afile);
extern void uphys_invalidate(struct ubik_dbase *adbase,
                             afs_int32 afid);

extern int urecovery_ResetState(void);
extern int urecovery_LostServer(struct ubik_server *server);
extern int urecovery_AllBetter(struct ubik_dbase *adbase,
                               int areadAny);
extern int urecovery_AbortAll(struct ubik_dbase *adbase);
extern int urecovery_CheckTid(struct ubik_tid *atid, int abortalways);
extern int urecovery_Initialize(struct ubik_dbase *adbase);
extern void *urecovery_Interact(void *);
extern int DoProbe(struct ubik_server *server);
/*\}*/

extern afs_int32 ContactQuorum_NoArguments(afs_int32 (*proc)
                                                       (struct rx_connection *,
                                                        ubik_tid *),
                                           struct ubik_trans *atrans,
                                           int aflags);

extern afs_int32 ContactQuorum_DISK_Lock(struct ubik_trans *atrans,
                                         int aflags,
                                         afs_int32 file, afs_int32 position,
                                         afs_int32 length, afs_int32 type);

extern afs_int32 ContactQuorum_DISK_Write(struct ubik_trans *atrans,
                                          int aflags,
                                          afs_int32 file, afs_int32 position,
                                          bulkdata *data);

extern afs_int32 ContactQuorum_DISK_Truncate(struct ubik_trans *atrans,
                                             int aflags,
                                             afs_int32 file, afs_int32 length);

extern afs_int32 ContactQuorum_DISK_WriteV(struct ubik_trans *atrans,
                                           int aflags,
                                           iovec_wrt * io_vector,
                                           iovec_buf *io_buffer);

extern afs_int32 ContactQuorum_DISK_SetVersion(struct ubik_trans *atrans,
                                               int aflags,
                                               ubik_version *OldVersion,
                                               ubik_version *NewVersion);

extern void panic(char *format, ...)
    AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);

extern afs_uint32 ubikGetPrimaryInterfaceAddr(afs_uint32 addr);

extern int ubik_CheckAuth(struct rx_call *);

/*\}*/

struct afsconf_cell;
extern void ubeacon_InitSecurityClass(void);
extern void ubeacon_ReinitServer(struct ubik_server *ts);
extern void ubeacon_Debug(struct ubik_debug *aparm);
extern int ubeacon_AmSyncSite(void);
extern int ubeacon_InitServerListByInfo(afs_uint32 ame,
                                        struct afsconf_cell *info,
                                        char clones[]);
extern int ubeacon_InitServerList(afs_uint32 ame, afs_uint32 aservers[]);
extern void *ubeacon_Interact(void *);
extern int ubeacon_updateUbikNetworkAddress(afs_uint32 ubik_host[]);
extern struct beacon_data beacon_globals;
extern struct addr_data addr_globals;

/*\}*/

extern int udisk_Init(int nBUffers);
extern void udisk_Debug(struct ubik_debug *aparm);
extern int udisk_Invalidate(struct ubik_dbase *adbase, afs_int32 afid);
extern int udisk_read(struct ubik_trans *atrans, afs_int32 afile,
                      void *abuffer, afs_int32 apos, afs_int32 alen);
extern int udisk_truncate(struct ubik_trans *atrans, afs_int32 afile,
                          afs_int32 alength);
extern int udisk_write(struct ubik_trans *atrans, afs_int32 afile,
                       void *abuffer, afs_int32 apos, afs_int32 alen);
extern int udisk_begin(struct ubik_dbase *adbase, int atype,
                       struct ubik_trans **atrans);
extern int udisk_commit(struct ubik_trans *atrans);
extern int udisk_abort(struct ubik_trans *atrans);
extern int udisk_end(struct ubik_trans *atrans);
/*\}*/

extern void ulock_Init(void);
extern int  ulock_getLock(struct ubik_trans *atrans, int atype, int await);
extern void ulock_relLock(struct ubik_trans *atrans);
extern void ulock_Debug(struct ubik_debug *aparm);
/*\}*/

extern int uvote_ShouldIRun(void);
extern afs_int32 uvote_GetSyncSite(void);
extern int uvote_Init(void);
extern void ubik_vprint(const char *format, va_list ap)
    AFS_ATTRIBUTE_FORMAT(__printf__, 1, 0);

extern void ubik_print(const char *format, ...)
    AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);

extern void ubik_dprint(const char *format, ...)
    AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);

extern void ubik_dprint_25(const char *format, ...)
    AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
extern struct vote_data vote_globals;
extern void uvote_set_dbVersion(struct ubik_version);
extern int uvote_eq_dbVersion(struct ubik_version);
extern int uvote_HaveSyncAndVersion(struct ubik_version);
/*\}*/

#endif /* UBIK_INTERNALS */

extern afs_int32 ubik_nBuffers;

struct afsconf_cell;
extern int ubik_ServerInitByInfo(afs_uint32 myHost, short myPort,
                                 struct afsconf_cell *info, char clones[],
                                 const char *pathName,
                                 struct ubik_dbase **dbase);
extern int ubik_ServerInit(afs_uint32 myHost, short myPort,
                           afs_uint32 serverList[],
                           const char *pathName, struct ubik_dbase **dbase);
extern int ubik_BeginTrans(struct ubik_dbase *dbase,
                           afs_int32 transMode, struct ubik_trans **transPtr);
extern int ubik_BeginTransReadAny(struct ubik_dbase *dbase,
                                  afs_int32 transMode,
                                  struct ubik_trans **transPtr);
extern int ubik_BeginTransReadAnyWrite(struct ubik_dbase *dbase,
                                       afs_int32 transMode,
                                       struct ubik_trans **transPtr);
extern int ubik_AbortTrans(struct ubik_trans *transPtr);

extern int ubik_EndTrans(struct ubik_trans *transPtr);
extern int ubik_Read(struct ubik_trans *transPtr, void *buffer,
                     afs_int32 length);
extern int ubik_Flush(struct ubik_trans *transPtr);
extern int ubik_Write(struct ubik_trans *transPtr, void *buffer,
                      afs_int32 length);
extern int ubik_Seek(struct ubik_trans *transPtr, afs_int32 fileid,
                     afs_int32 position);
extern int ubik_Tell(struct ubik_trans *transPtr, afs_int32 * fileid,
                     afs_int32 * position);
extern int ubik_Truncate(struct ubik_trans *transPtr,
                         afs_int32 length);
extern int ubik_SetLock(struct ubik_trans *atrans, afs_int32 apos,
                        afs_int32 alen, int atype);
extern int ubik_WaitVersion(struct ubik_dbase *adatabase,
                            struct ubik_version *aversion);
extern int ubik_GetVersion(struct ubik_trans *atrans,
                           struct ubik_version *avers);
extern int ubik_CheckCache(struct ubik_trans *atrans,
                           ubik_updatecache_func check,
                           void *rock);
extern struct version_data version_globals;
/*\}*/

extern int ubik_ParseClientList(int argc, char **argv, afs_uint32 * aothers);
extern unsigned int afs_random(void);
extern int ubik_ClientInit(struct rx_connection **serverconns,
                           struct ubik_client **aclient);
extern afs_int32 ubik_ClientDestroy(struct ubik_client *aclient);
extern struct rx_connection *ubik_RefreshConn(struct rx_connection *tc);
#ifdef UBIK_LEGACY_CALLITER
extern afs_int32 ubik_CallIter(int (*aproc) (), struct ubik_client *aclient,
                               afs_int32 aflags, int *apos, long p1, long p2,
                               long p3, long p4, long p5, long p6, long p7,
                               long p8, long p9, long p10, long p11, long p12,
                               long p13, long p14, long p15, long p16);
extern afs_int32 ubik_Call_New(int (*aproc) (), struct ubik_client
                               *aclient, afs_int32 aflags, long p1, long p2,
                               long p3, long p4, long p5, long p6, long p7,
                               long p8, long p9, long p10, long p11, long p12,
                               long p13, long p14, long p15, long p16);
#endif
/*\}*/

/* \name ubikcmd.c */
extern int ubik_ParseServerList(int argc, char **argv, afs_uint32 *ahost,
                                afs_uint32 *aothers);
/*\}*/

/* \name uinit.c */

struct rx_securityClass;
struct afsconf_dir;
extern int ugen_ClientInitCell(struct afsconf_dir *dir,
                               struct afsconf_cell *info,
                               int secFlags,
                               struct ubik_client **uclientp,
                               int maxservers, const char *serviceid,
                               int deadtime);
extern int ugen_ClientInitServer(const char *confDir, char *cellName,
                                 int secFlags, struct ubik_client **uclientp,
                                 int maxservers, char *serviceid,
                                 int deadtime, afs_uint32 server,
                                 afs_uint32 port);
extern int ugen_ClientInitFlags(const char *confDir, char *cellName,
                                int secFlags, struct ubik_client **uclientp,
                                int (*secproc) (struct rx_securityClass *,
                                                afs_int32),
                                int maxservers, char *serviceid,
                                int deadtime);
extern afs_int32 ugen_ClientInit(int noAuthFlag, const char *confDir,
                                 char *cellName, afs_int32 sauth,
                                 struct ubik_client **uclientp,
                                 int (*secproc) (struct rx_securityClass *sc,
                                                 afs_int32 scIndex),
                                 char *funcName,
                                 afs_int32 gen_rxkad_level,
                                 afs_int32 maxservers, char *serviceid,
                                 afs_int32 deadtime, afs_uint32 server,
                                 afs_uint32 port, afs_int32 usrvid);

#endif /* UBIK_H */