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