/cygdrive/c/src/openafs/openafs.git/repo/src/afs/afs.h

/*
 * Copyright 2000, International Business Machines Corporation and others.
 * All Rights Reserved.
 *
 * This software has been released under the terms of the IBM Public
 * License.  For details, see the LICENSE file in the top-level source
 * directory or online at http://www.openafs.org/dl/license10.html
 */

#ifndef _AFS_H_
#define _AFS_H_
/*
 * AFS system call opcodes
 */
#ifdef KDUMP_KERNEL
#include <afs/afs_args.h>
#include <afs/afs_consts.h>
#else
#include "afs/afs_args.h"
#include "afs/afs_consts.h"
#endif

/*
 * afs_fsfragsize cannot be less than 1023, or some cache-tracking
 * calculations will be incorrect (since we track cache usage in kb).
 * Some filesystems have fundamental blocksizes less than 1k, and
 * normally we would tune afs_fsfragsize to be fragsize-1, but we must
 * make sure to check that afs_fsfragsize does not go below this value.
 */
#define AFS_MIN_FRAGSIZE 1023

/* Upper bound on number of iovecs out uio routines will deal with. */
#define AFS_MAXIOVCNT       16


extern int afs_shuttingdown;

/*
 * Macros to uniquely identify the AFS vfs struct
 */
#define AFS_VFSMAGIC            0x1234
#if defined(AFS_SUN5_ENV) || defined(AFS_HPUX90_ENV) || defined(AFS_LINUX20_ENV)
#define AFS_VFSFSID             99
#else
#if defined(AFS_SGI_ENV)
#define AFS_VFSFSID             afs_fstype
#else
#define AFS_VFSFSID             AFS_MOUNT_AFS
#endif
#endif

/* Moved from VNOPS/afs_vnop_flocks so can be used in prototypes */
#if     defined(AFS_HPUX102_ENV)
#define AFS_FLOCK       k_flock
#else
#if     defined(AFS_SUN5_ENV) || (defined(AFS_LINUX24_ENV) && !(defined(AFS_LINUX26_ENV) && defined(AFS_LINUX_64BIT_KERNEL)))
#define AFS_FLOCK       flock64
#else
#define AFS_FLOCK       flock
#endif /* AFS_SUN65_ENV */
#endif /* AFS_HPUX102_ENV */

/* The following are various levels of afs debugging */
#define AFSDEB_GENERAL          1       /* Standard debugging */
#define AFSDEB_NETWORK          2       /* low level afs networking */
#define AFSDEB_RX               4       /* RX debugging */
#define AFSDEB_VNLAYER          8       /* interface layer to AFS (aixops, gfsops, etc) */

/* generic undefined vice id */
#define UNDEFVID            (-1)

/* The basic defines for the Andrew file system
    better keep things powers of two so "& (foo-1)" hack works for masking bits */
#define NBRS            15      /* max number of queued daemon requests */
#define NUSERS          16      /* hash table size for unixuser table */
#define NSERVERS        16      /* hash table size for server table */
#define NVOLS           64      /* hash table size for volume table */
#define NFENTRIES       256     /* hash table size for disk volume table */
#define VCSIZE         1024     /* stat cache hash table size */
#define DCSIZE          512     /* disk cache hash table size */
#define CBRSIZE         512     /* call back returns hash table size */
#define PIGGYSIZE       1350    /* max piggyback size */
#define MAXVOLS         128     /* max vols we can store */
#define MAXSYSNAME      128     /* max sysname (i.e. @sys) size */
#define MAXNUMSYSNAMES  32      /* max that current constants allow */
#define NOTOKTIMEOUT    (2*3600)        /* time after which to timeout conns sans tokens */
#define NOPAG           0xffffffff



#define AFS_MAXCBRSCALL 32      /* max to return in a given call (must be <= AFSCBMAX) */
#define AFS_SALLOC_LOW_WATER    250     /* Min free blocks before allocating more */
#define AFS_LRALLOCSIZ  4096    /* "Large" allocated size */
#define VCACHE_FREE     5
#define AFS_NRXPACKETS  80
#define AFS_RXDEADTIME  50
#define AFS_HARDDEADTIME        120
#define AFS_IDLEDEADTIME        1200
#define AFS_IDLEDEADTIME_REP    180 /* more than fs's cb dead time */
#define AFS_BLKBITS     12
#define AFS_BLKSIZE     (1 << AFS_BLKBITS)

extern afs_int32 afs_rx_deadtime;
extern afs_int32 afs_rx_harddead;
extern afs_int32 afs_rx_idledead;
extern afs_int32 afs_rx_idledead_rep;

struct sysname_info {
    char *name;
    short offset;
    signed char index, allocked;
};

/* flags to use with AFSOP_CACHEINIT */
#define AFSCALL_INIT_MEMCACHE        0x1        /* use a memory-based cache */

/* below here used only for kernel procedures */
#ifdef KERNEL
/* Store synchrony flags - SYNC means that data should be forced to server's
 * disk immediately upon completion. */
#define AFS_ASYNC       0
#define AFS_SYNC        1
#define AFS_VMSYNC_INVAL 2      /* sync and invalidate pages */
#define AFS_LASTSTORE   4
#define AFS_VMSYNC      8       /* sync pages but do not invalidate */

/* background request structure */
#define BPARMS          4

#define BOP_NOOP        0       /* leave 0 unused */
#define BOP_FETCH       1       /* parm1 is chunk to get */
#define BOP_STORE       2       /* parm1 is chunk to store */
#define BOP_PATH        3       /* parm1 is path, parm2 is chunk to fetch */
#define BOP_FETCH_NOCACHE       4   /* parms are: vnode ptr, offset, segment ptr, addr, cred ptr */
#ifdef AFS_DARWIN_ENV
#define BOP_MOVE        5        /* ptr1 afs_uspc_param ptr2 sname ptr3 dname */
#endif

#define B_DONTWAIT      1       /* On failure return; don't wait */

/* protocol is: refCount is incremented by user to take block out of free pool.
    Next, BSTARTED is set when daemon finds request.  This prevents
    other daemons from picking up the same request.  Finally, when
    request is done, refCount is zeroed.  BDONE and BWAIT are used by
    dudes waiting for operation to proceed to a certain point before returning.
*/
#define BSTARTED        1       /* request picked up by a daemon */
#define BUVALID         2       /* code is valid (store) */
#define BUWAIT          4       /* someone is waiting for BUVALID */
struct brequest {
    struct vcache *vc;          /* vnode to use, with vrefcount bumped */
    afs_ucred_t *cred;  /* credentials to use for operation */
    afs_size_t size_parm[BPARMS];       /* random parameters */
    void *ptr_parm[BPARMS];     /* pointer parameters */
    afs_int32 code;             /* return code */
    short refCount;             /* use counter for this structure */
    char opcode;                /* what to do (store, fetch, etc) */
    char flags;                 /* free, etc */
    afs_int32 ts;               /* counter "timestamp" */
};

struct SecretToken {
    char data[56];
};

struct ClearToken {
    afs_int32 AuthHandle;
    char HandShakeKey[8];
    afs_int32 ViceId;
    afs_int32 BeginTimestamp;
    afs_int32 EndTimestamp;
};

struct VenusFid {
    afs_int32 Cell;             /* better sun packing if at end of structure */
    struct AFSFid Fid;
};

/* 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!) */
struct SmallFid {
    afs_int32 Volume;
    afs_int32 CellAndUnique;
    u_short Vnode;
};
/* The actual number of bytes in the SmallFid, not the sizeof struct. */
#define SIZEOF_SMALLFID 10

/* Queues
 * ------
 *
 *  Circular queues, implemented with pointers. Structures may contain as many
 *  queues as required, which may be located at any point within the structure,
 *  providing the QEntry macro is used to translate between a queue pointer, and
 *  the address of its containing structure
 */

struct afs_q {
    struct afs_q *next;
    struct afs_q *prev;
};

#define QZero(e)    ((e)->prev = (e)->next = NULL)
#define QInit(q)    ((q)->prev = (q)->next = (q))
#define QAdd(q,e)   ((e)->next = (q)->next, (e)->prev = (q), \
                        (q)->next->prev = (e), (q)->next = (e))
#define QRemove(e)  ((e)->next->prev = (e)->prev, (e)->prev->next = (e)->next, (e)->prev = NULL, (e)->next = NULL)
#define QNext(e)    ((e)->next)
#define QPrev(e)    ((e)->prev)
#define QEmpty(q)   ((q)->prev == (q))
/* this one takes q1 and sticks it on the end of q2 - that is, the other end, not the end
 * that things are added onto.  q1 shouldn't be empty, it's silly */
#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))

/* Given a pointer to an afs_q within a structure, go back to the address of
 * the parent structure
 */

#define QEntry(queue, structure, member) \
        ((structure *)((char *)(queue)-(char *)(&((structure *)NULL)->member)))

/* And implement operations for individual lists in terms of the above macro */

#define QTOV(e)     QEntry(e, struct vcache, vlruq)
#define QTOC(e)     QEntry(e, struct cell, lruq)
#define QTOVH(e)    QEntry(e, struct vcache, vhashq)

struct afs_slotlist {
    afs_uint32 slot;
    struct afs_slotlist *next;
};

struct vrequest {
    afs_int32 uid;              /* user id making the request */
    afs_int32 busyCount;        /* how many busies we've seen so far */
    afs_int32 flags;            /* things like O_SYNC, O_NONBLOCK go here */
    char initd;                 /* if non-zero, Error fields meaningful */
    char accessError;           /* flags for overriding error return code */
    char volumeError;           /* encountered a missing or busy volume */
    char networkError;          /* encountered network problems */
    char permWriteError;        /* fileserver returns permenent error. */
    char tokenError;            /* a token error other than expired. */
    char idleError;             /* the server idled too long */
    char skipserver[AFS_MAXHOSTS];
    afs_int32 lasterror[AFS_MAXHOSTS];
};
#define VOLMISSING 1
#define VOLBUSY 2

/* structure linked off of a server to keep track of queued returned
 * callbacks.  Sent asynchronously when we run a little low on free dudes.
 */
struct afs_cbr {
    struct afs_cbr **pprev;
    struct afs_cbr *next;

    struct afs_cbr **hash_pprev;
    struct afs_cbr *hash_next;

    struct AFSFid fid;
};

#ifdef AFS_LINUX22_ENV
/* On Linux, we have to be able to allocate the storage for this using
 * kmalloc, as otherwise we may deadlock. So, it needs to be able to fit
 * in a single page
 */
# define AFS_NCBRS      PAGE_SIZE/sizeof(struct afs_cbr)
#else
# define AFS_NCBRS      1024    /* max # of call back return entries */
#endif

/* cellinfo file magic number */
#define AFS_CELLINFO_MAGIC      0xf32817cd

/* cell flags */
#define CNoSUID                 0x02    /* disable suid bit for this cell */
#define CLinkedCell4            0x04    /* reserved for ADDCELL2 pioctl */
#define CNoAFSDB                0x08    /* never bother trying AFSDB */
#define CHasVolRef              0x10    /* volumes were referenced */
#define CLinkedCell             0x20    /* has a linked cell in lcellp */
#define CHush                   0x40    /* don't display until referenced */

struct cell {
    struct afs_q lruq;          /* lru q next and prev */
    char *cellName;             /* char string name of cell */
    afs_int32 cellIndex;        /* sequence number */
    afs_int32 cellNum;          /* semi-permanent cell number */
    struct server *cellHosts[AFS_MAXCELLHOSTS]; /* volume *location* hosts */
    struct cell *lcellp;        /* Associated linked cell */
    u_short fsport;             /* file server port */
    u_short vlport;             /* volume server port */
    short states;               /* state flags */
    time_t timeout;             /* data expire time, if non-zero */
    struct cell_name *cnamep;   /* pointer to our cell_name */
    afs_rwlock_t lock;          /* protects cell data */
    unsigned char cellHandle[16];       /* deterministic handle for this cell */
};

struct cell_name {
    struct cell_name *next;
    afs_int32 cellnum;
    char *cellname;
    char used;
};

struct cell_alias {
    struct cell_alias *next;
    afs_int32 index;
    char *alias;
    char *cell;
};

#define afs_PutCell(cellp, locktype)

/* the unixuser flag bit definitions */
#define UHasTokens      1       /* are the st and ct fields valid (ever set)? */
#define UTokensBad      2       /* are tokens bad? */
#define UPrimary        4       /* on iff primary identity */
#define UNeedsReset     8       /* needs afs_ResetAccessCache call done */
#define UPAGCounted    16       /* entry seen during PAG search (for stats) */
#define UNFSGetCreds   32       /* getting creds for NFS client */
/* A flag used by afs_GCPAGs to keep track of
 * which entries in afs_users need to be deleted.
 * The lifetime of its presence in the table is the
 * lifetime of the afs_GCPAGs function.
 */
#define TMP_UPAGNotReferenced   128

/* unixuser notify events */
#define UTokensObtained 1
#define UTokensDropped  2

/* values for afs_gcpags */
enum { AFS_GCPAGS_NOTCOMPILED = 0, AFS_GCPAGS_OK =
        1, AFS_GCPAGS_USERDISABLED, AFS_GCPAGS_EPROC0, AFS_GCPAGS_EPROCN,
    AFS_GCPAGS_EEQPID, AFS_GCPAGS_EINEXACT, AFS_GCPAGS_EPROCEND,
    AFS_GCPAGS_EPROCWALK, AFS_GCPAGS_ECREDWALK, AFS_GCPAGS_EPIDCHECK,
    AFS_GCPAGS_ENICECHECK
};

extern afs_int32 afs_gcpags;
extern afs_int32 afs_gcpags_procsize;
extern afs_int32 afs_bkvolpref;
extern char afs_cachebasedir[1024];
extern afs_int32 afs_numcachefiles;
extern afs_int32 afs_numfilesperdir;

struct rxkadToken {
    afs_int32 ticketLen;
    char * ticket;
    struct ClearToken clearToken;
};

union tokenUnion {
    struct rxkadToken rxkad;
};

struct tokenJar {
    struct tokenJar *next;
    int type;
    union tokenUnion content;
};

struct unixuser {
    struct unixuser *next;      /* next hash pointer */
    afs_int32 uid;              /* search based on uid and cell */
    afs_int32 cell;
    afs_int32 viceId;           /* Optional viced ID corresponding to current tokens */
    short refCount;             /* reference count for allocation */
    char states;                /* flag info */
    afs_int32 tokenTime;        /* last time tokens were set, used for timing out conn data */
    struct tokenJar *tokens;
    struct afs_exporter *exporter;      /* more info about the exporter for the remote user */
    void *cellinfo;             /* pointer to cell info (PAG manager only) */
    afs_rwlock_t lock;
};

#define CVEC_LEN 3 /* per-user connection pool */

struct sa_conn_vector;
typedef struct sa_conn_vector * p_sa_conn_vector; /* forward decl */

#define CONN_REPLICATED 0x1

struct afs_conn {
    int refCount;
    int activated;
    char forceConnectFS; /* Should we try again with these tokens? */
    struct rx_connection *id; /* RPC connid */
    struct sa_conn_vector *parent; /* the con_vector which contains us */
};

/* An sa_conn_vector replaces the erstwhile list of conn
   structures maintained by the cache manager.  The sa_conn_vector
   contains a C array of connections which, if non-zero, represent
   connections to AFS servers.
*/

struct sa_conn_vector {
    /* linked-list machinery */
    struct sa_conn_vector *next;

    /* AFS conn-identifying info */
    struct unixuser *user;      /* user validated with respect to. */
    struct srvAddr *srvr;       /* server associated with this conn */
    short refCount;             /* reference count for allocation */
    unsigned short port;        /* port associated with this connection */
    int flags;

    /* next connection to return when all in cvec are fully utilized */
    int select_index; 
    
    /* connections vector */
    struct afs_conn cvec[CVEC_LEN];
};

#define SQNULL -1

/* Fid comparison routines */
#define FidCmp(a,b) ((a)->Fid.Unique != (b)->Fid.Unique \
    || (a)->Fid.Vnode != (b)->Fid.Vnode \
    || (a)->Fid.Volume != (b)->Fid.Volume \
    || (a)->Cell != (b)->Cell)

#define FidMatches(afid,tvc) ((tvc)->f.fid.Fid.Vnode == (afid)->Fid.Vnode && \
        (tvc)->f.fid.Fid.Volume == (afid)->Fid.Volume && \
        (tvc)->f.fid.Cell == (afid)->Cell && \
        ( (tvc)->f.fid.Fid.Unique == (afid)->Fid.Unique || \
         (!(afid)->Fid.Unique && ((tvc)->f.states & CUnique))))


#define SRVADDR_MH      1
#define SRVADDR_ISDOWN  0x20    /* same as SRVR_ISDOWN */
#define  SRVADDR_NOUSE    0x40  /* Don't use this srvAddr */

struct srvAddr {
    struct srvAddr *next_bkt;   /* next item in hash bucket */
    struct srvAddr *next_sa;    /* another interface on same host */
    struct server *server;      /* back to parent */
    struct sa_conn_vector *conns;   /* All user connections to this server */
    struct afs_conn *natping;
    afs_int32 sa_ip;            /* Host addr in network byte order */
    u_short sa_iprank;          /* indiv ip address priority */
    u_short sa_portal;          /* port addr in network byte order */
    u_char sa_flags;
};

/*
 * Values used in the flags field of the server structure below.
 *
 *      AFS_SERVER_FLAG_ACTIVATED Has the server ever had a user connection
 *                                associated with it?
 */
#define AFS_SERVER_FLAG_ACTIVATED       0x01
#define SNO_LHOSTS                      0x04
#define SYES_LHOSTS                     0x08
#define SVLSRV_UUID                     0x10
#define SRVR_ISDOWN                     0x20
#define SRVR_MULTIHOMED                 0x40
#define SRVR_ISGONE                     0x80
#define SNO_INLINEBULK                  0x100
#define SNO_64BIT                       0x200
#define SCAPS_KNOWN                     0x400

#define SRV_CAPABILITIES(ts) \
{ if ( !(ts->flags & SCAPS_KNOWN)) afs_GetCapabilities(ts); ts->capabilities; }

#define afs_serverSetNo64Bit(s) (((struct sa_conn_vector*)(s)->parent)->srvr->server->flags |= SNO_64BIT)
#define afs_serverHasNo64Bit(s) (((struct sa_conn_vector*)(s)->parent)->srvr->server->flags & SNO_64BIT)

struct server {
    union {
        struct {
            afsUUID suuid;
            afs_int32 addr_uniquifier;
            afs_int32 spares[2];
        } _srvUuid;
        struct {
            struct srvAddr haddr;
        } _srvId;
    } _suid;
#define sr_uuid         _suid._srvUuid.suuid
#define sr_addr_uniquifier      _suid._srvUuid.addr_uniquifier
#define sr_host         _suid._srvId.haddr.ip
#define sr_portal       _suid._srvId.haddr.portal
#define sr_rank         _suid._srvId.haddr.ip_rank
#define sr_flags        _suid._srvId.haddr.flags
#define sr_conns        _suid._srvId.haddr.conns
    struct server *next;        /* Ptr to next server in hash chain */
    struct cell *cell;          /* Cell in which this host resides */
    struct afs_cbr *cbrs;       /* Return list of callbacks */
    afs_int32 activationTime;   /* Time when this record was first activated */
    afs_int32 lastDowntimeStart;        /* Time when last downtime incident began */
    afs_int32 numDowntimeIncidents;     /* # (completed) downtime incidents */
    afs_int32 sumOfDowntimes;   /* Total downtime experienced, in seconds */
    struct srvAddr *addr;
    afs_uint32 flags;           /* Misc flags */
    afs_int32 capabilities;
};

#define afs_PutServer(servp, locktype)

/* structs for some pioctls  - these are (or should be)
 * also in venus.h
 */
struct spref {
    struct in_addr host;
    unsigned short rank;
};

struct sprefrequest_33 {
    unsigned short offset;
    unsigned short num_servers;
};


struct sprefrequest {           /* new struct for 3.4 */
    unsigned short offset;
    unsigned short num_servers;
    unsigned short flags;
};
#define DBservers 1

struct sprefinfo {
    unsigned short next_offset;
    unsigned short num_servers;
    struct spref servers[1];    /* we overrun this array intentionally... */
};

struct setspref {
    unsigned short flags;
    unsigned short num_servers;
    struct spref servers[1];    /* we overrun this array intentionally... */
};
/* struct for GAG pioctl
 */
struct gaginfo {
    afs_uint32 showflags, logflags, logwritethruflag, spare[3];
    unsigned char spare2[128];
};
#define GAGUSER    1
#define GAGCONSOLE 2
#define logwritethruON  1

struct rxparams {
    afs_int32 rx_initReceiveWindow, rx_maxReceiveWindow, rx_initSendWindow,
        rx_maxSendWindow, rxi_nSendFrags, rxi_nRecvFrags, rxi_OrphanFragSize;
    afs_int32 rx_maxReceiveSize, rx_MyMaxSendSize;
    afs_uint32 spare[21];
};

/* struct for checkservers */

struct chservinfo {
    int magic;
    char tbuffer[128];
    int tsize;
    afs_int32 tinterval;
    afs_int32 tflags;
};


/* state bits for volume */
#define VRO                     1       /* volume is readonly */
#define VRecheck                2       /* recheck volume info with server */
#define VBackup                 4       /* is this a backup volume? */
#define VForeign                8       /* this is a non-afs volume */
#define VPartVisible            16      /* Volume's partition is visible on the client */
#define VHardMount              32      /* we are hard-mount waiting for the vol */

enum repstate { not_busy, end_not_busy = 6, rd_busy, rdwr_busy, offline };

struct volume {
    /* One structure per volume, describing where the volume is located
     * and where its mount points are. */
    struct volume *next;        /* Next volume in hash list. */
    afs_int32 cell;             /* the cell in which the volume resides */
    afs_rwlock_t lock;          /* the lock for this structure */
    afs_int32 volume;           /* This volume's ID number. */
    char *name;                 /* This volume's name, or 0 if unknown */
    struct server *serverHost[AFS_MAXHOSTS];    /* servers serving this volume */
    enum repstate status[AFS_MAXHOSTS]; /* busy, offline, etc */
    struct VenusFid dotdot;     /* dir to access as .. */
    struct VenusFid mtpoint;    /* The mount point for this volume. */
    afs_int32 rootVnode, rootUnique;    /* Volume's root fid */
    afs_int32 roVol;
    afs_int32 backVol;
    afs_int32 rwVol;            /* For r/o vols, original read/write volume. */
    afs_int32 accessTime;       /* last time we used it */
    afs_int32 vtix;             /* volume table index */
    afs_int32 copyDate;         /* copyDate field, for tracking vol releases */
    afs_int32 expireTime;       /* for per-volume callbacks... */
    short refCount;             /* reference count for allocation */
    char states;                /* here for alignment reasons */
};

#define afs_PutVolume(av, locktype) ((av)->refCount--)

/* format of an entry in volume info file */
struct fvolume {
    afs_int32 cell;             /* cell for this entry */
    afs_int32 volume;           /* volume */
    afs_int32 next;             /* has index */
    struct VenusFid dotdot;     /* .. value */
    struct VenusFid mtpoint;    /* mt point's fid */
    afs_int32 rootVnode, rootUnique;    /* Volume's root fid */
};

struct SimpleLocks {
    struct SimpleLocks *next;
    int type;
    afs_int32 boff, eoff;
    afs_int32 pid;
#if     defined(AFS_AIX32_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
    afs_int32 sysid;
#endif
};

/* vcache state bits */
#define CStatd          0x00000001      /* has this file ever been stat'd? */
#define CBackup         0x00000002      /* file is on a backup volume */
#define CRO             0x00000004      /* is it on a read-only volume */
#define CMValid         0x00000008      /* is the mount point info valid? */
#define CCore           0x00000010      /* storing a core file, needed since we don't get an open */
#define CDirty          0x00000020      /* file has been modified since first open (... O_RDWR) */
#define CSafeStore      0x00000040      /* close must wait for store to finish (should be in fd) */
#define CMAPPED         0x00000080      /* Mapped files; primarily used by SunOS 4.0.x */
#define CNSHARE         0x00000100      /* support O_NSHARE semantics */
#define CLied           0x00000200
#define CTruth          0x00000400

#if defined(AFS_DARWIN80_ENV)
#define CDeadVnode        0x00000800
#elif defined(AFS_DARWIN_ENV)
#define CUBCinit        0x00000800
#else
#define CWRITE_IGN      0x00000800      /* Next OS hack only */
#endif

#define CUnique         0x00001000      /* vc's uniquifier - latest unifiquier for fid */
#define CForeign        0x00002000      /* this is a non-afs vcache */
#define CReadDir        0x00004000      /* readdir in progress */
#define CUnlinked       0x00010000
#define CBulkStat       0x00020000      /* loaded by a bulk stat, and not ref'd since */
#define CUnlinkedDel    0x00040000
#define CVFlushed       0x00080000
#ifdef AFS_LINUX22_ENV
#define CPageWrite      0x00200000      /* to detect vm deadlock - linux */
#elif defined(AFS_SGI_ENV)
#define CWritingUFS     0x00200000      /* to detect vm deadlock - used by sgi */
#elif defined(AFS_DARWIN80_ENV)
#define CEvent          0x00200000      /* to preclude deadlock when sending events */
#endif
#define CCreating       0x00400000      /* avoid needless store after open truncate */
#define CPageHog        0x00800000      /* AIX - dumping large cores is a page hog. */
#define CDCLock         0x02000000      /* Vnode lock held over call to GetDownD */
#define CBulkFetching   0x04000000      /* stats are being fetched by bulk stat */
#define CExtendedFile   0x08000000      /* extended file via ftruncate call. */
#define CVInit          0x10000000      /* being initialized */
#define CMetaDirty      0x20000000      /* vnode meta-data needs to be flushed */
#define CPartVisible    0x40000000      /* fileserver partition visible on client */

/* vcache vstate bits */
#define VRevokeWait   0x1
#define VPageCleaning 0x2       /* Solaris - Cache Trunc Daemon sez keep out */

/* Dirty disconnected vcache flags. */
#define VDisconSetTime          0x00000001      /* set time. */
#define VDisconSetMode          0x00000002      /* set mode. */
/* XXX: to be continued ? */
#define VDisconTrunc            0x00000020      /* truncate file. */
#define VDisconSetAttrMask      0x0000003F      /* Masks for setattr ops. */
#define VDisconWriteClose       0x00000400      /* Write op on file close. */
#define VDisconWriteFlush       0x00000800      /* Write op on normal fsync/flush. */
#define VDisconWriteOsiFlush    0x00001000      /* Write op on osi flush. */

#define VDisconRemove           0x00002000      /* Remove vnop. */
#define VDisconCreate           0x00004000      /* Create vnop. */
#define VDisconCreated          0x00008000      /* A file that was created during
                                                   this resync operation */
#define VDisconRename           0x00010000      /* Rename vnop. */
#define VDisconRenameSameDir    0x00020000      /* Rename in same dir. */

/*... to be continued ...  */

/* vcache (file) cachingStates bits */
#define FCSDesireBypass   0x1   /* This file should bypass the cache */
#define FCSBypass         0x2   /* This file is currently NOT being cached */
#define FCSManuallySet    0x4   /* The bypass flags were set, or reset, manually (via pioctl)
                                                                   and should not be overridden by the file's name */

/* Flag values used by the Transition routines */
#define TRANSChangeDesiredBit           0x1     /* The Transition routine should set or
                                                                                 * reset the FCSDesireBypass bit */
#define TRANSVcacheIsLocked                     0x2     /* The Transition routine does not need to
                                                                                 * lock vcache (it's already locked) */
#define TRANSSetManualBit               0x4     /* The Transition routine should set FCSManuallySet so that
                                                                         * filename checking does not override pioctl requests */

#define CPSIZE      2
#if defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV)
#define vrefCount   v->v_usecount
#else
#define vrefCount   v.v_count
#endif /* AFS_XBSD_ENV */

#if defined(AFS_DARWIN80_ENV)
#define VREFCOUNT_GT(v, y)    vnode_isinuse(AFSTOV(v), (y))
#elif defined(AFS_FBSD_ENV)
#define VREFCOUNT(v)            (vrefcnt(AFSTOV(v)))
#define VREFCOUNT_GT(v, y)      (vrefcnt(AFSTOV(v)) > y)
#elif defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV)
#define VREFCOUNT(v)          ((v)->vrefCount)
#define VREFCOUNT_GT(v, y)    (AFSTOV(v)->v_usecount > (y))
#elif defined(AFS_LINUX24_ENV)
#define VREFCOUNT(v)            atomic_read(&(AFSTOV(v)->v_count))
#define VREFCOUNT_GT(v, y)      (VREFCOUNT(v)>y)
#define VREFCOUNT_SET(v, c)     atomic_set(&(AFSTOV(v)->v_count), c)
#define VREFCOUNT_DEC(v)        atomic_dec(&(AFSTOV(v)->v_count))
#define VREFCOUNT_INC(v)        atomic_inc(&(AFSTOV(v)->v_count))
#else
#define VREFCOUNT(v)            ((v)->vrefCount)
#define VREFCOUNT_GT(v,y)     ((v)->vrefCount > (y))
#define VREFCOUNT_SET(v, c)     (v)->vrefCount = c;
#define VREFCOUNT_DEC(v)        (v)->vrefCount--;
#define VREFCOUNT_INC(v)        (v)->vrefCount++;
#define d_unhash(d) list_empty(&(d)->d_hash)
#define dget_locked(d) dget(d)
#endif

#define AFS_MAXDV   0x7fffffff  /* largest dataversion number */
#ifdef AFS_64BIT_CLIENT
#define AFS_NOTRUNC 0x7fffffffffffffffLL        /* largest positive int64 number */
#else /* AFS_64BIT_CLIENT */
#define AFS_NOTRUNC 0x7fffffff  /* largest dataversion number */
#endif /* AFS_64BIT_CLIENT */

extern afs_int32 vmPageHog;     /* counter for # of vnodes which are page hogs. */

#if defined(AFS_DARWIN80_ENV)
#define VTOAFS(v) ((struct vcache *)vnode_fsnode((v)))
#define AFSTOV(vc) ((vc)->v)
#elif defined(AFS_NBSD40_ENV)
struct nbvdata {
    struct genfs_node gfsn;
    struct vcache *afsvc;
};
#define VTOAFS(v) ((((struct nbvdata *)((v)->v_data)))->afsvc)
#define AFSTOV(vc) ((vc)->v)
#elif defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV) || (defined(AFS_LINUX22_ENV) && !defined(STRUCT_SUPER_OPERATIONS_HAS_ALLOC_INODE))
#define VTOAFS(v) ((struct vcache *)(v)->v_data)
#define AFSTOV(vc) ((vc)->v)
#else
#define VTOAFS(V) ((struct vcache *)(V))
#define AFSTOV(V) (&(V)->v)
#endif

struct afs_vnuniq {
    afs_uint32 vnode;
    afs_uint32 unique;
};

/* VCache elements which are kept on disk, and in the kernel */
struct fvcache {
    struct VenusFid fid;
    struct mstat {
        afs_size_t Length;
        afs_hyper_t DataVersion;
        afs_uint32 Date;
        afs_uint32 Owner;
        afs_uint32 Group;
        afs_uint16 Mode;        /* XXXX Should be afs_int32 XXXX */
        afs_uint16 LinkCount;
#ifdef AFS_DARWIN80_ENV
        afs_uint16 Type;
#else
        /* vnode type is in v.v_type */
#endif
    } m;
    struct afs_vnuniq parent;

    afs_size_t truncPos;

    afs_int32 anyAccess;

    afs_uint32 states;

    afs_uint32 ddirty_flags;
    struct afs_vnuniq shadow;
    struct afs_vnuniq oldParent;
};

#ifdef AFS_SUN5_ENV
/*
 * This is for the multiPage field in struct vcache. Each one of these
 * represents an outstanding getpage request that is larger than a single page.
 * Recording these is necessary to prevent afs_GetOnePage from trying to evict
 * a dcache entry that an earlier afs_GetOnePage call got in the same getpage
 * request. See osi_VM_MultiPageConflict and afs_getpage.
 */
struct multiPage_range {
    struct afs_q q;
    offset_t off;    
    u_int len;       
};
#endif

/* INVARIANTs: (vlruq.next != NULL) == (vlruq.prev != NULL)
 *             nextfree => !vlruq.next && ! vlruq.prev
 * !(avc->nextfree) && !avc->vlruq.next => (FreeVCList == avc->nextfree)
 */
struct vcache {
#if defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV) || (defined(AFS_LINUX22_ENV) && !defined(STRUCT_SUPER_OPERATIONS_HAS_ALLOC_INODE))
    struct vnode *v;
#else
    struct vnode v;             /* Has reference count in v.v_count */
#endif
    struct afs_q vlruq;         /* lru q next and prev */
#if !defined(AFS_LINUX22_ENV)
    struct vcache *nextfree;    /* next on free list (if free) */
#endif
    struct vcache *hnext;       /* Hash next */
    struct afs_q vhashq;        /* Hashed per-volume list */
    struct afs_q dirtyq;
    struct afs_q shadowq;
    struct afs_q metadirty;
    afs_uint32 diskSlot;
    struct fvcache f;
    afs_rwlock_t lock;          /* The lock on the vcache contents. */
#if     defined(AFS_SUN5_ENV)
    /* Lock used to protect the activeV, multipage, and vstates fields.
     * Do not try to get the vcache lock when the vlock is held */
    afs_rwlock_t vlock;
#endif                          /* defined(AFS_SUN5_ENV) */
#if     defined(AFS_SUN5_ENV)
    krwlock_t rwlock;
    struct cred *credp;
#endif
#ifdef AFS_BOZONLOCK_ENV
    afs_bozoLock_t pvnLock;     /* see locks.x */
#endif
#ifdef  AFS_AIX32_ENV
    afs_lock_t pvmlock;
    vmhandle_t vmh;
#if defined(AFS_AIX51_ENV)
    vmid_t segid;
#else
    int segid;
#endif
    struct ucred *credp;
#endif
#ifdef AFS_AIX_ENV
    int ownslock;               /* pid of owner of excl lock, else 0 - defect 3083 */
#endif
#ifdef AFS_DARWIN80_ENV
    lck_mtx_t *rwlock;
#elif defined(AFS_DARWIN_ENV)
    struct lock__bsd__ rwlock;
#endif
#ifdef AFS_XBSD_ENV
#if !defined(AFS_DFBSD_ENV) && !defined(AFS_NBSD_ENV)
    struct lock rwlock;
#endif
#endif

    struct VenusFid *mvid;      /* Either parent dir (if root) or root (if mt pt) */
    char *linkData;             /* Link data if a symlink. */
    afs_hyper_t flushDV;        /* data version last flushed from text */
    afs_hyper_t mapDV;          /* data version last flushed from map */
    struct server *callback;    /* The callback host, if any */
    afs_uint32 cbExpires;       /* time the callback expires */
    struct afs_q callsort;      /* queue in expiry order, sort of */
    struct axscache *Access;    /* a list of cached access bits */
    afs_int32 last_looker;      /* pag/uid from last lookup here */
#if     defined(AFS_SUN5_ENV)
    afs_int32 activeV;
#endif                          /* defined(AFS_SUN5_ENV) */
    struct SimpleLocks *slocks;
    short opens;                /* The numbers of opens, read or write, on this file. */
    short execsOrWriters;       /* The number of execs (if < 0) or writers (if > 0) of
                                 * this file. */
    short flockCount;           /* count of flock readers, or -1 if writer */
    char mvstat;                /* 0->normal, 1->mt pt, 2->root. */

    char cachingStates;                 /* Caching policies for this file */
    afs_uint32 cachingTransitions;              /* # of times file has flopped between caching and not */

#if defined(AFS_LINUX24_ENV)
    off_t next_seq_offset;      /* Next sequential offset (used by prefetch/readahead) */
#elif defined(AFS_SUN5_ENV) || defined(AFS_SGI65_ENV)
    off_t next_seq_blk_offset; /* accounted in blocks for Solaris & IRIX */
#endif

#if     defined(AFS_SUN5_ENV)
    afs_uint32 vstates;         /* vstate bits */
#endif                          /* defined(AFS_SUN5_ENV) */
    struct dcache *dchint;
    struct dcache *dcreaddir;   /* dcache for in-progress readdir */
    unsigned int readdir_pid;   /* pid of the thread in readdir */
#if defined(AFS_SGI_ENV)
    daddr_t lastr;              /* for read-ahead */
#ifdef AFS_SGI64_ENV
    uint64_t vc_rwlockid;       /* kthread owning rwlock */
#else
    short vc_rwlockid;          /* pid of process owning rwlock */
#endif
    short vc_locktrips;         /* # of rwlock reacquisitions */
    sema_t vc_rwlock;           /* vop_rwlock for afs */
    pgno_t mapcnt;              /* # of pages mapped */
    struct cred *cred;          /* last writer's cred */
#ifdef AFS_SGI64_ENV
    struct bhv_desc vc_bhv_desc;        /* vnode's behavior data. */
#endif
#endif                          /* AFS_SGI_ENV */
#if defined(AFS_LINUX26_ENV)
    cred_t *cred;               /* last writer's cred */
#endif
#ifdef AFS_LINUX24_ENV
    struct dentry *target_link; /* dentry we prefer, when we are redirecting
                                 * all requests due to duplicate dentry aliases.
                                 * See LINUX/osi_vnodeops.c. Note that this is
                                 * NOT an actual reference to a dentry, so this
                                 * pointer MUST NOT be dereferenced on its own. */
#endif
    afs_int32 vc_error;         /* stash write error for this vnode. */
    int xlatordv;               /* Used by nfs xlator */
    afs_ucred_t *uncred;
    int asynchrony;             /* num kbytes to store behind */
#ifdef AFS_SUN5_ENV
    struct afs_q multiPage;     /* list of multiPage_range structs */
#endif
    int protocol;               /* RX_FILESERVER, RX_OSD, ... defined in afsint.xg */
#if !defined(UKERNEL)
    void *vpacRock;             /* used to read or write in visible partitions */
#endif
};

#define DONT_CHECK_MODE_BITS    0
#define CHECK_MODE_BITS         1
#define CMB_ALLOW_EXEC_AS_READ  2       /* For the NFS xlator */

#if defined(AFS_SGI_ENV)
#define AVCRWLOCK(avc)          (valusema(&(avc)->vc_rwlock) <= 0)

/* SGI vnode rwlock macros and flags. */
#ifndef AFS_SGI62_ENV
/* The following are defined here. SGI 6.2 declares them in vnode.h */
#define VRWLOCK_READ            0
#define VRWLOCK_WRITE           1
#define VRWLOCK_WRITE_DIRECT    2
#endif

#ifdef AFS_SGI53_ENV
#ifdef AFS_SGI62_ENV
#define AFS_RWLOCK_T vrwlock_t
#else
#define AFS_RWLOCK_T int
#endif /* AFS_SGI62_ENV */
#ifdef AFS_SGI64_ENV
#include <ksys/behavior.h>
#define AFS_RWLOCK(V,F) \
        afs_rwlock(&VTOAFS(V)->vc_bhv_desc, (F));
#define AFS_RWUNLOCK(V,F) \
        afs_rwunlock(&VTOAFS(V)->vc_bhv_desc, (F));

#else
#define AFS_RWLOCK(V,F) afs_rwlock((vnode_t *)(V), (F) )
#define AFS_RWUNLOCK(V,F) afs_rwunlock((vnode_t *)(V), (F) )
#endif
#else /* AFS_SGI53_ENV */
#define AFS_RWLOCK(V,F) afs_rwlock((V))
#define AFS_RWUNLOCK(V,F) afs_rwunlock((V))
#endif /* AFS_SGI53_ENV */
#endif /* AFS_SGI_ENV */

struct vcxstat {
    struct VenusFid fid;
    afs_hyper_t DataVersion;
    afs_rwlock_t lock;
    afs_int32 parentVnode;
    afs_int32 parentUnique;
    afs_hyper_t flushDV;
    afs_hyper_t mapDV;
    afs_int32 truncPos;
    afs_int32 randomUid[CPSIZE];
    afs_int32 callback;         /* Now a pointer to 'server' struct */
    afs_int32 cbExpires;
    afs_int32 randomAccess[CPSIZE];
    afs_int32 anyAccess;
    short opens;
    short execsOrWriters;
    short flockCount;
    char mvstat;
    afs_uint32 states;
};

struct vcxstat2 {
    afs_int32 callerAccess;
    afs_int32 cbExpires;
    afs_int32 anyAccess;
    char mvstat;
};

struct sbstruct {
    int sb_thisfile;
    int sb_default;
};

/* CM inititialization parameters. What CM actually used after calculations
 * based on passed in arguments.
 */
#define CMI_VERSION 1           /* increment when adding new fields. */
struct cm_initparams {
    int cmi_version;
    int cmi_nChunkFiles;
    int cmi_nStatCaches;
    int cmi_nDataCaches;
    int cmi_nVolumeCaches;
    int cmi_firstChunkSize;
    int cmi_otherChunkSize;
    int cmi_cacheSize;          /* The original cache size, in 1K blocks. */
    unsigned cmi_setTime:1;
    unsigned cmi_memCache:1;
    int spare[16 - 9];          /* size of struct is 16 * 4 = 64 bytes */
};


/*----------------------------------------------------------------------
 * AFS Data cache definitions
 *
 * Each entry describes a Unix file on the local disk that is
 * is serving as a cached copy of all or part of a Vice file.
 * Entries live in circular queues for each hash table slot
 *
 * Which queue is this thing in?  Good question.
 * A struct dcache entry is in the freeDSlot queue when not associated with a cache slot (file).
 * Otherwise, it is in the DLRU queue.  The freeDSlot queue uses the lruq.next field as
 * its "next" pointer.
 *
 * Cache entries in the DLRU queue are either associated with vice files, in which case
 * they are hashed by afs_dvnextTbl and afs_dcnextTbl pointers, or they are in the freeDCList
 * and are not associated with any vice file.  This last list uses the afs_dvnextTbl pointer for
 * its "next" pointer.
 *----------------------------------------------------------------------*/

#define NULLIDX     (-1)        /* null index definition */
/* struct dcache states bits */
#define DRO         1
#define DBackup     2
#define DRW         4
#define DWriting    8           /* file being written (used for cache validation) */

/* dcache data flags */
#define DFEntryMod      0x02    /* has entry itself been modified? */
#define DFFetching      0x04    /* file is currently being fetched */

/* dcache meta flags */
#define DFNextStarted   0x01    /* next chunk has been prefetched already */
#define DFFetchReq      0x10    /* someone is waiting for DFFetching to go on */


/* flags in afs_indexFlags array */
#define IFEverUsed      1       /* index entry has >= 1 byte of data */
#define IFFree          2       /* index entry in freeDCList */
#define IFDataMod       4       /* file needs to be written out */
#define IFFlag          8       /* utility flag */
#define IFDirtyPages    16      /* Solaris-only. contains dirty pages */
#define IFAnyPages      32
#define IFDiscarded     64      /* index entry in discardDCList */

#ifdef AFS_DARWIN100_ENV
typedef user_addr_t iparmtype; /* 64 bit */
typedef user_addr_t uparmtype; /* 64 bit */
#else
typedef char * uparmtype;
#ifdef AFS_SGI65_ENV
typedef afs_uint32 iparmtype;
#else
typedef long iparmtype;
#endif
#endif

#if SIZEOF_VOID_P == SIZEOF_UNSIGNED_INT
# define uintptrsz unsigned int
#elif SIZEOF_VOID_P == SIZEOF_UNSIGNED_LONG
# define uintptrsz unsigned long
#elif SIZEOF_VOID_P == SIZEOF_UNSIGNED_LONG_LONG
# define uintptrsz unsigned long long
#else
# error "Unable to determine casting for pointers"
#endif

struct afs_ioctl {
    uparmtype in;               /* input buffer */
    uparmtype out;              /* output buffer */
    short in_size;              /* Size of input buffer <= 2K */
    short out_size;             /* Maximum size of output buffer, <= 2K */
};

/*
 * This version of afs_ioctl is required to pass in 32 bit user space
 * pointers into a 64 bit kernel.
 */

struct afs_ioctl32 {
    unsigned int in;
    unsigned int out;
    short in_size;
    short out_size;
};


/* CacheItems file has a header of type struct afs_fheader
 * (keep aligned properly). Since we already have sgi_62 clients running
 * with a 32 bit inode, a change is required to the header so that
 * they can distinguish the old 32 bit inode CacheItems file and zap it
 * instead of using it.
 */
struct afs_fheader {
#define AFS_FHMAGIC         0x7635abaf  /* uses version number */
    afs_int32 magic;
#define AFS_CI_VERSION 4
    afs_int32 version;
    afs_uint32 dataSize;
    afs_int32 firstCSize;
    afs_int32 otherCSize;
};

#if defined(AFS_CACHE_VNODE_PATH)
typedef char *afs_ufs_dcache_id_t;
#elif defined(AFS_SGI61_ENV) || defined(AFS_SUN5_64BIT_ENV)
/* Using ino64_t here so that user level debugging programs compile
 * the size correctly.
 */
typedef ino64_t afs_ufs_dcache_id_t;
#elif defined(AFS_LINUX26_ENV)
#define MAX_FH_LEN 10
typedef union {
#if defined(NEW_EXPORT_OPS)
    struct fid fh;
#endif
    __u32 raw[MAX_FH_LEN];
} afs_ufs_dcache_id_t;
extern int cache_fh_type;
extern int cache_fh_len;
#elif defined(AFS_LINUX_64BIT_KERNEL) && !defined(AFS_S390X_LINUX24_ENV)
typedef long afs_ufs_dcache_id_t;
#elif defined(AFS_AIX51_ENV) || defined(AFS_HPUX1123_ENV)
typedef ino_t afs_ufs_dcache_id_t;
#else
typedef afs_int32 afs_ufs_dcache_id_t;
#endif

typedef afs_int32 afs_mem_dcache_id_t;

typedef union {
    afs_ufs_dcache_id_t ufs;
    afs_mem_dcache_id_t mem;
} afs_dcache_id_t;

/* it does not compile outside kernel */
struct buffer {
  afs_int32 fid;              /* is adc->index, the cache file number */
  afs_dcache_id_t inode;          /* is adc->f.inode, the inode number of the cac\
                                 he file */
  afs_int32 page;
  afs_int32 accesstime;
  struct buffer *hashNext;
  char *data;
  char lockers;
  char dirty;
  char hashIndex;
  afs_rwlock_t lock;          /* the lock for this structure */
};

/* kept on disk and in dcache entries */
struct fcache {
    struct VenusFid fid;        /* Fid for this file */
    afs_int32 modTime;          /* last time this entry was modified */
    afs_hyper_t versionNo;      /* Associated data version number */
    afs_int32 chunk;            /* Relative chunk number */
    afs_dcache_id_t inode;              /* Unix inode for this chunk */
    afs_int32 chunkBytes;       /* Num bytes in this chunk */
    char states;                /* Has this chunk been modified? */
};

/* magic numbers to specify the cache type */

#define AFS_FCACHE_TYPE_UFS 0x0
#define AFS_FCACHE_TYPE_MEM 0x1
#define AFS_FCACHE_TYPE_NFS 0x2
#define AFS_FCACHE_TYPE_EPI 0x3

/* kept in memory */
struct dcache {
    struct afs_q lruq;          /* Free queue for in-memory images */
    struct afs_q dirty;         /* Queue of dirty entries that need written */
    afs_rwlock_t lock;          /* Protects validPos, some f */
    afs_rwlock_t tlock;         /* Atomizes updates to refCount */
    afs_rwlock_t mflock;        /* Atomizes accesses/updates to mflags */
    afs_size_t validPos;        /* number of valid bytes during fetch */
    afs_int32 index;            /* The index in the CacheInfo file */
    short refCount;             /* Associated reference count. */
    char dflags;                /* Data flags */
    char mflags;                /* Meta flags */
    struct fcache f;            /* disk image */
    afs_int32 bucket;           /* which bucket these dcache entries are in */
    /*
     * Locking rules:
     *
     * dcache.lock protects the actual contents of the cache file (in
     * f.inode), subfields of f except those noted below, dflags and
     * validPos.
     *
     * dcache.tlock is used to make atomic updates to refCount.  Zero
     * refCount dcache entries are protected by afs_xdcache instead of
     * tlock.
     *
     * dcache.mflock is used to access and update mflags.  It cannot be
     * held without holding the corresponding dcache.lock.  Updating
     * mflags requires holding dcache.lock(R) and dcache.mflock(W), and
     * checking for mflags requires dcache.lock(R) and dcache.mflock(R).
     * Note that dcache.lock(W) gives you the right to update mflags,
     * as dcache.mflock(W) can only be held with dcache.lock(R).
     *
     * dcache.index, dcache.f.fid, dcache.f.chunk and dcache.f.inode are
     * write-protected by afs_xdcache and read-protected by refCount.
     * Once an entry is referenced, these values cannot change, and if
     * it's on the free list (with refCount=0), it can be reused for a
     * different file/chunk.  These values can only be written while
     * holding afs_xdcache(W) and allocating this dcache entry (thereby
     * ensuring noone else has a refCount on it).
     */
};

/* afs_memcache.c */
struct memCacheEntry {
  int size;                   /* # of valid bytes in this entry */
  int dataSize;               /* size of allocated data area */
  afs_lock_t afs_memLock;
  char *data;                 /* bytes */
};

struct afs_FetchOutput {
    struct AFSVolSync tsync;
    struct AFSFetchStatus OutStatus;
    struct AFSCallBack CallBack;
};

/* macro to mark a dcache entry as bad */
#define ZapDCE(x) \
    do { \
        (x)->f.fid.Fid.Unique = 0; \
        afs_indexUnique[(x)->index] = 0; \
        (x)->dflags |= DFEntryMod; \
    } while(0)

/* FakeOpen and Fake Close used to be real subroutines.  They're only used in
 * sun_subr and afs_vnodeops, and they're very frequently called, so I made
 * them into macros.  They do:
 * FakeOpen:  fake the file being open for writing.  avc->lock must be held
 * in write mode.  Having the file open for writing is like having a DFS
 * write-token: you're known to have the best version of the data around,
 * and so the CM won't let it be overwritten by random server info.
 * FakeClose:  undo the effects of FakeOpen, noting that we want to ensure
 * that a real close eventually gets done.  We use CCore to achieve this if
 * we would end up closing the file.  avc->lock must be held in write mode */

#ifdef AFS_AIX_IAUTH_ENV
#define CRKEEP(V, C)  (V)->linkData = (char*)crdup((C))
#else
#define CRKEEP(V, C)  crhold((C)); (V)->linkData = (char*)(C)
#endif

#define afs_FakeOpen(avc) { avc->opens++; avc->execsOrWriters++; }
#define afs_FakeClose(avc, acred) \
{ if (avc->execsOrWriters == 1) {  \
        /* we're the last writer, just use CCore flag */   \
        avc->f.states |= CCore; /* causes close to be called later */ \
                                                                      \
        /* The cred and vnode holds will be released in afs_FlushActiveVcaches */  \
        AFS_FAST_HOLD(avc);     /* So it won't disappear */           \
        CRKEEP(avc, acred); /* Should use a better place for the creds */ \
    }                                                                         \
    else {                                                                    \
        /* we're not the last writer, let the last one do the store-back for us */    \
        avc->opens--;                                                         \
        avc->execsOrWriters--;                                                \
    }                                                                         \
}

#define AFS_ZEROS   64          /* zero buffer */

/*#define afs_DirtyPages(avc)   (((avc)->f.states & CDirty) || osi_VMDirty_p((avc)))*/
#define afs_DirtyPages(avc)     ((avc)->f.states & CDirty)

#define afs_InReadDir(avc) (((avc)->f.states & CReadDir) && (avc)->readdir_pid == MyPidxx2Pid(MyPidxx))

/* The PFlush algorithm makes use of the fact that Fid.Unique is not used in
  below hash algorithms.  Change it if need be so that flushing algorithm
  doesn't move things from one hash chain to another
*/
/* extern int afs_dhashsize; */
#define DCHash(v, c)    ((((v)->Fid.Vnode + (v)->Fid.Volume + (c))) & (afs_dhashsize-1))
        /*Vnode, Chunk -> Hash table index */
#define DVHash(v)       ((((v)->Fid.Vnode + (v)->Fid.Volume )) & (afs_dhashsize-1))
        /*Vnode -> Other hash table index */
/* don't hash on the cell, our callback-breaking code sometimes fails to compute
    the cell correctly, and only scans one hash bucket */
#define VCHash(fid)     (((fid)->Fid.Volume + (fid)->Fid.Vnode) & (VCSIZE-1))
/* Hash only on volume to speed up volume callbacks. */
#define VCHashV(fid) ((fid)->Fid.Volume & (VCSIZE-1))

extern struct dcache **afs_indexTable;  /*Pointers to in-memory dcache entries */
extern afs_int32 *afs_indexUnique;      /*dcache entry Fid.Unique */
extern afs_int32 *afs_dvnextTbl;        /*Dcache hash table links */
extern afs_int32 *afs_dcnextTbl;        /*Dcache hash table links */
extern afs_int32 afs_cacheFiles;        /*Size of afs_indexTable */
extern afs_int32 afs_cacheBlocks;       /*1K blocks in cache */
extern afs_int32 afs_cacheStats;        /*Stat entries in cache */
extern struct vcache *afs_vhashT[VCSIZE];       /*Stat cache hash table */
extern struct afs_q afs_vhashTV[VCSIZE]; /* cache hash table on volume */
extern afs_int32 afs_initState; /*Initialization state */
extern afs_int32 afs_termState; /* Termination state */
extern struct VenusFid afs_rootFid;     /*Root for whole file system */
extern afs_int32 afs_allCBs;    /* Count of callbacks */
extern afs_int32 afs_oddCBs;    /* Count of odd callbacks */
extern afs_int32 afs_evenCBs;   /* Count of even callbacks */
extern afs_int32 afs_allZaps;   /* Count of fid deletes */
extern afs_int32 afs_oddZaps;   /* Count of odd fid deletes */
extern afs_int32 afs_evenZaps;  /* Count of even fid deletes */
extern struct brequest afs_brs[NBRS];   /* request structures */

#define UHash(auid)     ((auid) & (NUSERS-1))
#define VHash(avol)     ((avol)&(NVOLS-1))
#define SHash(aserv)    ((ntohl(aserv)) & (NSERVERS-1))
#define FVHash(acell,avol)  (((avol)+(acell)) & (NFENTRIES-1))

/* Performance hack - we could replace VerifyVCache2 with the appropriate
 * GetVCache incantation, and could eliminate even this code from afs_UFSRead
 * by making intentionally invalidating quick.stamp in the various callbacks
 * expiration/breaking code */
#ifdef AFS_DARWIN_ENV
#define afs_VerifyVCache(avc, areq)  \
  (((avc)->f.states & CStatd) ? (osi_VM_Setup(avc, 0), 0) : \
   afs_VerifyVCache2((avc),areq))
#else
#define afs_VerifyVCache(avc, areq)  \
  (((avc)->f.states & CStatd) ? 0 : afs_VerifyVCache2((avc),areq))
#endif

#define DO_STATS 1              /* bits used by FindVCache */
#define DO_VLRU 2
#define IS_SLOCK 4
#define IS_WLOCK 8

/* values for adown value of afs_LoopServers */
#define AFS_LS_UP 0
#define AFS_LS_DOWN 1
#define AFS_LS_ALL 2

/* values for flag param of afs_CheckVolumeNames */
#define AFS_VOLCHECK_EXPIRED    0x1     /* volumes whose callbacks have expired */
#define AFS_VOLCHECK_BUSY       0x2     /* volumes which were marked busy */
#define AFS_VOLCHECK_MTPTS      0x4     /* mount point invalidation also */
#define AFS_VOLCHECK_FORCE      0x8     /* do all forcibly */

#endif /* KERNEL */

#define AFS_FSPORT          ((unsigned short) htons(7000))
#define AFS_VLPORT          ((unsigned short) htons(7003))
#define AFS_RXOSDPORT       ((unsigned short) htons(7011))

#define afs_rdwr(avc, uio, rw, io, cred) \
    (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 0) : afs_read(avc, uio, cred, 0))
#define afs_nlrdwr(avc, uio, rw, io, cred) \
    (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 1) : afs_read(avc, uio, cred, 1))

/* Cache size truncation uses the following low and high water marks:
 * If the cache is more than 95% full (CM_DCACHECOUNTFREEPCT), the cache
 * truncation daemon is awakened and will free up space until the cache is 85%
 * (CM_DCACHESPACEFREEPCT - CM_DCACHEEXTRAPCT) full.
 * afs_UFSWrite and afs_GetDCache (when it needs to fetch data) will wait on
 * afs_WaitForCacheDrain if the cache is 98% (CM_WAITFORDRAINPCT) full.
 * afs_GetDownD wakes those processes once the cache is 95% full
 * (CM_CACHESIZEDRAINEDPCT).
 */
#define CM_MAXDISCARDEDCHUNKS   16      /* # of chunks */
#define CM_DCACHECOUNTFREEPCT   95      /* max pct of chunks in use */
#define CM_DCACHESPACEFREEPCT   90      /* max pct of space in use */
#define CM_DCACHEEXTRAPCT        5      /* extra to get when freeing */
#define CM_CACHESIZEDRAINEDPCT  95      /* wakeup processes when down to here. */
#define CM_WAITFORDRAINPCT      98      /* sleep if cache is this full. */

/* when afs_cacheBlocks is large, settle for slightly decreased precision */
#define PERCENT(p, v) \
    ((afs_cacheBlocks & 0xffe00000) ? ((v) / 100 * (p)) : ((p) * (v) / 100))

#define afs_CacheIsTooFull() \
    (afs_blocksUsed - afs_blocksDiscarded > \
        PERCENT(CM_DCACHECOUNTFREEPCT, afs_cacheBlocks) || \
     afs_freeDCCount - afs_discardDCCount < \
        PERCENT(100 - CM_DCACHECOUNTFREEPCT, afs_cacheFiles))

/* Handy max length of a numeric string. */
#define CVBS    12              /* max afs_int32 is 2^32 ~ 4*10^9, +1 for NULL, +luck */

#define refpanic(foo) if (afs_norefpanic) \
        { printf( foo ); afs_norefpanic++;} else osi_Panic( foo )

/*
** these are defined in the AIX source code sys/fs_locks.h but are not
** defined anywhere in the /usr/include directory
*/
#if     defined(AFS_AIX41_ENV)
#define VN_LOCK(vp)             simple_lock(&(vp)->v_lock)
#define VN_UNLOCK(vp)           simple_unlock(&(vp)->v_lock)
#endif

/* get a file's serial number from a vnode */
#ifndef afs_vnodeToInumber
#if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
#define afs_vnodeToInumber(V) VnodeToIno(V)
#else
#define afs_vnodeToInumber(V) (VTOI(V)->i_number)
#endif /* AFS_SGI62_ENV */
#endif

/* get a file's device number from a vnode */
#ifndef afs_vnodeToDev
#if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
#define afs_vnodeToDev(V) VnodeToDev(V)
#elif defined(UKERNEL)
#define afs_vnodeToDev(V) (VTOI(V) ? (VTOI(V)->i_dev) : (-1))
#else
#define afs_vnodeToDev(V) (VTOI(V)->i_dev)
#endif
#endif

/* declare something so that prototypes don't flip out */
/* appears struct buf stuff is only actually passed around as a pointer,
   except with libuafs, in which case it is actually defined */

struct buf;

struct rxfs_storeVariables {
    struct rx_call *call;
    struct vcache *vcache;
    char *tbuffer;
    struct iovec *tiov;
    afs_int32 tnio;
    afs_int32 hasNo64bit;
    struct AFSStoreStatus InStatus;
};

struct storeOps {
    int (*prepare)(void *rock, afs_uint32 size, afs_uint32 *bytestoxfer);
    int (*read)(void *rock, struct osi_file *tfile, afs_uint32 offset,
        afs_uint32 tlen, afs_uint32 *bytesread);
    int (*write)(void *rock, afs_uint32 tlen, afs_uint32 *byteswritten);
    int (*status)(void *rock);
    int (*padd)(void *rock, afs_uint32 tlen);
    int (*close)(void *rock, struct AFSFetchStatus *OutStatus,
        afs_int32 *doProcessFS);
    int (*destroy)(void **rock, afs_int32 error);
    int (*storeproc)(struct storeOps *, void *, struct dcache *, int *,
                     afs_size_t *);
};

struct fetchOps {
    int (*more)(void *rock, afs_int32 *length, afs_uint32 *moredata);
    int (*read)(void *rock, afs_uint32 tlen, afs_uint32 *bytesread);
    int (*write)(void *rock, struct osi_file *fp, afs_uint32 offset,
        afs_uint32 tlen, afs_uint32 *byteswritten);
    int (*close)(void *rock, struct vcache *avc, struct dcache *adc,
        struct afs_FetchOutput *Outputs);
    int (*destroy)(void **rock, afs_int32 error);
};

/* fakestat support: opaque storage for afs_EvalFakeStat to remember
 * what vcache should be released.
 */
struct afs_fakestat_state {
    char valid;
    char did_eval;
    char need_release;
    struct vcache *root_vp;
};

extern int afs_fakestat_enable;
extern int afsd_dynamic_vcaches;

/*
 * Wrappers for access to credentials structure members
 * Linux uses the kernel cred structure if available, with the
 * wrappers defined in LINUX/osi_machdep.h
 */
#if defined(AFS_NBSD40_ENV)
/* in osi_machdep.h as expected */
#elif defined (AFS_DARWIN110_ENV)
#define afs_cr_uid(cred) kauth_cred_getuid((kauth_cred_t)(cred))
#define afs_cr_gid(cred) kauth_cred_getgid((kauth_cred_t)(cred))
#elif !(defined(AFS_LINUX26_ENV) && defined(STRUCT_TASK_STRUCT_HAS_CRED))
#define afs_cr_uid(cred) ((cred)->cr_uid)
#define afs_cr_gid(cred) ((cred)->cr_gid)
#if !defined(AFS_OBSD_ENV)
#define afs_cr_ruid(cred) ((cred)->cr_ruid)
#define afs_cr_rgid(cred) ((cred)->cr_rgid)
#endif

#if !defined(AFS_DARWIN110_ENV)
static_inline void
afs_set_cr_uid(afs_ucred_t *cred, uid_t uid) {
    cred->cr_uid = uid;
}
static_inline void
afs_set_cr_gid(afs_ucred_t *cred, gid_t gid) {
    cred->cr_gid = gid;
}
#if !defined(AFS_OBSD_ENV)
static_inline void
afs_set_cr_ruid(afs_ucred_t *cred, uid_t uid) {
    cred->cr_ruid = uid;
}
static_inline void
afs_set_cr_rgid(afs_ucred_t *cred, gid_t gid) {
    cred->cr_rgid = gid;
}
#endif /* ! AFS_OBSD_ENV */
#endif /* ! AFS_DARWIN110_ENV */
#endif

#ifdef AFS_SUN5_ENV

struct afssysa {
    long syscall;
    long parm1;
    long parm2;
    long parm3;
    long parm4;
    long parm5;
    long parm6;
};
extern int Afs_syscall(struct afssysa *uap, rval_t *rvp);
#endif /* AFS_SUN5_ENV */

/*
 * Various definitions for osi_sleep and its event hash table
 * DFBSD and SUNOS have no osi_sleep, and HPUX has its own hack for this stuff
 */
#define AFS_EVHASHSIZE  128     /* size of afs_evhasht, must be power of 2 */

typedef struct afs_event {
    struct afs_event *next;     /* next in hash chain */
    char *event;                /* lwp event: an address */
    int refcount;               /* Is it in use? */
    int seq;                    /* Sequence number: this is incremented
                                 * by wakeup calls; wait will not return until
                                 * it changes */
#if defined(AFS_AIX_ENV)
    tid_t cond;
#elif defined(AFS_DARWIN_ENV)
# ifdef AFS_DARWIN80_ENV
    lck_mtx_t *lck;
    thread_t owner;
# endif
    /* no cond member */
#elif defined(AFS_FBSD_ENV) || defined(AFS_OBSD_ENV)
    int cond;                   /* "all this gluck should probably be replaced by CVs" */
#elif defined(AFS_LINUX24_ENV)
    wait_queue_head_t cond;
#elif defined(AFS_NBSD_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
    kcondvar_t cond;            /* Currently associated condition variable */
#endif
} afs_event_t;

extern afs_event_t *afs_evhasht[AFS_EVHASHSIZE];        /* Hash table for events */

#endif /* _AFS_H_ */