src/config/afs_args.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_ARGS_H_
  11 #define _AFS_ARGS_H_
  12
  13 /*
  14  * AFS system call opcodes
  15  */
  16
  17 #define AFSOP_START_RXCALLBACK    0     /* no aux parms */
  18 #define AFSOP_START_AFS           1     /* no aux parms */
  19 #define AFSOP_START_BKG           2     /* no aux parms */
  20 #define AFSOP_START_TRUNCDAEMON   3     /* no aux parms */
  21 #define AFSOP_START_CS            4     /* no aux parms */
  22 #define AFSOP_ADDCELL             5     /* parm 2 = cell str */
  23 #define AFSOP_CACHEINIT           6     /* parms 2-4 -> cache sizes */
  24 #define AFSOP_CACHEINFO           7     /* the cacheinfo file */
  25 #define AFSOP_VOLUMEINFO          8     /* the volumeinfo file */
  26 #define AFSOP_CACHEFILE           9     /* a random cache file (V*) */
  27 #define AFSOP_CACHEINODE         10     /* random cache file by inode */
  28 #define AFSOP_AFSLOG             11     /* output log file */
  29 #define AFSOP_ROOTVOLUME         12     /* non-standard root volume name */
  30
  31 #define AFSOP_STARTLOG           14     /* temporary: Start afs logging */
  32 #define AFSOP_ENDLOG             15     /* temporary: End afs logging */
  33 #define AFSOP_AFS_VFSMOUNT       16     /* vfsmount cover for hpux */
  34 #define AFSOP_ADVISEADDR         17     /* to init rx cid generator */
  35 #define AFSOP_CLOSEWAIT          18     /* make all closes synchronous */
  36 #define AFSOP_RXEVENT_DAEMON     19     /* rxevent daemon */
  37 #define AFSOP_GETMTU             20     /* stand-in for SIOCGIFMTU, for now */
  38 #define AFSOP_GETIFADDRS         21     /* get machine's ethernet interfaces */
  39
  40 #define AFSOP_ADDCELL2           29     /* 2nd add cell protocol interface */
  41 #define AFSOP_AFSDB_HANDLER      30     /* userspace AFSDB lookup handler */
  42 #define AFSOP_SET_DYNROOT        31     /* enable/disable dynroot support */
  43 #define AFSOP_ADDCELLALIAS       32     /* create alias for existing cell */
  44 #define AFSOP_SET_FAKESTAT       33     /* enable/disable fakestat support */
  45 #define AFSOP_CELLINFO           34     /* set the cellinfo file name */
  46 #define AFSOP_SET_THISCELL       35     /* set the primary cell */
  47 #define AFSOP_BASIC_INIT         36     /* used to be part of START_AFS */
  48 #define AFSOP_SET_BACKUPTREE     37     /* enable backup tree support */
  49 #define AFSOP_SET_RXPCK          38     /* set rx_extraPackets*/
  50 #define AFSOP_BUCKETPCT          39     /* bucket percentage */
  51 #define AFSOP_SET_RXMAXMTU       40     /* set rx_MyMaxSendSize,rx_maxReceiveSizeUser,rx_maxReceiveSize */
  52 #define AFSOP_BKG_HANDLER        41     /* userspace-capable Bkg daemon */
  53 #define AFSOP_GETMASK            42     /* stand-in for SIOCGIFNETMASK */
  54 #define AFSOP_SET_RXMAXFRAGS     43     /* set rxi_nSendFrags, rxi_nRecvFrags */
  55 #define AFSOP_SET_RMTSYS_FLAG    44     /* set flag if rmtsys is enabled */
  56 #define AFSOP_SEED_ENTROPY       45     /* Give the kernel hcrypto entropy */
  57 #define AFSOP_SET_INUMCALC       46     /* set inode number calculation method */
  58 #define AFSOP_SET_VOLUME_TTL     47     /* set the vldb cache timeout */
  59
  60 #define AFSOP_RXLISTENER_DAEMON  48     /* starts kernel RX listener */
  61
  62 #define AFSOP_CACHEBASEDIR       50     /* cache base dir */
  63 #define AFSOP_CACHEDIRS          51     /* number of files per dir */
  64 #define AFSOP_CACHEFILES         52     /* number of files */
  65
  66 #define AFSOP_SETINT             60     /* set key/value pairs for ints */
  67
  68 #define AFSOP_GO                100     /* whether settime is being done */
  69
  70 #define AFSOP_CHECKLOCKS        200     /* dump lock state */
  71 #define AFSOP_SHUTDOWN          201     /* Totally shutdown afs (deallocate all) */
  72
  73 #define AFSOP_STOP_RXCALLBACK   210     /* Stop CALLBACK process */
  74 #define AFSOP_STOP_AFS          211     /* Stop AFS process */
  75 #define AFSOP_STOP_BKG          212     /* Stop BKG process */
  76 #define AFSOP_STOP_TRUNCDAEMON  213     /* Stop cache truncate daemon */
  77 /* AFSOP_STOP_RXEVENT           214        defined in osi.h */
  78 /* AFSOP_STOP_COMPLETE          215        defined in osi.h */
  79 #define AFSOP_STOP_CS           216     /* Stop CheckServer daemon */
  80 /* AFSOP_STOP_RXK_LISTENER      217        defined in osi.h */
  81 #define AFSOP_STOP_AFSDB        218     /* Stop AFSDB handler */
  82 #define AFSOP_STOP_NETIF        219     /* Stop Netif poller */
  83
  84 #define AFSOP_MAX_OPCODE        AFSOP_STOP_NETIF /* Largest defined opcode. */
  85
  86 /*
  87  * AFS system call types and flags.
  88  */
  89
  90 /* The range 20-30 is reserved for AFS system offsets in the afs_syscall */
  91 #define AFSCALL_PIOCTL          20
  92 #define AFSCALL_SETPAG          21
  93 #define AFSCALL_IOPEN           22
  94 #define AFSCALL_ICREATE         23
  95 #define AFSCALL_IREAD           24
  96 #define AFSCALL_IWRITE          25
  97 #define AFSCALL_IINC            26
  98 #define AFSCALL_IDEC            27
  99 #define AFSCALL_CALL            28
 100
 101 #define AFSCALL_ICL             30
 102
 103 /* 64 bit versions of inode system calls. */
 104 #define AFSCALL_IOPEN64         41
 105 #define AFSCALL_ICREATE64       42
 106 #define AFSCALL_IINC64          43
 107 #define AFSCALL_IDEC64          44
 108 #define AFSCALL_ILISTINODE64    45      /* Used by ListViceInodes */
 109 #define AFSCALL_ICREATENAME64   46      /* pass in platform specific pointer
 110                                          * used to create a name in in a
 111                                          * directory.
 112                                          */
 113 #ifdef AFS_SGI_VNODE_GLUE
 114 #define AFSCALL_INIT_KERNEL_CONFIG 47   /* set vnode glue ops. */
 115 #endif
 116
 117 /* these are for initialization flags */
 118
 119 #define AFSCALL_INIT_MEMCACHE 0x1
 120
 121 /* flags for rxstats pioctl */
 122
 123 #define AFSCALL_RXSTATS_MASK    0x7     /* Valid flag bits */
 124 #define AFSCALL_RXSTATS_ENABLE  0x1     /* Enable RX stats */
 125 #define AFSCALL_RXSTATS_DISABLE 0x2     /* Disable RX stats */
 126 #define AFSCALL_RXSTATS_CLEAR   0x4     /* Clear RX stats */
 127
 128 /* Main afs syscall entry; this number may vary per system (i.e. defined in afs/param.h) */
 129 #ifndef AFS_SYSCALL
 130 #define AFS_SYSCALL             31
 131 #endif
 132
 133 /* arguments passed by afsd */
 134 #define IDTYPE_UID 0
 135
 136 /* We don't necessarily have VenusFid here */
 137 struct afs_umv_param {
 138     afs_int32 id;
 139     afs_int32 idtype;
 140     afs_int32 sCell;
 141     afs_int32 sVolume;
 142     afs_int32 sVnode;
 143     afs_int32 sUnique;
 144     afs_int32 dCell;
 145     afs_int32 dVolume;
 146     afs_int32 dVnode;
 147     afs_int32 dUnique;
 148 };
 149
 150 #define AFS_USPC_UMV 1
 151
 152 struct afs_uspc_param {
 153     afs_int32 retval;
 154     afs_int32 ts; /* brequest ts - always unique */
 155     afs_int32 bufSz;
 156     afs_int32 reqtype;
 157     union {
 158         struct afs_umv_param umv;
 159     } req;
 160 };
 161
 162 struct afs_cacheParams {
 163     afs_int32 cacheScaches;
 164     afs_int32 cacheFiles;
 165     afs_int32 cacheBlocks;
 166     afs_int32 cacheDcaches;
 167     afs_int32 cacheVolumes;
 168     afs_int32 chunkSize;
 169     afs_int32 setTimeFlag;
 170     afs_int32 memCacheFlag;
 171     afs_int32 inodes;
 172     afs_int32 users;
 173     afs_int32 dynamic_vcaches;
 174 };
 175
 176 /* Supported values for AFSOP_SET_INUMCALC. */
 177 enum {
 178     AFS_INUMCALC_COMPAT = 0,
 179     AFS_INUMCALC_MD5 = 1
 180 };
 181
 182
 183 /*
 184  * Note that the AFS_*ALLOCSIZ values should be multiples of sizeof(void*) to
 185  * accomodate pointer alignment.
 186  */
 187 /* Used in rx.c as well as afs directory. */
 188 #if     defined(AFS_AIX32_ENV) || defined(AFS_HPUX_ENV)
 189 /* XXX Because of rxkad_cprivate... XXX */
 190 #define AFS_SMALLOCSIZ  (38*sizeof(void *))     /* "Small" allocated size */
 191 #else
 192 #define AFS_SMALLOCSIZ  (64*sizeof(void *))     /*  "Small" allocated size */
 193 #endif
 194 #define AFS_LRALLOCSIZ  4096    /* "Large" allocated size */
 195
 196 /* Cache configuration available through the client callback interface */
 197 typedef struct cm_initparams_v1 {
 198     afs_uint32 nChunkFiles;
 199     afs_uint32 nStatCaches;
 200     afs_uint32 nDataCaches;
 201     afs_uint32 nVolumeCaches;
 202     afs_uint32 firstChunkSize;
 203     afs_uint32 otherChunkSize;
 204     afs_uint32 cacheSize;
 205     afs_uint32 setTime;
 206     afs_uint32 memCache;
 207 } cm_initparams_v1;
 208
 209 /*
 210  * If you need to change afs_cacheParams, you should probably create a brand
 211  * new structure.  Keeping the old structure will allow backwards compatibility
 212  * with old clients (even if it is only used to calculate allocation size).
 213  * If you do change the size or the format, you'll need to bump
 214  * AFS_CLIENT_CONFIG_RETRIEVAL_VERSION.  This allows some primitive form
 215  * of versioning a la rxdebug.
 216  */
 217
 218 #define AFS_CLIENT_RETRIEVAL_VERSION            1       /* latest version */
 219 #define AFS_CLIENT_RETRIEVAL_FIRST_EDITION      1       /* first version */
 220
 221 /* Defines and structures for the AFS proc replacement layer for the original syscall (AFS_SYSCALL) strategy */
 222
 223 #ifdef AFS_LINUX20_ENV
 224
 225 #define PROC_FSDIRNAME "openafs"
 226 #define PROC_SYSCALL_NAME "afs_ioctl"
 227 #define PROC_SYSCALL_FNAME "/proc/fs/openafs/afs_ioctl"
 228 #define PROC_SYSCALL_ARLA_FNAME "/proc/fs/nnpfs/afs_ioctl"
 229 #define PROC_CELLSERVDB_NAME "CellServDB"
 230 #define PROC_PEER_NAME "rx_peer"
 231 #define PROC_CONN_NAME "rx_conn"
 232 #define PROC_CALL_NAME "rx_call"
 233 #define PROC_RX_NAME "rx"
 234 #define PROC_SERVICES_NAME "rx_services"
 235 #define PROC_RXSTATS_NAME "rx_stats"
 236 #define VIOC_SYSCALL_TYPE 'C'
 237 #define VIOC_SYSCALL _IOW(VIOC_SYSCALL_TYPE,1,void *)
 238 #define VIOC_SYSCALL32 _IOW(VIOC_SYSCALL_TYPE,1,int)
 239
 240 struct afsprocdata {
 241   long param4;
 242   long param3;
 243   long param2;
 244   long param1;
 245   long syscall;
 246 };
 247
 248 struct afsprocdata32 {
 249   unsigned int param4;
 250   unsigned int param3;
 251   unsigned int param2;
 252   unsigned int param1;
 253   unsigned int syscall;
 254 };
 255
 256 #endif
 257
 258 #ifdef AFS_DARWIN80_ENV
 259 struct afssysargs {
 260     unsigned int syscall;
 261     unsigned int param1;
 262     unsigned int param2;
 263     unsigned int param3;
 264     unsigned int param4;
 265     unsigned int param5;
 266     unsigned int param6;
 267     unsigned int retval;
 268 };
 269
 270 /* args reordered to avoid alignment issues */
 271 struct afssysargs64 {
 272     user_addr_t param1;
 273     user_addr_t param2;
 274     user_addr_t param3;
 275     user_addr_t param4;
 276     user_addr_t param5;
 277     user_addr_t param6;
 278     unsigned int syscall;
 279     unsigned int retval;
 280 };
 281 #define VIOC_SYSCALL_TYPE 'C'
 282 #define VIOC_SYSCALL _IOWR(VIOC_SYSCALL_TYPE,1,struct afssysargs)
 283 #define VIOC_SYSCALL64 _IOWR(VIOC_SYSCALL_TYPE,2,struct afssysargs64)
 284 #define SYSCALL_DEV_FNAME "/dev/openafs_ioctl"
 285 #endif
 286
 287 #ifdef AFS_SUN511_ENV
 288 # define VIOC_SYSCALL_TYPE 'C'
 289 # define VIOC_SYSCALL _IOW(VIOC_SYSCALL_TYPE, 1, struct afssysargs)
 290 # define VIOC_SYSCALL32 _IOW(VIOC_SYSCALL_TYPE, 2, struct afssysargs32)
 291 # define SYSCALL_DEV_FNAME "/dev/afs"
 292
 293 struct afssysargs {
 294     afs_uint64 param6;
 295     afs_uint64 param5;
 296     afs_uint64 param4;
 297     afs_uint64 param3;
 298     afs_uint64 param2;
 299     afs_uint64 param1;
 300     afs_uint32 syscall;
 301 };
 302
 303 struct afssysargs32 {
 304     afs_uint32 param6;
 305     afs_uint32 param5;
 306     afs_uint32 param4;
 307     afs_uint32 param3;
 308     afs_uint32 param2;
 309     afs_uint32 param1;
 310     afs_uint32 syscall;
 311 };
 312 #endif /* AFS_SUN511_ENV */
 313
 314 #ifdef AFS_CACHE_VNODE_PATH
 315 #define AFS_CACHE_CELLS_INODE -2
 316 #define AFS_CACHE_ITEMS_INODE -3
 317 #define AFS_CACHE_VOLUME_INODE -4
 318 #endif
 319
 320 #endif /* _AFS_ARGS_H_ */