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 #else
  18 #include "../afs/afs_args.h"
  19 #endif
  20
  21
  22 /* Upper bound on number of iovecs out uio routines will deal with. */
  23 #define AFS_MAXIOVCNT       16
  24
  25
  26 extern int afs_shuttingdown;
  27
  28 /*
  29  * Macros to uniquely identify the AFS vfs struct
  30  */
  31 #define AFS_VFSMAGIC            0x1234
  32 #if    defined(AFS_SUN_ENV) || defined(AFS_HPUX90_ENV) || defined(AFS_LINUX20_ENV)
  33 #define AFS_VFSFSID             99
  34 #else
  35 #if defined(AFS_SGI_ENV)
  36 #define AFS_VFSFSID             afs_fstype
  37 #else
  38 #define AFS_VFSFSID             AFS_MOUNT_AFS
  39 #endif
  40 #endif
  41
  42 /* The following are various levels of afs debugging */
  43 #define AFSDEB_GENERAL          1       /* Standard debugging */
  44 #define AFSDEB_NETWORK          2       /* low level afs networking */
  45 #define AFSDEB_RX               4       /* RX debugging */
  46 #define AFSDEB_VNLAYER          8       /* interface layer to AFS (aixops, gfsops, etc) */
  47
  48 /* generic undefined vice id */
  49 #define UNDEFVID            (-1)
  50
  51 /* The basic defines for the Andrew file system
  52     better keep things powers of two so "& (foo-1)" hack works for masking bits */
  53 #define MAXHOSTS        13          /* max hosts per single volume */
  54 #define OMAXHOSTS        8          /* backwards compatibility */
  55 #define MAXCELLHOSTS     8          /* max vldb servers per cell */
  56 #define NBRS            15          /* max number of queued daemon requests */
  57 #define NUSERS          16          /* hash table size for unixuser table */
  58 #define NSERVERS        16          /* hash table size for server table */
  59 #define NVOLS           64          /* hash table size for volume table */
  60 #define NFENTRIES       256         /* hash table size for disk volume table */
  61 #define VCSIZE         1024         /* stat cache hash table size */
  62 #define DCSIZE          512         /* disk cache hash table size */
  63 #define PIGGYSIZE       1350        /* max piggyback size */
  64 #define MAXVOLS         128         /* max vols we can store */
  65 #define MAXSYSNAME      128         /* max sysname (i.e. @sys) size */
  66 #define MAXNUMSYSNAMES  16          /* max that current constants allow */
  67 #define NOTOKTIMEOUT    (2*3600)    /* time after which to timeout conns sans tokens */
  68 #define NOPAG           0xffffffff
  69 #define AFS_NCBRS       300         /* max # of call back return entries */
  70 #define AFS_MAXCBRSCALL 16          /* max to return in a given call */
  71 #define AFS_SALLOC_LOW_WATER    250 /* Min free blocks before allocating more */
  72 #define AFS_LRALLOCSIZ  4096        /* "Large" allocated size */
  73 #define VCACHE_FREE     5
  74 #define AFS_NRXPACKETS  80
  75 #define AFS_RXDEADTIME  50
  76 #define AFS_HARDDEADTIME        120
  77
  78 struct sysname_info {
  79   char *name;
  80   short offset;
  81   char index, allocked;
  82 };
  83
  84 /* flags to use with AFSOP_CACHEINIT */
  85 #define AFSCALL_INIT_MEMCACHE        0x1         /* use a memory-based cache */
  86
  87 /* below here used only for kernel procedures */
  88 #ifdef KERNEL
  89 /* Store synchrony flags - SYNC means that data should be forced to server's
  90  * disk immediately upon completion. */
  91 #define AFS_ASYNC       0
  92 #define AFS_SYNC        1
  93 #define AFS_VMSYNC_INVAL 2      /* sync and invalidate pages */
  94 #define AFS_LASTSTORE   4
  95
  96
  97 /* background request structure */
  98 #define BPARMS          4
  99
 100 #define BOP_NOOP        0           /* leave 0 unused */
 101 #define BOP_FETCH       1           /* parm1 is chunk to get */
 102 #define BOP_STORE       2           /* parm1 is chunk to store */
 103 #define BOP_PATH        3           /* parm1 is path, parm2 is chunk to fetch */
 104
 105 #define B_DONTWAIT      1           /* On failure return; don't wait */
 106
 107 /* protocol is: refCount is incremented by user to take block out of free pool.
 108     Next, BSTARTED is set when daemon finds request.  This prevents
 109     other daemons from picking up the same request.  Finally, when
 110     request is done, refCount is zeroed.  BDONE and BWAIT are used by
 111     dudes waiting for operation to proceed to a certain point before returning.
 112 */
 113 #define BSTARTED        1           /* request picked up by a daemon */
 114 #define BUVALID         2           /* code is valid (store) */
 115 #define BUWAIT          4           /* someone is waiting for BUVALID */
 116 struct brequest {
 117     struct vcache *vnode;           /* vnode to use, with vrefcount bumped */
 118     struct AFS_UCRED *cred;         /* credentials to use for operation */
 119     afs_size_t size_parm[BPARMS];   /* random parameters */
 120     void *ptr_parm[BPARMS];         /* pointer parameters */
 121     afs_int32 code;                 /* return code */
 122     short refCount;                 /* use counter for this structure */
 123     char opcode;                    /* what to do (store, fetch, etc) */
 124     char flags;                     /* free, etc */
 125     afs_int32 ts;                   /* counter "timestamp" */
 126 };
 127
 128 struct SecretToken {
 129     char data[56];
 130 };
 131
 132 struct ClearToken {
 133         afs_int32 AuthHandle;
 134         char HandShakeKey[8];
 135         afs_int32 ViceId;
 136         afs_int32 BeginTimestamp;
 137         afs_int32 EndTimestamp;
 138 };
 139
 140 struct VenusFid {
 141     afs_int32 Cell;                         /* better sun packing if at end of structure */
 142     struct AFSFid Fid;
 143 };
 144
 145 /* 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!) */
 146 struct SmallFid {
 147     afs_int32 Volume;
 148     afs_int32 CellAndUnique;
 149     u_short Vnode;
 150 };
 151 /* The actual number of bytes in the SmallFid, not the sizeof struct. */
 152 #define SIZEOF_SMALLFID 10
 153
 154
 155 /*
 156   * Queues implemented with both pointers and short offsets into a disk file.
 157   */
 158 struct afs_q {
 159     struct afs_q *next;
 160     struct afs_q *prev;
 161 };
 162
 163 struct vrequest {
 164     afs_int32 uid;                      /* user id making the request */
 165     afs_int32 busyCount;                /* how many busies we've seen so far */
 166     afs_int32 flags;                 /* things like O_SYNC, O_NONBLOCK go here */
 167     char initd;                 /* if non-zero, non-uid fields meaningful */
 168     char accessError;           /* flags for overriding error return code */
 169     char volumeError;           /* encountered a missing or busy volume */
 170     char networkError;          /* encountered network problems */
 171     char permWriteError;        /* fileserver returns permenent error. */
 172 };
 173 #define VOLMISSING 1
 174 #define VOLBUSY 2
 175
 176 /* structure linked off of a server to keep track of queued returned
 177  * callbacks.  Sent asynchronously when we run a little low on free dudes.
 178  */
 179 struct afs_cbr {
 180     struct afs_cbr *next;
 181     struct AFSFid fid;
 182 };
 183
 184
 185 #define LOCALCELL           1   /* local cell's number is always 1 */
 186
 187 /* cell flags */
 188 #define CPrimary            1       /* on if this is the primary cell */
 189 #define CNoSUID             2       /* 1 if no suid progs can run from this cell */
 190 #define CHasVolRef         16       /* Volumes were referenced in this cell*/
 191 #define CLinkedCell        32
 192 #define CAlias             64       /* This cell entry is an alias */
 193
 194 struct cell {
 195     struct afs_q lruq;                       /* lru q next and prev */
 196     afs_int32 cell;                                 /* unique id assigned by venus */
 197     char *cellName;                         /* char string name of cell */
 198     struct server *cellHosts[MAXCELLHOSTS]; /* volume *location* hosts for this cell */
 199     struct cell *lcellp;                    /* Associated linked cell */
 200     u_short fsport;                         /* file server port */
 201     u_short vlport;                         /* volume server port */
 202     short states;                           /* state flags */
 203     short cellIndex;                        /* relative index number per cell */
 204     time_t timeout;                         /* data expire time, if non-zero */
 205     char *realName;                         /* who this cell is an alias for */
 206 };
 207
 208 #define afs_PutCell(cellp, locktype)
 209
 210 /* the unixuser flag bit definitions */
 211 #define UHasTokens      1           /* are the st and ct fields valid (ever set)? */
 212 #define UTokensBad      2           /* are tokens bad? */
 213 #define UPrimary        4           /* on iff primary identity */
 214 #define UNeedsReset     8           /* needs afs_ResetAccessCache call done */
 215 #define UPAGCounted    16           /* entry seen during PAG search (for stats) */
 216 /* A flag used by afs_GCPAGs to keep track of
 217  * which entries in afs_users need to be deleted.
 218  * The lifetime of its presence in the table is the
 219  * lifetime of the afs_GCPAGs function.
 220  */
 221 #define TMP_UPAGNotReferenced   128
 222
 223 /* values for afs_gcpags */
 224 enum
 225 { AFS_GCPAGS_NOTCOMPILED = 0
 226 , AFS_GCPAGS_OK = 1
 227 , AFS_GCPAGS_USERDISABLED
 228 , AFS_GCPAGS_EPROC0
 229 , AFS_GCPAGS_EPROCN
 230 , AFS_GCPAGS_EEQPID
 231 , AFS_GCPAGS_EINEXACT
 232 , AFS_GCPAGS_EPROCEND
 233 , AFS_GCPAGS_EPROCWALK
 234 , AFS_GCPAGS_ECREDWALK
 235 , AFS_GCPAGS_EPIDCHECK
 236 , AFS_GCPAGS_ENICECHECK
 237 };
 238
 239 extern afs_int32 afs_gcpags;
 240 extern afs_int32 afs_gcpags_procsize;
 241
 242 struct unixuser {
 243     struct unixuser *next;          /* next hash pointer */
 244     afs_int32 uid;                          /* search based on uid and cell */
 245     afs_int32 cell;
 246     afs_int32 vid;                          /* corresponding vice id in specified cell */
 247     short refCount;                 /* reference count for allocation */
 248     char states;                    /* flag info */
 249     afs_int32 tokenTime;                    /* last time tokens were set, used for timing out conn data */
 250     afs_int32 stLen;                        /* ticket length (if kerberos, includes kvno at head) */
 251     char *stp;                      /* pointer to ticket itself */
 252     struct ClearToken ct;
 253     struct afs_exporter *exporter;  /* more info about the exporter for the remote user */
 254 };
 255
 256 struct conn {
 257     /* Per-connection block. */
 258     struct conn *next;              /* Next dude same server. */
 259     struct unixuser *user;          /* user validated with respect to. */
 260     struct rx_connection *id;       /* RPC connid. */
 261     struct srvAddr *srvr;           /* server associated with this conn */
 262     short refCount;                 /* reference count for allocation */
 263     unsigned short port;            /* port associated with this connection */
 264     char forceConnectFS;            /* Should we try again with these tokens? */
 265 };
 266
 267
 268 #define SQNULL -1
 269
 270 /* Fid comparison routines */
 271 #define FidCmp(a,b) ((a)->Fid.Unique != (b)->Fid.Unique \
 272     || (a)->Fid.Vnode != (b)->Fid.Vnode \
 273     || (a)->Fid.Volume != (b)->Fid.Volume \
 274     || (a)->Cell != (b)->Cell)
 275
 276 #define FidMatches(afid,tvc) ((tvc)->fid.Fid.Vnode == (afid)->Fid.Vnode && \
 277         (tvc)->fid.Fid.Volume == (afid)->Fid.Volume && \
 278         (tvc)->fid.Cell == (afid)->Cell && \
 279         ( (tvc)->fid.Fid.Unique == (afid)->Fid.Unique || \
 280          (!(afid)->Fid.Unique && ((tvc)->states & CUnique))))
 281
 282
 283 /*
 284   * Operations on circular queues implemented with pointers.  Note: these queue
 285   * objects are always located at the beginning of the structures they are linking.
 286   */
 287 #define QInit(q)    ((q)->prev = (q)->next = (q))
 288 #define QAdd(q,e)   ((e)->next = (q)->next, (e)->prev = (q), \
 289                         (q)->next->prev = (e), (q)->next = (e))
 290 #define QRemove(e)  ((e)->next->prev = (e)->prev, (e)->prev->next = (e)->next)
 291 #define QNext(e)    ((e)->next)
 292 #define QPrev(e)    ((e)->prev)
 293 #define QEmpty(q)   ((q)->prev == (q))
 294 /* this one takes q1 and sticks it on the end of q2 - that is, the other end, not the end
 295  * that things are added onto.  q1 shouldn't be empty, it's silly */
 296 #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))
 297 /*
 298  * Do lots of address arithmetic to go from vlruq to the base of the vcache
 299  * structure.  Don't move struct vnode, since we think of a struct vcache as
 300  * a specialization of a struct vnode
 301  */
 302 #define QTOV(e)     ((struct vcache *)(((char *) (e)) - (((char *)(&(((struct vcache *)(e))->vlruq))) - ((char *)(e)))))
 303 #define QTOC(e)     ((struct cell *)((char *) (e)))
 304
 305 #define SRVADDR_MH      1
 306 #define SRVADDR_ISDOWN  0x20    /* same as SRVR_ISDOWN */
 307 #define  SRVADDR_NOUSE    0x40    /* Don't use this srvAddr */
 308 struct srvAddr {
 309     struct srvAddr *next_bkt;   /* next item in hash bucket */
 310     struct srvAddr *next_sa;    /* another interface on same host */
 311     struct server *server;      /* back to parent */
 312     struct conn *conns;         /* All user connections to this server */
 313     afs_int32 sa_ip;            /* Host addr in network byte order */
 314     u_short sa_iprank;          /* indiv ip address priority */
 315     u_short sa_portal;          /* port addr in network byte order */
 316     u_char sa_flags;
 317 };
 318
 319 /*
 320  * Values used in the flags field of the server structure below.
 321  *
 322  *      AFS_SERVER_FLAG_ACTIVATED Has the server ever had a user connection
 323  *                                associated with it?
 324  */
 325 #define AFS_SERVER_FLAG_ACTIVATED       0x01
 326 #define SNO_LHOSTS                      0x04
 327 #define SYES_LHOSTS                     0x08
 328 #define SVLSRV_UUID                     0x10
 329 #define SRVR_ISDOWN                     0x20
 330 #define SRVR_MULTIHOMED                 0x40
 331 #define SRVR_ISGONE                     0x80
 332 #define SNO_INLINEBULK                  0x100
 333 #define SNO_64BIT                       0x200
 334
 335 #define afs_serverSetNo64Bit(s) ((s)->srvr->server->flags |= SNO_64BIT)
 336 #define afs_serverHasNo64Bit(s) ((s)->srvr->server->flags & SNO_64BIT)
 337
 338 struct server {
 339     union {
 340         struct {
 341             afsUUID suuid;
 342             afs_int32 addr_uniquifier;
 343             afs_int32 spares[2];
 344         } _srvUuid;
 345         struct {
 346             struct srvAddr haddr;
 347         } _srvId;
 348     } _suid;
 349 #define sr_uuid         _suid._srvUuid.suuid
 350 #define sr_addr_uniquifier      _suid._srvUuid.addr_uniquifier
 351 #define sr_host         _suid._srvId.haddr.ip
 352 #define sr_portal       _suid._srvId.haddr.portal
 353 #define sr_rank         _suid._srvId.haddr.ip_rank
 354 #define sr_flags        _suid._srvId.haddr.flags
 355 #define sr_conns        _suid._srvId.haddr.conns
 356     struct server *next;        /* Ptr to next server in hash chain */
 357     struct cell *cell;          /* Cell in which this host resides */
 358     struct afs_cbr *cbrs;       /* Return list of callbacks */
 359     afs_int32 activationTime;   /* Time when this record was first activated */
 360     afs_int32 lastDowntimeStart;        /* Time when last downtime incident began */
 361     afs_int32 numDowntimeIncidents;     /* # (completed) downtime incidents */
 362     afs_int32 sumOfDowntimes;   /* Total downtime experienced, in seconds */
 363     struct srvAddr *addr;
 364     afs_uint32 flags;                   /* Misc flags*/
 365 };
 366
 367 #define afs_PutServer(servp, locktype)
 368
 369 /* structs for some pioctls  - these are (or should be)
 370  * also in venus.h
 371  */
 372 struct spref {
 373         struct in_addr host;
 374         unsigned short rank;
 375 };
 376
 377 struct sprefrequest_33 {
 378         unsigned short offset;
 379         unsigned short num_servers;
 380 };
 381
 382
 383 struct sprefrequest {             /* new struct for 3.4 */
 384         unsigned short offset;
 385         unsigned short num_servers;
 386         unsigned short flags;
 387 };
 388 #define DBservers 1
 389
 390 struct sprefinfo {
 391         unsigned short next_offset;
 392         unsigned short num_servers;
 393         struct spref servers[1];                /* we overrun this array intentionally...*/
 394 };
 395
 396 struct setspref {
 397         unsigned short flags;
 398         unsigned short num_servers;
 399         struct spref servers[1];                /* we overrun this array intentionally...*/
 400 };
 401 /* struct for GAG pioctl
 402  */
 403 struct gaginfo {
 404         afs_uint32 showflags, logflags, logwritethruflag, spare[3];
 405         unsigned char spare2[128];
 406 };
 407 #define GAGUSER    1
 408 #define GAGCONSOLE 2
 409 #define logwritethruON  1
 410
 411 struct rxparams {
 412         afs_int32 rx_initReceiveWindow, rx_maxReceiveWindow,
 413               rx_initSendWindow, rx_maxSendWindow, rxi_nSendFrags,
 414               rxi_nRecvFrags, rxi_OrphanFragSize;
 415         afs_int32 rx_maxReceiveSize, rx_MyMaxSendSize;
 416         afs_uint32 spare[21];
 417       };
 418
 419 /* struct for checkservers */
 420
 421 struct chservinfo
 422 {
 423         int magic;
 424         char tbuffer[128];
 425         int tsize;
 426         afs_int32 tinterval;
 427         afs_int32 tflags;
 428 }
 429 ;
 430
 431
 432 /* state bits for volume */
 433 #define VRO                     1               /* volume is readonly */
 434 #define VRecheck                2               /* recheck volume info with server */
 435 #define VBackup                 4               /* is this a backup volume? */
 436 #define VForeign                8               /* this is a non-afs volume */
 437 #define VResort         16   /* server order was rearranged, sort when able */
 438 #define VMoreReps       32   /* This volume has more replicas than we are   */
 439                              /* keeping track of now -- check with VLDB     */
 440
 441  enum repstate { not_busy, end_not_busy = 6, rd_busy, rdwr_busy, offline };
 442
 443 struct volume {
 444     /* One structure per volume, describing where the volume is located
 445           and where its mount points are. */
 446     struct volume *next;        /* Next volume in hash list. */
 447     afs_int32 cell;                     /* the cell in which the volume resides */
 448     afs_rwlock_t lock;          /* the lock for this structure */
 449     afs_int32 volume;           /* This volume's ID number. */
 450     char *name;                 /* This volume's name, or 0 if unknown */
 451     struct server *serverHost[MAXHOSTS];    /* servers serving this volume */
 452     enum repstate status[MAXHOSTS]; /* busy, offline, etc */
 453     struct VenusFid dotdot;     /* dir to access as .. */
 454     struct VenusFid mtpoint;    /* The mount point for this volume. */
 455     afs_int32 rootVnode, rootUnique;    /* Volume's root fid */
 456     afs_int32 roVol;
 457     afs_int32 backVol;
 458     afs_int32 rwVol;                    /* For r/o vols, original read/write volume. */
 459     afs_int32 accessTime;               /* last time we used it */
 460     afs_int32 vtix;                     /* volume table index */
 461     afs_int32 copyDate;         /* copyDate field, for tracking vol releases */
 462     afs_int32 expireTime;            /* for per-volume callbacks... */
 463     short refCount;             /* reference count for allocation */
 464     char states;                /* here for alignment reasons */
 465 };
 466
 467 #define afs_PutVolume(av, locktype) ((av)->refCount--)
 468
 469 /* format of an entry in volume info file */
 470 struct fvolume {
 471     afs_int32 cell;                     /* cell for this entry */
 472     afs_int32 volume;           /* volume */
 473     afs_int32 next;                     /* has index */
 474     struct VenusFid dotdot;     /* .. value */
 475     struct VenusFid mtpoint;    /* mt point's fid */
 476     afs_int32 rootVnode, rootUnique;    /* Volume's root fid */
 477 };
 478
 479 struct SimpleLocks {
 480     struct SimpleLocks *next;
 481     int type;
 482     afs_int32 boff, eoff;
 483     afs_int32 pid;
 484 #if     defined(AFS_AIX32_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
 485     afs_int32 sysid;
 486 #endif
 487 };
 488
 489 /* vcache state bits */
 490 #define CStatd          0x00000001      /* has this file ever been stat'd? */
 491 #define CBackup         0x00000002      /* file is on a backup volume */
 492 #define CRO             0x00000004      /* is it on a read-only volume */
 493 #define CMValid         0x00000008      /* is the mount point info valid? */
 494 #define CCore           0x00000010      /* storing a core file, needed since we don't get an open */
 495 #define CDirty          0x00000020      /* file has been modified since first open (... O_RDWR) */
 496 #define CSafeStore      0x00000040      /* close must wait for store to finish (should be in fd) */
 497 #define CMAPPED         0x00000080      /* Mapped files; primarily used by SunOS 4.0.x */
 498 #define CNSHARE         0x00000100      /* support O_NSHARE semantics */
 499 #define CLied           0x00000200
 500 #define CTruth          0x00000400
 501 #ifdef  AFS_OSF_ENV
 502 #define CWired          0x00000800      /* OSF hack only */
 503 #else
 504 #define CWRITE_IGN      0x00000800      /* Next OS hack only */
 505 #endif
 506 #define CUnique         0x00001000      /* vc's uniquifier - latest unifiquier for fid */
 507 #define CForeign        0x00002000      /* this is a non-afs vcache */
 508 #define CUnlinked       0x00010000
 509 #define CBulkStat       0x00020000      /* loaded by a bulk stat, and not ref'd since */
 510 #define CUnlinkedDel    0x00040000
 511 #define CVFlushed       0x00080000
 512 #define CCore1          0x00100000      /* osf1 core file; not same as CCore above */
 513 #define CWritingUFS     0x00200000      /* to detect vm deadlock - used by sgi */
 514 #define CCreating       0x00400000      /* avoid needless store after open truncate */
 515 #define CPageHog        0x00800000      /* AIX - dumping large cores is a page hog. */
 516 #define CDCLock         0x02000000      /* Vnode lock held over call to GetDownD */
 517 #define CBulkFetching   0x04000000      /* stats are being fetched by bulk stat */
 518 #define CExtendedFile   0x08000000      /* extended file via ftruncate call. */
 519
 520 /* vcache vstate bits */
 521 #define VRevokeWait   0x1
 522 #define VPageCleaning 0x2       /* Solaris - Cache Trunc Daemon sez keep out */
 523
 524 #define CPSIZE      2
 525 #if !defined(AFS_FBSD_ENV)
 526 #define vrefCount   v.v_count
 527 #else
 528 #define vrefCount   v.v_usecount
 529 #endif /* AFS_FBSD_ENV */
 530
 531 #ifdef AFS_LINUX24_ENV
 532 #define VREFCOUNT(v)            atomic_read(&((vnode_t *) v)->v_count)
 533 #define VREFCOUNT_SET(v, c)     atomic_set(&((vnode_t *) v)->v_count, c)
 534 #define VREFCOUNT_DEC(v)        atomic_dec(&((vnode_t *) v)->v_count)
 535 #define VREFCOUNT_INC(v)        atomic_inc(&((vnode_t *) v)->v_count)
 536 #define DLOCK()      spin_lock(&dcache_lock)
 537 #define DUNLOCK()    spin_unlock(&dcache_lock)
 538 #define DGET(d)      dget_locked(d)
 539 #define DCOUNT(d)    atomic_read(&(d)->d_count)
 540 #else
 541 #define VREFCOUNT(v)            ((v)->vrefCount)
 542 #define VREFCOUNT_SET(v, c)     (v)->vrefCount = c;
 543 #define VREFCOUNT_DEC(v)        (v)->vrefCount--;
 544 #define VREFCOUNT_INC(v)        (v)->vrefCount++;
 545 #define DLOCK()
 546 #define DUNLOCK()
 547 #define DGET(d)      dget(d)
 548 #define DCOUNT(d)    ((d)->d_count)
 549 #endif
 550
 551 #define AFS_MAXDV   0x7fffffff      /* largest dataversion number */
 552 #ifdef AFS_64BIT_CLIENT
 553 #define AFS_NOTRUNC 0x7fffffffffffffffLL  /* largest positive int64 number */
 554 #else /* AFS_64BIT_CLIENT */
 555 #define AFS_NOTRUNC 0x7fffffff      /* largest dataversion number */
 556 #endif /* AFS_64BIT_CLIENT */
 557
 558 extern afs_int32 vmPageHog; /* counter for # of vnodes which are page hogs. */
 559
 560 /*
 561  * Fast map from vcache to dcache
 562  */
 563 struct  vtodc
 564         {
 565         struct dcache * dc;
 566         afs_uint32              stamp;
 567         struct osi_file * f;
 568         afs_offs_t              minLoc; /* smallest offset into dc. */
 569         afs_offs_t              len;    /* largest offset into dc. */
 570         };
 571
 572 extern afs_uint32 afs_stampValue;               /* stamp for pair's usage */
 573 #define MakeStamp()     (++afs_stampValue)
 574
 575 /* INVARIANTs: (vlruq.next != NULL) == (vlruq.prev != NULL)
 576  *             nextfree => !vlruq.next && ! vlruq.prev
 577  * !(avc->nextfree) && !avc->vlruq.next => (FreeVCList == avc->nextfree)
 578  */
 579 struct vcache {
 580     struct vnode v;                     /* Has reference count in v.v_count */
 581     struct afs_q vlruq;                 /* lru q next and prev */
 582     struct vcache *nextfree;            /* next on free list (if free) */
 583     struct vcache *hnext;               /* Hash next */
 584     struct VenusFid fid;
 585     struct mstat {
 586         afs_size_t Length;
 587         afs_hyper_t DataVersion;
 588         afs_uint32 Date;
 589         afs_uint32 Owner;
 590         afs_uint32 Group;
 591         ushort Mode;                    /* XXXX Should be afs_int32 XXXX */
 592         ushort LinkCount;
 593         /* vnode type is in v.v_type */
 594     } m;
 595     afs_rwlock_t lock;                  /* The lock on the vcache contents. */
 596 #if     defined(AFS_SUN5_ENV)
 597     /* Lock used to protect the activeV, multipage, and vstates fields.
 598      * Do not try to get the vcache lock when the vlock is held */
 599     afs_rwlock_t vlock;
 600 #endif /* defined(AFS_SUN5_ENV) */
 601 #if     defined(AFS_SUN5_ENV)
 602     krwlock_t rwlock;
 603     struct cred *credp;
 604 #endif
 605 #if defined(AFS_SUN_ENV) || defined(AFS_ALPHA_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
 606     afs_bozoLock_t pvnLock;     /* see locks.x */
 607 #endif
 608 #ifdef  AFS_AIX32_ENV
 609     afs_lock_t pvmlock;
 610     vmhandle_t vmh;
 611     int  segid;
 612     struct ucred *credp;
 613 #endif
 614 #ifdef AFS_AIX_ENV
 615     int ownslock;       /* pid of owner of excl lock, else 0 - defect 3083 */
 616 #endif
 617 #ifdef AFS_DARWIN_ENV
 618     struct lock__bsd__      rwlock;
 619 #endif
 620 #ifdef AFS_FBSD_ENV
 621     struct lock      rwlock;
 622 #endif
 623     afs_int32 parentVnode;                      /* Parent dir, if a file. */
 624     afs_int32 parentUnique;
 625     struct VenusFid *mvid;              /* Either parent dir (if root) or root (if mt pt) */
 626     char *linkData;                     /* Link data if a symlink. */
 627     afs_hyper_t flushDV;                /* data version last flushed from text */
 628     afs_hyper_t mapDV;                  /* data version last flushed from map */
 629     afs_size_t truncPos;                /* truncate file to this position at next store */
 630     struct server *callback;            /* The callback host, if any */
 631     afs_uint32 cbExpires;               /* time the callback expires */
 632     struct afs_q callsort;              /* queue in expiry order, sort of */
 633     struct axscache *Access;            /* a list of cached access bits */
 634     afs_int32 anyAccess;                /* System:AnyUser's access to this. */
 635     afs_int32 last_looker;              /* pag/uid from last lookup here */
 636 #if     defined(AFS_SUN5_ENV)
 637     afs_int32 activeV;
 638 #endif /* defined(AFS_SUN5_ENV) */
 639     struct SimpleLocks *slocks;
 640     short opens;                    /* The numbers of opens, read or write, on this file. */
 641     short execsOrWriters;           /* The number of execs (if < 0) or writers (if > 0) of
 642                                        this file. */
 643     short flockCount;               /* count of flock readers, or -1 if writer */
 644     char mvstat;                        /* 0->normal, 1->mt pt, 2->root. */
 645     afs_uint32 states;                  /* state bits */
 646 #if     defined(AFS_SUN5_ENV)
 647     afs_uint32 vstates;                 /* vstate bits */
 648 #endif /* defined(AFS_SUN5_ENV) */
 649     struct vtodc quick;
 650     afs_uint32 symhintstamp;
 651     union {
 652       struct vcache *symhint;
 653       struct dcache *dchint;
 654     } h1;
 655 #ifdef AFS_LINUX22_ENV
 656     u_short flushcnt; /* Number of flushes which haven't released yet. */
 657     u_short mapcnt; /* Number of mappings of this file. */
 658 #endif
 659 #if defined(AFS_SGI_ENV)
 660     daddr_t lastr;                      /* for read-ahead */
 661 #ifdef AFS_SGI64_ENV
 662     uint64_t vc_rwlockid;               /* kthread owning rwlock */
 663 #else
 664     short vc_rwlockid;                  /* pid of process owning rwlock */
 665 #endif
 666     short vc_locktrips;                 /* # of rwlock reacquisitions */
 667     sema_t vc_rwlock;                   /* vop_rwlock for afs */
 668     pgno_t mapcnt;                      /* # of pages mapped */
 669     struct cred *cred;                  /* last writer's cred */
 670 #ifdef AFS_SGI64_ENV
 671     struct bhv_desc vc_bhv_desc;        /* vnode's behavior data. */
 672 #endif
 673 #endif /* AFS_SGI_ENV */
 674     afs_int32 vc_error;                 /* stash write error for this vnode. */
 675     int xlatordv;                       /* Used by nfs xlator */
 676     struct AFS_UCRED *uncred;
 677     int asynchrony;                     /* num kbytes to store behind */
 678 #ifdef AFS_SUN5_ENV
 679     short multiPage;            /* count of multi-page getpages in progress */
 680 #endif
 681 };
 682
 683 #define afs_symhint_inval(avc)
 684
 685
 686 #define DONT_CHECK_MODE_BITS    0
 687 #define CHECK_MODE_BITS         1
 688 #define CMB_ALLOW_EXEC_AS_READ  2 /* For the NFS xlator */
 689
 690 #if defined(AFS_SGI_ENV)
 691 #define AVCRWLOCK(avc)          (valusema(&(avc)->vc_rwlock) <= 0)
 692
 693 /* SGI vnode rwlock macros and flags. */
 694 #ifndef AFS_SGI62_ENV
 695 /* The following are defined here. SGI 6.2 declares them in vnode.h */
 696 #define VRWLOCK_READ            0
 697 #define VRWLOCK_WRITE           1
 698 #define VRWLOCK_WRITE_DIRECT    2
 699 #endif
 700
 701 #ifdef AFS_SGI53_ENV
 702 #ifdef AFS_SGI62_ENV
 703 #define AFS_RWLOCK_T vrwlock_t
 704 #else
 705 #define AFS_RWLOCK_T int
 706 #endif /* AFS_SGI62_ENV */
 707 #ifdef AFS_SGI64_ENV
 708 #include <ksys/behavior.h>
 709 #define AFS_RWLOCK(V,F) \
 710         afs_rwlock(&(((struct vcache *)(V))->vc_bhv_desc), (F));
 711 #define AFS_RWUNLOCK(V,F) \
 712         afs_rwunlock(&(((struct vcache *)(V))->vc_bhv_desc), (F));
 713
 714 #else
 715 #define AFS_RWLOCK(V,F) afs_rwlock((vnode_t *)(V), (F) )
 716 #define AFS_RWUNLOCK(V,F) afs_rwunlock((vnode_t *)(V), (F) )
 717 #endif
 718 #else /* AFS_SGI53_ENV */
 719 #define AFS_RWLOCK(V,F) afs_rwlock((V))
 720 #define AFS_RWUNLOCK(V,F) afs_rwunlock((V))
 721 #endif /* AFS_SGI53_ENV */
 722 #endif /* AFS_SGI_ENV */
 723
 724 struct vcxstat {
 725     struct VenusFid fid;
 726     afs_hyper_t DataVersion;
 727     afs_rwlock_t lock;
 728     afs_int32 parentVnode;
 729     afs_int32 parentUnique;
 730     afs_hyper_t flushDV;
 731     afs_hyper_t mapDV;
 732     afs_int32 truncPos;
 733     afs_int32 randomUid[CPSIZE];
 734     afs_int32 callback;         /* Now a pointer to 'server' struct */
 735     afs_int32 cbExpires;
 736     afs_int32 randomAccess[CPSIZE];
 737     afs_int32 anyAccess;
 738     short opens;
 739     short execsOrWriters;
 740     short flockCount;
 741     char mvstat;
 742     afs_uint32 states;
 743 };
 744
 745 struct sbstruct {
 746   int sb_thisfile;
 747   int sb_default;
 748 };
 749
 750 /* CM inititialization parameters. What CM actually used after calculations
 751  * based on passed in arguments.
 752  */
 753 #define CMI_VERSION 1 /* increment when adding new fields. */
 754 struct cm_initparams {
 755     int cmi_version;
 756     int cmi_nChunkFiles;
 757     int cmi_nStatCaches;
 758     int cmi_nDataCaches;
 759     int cmi_nVolumeCaches;
 760     int cmi_firstChunkSize;
 761     int cmi_otherChunkSize;
 762     int cmi_cacheSize;  /* The original cache size, in 1K blocks. */
 763     unsigned cmi_setTime:1;
 764     unsigned cmi_memCache:1;
 765     int spare[16-9]; /* size of struct is 16 * 4 = 64 bytes */
 766 };
 767
 768
 769 /*----------------------------------------------------------------------
 770  * AFS Data cache definitions
 771  *
 772  * Each entry describes a Unix file on the local disk that is
 773  * is serving as a cached copy of all or part of a Vice file.
 774  * Entries live in circular queues for each hash table slot
 775  *
 776  * Which queue is this thing in?  Good question.
 777  * A struct dcache entry is in the freeDSlot queue when not associated with a cache slot (file).
 778  * Otherwise, it is in the DLRU queue.  The freeDSlot queue uses the lruq.next field as
 779  * its "next" pointer.
 780  *
 781  * Cache entries in the DLRU queue are either associated with vice files, in which case
 782  * they are hashed by afs_dvnextTbl and afs_dcnextTbl pointers, or they are in the freeDCList
 783  * and are not associated with any vice file.  This last list uses the afs_dvnextTbl pointer for
 784  * its "next" pointer.
 785  *----------------------------------------------------------------------*/
 786
 787 #define NULLIDX     (-1)        /* null index definition */
 788 /* struct dcache states bits */
 789 #define DWriting    8           /* file being written (used for cache validation) */
 790
 791 /* dcache data flags */
 792 #define DFEntryMod      0x02    /* has entry itself been modified? */
 793 #define DFFetching      0x04    /* file is currently being fetched */
 794
 795 /* dcache meta flags */
 796 #define DFNextStarted   0x01    /* next chunk has been prefetched already */
 797 #define DFFetchReq      0x10    /* someone is waiting for DFFetching to go on */
 798
 799
 800 /* flags in afs_indexFlags array */
 801 #define IFEverUsed      1               /* index entry has >= 1 byte of data */
 802 #define IFFree          2               /* index entry in freeDCList */
 803 #define IFDataMod       4               /* file needs to be written out */
 804 #define IFFlag          8               /* utility flag */
 805 #define IFDirtyPages    16
 806 #define IFAnyPages      32
 807 #define IFDiscarded     64              /* index entry in discardDCList */
 808
 809 struct afs_ioctl {
 810         char *in;               /* input buffer */
 811         char *out;              /* output buffer */
 812         short in_size;          /* Size of input buffer <= 2K */
 813         short out_size;         /* Maximum size of output buffer, <= 2K */
 814 };
 815
 816 /*
 817  * This version of afs_ioctl is required to pass in 32 bit user space
 818  * pointers into a 64 bit kernel.
 819  */
 820
 821 struct afs_ioctl32 {
 822     unsigned int in;
 823     unsigned int out;
 824     short in_size;
 825     short out_size;
 826 };
 827
 828
 829 /* CacheItems file has a header of type struct afs_fheader
 830  * (keep aligned properly). Since we already have sgi_62 clients running
 831  * with a 32 bit inode, a change is required to the header so that
 832  * they can distinguish the old 32 bit inode CacheItems file and zap it
 833  * instead of using it.
 834  */
 835 struct afs_fheader {
 836 #define AFS_FHMAGIC         0x7635abaf /* uses version number */
 837     afs_int32 magic;
 838 #if defined(AFS_SUN57_64BIT_ENV)
 839 #define AFS_CI_VERSION 3
 840 #else
 841 #define AFS_CI_VERSION 2
 842 #endif
 843     afs_int32 version;
 844     afs_int32 firstCSize;
 845     afs_int32 otherCSize;
 846 };
 847
 848 /* kept on disk and in dcache entries */
 849 struct fcache {
 850     struct VenusFid fid;        /* Fid for this file */
 851     afs_int32 modTime;          /* last time this entry was modified */
 852     afs_hyper_t versionNo;      /* Associated data version number */
 853     afs_int32 chunk;            /* Relative chunk number */
 854 #if defined(AFS_SGI61_ENV) || defined(AFS_SUN57_64BIT_ENV)
 855     /* Using ino64_t here so that user level debugging programs compile
 856      * the size correctly.
 857      */
 858     ino64_t inode;              /* Unix inode for this chunk */
 859 #else
 860 #if defined(AFS_LINUX_64BIT_KERNEL)
 861     long inode;                 /* Unix inode for this chunk */
 862 #else
 863     afs_int32 inode;            /* Unix inode for this chunk */
 864 #endif
 865 #endif
 866     afs_int32 chunkBytes;       /* Num bytes in this chunk */
 867     char states;                /* Has this chunk been modified? */
 868 };
 869
 870 /* magic numbers to specify the cache type */
 871
 872 #define AFS_FCACHE_TYPE_UFS 0x0
 873 #define AFS_FCACHE_TYPE_MEM 0x1
 874 #define AFS_FCACHE_TYPE_NFS 0x2
 875 #define AFS_FCACHE_TYPE_EPI 0x3
 876
 877 /* kept in memory */
 878 struct dcache {
 879     struct afs_q lruq;          /* Free queue for in-memory images */
 880     afs_rwlock_t lock;          /* Protects validPos, some f */
 881     afs_rwlock_t tlock;         /* Atomizes updates to refCount */
 882     afs_rwlock_t mflock;        /* Atomizes accesses/updates to mflags */
 883     afs_size_t validPos;        /* number of valid bytes during fetch */
 884     afs_int32 index;            /* The index in the CacheInfo file*/
 885     short refCount;             /* Associated reference count. */
 886     char dflags;                /* Data flags */
 887     char mflags;                /* Meta flags */
 888     struct fcache f;            /* disk image */
 889     afs_int32 stamp;            /* used with vtodc struct for hints */
 890
 891     /*
 892      * Locking rules:
 893      *
 894      * dcache.lock protects the actual contents of the cache file (in
 895      * f.inode), subfields of f except those noted below, dflags and
 896      * validPos.
 897      *
 898      * dcache.tlock is used to make atomic updates to refCount.  Zero
 899      * refCount dcache entries are protected by afs_xdcache instead of
 900      * tlock.
 901      *
 902      * dcache.mflock is used to access and update mflags.  It cannot be
 903      * held without holding the corresponding dcache.lock.  Updating
 904      * mflags requires holding dcache.lock(R) and dcache.mflock(W), and
 905      * checking for mflags requires dcache.lock(R) and dcache.mflock(R).
 906      * Note that dcache.lock(W) gives you the right to update mflags,
 907      * as dcache.mflock(W) can only be held with dcache.lock(R).
 908      *
 909      * dcache.stamp is protected by the associated vcache lock, because
 910      * it's only purpose is to establish correspondence between vcache
 911      * and dcache entries.
 912      *
 913      * dcache.index, dcache.f.fid, dcache.f.chunk and dcache.f.inode are
 914      * write-protected by afs_xdcache and read-protected by refCount.
 915      * Once an entry is referenced, these values cannot change, and if
 916      * it's on the free list (with refCount=0), it can be reused for a
 917      * different file/chunk.  These values can only be written while
 918      * holding afs_xdcache(W) and allocating this dcache entry (thereby
 919      * ensuring noone else has a refCount on it).
 920      */
 921 };
 922 /* this is obsolete and should be removed */
 923 #define ihint stamp
 924
 925 /* macro to mark a dcache entry as bad */
 926 #define ZapDCE(x) \
 927     do { \
 928         (x)->f.fid.Fid.Unique = 0; \
 929         afs_indexUnique[(x)->index] = 0; \
 930         (x)->dflags |= DFEntryMod; \
 931     } while(0)
 932
 933 /* FakeOpen and Fake Close used to be real subroutines.  They're only used in
 934  * sun_subr and afs_vnodeops, and they're very frequently called, so I made
 935  * them into macros.  They do:
 936  * FakeOpen:  fake the file being open for writing.  avc->lock must be held
 937  * in write mode.  Having the file open for writing is like having a DFS
 938  * write-token: you're known to have the best version of the data around,
 939  * and so the CM won't let it be overwritten by random server info.
 940  * FakeClose:  undo the effects of FakeOpen, noting that we want to ensure
 941  * that a real close eventually gets done.  We use CCore to achieve this if
 942  * we would end up closing the file.  avc->lock must be held in write mode */
 943
 944 #ifdef AFS_AIX_IAUTH_ENV
 945 #define CRKEEP(V, C)  (V)->linkData = (char*)crdup((C))
 946 #else
 947 #define CRKEEP(V, C)  crhold((C)); (V)->linkData = (char*)(C)
 948 #endif
 949
 950 #define afs_FakeOpen(avc) { avc->opens++; avc->execsOrWriters++; }
 951 #define afs_FakeClose(avc, acred) \
 952 { if (avc->execsOrWriters == 1) {  \
 953         /* we're the last writer, just use CCore flag */   \
 954         avc->states |= CCore;   /* causes close to be called later */ \
 955                                                                       \
 956         /* The cred and vnode holds will be released in afs_FlushActiveVcaches */  \
 957         VN_HOLD((struct vnode *)avc);   /* So it won't disappear */           \
 958         CRKEEP(avc, acred); /* Should use a better place for the creds */ \
 959     }                                                                         \
 960     else {                                                                    \
 961         /* we're not the last writer, let the last one do the store-back for us */    \
 962         avc->opens--;                                                         \
 963         avc->execsOrWriters--;                                                \
 964     }                                                                         \
 965 }
 966
 967 #define AFS_ZEROS   64      /* zero buffer */
 968
 969 /*#define afs_DirtyPages(avc)   (((avc)->states & CDirty) || osi_VMDirty_p((avc)))*/
 970 #define afs_DirtyPages(avc)     ((avc)->states & CDirty)
 971
 972 /* The PFlush algorithm makes use of the fact that Fid.Unique is not used in
 973   below hash algorithms.  Change it if need be so that flushing algorithm
 974   doesn't move things from one hash chain to another
 975 */
 976 /* extern int afs_dhashsize; */
 977 #define DCHash(v, c)    ((((v)->Fid.Vnode + (v)->Fid.Volume + (c))) & (afs_dhashsize-1))
 978         /*Vnode, Chunk -> Hash table index*/
 979 #define DVHash(v)       ((((v)->Fid.Vnode + (v)->Fid.Volume )) & (afs_dhashsize-1))
 980         /*Vnode -> Other hash table index*/
 981 /* don't hash on the cell, our callback-breaking code sometimes fails to compute
 982     the cell correctly, and only scans one hash bucket */
 983 #define VCHash(fid)     (((fid)->Fid.Volume + (fid)->Fid.Vnode) & (VCSIZE-1))
 984
 985 extern struct dcache **afs_indexTable;          /*Pointers to in-memory dcache entries*/
 986 extern afs_int32 *afs_indexUnique;                      /*dcache entry Fid.Unique */
 987 extern afs_int32 *afs_dvnextTbl;                        /*Dcache hash table links */
 988 extern afs_int32 *afs_dcnextTbl;                        /*Dcache hash table links */
 989 extern afs_int32 afs_cacheFiles;                        /*Size of afs_indexTable*/
 990 extern afs_int32 afs_cacheBlocks;                       /*1K blocks in cache*/
 991 extern afs_int32 afs_cacheStats;                        /*Stat entries in cache*/
 992 extern struct vcache *afs_vhashT[VCSIZE];       /*Stat cache hash table*/
 993 extern afs_int32 afs_initState;                 /*Initialization state*/
 994 extern afs_int32 afs_termState;                 /* Termination state */
 995 extern struct VenusFid afs_rootFid;             /*Root for whole file system*/
 996 extern afs_int32 afs_allCBs;                            /* Count of callbacks*/
 997 extern afs_int32 afs_oddCBs;                            /* Count of odd callbacks*/
 998 extern afs_int32 afs_evenCBs;                   /* Count of even callbacks*/
 999 extern afs_int32 afs_allZaps;                   /* Count of fid deletes */
1000 extern afs_int32 afs_oddZaps;                   /* Count of odd fid deletes */
1001 extern afs_int32 afs_evenZaps;                  /* Count of even fid deletes */
1002 extern struct brequest afs_brs[NBRS];           /* request structures */
1003
1004 #define UHash(auid)     ((auid) & (NUSERS-1))
1005 #define VHash(avol)     ((avol)&(NVOLS-1))
1006 #define SHash(aserv)    ((ntohl(aserv)) & (NSERVERS-1))
1007 #define FVHash(acell,avol)  (((avol)+(acell)) & (NFENTRIES-1))
1008
1009 extern struct cell          *afs_GetCell();
1010 extern struct cell          *afs_GetCellNoLock();
1011 extern struct cell          *afs_GetCellByName();
1012 extern struct cell          *afs_GetCellByName2();
1013 extern struct cell          *afs_GetCellByIndex();
1014 extern struct unixuser      *afs_GetUser();
1015 extern struct volume        *afs_GetVolume();
1016 extern struct volume        *afs_GetVolumeByName();
1017 extern struct conn          *afs_Conn();
1018 extern struct conn          *afs_ConnByHost();
1019 extern struct conn          *afs_ConnByMHosts();
1020 extern afs_int32            afs_NewCell();
1021 extern struct dcache        *afs_GetDCache();
1022 extern struct dcache        *afs_FindDCache();
1023 extern struct dcache        *afs_NewDCache();
1024 extern struct dcache        *afs_GetDSlot();
1025 extern struct vcache        *afs_GetVCache();
1026 extern struct brequest      *afs_BQueue();
1027
1028 /* afs_cache.c */
1029 extern int afs_CacheInit();
1030 extern void afs_StoreWarn();
1031 extern void afs_AdjustSize();
1032 extern void afs_ComputeCacheParms();
1033 extern void afs_FlushDCache();
1034 extern void afs_FlushActiveVcaches();
1035 extern void afs_StuffVcache();
1036 extern void afs_PutVCache();
1037 extern void afs_TryToSmush();
1038 extern void afs_ProcessFS();
1039 extern void afs_WriteThroughDSlots();
1040 extern void shutdown_cache();
1041 /* afs_call.c */
1042 extern void afs_shutdown();
1043 /* afs_osifile.c */
1044 extern void shutdown_osifile();
1045
1046 /* afs_dynroot.c */
1047 extern int afs_IsDynrootFid();
1048 extern void afs_GetDynrootFid();
1049 extern int afs_IsDynroot();
1050 extern void afs_RefreshDynroot();
1051 extern void afs_GetDynroot();
1052 extern void afs_PutDynroot();
1053 extern int afs_DynrootNewVnode();
1054 extern int afs_SetDynrootEnable();
1055 extern int afs_GetDynrootEnable();
1056 extern int afs_DynrootVOPSymlink();
1057 extern int afs_DynrootVOPRemove();
1058
1059
1060 /* Performance hack - we could replace VerifyVCache2 with the appropriate
1061  * GetVCache incantation, and could eliminate even this code from afs_UFSRead
1062  * by making intentionally invalidating quick.stamp in the various callbacks
1063  * expiration/breaking code */
1064 #ifdef AFS_LINUX20_ENV
1065 #define afs_VerifyVCache(avc, areq)  \
1066   (((avc)->states & CStatd) ? (vcache2inode(avc), 0) : \
1067    afs_VerifyVCache2((avc),areq))
1068 #else
1069 #ifdef AFS_DARWIN_ENV
1070 #define afs_VerifyVCache(avc, areq)  \
1071   (((avc)->states & CStatd) ? (osi_VM_Setup(avc), 0) : \
1072    afs_VerifyVCache2((avc),areq))
1073 #else
1074 #define afs_VerifyVCache(avc, areq)  \
1075   (((avc)->states & CStatd) ? 0 : afs_VerifyVCache2((avc),areq))
1076 #endif
1077 #endif
1078
1079 #define DO_STATS 1  /* bits used by FindVCache */
1080 #define DO_VLRU 2
1081
1082 /* values for flag param of afs_CheckVolumeNames */
1083 #define AFS_VOLCHECK_EXPIRED    0x1     /* volumes whose callbacks have expired */
1084 #define AFS_VOLCHECK_BUSY       0x2     /* volumes which were marked busy */
1085 #define AFS_VOLCHECK_MTPTS      0x4     /* mount point invalidation also */
1086 #define AFS_VOLCHECK_FORCE      0x8     /* do all forcibly */
1087
1088 #endif /* KERNEL */
1089
1090 #define AFS_FSPORT          ((unsigned short) htons(7000))
1091 #define AFS_VLPORT          ((unsigned short) htons(7003))
1092
1093 #define afs_read(avc, uio, acred, albn, abpp, nolock) \
1094         (*(afs_cacheType->vread))(avc, uio, acred, albn, abpp, nolock)
1095 #define afs_write(avc, uio, aio, acred, nolock) \
1096         (*(afs_cacheType->vwrite))(avc, uio, aio, acred, nolock)
1097
1098 #define afs_rdwr(avc, uio, rw, io, cred) \
1099     (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 0) : afs_read(avc, uio, cred, 0, 0, 0))
1100 #define afs_nlrdwr(avc, uio, rw, io, cred) \
1101     (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 1) : afs_read(avc, uio, cred, 0, 0, 1))
1102
1103 extern afs_int32 afs_blocksUsed, afs_blocksDiscarded;
1104 extern afs_int32 afs_discardDCCount, afs_freeDCCount;
1105 extern afs_int32 afs_bulkStatsDone, afs_bulkStatsLost;
1106 extern int afs_TruncateDaemonRunning;
1107 extern int afs_CacheTooFull;
1108 /* Cache size truncation uses the following low and high water marks:
1109  * If the cache is more than 95% full (CM_DCACHECOUNTFREEPCT), the cache
1110  * truncation daemon is awakened and will free up space until the cache is 85%
1111  * (CM_DCACHESPACEFREEPCT - CM_DCACHEEXTRAPCT) full.
1112  * afs_UFSWrite and afs_GetDCache (when it needs to fetch data) will wait on
1113  * afs_WaitForCacheDrain if the cache is 98% (CM_WAITFORDRAINPCT) full.
1114  * afs_GetDownD wakes those processes once the cache is 95% full
1115  * (CM_CACHESIZEDRAINEDPCT).
1116  */
1117 extern void afs_MaybeWakeupTruncateDaemon();
1118 extern void afs_CacheTruncateDaemon();
1119 extern int afs_WaitForCacheDrain;
1120 #define CM_MAXDISCARDEDCHUNKS   16      /* # of chunks */
1121 #define CM_DCACHECOUNTFREEPCT   95      /* max pct of chunks in use */
1122 #define CM_DCACHESPACEFREEPCT   90      /* max pct of space in use */
1123 #define CM_DCACHEEXTRAPCT        5      /* extra to get when freeing */
1124 #define CM_CACHESIZEDRAINEDPCT  95      /* wakeup processes when down to here.*/
1125 #define CM_WAITFORDRAINPCT      98      /* sleep if cache is this full. */
1126
1127 #define afs_CacheIsTooFull() \
1128     (afs_blocksUsed - afs_blocksDiscarded > \
1129         (CM_DCACHECOUNTFREEPCT*afs_cacheBlocks)/100 || \
1130      afs_freeDCCount - afs_discardDCCount < \
1131         ((100-CM_DCACHECOUNTFREEPCT)*afs_cacheFiles)/100)
1132
1133 /* Handy max length of a numeric string. */
1134 #define CVBS    12  /* max afs_int32 is 2^32 ~ 4*10^9, +1 for NULL, +luck */
1135
1136 extern int afs_norefpanic;
1137 #define refpanic(foo) if (afs_norefpanic) \
1138         { printf( foo ); afs_norefpanic++;} else osi_Panic( foo )
1139
1140
1141
1142 /*
1143 ** these are defined in the AIX source code sys/fs_locks.h but are not
1144 ** defined anywhere in the /usr/include directory
1145 */
1146 #if     defined(AFS_AIX41_ENV)
1147 #define VN_LOCK(vp)             simple_lock(&(vp)->v_lock)
1148 #define VN_UNLOCK(vp)           simple_unlock(&(vp)->v_lock)
1149 #endif
1150
1151 /* get a file's serial number from a vnode */
1152 #ifndef afs_vnodeToInumber
1153 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1154 #define afs_vnodeToInumber(V) VnodeToIno(V)
1155 #else
1156 #ifdef AFS_DECOSF_ENV
1157 #define afs_vnodeToInumber(V) osi_vnodeToInumber(V)
1158 #else
1159 #define afs_vnodeToInumber(V) (VTOI(V)->i_number)
1160 #endif /* AFS_DECOSF_ENV */
1161 #endif /* AFS_SGI62_ENV */
1162 #endif
1163
1164 /* get a file's device number from a vnode */
1165 #ifndef afs_vnodeToDev
1166 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1167 #define afs_vnodeToDev(V) VnodeToDev(V)
1168 #else
1169 #ifdef AFS_DECOSF_ENV
1170 #define afs_vnodeToDev(V) osi_vnodeToDev(V)
1171 #else
1172 #define afs_vnodeToDev(V) (VTOI(V)->i_dev)
1173 #endif /* AFS_DECOSF_ENV */
1174 #endif /* AFS_SGI62_ENV */
1175 #endif
1176
1177 #endif  /* _AFS_H_ */
1178