src/volser/volser.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 _VOLSER_
  11 #define _VOLSER_ 1
  12
  13 #ifdef AFS_PTHREAD_ENV
  14 #include <assert.h>
  15 #include <pthread.h>
  16 #endif
  17
  18 #include <afs/voldefs.h>
  19
  20 /* vflags, representing state of the volume */
  21 #define VTDeleteOnSalvage       1       /* delete on next salvage */
  22 #define VTOutOfService          2       /* never put this volume online */
  23 #define VTDeleted               4       /* deleted, don't do anything else */
  24
  25 /* iflags, representing "attach mode" for this volume at the start of this transaction */
  26 #define ITOffline       1       /* volume offline on server (returns VOFFLINE) */
  27 #define ITBusy          2       /* volume busy on server (returns VBUSY) */
  28 #define ITReadOnly      8       /* volume readonly on client, readwrite on server -DO NOT USE */
  29 #define ITCreate        0x10    /* volume does not exist correctly yet */
  30 #define ITCreateVolID   0x1000  /* create volid */
  31
  32 /* tflags, representing transaction state */
  33 #define TTDeleted       1       /* delete transaction not yet freed due  to high refCount */
  34
  35 /* other names for volumes in voldefs.h */
  36 #define volser_RW       0
  37 #define volser_RO       1
  38 #define volser_BACK     2
  39
  40 #define THOLD(tt)       ((tt)->refCount++)
  41
  42 struct volser_trans {
  43     struct volser_trans *next;  /* next ptr in active trans list */
  44     afs_int32 tid;              /* transaction id */
  45     afs_int32 time;             /* time transaction was last active (for timeouts) */
  46     afs_int32 creationTime;     /* time the transaction started */
  47     afs_int32 returnCode;       /* transaction error code */
  48     struct Volume *volume;      /* pointer to open volume */
  49     afs_int32 volid;            /* open volume's id */
  50     afs_int32 partition;        /* open volume's partition */
  51     afs_int32 dumpTransId;      /* other side's trans id during a dump */
  52     afs_int32 dumpSeq;          /* next sequence number to use during a dump */
  53     short refCount;             /* reference count on this structure */
  54     short iflags;               /* initial attach mode flags (IT*) */
  55     char vflags;                /* current volume status flags (VT*) */
  56     char tflags;                /* transaction flags (TT*) */
  57     char incremental;           /* do an incremental restore */
  58     /* the fields below are useful for debugging */
  59     char lastProcName[30];      /* name of the last procedure which used transaction */
  60     struct rx_call *rxCallPtr;  /* pointer to latest associated rx_call */
  61
  62 };
  63
  64 /* This is how often the garbage collection thread wakes up and
  65  * checks for transactions that have timed out: BKGLoop()
  66  */
  67 #define GCWAKEUP            30
  68
  69 struct volser_dest {
  70     afs_int32 destHost;
  71     afs_int32 destPort;
  72     afs_int32 destSSID;
  73 };
  74
  75 #define MAXHELPERS          10
  76 /* flags for vol helper busyFlags array.  First, VHIdle goes on when a server
  77  * becomes idle.  Next, idle flag is cleared and VHRequest goes on when
  78  * trans is queued.  Finally, VHRequest goes off (but VHIdle stays off) when
  79  * helper is done.  VHIdle goes on again when an lwp waits for work.
  80  */
  81 #define VHIdle              1   /* vol helper is waiting for a request here */
  82 #define VHRequest           2   /* a request has been queued here */
  83 extern struct volser_trans *QI_GlobalWriteTrans;
  84
  85 /* the stuff below is from errors.h in vol directory */
  86 #define VICE_SPECIAL_ERRORS     101     /* Lowest special error code */
  87
  88 #define VSALVAGE        101     /* Volume needs salvage */
  89 #define VNOVNODE        102     /* Bad vnode number quoted */
  90 #define VNOVOL          103     /* Volume not attached, doesn't exist,
  91                                  * not created or not online */
  92 #define VVOLEXISTS      104     /* Volume already exists */
  93 #define VNOSERVICE      105     /* Volume is not in service (i.e. it's
  94                                  * is out of funds, is obsolete, or somesuch) */
  95 #define VOFFLINE        106     /* Volume is off line, for the reason
  96                                  * given in the offline message */
  97 #define VONLINE         107     /* Volume is already on line */
  98 #define VDISKFULL       108     /* Partition is "full", i.e. rougly within
  99                                  * n% of full */
 100 #define VOVERQUOTA      109     /* Volume max quota exceeded */
 101 #define VBUSY           110     /* Volume temporarily unavailable; try again.
 102                                  * The volume should be available again shortly; if
 103                                  * it isn't something is wrong.  Not normally to be
 104                                  * propagated to the application level */
 105 #define VMOVED          111     /* Volume has moved to another server; do a VGetVolumeInfo
 106                                  * to THIS server to find out where */
 107
 108 #define MyPort 5003
 109 #define NameLen 80
 110 #define VLDB_MAXSERVERS 10
 111 #define VOLSERVICE_ID 4
 112 #define INVALID_BID 0
 113 #define VOLSER_MAXVOLNAME 65
 114 #define VOLSER_OLDMAXVOLNAME 32
 115
 116 /*flags used for interfacing with the  backup system */
 117 struct volDescription {         /*used for interfacing with the backup system */
 118     char volName[VOLSER_MAXVOLNAME];    /* should be VNAMESIZE as defined in volume.h */
 119     afs_uint32 volId;
 120     int volSize;
 121     afs_int32 volFlags;
 122     afs_uint32 volCloneId;
 123 };
 124
 125 struct partList {               /*used by the backup system */
 126     afs_int32 partId[VOLMAXPARTS];
 127     afs_int32 partFlags[VOLMAXPARTS];
 128 };
 129
 130 #define STDERR  stderr
 131 #define STDOUT  stdout
 132
 133 #define ISNAMEVALID(name) (strlen(name) < (VOLSER_OLDMAXVOLNAME - 9))
 134
 135 /* values for flags in struct nvldbEntry */
 136 #define RW_EXISTS 0x1000
 137 #define RO_EXISTS 0x2000
 138 #define BACK_EXISTS 0x4000
 139
 140 /* values for serverFlags in struct nvldbEntry */
 141 #define NEW_REPSITE 0x01
 142 #define ITSROVOL    0x02
 143 #define ITSRWVOL    0x04
 144 #define ITSBACKVOL  0x08
 145 #define RO_DONTUSE  0x20
 146
 147 #define VLOP_RESTORE 0x100      /*this is bogus, clashes with VLOP_DUMP */
 148 #define VLOP_ADDSITE 0x80       /*this is bogus, clashes with VLOP_DELETE */
 149 #define PARTVALID 0x01
 150 #define CLONEVALID 0x02
 151 #define CLONEZAPPED 0x04
 152 #define IDVALID 0x08
 153 #define NAMEVALID 0x10
 154 #define SIZEVALID 0x20
 155 #define ENTRYVALID 0x40
 156 #define REUSECLONEID 0x80
 157 #define VOK 0x02
 158
 159 /* Values for the UV_RestoreVolume flags parameter */
 160 /* Also used for UV_CopyVolume and UV_CloneVolume */
 161 #define RV_FULLRST      0x000001
 162 #define RV_OFFLINE      0x000002
 163 #define RV_CRDUMP       0x000010
 164 #define RV_CRKEEP       0x000020
 165 #define RV_CRNEW        0x000040
 166 #define RV_LUDUMP       0x000100
 167 #define RV_LUKEEP       0x000200
 168 #define RV_LUNEW        0x000400
 169 #define RV_RDONLY       0x010000
 170 #define RV_CPINCR       0x020000
 171 #define RV_NOVLDB       0x040000
 172 #define RV_NOCLONE      0x080000
 173 #define RV_NODEL        0x100000
 174
 175 struct ubik_client;
 176 extern afs_uint32 vsu_GetVolumeID(char *astring, struct ubik_client *acstruct, afs_int32 *errp);
 177 extern int vsu_ExtractName(char rname[], char name[]);
 178 extern afs_int32 vsu_ClientInit(int noAuthFlag, char *confDir,
 179                                 char *cellName, afs_int32 sauth,
 180                                 struct ubik_client **uclientp,
 181                                 int (*secproc)(struct rx_securityClass *, afs_int32));
 182 extern void vsu_SetCrypt(int cryptflag);
 183
 184 #endif /* _VOLSER_ */