ff34d12d45454de328439cab3ed896fd564f0c59
[openafs.git] / src / vlserver / vldbint.xg
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 package VL_
11 prefix S
12 statindex 15
13
14 #include        "vl_opcodes.h"
15 %#include       <afs/vl_opcodes.h>      /* directly to other places */
16
17 %#ifdef KERNEL
18 %#define        afs_xdr_array(a,b,c,d,e,f)      afs_xdr_arrayN(a,b,c,d,e,f)
19 %#endif
20
21 /* Current limitations on parameters that affect other packages (i.e. volume) */
22 %#define VldbVersion "4"
23
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;
30 const   MAXTYPES        =       3;
31
32 /* Structure used by the VLUpdateEntry routine; multiple entries can be updated at once by setting the appropriate Mask bits. */
33 struct VldbUpdateEntry {
34         afs_uint32      Mask;
35         char    name[VL_MAXNAMELEN];
36         afs_int32       spares3;
37         afs_int32       flags;
38         afs_uint32      ReadOnlyId;
39         afs_uint32      BackupId;
40         afs_uint32      cloneId;
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];
48 };
49
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;
60
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;
67
68 /*typedef       string volumename<VL_MAXNAMELEN>;*/
69
70 const   DEFAULTBULK     =       10000;
71 typedef opaque bulk<DEFAULTBULK>;
72
73 /*  Structure used by the VLListAttributes routine */
74 struct VldbListByAttributes {
75         afs_uint32      Mask;
76         afs_int32       server;
77         afs_int32       partition;
78         afs_int32       spares3;
79         afs_uint32      volumeid;
80         afs_int32       flag;
81 };
82
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;
89
90 /* External (visible) representation of an individual vldb entry */
91 struct vldbentry   {
92         char    name[VL_MAXNAMELEN];            /* Volume name */
93         afs_int32       spares3;
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 */
101 };
102
103 struct nvldbentry   {
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;
113         afs_int32       spares2;
114         afs_int32       spares3;
115         afs_int32       spares4;
116         afs_int32       spares5;
117         afs_int32       spares6;
118         afs_int32       spares7;
119         afs_int32       spares8;
120         afs_int32       spares9;
121 };
122
123
124 struct ListAddrByAttributes {
125         afs_int32       Mask;
126         afs_uint32      ipaddr;
127         afs_int32       index;
128         afs_int32       spare1;
129         afsUUID uuid;
130 };
131 const   VLADDR_IPADDR   =       0x1;
132 const   VLADDR_INDEX    =       0x2;
133 const   VLADDR_UUID     =       0x4;
134
135 struct uvldbentry   {
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 */
146         afs_int32       spares2;
147         afs_int32       spares3;
148         afs_int32       spares4;
149         afs_int32       spares5;
150         afs_int32       spares6;
151         afs_int32       spares7;
152         afs_int32       spares8;
153         afs_int32       spares9;
154 };
155
156
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 */
167 };
168
169 /* General stats on opcode hit frequency */
170 const   MAX_NUMBER_OPCODES      = 50;
171 struct vldstats {
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 */
176 };
177
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;
184
185 /*
186  * Additional VLOP_xxxx constants cannot be added without breaking
187  * compatibility so must reuse values. New names are added for
188  * code readability.
189  */
190 %#define VLOP_ADDSITE   VLOP_DELETE
191 %#define VLOP_RESTORE   VLOP_DUMP
192
193 %#define VLOP_ALLOPERS ( VLOP_MOVE | VLOP_RELEASE | VLOP_BACKUP | VLOP_DELETE | VLOP_DUMP)
194
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 */
207
208 typedef vldbentry bulkentries<>;
209 typedef nvldbentry nbulkentries<>;
210 typedef uvldbentry ubulkentries<>;
211 typedef afs_uint32 bulkaddrs<>;
212
213 struct VLCallBack {
214     afs_uint32 CallBackVersion;
215     afs_uint32 ExpirationTime;
216     afs_uint32 CallBackType;
217     afs_uint32 Handle;
218 };
219
220 /* vldb interface calls */
221
222 /*
223  * The kernel needs to be able to use a subset of these.
224  *
225  * Rather than try to make sure the all the kernels have
226  * all the necessary xdr routines for *all* the interfaces,
227  * we arrange that only the ones necessary for the kernel
228  * get compiled in the kernel.
229  */
230
231 /*
232  * VL_Probe was renamed to VL_ProbeServer to avoid namespace collisions
233  * with DFS clients.
234  */
235
236 ProbeServer(
237 ) multi = VLPROBE;
238
239 /*
240  * VL_GetEntryByName was renamed to VL_GetEntryByNameO to avoid
241  * namespace collisions with DFS clients.
242  */
243
244 GetEntryByNameO(
245   IN string volumename<VL_MAXNAMELEN>,
246   OUT vldbentry *entry
247 ) = VLGETENTRYBYNAME;
248
249 GetEntryByNameN(
250   IN string volumename<VL_MAXNAMELEN>,
251   OUT nvldbentry *entry
252 ) = VLGETENTRYBYNAMEN;
253
254 GetEntryByNameU(
255   IN string volumename<VL_MAXNAMELEN>,
256   OUT uvldbentry *entry
257 ) = VLGETENTRYBYNAMEU;
258
259 GetAddrsU(
260   IN ListAddrByAttributes *inaddr,
261   OUT afsUUID *uuidp1,
262   OUT afs_int32 *uniquifier,
263   OUT afs_int32 *nentries,
264   OUT bulkaddrs *blkaddrs
265 ) = VLGETADDRSU;
266
267 /*
268  * The rest of the interfaces are not needed in the kernel
269  */
270
271 %#if !defined(KERNEL)
272
273 typedef struct single_vldbentry  *vldblist;
274
275 struct single_vldbentry {
276         vldbentry VldbEntry;
277         vldblist next_vldb;
278 };
279
280 struct vldb_list {
281 vldblist node;
282 };
283
284 typedef struct single_nvldbentry  *nvldblist;
285
286 struct single_nvldbentry {
287         nvldbentry VldbEntry;
288         nvldblist next_vldb;
289 };
290
291 struct nvldb_list {
292 nvldblist node;
293 };
294
295 CreateEntry(
296   IN vldbentry *newentry
297 ) = VLCREATEENTRY;
298
299 DeleteEntry(
300   IN afs_uint32 Volid,
301   afs_int32 voltype
302 ) = VLDELETEENTRY;
303
304 GetEntryByID(
305   IN afs_uint32 Volid,
306   afs_int32 voltype,
307   OUT vldbentry *entry
308 ) = VLGETENTRYBYID;
309
310 GetNewVolumeId(
311   IN afs_uint32 bumpcount,
312   OUT afs_uint32 *newvolumid
313 ) = VLGETNEWVOLUMEID;
314
315 ReplaceEntry(
316   IN afs_uint32 Volid,
317   afs_int32 voltype,
318   vldbentry *newentry,
319   afs_int32 ReleaseType
320 ) = VLREPLACEENTRY;
321
322 UpdateEntry(
323   IN afs_uint32 Volid,
324   afs_int32 voltype,
325   VldbUpdateEntry *UpdateEntry,
326   afs_int32 ReleaseType
327 ) = VLUPDATEENTRY;
328
329 SetLock(
330   IN afs_uint32 Volid,
331   afs_int32 voltype,
332   afs_int32 voloper
333 ) = VLSETLOCK;
334
335 ReleaseLock(
336   IN afs_uint32 Volid,
337   afs_int32 voltype,
338   afs_int32 ReleaseType
339 ) = VLRELEASELOCK;
340
341 ListEntry(
342   IN afs_int32 previous_index,
343   OUT afs_int32 *count,
344   afs_int32 *next_index,
345   vldbentry *entry
346 ) = VLLISTENTRY;
347
348 ListAttributes(
349   IN VldbListByAttributes *attributes,
350   OUT afs_int32 *nentries,
351   OUT bulkentries *blkentries
352 ) = VLLISTATTRIBUTES;
353
354 LinkedList(
355   IN VldbListByAttributes *attributes,
356   OUT afs_int32 *nentries,
357   OUT vldb_list *linkedentries
358 ) = VLLINKEDLIST;
359
360 GetStats(
361   OUT vldstats *stats,
362   vital_vlheader *vital_header
363 ) = VLGETSTATS;
364
365 GetAddrs(
366   IN afs_int32 Handle,
367   afs_int32 spare2,
368   OUT VLCallBack *spare3,
369   OUT afs_int32 *nentries,
370   OUT bulkaddrs *blkaddrs
371 ) = VLGETADDRS;
372
373 ChangeAddr(
374   IN afs_uint32 ip1,
375   afs_uint32 ip2
376 ) = VLCHANGEADDR;
377
378
379 CreateEntryN(
380   IN nvldbentry *newentry
381 ) = VLCREATEENTRYN;
382
383 GetEntryByIDN(
384   IN afs_uint32 Volid,
385   afs_int32 voltype,
386   OUT nvldbentry *entry
387 ) = VLGETENTRYBYIDN;
388
389 ReplaceEntryN(
390   IN afs_uint32 Volid,
391   afs_int32 voltype,
392   nvldbentry *newentry,
393   afs_int32 ReleaseType
394 ) = VLREPLACEENTRYN;
395
396 ListEntryN(
397   IN afs_int32 previous_index,
398   OUT afs_int32 *count,
399   afs_int32 *next_index,
400   nvldbentry *entry
401 ) = VLLISTENTRYN;
402
403 ListAttributesN(
404   IN VldbListByAttributes *attributes,
405   OUT afs_int32 *nentries,
406   OUT nbulkentries *blkentries
407 ) = VLLISTATTRIBUTESN;
408
409 LinkedListN(
410   IN VldbListByAttributes *attributes,
411   OUT afs_int32 *nentries,
412   OUT nvldb_list *linkedentries
413 ) = VLLINKEDLISTN;
414
415 UpdateEntryByName(
416   IN string volumename<VL_MAXNAMELEN>,
417   VldbUpdateEntry *UpdateEntry,
418   afs_int32 ReleaseType
419 ) = VLUPDATEENTRYBYNAME;
420
421 RegisterAddrs(
422   IN afsUUID *uuidp,
423   IN afs_int32 spare1,
424   IN bulkaddrs *ipaddr
425 ) = VLREGADDR;
426
427 ListAttributesN2(
428   IN VldbListByAttributes *attributes,
429   IN string volumename<VL_MAXNAMELEN>,
430   IN  afs_int32 startindex,
431   OUT afs_int32 *nentries,
432   OUT nbulkentries *blkentries,
433   OUT afs_int32 *nextstartindex
434 ) = VLLISTATTRIBUTESN2;
435
436 %#endif /* !defined(KERNEL) */