rxdef/vldb.xg

   1 /* This is -*-c-*- */
   2
   3 /*
   4  * Copyright (c) 1997 - 2002 Kungliga Tekniska Högskolan
   5  * (Royal Institute of Technology, Stockholm, Sweden).
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * 3. Neither the name of the Institute nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 /*
  37  * Interface to VLDB
  38  */
  39
  40 package VL_
  41
  42 %#include <fs_errors.h>
  43 %#include <fs.h>
  44
  45 error-function conv_to_arla_errno
  46
  47 #include "common.h"
  48
  49 /*
  50  * Structures and defines for vldb data
  51  */
  52
  53 const VLDB_MAXNAMELEN           = 65;
  54 const MAXNSERVERS               = 8;
  55 const NMAXNSERVERS              = 13;
  56 const MAX_NUMBER_OPCODES        = 30;
  57 const MAXTYPES                  = 3;
  58 const MAXSERVERID               = 30;
  59 const HASHSIZE                  = 8191;
  60 const DEFAULTBULK               = 10000;
  61
  62 typedef opaque bulk<DEFAULTBULK>;
  63
  64 #if 0
  65 typedef struct single_vldbentry *vldblist;
  66 #endif
  67
  68 /*
  69  * Used in vlentry.server[i].flags
  70  * ie for each site/server
  71  */
  72
  73 const VLSF_NEWREPSITE = 0x01;   /* ??? */
  74 const VLSF_ROVOL      = 0x02;   /* Readonly volume on this site */
  75 const VLSF_RWVOL      = 0x04;   /* Readwrite volume on this site */
  76 const VLSF_BACKVOL    = 0x08;   /* Backup volume on this site */
  77 const VLSF_UUID       = 0x10;   /* Internal flag in Transarc client */
  78 const VLSF_DONTUSE    = 0x20;   /* Not yet released volumes */
  79
  80 /*
  81  * Used in vlentry.flags
  82  * ie used for whole entry
  83  */
  84
  85 /* Internal information in the vldb */
  86 const VLFREE           = 0x1;
  87 const VLDELETED        = 0x2;
  88 const VLLOCKED         = 0x4;
  89
  90 /* Volser information/status */
  91 const VLOP_MOVE         = 0x10;
  92 const VLOP_RELEASE      = 0x20;
  93 const VLOP_BACKUP       = 0x40;
  94 const VLOP_DELETE       = 0x80;
  95 const VLOP_DUMP         = 0x100;
  96
  97 %#define VLOP_ALLOPERS ( VLOP_MOVE | VLOP_RELEASE | VLOP_BACKUP | VLOP_DELETE | VLOP_DUMP)
  98
  99 /* Location  information */
 100 const VLF_RWEXISTS    = 0x1000;
 101 const VLF_ROEXISTS    = 0x2000;
 102 const VLF_BOEXISTS    = 0x4000;
 103 const VLF_BACKEXISTS  = 0x4000;
 104 const VLF_DFSFILESET  = 0x8000;
 105
 106 /* VL error interface */
 107 const VL_IDEXIST       = 363520;
 108 const VL_IO            = 363521;
 109 const VL_NAMEEXIST     = 363522;
 110 const VL_CREATEFAIL    = 363523;
 111 const VL_NOENT         = 363524;
 112 const VL_EMPTY         = 363525;
 113 const VL_ENTDELETED    = 363526;
 114 const VL_BADNAME       = 363527;
 115 const VL_BADINDEX      = 363528;
 116 const VL_BADVOLTYPE    = 363529;
 117 const VL_BADPARTITION  = 363530;
 118 const VL_BADSERVER     = 363531;
 119 const VL_REPSFULL      = 363532;
 120 const VL_NOREPSERVER   = 363533;
 121 const VL_DUPREPSERVER  = 363534;
 122 const VL_RWNOTFOUND    = 363535;
 123 const VL_BADREFCOUNT   = 363536;
 124 const VL_SIZEEXCEEDED  = 363537;
 125 const VL_BADENTRY      = 363538;
 126 const VL_BADVOLIDBUMP  = 363539;
 127 const VL_IDALREADHASED = 363540;
 128 const VL_ENTRYLOCKED   = 363541;
 129 const VL_BADVOLOPER    = 363542;
 130 const VL_BADRELLOCKTYPE= 363543;
 131 const VL_RERELEASE     = 363544;
 132 const VL_BADSERVERFLAG = 363545;
 133 const VL_PERM          = 363546;
 134 const VL_NOMEM         = 363547;
 135 const VL_BADVERSION    = 363548;
 136 const VL_INDEXERANGE   = 363549;
 137 const VL_MULTIPADDR    = 363550;
 138 const VL_BADMASK       = 363551;
 139
 140
 141 /*
 142  * Opcodes
 143  */
 144
 145 const VLCREATEENTRY             = 501;
 146 const VLDELETEENTRY             = 502;
 147 const VLGETENTRYBYID            = 503;
 148 const VLGETENTRYBYNAME          = 504;
 149 const VLGETNEWVOLUMEID          = 505;
 150 const VLREPLACEENTRY            = 506;
 151 const VLUPDATEENTRY             = 507;
 152 const VLSETLOCK                 = 508;
 153 const VLRELEASELOCK             = 509;
 154 const VLLISTENTRY               = 510;
 155 const VLLISTATTRIBUTES          = 511;
 156 const VLLINKEDLIST              = 512;
 157 const VLGETSTATS                = 513;
 158 const VLPROBE                   = 514;
 159 const VLGETADDRS                = 515;
 160 const VLCHANGEADDR              = 516;
 161 const VLCREATEENTRYN            = 517;
 162 const VLGETENTRYBYIDN           = 518;
 163 const VLGETENTRYBYNAMEN         = 519;
 164 const VLREPLACEENTRYN           = 520;
 165 const VLLISTENTRYN              = 521;
 166 const VLLISTATTRIBUTESN         = 522;
 167 const VLLINKEDLISTN             = 523;
 168 const VLUPDATEENTRYBYNAME       = 524;
 169 const VLCREATEENTRYU            = 525;
 170 const VLGETENTRYBYIDU           = 526;
 171 const VLGETENTRYBYNAMEU         = 527;
 172 const VLREPLACEENTRYU           = 528;
 173 const VLLISTENTRYU              = 529;
 174 const VLLISTATTRIBUTESU         = 530;
 175 const VLLINKEDLISTU             = 531;
 176 const VLREGADDR                 = 532;
 177 const VLGETADDRSU               = 533;
 178 const VLLISTATTRIBUTESN2        = 534;
 179
 180 /*
 181  * ReleaseType argument for VL_ReleaseLock
 182  */
 183 const LOCKREL_TIMESTAMP = 1;
 184 const LOCKREL_OPCODE    = 2;
 185 const LOCKREL_AFSID     = 4;
 186
 187 struct vldbentry {
 188      char name[VLDB_MAXNAMELEN];
 189      long volumeType;           /* currrent unused */
 190      long nServers;
 191      long serverNumber[MAXNSERVERS];
 192      long serverPartition[MAXNSERVERS];
 193      long serverFlags[MAXNSERVERS];
 194      u_long volumeId[MAXTYPES];
 195      long cloneId;
 196      long flags;
 197 };
 198
 199 struct nvldbentry {
 200     char name[VLDB_MAXNAMELEN];
 201     long nServers;
 202     long serverNumber[NMAXNSERVERS];
 203     long serverPartition[NMAXNSERVERS];
 204     long serverFlags[NMAXNSERVERS];
 205     u_long volumeId[MAXTYPES];
 206     long cloneId;
 207     long flags;
 208     long matchindex;
 209     long spares2;
 210     long spares3;
 211     long spares4;
 212     long spares5;
 213     long spares6;
 214     long spares7;
 215     long spares8;
 216     long spares9;
 217 };
 218
 219 struct vlentry {
 220     u_long volumeId[MAXTYPES];
 221     long flags;
 222     long LockAfsId;
 223     long LockTimestamp;
 224     long cloneId;
 225     long AssociatedChain;
 226     long nextIdHash[MAXTYPES];
 227     long nextNameHash;
 228     long spares1[2];
 229     char name[VLDB_MAXNAMELEN];
 230     u_char volumeType;
 231     u_char serverNumber[MAXNSERVERS];
 232     u_char serverPartition[MAXNSERVERS];
 233     u_char serverFlags[MAXNSERVERS];
 234     u_char RefCount;
 235     char spares2[1];
 236 };
 237
 238 /* disk_vlentry is arla specific */
 239
 240 struct disk_vlentry {
 241     u_long volumeId[MAXTYPES];
 242     long flags;
 243     long cloneId;
 244     string name<>;
 245     long serverNumber<>;
 246     long serverPartition<>;
 247     long serverFlags<>;
 248 };
 249
 250 struct vital_vlheader {
 251      long vldbversion;
 252      long headersize;
 253      long freePtr;
 254      long eofPtr;
 255      long allocs;
 256      long frees;
 257      long MaxVolumeId;
 258      long totalEntries[MAXTYPES];
 259 };
 260
 261 typedef long longarray[MAXTYPES];
 262
 263 struct vlheader {
 264     struct vital_vlheader vital_header;
 265     u_long IpMappedAddr[MAXSERVERID];
 266     long VolnameHash[HASHSIZE];
 267 /*    long VolidHashRW[HASHSIZE];
 268     long VolidHashRO[HASHSIZE];
 269     long VolidHashBACK[HASHSIZE];*/
 270     longarray VolidHash[HASHSIZE];
 271 };
 272
 273
 274 const VLUPDATE_VOLUMENAME       = 0x1;
 275 const VLUPDATE_FLAGS            = 0x4;
 276 const VLUPDATE_READONLYID       = 0x8;
 277 const VLUPDATE_BACKUPID         = 0x10;
 278 const VLUPDATE_REPSITES         = 0x20;
 279 const VLUPDATE_CLONEID          = 0x80;
 280 const VLUPDATE_VOLNAMEHASH      = 0x100;
 281 const VLUPDATE_RWID             = 0x200;
 282
 283 const VLUPDATE_REPS_DELETE      = 0x100;
 284 const VLUPDATE_REPS_ADD         = 0x200;
 285 const VLUPDATE_REPS_MODSERV     = 0x400;
 286 const VLUPDATE_REPS_MODPART     = 0x800;
 287 const VLUPDATE_REPS_MODFLAG     = 0x1000;
 288
 289 struct VldbUpdateEntry {
 290      u_long Mask;
 291      char name[VLDB_MAXNAMELEN];
 292      long volumeType;
 293      long flags;
 294      u_long ReadOnlyId;
 295      u_long BackupId;
 296      long cloneid;
 297      long nModifiedRepsites;
 298      u_long RepsitesMask[MAXNSERVERS];
 299      long RepsitesTargetServer[MAXNSERVERS];
 300      long RepsitesTargetPart[MAXNSERVERS];
 301      long RepsitesNewServer[MAXNSERVERS];
 302      long RepsitesNewPart[MAXNSERVERS];
 303      long RepsitesNewFlags[MAXNSERVERS];
 304 };
 305
 306 /* bit mask for VldbListByAttributes.Mask */
 307 const   VLLIST_SERVER           = 0x1;
 308 const   VLLIST_PARTITION        = 0x2;
 309 /* 0x4 was VLLIST_VOLUMETYPE but now it seems to be depricated */
 310 const   VLLIST_VOLUMEID         = 0x8;
 311 const   VLLIST_FLAG             = 0x10;
 312
 313 struct VldbListByAttributes {
 314      u_long Mask;
 315      long server;
 316      long partition;
 317      long volumetype; /* depricated */
 318      long volumeid;
 319      long flag;
 320 };
 321
 322 struct uvldbentry {
 323      char name[VLDB_MAXNAMELEN];
 324      long nServers;
 325      afsUUID serverNumber[NMAXNSERVERS];
 326      long serverUnique[NMAXNSERVERS];
 327      long serverPartition[NMAXNSERVERS];
 328      long serverFlags[NMAXNSERVERS];
 329      u_long volumeId[MAXTYPES];
 330      long cloneId;
 331      long flags;
 332      long spares1;
 333      long spares2;
 334      long spares3;
 335      long spares4;
 336      long spares5;
 337      long spares6;
 338      long spares7;
 339      long spares8;
 340      long spares9;
 341 };
 342
 343
 344 #if 0
 345 struct single_vldbentry {
 346      vldbentry VldbEntry;
 347      vldblist next_vldb;
 348 };
 349
 350 struct vldb_list {
 351      vldblist node;
 352 };
 353 #endif
 354
 355 struct vldstats {
 356      unsigned long start_time;
 357      long requests[MAX_NUMBER_OPCODES];
 358      long aborts[MAX_NUMBER_OPCODES];
 359      long reserved[5];
 360 };
 361
 362 const VL_MAX_BULK_ADDRS         = 1024 ;
 363
 364 typedef vldbentry bulkentries<>;
 365 typedef nvldbentry nbulkentries<>;
 366 typedef uvldbentry ubulkentries<>;
 367 typedef int32_t bulkaddrs<VL_MAX_BULK_ADDRS>;
 368
 369
 370 /*
 371  * Bits for ListAddrByAttributes.Mask
 372  * Note, IPADDR/INDEX/UUID are mutually exclusive
 373  */
 374
 375 const VLADDR_IPADDR = 0x1;
 376 const VLADDR_INDEX  = 0x2;
 377 const VLADDR_UUID   = 0x4;
 378
 379 struct ListAddrByAttributes {
 380     int32_t Mask;
 381     uint32_t ipaddr;
 382     int32_t index;
 383     int32_t spare;
 384     afsUUID uuid;
 385 };
 386
 387 struct VL_Callback {
 388     uint32_t version;
 389     uint32_t expiration_time;
 390     uint32_t time;
 391     uint32_t handle;
 392 };
 393
 394 /*
 395  * Interface
 396  */
 397
 398 CreateEntry (IN vldbentry *newentry) = VLCREATEENTRY;
 399
 400 DeleteEntry (IN long Volid,
 401              IN long voltype) = VLDELETEENTRY;
 402
 403 GetEntryByID (IN long Volid,
 404               IN long voltype,
 405               OUT vldbentry *entry) = VLGETENTRYBYID;
 406
 407 GetEntryByName (IN string volumename<VLDB_MAXNAMELEN>,
 408                 OUT vldbentry *entry) = VLGETENTRYBYNAME;
 409
 410 GetNewVolumeId (IN long bumpcount,
 411                 OUT long *newvolumid) = VLGETNEWVOLUMEID;
 412
 413 ReplaceEntry (IN long Volid,
 414               IN long voltype,
 415               IN vldbentry *newentry,
 416               IN long ReleaseType) = VLREPLACEENTRY;
 417
 418 UpdateEntry (IN long Volid,
 419              IN long voltype,
 420              IN VldbUpdateEntry *UpdateEntry,
 421              IN long ReleaseType) = VLUPDATEENTRY;
 422
 423 SetLock (IN long Volid,
 424          IN long voltype,
 425          IN long voloper) = VLSETLOCK;
 426
 427 ReleaseLock (IN long volid,
 428              IN long voltype,
 429              IN long ReleaseType) = VLRELEASELOCK;
 430
 431 ListEntry (IN long previous_index,
 432            OUT long *count,
 433            OUT long *next_index,
 434            OUT vldbentry *entry) = VLLISTENTRY;
 435
 436 ListAttributes (IN VldbListByAttributes *attributes,
 437                 OUT long *nentries,
 438                 OUT bulkentries *blkentries) = VLLISTATTRIBUTES;
 439
 440 #if 0
 441 LinkedList (IN VldbListByAttributes *attributes,
 442             OUT long *nentries,
 443             OUT vldb_list *linkedentries) = 512;
 444 #endif
 445
 446 GetStats (OUT vldstats *stats,
 447           OUT vital_vlheader *vital_header) = VLGETSTATS;
 448
 449 Probe () = VLPROBE;
 450
 451 GetAddrs(IN int32_t handle,
 452          IN int32_t spare,
 453          OUT VL_Callback *spare3,
 454          OUT int32_t *nentries,
 455          OUT bulkaddrs *blkaddr) = VLGETADDRS;
 456
 457 ChangeAddrs(IN int32_t old_ip,
 458             IN int32_t new_ip) = VLCHANGEADDR;          /* obsolete */
 459
 460 CreateEntryN(IN nvldbentry *newentry) = VLCREATEENTRYN;
 461
 462 GetEntryByIDN (IN long Volid,
 463                IN long voltype,
 464                OUT nvldbentry *entry) = VLGETENTRYBYIDN;
 465
 466 GetEntryByNameN (IN string volumename<VLDB_MAXNAMELEN>,
 467                  OUT nvldbentry *entry) = VLGETENTRYBYNAMEN;
 468
 469 ReplaceEntryN (IN long Volid,
 470               IN long voltype,
 471               IN nvldbentry *newentry,
 472               IN long ReleaseType) = VLREPLACEENTRYN;
 473
 474 ListEntryN(IN afs_int32 previous_index,
 475            OUT afs_int32 *count,
 476            OUT afs_int32 *next_index,
 477            OUT nvldbentry *entry) = VLLISTENTRYN;
 478
 479 ListAttributesN (IN VldbListByAttributes *attributes,
 480                 OUT long *nentries,
 481                 OUT nbulkentries *blkentries) = VLLISTATTRIBUTESN;
 482
 483 #if 0
 484 LinkedListN() = 523;
 485 #endif
 486
 487 UpdateEntryByName (IN string volname<VLDB_MAXNAMELEN>,
 488              IN VldbUpdateEntry *UpdateEntry,
 489              IN long ReleaseType) = VLUPDATEENTRYBYNAME;
 490
 491 #ifdef not_implemented_yet
 492 CreateEntryU(IN uvldbentry *newentry) = VLCREATEENTRYU;
 493
 494 GetEntryByIDU() = VLGETENTRYBYIDU;
 495
 496 GetEntryByNameU (IN string volumename<VLDB_MAXNAMELEN>,
 497                  OUT struct uvldbentry *entry) = VLGETENTRYBYNAMEU;
 498
 499 ReplaceEntryU() = VLREPLACEENTRYU;
 500
 501 ListEntryU() = VLLISTENTRYU;
 502
 503 ListAttributesU (IN VldbListByAttributes *attributes,
 504                 OUT long *nentries,
 505                 OUT ubulkentries *blkentries) = VLLISTATTRIBUTESU;
 506
 507 LinkedListU() = VLLINKEDLISTU;
 508 #endif
 509
 510 GetAddrsU(IN ListAddrByAttributes *inaddr,
 511           OUT afsUUID *uuidp1,
 512           OUT afs_int32 *uniquifier,
 513           OUT afs_int32 *nentries,
 514           OUT bulkaddrs *blkaddrs) = VLGETADDRSU;
 515
 516
 517 RegisterAddrs(IN afsUUID *uid,
 518               IN int32_t spare,
 519               IN bulkaddrs *addrs) = VLREGADDR;
 520
 521
 522 ListAttributesN2(IN VldbListByAttributes *attributes,
 523                  IN string volumename<VLDB_MAXNAMELEN>,
 524                  IN  afs_int32 startindex,
 525                  OUT afs_int32 *nentries,
 526                  OUT nbulkentries *blkentries,
 527                  OUT afs_int32 *nextstartindex) = VLLISTATTRIBUTESN2;
 528
 529 #if 0
 530
 531 /*
 532  *
 533  */
 534
 535 const   VL_LISTATTRUUID_MAXATTR         = 64;
 536 const   VL_LISTATTRUUID_MAXATTRSIZE     = 512;
 537
 538 struct VL_ListAddrUUID {
 539     afs_int32 type;
 540     afs_int32 error;
 541     opaque data<VL_LISTATTRUUID_MAXATTRSIZE>;
 542 };
 543
 544 typedef VL_ListAddrUUID VL_ListAddrUUIDs<>;
 545
 546 const VL_UUID_data_INVALID = 1;
 547
 548 const VL_UUID_data_IPV6 = 1;
 549 struct VL_UUID_data {
 550     opaque ipv6_addr<128>;
 551     int ipv6_mtu;
 552 };
 553
 554 const VL_UUID_data_GSSAPI_name  = 2;
 555 struct VL_UUID_data_gss_name {
 556     opaque gss_name<>;
 557 };
 558
 559 /*
 560  * `uuid' is the uuid we query information the diffrent types are in
 561  * `query'.
 562  *
 563  * For each `query'-item there can be one or more items in `reply'.
 564  * The reply items have `reply<>.type' set to the same type as in the
 565  * query. The are always sorted in the same order as the `query'.
 566  *
 567  * If the `query' type isn't supported a `reply<>' is sent back with
 568  * `reply<>.error' set.
 569  *
 570  * The `reply<>.data' is filled with `reply<>.type' specific data.
 571  * XXX should we use union, I don't think so.
 572  */
 573
 574 ListAttrUUID(IN afsUUID *uuid,
 575              IN afs_int32 query<VL_LISTATTRUUID_MAXATTR>,
 576              OUT VL_ListAddrUUIDs *reply) = 10001;
 577
 578 #endif