src/afs/afs.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 _AFS_H_
  11 #define _AFS_H_
  12 /*
  13  * AFS system call opcodes
  14  */
  15 #ifdef KDUMP_KERNEL
  16 #include <afs/afs_args.h>
  17 #include <afs/afs_consts.h>
  18 #else
  19 #include "afs/afs_args.h"
  20 #include "afs/afs_consts.h"
  21 #endif
  22
  23 /*
  24  * afs_fsfragsize cannot be less than 1023, or some cache-tracking
  25  * calculations will be incorrect (since we track cache usage in kb).
  26  * Some filesystems have fundamental blocksizes less than 1k, and
  27  * normally we would tune afs_fsfragsize to be fragsize-1, but we must
  28  * make sure to check that afs_fsfragsize does not go below this value.
  29  */
  30 #define AFS_MIN_FRAGSIZE 1023
  31
  32 /* Upper bound on number of iovecs out uio routines will deal with. */
  33 #define AFS_MAXIOVCNT       16
  34
  35
  36 extern int afs_shuttingdown;
  37
  38 /*
  39  * Macros to uniquely identify the AFS vfs struct
  40  */
  41 #define AFS_VFSMAGIC            0x1234
  42 #if defined(AFS_SUN5_ENV) || defined(AFS_HPUX90_ENV) || defined(AFS_LINUX20_ENV)
  43 #define AFS_VFSFSID             99
  44 #else
  45 #if defined(AFS_SGI_ENV)
  46 #define AFS_VFSFSID             afs_fstype
  47 #else
  48 #define AFS_VFSFSID             AFS_MOUNT_AFS
  49 #endif
  50 #endif
  51 /* use this value for reporting total space, free space, etc.
  52  * fake a high number to satisfy programs that use the statfs call to make sure
  53  * that there's enough space in the device partition before storing something
  54  * there. keep it just under 2^31, to try and be safe about not breaking
  55  * stuff that looks at the amount of free space. */
  56 #define AFS_VFS_FAKEFREE (2147483647)
  57
  58 /* Moved from VNOPS/afs_vnop_flocks so can be used in prototypes */
  59 #if     defined(AFS_HPUX102_ENV)
  60 #define AFS_FLOCK       k_flock
  61 #else
  62 #if     defined(AFS_SUN5_ENV) || (defined(AFS_LINUX24_ENV) && !(defined(AFS_LINUX26_ENV) && defined(AFS_LINUX_64BIT_KERNEL)))
  63 #define AFS_FLOCK       flock64
  64 #else
  65 #define AFS_FLOCK       flock
  66 #endif /* AFS_SUN65_ENV */
  67 #endif /* AFS_HPUX102_ENV */
  68
  69 /* The following are various levels of afs debugging */
  70 #define AFSDEB_GENERAL          1       /* Standard debugging */
  71 #define AFSDEB_NETWORK          2       /* low level afs networking */
  72 #define AFSDEB_RX               4       /* RX debugging */
  73 #define AFSDEB_VNLAYER          8       /* interface layer to AFS (aixops, gfsops, etc) */
  74
  75 /* generic undefined vice id */
  76 #define UNDEFVID            (-1)
  77
  78 /* The basic defines for the Andrew file system
  79     better keep things powers of two so "& (foo-1)" hack works for masking bits */
  80 #define NBRS            15      /* max number of queued daemon requests */
  81 #define NUSERS          16      /* hash table size for unixuser table */
  82 #define NSERVERS        16      /* hash table size for server table */
  83 #define NVOLS           64      /* hash table size for volume table */
  84 #define NFENTRIES       256     /* hash table size for disk volume table */
  85 #define VCSIZE         1024     /* stat cache hash table size */
  86 #define DCSIZE          512     /* disk cache hash table size */
  87 #define CBRSIZE         512     /* call back returns hash table size */
  88 #define PIGGYSIZE       1350    /* max piggyback size */
  89 #define MAXVOLS         128     /* max vols we can store */
  90 #define MAXSYSNAME      128     /* max sysname (i.e. @sys) size */
  91 #define MAXNUMSYSNAMES  32      /* max that current constants allow */
  92 #define NOTOKTIMEOUT    (2*3600)        /* time after which to timeout conns sans tokens */
  93 #define NOPAG           0xffffffff
  94
  95
  96
  97 #define AFS_MAXCBRSCALL 32      /* max to return in a given call (must be <= AFSCBMAX) */
  98 #define VCACHE_FREE     5
  99 #define AFS_NRXPACKETS  80
 100 #define AFS_RXDEADTIME  50
 101 #define AFS_HARDDEADTIME        120
 102 #define AFS_IDLEDEADTIME        1200
 103 #define AFS_IDLEDEADTIME_REP    180 /* more than fs's cb dead time */
 104 #define AFS_BLKBITS     12
 105 #define AFS_BLKSIZE     (1 << AFS_BLKBITS)
 106
 107 extern afs_int32 afs_rx_deadtime;
 108 extern afs_int32 afs_rx_harddead;
 109 extern afs_int32 afs_rx_idledead;
 110 extern afs_int32 afs_rx_idledead_rep;
 111
 112 struct sysname_info {
 113     char *name;
 114     short offset;
 115     signed char index, allocked;
 116 };
 117
 118 /* flags to use with AFSOP_CACHEINIT */
 119 #define AFSCALL_INIT_MEMCACHE        0x1        /* use a memory-based cache */
 120
 121 /* below here used only for kernel procedures */
 122 #ifdef KERNEL
 123 /* Store synchrony flags - SYNC means that data should be forced to server's
 124  * disk immediately upon completion. */
 125 #define AFS_ASYNC       0
 126 #define AFS_SYNC        1
 127 #define AFS_VMSYNC_INVAL 2      /* sync and invalidate pages */
 128 #define AFS_LASTSTORE   4
 129 #define AFS_VMSYNC      8       /* sync pages but do not invalidate */
 130
 131 /* background request structure */
 132 #define BPARMS          4
 133
 134 #define BOP_NOOP        0       /* leave 0 unused */
 135 #define BOP_FETCH       1       /* parm1 is chunk to get */
 136 #define BOP_STORE       2       /* parm1 is chunk to store */
 137 #define BOP_PATH        3       /* parm1 is path, parm2 is chunk to fetch */
 138 #define BOP_FETCH_NOCACHE       4   /* parms are: vnode ptr, offset, segment ptr, addr, cred ptr */
 139 #ifdef AFS_DARWIN_ENV
 140 #define BOP_MOVE        5        /* ptr1 afs_uspc_param ptr2 sname ptr3 dname */
 141 #endif
 142 #define BOP_PARTIAL_STORE 6     /* parm1 is chunk to store */
 143
 144 #define B_DONTWAIT      1       /* On failure return; don't wait */
 145
 146 /* protocol is: refCount is incremented by user to take block out of free pool.
 147     Next, BSTARTED is set when daemon finds request.  This prevents
 148     other daemons from picking up the same request.  Finally, when
 149     request is done, refCount is zeroed.  BDONE and BWAIT are used by
 150     dudes waiting for operation to proceed to a certain point before returning.
 151 */
 152 #define BSTARTED        1       /* request picked up by a daemon */
 153 #define BUVALID         2       /* code is valid (store) */
 154 #define BUWAIT          4       /* someone is waiting for BUVALID */
 155 struct brequest {
 156     struct vcache *vc;          /* vnode to use, with vrefcount bumped */
 157     afs_ucred_t *cred;  /* credentials to use for operation */
 158     afs_size_t size_parm[BPARMS];       /* random parameters */
 159     void *ptr_parm[BPARMS];     /* pointer parameters */
 160     afs_int32 code_raw;         /* return code from AFS routines */
 161     afs_int32 code_checkcode;   /* the afs_CheckCode-translated code */
 162     short refCount;             /* use counter for this structure */
 163     char opcode;                /* what to do (store, fetch, etc) */
 164     char flags;                 /* free, etc */
 165     afs_int32 ts;               /* counter "timestamp" */
 166 };
 167
 168 struct SecretToken {
 169     char data[56];
 170 };
 171
 172 struct ClearToken {
 173     afs_int32 AuthHandle;
 174     char HandShakeKey[8];
 175     afs_int32 ViceId;
 176     afs_int32 BeginTimestamp;
 177     afs_int32 EndTimestamp;
 178 };
 179
 180 struct VenusFid {
 181     afs_int32 Cell;             /* better sun packing if at end of structure */
 182     struct AFSFid Fid;
 183 };
 184
 185 /* Temporary struct to be passed between afs_fid and afs_vget; in SunOS4.x we can only pass a maximum of 10 bytes for a handle (we ideally need 16!) */
 186 struct SmallFid {
 187     afs_int32 Volume;
 188     afs_int32 CellAndUnique;
 189     u_short Vnode;
 190 };
 191 /* The actual number of bytes in the SmallFid, not the sizeof struct. */
 192 #define SIZEOF_SMALLFID 10
 193
 194 /* Queues
 195  * ------
 196  *
 197  *  Circular queues, implemented with pointers. Structures may contain as many
 198  *  queues as required, which may be located at any point within the structure,
 199  *  providing the QEntry macro is used to translate between a queue pointer, and
 200  *  the address of its containing structure
 201  */
 202
 203 struct afs_q {
 204     struct afs_q *next;
 205     struct afs_q *prev;
 206 };
 207
 208 #define QZero(e)    ((e)->prev = (e)->next = NULL)
 209 #define QInit(q)    ((q)->prev = (q)->next = (q))
 210 #define QAdd(q,e)   ((e)->next = (q)->next, (e)->prev = (q), \
 211                         (q)->next->prev = (e), (q)->next = (e))
 212 #define QRemove(e)  ((e)->next->prev = (e)->prev, (e)->prev->next = (e)->next, (e)->prev = NULL, (e)->next = NULL)
 213 #define QNext(e)    ((e)->next)
 214 #define QPrev(e)    ((e)->prev)
 215 #define QEmpty(q)   ((q)->prev == (q))
 216 /* this one takes q1 and sticks it on the end of q2 - that is, the other end, not the end
 217  * that things are added onto.  q1 shouldn't be empty, it's silly */
 218 #define QCat(q1,q2) ((q2)->prev->next = (q1)->next, (q1)->next->prev=(q2)->prev, (q1)->prev->next=(q2), (q2)->prev=(q1)->prev, (q1)->prev=(q1)->next=(q1))
 219
 220 /* Given a pointer to an afs_q within a structure, go back to the address of
 221  * the parent structure
 222  */
 223
 224 #define QEntry(queue, structure, member) \
 225         ((structure *)((char *)(queue)-(char *)(&((structure *)NULL)->member)))
 226
 227 /* And implement operations for individual lists in terms of the above macro */
 228
 229 #define QTOV(e)     QEntry(e, struct vcache, vlruq)
 230 #define QTOC(e)     QEntry(e, struct cell, lruq)
 231 #define QTOVH(e)    QEntry(e, struct vcache, vhashq)
 232
 233 /*!
 234  * List of free slot numbers
 235  */
 236 struct afs_slotlist {
 237     afs_uint32 slot;
 238     struct afs_slotlist *next;
 239 };
 240
 241 struct vrequest {
 242     afs_int32 uid;              /* user id making the request */
 243     afs_int32 busyCount;        /* how many busies we've seen so far */
 244     afs_int32 flags;            /* things like O_SYNC, O_NONBLOCK go here */
 245     char initd;                 /* if non-zero, Error fields meaningful */
 246     char accessError;           /* flags for overriding error return code */
 247     char volumeError;           /* encountered a missing or busy volume */
 248     char networkError;          /* encountered network problems */
 249     char permWriteError;        /* fileserver returns permenent error. */
 250     char tokenError;            /* a token error other than expired. */
 251     char idleError;             /* the server idled too long */
 252     char skipserver[AFS_MAXHOSTS];
 253     afs_int32 lasterror[AFS_MAXHOSTS];
 254 };
 255 #define VOLMISSING 1
 256 #define VOLBUSY 2
 257
 258 /* structure linked off of a server to keep track of queued returned
 259  * callbacks.  Sent asynchronously when we run a little low on free dudes.
 260  */
 261 struct afs_cbr {
 262     struct afs_cbr **pprev;
 263     struct afs_cbr *next;
 264
 265     struct afs_cbr **hash_pprev;
 266     struct afs_cbr *hash_next;
 267
 268     struct AFSFid fid;
 269 };
 270
 271 #ifdef AFS_LINUX22_ENV
 272 /* On Linux, we have to be able to allocate the storage for this using
 273  * kmalloc, as otherwise we may deadlock. So, it needs to be able to fit
 274  * in a single page
 275  */
 276 # define AFS_NCBRS      PAGE_SIZE/sizeof(struct afs_cbr)
 277 #else
 278 # define AFS_NCBRS      1024    /* max # of call back return entries */
 279 #endif
 280
 281 /* cellinfo file magic number */
 282 #define AFS_CELLINFO_MAGIC      0xf32817cd
 283
 284 /* cell flags */
 285 #define CNoSUID                 0x02    /* disable suid bit for this cell */
 286 #define CLinkedCell4            0x04    /* reserved for ADDCELL2 pioctl */
 287 #define CNoAFSDB                0x08    /* never bother trying AFSDB */
 288 #define CHasVolRef              0x10    /* volumes were referenced */
 289 #define CLinkedCell             0x20    /* has a linked cell in lcellp */
 290 #define CHush                   0x40    /* don't display until referenced */
 291
 292 struct cell {
 293     struct afs_q lruq;          /* lru q next and prev */
 294     char *cellName;             /* char string name of cell */
 295     afs_int32 cellIndex;        /* sequence number */
 296     afs_int32 cellNum;          /* semi-permanent cell number */
 297     struct server *cellHosts[AFS_MAXCELLHOSTS]; /* volume *location* hosts */
 298     struct cell *lcellp;        /* Associated linked cell */
 299     u_short fsport;             /* file server port */
 300     u_short vlport;             /* volume server port */
 301     short states;               /* state flags */
 302     time_t timeout;             /* data expire time, if non-zero */
 303     struct cell_name *cnamep;   /* pointer to our cell_name */
 304     afs_rwlock_t lock;          /* protects cell data */
 305     unsigned char cellHandle[16];       /* deterministic handle for this cell */
 306 };
 307
 308 struct cell_name {
 309     struct cell_name *next;
 310     afs_int32 cellnum;
 311     char *cellname;
 312     char used;
 313 };
 314
 315 struct cell_alias {
 316     struct cell_alias *next;
 317     afs_int32 index;
 318     char *alias;
 319     char *cell;
 320 };
 321
 322 #define afs_PutCell(cellp, locktype)
 323
 324 /* the unixuser flag bit definitions */
 325 #define UHasTokens      1       /* are the st and ct fields valid (ever set)? */
 326 #define UTokensBad      2       /* are tokens bad? */
 327 #define UPrimary        4       /* on iff primary identity */
 328 #define UNeedsReset     8       /* needs afs_ResetAccessCache call done */
 329 #define UPAGCounted    16       /* entry seen during PAG search (for stats) */
 330 #define UNFSGetCreds   32       /* getting creds for NFS client */
 331 /* A flag used by afs_GCPAGs to keep track of
 332  * which entries in afs_users need to be deleted.
 333  * The lifetime of its presence in the table is the
 334  * lifetime of the afs_GCPAGs function.
 335  */
 336 #define TMP_UPAGNotReferenced   128
 337
 338 /* unixuser notify events */
 339 #define UTokensObtained 1
 340 #define UTokensDropped  2
 341
 342 /* values for afs_gcpags */
 343 enum { AFS_GCPAGS_NOTCOMPILED = 0, AFS_GCPAGS_OK =
 344         1, AFS_GCPAGS_USERDISABLED, AFS_GCPAGS_EPROC0, AFS_GCPAGS_EPROCN,
 345     AFS_GCPAGS_EEQPID, AFS_GCPAGS_EINEXACT, AFS_GCPAGS_EPROCEND,
 346     AFS_GCPAGS_EPROCWALK, AFS_GCPAGS_ECREDWALK, AFS_GCPAGS_EPIDCHECK,
 347     AFS_GCPAGS_ENICECHECK
 348 };
 349
 350 extern afs_int32 afs_gcpags;
 351 extern afs_int32 afs_gcpags_procsize;
 352 extern afs_int32 afs_bkvolpref;
 353 extern char afs_cachebasedir[1024];
 354 extern afs_int32 afs_numcachefiles;
 355 extern afs_int32 afs_numfilesperdir;
 356
 357 struct rxkadToken {
 358     afs_int32 ticketLen;
 359     char * ticket;
 360     struct ClearToken clearToken;
 361 };
 362
 363 union tokenUnion {
 364     struct rxkadToken rxkad;
 365 };
 366
 367 struct tokenJar {
 368     struct tokenJar *next;
 369     int type;
 370     union tokenUnion content;
 371 };
 372
 373 struct unixuser {
 374     struct unixuser *next;      /* next hash pointer */
 375     afs_int32 uid;              /* search based on uid and cell */
 376     afs_int32 cell;
 377     afs_int32 viceId;           /* Optional viced ID corresponding to current tokens */
 378     short refCount;             /* reference count for allocation */
 379     char states;                /* flag info */
 380     afs_int32 tokenTime;        /* last time tokens were set, used for timing out conn data */
 381     struct tokenJar *tokens;
 382     struct afs_exporter *exporter;      /* more info about the exporter for the remote user */
 383     void *cellinfo;             /* pointer to cell info (PAG manager only) */
 384     afs_rwlock_t lock;
 385 };
 386
 387 #define CVEC_LEN 3 /* per-user connection pool */
 388
 389 struct sa_conn_vector;
 390 typedef struct sa_conn_vector * p_sa_conn_vector; /* forward decl */
 391
 392 #define CONN_REPLICATED 0x1
 393
 394 struct afs_conn {
 395     int refCount;
 396     int activated;
 397     char forceConnectFS; /* Should we try again with these tokens? */
 398     struct rx_connection *id; /* RPC connid */
 399     struct sa_conn_vector *parent; /* the con_vector which contains us */
 400 };
 401
 402 /* An sa_conn_vector replaces the erstwhile list of conn
 403    structures maintained by the cache manager.  The sa_conn_vector
 404    contains a C array of connections which, if non-zero, represent
 405    connections to AFS servers.
 406 */
 407
 408 struct sa_conn_vector {
 409     /* linked-list machinery */
 410     struct sa_conn_vector *next;
 411
 412     /* AFS conn-identifying info */
 413     struct unixuser *user;      /* user validated with respect to. */
 414     struct srvAddr *srvr;       /* server associated with this conn */
 415     short refCount;             /* reference count for allocation */
 416     unsigned short port;        /* port associated with this connection */
 417     int flags;
 418
 419     /* next connection to return when all in cvec are fully utilized */
 420     int select_index;
 421
 422     /* connections vector */
 423     struct afs_conn cvec[CVEC_LEN];
 424 };
 425
 426 #define SQNULL -1
 427
 428 /* Fid comparison routines */
 429 #define FidCmp(a,b) ((a)->Fid.Unique != (b)->Fid.Unique \
 430     || (a)->Fid.Vnode != (b)->Fid.Vnode \
 431     || (a)->Fid.Volume != (b)->Fid.Volume \
 432     || (a)->Cell != (b)->Cell)
 433
 434 #define FidMatches(afid,tvc) ((tvc)->f.fid.Fid.Vnode == (afid)->Fid.Vnode && \
 435         (tvc)->f.fid.Fid.Volume == (afid)->Fid.Volume && \
 436         (tvc)->f.fid.Cell == (afid)->Cell && \
 437         ( (tvc)->f.fid.Fid.Unique == (afid)->Fid.Unique || \
 438          (!(afid)->Fid.Unique && ((tvc)->f.states & CUnique))))
 439
 440
 441 #define SRVADDR_MH      1
 442 #define SRVADDR_ISDOWN  0x20    /* same as SRVR_ISDOWN */
 443 #define  SRVADDR_NOUSE    0x40  /* Don't use this srvAddr */
 444
 445 struct srvAddr {
 446     struct srvAddr *next_bkt;   /* next item in hash bucket */
 447     struct srvAddr *next_sa;    /* another interface on same host */
 448     struct server *server;      /* back to parent */
 449     struct sa_conn_vector *conns;   /* All user connections to this server */
 450     struct afs_conn *natping;
 451     afs_int32 sa_ip;            /* Host addr in network byte order */
 452     u_short sa_iprank;          /* indiv ip address priority */
 453     u_short sa_portal;          /* port addr in network byte order */
 454     u_char sa_flags;
 455 };
 456
 457 /*
 458  * Values used in the flags field of the server structure below.
 459  *
 460  *      AFS_SERVER_FLAG_ACTIVATED Has the server ever had a user connection
 461  *                                associated with it?
 462  */
 463 #define AFS_SERVER_FLAG_ACTIVATED       0x01
 464 #define SNO_LHOSTS                      0x04
 465 #define SYES_LHOSTS                     0x08
 466 #define SVLSRV_UUID                     0x10
 467 #define SRVR_ISDOWN                     0x20
 468 #define SRVR_MULTIHOMED                 0x40
 469 #define SRVR_ISGONE                     0x80
 470 #define SNO_INLINEBULK                  0x100
 471 #define SNO_64BIT                       0x200
 472 #define SCAPS_KNOWN                     0x400
 473
 474 #define SRV_CAPABILITIES(ts) \
 475 { if ( !(ts->flags & SCAPS_KNOWN)) afs_GetCapabilities(ts); ts->capabilities; }
 476
 477 #define afs_serverSetNo64Bit(s) (((struct sa_conn_vector*)(s)->parent)->srvr->server->flags |= SNO_64BIT)
 478 #define afs_serverHasNo64Bit(s) (((struct sa_conn_vector*)(s)->parent)->srvr->server->flags & SNO_64BIT)
 479
 480 struct server {
 481     union {
 482         struct {
 483             afsUUID suuid;
 484             afs_int32 addr_uniquifier;
 485             afs_int32 spares[2];
 486         } _srvUuid;
 487         struct {
 488             struct srvAddr haddr;
 489         } _srvId;
 490     } _suid;
 491 #define sr_uuid         _suid._srvUuid.suuid
 492 #define sr_addr_uniquifier      _suid._srvUuid.addr_uniquifier
 493 #define sr_host         _suid._srvId.haddr.ip
 494 #define sr_portal       _suid._srvId.haddr.portal
 495 #define sr_rank         _suid._srvId.haddr.ip_rank
 496 #define sr_flags        _suid._srvId.haddr.flags
 497 #define sr_conns        _suid._srvId.haddr.conns
 498     struct server *next;        /* Ptr to next server in hash chain */
 499     struct cell *cell;          /* Cell in which this host resides */
 500     struct afs_cbr *cbrs;       /* Return list of callbacks */
 501     afs_int32 activationTime;   /* Time when this record was first activated */
 502     afs_int32 lastDowntimeStart;        /* Time when last downtime incident began */
 503     afs_int32 numDowntimeIncidents;     /* # (completed) downtime incidents */
 504     afs_int32 sumOfDowntimes;   /* Total downtime experienced, in seconds */
 505     struct srvAddr *addr;
 506     afs_uint32 flags;           /* Misc flags */
 507     afs_int32 capabilities;
 508 };
 509
 510 #define afs_PutServer(servp, locktype)
 511
 512 /* structs for some pioctls  - these are (or should be)
 513  * also in venus.h
 514  */
 515 struct spref {
 516     struct in_addr host;
 517     unsigned short rank;
 518 };
 519
 520 struct sprefrequest_33 {
 521     unsigned short offset;
 522     unsigned short num_servers;
 523 };
 524
 525
 526 struct sprefrequest {           /* new struct for 3.4 */
 527     unsigned short offset;
 528     unsigned short num_servers;
 529     unsigned short flags;
 530 };
 531 #define DBservers 1
 532
 533 struct sprefinfo {
 534     unsigned short next_offset;
 535     unsigned short num_servers;
 536     struct spref servers[1];    /* we overrun this array intentionally... */
 537 };
 538
 539 struct setspref {
 540     unsigned short flags;
 541     unsigned short num_servers;
 542     struct spref servers[1];    /* we overrun this array intentionally... */
 543 };
 544 /* struct for GAG pioctl
 545  */
 546 struct gaginfo {
 547     afs_uint32 showflags, logflags, logwritethruflag, spare[3];
 548     unsigned char spare2[128];
 549 };
 550 #define GAGUSER    1
 551 #define GAGCONSOLE 2
 552 #define logwritethruON  1
 553
 554 struct rxparams {
 555     afs_int32 rx_initReceiveWindow, rx_maxReceiveWindow, rx_initSendWindow,
 556         rx_maxSendWindow, rxi_nSendFrags, rxi_nRecvFrags, rxi_OrphanFragSize;
 557     afs_int32 rx_maxReceiveSize, rx_MyMaxSendSize;
 558     afs_uint32 spare[21];
 559 };
 560
 561 /* struct for checkservers */
 562
 563 struct chservinfo {
 564     int magic;
 565     char tbuffer[128];
 566     int tsize;
 567     afs_int32 tinterval;
 568     afs_int32 tflags;
 569 };
 570
 571
 572 /* state bits for volume */
 573 #define VRO                     1       /* volume is readonly */
 574 #define VRecheck                2       /* recheck volume info with server */
 575 #define VBackup                 4       /* is this a backup volume? */
 576 #define VForeign                8       /* this is a non-afs volume */
 577 #define VPartVisible            16      /* Volume's partition is visible on the client */
 578 #define VHardMount              32      /* we are hard-mount waiting for the vol */
 579
 580 enum repstate { not_busy, end_not_busy = 6, rd_busy, rdwr_busy, offline };
 581
 582 struct volume {
 583     /* One structure per volume, describing where the volume is located
 584      * and where its mount points are. */
 585     struct volume *next;        /* Next volume in hash list. */
 586     afs_int32 cell;             /* the cell in which the volume resides */
 587     afs_rwlock_t lock;          /* the lock for this structure */
 588     afs_int32 volume;           /* This volume's ID number. */
 589     char *name;                 /* This volume's name, or 0 if unknown */
 590     struct server *serverHost[AFS_MAXHOSTS];    /* servers serving this volume */
 591     enum repstate status[AFS_MAXHOSTS]; /* busy, offline, etc */
 592     struct VenusFid dotdot;     /* dir to access as .. */
 593     struct VenusFid mtpoint;    /* The mount point for this volume. */
 594     afs_int32 rootVnode, rootUnique;    /* Volume's root fid */
 595     afs_int32 roVol;
 596     afs_int32 backVol;
 597     afs_int32 rwVol;            /* For r/o vols, original read/write volume. */
 598     afs_int32 accessTime;       /* last time we used it */
 599     afs_int32 vtix;             /* volume table index */
 600     afs_int32 copyDate;         /* copyDate field, for tracking vol releases */
 601     afs_int32 expireTime;       /* for per-volume callbacks... */
 602     short refCount;             /* reference count for allocation */
 603     char states;                /* here for alignment reasons */
 604 };
 605
 606 #define afs_PutVolume(av, locktype) ((av)->refCount--)
 607
 608 /* format of an entry in volume info file */
 609 struct fvolume {
 610     afs_int32 cell;             /* cell for this entry */
 611     afs_int32 volume;           /* volume */
 612     afs_int32 next;             /* has index */
 613     struct VenusFid dotdot;     /* .. value */
 614     struct VenusFid mtpoint;    /* mt point's fid */
 615     afs_int32 rootVnode, rootUnique;    /* Volume's root fid */
 616 };
 617
 618 struct SimpleLocks {
 619     struct SimpleLocks *next;
 620     int type;
 621     afs_int32 boff, eoff;
 622     afs_int32 pid;
 623 #if     defined(AFS_AIX32_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
 624     afs_int32 sysid;
 625 #endif
 626 };
 627
 628 /* vcache state bits */
 629 #define CStatd          0x00000001      /* has this file ever been stat'd? */
 630 #define CBackup         0x00000002      /* file is on a backup volume */
 631 #define CRO             0x00000004      /* is it on a read-only volume */
 632 #define CMValid         0x00000008      /* is the mount point info valid? */
 633 #define CCore           0x00000010      /* storing a core file, needed since we don't get an open */
 634 #define CDirty          0x00000020      /* file has been modified since first open (... O_RDWR) */
 635 #define CSafeStore      0x00000040      /* close must wait for store to finish (should be in fd) */
 636 #define CMAPPED         0x00000080      /* Mapped files; primarily used by SunOS 4.0.x */
 637 #define CNSHARE         0x00000100      /* support O_NSHARE semantics */
 638 #define CLied           0x00000200
 639 #define CTruth          0x00000400
 640
 641 #if defined(AFS_DARWIN80_ENV)
 642 #define CDeadVnode        0x00000800
 643 #elif defined(AFS_DARWIN_ENV)
 644 #define CUBCinit        0x00000800
 645 #else
 646 #define CWRITE_IGN      0x00000800      /* Next OS hack only */
 647 #endif
 648
 649 #define CUnique         0x00001000      /* vc's uniquifier - latest unifiquier for fid */
 650 #define CForeign        0x00002000      /* this is a non-afs vcache */
 651 #define CReadDir        0x00004000      /* readdir in progress */
 652 #define CUnlinked       0x00010000
 653 #define CBulkStat       0x00020000      /* loaded by a bulk stat, and not ref'd since */
 654 #define CUnlinkedDel    0x00040000
 655 #define CVFlushed       0x00080000
 656 #ifdef AFS_LINUX22_ENV
 657 #define CPageWrite      0x00200000      /* to detect vm deadlock - linux */
 658 #elif defined(AFS_SGI_ENV)
 659 #define CWritingUFS     0x00200000      /* to detect vm deadlock - used by sgi */
 660 #elif defined(AFS_DARWIN80_ENV)
 661 #define CEvent          0x00200000      /* to preclude deadlock when sending events */
 662 #endif
 663 #define CCreating       0x00400000      /* avoid needless store after open truncate */
 664 #define CPageHog        0x00800000      /* AIX - dumping large cores is a page hog. */
 665 #define CCorrupt        0x01000000      /* corrupt dir already reported */
 666 #define CDCLock         0x02000000      /* Vnode lock held over call to GetDownD */
 667 #define CBulkFetching   0x04000000      /* stats are being fetched by bulk stat */
 668 #define CExtendedFile   0x08000000      /* extended file via ftruncate call. */
 669 #define CVInit          0x10000000      /* being initialized */
 670 #define CMetaDirty      0x20000000      /* vnode meta-data needs to be flushed */
 671 #define CPartVisible    0x40000000      /* fileserver partition visible on client */
 672
 673 /* vcache vstate bits */
 674 #define VRevokeWait   0x1
 675 #define VPageCleaning 0x2       /* Solaris - Cache Trunc Daemon sez keep out */
 676
 677 /* Dirty disconnected vcache flags. */
 678 #define VDisconSetTime          0x00000001      /* set time. */
 679 #define VDisconSetMode          0x00000002      /* set mode. */
 680 /* XXX: to be continued ? */
 681 #define VDisconTrunc            0x00000020      /* truncate file. */
 682 #define VDisconSetAttrMask      0x0000003F      /* Masks for setattr ops. */
 683 #define VDisconWriteClose       0x00000400      /* Write op on file close. */
 684 #define VDisconWriteFlush       0x00000800      /* Write op on normal fsync/flush. */
 685 #define VDisconWriteOsiFlush    0x00001000      /* Write op on osi flush. */
 686
 687 #define VDisconRemove           0x00002000      /* Remove vnop. */
 688 #define VDisconCreate           0x00004000      /* Create vnop. */
 689 #define VDisconCreated          0x00008000      /* A file that was created during
 690                                                    this resync operation */
 691 #define VDisconRename           0x00010000      /* Rename vnop. */
 692 #define VDisconRenameSameDir    0x00020000      /* Rename in same dir. */
 693
 694 /*... to be continued ...  */
 695
 696 /* vcache (file) cachingStates bits */
 697 #define FCSDesireBypass   0x1   /* This file should bypass the cache */
 698 #define FCSBypass         0x2   /* This file is currently NOT being cached */
 699 #define FCSManuallySet    0x4   /* The bypass flags were set, or reset, manually (via pioctl)
 700                                                                    and should not be overridden by the file's name */
 701
 702 /* Flag values used by the Transition routines */
 703 #define TRANSChangeDesiredBit           0x1     /* The Transition routine should set or
 704                                                                                  * reset the FCSDesireBypass bit */
 705 #define TRANSVcacheIsLocked                     0x2     /* The Transition routine does not need to
 706                                                                                  * lock vcache (it's already locked) */
 707 #define TRANSSetManualBit               0x4     /* The Transition routine should set FCSManuallySet so that
 708                                                                          * filename checking does not override pioctl requests */
 709
 710 #define CPSIZE      2
 711 #if defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV)
 712 #define vrefCount   v->v_usecount
 713 #else
 714 #define vrefCount   v.v_count
 715 #endif /* AFS_XBSD_ENV */
 716
 717 #if defined(AFS_DARWIN80_ENV)
 718 #define VREFCOUNT_GT(v, y)    vnode_isinuse(AFSTOV(v), (y))
 719 #elif defined(AFS_FBSD_ENV)
 720 #define VREFCOUNT(v)            (vrefcnt(AFSTOV(v)))
 721 #define VREFCOUNT_GT(v, y)      (vrefcnt(AFSTOV(v)) > y)
 722 #elif defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV)
 723 #define VREFCOUNT(v)          ((v)->vrefCount)
 724 #define VREFCOUNT_GT(v, y)    (AFSTOV(v)->v_usecount > (y))
 725 #elif defined(AFS_LINUX24_ENV)
 726 #define VREFCOUNT(v)            atomic_read(&(AFSTOV(v)->v_count))
 727 #define VREFCOUNT_GT(v, y)      (VREFCOUNT(v)>y)
 728 #define VREFCOUNT_SET(v, c)     atomic_set(&(AFSTOV(v)->v_count), c)
 729 #define VREFCOUNT_DEC(v)        atomic_dec(&(AFSTOV(v)->v_count))
 730 #define VREFCOUNT_INC(v)        atomic_inc(&(AFSTOV(v)->v_count))
 731 #else
 732 #define VREFCOUNT(v)            ((v)->vrefCount)
 733 #define VREFCOUNT_GT(v,y)     ((v)->vrefCount > (y))
 734 #define VREFCOUNT_SET(v, c)     (v)->vrefCount = c
 735 #define VREFCOUNT_DEC(v)        (v)->vrefCount--
 736 #define VREFCOUNT_INC(v)        (v)->vrefCount++
 737 #define d_unhash(d) list_empty(&(d)->d_hash)
 738 #define dget_locked(d) dget(d)
 739 #endif
 740
 741 #define AFS_MAXDV   0x7fffffff  /* largest dataversion number */
 742 #ifdef AFS_64BIT_CLIENT
 743 #define AFS_NOTRUNC 0x7fffffffffffffffLL        /* largest positive int64 number */
 744 #else /* AFS_64BIT_CLIENT */
 745 #define AFS_NOTRUNC 0x7fffffff  /* largest dataversion number */
 746 #endif /* AFS_64BIT_CLIENT */
 747
 748 extern afs_int32 vmPageHog;     /* counter for # of vnodes which are page hogs. */
 749
 750 #if defined(AFS_DARWIN80_ENV)
 751 #define VTOAFS(v) ((struct vcache *)vnode_fsnode((v)))
 752 #define AFSTOV(vc) ((vc)->v)
 753 #elif defined(AFS_NBSD40_ENV)
 754 struct nbvdata {
 755     struct genfs_node gfsn;
 756     struct vcache *afsvc;
 757 };
 758 #define VTOAFS(v) ((((struct nbvdata *)((v)->v_data)))->afsvc)
 759 #define AFSTOV(vc) ((vc)->v)
 760 #elif defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV) || (defined(AFS_LINUX22_ENV) && !defined(STRUCT_SUPER_OPERATIONS_HAS_ALLOC_INODE))
 761 #define VTOAFS(v) ((struct vcache *)(v)->v_data)
 762 #define AFSTOV(vc) ((vc)->v)
 763 #else
 764 #define VTOAFS(V) ((struct vcache *)(V))
 765 #define AFSTOV(V) (&(V)->v)
 766 #endif
 767
 768 struct afs_vnuniq {
 769     afs_uint32 vnode;
 770     afs_uint32 unique;
 771 };
 772
 773 /* VCache elements which are kept on disk, and in the kernel */
 774 struct fvcache {
 775     struct VenusFid fid;
 776     struct mstat {
 777         afs_size_t Length;
 778         afs_hyper_t DataVersion;
 779         afs_uint32 Date;
 780         afs_uint32 Owner;
 781         afs_uint32 Group;
 782         afs_uint16 Mode;        /* XXXX Should be afs_int32 XXXX */
 783         afs_uint16 LinkCount;
 784 #ifdef AFS_DARWIN80_ENV
 785         afs_uint16 Type;
 786 #else
 787         /* vnode type is in v.v_type */
 788 #endif
 789     } m;
 790     struct afs_vnuniq parent;
 791
 792     /*! Truncate file to this position at the next store */
 793     afs_size_t truncPos;
 794
 795     /*! System:AnyUser's access to this. */
 796     afs_int32 anyAccess;
 797
 798     /*! state bits */
 799     afs_uint32 states;
 800
 801     /*! Disconnected flags for this vcache element. */
 802     afs_uint32 ddirty_flags;
 803     /*! Shadow vnode + unique keep the shadow dir location. */
 804     struct afs_vnuniq shadow;
 805     /*! The old parent FID for renamed vnodes */
 806     struct afs_vnuniq oldParent;
 807 };
 808
 809 #ifdef AFS_SUN5_ENV
 810 /*
 811  * This is for the multiPage field in struct vcache. Each one of these
 812  * represents an outstanding getpage request that is larger than a single page.
 813  * Recording these is necessary to prevent afs_GetOnePage from trying to evict
 814  * a dcache entry that an earlier afs_GetOnePage call got in the same getpage
 815  * request. See osi_VM_MultiPageConflict and afs_getpage.
 816  */
 817 struct multiPage_range {
 818     struct afs_q q;
 819     offset_t off;    /**< offset of getpage request */
 820     u_int len;       /**< length of getpage request */
 821 };
 822 #endif
 823
 824 /* INVARIANTs: (vlruq.next != NULL) == (vlruq.prev != NULL)
 825  *             nextfree => !vlruq.next && ! vlruq.prev
 826  * !(avc->nextfree) && !avc->vlruq.next => (FreeVCList == avc->nextfree)
 827  */
 828 struct vcache {
 829 #if defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV) || (defined(AFS_LINUX22_ENV) && !defined(STRUCT_SUPER_OPERATIONS_HAS_ALLOC_INODE))
 830     struct vnode *v;
 831 #else
 832     struct vnode v;             /* Has reference count in v.v_count */
 833 #endif
 834     struct afs_q vlruq;         /* lru q next and prev */
 835 #if !defined(AFS_LINUX22_ENV)
 836     struct vcache *nextfree;    /* next on free list (if free) */
 837 #endif
 838     struct vcache *hnext;       /* Hash next */
 839     struct afs_q vhashq;        /* Hashed per-volume list */
 840     /*! Queue of dirty vcaches. Lock with afs_disconDirtyLock */
 841     struct afs_q dirtyq;
 842     /*! Queue of vcaches with shadow entries. Lock with afs_disconDirtyLock */
 843     struct afs_q shadowq;
 844     /*! Queue of vcaches with dirty metadata. Locked by afs_xvcdirty */
 845     struct afs_q metadirty;
 846     /*! Vcaches slot number in the disk backup. Protected by tvc->lock */
 847     afs_uint32 diskSlot;
 848     struct fvcache f;
 849     afs_rwlock_t lock;          /* The lock on the vcache contents. */
 850 #if     defined(AFS_SUN5_ENV)
 851     /* Lock used to protect the activeV, multipage, and vstates fields.
 852      * Do not try to get the vcache lock when the vlock is held */
 853     afs_rwlock_t vlock;
 854 #endif                          /* defined(AFS_SUN5_ENV) */
 855 #if     defined(AFS_SUN5_ENV)
 856     krwlock_t rwlock;
 857     struct cred *credp;
 858 #endif
 859 #ifdef  AFS_AIX32_ENV
 860     afs_lock_t pvmlock;
 861     vmhandle_t vmh;
 862 #if defined(AFS_AIX51_ENV)
 863     vmid_t segid;
 864 #else
 865     int segid;
 866 #endif
 867     struct ucred *credp;
 868 #endif
 869 #ifdef AFS_AIX_ENV
 870     int ownslock;               /* pid of owner of excl lock, else 0 - defect 3083 */
 871 #endif
 872 #ifdef AFS_DARWIN80_ENV
 873     lck_mtx_t *rwlock;
 874 #elif defined(AFS_DARWIN_ENV)
 875     struct lock__bsd__ rwlock;
 876 #endif
 877 #ifdef AFS_XBSD_ENV
 878 #if !defined(AFS_DFBSD_ENV) && !defined(AFS_NBSD_ENV)
 879     struct lock rwlock;
 880 #endif
 881 #endif
 882
 883     struct VenusFid *mvid;      /* Either parent dir (if root) or root (if mt pt) */
 884     char *linkData;             /* Link data if a symlink. */
 885     afs_hyper_t flushDV;        /* data version last flushed from text */
 886     afs_hyper_t mapDV;          /* data version last flushed from map */
 887     struct server *callback;    /* The callback host, if any */
 888     afs_uint32 cbExpires;       /* time the callback expires */
 889     struct afs_q callsort;      /* queue in expiry order, sort of */
 890     struct axscache *Access;    /* a list of cached access bits */
 891     afs_int32 last_looker;      /* pag/uid from last lookup here */
 892 #if     defined(AFS_SUN5_ENV)
 893     afs_int32 activeV;
 894 #endif                          /* defined(AFS_SUN5_ENV) */
 895     struct SimpleLocks *slocks;
 896     short opens;                /* The numbers of opens, read or write, on this file. */
 897     short execsOrWriters;       /* The number of execs (if < 0) or writers (if > 0) of
 898                                  * this file. */
 899     short flockCount;           /* count of flock readers, or -1 if writer */
 900     char mvstat;                /* 0->normal, 1->mt pt, 2->root. */
 901
 902     char cachingStates;                 /* Caching policies for this file */
 903     afs_uint32 cachingTransitions;              /* # of times file has flopped between caching and not */
 904
 905 #if defined(AFS_LINUX24_ENV)
 906     off_t next_seq_offset;      /* Next sequential offset (used by prefetch/readahead) */
 907 #elif defined(AFS_SUN5_ENV) || defined(AFS_SGI65_ENV)
 908     off_t next_seq_blk_offset; /* accounted in blocks for Solaris & IRIX */
 909 #endif
 910
 911 #if     defined(AFS_SUN5_ENV)
 912     afs_uint32 vstates;         /* vstate bits */
 913 #endif                          /* defined(AFS_SUN5_ENV) */
 914     struct dcache *dchint;
 915     struct dcache *dcreaddir;   /* dcache for in-progress readdir */
 916     unsigned int readdir_pid;   /* pid of the thread in readdir */
 917 #if defined(AFS_SGI_ENV)
 918     daddr_t lastr;              /* for read-ahead */
 919 #ifdef AFS_SGI64_ENV
 920     uint64_t vc_rwlockid;       /* kthread owning rwlock */
 921 #else
 922     short vc_rwlockid;          /* pid of process owning rwlock */
 923 #endif
 924     short vc_locktrips;         /* # of rwlock reacquisitions */
 925     sema_t vc_rwlock;           /* vop_rwlock for afs */
 926     pgno_t mapcnt;              /* # of pages mapped */
 927     struct cred *cred;          /* last writer's cred */
 928 #ifdef AFS_SGI64_ENV
 929     struct bhv_desc vc_bhv_desc;        /* vnode's behavior data. */
 930 #endif
 931 #endif                          /* AFS_SGI_ENV */
 932 #if defined(AFS_LINUX26_ENV)
 933     cred_t *cred;               /* last writer's cred */
 934 #endif
 935 #ifdef AFS_LINUX24_ENV
 936     struct dentry *target_link; /* dentry we prefer, when we are redirecting
 937                                  * all requests due to duplicate dentry aliases.
 938                                  * See LINUX/osi_vnodeops.c. Note that this is
 939                                  * NOT an actual reference to a dentry, so this
 940                                  * pointer MUST NOT be dereferenced on its own. */
 941 #endif
 942     afs_int32 vc_error;         /* stash write error for this vnode. */
 943     int xlatordv;               /* Used by nfs xlator */
 944     afs_ucred_t *uncred;
 945     int asynchrony;             /* num kbytes to store behind */
 946 #ifdef AFS_SUN5_ENV
 947     struct afs_q multiPage;     /* list of multiPage_range structs */
 948 #endif
 949     int protocol;               /* RX_FILESERVER, RX_OSD, ... defined in afsint.xg */
 950 #if !defined(UKERNEL)
 951     void *vpacRock;             /* used to read or write in visible partitions */
 952 #endif
 953     afs_uint32 lastBRLWarnTime; /* last time we warned about byte-range locks */
 954 };
 955
 956 #define DONT_CHECK_MODE_BITS    0
 957 #define CHECK_MODE_BITS         1
 958 #define CMB_ALLOW_EXEC_AS_READ  2       /* For the NFS xlator */
 959
 960 #if defined(AFS_SGI_ENV)
 961 #define AVCRWLOCK(avc)          (valusema(&(avc)->vc_rwlock) <= 0)
 962
 963 /* SGI vnode rwlock macros and flags. */
 964 #ifndef AFS_SGI62_ENV
 965 /* The following are defined here. SGI 6.2 declares them in vnode.h */
 966 #define VRWLOCK_READ            0
 967 #define VRWLOCK_WRITE           1
 968 #define VRWLOCK_WRITE_DIRECT    2
 969 #endif
 970
 971 #ifdef AFS_SGI53_ENV
 972 #ifdef AFS_SGI62_ENV
 973 #define AFS_RWLOCK_T vrwlock_t
 974 #else
 975 #define AFS_RWLOCK_T int
 976 #endif /* AFS_SGI62_ENV */
 977 #ifdef AFS_SGI64_ENV
 978 #include <ksys/behavior.h>
 979 #define AFS_RWLOCK(V,F) \
 980         afs_rwlock(&VTOAFS(V)->vc_bhv_desc, (F));
 981 #define AFS_RWUNLOCK(V,F) \
 982         afs_rwunlock(&VTOAFS(V)->vc_bhv_desc, (F));
 983
 984 #else
 985 #define AFS_RWLOCK(V,F) afs_rwlock((vnode_t *)(V), (F) )
 986 #define AFS_RWUNLOCK(V,F) afs_rwunlock((vnode_t *)(V), (F) )
 987 #endif
 988 #else /* AFS_SGI53_ENV */
 989 #define AFS_RWLOCK(V,F) afs_rwlock((V))
 990 #define AFS_RWUNLOCK(V,F) afs_rwunlock((V))
 991 #endif /* AFS_SGI53_ENV */
 992 #endif /* AFS_SGI_ENV */
 993
 994 struct vcxstat {
 995     struct VenusFid fid;
 996     afs_hyper_t DataVersion;
 997     afs_rwlock_t lock;
 998     afs_int32 parentVnode;
 999     afs_int32 parentUnique;
1000     afs_hyper_t flushDV;
1001     afs_hyper_t mapDV;
1002     afs_int32 truncPos;
1003     afs_int32 randomUid[CPSIZE];
1004     afs_int32 callback;         /* Now a pointer to 'server' struct */
1005     afs_int32 cbExpires;
1006     afs_int32 randomAccess[CPSIZE];
1007     afs_int32 anyAccess;
1008     short opens;
1009     short execsOrWriters;
1010     short flockCount;
1011     char mvstat;
1012     afs_uint32 states;
1013 };
1014
1015 struct vcxstat2 {
1016     afs_int32 callerAccess;
1017     afs_int32 cbExpires;
1018     afs_int32 anyAccess;
1019     char mvstat;
1020 };
1021
1022 struct sbstruct {
1023     int sb_thisfile;
1024     int sb_default;
1025 };
1026
1027 /* CM inititialization parameters. What CM actually used after calculations
1028  * based on passed in arguments.
1029  */
1030 #define CMI_VERSION 1           /* increment when adding new fields. */
1031 struct cm_initparams {
1032     int cmi_version;
1033     int cmi_nChunkFiles;
1034     int cmi_nStatCaches;
1035     int cmi_nDataCaches;
1036     int cmi_nVolumeCaches;
1037     int cmi_firstChunkSize;
1038     int cmi_otherChunkSize;
1039     int cmi_cacheSize;          /* The original cache size, in 1K blocks. */
1040     unsigned cmi_setTime:1;
1041     unsigned cmi_memCache:1;
1042     int spare[16 - 9];          /* size of struct is 16 * 4 = 64 bytes */
1043 };
1044
1045
1046 /*----------------------------------------------------------------------
1047  * AFS Data cache definitions
1048  *
1049  * Each entry describes a Unix file on the local disk that is
1050  * is serving as a cached copy of all or part of a Vice file.
1051  * Entries live in circular queues for each hash table slot
1052  *
1053  * Which queue is this thing in?  Good question.
1054  * A struct dcache entry is in the freeDSlot queue when not associated with a cache slot (file).
1055  * Otherwise, it is in the DLRU queue.  The freeDSlot queue uses the lruq.next field as
1056  * its "next" pointer.
1057  *
1058  * Cache entries in the DLRU queue are either associated with vice files, in which case
1059  * they are hashed by afs_dvnextTbl and afs_dcnextTbl pointers, or they are in the freeDCList
1060  * and are not associated with any vice file.  This last list uses the afs_dvnextTbl pointer for
1061  * its "next" pointer.
1062  *----------------------------------------------------------------------*/
1063
1064 #define NULLIDX     (-1)        /* null index definition */
1065 /* struct dcache states bits */
1066 #define DRO         1
1067 #define DBackup     2
1068 #define DRW         4
1069 #define DWriting    8           /* file being written (used for cache validation) */
1070
1071 /* dcache data flags */
1072 #define DFEntryMod      0x02    /* has entry itself been modified? */
1073 #define DFFetching      0x04    /* file is currently being fetched */
1074
1075 /* dcache meta flags */
1076 #define DFNextStarted   0x01    /* next chunk has been prefetched already */
1077 #define DFFetchReq      0x10    /* someone is waiting for DFFetching to go on */
1078
1079
1080 /* flags in afs_indexFlags array */
1081 #define IFEverUsed      1       /* index entry has >= 1 byte of data */
1082 #define IFFree          2       /* index entry in freeDCList */
1083 #define IFDataMod       4       /* file needs to be written out */
1084 #define IFFlag          8       /* utility flag */
1085 #define IFDirtyPages    16      /* Solaris-only. contains dirty pages */
1086 #define IFAnyPages      32
1087 #define IFDiscarded     64      /* index entry in discardDCList */
1088
1089 #ifdef AFS_DARWIN100_ENV
1090 typedef user_addr_t iparmtype; /* 64 bit */
1091 typedef user_addr_t uparmtype; /* 64 bit */
1092 #else
1093 typedef char * uparmtype;
1094 #ifdef AFS_SGI65_ENV
1095 typedef afs_uint32 iparmtype;
1096 #else
1097 typedef long iparmtype;
1098 #endif
1099 #endif
1100
1101 #if SIZEOF_VOID_P == SIZEOF_UNSIGNED_INT
1102 # define uintptrsz unsigned int
1103 #elif SIZEOF_VOID_P == SIZEOF_UNSIGNED_LONG
1104 # define uintptrsz unsigned long
1105 #elif SIZEOF_VOID_P == SIZEOF_UNSIGNED_LONG_LONG
1106 # define uintptrsz unsigned long long
1107 #else
1108 # error "Unable to determine casting for pointers"
1109 #endif
1110
1111 struct afs_ioctl {
1112     uparmtype in;               /* input buffer */
1113     uparmtype out;              /* output buffer */
1114     short in_size;              /* Size of input buffer <= 2K */
1115     short out_size;             /* Maximum size of output buffer, <= 2K */
1116 };
1117
1118 /*
1119  * This version of afs_ioctl is required to pass in 32 bit user space
1120  * pointers into a 64 bit kernel.
1121  */
1122
1123 struct afs_ioctl32 {
1124     unsigned int in;
1125     unsigned int out;
1126     short in_size;
1127     short out_size;
1128 };
1129
1130
1131 /* CacheItems file has a header of type struct afs_fheader
1132  * (keep aligned properly). Since we already have sgi_62 clients running
1133  * with a 32 bit inode, a change is required to the header so that
1134  * they can distinguish the old 32 bit inode CacheItems file and zap it
1135  * instead of using it.
1136  */
1137 struct afs_fheader {
1138 #define AFS_FHMAGIC         0x7635abaf  /* uses version number */
1139     afs_int32 magic;
1140 #define AFS_CI_VERSION 4
1141     afs_int32 version;
1142     afs_uint32 dataSize;
1143     afs_int32 firstCSize;
1144     afs_int32 otherCSize;
1145 };
1146
1147 #if defined(AFS_CACHE_VNODE_PATH)
1148 typedef char *afs_ufs_dcache_id_t;
1149 #elif defined(AFS_SGI61_ENV) || defined(AFS_SUN5_64BIT_ENV)
1150 /* Using ino64_t here so that user level debugging programs compile
1151  * the size correctly.
1152  */
1153 typedef ino64_t afs_ufs_dcache_id_t;
1154 #elif defined(AFS_LINUX26_ENV)
1155 #define MAX_FH_LEN 10
1156 typedef union {
1157 #if defined(NEW_EXPORT_OPS)
1158     struct fid fh;
1159 #endif
1160     __u32 raw[MAX_FH_LEN];
1161 } afs_ufs_dcache_id_t;
1162 extern int cache_fh_type;
1163 extern int cache_fh_len;
1164 #elif defined(AFS_LINUX_64BIT_KERNEL) && !defined(AFS_S390X_LINUX24_ENV)
1165 typedef long afs_ufs_dcache_id_t;
1166 #elif defined(AFS_AIX51_ENV) || defined(AFS_HPUX1123_ENV)
1167 typedef ino_t afs_ufs_dcache_id_t;
1168 #else
1169 typedef afs_int32 afs_ufs_dcache_id_t;
1170 #endif
1171
1172 typedef afs_int32 afs_mem_dcache_id_t;
1173
1174 typedef union {
1175     afs_ufs_dcache_id_t ufs;
1176     afs_mem_dcache_id_t mem;
1177 } afs_dcache_id_t;
1178
1179 /* it does not compile outside kernel */
1180 struct buffer {
1181   afs_int32 fid;              /* is adc->index, the cache file number */
1182   afs_dcache_id_t inode;          /* is adc->f.inode, the inode number of the cac\
1183                                  he file */
1184   afs_int32 page;
1185   afs_int32 accesstime;
1186   struct buffer *hashNext;
1187   char *data;
1188   char lockers;
1189   char dirty;
1190   char hashIndex;
1191   afs_rwlock_t lock;          /* the lock for this structure */
1192 };
1193
1194 /* kept on disk and in dcache entries */
1195 struct fcache {
1196     struct VenusFid fid;        /* Fid for this file */
1197     afs_int32 modTime;          /* last time this entry was modified */
1198     afs_hyper_t versionNo;      /* Associated data version number */
1199     afs_int32 chunk;            /* Relative chunk number */
1200     afs_dcache_id_t inode;              /* Unix inode for this chunk */
1201     afs_int32 chunkBytes;       /* Num bytes in this chunk */
1202     char states;                /* Has this chunk been modified? */
1203 };
1204
1205 /* magic numbers to specify the cache type */
1206
1207 #define AFS_FCACHE_TYPE_UFS 0x0
1208 #define AFS_FCACHE_TYPE_MEM 0x1
1209 #define AFS_FCACHE_TYPE_NFS 0x2
1210 #define AFS_FCACHE_TYPE_EPI 0x3
1211
1212 /* kept in memory */
1213 struct dcache {
1214     struct afs_q lruq;          /* Free queue for in-memory images */
1215     struct afs_q dirty;         /* Queue of dirty entries that need written */
1216     afs_rwlock_t lock;          /* Protects validPos, some f */
1217     afs_rwlock_t tlock;         /* Atomizes updates to refCount */
1218     afs_rwlock_t mflock;        /* Atomizes accesses/updates to mflags */
1219     afs_size_t validPos;        /* number of valid bytes during fetch */
1220     afs_int32 index;            /* The index in the CacheInfo file */
1221     short refCount;             /* Associated reference count. */
1222     char dflags;                /* Data flags */
1223     char mflags;                /* Meta flags */
1224     struct fcache f;            /* disk image */
1225     afs_int32 bucket;           /* which bucket these dcache entries are in */
1226     /*
1227      * Locking rules:
1228      *
1229      * dcache.lock protects the actual contents of the cache file (in
1230      * f.inode), subfields of f except those noted below, dflags and
1231      * validPos.
1232      *
1233      * dcache.tlock is used to make atomic updates to refCount.  Zero
1234      * refCount dcache entries are protected by afs_xdcache instead of
1235      * tlock.
1236      *
1237      * dcache.mflock is used to access and update mflags.  It cannot be
1238      * held without holding the corresponding dcache.lock.  Updating
1239      * mflags requires holding dcache.lock(R) and dcache.mflock(W), and
1240      * checking for mflags requires dcache.lock(R) and dcache.mflock(R).
1241      * Note that dcache.lock(W) gives you the right to update mflags,
1242      * as dcache.mflock(W) can only be held with dcache.lock(R).
1243      *
1244      * dcache.index, dcache.f.fid, dcache.f.chunk and dcache.f.inode are
1245      * write-protected by afs_xdcache and read-protected by refCount.
1246      * Once an entry is referenced, these values cannot change, and if
1247      * it's on the free list (with refCount=0), it can be reused for a
1248      * different file/chunk.  These values can only be written while
1249      * holding afs_xdcache(W) and allocating this dcache entry (thereby
1250      * ensuring noone else has a refCount on it).
1251      */
1252 };
1253
1254 /* afs_memcache.c */
1255 struct memCacheEntry {
1256   int size;                   /* # of valid bytes in this entry */
1257   int dataSize;               /* size of allocated data area */
1258   afs_lock_t afs_memLock;
1259   char *data;                 /* bytes */
1260 };
1261
1262 struct afs_FetchOutput {
1263     struct AFSVolSync tsync;
1264     struct AFSFetchStatus OutStatus;
1265     struct AFSCallBack CallBack;
1266 };
1267
1268 /* macro to mark a dcache entry as bad */
1269 #define ZapDCE(x) \
1270     do { \
1271         (x)->f.fid.Fid.Unique = 0; \
1272         afs_indexUnique[(x)->index] = 0; \
1273         (x)->dflags |= DFEntryMod; \
1274     } while(0)
1275
1276 /* FakeOpen and Fake Close used to be real subroutines.  They're only used in
1277  * sun_subr and afs_vnodeops, and they're very frequently called, so I made
1278  * them into macros.  They do:
1279  * FakeOpen:  fake the file being open for writing.  avc->lock must be held
1280  * in write mode.  Having the file open for writing is like having a DFS
1281  * write-token: you're known to have the best version of the data around,
1282  * and so the CM won't let it be overwritten by random server info.
1283  * FakeClose:  undo the effects of FakeOpen, noting that we want to ensure
1284  * that a real close eventually gets done.  We use CCore to achieve this if
1285  * we would end up closing the file.  avc->lock must be held in write mode */
1286
1287 #ifdef AFS_AIX_IAUTH_ENV
1288 #define CRKEEP(V, C)  (V)->linkData = (char*)crdup((C))
1289 #else
1290 #define CRKEEP(V, C)  crhold((C)); (V)->linkData = (char*)(C)
1291 #endif
1292
1293 #define afs_FakeOpen(avc) { avc->opens++; avc->execsOrWriters++; }
1294 #define afs_FakeClose(avc, acred) \
1295 { if (avc->execsOrWriters == 1) {  \
1296         /* we're the last writer, just use CCore flag */   \
1297         avc->f.states |= CCore; /* causes close to be called later */ \
1298                                                                       \
1299         /* The cred and vnode holds will be released in afs_FlushActiveVcaches */  \
1300         AFS_FAST_HOLD(avc);     /* So it won't disappear */           \
1301         CRKEEP(avc, acred); /* Should use a better place for the creds */ \
1302     }                                                                         \
1303     else {                                                                    \
1304         /* we're not the last writer, let the last one do the store-back for us */    \
1305         avc->opens--;                                                         \
1306         avc->execsOrWriters--;                                                \
1307     }                                                                         \
1308 }
1309
1310 #define AFS_ZEROS   64          /* zero buffer */
1311
1312 /*#define afs_DirtyPages(avc)   (((avc)->f.states & CDirty) || osi_VMDirty_p((avc)))*/
1313 #define afs_DirtyPages(avc)     ((avc)->f.states & CDirty)
1314
1315 #define afs_InReadDir(avc) (((avc)->f.states & CReadDir) && (avc)->readdir_pid == MyPidxx2Pid(MyPidxx))
1316
1317 /* The PFlush algorithm makes use of the fact that Fid.Unique is not used in
1318   below hash algorithms.  Change it if need be so that flushing algorithm
1319   doesn't move things from one hash chain to another
1320 */
1321 /* extern int afs_dhashsize; */
1322 #define DCHash(v, c)    ((((v)->Fid.Vnode + (v)->Fid.Volume + (c))) & (afs_dhashsize-1))
1323         /*Vnode, Chunk -> Hash table index */
1324 #define DVHash(v)       ((((v)->Fid.Vnode + (v)->Fid.Volume )) & (afs_dhashsize-1))
1325         /*Vnode -> Other hash table index */
1326 /* don't hash on the cell, our callback-breaking code sometimes fails to compute
1327     the cell correctly, and only scans one hash bucket */
1328 #define VCHash(fid)     (((fid)->Fid.Volume + (fid)->Fid.Vnode) & (VCSIZE-1))
1329 /* Hash only on volume to speed up volume callbacks. */
1330 #define VCHashV(fid) ((fid)->Fid.Volume & (VCSIZE-1))
1331
1332 extern struct dcache **afs_indexTable;  /*Pointers to in-memory dcache entries */
1333 extern afs_int32 *afs_indexUnique;      /*dcache entry Fid.Unique */
1334 extern afs_int32 *afs_dvnextTbl;        /*Dcache hash table links */
1335 extern afs_int32 *afs_dcnextTbl;        /*Dcache hash table links */
1336 extern afs_int32 afs_cacheFiles;        /*Size of afs_indexTable */
1337 extern afs_int32 afs_cacheBlocks;       /*1K blocks in cache */
1338 extern afs_int32 afs_cacheStats;        /*Stat entries in cache */
1339 extern struct vcache *afs_vhashT[VCSIZE];       /*Stat cache hash table */
1340 extern struct afs_q afs_vhashTV[VCSIZE]; /* cache hash table on volume */
1341 extern afs_int32 afs_initState; /*Initialization state */
1342 extern afs_int32 afs_termState; /* Termination state */
1343 extern struct VenusFid afs_rootFid;     /*Root for whole file system */
1344 extern afs_int32 afs_allCBs;    /* Count of callbacks */
1345 extern afs_int32 afs_oddCBs;    /* Count of odd callbacks */
1346 extern afs_int32 afs_evenCBs;   /* Count of even callbacks */
1347 extern afs_int32 afs_allZaps;   /* Count of fid deletes */
1348 extern afs_int32 afs_oddZaps;   /* Count of odd fid deletes */
1349 extern afs_int32 afs_evenZaps;  /* Count of even fid deletes */
1350 extern struct brequest afs_brs[NBRS];   /* request structures */
1351
1352 #define UHash(auid)     ((auid) & (NUSERS-1))
1353 #define VHash(avol)     ((avol)&(NVOLS-1))
1354 #define SHash(aserv)    ((ntohl(aserv)) & (NSERVERS-1))
1355 #define FVHash(acell,avol)  (((avol)+(acell)) & (NFENTRIES-1))
1356
1357 /* Performance hack - we could replace VerifyVCache2 with the appropriate
1358  * GetVCache incantation, and could eliminate even this code from afs_UFSRead
1359  * by making intentionally invalidating quick.stamp in the various callbacks
1360  * expiration/breaking code */
1361 #ifdef AFS_DARWIN_ENV
1362 #define afs_VerifyVCache(avc, areq)  \
1363   (((avc)->f.states & CStatd) ? (osi_VM_Setup(avc, 0), 0) : \
1364    afs_VerifyVCache2((avc),areq))
1365 #else
1366 #define afs_VerifyVCache(avc, areq)  \
1367   (((avc)->f.states & CStatd) ? 0 : afs_VerifyVCache2((avc),areq))
1368 #endif
1369
1370 #define DO_STATS 1              /* bits used by FindVCache */
1371 #define DO_VLRU 2
1372 #define IS_SLOCK 4
1373 #define IS_WLOCK 8
1374
1375 /* values for adown value of afs_LoopServers */
1376 #define AFS_LS_UP 0
1377 #define AFS_LS_DOWN 1
1378 #define AFS_LS_ALL 2
1379
1380 /* values for flag param of afs_CheckVolumeNames */
1381 #define AFS_VOLCHECK_EXPIRED    0x1     /* volumes whose callbacks have expired */
1382 #define AFS_VOLCHECK_BUSY       0x2     /* volumes which were marked busy */
1383 #define AFS_VOLCHECK_MTPTS      0x4     /* mount point invalidation also */
1384 #define AFS_VOLCHECK_FORCE      0x8     /* do all forcibly */
1385
1386 #endif /* KERNEL */
1387
1388 #define AFS_FSPORT          ((unsigned short) htons(7000))
1389 #define AFS_VLPORT          ((unsigned short) htons(7003))
1390 #define AFS_RXOSDPORT       ((unsigned short) htons(7011))
1391
1392 #define afs_rdwr(avc, uio, rw, io, cred) \
1393     (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 0) : afs_read(avc, uio, cred, 0))
1394 #define afs_nlrdwr(avc, uio, rw, io, cred) \
1395     (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 1) : afs_read(avc, uio, cred, 1))
1396
1397 /* Cache size truncation uses the following low and high water marks:
1398  * If the cache is more than 90% full by space (CM_DCACHESPACEFREEPCT) or
1399  * 95% full by # of chunks (CM_DCACHECOUNTFREEPCT), the cache truncation
1400  * daemon is awakened and will start freeing space. The cache truncation
1401  * daemon will continue to free space until the cache is at most 85% full
1402  * by space (CM_DCACHESPACEFREEPCT - CM_DCACHEEXTRAPCT). The cache truncation
1403  * daemon will also try to free space until the cache is at most 90% full by
1404  * chunks (CM_DCACHECOUNTFREEPCT - CM_DCACHEEXTRAPCT), but the 85% space limit
1405  * is the only limit that we must hit.
1406  * afs_UFSWrite and afs_GetDCache (when it needs to fetch data) will wait on
1407  * afs_WaitForCacheDrain if the cache is 98% (CM_WAITFORDRAINPCT) full.
1408  * afs_GetDownD wakes those processes once the cache is 95% full
1409  * (CM_CACHESIZEDRAINEDPCT).
1410  */
1411 #define CM_MAXDISCARDEDCHUNKS   16      /* # of chunks */
1412 #define CM_DCACHECOUNTFREEPCT   95      /* max pct of chunks in use */
1413 #define CM_DCACHESPACEFREEPCT   90      /* max pct of space in use */
1414 #define CM_DCACHEEXTRAPCT        5      /* extra to get when freeing */
1415 #define CM_CACHESIZEDRAINEDPCT  95      /* wakeup processes when down to here. */
1416 #define CM_WAITFORDRAINPCT      98      /* sleep if cache is this full. */
1417
1418 /* when afs_cacheBlocks is large, settle for slightly decreased precision */
1419 #define PERCENT(p, v) \
1420     ((afs_cacheBlocks & 0xffe00000) ? ((v) / 100 * (p)) : ((p) * (v) / 100))
1421
1422 #define afs_CacheIsTooFull() \
1423     (afs_blocksUsed - afs_blocksDiscarded > \
1424         PERCENT(CM_DCACHESPACEFREEPCT, afs_cacheBlocks) || \
1425      afs_freeDCCount - afs_discardDCCount < \
1426         PERCENT(100 - CM_DCACHECOUNTFREEPCT, afs_cacheFiles))
1427
1428 /* Handy max length of a numeric string. */
1429 #define CVBS    12              /* max afs_int32 is 2^32 ~ 4*10^9, +1 for NULL, +luck */
1430
1431 #define refpanic(foo) if (afs_norefpanic) \
1432         { printf( foo ); afs_norefpanic++;} else osi_Panic( foo )
1433
1434 /*
1435 ** these are defined in the AIX source code sys/fs_locks.h but are not
1436 ** defined anywhere in the /usr/include directory
1437 */
1438 #if     defined(AFS_AIX41_ENV)
1439 #define VN_LOCK(vp)             simple_lock(&(vp)->v_lock)
1440 #define VN_UNLOCK(vp)           simple_unlock(&(vp)->v_lock)
1441 #endif
1442
1443 /* get a file's serial number from a vnode */
1444 #ifndef afs_vnodeToInumber
1445 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1446 #define afs_vnodeToInumber(V) VnodeToIno(V)
1447 #else
1448 #define afs_vnodeToInumber(V) (VTOI(V)->i_number)
1449 #endif /* AFS_SGI62_ENV */
1450 #endif
1451
1452 /* get a file's device number from a vnode */
1453 #ifndef afs_vnodeToDev
1454 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1455 #define afs_vnodeToDev(V) VnodeToDev(V)
1456 #elif defined(UKERNEL)
1457 #define afs_vnodeToDev(V) (VTOI(V) ? (VTOI(V)->i_dev) : (-1))
1458 #else
1459 #define afs_vnodeToDev(V) (VTOI(V)->i_dev)
1460 #endif
1461 #endif
1462
1463 /* declare something so that prototypes don't flip out */
1464 /* appears struct buf stuff is only actually passed around as a pointer,
1465    except with libuafs, in which case it is actually defined */
1466
1467 struct buf;
1468
1469 struct rxfs_storeVariables {
1470     struct rx_call *call;
1471     struct vcache *vcache;
1472     char *tbuffer;
1473     struct iovec *tiov;
1474     afs_int32 tnio;
1475     afs_int32 hasNo64bit;
1476     struct AFSStoreStatus InStatus;
1477 };
1478
1479 struct storeOps {
1480     int (*prepare)(void *rock, afs_uint32 size, afs_uint32 *bytestoxfer);
1481     int (*read)(void *rock, struct osi_file *tfile, afs_uint32 offset,
1482         afs_uint32 tlen, afs_uint32 *bytesread);
1483     int (*write)(void *rock, afs_uint32 tlen, afs_uint32 *byteswritten);
1484     int (*status)(void *rock);
1485     int (*padd)(void *rock, afs_uint32 tlen);
1486     int (*close)(void *rock, struct AFSFetchStatus *OutStatus,
1487         afs_int32 *doProcessFS);
1488     int (*destroy)(void **rock, afs_int32 error);
1489     int (*storeproc)(struct storeOps *, void *, struct dcache *, int *,
1490                      afs_size_t *);
1491 };
1492
1493 struct fetchOps {
1494     int (*more)(void *rock, afs_int32 *length, afs_uint32 *moredata);
1495     int (*read)(void *rock, afs_uint32 tlen, afs_uint32 *bytesread);
1496     int (*write)(void *rock, struct osi_file *fp, afs_uint32 offset,
1497         afs_uint32 tlen, afs_uint32 *byteswritten);
1498     int (*close)(void *rock, struct vcache *avc, struct dcache *adc,
1499         struct afs_FetchOutput *Outputs);
1500     int (*destroy)(void **rock, afs_int32 error);
1501 };
1502
1503 /* fakestat support: opaque storage for afs_EvalFakeStat to remember
1504  * what vcache should be released.
1505  */
1506 struct afs_fakestat_state {
1507     char valid;
1508     char did_eval;
1509     char need_release;
1510     struct vcache *root_vp;
1511 };
1512
1513 extern int afs_fakestat_enable;
1514 extern int afs_rmtsys_enable;
1515 extern int afsd_dynamic_vcaches;
1516
1517 /*
1518  * Wrappers for access to credentials structure members
1519  * Linux uses the kernel cred structure if available, with the
1520  * wrappers defined in LINUX/osi_machdep.h
1521  */
1522 #if defined(AFS_NBSD40_ENV)
1523 /* in osi_machdep.h as expected */
1524 #elif defined (AFS_DARWIN110_ENV)
1525 #define afs_cr_uid(cred) kauth_cred_getuid((kauth_cred_t)(cred))
1526 #define afs_cr_gid(cred) kauth_cred_getgid((kauth_cred_t)(cred))
1527 #elif !(defined(AFS_LINUX26_ENV) && defined(STRUCT_TASK_STRUCT_HAS_CRED))
1528 #define afs_cr_uid(cred) ((cred)->cr_uid)
1529 #define afs_cr_gid(cred) ((cred)->cr_gid)
1530 #if !defined(AFS_OBSD_ENV)
1531 #define afs_cr_ruid(cred) ((cred)->cr_ruid)
1532 #define afs_cr_rgid(cred) ((cred)->cr_rgid)
1533 #endif
1534
1535 #if !defined(AFS_DARWIN110_ENV)
1536 static_inline void
1537 afs_set_cr_uid(afs_ucred_t *cred, uid_t uid) {
1538     cred->cr_uid = uid;
1539 }
1540 static_inline void
1541 afs_set_cr_gid(afs_ucred_t *cred, gid_t gid) {
1542     cred->cr_gid = gid;
1543 }
1544 #if !defined(AFS_OBSD_ENV)
1545 static_inline void
1546 afs_set_cr_ruid(afs_ucred_t *cred, uid_t uid) {
1547     cred->cr_ruid = uid;
1548 }
1549 static_inline void
1550 afs_set_cr_rgid(afs_ucred_t *cred, gid_t gid) {
1551     cred->cr_rgid = gid;
1552 }
1553 #endif /* ! AFS_OBSD_ENV */
1554 #endif /* ! AFS_DARWIN110_ENV */
1555 #endif
1556
1557 #ifdef AFS_SUN5_ENV
1558
1559 /** The 32 bit OS expects the members of this structure to be 32 bit
1560  * quantities and the 64 bit OS expects them as 64 bit quanties. Hence
1561  * to accomodate both, *long* is used instead of afs_int32
1562  */
1563
1564 struct afssysa {
1565     long syscall;
1566     long parm1;
1567     long parm2;
1568     long parm3;
1569     long parm4;
1570     long parm5;
1571     long parm6;
1572 };
1573 extern int Afs_syscall(struct afssysa *uap, rval_t *rvp);
1574 #endif /* AFS_SUN5_ENV */
1575
1576 /*
1577  * Various definitions for osi_sleep and its event hash table
1578  * DFBSD and SUNOS have no osi_sleep, and HPUX has its own hack for this stuff
1579  */
1580 #define AFS_EVHASHSIZE  128     /* size of afs_evhasht, must be power of 2 */
1581
1582 typedef struct afs_event {
1583     struct afs_event *next;     /* next in hash chain */
1584     char *event;                /* lwp event: an address */
1585     int refcount;               /* Is it in use? */
1586     int seq;                    /* Sequence number: this is incremented
1587                                  * by wakeup calls; wait will not return until
1588                                  * it changes */
1589 #if defined(AFS_AIX_ENV)
1590     tid_t cond;
1591 #elif defined(AFS_DARWIN_ENV)
1592 # ifdef AFS_DARWIN80_ENV
1593     lck_mtx_t *lck;
1594     thread_t owner;
1595 # endif
1596     /* no cond member */
1597 #elif defined(AFS_FBSD_ENV) || defined(AFS_OBSD_ENV)
1598     int cond;                   /* "all this gluck should probably be replaced by CVs" */
1599 #elif defined(AFS_LINUX24_ENV)
1600     wait_queue_head_t cond;
1601 #elif defined(AFS_NBSD_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
1602     kcondvar_t cond;            /* Currently associated condition variable */
1603 #endif
1604 } afs_event_t;
1605
1606 extern afs_event_t *afs_evhasht[AFS_EVHASHSIZE];        /* Hash table for events */
1607
1608 #endif /* _AFS_H_ */