src/afs/afs.h

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