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