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