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
14 #include "vl_opcodes.h"
15 %#include <afs/vl_opcodes.h> /* directly to other places */
18 %#define afs_xdr_array(a,b,c,d,e,f) afs_xdr_arrayN(a,b,c,d,e,f)
21 /* Current limitations on parameters that affect other packages (i.e. volume) */
22 %#define VldbVersion "4"
24 const VLDBVERSION_4 = 4;
25 const VLDBVERSION = 3;
26 const OVLDBVERSION = 2;
27 const VL_MAXNAMELEN = 65;
28 const OMAXNSERVERS = 8;
29 const NMAXNSERVERS = 13;
32 /* Structure used by the VLUpdateEntry routine; multiple entries can be updated at once by setting the appropriate Mask bits. */
33 struct VldbUpdateEntry {
35 char name[VL_MAXNAMELEN];
38 afs_uint32 ReadOnlyId;
41 afs_int32 nModifiedRepsites;
42 afs_uint32 RepsitesMask[OMAXNSERVERS];
43 afs_int32 RepsitesTargetServer[OMAXNSERVERS];
44 afs_int32 RepsitesTargetPart[OMAXNSERVERS];
45 afs_int32 RepsitesNewServer[OMAXNSERVERS];
46 afs_int32 RepsitesNewPart[OMAXNSERVERS];
47 afs_int32 RepsitesNewFlags[OMAXNSERVERS];
50 /* struct VldbUpdateEntry Mask bit values */
51 const VLUPDATE_VOLUMENAME = 0x0001;
52 /*const VLUPDATE_VOLUMETYPE = 0x0002;*/
53 const VLUPDATE_FLAGS = 0x0004;
54 const VLUPDATE_READONLYID = 0x0008;
55 const VLUPDATE_BACKUPID = 0x0010;
56 const VLUPDATE_REPSITES = 0x0020;
57 const VLUPDATE_CLONEID = 0x0080;
58 const VLUPDATE_VOLNAMEHASH = 0x0100;
59 const VLUPDATE_RWID = 0x0200;
61 /* struct VldbUpdateEntry RepsitesMask[i] bit values */
62 const VLUPDATE_REPS_DELETE = 0x0100;
63 const VLUPDATE_REPS_ADD = 0x0200;
64 const VLUPDATE_REPS_MODSERV = 0x0400;
65 const VLUPDATE_REPS_MODPART = 0x0800;
66 const VLUPDATE_REPS_MODFLAG = 0x1000;
68 /*typedef string volumename<VL_MAXNAMELEN>;*/
70 const DEFAULTBULK = 10000;
71 typedef opaque bulk<DEFAULTBULK>;
73 /* Structure used by the VLListAttributes routine */
74 struct VldbListByAttributes {
83 /* struct VldbListByAttributes Mask bit values */
84 const VLLIST_SERVER = 0x1;
85 const VLLIST_PARTITION= 0x2;
86 /*const VLLIST_VOLUMETYPE= 0x4;*/
87 const VLLIST_VOLUMEID= 0x8;
88 const VLLIST_FLAG= 0x10;
90 /* External (visible) representation of an individual vldb entry */
92 char name[VL_MAXNAMELEN]; /* Volume name */
94 afs_int32 nServers; /* Number of servers that have this volume */
95 afs_int32 serverNumber[OMAXNSERVERS]; /* Server # for each server that holds volume */
96 afs_int32 serverPartition[OMAXNSERVERS]; /* Server Partition number */
97 afs_int32 serverFlags[OMAXNSERVERS]; /* Server flags */
98 afs_uint32 volumeId[MAXTYPES]; /* Corresponding volume of each type */
99 afs_uint32 cloneId; /* Used during cloning */
100 afs_int32 flags; /* General flags */
104 char name[VL_MAXNAMELEN]; /* Volume name */
105 afs_int32 nServers; /* Number of servers that have this volume */
106 afs_int32 serverNumber[NMAXNSERVERS]; /* Server # for each server that holds volume */
107 afs_int32 serverPartition[NMAXNSERVERS]; /* Server Partition number */
108 afs_int32 serverFlags[NMAXNSERVERS]; /* Server flags */
109 afs_uint32 volumeId[MAXTYPES]; /* Corresponding volume of each type */
110 afs_uint32 cloneId; /* Used during cloning */
111 afs_int32 flags; /* General flags */
112 afs_int32 matchindex;
124 struct ListAddrByAttributes {
131 const VLADDR_IPADDR = 0x1;
132 const VLADDR_INDEX = 0x2;
133 const VLADDR_UUID = 0x4;
136 char name[VL_MAXNAMELEN]; /* Volume name */
137 afs_int32 nServers; /* Number of servers that have this volume */
138 afsUUID serverNumber[NMAXNSERVERS]; /* Server # for each server that holds volume */
139 afs_int32 serverUnique[NMAXNSERVERS]; /* Server unique address */
140 afs_int32 serverPartition[NMAXNSERVERS]; /* Server Partition number */
141 afs_int32 serverFlags[NMAXNSERVERS]; /* Server flags */
142 afs_uint32 volumeId[MAXTYPES]; /* Corresponding volume of each type */
143 afs_uint32 cloneId; /* Used during cloning */
144 afs_int32 flags; /* General flags */
145 afs_int32 matchindex; /* The server index we matched */
157 /* Leading section of the vldb header (vlheader); contains frequently used globals and general statistics information */
158 struct vital_vlheader {
159 afs_int32 vldbversion; /* vldb version number--must be 1st */
160 afs_int32 headersize; /* total bytes in header */
161 afs_int32 freePtr; /* first (if any) free enry in freelist */
162 afs_int32 eofPtr; /* first free byte in file */
163 afs_int32 allocs; /* total calls to AllocBlock */
164 afs_int32 frees; /* total calls to FreeBlock */
165 afs_uint32 MaxVolumeId; /* Global volume id holder */
166 afs_int32 totalEntries[MAXTYPES]; /* Total entries by voltype in vldb */
169 /* General stats on opcode hit frequency */
170 const MAX_NUMBER_OPCODES = 50;
172 afs_uint32 start_time; /* Time statistics were last cleared */
173 afs_int32 requests[MAX_NUMBER_OPCODES]; /* requests of each type */
174 afs_int32 aborts[MAX_NUMBER_OPCODES]; /* aborts of each type */
175 afs_int32 reserved[5]; /* for future usage */
178 /* Volser information/status */
179 const VLOP_MOVE = 0x10;
180 const VLOP_RELEASE = 0x20;
181 const VLOP_BACKUP = 0x40;
182 const VLOP_DELETE = 0x80;
183 const VLOP_DUMP = 0x100;
186 * Additional VLOP_xxxx constants cannot be added without breaking
187 * compatibility so must reuse values. New names are added for
190 %#define VLOP_ADDSITE VLOP_DELETE
191 %#define VLOP_RESTORE VLOP_DUMP
193 %#define VLOP_ALLOPERS ( VLOP_MOVE | VLOP_RELEASE | VLOP_BACKUP | VLOP_DELETE | VLOP_DUMP)
195 /* defines for convenience of vl users */
196 %#define VLF_RWEXISTS 0x1000 /* flags for whole vldb entry */
197 %#define VLF_ROEXISTS 0x2000
198 %#define VLF_BACKEXISTS 0x4000
199 %#define VLF_DFSFILESET 0x8000 /* Volume is really DFS fileset */
200 %#define VLSF_NEWREPSITE 0x01 /* flags for indiv. server entry */
201 %#define VLSF_ROVOL 0x02
202 %#define VLSF_RWVOL 0x04
203 %#define VLSF_BACKVOL 0x08
204 %#define VLSF_UUID 0x10
205 %#define VLSF_DONTUSE 0x20
206 %#define VLSF_RWREPLICA 0x40 /* Volume is a RW replica */
208 typedef vldbentry bulkentries<>;
209 typedef nvldbentry nbulkentries<>;
210 typedef uvldbentry ubulkentries<>;
212 * 500 is an arbitrary implementation limit, larger than what we support storing.
213 * It lets the XDR decoder detect an attack (excessively large input) and reject
214 * it without incurring excessive resource usage.
216 typedef afs_uint32 bulkaddrs<500>;
219 afs_uint32 CallBackVersion;
220 afs_uint32 ExpirationTime;
221 afs_uint32 CallBackType;
225 /* vldb interface calls */
228 * The kernel needs to be able to use a subset of these.
230 * Rather than try to make sure the all the kernels have
231 * all the necessary xdr routines for *all* the interfaces,
232 * we arrange that only the ones necessary for the kernel
233 * get compiled in the kernel.
237 * VL_Probe was renamed to VL_ProbeServer to avoid namespace collisions
245 * VL_GetEntryByName was renamed to VL_GetEntryByNameO to avoid
246 * namespace collisions with DFS clients.
250 IN string volumename<VL_MAXNAMELEN>,
252 ) = VLGETENTRYBYNAME;
255 IN string volumename<VL_MAXNAMELEN>,
256 OUT nvldbentry *entry
257 ) = VLGETENTRYBYNAMEN;
260 IN string volumename<VL_MAXNAMELEN>,
261 OUT uvldbentry *entry
262 ) = VLGETENTRYBYNAMEU;
265 IN ListAddrByAttributes *inaddr,
267 OUT afs_int32 *uniquifier,
268 OUT afs_int32 *nentries,
269 OUT bulkaddrs *blkaddrs
273 * The rest of the interfaces are not needed in the kernel
276 %#if !defined(KERNEL)
278 typedef struct single_vldbentry *vldblist;
280 struct single_vldbentry {
289 typedef struct single_nvldbentry *nvldblist;
291 struct single_nvldbentry {
292 nvldbentry VldbEntry;
301 IN vldbentry *newentry
316 IN afs_uint32 bumpcount,
317 OUT afs_uint32 *newvolumid
318 ) = VLGETNEWVOLUMEID;
324 afs_int32 ReleaseType
330 VldbUpdateEntry *UpdateEntry,
331 afs_int32 ReleaseType
343 afs_int32 ReleaseType
347 IN afs_int32 previous_index,
348 OUT afs_int32 *count,
349 afs_int32 *next_index,
354 IN VldbListByAttributes *attributes,
355 OUT afs_int32 *nentries,
356 OUT bulkentries *blkentries
357 ) = VLLISTATTRIBUTES;
360 IN VldbListByAttributes *attributes,
361 OUT afs_int32 *nentries,
362 OUT vldb_list *linkedentries
367 vital_vlheader *vital_header
373 OUT VLCallBack *spare3,
374 OUT afs_int32 *nentries,
375 OUT bulkaddrs *blkaddrs
385 IN nvldbentry *newentry
391 OUT nvldbentry *entry
397 nvldbentry *newentry,
398 afs_int32 ReleaseType
402 IN afs_int32 previous_index,
403 OUT afs_int32 *count,
404 afs_int32 *next_index,
409 IN VldbListByAttributes *attributes,
410 OUT afs_int32 *nentries,
411 OUT nbulkentries *blkentries
412 ) = VLLISTATTRIBUTESN;
415 IN VldbListByAttributes *attributes,
416 OUT afs_int32 *nentries,
417 OUT nvldb_list *linkedentries
421 IN string volumename<VL_MAXNAMELEN>,
422 VldbUpdateEntry *UpdateEntry,
423 afs_int32 ReleaseType
424 ) = VLUPDATEENTRYBYNAME;
433 IN VldbListByAttributes *attributes,
434 IN string volumename<VL_MAXNAMELEN>,
435 IN afs_int32 startindex,
436 OUT afs_int32 *nentries,
437 OUT nbulkentries *blkentries,
438 OUT afs_int32 *nextstartindex
439 ) = VLLISTATTRIBUTESN2;
441 %#endif /* !defined(KERNEL) */