DEVEL15-death-to-longc-procs-20060804
[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       "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 const   VLDBVERSION_4   =       4;
23 const   VLDBVERSION     =       3;
24 const   OVLDBVERSION    =       2;
25 const   VL_MAXNAMELEN   =       65;
26 const   OMAXNSERVERS    =       8;
27 const   NMAXNSERVERS    =       13;
28 const   MAXTYPES        =       3;
29
30 /* Structure used by the VLUpdateEntry routine; multiple entries can be updated at once by setting the appropriate Mask bits. */
31 struct VldbUpdateEntry {
32         afs_uint32      Mask;
33         char    name[VL_MAXNAMELEN];
34         afs_int32       spares3;
35         afs_int32       flags;
36         afs_uint32      ReadOnlyId;
37         afs_uint32      BackupId;
38         afs_uint32      cloneId;
39         afs_int32       nModifiedRepsites;
40         afs_uint32      RepsitesMask[OMAXNSERVERS];
41         afs_int32       RepsitesTargetServer[OMAXNSERVERS];
42         afs_int32       RepsitesTargetPart[OMAXNSERVERS];
43         afs_int32       RepsitesNewServer[OMAXNSERVERS];
44         afs_int32       RepsitesNewPart[OMAXNSERVERS];
45         afs_int32       RepsitesNewFlags[OMAXNSERVERS];
46 };
47
48 /* struct VldbUpdateEntry Mask bit values */
49 const   VLUPDATE_VOLUMENAME     =       0x0001;
50 /*const VLUPDATE_VOLUMETYPE     =       0x0002;*/
51 const   VLUPDATE_FLAGS          =       0x0004;
52 const   VLUPDATE_READONLYID     =       0x0008;
53 const   VLUPDATE_BACKUPID               =       0x0010;
54 const   VLUPDATE_REPSITES               =       0x0020;
55 const   VLUPDATE_CLONEID                =       0x0080;
56 const   VLUPDATE_VOLNAMEHASH    =       0x0100;
57 const   VLUPDATE_RWID           =       0x0200;
58
59 /* struct VldbUpdateEntry RepsitesMask[i] bit values */
60 const   VLUPDATE_REPS_DELETE    =       0x0100;
61 const   VLUPDATE_REPS_ADD               =       0x0200;
62 const   VLUPDATE_REPS_MODSERV   =       0x0400;
63 const   VLUPDATE_REPS_MODPART   =       0x0800;
64 const   VLUPDATE_REPS_MODFLAG   =       0x1000;
65
66 const   VLSERVER_FLAG_UUID      =       0x0010;
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       spares1;                        /* 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 %#define VLOP_ALLOPERS ( VLOP_MOVE | VLOP_RELEASE | VLOP_BACKUP | VLOP_DELETE | VLOP_DUMP)
186
187 /* defines for convenience of vl users */
188 %#define        VLF_RWEXISTS        0x1000  /* flags for whole vldb entry */
189 %#define        VLF_ROEXISTS        0x2000
190 %#define        VLF_BACKEXISTS      0x4000
191 %#define        VLF_DFSFILESET      0x8000  /* Volume is really DFS fileset */
192 %#define        VLSF_NEWREPSITE     0x01    /* flags for indiv. server entry */
193 %#define        VLSF_ROVOL          0x02
194 %#define        VLSF_RWVOL          0x04
195 %#define        VLSF_BACKVOL        0x08
196 %#define        VLSF_DONTUSE        0x20    /* no conflict with VLSERVER_FLAG_UUID */
197
198 typedef vldbentry bulkentries<>;
199 typedef nvldbentry nbulkentries<>;
200 typedef uvldbentry ubulkentries<>;
201 typedef afs_uint32 bulkaddrs<>;
202
203 struct VLCallBack {
204     afs_uint32 CallBackVersion;
205     afs_uint32 ExpirationTime;
206     afs_uint32 CallBackType;
207     afs_uint32 Handle;
208 };
209
210 /* vldb interface calls */
211
212 /*
213  * The kernel needs to be able to use a subset of these.
214  *
215  * Rather than try to make sure the all the kernels have
216  * all the necessary xdr routines for *all* the interfaces,
217  * we arrange that only the ones necessary for the kernel
218  * get compiled in the kernel.
219  */
220
221 /*
222  * VL_Probe was renamed to VL_ProbeServer to avoid namespace collisions
223  * with DFS clients.
224  */
225
226 ProbeServer(
227 ) multi = VLPROBE;
228
229 /*
230  * VL_GetEntryByName was renamed to VL_GetEntryByNameO to avoid
231  * namespace collisions with DFS clients.
232  */
233
234 GetEntryByNameO(
235   IN string volumename<VL_MAXNAMELEN>,
236   OUT vldbentry *entry
237 ) = VLGETENTRYBYNAME;
238
239 GetEntryByNameN(
240   IN string volumename<VL_MAXNAMELEN>,
241   OUT nvldbentry *entry
242 ) = VLGETENTRYBYNAMEN;
243
244 GetEntryByNameU(
245   IN string volumename<VL_MAXNAMELEN>,
246   OUT uvldbentry *entry
247 ) = VLGETENTRYBYNAMEU;
248
249 GetAddrsU(
250   IN ListAddrByAttributes *inaddr,
251   OUT afsUUID *uuidp1,
252   OUT afs_int32 *uniquifier,
253   OUT afs_int32 *nentries,
254   OUT bulkaddrs *blkaddrs
255 ) = VLGETADDRSU;
256
257 /*
258  * The rest of the interfaces are not needed in the kernel
259  */
260
261 %#if !defined(KERNEL)
262
263 typedef struct single_vldbentry  *vldblist;
264
265 struct single_vldbentry {
266         vldbentry VldbEntry;
267         vldblist next_vldb;
268 };
269
270 struct vldb_list {
271 vldblist node;
272 };
273
274 typedef struct single_nvldbentry  *nvldblist;
275
276 struct single_nvldbentry {
277         nvldbentry VldbEntry;
278         nvldblist next_vldb;
279 };
280
281 struct nvldb_list {
282 nvldblist node;
283 };
284
285 CreateEntry(
286   IN vldbentry *newentry
287 ) = VLCREATEENTRY;
288
289 DeleteEntry(
290   IN afs_uint32 Volid,
291   afs_int32 voltype
292 ) = VLDELETEENTRY;
293
294 GetEntryByID(
295   IN afs_uint32 Volid,
296   afs_int32 voltype,
297   OUT vldbentry *entry
298 ) = VLGETENTRYBYID;
299
300 GetNewVolumeId(
301   IN afs_uint32 bumpcount,
302   OUT afs_uint32 *newvolumid
303 ) = VLGETNEWVOLUMEID;
304
305 ReplaceEntry(
306   IN afs_uint32 Volid,
307   afs_int32 voltype,
308   vldbentry *newentry,
309   afs_int32 ReleaseType
310 ) = VLREPLACEENTRY;
311
312 UpdateEntry(
313   IN afs_uint32 Volid,
314   afs_int32 voltype,
315   VldbUpdateEntry *UpdateEntry,
316   afs_int32 ReleaseType
317 ) = VLUPDATEENTRY;
318
319 SetLock(
320   IN afs_uint32 Volid,
321   afs_int32 voltype,
322   afs_int32 voloper
323 ) = VLSETLOCK;
324
325 ReleaseLock(
326   IN afs_uint32 Volid,
327   afs_int32 voltype,
328   afs_int32 ReleaseType
329 ) = VLRELEASELOCK;
330
331 ListEntry(
332   IN afs_int32 previous_index,
333   OUT afs_int32 *count,
334   afs_int32 *next_index,
335   vldbentry *entry
336 ) = VLLISTENTRY;
337
338 ListAttributes(
339   IN VldbListByAttributes *attributes,
340   OUT afs_int32 *nentries,
341   OUT bulkentries *blkentries
342 ) = VLLISTATTRIBUTES;
343
344 LinkedList(
345   IN VldbListByAttributes *attributes,
346   OUT afs_int32 *nentries,
347   OUT vldb_list *linkedentries
348 ) = VLLINKEDLIST;
349
350 GetStats(
351   OUT vldstats *stats,
352   vital_vlheader *vital_header
353 ) = VLGETSTATS;
354
355 GetAddrs(
356   IN afs_int32 Handle,
357   afs_int32 spare2,
358   OUT VLCallBack *spare3,
359   OUT afs_int32 *nentries,
360   OUT bulkaddrs *blkaddrs
361 ) = VLGETADDRS;
362
363 ChangeAddr(
364   IN afs_uint32 ip1,
365   afs_uint32 ip2
366 ) = VLCHANGEADDR;
367
368
369 CreateEntryN(
370   IN nvldbentry *newentry
371 ) = VLCREATEENTRYN;
372
373 GetEntryByIDN(
374   IN afs_uint32 Volid,
375   afs_int32 voltype,
376   OUT nvldbentry *entry
377 ) = VLGETENTRYBYIDN;
378
379 ReplaceEntryN(
380   IN afs_uint32 Volid,
381   afs_int32 voltype,
382   nvldbentry *newentry,
383   afs_int32 ReleaseType
384 ) = VLREPLACEENTRYN;
385
386 ListEntryN(
387   IN afs_int32 previous_index,
388   OUT afs_int32 *count,
389   afs_int32 *next_index,
390   nvldbentry *entry
391 ) = VLLISTENTRYN;
392
393 ListAttributesN(
394   IN VldbListByAttributes *attributes,
395   OUT afs_int32 *nentries,
396   OUT nbulkentries *blkentries
397 ) = VLLISTATTRIBUTESN;
398
399 LinkedListN(
400   IN VldbListByAttributes *attributes,
401   OUT afs_int32 *nentries,
402   OUT nvldb_list *linkedentries
403 ) = VLLINKEDLISTN;
404
405 UpdateEntryByName(
406   IN string volumename<VL_MAXNAMELEN>,
407   VldbUpdateEntry *UpdateEntry,
408   afs_int32 ReleaseType
409 ) = VLUPDATEENTRYBYNAME;
410
411 RegisterAddrs(
412   IN afsUUID *uuidp,
413   IN afs_int32 spare1,
414   IN bulkaddrs *ipaddr
415 ) = VLREGADDR;
416
417 ListAttributesN2(
418   IN VldbListByAttributes *attributes,
419   IN string volumename<VL_MAXNAMELEN>,
420   IN  afs_int32 startindex,
421   OUT afs_int32 *nentries,
422   OUT nbulkentries *blkentries,
423   OUT afs_int32 *nextstartindex
424 ) = VLLISTATTRIBUTESN2;
425
426 %#endif /* !defined(KERNEL) */