afs: Detect VIOCPREFETCH special case properly
[openafs.git] / src / afs / afs_pioctl.c
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 #include <afsconfig.h>
11 #include "afs/param.h"
12
13
14 #include "afs/sysincludes.h"    /* Standard vendor system headers */
15 #ifdef AFS_OBSD_ENV
16 #include "h/syscallargs.h"
17 #endif
18 #ifdef AFS_FBSD_ENV
19 #include "h/sysproto.h"
20 #endif
21 #ifdef AFS_NBSD40_ENV
22 #include <sys/ioctl.h>
23 #include <sys/ioccom.h>
24 #endif
25 #include "afsincludes.h"        /* Afs-based standard headers */
26 #include "afs/afs_stats.h"      /* afs statistics */
27 #include "afs/vice.h"
28 #include "afs/afs_bypasscache.h"
29 #include "rx/rx_globals.h"
30 #include "token.h"
31
32 extern int afs_rmtsys_enable;
33 struct VenusFid afs_rootFid;
34 afs_int32 afs_waitForever = 0;
35 short afs_waitForeverCount = 0;
36 afs_int32 afs_showflags = GAGUSER | GAGCONSOLE; /* show all messages */
37
38 afs_int32 afs_is_disconnected;
39 afs_int32 afs_is_discon_rw;
40 /* On reconnection, turn this knob on until it finishes,
41  * then turn it off.
42  */
43 afs_int32 afs_in_sync = 0;
44
45 struct afs_pdata {
46     char *ptr;
47     size_t remaining;
48 };
49
50 /*
51  * A set of handy little functions for encoding and decoding
52  * pioctls without losing your marbles, or memory integrity
53  */
54
55 static_inline int
56 afs_pd_alloc(struct afs_pdata *apd, size_t size)
57 {
58     /* Ensure that we give caller at least one trailing guard byte
59      * for the NUL terminator. */
60     if (size >= AFS_LRALLOCSIZ)
61         apd->ptr = osi_Alloc(size + 1);
62     else
63         apd->ptr = osi_AllocLargeSpace(AFS_LRALLOCSIZ);
64
65     if (apd->ptr == NULL)
66         return ENOMEM;
67
68     /* Clear it all now, including the guard byte. */
69     if (size >= AFS_LRALLOCSIZ)
70         memset(apd->ptr, 0, size + 1);
71     else
72         memset(apd->ptr, 0, AFS_LRALLOCSIZ);
73
74     /* Don't tell the caller about the guard byte. */
75     apd->remaining = size;
76
77     return 0;
78 }
79
80 static_inline void
81 afs_pd_free(struct afs_pdata *apd)
82 {
83     if (apd->ptr == NULL)
84         return;
85
86     if (apd->remaining >= AFS_LRALLOCSIZ)
87         osi_Free(apd->ptr, apd->remaining + 1);
88     else
89         osi_FreeLargeSpace(apd->ptr);
90
91     apd->ptr = NULL;
92     apd->remaining = 0;
93 }
94
95 static_inline char *
96 afs_pd_where(struct afs_pdata *apd)
97 {
98     return apd ? apd->ptr : NULL;
99 }
100
101 static_inline size_t
102 afs_pd_remaining(struct afs_pdata *apd)
103 {
104     return apd ? apd->remaining : 0;
105 }
106
107 static_inline int
108 afs_pd_skip(struct afs_pdata *apd, size_t skip)
109 {
110     if (apd == NULL || apd->remaining < skip)
111         return EINVAL;
112     apd->remaining -= skip;
113     apd->ptr += skip;
114
115     return 0;
116 }
117
118 static_inline int
119 afs_pd_getBytes(struct afs_pdata *apd, void *dest, size_t bytes)
120 {
121     if (apd == NULL || apd->remaining < bytes)
122         return EINVAL;
123     apd->remaining -= bytes;
124     memcpy(dest, apd->ptr, bytes);
125     apd->ptr += bytes;
126     return 0;
127 }
128
129 static_inline int
130 afs_pd_getInt(struct afs_pdata *apd, afs_int32 *val)
131 {
132     return afs_pd_getBytes(apd, val, sizeof(*val));
133 }
134
135 static_inline int
136 afs_pd_getUint(struct afs_pdata *apd, afs_uint32 *val)
137 {
138     return afs_pd_getBytes(apd, val, sizeof(*val));
139 }
140
141 static_inline void *
142 afs_pd_inline(struct afs_pdata *apd, size_t bytes)
143 {
144     void *ret;
145
146     if (apd == NULL || apd->remaining < bytes)
147         return NULL;
148
149     ret = apd->ptr;
150
151     apd->remaining -= bytes;
152     apd->ptr += bytes;
153
154     return ret;
155 }
156
157 static_inline void
158 afs_pd_xdrStart(struct afs_pdata *apd, XDR *xdrs, enum xdr_op op) {
159     xdrmem_create(xdrs, apd->ptr, apd->remaining, op);
160 }
161
162 static_inline void
163 afs_pd_xdrEnd(struct afs_pdata *apd, XDR *xdrs) {
164     size_t pos;
165
166     pos = xdr_getpos(xdrs);
167     apd->ptr += pos;
168     apd->remaining -= pos;
169     xdr_destroy(xdrs);
170 }
171
172
173
174 static_inline int
175 afs_pd_getString(struct afs_pdata *apd, char *str, size_t maxLen)
176 {
177     size_t len;
178
179     if (apd == NULL || apd->remaining <= 0)
180         return EINVAL;
181     len = strlen(apd->ptr) + 1;
182     if (len > maxLen)
183         return E2BIG;
184     memcpy(str, apd->ptr, len);
185     apd->ptr += len;
186     apd->remaining -= len;
187     return 0;
188 }
189
190 static_inline int
191 afs_pd_getStringPtr(struct afs_pdata *apd, char **str)
192 {
193     size_t len;
194
195     if (apd == NULL || apd->remaining <= 0)
196         return EINVAL;
197     len = strlen(apd->ptr) + 1;
198     *str = apd->ptr;
199     apd->ptr += len;
200     apd->remaining -= len;
201     return 0;
202 }
203
204 static_inline int
205 afs_pd_putBytes(struct afs_pdata *apd, const void *bytes, size_t len)
206 {
207     if (apd == NULL || apd->remaining < len)
208         return E2BIG;
209     memcpy(apd->ptr, bytes, len);
210     apd->ptr += len;
211     apd->remaining -= len;
212     return 0;
213 }
214
215 static_inline int
216 afs_pd_putInt(struct afs_pdata *apd, afs_int32 val)
217 {
218     return afs_pd_putBytes(apd, &val, sizeof(val));
219 }
220
221 static_inline int
222 afs_pd_putString(struct afs_pdata *apd, char *str) {
223
224     /* Add 1 so we copy the NULL too */
225     return afs_pd_putBytes(apd, str, strlen(str) +1);
226 }
227
228 /*!
229  * \defgroup pioctl Path IOCTL functions
230  *
231  * DECL_PIOCTL is a macro defined to contain the following parameters for functions:
232  *
233  * \param[in] avc
234  *      the AFS vcache structure in use by pioctl
235  * \param[in] afun
236  *      not in use
237  * \param[in] areq
238  *      the AFS vrequest structure
239  * \param[in] ain
240  *      an afs_pdata block describing the data received from the caller
241  * \param[in] aout
242  *      an afs_pdata block describing a pre-allocated block for output
243  * \param[in] acred
244  *      UNIX credentials structure underlying the operation
245  */
246
247 #define DECL_PIOCTL(x) \
248         static int x(struct vcache *avc, int afun, struct vrequest *areq, \
249                      struct afs_pdata *ain, struct afs_pdata *aout, \
250                      afs_ucred_t **acred)
251
252 /* Prototypes for pioctl routines */
253 DECL_PIOCTL(PGetFID);
254 DECL_PIOCTL(PSetAcl);
255 DECL_PIOCTL(PStoreBehind);
256 DECL_PIOCTL(PGCPAGs);
257 DECL_PIOCTL(PGetAcl);
258 DECL_PIOCTL(PNoop);
259 DECL_PIOCTL(PBogus);
260 DECL_PIOCTL(PGetFileCell);
261 DECL_PIOCTL(PGetWSCell);
262 DECL_PIOCTL(PGetUserCell);
263 DECL_PIOCTL(PSetTokens);
264 DECL_PIOCTL(PSetTokens2);
265 DECL_PIOCTL(PGetVolumeStatus);
266 DECL_PIOCTL(PSetVolumeStatus);
267 DECL_PIOCTL(PFlush);
268 DECL_PIOCTL(PNewStatMount);
269 DECL_PIOCTL(PGetTokens);
270 DECL_PIOCTL(PGetTokens2);
271 DECL_PIOCTL(PUnlog);
272 DECL_PIOCTL(PMariner);
273 DECL_PIOCTL(PCheckServers);
274 DECL_PIOCTL(PCheckVolNames);
275 DECL_PIOCTL(PCheckAuth);
276 DECL_PIOCTL(PFindVolume);
277 DECL_PIOCTL(PViceAccess);
278 DECL_PIOCTL(PSetCacheSize);
279 DECL_PIOCTL(PGetCacheSize);
280 DECL_PIOCTL(PRemoveCallBack);
281 DECL_PIOCTL(PNewCell);
282 DECL_PIOCTL(PNewAlias);
283 DECL_PIOCTL(PListCells);
284 DECL_PIOCTL(PListAliases);
285 DECL_PIOCTL(PRemoveMount);
286 DECL_PIOCTL(PGetCellStatus);
287 DECL_PIOCTL(PSetCellStatus);
288 DECL_PIOCTL(PFlushVolumeData);
289 DECL_PIOCTL(PFlushAllVolumeData);
290 DECL_PIOCTL(PGetVnodeXStatus);
291 DECL_PIOCTL(PGetVnodeXStatus2);
292 DECL_PIOCTL(PSetSysName);
293 DECL_PIOCTL(PSetSPrefs);
294 DECL_PIOCTL(PSetSPrefs33);
295 DECL_PIOCTL(PGetSPrefs);
296 DECL_PIOCTL(PExportAfs);
297 DECL_PIOCTL(PGag);
298 DECL_PIOCTL(PTwiddleRx);
299 DECL_PIOCTL(PGetInitParams);
300 DECL_PIOCTL(PGetRxkcrypt);
301 DECL_PIOCTL(PSetRxkcrypt);
302 DECL_PIOCTL(PGetCPrefs);
303 DECL_PIOCTL(PSetCPrefs);
304 DECL_PIOCTL(PFlushMount);
305 DECL_PIOCTL(PRxStatProc);
306 DECL_PIOCTL(PRxStatPeer);
307 DECL_PIOCTL(PPrefetchFromTape);
308 DECL_PIOCTL(PFsCmd);
309 DECL_PIOCTL(PCallBackAddr);
310 DECL_PIOCTL(PDiscon);
311 DECL_PIOCTL(PNFSNukeCreds);
312 DECL_PIOCTL(PNewUuid);
313 DECL_PIOCTL(PPrecache);
314 DECL_PIOCTL(PGetPAG);
315 #if defined(AFS_CACHE_BYPASS) && defined(AFS_LINUX24_ENV)
316 DECL_PIOCTL(PSetCachingThreshold);
317 #endif
318
319 /*
320  * A macro that says whether we're going to need HandleClientContext().
321  * This is currently used only by the nfs translator.
322  */
323 #if !defined(AFS_NONFSTRANS) || defined(AFS_AIX_IAUTH_ENV)
324 #define AFS_NEED_CLIENTCONTEXT
325 #endif
326
327 /* Prototypes for private routines */
328 #ifdef AFS_NEED_CLIENTCONTEXT
329 static int HandleClientContext(struct afs_ioctl *ablob, int *com,
330                                afs_ucred_t **acred,
331                                afs_ucred_t *credp);
332 #endif
333 int HandleIoctl(struct vcache *avc, afs_int32 acom,
334                 struct afs_ioctl *adata);
335 int afs_HandlePioctl(struct vnode *avp, afs_int32 acom,
336                      struct afs_ioctl *ablob, int afollow,
337                      afs_ucred_t **acred);
338 static int Prefetch(uparmtype apath, struct afs_ioctl *adata, int afollow,
339                     afs_ucred_t *acred);
340
341 typedef int (*pioctlFunction) (struct vcache *, int, struct vrequest *,
342                                struct afs_pdata *, struct afs_pdata *,
343                                afs_ucred_t **);
344
345 static pioctlFunction VpioctlSw[] = {
346     PBogus,                     /* 0 */
347     PSetAcl,                    /* 1 */
348     PGetAcl,                    /* 2 */
349     PSetTokens,                 /* 3 */
350     PGetVolumeStatus,           /* 4 */
351     PSetVolumeStatus,           /* 5 */
352     PFlush,                     /* 6 */
353     PBogus,                     /* 7 */
354     PGetTokens,                 /* 8 */
355     PUnlog,                     /* 9 */
356     PCheckServers,              /* 10 */
357     PCheckVolNames,             /* 11 */
358     PCheckAuth,                 /* 12 */
359     PBogus,                     /* 13 -- used to be quick check time */
360     PFindVolume,                /* 14 */
361     PBogus,                     /* 15 -- prefetch is now special-cased; see pioctl code! */
362     PBogus,                     /* 16 -- used to be testing code */
363     PNoop,                      /* 17 -- used to be enable group */
364     PNoop,                      /* 18 -- used to be disable group */
365     PBogus,                     /* 19 -- used to be list group */
366     PViceAccess,                /* 20 */
367     PUnlog,                     /* 21 -- unlog *is* unpag in this system */
368     PGetFID,                    /* 22 -- get file ID */
369     PBogus,                     /* 23 -- used to be waitforever */
370     PSetCacheSize,              /* 24 */
371     PRemoveCallBack,            /* 25 -- flush only the callback */
372     PNewCell,                   /* 26 */
373     PListCells,                 /* 27 */
374     PRemoveMount,               /* 28 -- delete mount point */
375     PNewStatMount,              /* 29 -- new style mount point stat */
376     PGetFileCell,               /* 30 -- get cell name for input file */
377     PGetWSCell,                 /* 31 -- get cell name for workstation */
378     PMariner,                   /* 32 - set/get mariner host */
379     PGetUserCell,               /* 33 -- get cell name for user */
380     PBogus,                     /* 34 -- Enable/Disable logging */
381     PGetCellStatus,             /* 35 */
382     PSetCellStatus,             /* 36 */
383     PFlushVolumeData,           /* 37 -- flush all data from a volume */
384     PSetSysName,                /* 38 - Set system name */
385     PExportAfs,                 /* 39 - Export Afs to remote nfs clients */
386     PGetCacheSize,              /* 40 - get cache size and usage */
387     PGetVnodeXStatus,           /* 41 - get vcache's special status */
388     PSetSPrefs33,               /* 42 - Set CM Server preferences... */
389     PGetSPrefs,                 /* 43 - Get CM Server preferences... */
390     PGag,                       /* 44 - turn off/on all CM messages */
391     PTwiddleRx,                 /* 45 - adjust some RX params       */
392     PSetSPrefs,                 /* 46 - Set CM Server preferences... */
393     PStoreBehind,               /* 47 - set degree of store behind to be done */
394     PGCPAGs,                    /* 48 - disable automatic pag gc-ing */
395     PGetInitParams,             /* 49 - get initial cm params */
396     PGetCPrefs,                 /* 50 - get client interface addresses */
397     PSetCPrefs,                 /* 51 - set client interface addresses */
398     PFlushMount,                /* 52 - flush mount symlink data */
399     PRxStatProc,                /* 53 - control process RX statistics */
400     PRxStatPeer,                /* 54 - control peer RX statistics */
401     PGetRxkcrypt,               /* 55 -- Get rxkad encryption flag */
402     PSetRxkcrypt,               /* 56 -- Set rxkad encryption flag */
403     PBogus,                     /* 57 -- arla: set file prio */
404     PBogus,                     /* 58 -- arla: fallback getfh */
405     PBogus,                     /* 59 -- arla: fallback fhopen */
406     PBogus,                     /* 60 -- arla: controls xfsdebug */
407     PBogus,                     /* 61 -- arla: controls arla debug */
408     PBogus,                     /* 62 -- arla: debug interface */
409     PBogus,                     /* 63 -- arla: print xfs status */
410     PBogus,                     /* 64 -- arla: force cache check */
411     PBogus,                     /* 65 -- arla: break callback */
412     PPrefetchFromTape,          /* 66 -- MR-AFS: prefetch file from tape */
413     PFsCmd,                     /* 67 -- RXOSD: generic commnd interface */
414     PBogus,                     /* 68 -- arla: fetch stats */
415     PGetVnodeXStatus2,          /* 69 - get caller access and some vcache status */
416 };
417
418 static pioctlFunction CpioctlSw[] = {
419     PBogus,                     /* 0 */
420     PNewAlias,                  /* 1 -- create new cell alias */
421     PListAliases,               /* 2 -- list cell aliases */
422     PCallBackAddr,              /* 3 -- request addr for callback rxcon */
423     PBogus,                     /* 4 */
424     PDiscon,                    /* 5 -- get/set discon mode */
425     PBogus,                     /* 6 */
426     PGetTokens2,                /* 7 */
427     PSetTokens2,                /* 8 */
428     PNewUuid,                   /* 9 */
429     PBogus,                     /* 10 */
430     PBogus,                     /* 11 */
431     PPrecache,                  /* 12 */
432     PGetPAG,                    /* 13 */
433     PFlushAllVolumeData,        /* 14 */
434 };
435
436 static pioctlFunction OpioctlSw[]  = {
437     PBogus,                     /* 0 */
438     PNFSNukeCreds,              /* 1 -- nuke all creds for NFS client */
439 #if defined(AFS_CACHE_BYPASS) && defined(AFS_LINUX24_ENV)
440     PSetCachingThreshold        /* 2 -- get/set cache-bypass size threshold */
441 #else
442     PNoop                       /* 2 -- get/set cache-bypass size threshold */
443 #endif
444 };
445
446 #define PSetClientContext 99    /*  Special pioctl to setup caller's creds  */
447 int afs_nobody = NFS_NOBODY;
448
449 int
450 HandleIoctl(struct vcache *avc, afs_int32 acom,
451             struct afs_ioctl *adata)
452 {
453     afs_int32 code;
454
455     code = 0;
456     AFS_STATCNT(HandleIoctl);
457
458     switch (acom & 0xff) {
459     case 1:
460         avc->f.states |= CSafeStore;
461         avc->asynchrony = 0;
462         /* SXW - Should we force a MetaData flush for this flag setting */
463         break;
464
465         /* case 2 used to be abort store, but this is no longer provided,
466          * since it is impossible to implement under normal Unix.
467          */
468
469     case 3:{
470             /* return the name of the cell this file is open on */
471             struct cell *tcell;
472             afs_int32 i;
473
474             tcell = afs_GetCell(avc->f.fid.Cell, READ_LOCK);
475             if (tcell) {
476                 i = strlen(tcell->cellName) + 1;        /* bytes to copy out */
477
478                 if (i > adata->out_size) {
479                     /* 0 means we're not interested in the output */
480                     if (adata->out_size != 0)
481                         code = EFAULT;
482                 } else {
483                     /* do the copy */
484                     AFS_COPYOUT(tcell->cellName, adata->out, i, code);
485                 }
486                 afs_PutCell(tcell, READ_LOCK);
487             } else
488                 code = ENOTTY;
489         }
490         break;
491
492     case 49:                    /* VIOC_GETINITPARAMS */
493         if (adata->out_size < sizeof(struct cm_initparams)) {
494             code = EFAULT;
495         } else {
496             AFS_COPYOUT(&cm_initParams, adata->out,
497                         sizeof(struct cm_initparams), code);
498         }
499         break;
500
501     default:
502
503         code = EINVAL;
504 #ifdef AFS_AIX51_ENV
505         code = ENOSYS;
506 #endif
507         break;
508     }
509     return code;                /* so far, none implemented */
510 }
511
512 #ifdef AFS_AIX_ENV
513 /* For aix we don't temporarily bypass ioctl(2) but rather do our
514  * thing directly in the vnode layer call, VNOP_IOCTL; thus afs_ioctl
515  * is now called from afs_gn_ioctl.
516  */
517 int
518 afs_ioctl(struct vcache *tvc, int cmd, int arg)
519 {
520     struct afs_ioctl data;
521     int error = 0;
522
523     AFS_STATCNT(afs_ioctl);
524     if (((cmd >> 8) & 0xff) == 'V') {
525         /* This is a VICEIOCTL call */
526         AFS_COPYIN(arg, (caddr_t) & data, sizeof(data), error);
527         if (error)
528             return (error);
529         error = HandleIoctl(tvc, cmd, &data);
530         return (error);
531     } else {
532         /* No-op call; just return. */
533         return (ENOTTY);
534     }
535 }
536 # if defined(AFS_AIX32_ENV)
537 #  if defined(AFS_AIX51_ENV)
538 #   ifdef __64BIT__
539 int
540 kioctl(int fdes, int com, caddr_t arg, caddr_t ext, caddr_t arg2,
541            caddr_t arg3)
542 #   else /* __64BIT__ */
543 int
544 kioctl32(int fdes, int com, caddr_t arg, caddr_t ext, caddr_t arg2,
545              caddr_t arg3)
546 #   endif /* __64BIT__ */
547 #  else
548 int
549 kioctl(int fdes, int com, caddr_t arg, caddr_t ext)
550 #  endif /* AFS_AIX51_ENV */
551 {
552     struct a {
553         int fd, com;
554         caddr_t arg, ext;
555 #  ifdef AFS_AIX51_ENV
556         caddr_t arg2, arg3;
557 #  endif
558     } u_uap, *uap = &u_uap;
559     struct file *fd;
560     struct vcache *tvc;
561     int ioctlDone = 0, code = 0;
562
563     AFS_STATCNT(afs_xioctl);
564     uap->fd = fdes;
565     uap->com = com;
566     uap->arg = arg;
567 #  ifdef AFS_AIX51_ENV
568     uap->arg2 = arg2;
569     uap->arg3 = arg3;
570 #  endif
571     if (setuerror(getf(uap->fd, &fd))) {
572         return -1;
573     }
574     if (fd->f_type == DTYPE_VNODE) {
575         /* good, this is a vnode; next see if it is an AFS vnode */
576         tvc = VTOAFS(fd->f_vnode);      /* valid, given a vnode */
577         if (tvc && IsAfsVnode(AFSTOV(tvc))) {
578             /* This is an AFS vnode */
579             if (((uap->com >> 8) & 0xff) == 'V') {
580                 struct afs_ioctl *datap;
581                 AFS_GLOCK();
582                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
583                 code=copyin_afs_ioctl((char *)uap->arg, datap);
584                 if (code) {
585                     osi_FreeSmallSpace(datap);
586                     AFS_GUNLOCK();
587 #  if defined(AFS_AIX41_ENV)
588                     ufdrele(uap->fd);
589 #  endif
590                     return (setuerror(code), code);
591                 }
592                 code = HandleIoctl(tvc, uap->com, datap);
593                 osi_FreeSmallSpace(datap);
594                 AFS_GUNLOCK();
595                 ioctlDone = 1;
596 #  if defined(AFS_AIX41_ENV)
597                 ufdrele(uap->fd);
598 #  endif
599              }
600         }
601     }
602     if (!ioctlDone) {
603 #  if defined(AFS_AIX41_ENV)
604         ufdrele(uap->fd);
605 #   if defined(AFS_AIX51_ENV)
606 #    ifdef __64BIT__
607         code = okioctl(fdes, com, arg, ext, arg2, arg3);
608 #    else /* __64BIT__ */
609         code = okioctl32(fdes, com, arg, ext, arg2, arg3);
610 #    endif /* __64BIT__ */
611 #   else /* !AFS_AIX51_ENV */
612         code = okioctl(fdes, com, arg, ext);
613 #   endif /* AFS_AIX51_ENV */
614         return code;
615 #  elif defined(AFS_AIX32_ENV)
616         okioctl(fdes, com, arg, ext);
617 #  endif
618     }
619 #  if defined(KERNEL_HAVE_UERROR)
620     if (!getuerror())
621         setuerror(code);
622 #   if !defined(AFS_AIX41_ENV)
623     return (getuerror()? -1 : u.u_ioctlrv);
624 #   else
625     return getuerror()? -1 : 0;
626 #   endif
627 #  endif
628     return 0;
629 }
630 # endif
631
632 #elif defined(AFS_SGI_ENV)
633 # if defined(AFS_SGI65_ENV)
634 afs_ioctl(OSI_VN_DECL(tvc), int cmd, void *arg, int flag, cred_t * cr,
635           rval_t * rvalp, struct vopbd * vbds)
636 # else
637 afs_ioctl(OSI_VN_DECL(tvc), int cmd, void *arg, int flag, cred_t * cr,
638           rval_t * rvalp, struct vopbd * vbds)
639 # endif
640 {
641     struct afs_ioctl data;
642     int error = 0;
643     int locked;
644
645     OSI_VN_CONVERT(tvc);
646
647     AFS_STATCNT(afs_ioctl);
648     if (((cmd >> 8) & 0xff) == 'V') {
649         /* This is a VICEIOCTL call */
650         error = copyin_afs_ioctl(arg, &data);
651         if (error)
652             return (error);
653         locked = ISAFS_GLOCK();
654         if (!locked)
655             AFS_GLOCK();
656         error = HandleIoctl(tvc, cmd, &data);
657         if (!locked)
658             AFS_GUNLOCK();
659         return (error);
660     } else {
661         /* No-op call; just return. */
662         return (ENOTTY);
663     }
664 }
665 #elif defined(AFS_SUN5_ENV)
666 struct afs_ioctl_sys {
667     int fd;
668     int com;
669     int arg;
670 };
671
672 int
673 afs_xioctl(struct afs_ioctl_sys *uap, rval_t *rvp)
674 {
675     struct file *fd;
676     struct vcache *tvc;
677     int ioctlDone = 0, code = 0;
678
679     AFS_STATCNT(afs_xioctl);
680     fd = getf(uap->fd);
681     if (!fd)
682         return (EBADF);
683     if (fd->f_vnode->v_type == VREG || fd->f_vnode->v_type == VDIR) {
684         tvc = VTOAFS(fd->f_vnode);      /* valid, given a vnode */
685         if (tvc && IsAfsVnode(AFSTOV(tvc))) {
686             /* This is an AFS vnode */
687             if (((uap->com >> 8) & 0xff) == 'V') {
688                 struct afs_ioctl *datap;
689                 AFS_GLOCK();
690                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
691                 code=copyin_afs_ioctl((char *)uap->arg, datap);
692                 if (code) {
693                     osi_FreeSmallSpace(datap);
694                     AFS_GUNLOCK();
695                     releasef(uap->fd);
696                     return (EFAULT);
697                 }
698                 code = HandleIoctl(tvc, uap->com, datap);
699                 osi_FreeSmallSpace(datap);
700                 AFS_GUNLOCK();
701                 ioctlDone = 1;
702             }
703         }
704     }
705     releasef(uap->fd);
706     if (!ioctlDone)
707         code = ioctl(uap, rvp);
708
709     return (code);
710 }
711 #elif defined(AFS_LINUX22_ENV)
712 struct afs_ioctl_sys {
713     unsigned int com;
714     unsigned long arg;
715 };
716 int
717 afs_xioctl(struct inode *ip, struct file *fp, unsigned int com,
718            unsigned long arg)
719 {
720     struct afs_ioctl_sys ua, *uap = &ua;
721     struct vcache *tvc;
722     int code = 0;
723
724     AFS_STATCNT(afs_xioctl);
725     ua.com = com;
726     ua.arg = arg;
727
728     tvc = VTOAFS(ip);
729     if (tvc && IsAfsVnode(AFSTOV(tvc))) {
730         /* This is an AFS vnode */
731         if (((uap->com >> 8) & 0xff) == 'V') {
732             struct afs_ioctl *datap;
733             AFS_GLOCK();
734             datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
735             code = copyin_afs_ioctl((char *)uap->arg, datap);
736             if (code) {
737                 osi_FreeSmallSpace(datap);
738                 AFS_GUNLOCK();
739                 return -code;
740             }
741             code = HandleIoctl(tvc, uap->com, datap);
742             osi_FreeSmallSpace(datap);
743             AFS_GUNLOCK();
744         }
745         else
746             code = EINVAL;
747     }
748     return -code;
749 }
750 #elif defined(AFS_DARWIN_ENV) && !defined(AFS_DARWIN80_ENV)
751 struct ioctl_args {
752     int fd;
753     u_long com;
754     caddr_t arg;
755 };
756
757 int
758 afs_xioctl(afs_proc_t *p, struct ioctl_args *uap, register_t *retval)
759 {
760     struct file *fd;
761     struct vcache *tvc;
762     int ioctlDone = 0, code = 0;
763
764     AFS_STATCNT(afs_xioctl);
765     if ((code = fdgetf(p, uap->fd, &fd)))
766         return code;
767     if (fd->f_type == DTYPE_VNODE) {
768         tvc = VTOAFS((struct vnode *)fd->f_data);       /* valid, given a vnode */
769         if (tvc && IsAfsVnode(AFSTOV(tvc))) {
770             /* This is an AFS vnode */
771             if (((uap->com >> 8) & 0xff) == 'V') {
772                 struct afs_ioctl *datap;
773                 AFS_GLOCK();
774                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
775                 code = copyin_afs_ioctl((char *)uap->arg, datap);
776                 if (code) {
777                     osi_FreeSmallSpace(datap);
778                     AFS_GUNLOCK();
779                     return code;
780                 }
781                 code = HandleIoctl(tvc, uap->com, datap);
782                 osi_FreeSmallSpace(datap);
783                 AFS_GUNLOCK();
784                 ioctlDone = 1;
785             }
786         }
787     }
788
789     if (!ioctlDone)
790         return ioctl(p, uap, retval);
791
792     return (code);
793 }
794 #elif defined(AFS_XBSD_ENV)
795 # if defined(AFS_FBSD_ENV)
796 #  define arg data
797 int
798 afs_xioctl(struct thread *td, struct ioctl_args *uap,
799            register_t *retval)
800 {
801     afs_proc_t *p = td->td_proc;
802 # elif defined(AFS_NBSD_ENV)
803 int
804 afs_xioctl(afs_proc_t *p, const struct sys_ioctl_args *uap, register_t *retval)
805 {
806 # else
807 struct ioctl_args {
808     int fd;
809     u_long com;
810     caddr_t arg;
811 };
812
813 int
814 afs_xioctl(afs_proc_t *p, const struct ioctl_args *uap, register_t *retval)
815 {
816 # endif
817     struct filedesc *fdp;
818     struct vcache *tvc;
819     int ioctlDone = 0, code = 0;
820     struct file *fd;
821
822     AFS_STATCNT(afs_xioctl);
823 #if defined(AFS_NBSD40_ENV)
824     fdp = p->l_proc->p_fd;
825 #else
826     fdp = p->p_fd;
827 #endif
828 #if defined(AFS_NBSD50_ENV)
829     if ((fd = fd_getfile(SCARG(uap, fd))) == NULL)
830         return (EBADF);
831 #elif defined(AFS_FBSD_ENV)
832     if ((uap->fd >= fdp->fd_nfiles)
833         || ((fd = fdp->fd_ofiles[uap->fd].fde_file) == NULL))
834         return EBADF;
835 #else
836     if ((uap->fd >= fdp->fd_nfiles)
837         || ((fd = fdp->fd_ofiles[uap->fd]) == NULL))
838         return EBADF;
839 #endif
840     if ((fd->f_flag & (FREAD | FWRITE)) == 0)
841         return EBADF;
842     /* first determine whether this is any sort of vnode */
843     if (fd->f_type == DTYPE_VNODE) {
844         /* good, this is a vnode; next see if it is an AFS vnode */
845 # if defined(AFS_OBSD_ENV)
846         tvc =
847             IsAfsVnode((struct vnode *)fd->
848                        f_data) ? VTOAFS((struct vnode *)fd->f_data) : NULL;
849 # else
850         tvc = VTOAFS((struct vnode *)fd->f_data);       /* valid, given a vnode */
851 # endif
852         if (tvc && IsAfsVnode((struct vnode *)fd->f_data)) {
853             /* This is an AFS vnode */
854 #if defined(AFS_NBSD50_ENV)
855             if (((SCARG(uap, com) >> 8) & 0xff) == 'V') {
856 #else
857             if (((uap->com >> 8) & 0xff) == 'V') {
858 #endif
859                 struct afs_ioctl *datap;
860                 AFS_GLOCK();
861                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
862 #if defined(AFS_NBSD50_ENV)
863                 code = copyin_afs_ioctl(SCARG(uap, data), datap);
864 #else
865                 code = copyin_afs_ioctl((char *)uap->arg, datap);
866 #endif
867                 if (code) {
868                     osi_FreeSmallSpace(datap);
869                     AFS_GUNLOCK();
870                     return code;
871                 }
872 #if defined(AFS_NBSD50_ENV)
873                 code = HandleIoctl(tvc, SCARG(uap, com), datap);
874 #else
875                 code = HandleIoctl(tvc, uap->com, datap);
876 #endif
877                 osi_FreeSmallSpace(datap);
878                 AFS_GUNLOCK();
879                 ioctlDone = 1;
880             }
881         }
882     }
883
884 #if defined(AFS_NBSD50_ENV)
885     fd_putfile(SCARG(uap, fd));
886 #endif
887
888     if (!ioctlDone) {
889 # if defined(AFS_FBSD_ENV)
890         return sys_ioctl(td, uap);
891 # elif defined(AFS_OBSD_ENV)
892         code = sys_ioctl(p, uap, retval);
893 # elif defined(AFS_NBSD_ENV)
894         code = sys_ioctl(p, uap, retval);
895 # endif
896     }
897
898     return (code);
899 }
900 #elif defined(UKERNEL)
901 int
902 afs_xioctl(void)
903 {
904     struct a {
905         int fd;
906         int com;
907         caddr_t arg;
908     } *uap = (struct a *)get_user_struct()->u_ap;
909     struct file *fd;
910     struct vcache *tvc;
911     int ioctlDone = 0, code = 0;
912
913     AFS_STATCNT(afs_xioctl);
914
915     fd = getf(uap->fd);
916     if (!fd)
917         return (EBADF);
918     /* first determine whether this is any sort of vnode */
919     if (fd->f_type == DTYPE_VNODE) {
920         /* good, this is a vnode; next see if it is an AFS vnode */
921         tvc = VTOAFS((struct vnode *)fd->f_data);       /* valid, given a vnode */
922         if (tvc && IsAfsVnode(AFSTOV(tvc))) {
923             /* This is an AFS vnode */
924             if (((uap->com >> 8) & 0xff) == 'V') {
925                 struct afs_ioctl *datap;
926                 AFS_GLOCK();
927                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
928                 code=copyin_afs_ioctl((char *)uap->arg, datap);
929                 if (code) {
930                     osi_FreeSmallSpace(datap);
931                     AFS_GUNLOCK();
932
933                     return (setuerror(code), code);
934                 }
935                 code = HandleIoctl(tvc, uap->com, datap);
936                 osi_FreeSmallSpace(datap);
937                 AFS_GUNLOCK();
938                 ioctlDone = 1;
939             }
940         }
941     }
942
943     if (!ioctlDone) {
944         ioctl();
945     }
946
947     return 0;
948 }
949 #endif /* AFS_HPUX102_ENV */
950
951 #if defined(AFS_SGI_ENV)
952   /* "pioctl" system call entry point; just pass argument to the parameterized
953    * call below */
954 struct pioctlargs {
955     char *path;
956     sysarg_t cmd;
957     caddr_t cmarg;
958     sysarg_t follow;
959 };
960 int
961 afs_pioctl(struct pioctlargs *uap, rval_t * rvp)
962 {
963     int code;
964
965     AFS_STATCNT(afs_pioctl);
966     AFS_GLOCK();
967     code = afs_syscall_pioctl(uap->path, uap->cmd, uap->cmarg, uap->follow);
968     AFS_GUNLOCK();
969 # ifdef AFS_SGI64_ENV
970     return code;
971 # else
972     return u.u_error;
973 # endif
974 }
975
976 #elif defined(AFS_FBSD_ENV)
977 int
978 afs_pioctl(struct thread *td, void *args, int *retval)
979 {
980     struct a {
981         char *path;
982         int cmd;
983         caddr_t cmarg;
984         int follow;
985     } *uap = (struct a *)args;
986
987     AFS_STATCNT(afs_pioctl);
988     return (afs_syscall_pioctl
989             (uap->path, uap->cmd, uap->cmarg, uap->follow, td->td_ucred));
990 }
991
992 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
993 int
994 afs_pioctl(afs_proc_t *p, void *args, int *retval)
995 {
996     struct a {
997         char *path;
998         int cmd;
999         caddr_t cmarg;
1000         int follow;
1001     } *uap = (struct a *)args;
1002
1003     AFS_STATCNT(afs_pioctl);
1004 # if defined(AFS_DARWIN80_ENV) || defined(AFS_NBSD40_ENV)
1005     return (afs_syscall_pioctl
1006             (uap->path, uap->cmd, uap->cmarg, uap->follow,
1007              kauth_cred_get()));
1008 # else
1009     return (afs_syscall_pioctl
1010             (uap->path, uap->cmd, uap->cmarg, uap->follow,
1011 #  if defined(AFS_FBSD_ENV)
1012              td->td_ucred));
1013 #  else
1014              p->p_cred->pc_ucred));
1015 #  endif
1016 # endif
1017 }
1018
1019 #endif
1020
1021 /* macro to avoid adding any more #ifdef's to pioctl code. */
1022 #if defined(AFS_LINUX22_ENV) || defined(AFS_AIX41_ENV)
1023 #define PIOCTL_FREE_CRED() crfree(credp)
1024 #else
1025 #define PIOCTL_FREE_CRED()
1026 #endif
1027
1028 int
1029 #ifdef  AFS_SUN5_ENV
1030 afs_syscall_pioctl(char *path, unsigned int com, caddr_t cmarg, int follow,
1031                    rval_t *vvp, afs_ucred_t *credp)
1032 #else
1033 #ifdef AFS_DARWIN100_ENV
1034 afs_syscall64_pioctl(user_addr_t path, unsigned int com, user_addr_t cmarg,
1035                    int follow, afs_ucred_t *credp)
1036 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1037 afs_syscall_pioctl(char *path, unsigned int com, caddr_t cmarg, int follow,
1038                    afs_ucred_t *credp)
1039 #else
1040 afs_syscall_pioctl(char *path, unsigned int com, caddr_t cmarg, int follow)
1041 #endif
1042 #endif
1043 {
1044     struct afs_ioctl data;
1045 #ifdef AFS_NEED_CLIENTCONTEXT
1046     afs_ucred_t *tmpcred = NULL;
1047 #endif
1048 #if defined(AFS_NEED_CLIENTCONTEXT) || defined(AFS_SUN5_ENV) || defined(AFS_AIX41_ENV) || defined(AFS_LINUX22_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1049     afs_ucred_t *foreigncreds = NULL;
1050 #endif
1051     afs_int32 code = 0;
1052     struct vnode *vp = NULL;
1053 #ifdef  AFS_AIX41_ENV
1054     struct ucred *credp = crref();      /* don't free until done! */
1055 #endif
1056 #ifdef AFS_LINUX22_ENV
1057     cred_t *credp = crref();    /* don't free until done! */
1058     struct dentry *dp;
1059 #endif
1060
1061     AFS_STATCNT(afs_syscall_pioctl);
1062     if (follow)
1063         follow = 1;             /* compat. with old venus */
1064     code = copyin_afs_ioctl(cmarg, &data);
1065     if (code) {
1066         PIOCTL_FREE_CRED();
1067 #if defined(KERNEL_HAVE_UERROR)
1068         setuerror(code);
1069 #endif
1070         return (code);
1071     }
1072     if ((com & 0xff) == PSetClientContext) {
1073 #ifdef AFS_NEED_CLIENTCONTEXT
1074 #if defined(AFS_SUN5_ENV) || defined(AFS_AIX41_ENV) || defined(AFS_LINUX22_ENV)
1075         code = HandleClientContext(&data, &com, &foreigncreds, credp);
1076 #else
1077         code = HandleClientContext(&data, &com, &foreigncreds, osi_curcred());
1078 #endif
1079         if (code) {
1080             if (foreigncreds) {
1081                 crfree(foreigncreds);
1082             }
1083             PIOCTL_FREE_CRED();
1084 #if defined(KERNEL_HAVE_UERROR)
1085             return (setuerror(code), code);
1086 #else
1087             return (code);
1088 #endif
1089         }
1090 #else /* AFS_NEED_CLIENTCONTEXT */
1091         return EINVAL;
1092 #endif /* AFS_NEED_CLIENTCONTEXT */
1093     }
1094 #ifdef AFS_NEED_CLIENTCONTEXT
1095     if (foreigncreds) {
1096         /*
1097          * We could have done without temporary setting the u.u_cred below
1098          * (foreigncreds could be passed as param the pioctl modules)
1099          * but calls such as afs_osi_suser() doesn't allow that since it
1100          * references u.u_cred directly.  We could, of course, do something
1101          * like afs_osi_suser(cred) which, I think, is better since it
1102          * generalizes and supports multi cred environments...
1103          */
1104 #if defined(AFS_SUN5_ENV) || defined(AFS_LINUX22_ENV)
1105         tmpcred = credp;
1106         credp = foreigncreds;
1107 #elif defined(AFS_AIX41_ENV)
1108         tmpcred = crref();      /* XXX */
1109         crset(foreigncreds);
1110 #elif defined(AFS_HPUX101_ENV)
1111         tmpcred = p_cred(u.u_procp);
1112         set_p_cred(u.u_procp, foreigncreds);
1113 #elif defined(AFS_SGI_ENV)
1114         tmpcred = OSI_GET_CURRENT_CRED();
1115         OSI_SET_CURRENT_CRED(foreigncreds);
1116 #else
1117         tmpcred = u.u_cred;
1118         u.u_cred = foreigncreds;
1119 #endif
1120     }
1121 #endif /* AFS_NEED_CLIENTCONTEXT */
1122
1123     /* VIOCPREFETCH */
1124     if ((com & 0xff00) >> 8 == 'V' && (com & 0xff) == 15) {
1125         /* special case prefetch so entire pathname eval occurs in helper process.
1126          * otherwise, the pioctl call is essentially useless */
1127 #if     defined(AFS_SUN5_ENV) || defined(AFS_AIX41_ENV) || defined(AFS_LINUX22_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1128         code =
1129             Prefetch(path, &data, follow,
1130                      foreigncreds ? foreigncreds : credp);
1131 #else
1132         code = Prefetch(path, &data, follow, osi_curcred());
1133 #endif
1134         vp = NULL;
1135 #if defined(KERNEL_HAVE_UERROR)
1136         setuerror(code);
1137 #endif
1138         goto rescred;
1139     }
1140     if (path) {
1141         AFS_GUNLOCK();
1142 #ifdef  AFS_AIX41_ENV
1143         code =
1144             lookupname(path, USR, follow, NULL, &vp,
1145                        foreigncreds ? foreigncreds : credp);
1146 #else
1147 #ifdef AFS_LINUX22_ENV
1148         code = gop_lookupname_user(path, AFS_UIOUSER, follow, &dp);
1149         if (!code)
1150             vp = (struct vnode *)dp->d_inode;
1151 #else
1152         code = gop_lookupname_user(path, AFS_UIOUSER, follow, &vp);
1153 #endif /* AFS_LINUX22_ENV */
1154 #endif /* AFS_AIX41_ENV */
1155         AFS_GLOCK();
1156         if (code) {
1157             vp = NULL;
1158 #if defined(KERNEL_HAVE_UERROR)
1159             setuerror(code);
1160 #endif
1161             goto rescred;
1162         }
1163     } else
1164         vp = NULL;
1165
1166 #if defined(AFS_SUN510_ENV)
1167     if (vp && !IsAfsVnode(vp)) {
1168         struct vnode *realvp;
1169         if
1170 #ifdef AFS_SUN511_ENV
1171           (VOP_REALVP(vp, &realvp, NULL) == 0)
1172 #else
1173           (VOP_REALVP(vp, &realvp) == 0)
1174 #endif
1175 {
1176             struct vnode *oldvp = vp;
1177
1178             VN_HOLD(realvp);
1179             vp = realvp;
1180             AFS_RELE(oldvp);
1181         }
1182     }
1183 #endif
1184     /* now make the call if we were passed no file, or were passed an AFS file */
1185     if (!vp || IsAfsVnode(vp)) {
1186 #if defined(AFS_SUN5_ENV)
1187         code = afs_HandlePioctl(vp, com, &data, follow, &credp);
1188 #elif defined(AFS_AIX41_ENV)
1189         {
1190             struct ucred *cred1, *cred2;
1191
1192             if (foreigncreds) {
1193                 cred1 = cred2 = foreigncreds;
1194             } else {
1195                 cred1 = cred2 = credp;
1196             }
1197             code = afs_HandlePioctl(vp, com, &data, follow, &cred1);
1198             if (cred1 != cred2) {
1199                 /* something changed the creds */
1200                 crset(cred1);
1201             }
1202         }
1203 #elif defined(AFS_HPUX101_ENV)
1204         {
1205             struct ucred *cred = p_cred(u.u_procp);
1206             code = afs_HandlePioctl(vp, com, &data, follow, &cred);
1207         }
1208 #elif defined(AFS_SGI_ENV)
1209         {
1210             struct cred *credp;
1211             credp = OSI_GET_CURRENT_CRED();
1212             code = afs_HandlePioctl(vp, com, &data, follow, &credp);
1213         }
1214 #elif defined(AFS_LINUX22_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1215         code = afs_HandlePioctl(vp, com, &data, follow, &credp);
1216 #elif defined(UKERNEL)
1217         code = afs_HandlePioctl(vp, com, &data, follow,
1218                                 &(get_user_struct()->u_cred));
1219 #else
1220         code = afs_HandlePioctl(vp, com, &data, follow, &u.u_cred);
1221 #endif
1222     } else {
1223 #if defined(KERNEL_HAVE_UERROR)
1224         setuerror(EINVAL);
1225 #else
1226         code = EINVAL;          /* not in /afs */
1227 #endif
1228     }
1229
1230   rescred:
1231 #if defined(AFS_NEED_CLIENTCONTEXT)
1232     if (foreigncreds) {
1233 #ifdef  AFS_AIX41_ENV
1234         crset(tmpcred);         /* restore original credentials */
1235 #else
1236 #if     defined(AFS_HPUX101_ENV)
1237         set_p_cred(u.u_procp, tmpcred); /* restore original credentials */
1238 #elif   defined(AFS_SGI_ENV)
1239         OSI_SET_CURRENT_CRED(tmpcred);  /* restore original credentials */
1240 #elif   defined(AFS_SUN5_ENV) || defined(AFS_LINUX22_ENV)
1241         credp = tmpcred;                /* restore original credentials */
1242 #else
1243         osi_curcred() = tmpcred;        /* restore original credentials */
1244 #endif /* AFS_HPUX101_ENV */
1245         crfree(foreigncreds);
1246 #endif /* AIX41 */
1247     }
1248 #endif /* AFS_NEED_CLIENTCONTEXT */
1249     if (vp) {
1250 #ifdef AFS_LINUX22_ENV
1251         /*
1252          * Holding the global lock when calling dput can cause a deadlock
1253          * when the kernel calls back into afs_dentry_iput
1254          */
1255         AFS_GUNLOCK();
1256         dput(dp);
1257         AFS_GLOCK();
1258 #else
1259 #if defined(AFS_FBSD_ENV)
1260     if (VOP_ISLOCKED(vp))
1261         VOP_UNLOCK(vp, 0);
1262 #endif /* AFS_FBSD_ENV */
1263         AFS_RELE(vp);           /* put vnode back */
1264 #endif
1265     }
1266     PIOCTL_FREE_CRED();
1267 #if defined(KERNEL_HAVE_UERROR)
1268     if (!getuerror())
1269         setuerror(code);
1270     return (getuerror());
1271 #else
1272     return (code);
1273 #endif
1274 }
1275
1276 #ifdef AFS_DARWIN100_ENV
1277 int
1278 afs_syscall_pioctl(char * path, unsigned int com, caddr_t cmarg,
1279                    int follow, afs_ucred_t *credp)
1280 {
1281     return afs_syscall64_pioctl(CAST_USER_ADDR_T(path), com,
1282                                 CAST_USER_ADDR_T((unsigned int)cmarg), follow,
1283                                 credp);
1284 }
1285 #endif
1286
1287 #define MAXPIOCTLTOKENLEN \
1288 (3*sizeof(afs_int32)+MAXKTCTICKETLEN+sizeof(struct ClearToken)+MAXKTCREALMLEN)
1289
1290 int
1291 afs_HandlePioctl(struct vnode *avp, afs_int32 acom,
1292                  struct afs_ioctl *ablob, int afollow,
1293                  afs_ucred_t **acred)
1294 {
1295     struct vcache *avc;
1296     struct vrequest *treq = NULL;
1297     afs_int32 code;
1298     afs_int32 function, device;
1299     struct afs_pdata input, output;
1300     struct afs_pdata copyInput, copyOutput;
1301     size_t outSize;
1302     pioctlFunction *pioctlSw;
1303     int pioctlSwSize;
1304     struct afs_fakestat_state fakestate;
1305
1306     memset(&input, 0, sizeof(input));
1307     memset(&output, 0, sizeof(output));
1308
1309     avc = avp ? VTOAFS(avp) : NULL;
1310     afs_Trace3(afs_iclSetp, CM_TRACE_PIOCTL, ICL_TYPE_INT32, acom & 0xff,
1311                ICL_TYPE_POINTER, avc, ICL_TYPE_INT32, afollow);
1312     AFS_STATCNT(HandlePioctl);
1313
1314     code = afs_CreateReq(&treq, *acred);
1315     if (code)
1316         return code;
1317
1318     afs_InitFakeStat(&fakestate);
1319     if (avc) {
1320         code = afs_EvalFakeStat(&avc, &fakestate, treq);
1321         if (code)
1322             goto out;
1323     }
1324     device = (acom & 0xff00) >> 8;
1325     switch (device) {
1326     case 'V':                   /* Original pioctls */
1327         pioctlSw = VpioctlSw;
1328         pioctlSwSize = sizeof(VpioctlSw);
1329         break;
1330     case 'C':                   /* Coordinated/common pioctls */
1331         pioctlSw = CpioctlSw;
1332         pioctlSwSize = sizeof(CpioctlSw);
1333         break;
1334     case 'O':                   /* Coordinated/common pioctls */
1335         pioctlSw = OpioctlSw;
1336         pioctlSwSize = sizeof(OpioctlSw);
1337         break;
1338     default:
1339         code = EINVAL;
1340         goto out;
1341     }
1342     function = acom & 0xff;
1343     if (function >= (pioctlSwSize / sizeof(char *))) {
1344         code = EINVAL;
1345         goto out;
1346     }
1347
1348     /* Do all range checking before continuing */
1349     if (ablob->in_size > MAXPIOCTLTOKENLEN ||
1350         ablob->in_size < 0 || ablob->out_size < 0) {
1351         code = EINVAL;
1352         goto out;
1353     }
1354
1355     code = afs_pd_alloc(&input, ablob->in_size);
1356     if (code)
1357         goto out;
1358
1359     if (ablob->in_size > 0) {
1360         AFS_COPYIN(ablob->in, input.ptr, ablob->in_size, code);
1361         input.ptr[input.remaining] = '\0';
1362     }
1363     if (code)
1364         goto out;
1365
1366     if ((function == 8 && device == 'V') ||
1367        (function == 7 && device == 'C')) {      /* PGetTokens */
1368         code = afs_pd_alloc(&output, MAXPIOCTLTOKENLEN);
1369     } else {
1370         code = afs_pd_alloc(&output, AFS_LRALLOCSIZ);
1371     }
1372     if (code)
1373         goto out;
1374
1375     copyInput = input;
1376     copyOutput = output;
1377
1378     code =
1379         (*pioctlSw[function]) (avc, function, treq, &copyInput,
1380                                &copyOutput, acred);
1381
1382     outSize = copyOutput.ptr - output.ptr;
1383
1384     if (code == 0 && ablob->out_size > 0) {
1385         if (outSize > ablob->out_size) {
1386             code = E2BIG;       /* data wont fit in user buffer */
1387         } else if (outSize) {
1388             AFS_COPYOUT(output.ptr, ablob->out, outSize, code);
1389         }
1390     }
1391
1392 out:
1393     afs_pd_free(&input);
1394     afs_pd_free(&output);
1395
1396     afs_PutFakeStat(&fakestate);
1397     code = afs_CheckCode(code, treq, 41);
1398     afs_DestroyReq(treq);
1399     return code;
1400 }
1401
1402 /*!
1403  * VIOCGETFID (22) - Get file ID quickly
1404  *
1405  * \ingroup pioctl
1406  *
1407  * \param[in] ain       not in use
1408  * \param[out] aout     fid of requested file
1409  *
1410  * \retval EINVAL       Error if some of the initial arguments aren't set
1411  *
1412  * \post get the file id of some file
1413  */
1414 DECL_PIOCTL(PGetFID)
1415 {
1416     AFS_STATCNT(PGetFID);
1417     if (!avc)
1418         return EINVAL;
1419     if (afs_pd_putBytes(aout, &avc->f.fid, sizeof(struct VenusFid)) != 0)
1420         return EINVAL;
1421     return 0;
1422 }
1423
1424 /*!
1425  * VIOCSETAL (1) - Set access control list
1426  *
1427  * \ingroup pioctl
1428  *
1429  * \param[in] ain       the ACL being set
1430  * \param[out] aout     the ACL being set returned
1431  *
1432  * \retval EINVAL       Error if some of the standard args aren't set
1433  *
1434  * \post Changed ACL, via direct writing to the wire
1435  */
1436 int
1437 dummy_PSetAcl(char *ain, char *aout)
1438 {
1439     return 0;
1440 }
1441
1442 DECL_PIOCTL(PSetAcl)
1443 {
1444     afs_int32 code;
1445     struct afs_conn *tconn;
1446     struct AFSOpaque acl;
1447     struct AFSVolSync tsync;
1448     struct AFSFetchStatus OutStatus;
1449     struct rx_connection *rxconn;
1450     XSTATS_DECLS;
1451
1452     AFS_STATCNT(PSetAcl);
1453     if (!avc)
1454         return EINVAL;
1455
1456     if (afs_pd_getStringPtr(ain, &acl.AFSOpaque_val) != 0)
1457         return EINVAL;
1458     acl.AFSOpaque_len = strlen(acl.AFSOpaque_val) + 1;
1459     if (acl.AFSOpaque_len > 1024)
1460         return EINVAL;
1461
1462     do {
1463         tconn = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
1464         if (tconn) {
1465             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_STOREACL);
1466             RX_AFS_GUNLOCK();
1467             code =
1468                 RXAFS_StoreACL(rxconn, (struct AFSFid *)&avc->f.fid.Fid,
1469                                &acl, &OutStatus, &tsync);
1470             RX_AFS_GLOCK();
1471             XSTATS_END_TIME;
1472         } else
1473             code = -1;
1474     } while (afs_Analyze
1475              (tconn, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_STOREACL,
1476               SHARED_LOCK, NULL));
1477
1478     /* now we've forgotten all of the access info */
1479     afs_StaleVCacheFlags(avc, AFS_STALEVC_CLEARCB, CUnique);
1480
1481     /* SXW - Should we flush metadata here? */
1482
1483     return code;
1484 }
1485
1486 int afs_defaultAsynchrony = 0;
1487
1488 /*!
1489  * VIOC_STOREBEHIND (47) Adjust store asynchrony
1490  *
1491  * \ingroup pioctl
1492  *
1493  * \param[in] ain       sbstruct (store behind structure) input
1494  * \param[out] aout     resulting sbstruct
1495  *
1496  * \retval EPERM
1497  *      Error if the user doesn't have super-user credentials
1498  * \retval EACCES
1499  *      Error if there isn't enough access to not check the mode bits
1500  *
1501  * \post
1502  *      Changes either the default asynchrony (the amount of data that
1503  *      can remain to be written when the cache manager returns control
1504  *      to the user), or the asyncrony for the specified file.
1505  */
1506 DECL_PIOCTL(PStoreBehind)
1507 {
1508     struct sbstruct sbr;
1509
1510     if (afs_pd_getBytes(ain, &sbr, sizeof(struct sbstruct)) != 0)
1511         return EINVAL;
1512
1513     if (sbr.sb_default != -1) {
1514         if (afs_osi_suser(*acred))
1515             afs_defaultAsynchrony = sbr.sb_default;
1516         else
1517             return EPERM;
1518     }
1519
1520     if (avc && (sbr.sb_thisfile != -1)) {
1521         if (afs_AccessOK
1522             (avc, PRSFS_WRITE | PRSFS_ADMINISTER, areq, DONT_CHECK_MODE_BITS))
1523             avc->asynchrony = sbr.sb_thisfile;
1524         else
1525             return EACCES;
1526     }
1527
1528     memset(&sbr, 0, sizeof(sbr));
1529     sbr.sb_default = afs_defaultAsynchrony;
1530     if (avc) {
1531         sbr.sb_thisfile = avc->asynchrony;
1532     }
1533
1534     return afs_pd_putBytes(aout, &sbr, sizeof(sbr));
1535 }
1536
1537 /*!
1538  * VIOC_GCPAGS (48) - Disable automatic PAG gc'ing
1539  *
1540  * \ingroup pioctl
1541  *
1542  * \param[in] ain       not in use
1543  * \param[out] aout     not in use
1544  *
1545  * \retval EACCES       Error if the user doesn't have super-user credentials
1546  *
1547  * \post set the gcpags to GCPAGS_USERDISABLED
1548  */
1549 DECL_PIOCTL(PGCPAGs)
1550 {
1551     if (!afs_osi_suser(*acred)) {
1552         return EACCES;
1553     }
1554     afs_gcpags = AFS_GCPAGS_USERDISABLED;
1555     return 0;
1556 }
1557
1558 /*!
1559  * VIOCGETAL (2) - Get access control list
1560  *
1561  * \ingroup pioctl
1562  *
1563  * \param[in] ain       not in use
1564  * \param[out] aout     the ACL
1565  *
1566  * \retval EINVAL       Error if some of the standard args aren't set
1567  * \retval ERANGE       Error if the vnode of the file id is too large
1568  * \retval -1           Error if getting the ACL failed
1569  *
1570  * \post Obtain the ACL, based on file ID
1571  *
1572  * \notes
1573  *      There is a hack to tell which type of ACL is being returned, checks
1574  *      the top 2-bytes of the input size to judge what type of ACL it is,
1575  *      only for dfs xlator ACLs
1576  */
1577 DECL_PIOCTL(PGetAcl)
1578 {
1579     struct AFSOpaque acl;
1580     struct AFSVolSync tsync;
1581     struct AFSFetchStatus OutStatus;
1582     afs_int32 code;
1583     struct afs_conn *tconn;
1584     struct AFSFid Fid;
1585     struct rx_connection *rxconn;
1586     XSTATS_DECLS;
1587
1588     AFS_STATCNT(PGetAcl);
1589     if (!avc)
1590         return EINVAL;
1591     Fid.Volume = avc->f.fid.Fid.Volume;
1592     Fid.Vnode = avc->f.fid.Fid.Vnode;
1593     Fid.Unique = avc->f.fid.Fid.Unique;
1594     if (avc->f.states & CForeign) {
1595         /*
1596          * For a dfs xlator acl we have a special hack so that the
1597          * xlator will distinguish which type of acl will return. So
1598          * we currently use the top 2-bytes (vals 0-4) to tell which
1599          * type of acl to bring back. Horrible hack but this will
1600          * cause the least number of changes to code size and interfaces.
1601          */
1602         if (Fid.Vnode & 0xc0000000)
1603             return ERANGE;
1604         Fid.Vnode |= (ain->remaining << 30);
1605     }
1606     acl.AFSOpaque_val = aout->ptr;
1607     do {
1608         tconn = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
1609         if (tconn) {
1610             acl.AFSOpaque_val[0] = '\0';
1611             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_FETCHACL);
1612             RX_AFS_GUNLOCK();
1613             code = RXAFS_FetchACL(rxconn, &Fid, &acl, &OutStatus, &tsync);
1614             RX_AFS_GLOCK();
1615             XSTATS_END_TIME;
1616         } else
1617             code = -1;
1618     } while (afs_Analyze
1619              (tconn, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_FETCHACL,
1620               SHARED_LOCK, NULL));
1621
1622     if (code == 0) {
1623         if (acl.AFSOpaque_len == 0)
1624             afs_pd_skip(aout, 1); /* leave the NULL */
1625         else
1626             afs_pd_skip(aout, acl.AFSOpaque_len); /* Length of the ACL */
1627     }
1628     return code;
1629 }
1630
1631 /*!
1632  * PNoop returns success.  Used for functions which are not implemented
1633  * or are no longer in use.
1634  *
1635  * \ingroup pioctl
1636  *
1637  * \retval Always returns success
1638  *
1639  * \notes
1640  *      Functions involved in this:
1641  *      17 (VIOCENGROUP) -- used to be enable group;
1642  *      18 (VIOCDISGROUP) -- used to be disable group;
1643  *      2 (?) -- get/set cache-bypass size threshold
1644  */
1645 DECL_PIOCTL(PNoop)
1646 {
1647     AFS_STATCNT(PNoop);
1648     return 0;
1649 }
1650
1651 /*!
1652  * PBogus returns fail.  Used for functions which are not implemented or
1653  * are no longer in use.
1654  *
1655  * \ingroup pioctl
1656  *
1657  * \retval EINVAL       Always returns this value
1658  *
1659  * \notes
1660  *      Functions involved in this:
1661  *      0 (?);
1662  *      4 (?);
1663  *      6 (?);
1664  *      7 (VIOCSTAT);
1665  *      8 (?);
1666  *      13 (VIOCGETTIME) -- used to be quick check time;
1667  *      15 (VIOCPREFETCH) -- prefetch is now special-cased; see pioctl code!;
1668  *      16 (VIOCNOP) -- used to be testing code;
1669  *      19 (VIOCLISTGROUPS) -- used to be list group;
1670  *      23 (VIOCWAITFOREVER) -- used to be waitforever;
1671  *      57 (VIOC_FPRIOSTATUS) -- arla: set file prio;
1672  *      58 (VIOC_FHGET) -- arla: fallback getfh;
1673  *      59 (VIOC_FHOPEN) -- arla: fallback fhopen;
1674  *      60 (VIOC_XFSDEBUG) -- arla: controls xfsdebug;
1675  *      61 (VIOC_ARLADEBUG) -- arla: controls arla debug;
1676  *      62 (VIOC_AVIATOR) -- arla: debug interface;
1677  *      63 (VIOC_XFSDEBUG_PRINT) -- arla: print xfs status;
1678  *      64 (VIOC_CALCULATE_CACHE) -- arla: force cache check;
1679  *      65 (VIOC_BREAKCELLBACK) -- arla: break callback;
1680  *      68 (?) -- arla: fetch stats;
1681  */
1682 DECL_PIOCTL(PBogus)
1683 {
1684     AFS_STATCNT(PBogus);
1685     return EINVAL;
1686 }
1687
1688 /*!
1689  * VIOC_FILE_CELL_NAME (30) - Get cell in which file lives
1690  *
1691  * \ingroup pioctl
1692  *
1693  * \param[in] ain       not in use (avc used to pass in file id)
1694  * \param[out] aout     cell name
1695  *
1696  * \retval EINVAL       Error if some of the standard args aren't set
1697  * \retval ESRCH        Error if the file isn't part of a cell
1698  *
1699  * \post Get a cell based on a passed in file id
1700  */
1701 DECL_PIOCTL(PGetFileCell)
1702 {
1703     struct cell *tcell;
1704
1705     AFS_STATCNT(PGetFileCell);
1706     if (!avc)
1707         return EINVAL;
1708     tcell = afs_GetCell(avc->f.fid.Cell, READ_LOCK);
1709     if (!tcell)
1710         return ESRCH;
1711
1712     if (afs_pd_putString(aout, tcell->cellName) != 0)
1713         return EINVAL;
1714
1715     afs_PutCell(tcell, READ_LOCK);
1716     return 0;
1717 }
1718
1719 /*!
1720  * VIOC_GET_WS_CELL (31) - Get cell in which workstation lives
1721  *
1722  * \ingroup pioctl
1723  *
1724  * \param[in] ain       not in use
1725  * \param[out] aout     cell name
1726  *
1727  * \retval EIO
1728  *      Error if the afs daemon hasn't started yet
1729  * \retval ESRCH
1730  *      Error if the machine isn't part of a cell, for whatever reason
1731  *
1732  * \post Get the primary cell that the machine is a part of.
1733  */
1734 DECL_PIOCTL(PGetWSCell)
1735 {
1736     struct cell *tcell = NULL;
1737
1738     AFS_STATCNT(PGetWSCell);
1739     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
1740         return EIO;             /* Inappropriate ioctl for device */
1741
1742     tcell = afs_GetPrimaryCell(READ_LOCK);
1743     if (!tcell)                 /* no primary cell? */
1744         return ESRCH;
1745
1746     if (afs_pd_putString(aout, tcell->cellName) != 0)
1747         return EINVAL;
1748     afs_PutCell(tcell, READ_LOCK);
1749     return 0;
1750 }
1751
1752 /*!
1753  * VIOC_GET_PRIMARY_CELL (33) - Get primary cell for caller
1754  *
1755  * \ingroup pioctl
1756  *
1757  * \param[in] ain       not in use (user id found via areq)
1758  * \param[out] aout     cell name
1759  *
1760  * \retval ESRCH
1761  *      Error if the user id doesn't have a primary cell specified
1762  *
1763  * \post Get the primary cell for a certain user, based on the user's uid
1764  */
1765 DECL_PIOCTL(PGetUserCell)
1766 {
1767     afs_int32 i;
1768     struct unixuser *tu;
1769     struct cell *tcell;
1770
1771     AFS_STATCNT(PGetUserCell);
1772     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
1773         return EIO;             /* Inappropriate ioctl for device */
1774
1775     /* return the cell name of the primary cell for this user */
1776     i = UHash(areq->uid);
1777     ObtainWriteLock(&afs_xuser, 224);
1778     for (tu = afs_users[i]; tu; tu = tu->next) {
1779         if (tu->uid == areq->uid && (tu->states & UPrimary)) {
1780             tu->refCount++;
1781             ReleaseWriteLock(&afs_xuser);
1782             afs_LockUser(tu, READ_LOCK, 0);
1783             break;
1784         }
1785     }
1786     if (tu) {
1787         tcell = afs_GetCell(tu->cell, READ_LOCK);
1788         afs_PutUser(tu, READ_LOCK);
1789         if (!tcell)
1790             return ESRCH;
1791         else {
1792             if (afs_pd_putString(aout, tcell->cellName) != 0)
1793                 return E2BIG;
1794             afs_PutCell(tcell, READ_LOCK);
1795         }
1796     } else {
1797         ReleaseWriteLock(&afs_xuser);
1798     }
1799     return 0;
1800 }
1801
1802 /* Work out which cell we're changing tokens for */
1803 static_inline int
1804 _settok_tokenCell(char *cellName, int *cellNum, int *primary) {
1805     int t1;
1806     struct cell *cell;
1807
1808     if (primary) {
1809         *primary = 0;
1810     }
1811
1812     if (cellName && strlen(cellName) > 0) {
1813         cell = afs_GetCellByName(cellName, READ_LOCK);
1814     } else {
1815         cell = afs_GetPrimaryCell(READ_LOCK);
1816         if (primary)
1817             *primary = 1;
1818     }
1819     if (!cell) {
1820         t1 = afs_initState;
1821         if (t1 < 101)
1822             return EIO;
1823         else
1824             return ESRCH;
1825     }
1826     *cellNum = cell->cellNum;
1827     afs_PutCell(cell, READ_LOCK);
1828
1829     return 0;
1830 }
1831
1832
1833 static_inline int
1834 _settok_setParentPag(afs_ucred_t **cred) {
1835     afs_uint32 pag;
1836 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1837     char procname[256];
1838     osi_procname(procname, 256);
1839     afs_warnuser("Process %d (%s) tried to change pags in PSetTokens\n",
1840                  MyPidxx2Pid(MyPidxx), procname);
1841     return setpag(osi_curproc(), cred, -1, &pag, 1);
1842 #else
1843     return setpag(cred, -1, &pag, 1);
1844 #endif
1845 }
1846
1847 /*!
1848  * VIOCSETTOK (3) - Set authentication tokens
1849  *
1850  * \ingroup pioctl
1851  *
1852  * \param[in] ain       the krb tickets from which to set the afs tokens
1853  * \param[out] aout     not in use
1854  *
1855  * \retval EINVAL
1856  *      Error if the ticket is either too long or too short
1857  * \retval EIO
1858  *      Error if the AFS initState is below 101
1859  * \retval ESRCH
1860  *      Error if the cell for which the Token is being set can't be found
1861  *
1862  * \post
1863  *      Set the Tokens for a specific cell name, unless there is none set,
1864  *      then default to primary
1865  *
1866  */
1867 DECL_PIOCTL(PSetTokens)
1868 {
1869     afs_int32 cellNum;
1870     afs_int32 size;
1871     afs_int32 code;
1872     struct unixuser *tu;
1873     struct ClearToken clear;
1874     char *stp;
1875     char *cellName;
1876     int stLen;
1877     struct vrequest *treq = NULL;
1878     afs_int32 flag, set_parent_pag = 0;
1879
1880     AFS_STATCNT(PSetTokens);
1881     if (!afs_resourceinit_flag) {
1882         return EIO;
1883     }
1884
1885     if (afs_pd_getInt(ain, &stLen) != 0)
1886         return EINVAL;
1887
1888     stp = afs_pd_where(ain);    /* remember where the ticket is */
1889     if (stLen < 0 || stLen > MAXKTCTICKETLEN)
1890         return EINVAL;          /* malloc may fail */
1891     if (afs_pd_skip(ain, stLen) != 0)
1892         return EINVAL;
1893
1894     if (afs_pd_getInt(ain, &size) != 0)
1895         return EINVAL;
1896     if (size != sizeof(struct ClearToken))
1897         return EINVAL;
1898
1899     if (afs_pd_getBytes(ain, &clear, sizeof(struct ClearToken)) !=0)
1900         return EINVAL;
1901
1902     if (clear.AuthHandle == -1)
1903         clear.AuthHandle = 999; /* more rxvab compat stuff */
1904
1905     if (afs_pd_remaining(ain) != 0) {
1906         /* still stuff left?  we've got primary flag and cell name.
1907          * Set these */
1908
1909         if (afs_pd_getInt(ain, &flag) != 0)
1910             return EINVAL;
1911
1912         /* some versions of gcc appear to need != 0 in order to get this
1913          * right */
1914         if ((flag & 0x8000) != 0) {     /* XXX Use Constant XXX */
1915             flag &= ~0x8000;
1916             set_parent_pag = 1;
1917         }
1918
1919         if (afs_pd_getStringPtr(ain, &cellName) != 0)
1920             return EINVAL;
1921
1922         code = _settok_tokenCell(cellName, &cellNum, NULL);
1923         if (code)
1924             return code;
1925     } else {
1926         /* default to primary cell, primary id */
1927         code = _settok_tokenCell(NULL, &cellNum, &flag);
1928         if (code)
1929             return code;
1930     }
1931
1932     if (set_parent_pag) {
1933         if (_settok_setParentPag(acred) == 0) {
1934             code = afs_CreateReq(&treq, *acred);
1935             if (code) {
1936                 return code;
1937             }
1938             areq = treq;
1939         }
1940     }
1941
1942     /* now we just set the tokens */
1943     tu = afs_GetUser(areq->uid, cellNum, WRITE_LOCK);
1944     /* Set tokens destroys any that are already there */
1945     afs_FreeTokens(&tu->tokens);
1946     afs_AddRxkadToken(&tu->tokens, stp, stLen, &clear);
1947 #ifndef AFS_NOSTATS
1948     afs_stats_cmfullperf.authent.TicketUpdates++;
1949     afs_ComputePAGStats();
1950 #endif /* AFS_NOSTATS */
1951     tu->states |= UHasTokens;
1952     tu->states &= ~UTokensBad;
1953     afs_SetPrimary(tu, flag);
1954     tu->tokenTime = osi_Time();
1955     afs_ResetUserConns(tu);
1956     afs_NotifyUser(tu, UTokensObtained);
1957     afs_PutUser(tu, WRITE_LOCK);
1958     afs_DestroyReq(treq);
1959
1960     return 0;
1961 }
1962
1963 /*!
1964  * VIOCGETVOLSTAT (4) - Get volume status
1965  *
1966  * \ingroup pioctl
1967  *
1968  * \param[in] ain       not in use
1969  * \param[out] aout     status of the volume
1970  *
1971  * \retval EINVAL       Error if some of the standard args aren't set
1972  *
1973  * \post
1974  *      The status of a volume (based on the FID of the volume), or an
1975  *      offline message /motd
1976  */
1977 DECL_PIOCTL(PGetVolumeStatus)
1978 {
1979     char volName[32];
1980     char *offLineMsg = afs_osi_Alloc(256);
1981     char *motd = afs_osi_Alloc(256);
1982     struct afs_conn *tc;
1983     afs_int32 code = 0;
1984     struct AFSFetchVolumeStatus volstat;
1985     char *Name;
1986     struct rx_connection *rxconn;
1987     XSTATS_DECLS;
1988
1989     osi_Assert(offLineMsg != NULL);
1990     osi_Assert(motd != NULL);
1991     AFS_STATCNT(PGetVolumeStatus);
1992     if (!avc) {
1993         code = EINVAL;
1994         goto out;
1995     }
1996     Name = volName;
1997     do {
1998         tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
1999         if (tc) {
2000             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_GETVOLUMESTATUS);
2001             RX_AFS_GUNLOCK();
2002             code =
2003                 RXAFS_GetVolumeStatus(rxconn, avc->f.fid.Fid.Volume, &volstat,
2004                                       &Name, &offLineMsg, &motd);
2005             RX_AFS_GLOCK();
2006             XSTATS_END_TIME;
2007         } else
2008             code = -1;
2009     } while (afs_Analyze
2010              (tc, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_GETVOLUMESTATUS,
2011               SHARED_LOCK, NULL));
2012
2013     if (code)
2014         goto out;
2015     /* Copy all this junk into msg->im_data, keeping track of the lengths. */
2016     if (afs_pd_putBytes(aout, &volstat, sizeof(VolumeStatus)) != 0)
2017         return E2BIG;
2018     if (afs_pd_putString(aout, volName) != 0)
2019         return E2BIG;
2020     if (afs_pd_putString(aout, offLineMsg) != 0)
2021         return E2BIG;
2022     if (afs_pd_putString(aout, motd) != 0)
2023         return E2BIG;
2024   out:
2025     afs_osi_Free(offLineMsg, 256);
2026     afs_osi_Free(motd, 256);
2027     return code;
2028 }
2029
2030 /*!
2031  * VIOCSETVOLSTAT (5) - Set volume status
2032  *
2033  * \ingroup pioctl
2034  *
2035  * \param[in] ain
2036  *      values to set the status at, offline message, message of the day,
2037  *      volume name, minimum quota, maximum quota
2038  * \param[out] aout
2039  *      status of a volume, offlines messages, minimum quota, maximumm quota
2040  *
2041  * \retval EINVAL
2042  *      Error if some of the standard args aren't set
2043  * \retval EROFS
2044  *      Error if the volume is read only, or a backup volume
2045  * \retval ENODEV
2046  *      Error if the volume can't be accessed
2047  * \retval E2BIG
2048  *      Error if the volume name, offline message, and motd are too big
2049  *
2050  * \post
2051  *      Set the status of a volume, including any offline messages,
2052  *      a minimum quota, and a maximum quota
2053  */
2054 DECL_PIOCTL(PSetVolumeStatus)
2055 {
2056     char *volName;
2057     char *offLineMsg;
2058     char *motd;
2059     struct afs_conn *tc;
2060     afs_int32 code = 0;
2061     struct AFSFetchVolumeStatus volstat;
2062     struct AFSStoreVolumeStatus storeStat;
2063     struct volume *tvp;
2064     struct rx_connection *rxconn;
2065     XSTATS_DECLS;
2066
2067     AFS_STATCNT(PSetVolumeStatus);
2068     if (!avc)
2069         return EINVAL;
2070     memset(&storeStat, 0, sizeof(storeStat));
2071
2072     tvp = afs_GetVolume(&avc->f.fid, areq, READ_LOCK);
2073     if (tvp) {
2074         if (tvp->states & (VRO | VBackup)) {
2075             afs_PutVolume(tvp, READ_LOCK);
2076             return EROFS;
2077         }
2078         afs_PutVolume(tvp, READ_LOCK);
2079     } else
2080         return ENODEV;
2081
2082
2083     if (afs_pd_getBytes(ain, &volstat, sizeof(AFSFetchVolumeStatus)) != 0)
2084         return EINVAL;
2085
2086     if (afs_pd_getStringPtr(ain, &volName) != 0)
2087         return EINVAL;
2088     if (strlen(volName) > 32)
2089         return E2BIG;
2090
2091     if (afs_pd_getStringPtr(ain, &offLineMsg) != 0)
2092         return EINVAL;
2093     if (strlen(offLineMsg) > 256)
2094         return E2BIG;
2095
2096     if (afs_pd_getStringPtr(ain, &motd) != 0)
2097         return EINVAL;
2098     if (strlen(motd) > 256)
2099         return E2BIG;
2100
2101     /* Done reading ... */
2102
2103     storeStat.Mask = 0;
2104     if (volstat.MinQuota != -1) {
2105         storeStat.MinQuota = volstat.MinQuota;
2106         storeStat.Mask |= AFS_SETMINQUOTA;
2107     }
2108     if (volstat.MaxQuota != -1) {
2109         storeStat.MaxQuota = volstat.MaxQuota;
2110         storeStat.Mask |= AFS_SETMAXQUOTA;
2111     }
2112     do {
2113         tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
2114         if (tc) {
2115             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_SETVOLUMESTATUS);
2116             RX_AFS_GUNLOCK();
2117             code =
2118                 RXAFS_SetVolumeStatus(rxconn, avc->f.fid.Fid.Volume, &storeStat,
2119                                       volName, offLineMsg, motd);
2120             RX_AFS_GLOCK();
2121             XSTATS_END_TIME;
2122         } else
2123             code = -1;
2124     } while (afs_Analyze
2125              (tc, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_SETVOLUMESTATUS,
2126               SHARED_LOCK, NULL));
2127
2128     if (code)
2129         return code;
2130     /* we are sending parms back to make compat. with prev system.  should
2131      * change interface later to not ask for current status, just set new
2132      * status */
2133
2134     if (afs_pd_putBytes(aout, &volstat, sizeof(VolumeStatus)) != 0)
2135         return EINVAL;
2136     if (afs_pd_putString(aout, volName) != 0)
2137         return EINVAL;
2138     if (afs_pd_putString(aout, offLineMsg) != 0)
2139         return EINVAL;
2140     if (afs_pd_putString(aout, motd) != 0)
2141         return EINVAL;
2142
2143     return code;
2144 }
2145
2146 /*!
2147  * VIOCFLUSH (6) - Invalidate cache entry
2148  *
2149  * \ingroup pioctl
2150  *
2151  * \param[in] ain       not in use
2152  * \param[out] aout     not in use
2153  *
2154  * \retval EINVAL       Error if some of the standard args aren't set
2155  *
2156  * \post Flush any information the cache manager has on an entry
2157  */
2158 DECL_PIOCTL(PFlush)
2159 {
2160     AFS_STATCNT(PFlush);
2161     if (!avc)
2162         return EINVAL;
2163     ObtainWriteLock(&avc->lock, 225);
2164     afs_ResetVCache(avc, *acred, 0);
2165     ReleaseWriteLock(&avc->lock);
2166     return 0;
2167 }
2168
2169 /*!
2170  * VIOC_AFS_STAT_MT_PT (29) - Stat mount point
2171  *
2172  * \ingroup pioctl
2173  *
2174  * \param[in] ain
2175  *      the last component in a path, related to mountpoint that we're
2176  *      looking for information about
2177  * \param[out] aout
2178  *      volume, cell, link data
2179  *
2180  * \retval EINVAL       Error if some of the standard args aren't set
2181  * \retval ENOTDIR      Error if the 'mount point' argument isn't a directory
2182  * \retval EIO          Error if the link data can't be accessed
2183  *
2184  * \post Get the volume, and cell, as well as the link data for a mount point
2185  */
2186 DECL_PIOCTL(PNewStatMount)
2187 {
2188     afs_int32 code;
2189     struct vcache *tvc;
2190     struct dcache *tdc;
2191     struct VenusFid tfid;
2192     char *bufp;
2193     char *name;
2194     struct sysname_info sysState;
2195     afs_size_t offset, len;
2196
2197     AFS_STATCNT(PNewStatMount);
2198     if (!avc)
2199         return EINVAL;
2200
2201     if (afs_pd_getStringPtr(ain, &name) != 0)
2202         return EINVAL;
2203
2204     code = afs_VerifyVCache(avc, areq);
2205     if (code)
2206         return code;
2207     if (vType(avc) != VDIR) {
2208         return ENOTDIR;
2209     }
2210     tdc = afs_GetDCache(avc, (afs_size_t) 0, areq, &offset, &len, 1);
2211     if (!tdc)
2212         return EIO;
2213     Check_AtSys(avc, name, &sysState, areq);
2214     ObtainReadLock(&tdc->lock);
2215     do {
2216         code = afs_dir_Lookup(tdc, sysState.name, &tfid.Fid);
2217     } while (code == ENOENT && Next_AtSys(avc, areq, &sysState));
2218     ReleaseReadLock(&tdc->lock);
2219     afs_PutDCache(tdc);         /* we're done with the data */
2220     bufp = sysState.name;
2221     if (code) {
2222         goto out;
2223     }
2224     tfid.Cell = avc->f.fid.Cell;
2225     tfid.Fid.Volume = avc->f.fid.Fid.Volume;
2226     if (!tfid.Fid.Unique && (avc->f.states & CForeign)) {
2227         tvc = afs_LookupVCache(&tfid, areq, avc, bufp);
2228     } else {
2229         tvc = afs_GetVCache(&tfid, areq);
2230     }
2231     if (!tvc) {
2232         code = EIO;
2233         goto out;
2234     }
2235     if (tvc->mvstat != AFS_MVSTAT_MTPT) {
2236         afs_PutVCache(tvc);
2237         code = EINVAL;
2238         goto out;
2239     }
2240     ObtainWriteLock(&tvc->lock, 226);
2241     code = afs_HandleLink(tvc, areq);
2242     if (code == 0) {
2243         if (tvc->linkData) {
2244             if ((tvc->linkData[0] != '#') && (tvc->linkData[0] != '%'))
2245                 code = EINVAL;
2246             else {
2247                 /* we have the data */
2248                 if (afs_pd_putString(aout, tvc->linkData) != 0)
2249                     code = EINVAL;
2250             }
2251         } else
2252             code = EIO;
2253     }
2254     ReleaseWriteLock(&tvc->lock);
2255     afs_PutVCache(tvc);
2256   out:
2257     if (sysState.allocked)
2258         osi_FreeLargeSpace(bufp);
2259     return code;
2260 }
2261
2262 /*!
2263  * A helper function to get the n'th cell which a particular user has tokens
2264  * for. This is racy. If new tokens are added whilst we're iterating, then
2265  * we may return some cells twice. If tokens expire mid run, then we'll
2266  * miss some cells from our output. So, could be better, but that would
2267  * require an interface change.
2268  */
2269
2270 static struct unixuser *
2271 getNthCell(afs_int32 uid, afs_int32 iterator) {
2272     int i;
2273     struct unixuser *tu = NULL;
2274
2275     if (iterator > afs_cellindex)
2276         return NULL;            /* no point in looking */
2277
2278     i = UHash(uid);
2279     ObtainReadLock(&afs_xuser);
2280     for (tu = afs_users[i]; tu; tu = tu->next) {
2281         if (tu->uid == uid && (tu->states & UHasTokens)) {
2282             if (iterator-- == 0)
2283             break;      /* are we done yet? */
2284         }
2285     }
2286     if (tu) {
2287         tu->refCount++;
2288     }
2289     ReleaseReadLock(&afs_xuser);
2290     if (tu) {
2291         afs_LockUser(tu, READ_LOCK, 0);
2292     }
2293
2294
2295     return tu;
2296 }
2297 /*!
2298  * VIOCGETTOK (8) - Get authentication tokens
2299  *
2300  * \ingroup pioctl
2301  *
2302  * \param[in] ain       cellid to return tokens for
2303  * \param[out] aout     token
2304  *
2305  * \retval EIO
2306  *      Error if the afs daemon hasn't started yet
2307  * \retval EDOM
2308  *      Error if the input parameter is out of the bounds of the available
2309  *      tokens
2310  * \retval ENOTCONN
2311  *      Error if there aren't tokens for this cell
2312  *
2313  * \post
2314  *      If the input paramater exists, get the token that corresponds to
2315  *      the parameter value, if there is no token at this value, get the
2316  *      token for the first cell
2317  *
2318  * \notes "it's a weird interface (from comments in the code)"
2319  */
2320
2321 DECL_PIOCTL(PGetTokens)
2322 {
2323     struct cell *tcell;
2324     struct unixuser *tu = NULL;
2325     union tokenUnion *token;
2326     afs_int32 iterator = 0;
2327     int newStyle;
2328     int cellNum;
2329     int code = E2BIG;
2330
2331     AFS_STATCNT(PGetTokens);
2332     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2333         return EIO;             /* Inappropriate ioctl for device */
2334
2335     /* weird interface.  If input parameter is present, it is an integer and
2336      * we're supposed to return the parm'th tokens for this unix uid.
2337      * If not present, we just return tokens for cell 1.
2338      * If counter out of bounds, return EDOM.
2339      * If no tokens for the particular cell, return ENOTCONN.
2340      * Also, if this mysterious parm is present, we return, along with the
2341      * tokens, the primary cell indicator (an afs_int32 0) and the cell name
2342      * at the end, in that order.
2343      */
2344     newStyle = (afs_pd_remaining(ain) > 0);
2345     if (newStyle) {
2346         if (afs_pd_getInt(ain, &iterator) != 0)
2347             return EINVAL;
2348     }
2349     if (newStyle) {
2350         tu = getNthCell(areq->uid, iterator);
2351     } else {
2352         cellNum = afs_GetPrimaryCellNum();
2353         if (cellNum)
2354             tu = afs_FindUser(areq->uid, cellNum, READ_LOCK);
2355     }
2356     if (!tu) {
2357         return EDOM;
2358     }
2359     if (!(tu->states & UHasTokens)
2360         || !afs_HasUsableTokens(tu->tokens, osi_Time())) {
2361         tu->states |= (UTokensBad | UNeedsReset);
2362         afs_NotifyUser(tu, UTokensDropped);
2363         afs_PutUser(tu, READ_LOCK);
2364         return ENOTCONN;
2365     }
2366     token = afs_FindToken(tu->tokens, RX_SECIDX_KAD);
2367
2368     /* If they don't have an RXKAD token, but do have other tokens,
2369      * then sadly there's nothing this interface can do to help them. */
2370     if (token == NULL)
2371         return ENOTCONN;
2372
2373     /* for compat, we try to return 56 byte tix if they fit */
2374     iterator = token->rxkad.ticketLen;
2375     if (iterator < 56)
2376         iterator = 56;          /* # of bytes we're returning */
2377
2378     if (afs_pd_putInt(aout, iterator) != 0)
2379         goto out;
2380     if (afs_pd_putBytes(aout, token->rxkad.ticket, token->rxkad.ticketLen) != 0)
2381         goto out;
2382     if (token->rxkad.ticketLen < 56) {
2383         /* Tokens are always 56 bytes or larger */
2384         if (afs_pd_skip(aout, iterator - token->rxkad.ticketLen) != 0) {
2385             goto out;
2386         }
2387     }
2388
2389     if (afs_pd_putInt(aout, sizeof(struct ClearToken)) != 0)
2390         goto out;
2391     if (afs_pd_putBytes(aout, &token->rxkad.clearToken,
2392                         sizeof(struct ClearToken)) != 0)
2393         goto out;
2394
2395     if (newStyle) {
2396         /* put out primary id and cell name, too */
2397         iterator = (tu->states & UPrimary ? 1 : 0);
2398         if (afs_pd_putInt(aout, iterator) != 0)
2399             goto out;
2400         tcell = afs_GetCell(tu->cell, READ_LOCK);
2401         if (tcell) {
2402             if (afs_pd_putString(aout, tcell->cellName) != 0)
2403                 goto out;
2404             afs_PutCell(tcell, READ_LOCK);
2405         } else
2406             if (afs_pd_putString(aout, "") != 0)
2407                 goto out;
2408     }
2409     /* Got here, all is good */
2410     code = 0;
2411 out:
2412     afs_PutUser(tu, READ_LOCK);
2413     return code;
2414 }
2415
2416 /*!
2417  * VIOCUNLOG (9) - Invalidate tokens
2418  *
2419  * \ingroup pioctl
2420  *
2421  * \param[in] ain       not in use
2422  * \param[out] aout     not in use
2423  *
2424  * \retval EIO  Error if the afs daemon hasn't been started yet
2425  *
2426  * \post remove tokens from a user, specified by the user id
2427  *
2428  * \notes sets the token's time to 0, which then causes it to be removed
2429  * \notes Unlog is the same as un-pag in OpenAFS
2430  */
2431 DECL_PIOCTL(PUnlog)
2432 {
2433     afs_int32 i;
2434     struct unixuser *tu;
2435
2436     AFS_STATCNT(PUnlog);
2437     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2438         return EIO;             /* Inappropriate ioctl for device */
2439
2440     i = UHash(areq->uid);
2441     ObtainWriteLock(&afs_xuser, 227);
2442     for (tu = afs_users[i]; tu; tu = tu->next) {
2443         if (tu->uid == areq->uid) {
2444             tu->refCount++;
2445             ReleaseWriteLock(&afs_xuser);
2446
2447             afs_LockUser(tu, WRITE_LOCK, 366);
2448
2449             tu->states &= ~UHasTokens;
2450             afs_FreeTokens(&tu->tokens);
2451             afs_NotifyUser(tu, UTokensDropped);
2452             /* We have to drop the lock over the call to afs_ResetUserConns,
2453              * since it obtains the afs_xvcache lock.  We could also keep
2454              * the lock, and modify ResetUserConns to take parm saying we
2455              * obtained the lock already, but that is overkill.  By keeping
2456              * the "tu" pointer held over the released lock, we guarantee
2457              * that we won't lose our place, and that we'll pass over
2458              * every user conn that existed when we began this call.
2459              */
2460             afs_ResetUserConns(tu);
2461             afs_PutUser(tu, WRITE_LOCK);
2462             ObtainWriteLock(&afs_xuser, 228);
2463 #ifdef UKERNEL
2464             /* set the expire times to 0, causes
2465              * afs_GCUserData to remove this entry
2466              */
2467             tu->tokenTime = 0;
2468 #endif /* UKERNEL */
2469         }
2470     }
2471     ReleaseWriteLock(&afs_xuser);
2472     return 0;
2473 }
2474
2475 /*!
2476  * VIOC_AFS_MARINER_HOST (32) - Get/set mariner (cache manager monitor) host
2477  *
2478  * \ingroup pioctl
2479  *
2480  * \param[in] ain       host address to be set
2481  * \param[out] aout     old host address
2482  *
2483  * \post
2484  *      depending on whether or not a variable is set, either get the host
2485  *      for the cache manager monitor, or set the old address and give it
2486  *      a new address
2487  *
2488  * \notes Errors turn off mariner
2489  */
2490 DECL_PIOCTL(PMariner)
2491 {
2492     afs_int32 newHostAddr;
2493     afs_int32 oldHostAddr;
2494
2495     AFS_STATCNT(PMariner);
2496     if (afs_mariner)
2497         memcpy((char *)&oldHostAddr, (char *)&afs_marinerHost,
2498                sizeof(afs_int32));
2499     else
2500         oldHostAddr = 0xffffffff;       /* disabled */
2501
2502     if (afs_pd_getInt(ain, &newHostAddr) != 0)
2503         return EINVAL;
2504
2505     if (newHostAddr == 0xffffffff) {
2506         /* disable mariner operations */
2507         afs_mariner = 0;
2508     } else if (newHostAddr) {
2509         afs_mariner = 1;
2510         afs_marinerHost = newHostAddr;
2511     }
2512
2513     if (afs_pd_putInt(aout, oldHostAddr) != 0)
2514         return E2BIG;
2515
2516     return 0;
2517 }
2518
2519 /*!
2520  * VIOCCKSERV (10) - Check that servers are up
2521  *
2522  * \ingroup pioctl
2523  *
2524  * \param[in] ain       name of the cell
2525  * \param[out] aout     current down server list
2526  *
2527  * \retval EIO          Error if the afs daemon hasn't started yet
2528  * \retval EACCES       Error if the user doesn't have super-user credentials
2529  * \retval ENOENT       Error if we are unable to obtain the cell
2530  *
2531  * \post
2532  *      Either a fast check (where it doesn't contact servers) or a
2533  *      local check (checks local cell only)
2534  */
2535 DECL_PIOCTL(PCheckServers)
2536 {
2537     int i;
2538     struct server *ts;
2539     afs_int32 temp;
2540     char *cellName = NULL;
2541     struct cell *cellp;
2542     struct chservinfo *pcheck;
2543
2544     AFS_STATCNT(PCheckServers);
2545
2546     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2547         return EIO;             /* Inappropriate ioctl for device */
2548
2549     /* This is tricky, because we need to peak at the datastream to see
2550      * what we're getting. For now, let's cheat. */
2551
2552     /* ain contains either an int32 or a string */
2553     if (ain->remaining == 0)
2554         return EINVAL;
2555
2556     if (*(afs_int32 *)ain->ptr == 0x12345678) { /* For afs3.3 version */
2557         pcheck = afs_pd_inline(ain, sizeof(*pcheck));
2558         if (pcheck == NULL)
2559             return EINVAL;
2560
2561         if (pcheck->tinterval >= 0) {
2562             if (afs_pd_putInt(aout, afs_probe_interval) != 0)
2563                 return E2BIG;
2564             if (pcheck->tinterval > 0) {
2565                 if (!afs_osi_suser(*acred))
2566                     return EACCES;
2567                 afs_probe_interval = pcheck->tinterval;
2568             }
2569             return 0;
2570         }
2571         temp = pcheck->tflags;
2572         if (pcheck->tsize)
2573             cellName = pcheck->tbuffer;
2574     } else {                    /* For pre afs3.3 versions */
2575         if (afs_pd_getInt(ain, &temp) != 0)
2576             return EINVAL;
2577         if (afs_pd_remaining(ain) > 0) {
2578             if (afs_pd_getStringPtr(ain, &cellName) != 0)
2579                 return EINVAL;
2580         }
2581     }
2582
2583     /*
2584      * 1: fast check, don't contact servers.
2585      * 2: local cell only.
2586      */
2587     if (cellName) {
2588         /* have cell name, too */
2589         cellp = afs_GetCellByName(cellName, READ_LOCK);
2590         if (!cellp)
2591             return ENOENT;
2592     } else
2593         cellp = NULL;
2594     if (!cellp && (temp & 2)) {
2595         /* use local cell */
2596         cellp = afs_GetPrimaryCell(READ_LOCK);
2597     }
2598     if (!(temp & 1)) {          /* if not fast, call server checker routine */
2599         afs_CheckServers(1, cellp);     /* check down servers */
2600         afs_CheckServers(0, cellp);     /* check up servers */
2601     }
2602     /* now return the current down server list */
2603     ObtainReadLock(&afs_xserver);
2604     for (i = 0; i < NSERVERS; i++) {
2605         for (ts = afs_servers[i]; ts; ts = ts->next) {
2606             if (cellp && ts->cell != cellp)
2607                 continue;       /* cell spec'd and wrong */
2608             if ((ts->flags & SRVR_ISDOWN)
2609                 && ts->addr->sa_portal != ts->cell->vlport) {
2610                 afs_pd_putInt(aout, ts->addr->sa_ip);
2611             }
2612         }
2613     }
2614     ReleaseReadLock(&afs_xserver);
2615     if (cellp)
2616         afs_PutCell(cellp, READ_LOCK);
2617     return 0;
2618 }
2619
2620 /*!
2621  * VIOCCKBACK (11) - Check backup volume mappings
2622  *
2623  * \ingroup pioctl
2624  *
2625  * \param[in] ain       not in use
2626  * \param[out] aout     not in use
2627  *
2628  * \retval EIO          Error if the afs daemon hasn't started yet
2629  *
2630  * \post
2631  *      Check the root volume, and then check the names if the volume
2632  *      check variable is set to force, has expired, is busy, or if
2633  *      the mount points variable is set
2634  */
2635 DECL_PIOCTL(PCheckVolNames)
2636 {
2637     AFS_STATCNT(PCheckVolNames);
2638     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2639         return EIO;             /* Inappropriate ioctl for device */
2640
2641     afs_CheckRootVolume();
2642     afs_CheckVolumeNames(AFS_VOLCHECK_FORCE | AFS_VOLCHECK_EXPIRED |
2643                          AFS_VOLCHECK_BUSY | AFS_VOLCHECK_MTPTS);
2644     return 0;
2645 }
2646
2647 /*!
2648  * VIOCCKCONN (12) - Check connections for a user
2649  *
2650  * \ingroup pioctl
2651  *
2652  * \param[in] ain       not in use
2653  * \param[out] aout     not in use
2654  *
2655  * \retval EACCESS
2656  *      Error if no user is specififed, the user has no tokens set,
2657  *      or if the user's tokens are bad
2658  *
2659  * \post
2660  *      check to see if a user has the correct authentication.
2661  *      If so, allow access.
2662  *
2663  * \notes Check the connections to all the servers specified
2664  */
2665 DECL_PIOCTL(PCheckAuth)
2666 {
2667     int i;
2668     struct srvAddr *sa;
2669     struct sa_conn_vector *tcv;
2670     struct unixuser *tu;
2671     afs_int32 retValue;
2672
2673     AFS_STATCNT(PCheckAuth);
2674     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2675         return EIO;             /* Inappropriate ioctl for device */
2676
2677     retValue = 0;
2678     tu = afs_GetUser(areq->uid, 1, READ_LOCK);  /* check local cell authentication */
2679     if (!tu)
2680         retValue = EACCES;
2681     else {
2682         /* we have a user */
2683         ObtainReadLock(&afs_xsrvAddr);
2684         ObtainReadLock(&afs_xconn);
2685
2686         /* any tokens set? */
2687         if ((tu->states & UHasTokens) == 0)
2688             retValue = EACCES;
2689         /* all connections in cell 1 working? */
2690         for (i = 0; i < NSERVERS; i++) {
2691             for (sa = afs_srvAddrs[i]; sa; sa = sa->next_bkt) {
2692                 for (tcv = sa->conns; tcv; tcv = tcv->next) {
2693                     if (tcv->user == tu && (tu->states & UTokensBad))
2694                         retValue = EACCES;
2695                 }
2696             }
2697         }
2698         ReleaseReadLock(&afs_xsrvAddr);
2699         ReleaseReadLock(&afs_xconn);
2700         afs_PutUser(tu, READ_LOCK);
2701     }
2702     if (afs_pd_putInt(aout, retValue) != 0)
2703         return E2BIG;
2704     return 0;
2705 }
2706
2707 static int
2708 Prefetch(uparmtype apath, struct afs_ioctl *adata, int afollow,
2709          afs_ucred_t *acred)
2710 {
2711     char *tp;
2712     afs_int32 code;
2713 #if defined(AFS_SGI61_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
2714     size_t bufferSize;
2715 #else
2716     u_int bufferSize;
2717 #endif
2718
2719     AFS_STATCNT(Prefetch);
2720     if (!apath)
2721         return EINVAL;
2722     tp = osi_AllocLargeSpace(1024);
2723     AFS_COPYINSTR(apath, tp, 1024, &bufferSize, code);
2724     if (code) {
2725         osi_FreeLargeSpace(tp);
2726         return code;
2727     }
2728     if (afs_BBusy()) {          /* do this as late as possible */
2729         osi_FreeLargeSpace(tp);
2730         return EWOULDBLOCK;     /* pretty close */
2731     }
2732     afs_BQueue(BOP_PATH, (struct vcache *)0, 0, 0, acred, (afs_size_t) 0,
2733                (afs_size_t) 0, tp, (void *)0, (void *)0);
2734     return 0;
2735 }
2736
2737 /*!
2738  * VIOCWHEREIS (14) - Find out where a volume is located
2739  *
2740  * \ingroup pioctl
2741  *
2742  * \param[in] ain       not in use
2743  * \param[out] aout     volume location
2744  *
2745  * \retval EINVAL       Error if some of the default arguments don't exist
2746  * \retval ENODEV       Error if there is no such volume
2747  *
2748  * \post fine a volume, based on a volume file id
2749  *
2750  * \notes check each of the servers specified
2751  */
2752 DECL_PIOCTL(PFindVolume)
2753 {
2754     struct volume *tvp;
2755     struct server *ts;
2756     afs_int32 i;
2757     int code = 0;
2758
2759     AFS_STATCNT(PFindVolume);
2760     if (!avc)
2761         return EINVAL;
2762     tvp = afs_GetVolume(&avc->f.fid, areq, READ_LOCK);
2763     if (!tvp)
2764         return ENODEV;
2765
2766     for (i = 0; i < AFS_MAXHOSTS; i++) {
2767         ts = tvp->serverHost[i];
2768         if (!ts)
2769             break;
2770         if (afs_pd_putInt(aout, ts->addr->sa_ip) != 0) {
2771             code = E2BIG;
2772             goto out;
2773         }
2774     }
2775     if (i < AFS_MAXHOSTS) {
2776         /* still room for terminating NULL, add it on */
2777         if (afs_pd_putInt(aout, 0) != 0) {
2778             code = E2BIG;
2779             goto out;
2780         }
2781     }
2782 out:
2783     afs_PutVolume(tvp, READ_LOCK);
2784     return code;
2785 }
2786
2787 /*!
2788  * VIOCACCESS (20) - Access using PRS_FS bits
2789  *
2790  * \ingroup pioctl
2791  *
2792  * \param[in] ain       PRS_FS bits
2793  * \param[out] aout     not in use
2794  *
2795  * \retval EINVAL       Error if some of the initial arguments aren't set
2796  * \retval EACCES       Error if access is denied
2797  *
2798  * \post check to make sure access is allowed
2799  */
2800 DECL_PIOCTL(PViceAccess)
2801 {
2802     afs_int32 code;
2803     afs_int32 temp;
2804
2805     AFS_STATCNT(PViceAccess);
2806     if (!avc)
2807         return EINVAL;
2808
2809     code = afs_VerifyVCache(avc, areq);
2810     if (code)
2811         return code;
2812
2813     if (afs_pd_getInt(ain, &temp) != 0)
2814         return EINVAL;
2815
2816     code = afs_AccessOK(avc, temp, areq, CHECK_MODE_BITS);
2817     if (code)
2818         return 0;
2819     else
2820         return EACCES;
2821 }
2822
2823 /*!
2824  * VIOC_GETPAG (13) - Get PAG value
2825  *
2826  * \ingroup pioctl
2827  *
2828  * \param[in] ain       not in use
2829  * \param[out] aout     PAG value or NOPAG
2830  *
2831  * \post get PAG value for the caller's cred
2832  */
2833 DECL_PIOCTL(PGetPAG)
2834 {
2835     afs_int32 pag;
2836
2837     pag = PagInCred(*acred);
2838
2839     return afs_pd_putInt(aout, pag);
2840 }
2841
2842 DECL_PIOCTL(PPrecache)
2843 {
2844     afs_int32 newValue;
2845
2846     /*AFS_STATCNT(PPrecache);*/
2847     if (!afs_osi_suser(*acred))
2848         return EACCES;
2849
2850     if (afs_pd_getInt(ain, &newValue) != 0)
2851         return EINVAL;
2852
2853     afs_preCache = newValue*1024;
2854     return 0;
2855 }
2856
2857 /*!
2858  * VIOCSETCACHESIZE (24) - Set venus cache size in 1000 units
2859  *
2860  * \ingroup pioctl
2861  *
2862  * \param[in] ain       the size the venus cache should be set to
2863  * \param[out] aout     not in use
2864  *
2865  * \retval EACCES       Error if the user doesn't have super-user credentials
2866  * \retval EROFS        Error if the cache is set to be in memory
2867  *
2868  * \post
2869  *      Set the cache size based on user input.  If no size is given,
2870  *      set it to the default OpenAFS cache size.
2871  *
2872  * \notes
2873  *      recompute the general cache parameters for every single block allocated
2874  */
2875 DECL_PIOCTL(PSetCacheSize)
2876 {
2877     afs_int32 newValue;
2878     int waitcnt = 0;
2879
2880     AFS_STATCNT(PSetCacheSize);
2881
2882     if (!afs_osi_suser(*acred))
2883         return EACCES;
2884     /* too many things are setup initially in mem cache version */
2885     if (cacheDiskType == AFS_FCACHE_TYPE_MEM)
2886         return EROFS;
2887     if (afs_pd_getInt(ain, &newValue) != 0)
2888         return EINVAL;
2889     if (newValue == 0)
2890         afs_cacheBlocks = afs_stats_cmperf.cacheBlocksOrig;
2891     else {
2892         if (newValue < afs_min_cache)
2893             afs_cacheBlocks = afs_min_cache;
2894         else
2895             afs_cacheBlocks = newValue;
2896     }
2897     afs_stats_cmperf.cacheBlocksTotal = afs_cacheBlocks;
2898     afs_ComputeCacheParms();    /* recompute basic cache parameters */
2899     afs_MaybeWakeupTruncateDaemon();
2900     while (waitcnt++ < 100 && afs_cacheBlocks < afs_blocksUsed) {
2901         afs_osi_Wait(1000, 0, 0);
2902         afs_MaybeWakeupTruncateDaemon();
2903     }
2904     return 0;
2905 }
2906
2907 #define MAXGCSTATS      16
2908 /*!
2909  * VIOCGETCACHEPARMS (40) - Get cache stats
2910  *
2911  * \ingroup pioctl
2912  *
2913  * \param[in] ain       afs index flags
2914  * \param[out] aout     cache blocks, blocks used, blocks files (in an array)
2915  *
2916  * \post Get the cache blocks, and how many of the cache blocks there are
2917  */
2918 DECL_PIOCTL(PGetCacheSize)
2919 {
2920     afs_int32 results[MAXGCSTATS];
2921     afs_int32 flags;
2922     struct dcache * tdc;
2923     int i;
2924
2925     AFS_STATCNT(PGetCacheSize);
2926
2927     if (afs_pd_remaining(ain) == sizeof(afs_int32)) {
2928         afs_pd_getInt(ain, &flags); /* can't error, we just checked size */
2929     } else if (afs_pd_remaining(ain) == 0) {
2930         flags = 0;
2931     } else {
2932         return EINVAL;
2933     }
2934
2935     memset(results, 0, sizeof(results));
2936     results[0] = afs_cacheBlocks;
2937     results[1] = afs_blocksUsed;
2938     results[2] = afs_cacheFiles;
2939
2940     if (1 == flags){
2941         for (i = 0; i < afs_cacheFiles; i++) {
2942             if (afs_indexFlags[i] & IFFree) results[3]++;
2943         }
2944     } else if (2 == flags){
2945         for (i = 0; i < afs_cacheFiles; i++) {
2946             if (afs_indexFlags[i] & IFFree) results[3]++;
2947             if (afs_indexFlags[i] & IFEverUsed) results[4]++;
2948             if (afs_indexFlags[i] & IFDataMod) results[5]++;
2949             if (afs_indexFlags[i] & IFDirtyPages) results[6]++;
2950             if (afs_indexFlags[i] & IFAnyPages) results[7]++;
2951             if (afs_indexFlags[i] & IFDiscarded) results[8]++;
2952
2953             tdc = afs_indexTable[i];
2954             if (tdc){
2955                 afs_size_t size = tdc->validPos;
2956
2957                 results[9]++;
2958                 if ( 0 <= size && size < (1<<12) ) results[10]++;
2959                 else if (size < (1<<14) ) results[11]++;
2960                 else if (size < (1<<16) ) results[12]++;
2961                 else if (size < (1<<18) ) results[13]++;
2962                 else if (size < (1<<20) ) results[14]++;
2963                 else if (size >= (1<<20) ) results[15]++;
2964             }
2965         }
2966     }
2967     return afs_pd_putBytes(aout, results, sizeof(results));
2968 }
2969
2970 /*!
2971  * VIOCFLUSHCB (25) - Flush callback only
2972  *
2973  * \ingroup pioctl
2974  *
2975  * \param[in] ain       not in use
2976  * \param[out] aout     not in use
2977  *
2978  * \retval EINVAL       Error if some of the standard args aren't set
2979  * \retval 0            0 returned if the volume is set to read-only
2980  *
2981  * \post
2982  *      Flushes callbacks, by setting the length of callbacks to one,
2983  *      setting the next callback to be sent to the CB_DROPPED value,
2984  *      and then dequeues everything else.
2985  */
2986 DECL_PIOCTL(PRemoveCallBack)
2987 {
2988     struct afs_conn *tc;
2989     afs_int32 code = 0;
2990     struct AFSCallBack CallBacks_Array[1];
2991     struct AFSCBFids theFids;
2992     struct AFSCBs theCBs;
2993     struct rx_connection *rxconn;
2994     XSTATS_DECLS;
2995
2996     AFS_STATCNT(PRemoveCallBack);
2997     if (!avc)
2998         return EINVAL;
2999     if (avc->f.states & CRO)
3000         return 0;               /* read-only-ness can't change */
3001     ObtainWriteLock(&avc->lock, 229);
3002     theFids.AFSCBFids_len = 1;
3003     theCBs.AFSCBs_len = 1;
3004     theFids.AFSCBFids_val = (struct AFSFid *)&avc->f.fid.Fid;
3005     theCBs.AFSCBs_val = CallBacks_Array;
3006     CallBacks_Array[0].CallBackType = CB_DROPPED;
3007     if (avc->callback) {
3008         do {
3009             tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
3010             if (tc) {
3011                 XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_GIVEUPCALLBACKS);
3012                 RX_AFS_GUNLOCK();
3013                 code = RXAFS_GiveUpCallBacks(rxconn, &theFids, &theCBs);
3014                 RX_AFS_GLOCK();
3015                 XSTATS_END_TIME;
3016             }
3017             /* don't set code on failure since we wouldn't use it */
3018         } while (afs_Analyze
3019                  (tc, rxconn, code, &avc->f.fid, areq,
3020                   AFS_STATS_FS_RPCIDX_GIVEUPCALLBACKS, SHARED_LOCK, NULL));
3021
3022         afs_StaleVCacheFlags(avc, AFS_STALEVC_CLEARCB, CUnique);
3023     }
3024     ReleaseWriteLock(&avc->lock);
3025     return 0;
3026 }
3027
3028 /*!
3029  * VIOCNEWCELL (26) - Configure new cell
3030  *
3031  * \ingroup pioctl
3032  *
3033  * \param[in] ain
3034  *      the name of the cell, the hosts that will be a part of the cell,
3035  *      whether or not it's linked with another cell, the other cell it's
3036  *      linked with, the file server port, and the volume server port
3037  * \param[out] aout
3038  *      not in use
3039  *
3040  * \retval EIO          Error if the afs daemon hasn't started yet
3041  * \retval EACCES       Error if the user doesn't have super-user cedentials
3042  * \retval EINVAL       Error if some 'magic' var doesn't have a certain bit set
3043  *
3044  * \post creates a new cell
3045  */
3046 DECL_PIOCTL(PNewCell)
3047 {
3048     afs_int32 cellHosts[AFS_MAXCELLHOSTS], magic = 0;
3049     char *newcell = NULL;
3050     char *linkedcell = NULL;
3051     afs_int32 code, ls;
3052     afs_int32 linkedstate = 0;
3053     afs_int32 fsport = 0, vlport = 0;
3054     int skip;
3055
3056     AFS_STATCNT(PNewCell);
3057     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3058         return EIO;             /* Inappropriate ioctl for device */
3059
3060     if (!afs_osi_suser(*acred))
3061         return EACCES;
3062
3063     if (afs_pd_getInt(ain, &magic) != 0)
3064         return EINVAL;
3065     if (magic != 0x12345678)
3066         return EINVAL;
3067
3068     /* A 3.4 fs newcell command will pass an array of AFS_MAXCELLHOSTS
3069      * server addresses while the 3.5 fs newcell command passes
3070      * AFS_MAXHOSTS. To figure out which is which, check if the cellname
3071      * is good.
3072      *
3073      * This whole logic is bogus, because it relies on the newer command
3074      * sending its 12th address as 0.
3075      */
3076     if (afs_pd_remaining(ain) < (AFS_MAXCELLHOSTS + 3) * sizeof(afs_int32))
3077         return EINVAL;
3078
3079     newcell = afs_pd_where(ain) + (AFS_MAXCELLHOSTS + 3) * sizeof(afs_int32);
3080     if (newcell[0] != '\0') {
3081         skip = 0;
3082     } else {
3083         skip = AFS_MAXHOSTS - AFS_MAXCELLHOSTS;
3084     }
3085
3086     /* AFS_MAXCELLHOSTS (=8) is less than AFS_MAXHOSTS (=13) */
3087     if (afs_pd_getBytes(ain, &cellHosts,
3088                         AFS_MAXCELLHOSTS * sizeof(afs_int32)) != 0)
3089         return EINVAL;
3090     if (afs_pd_skip(ain, skip * sizeof(afs_int32)) !=0)
3091         return EINVAL;
3092
3093     if (afs_pd_getInt(ain, &fsport) != 0)
3094         return EINVAL;
3095     if (fsport < 1024)
3096         fsport = 0;             /* Privileged ports not allowed */
3097
3098     if (afs_pd_getInt(ain, &vlport) != 0)
3099         return EINVAL;
3100     if (vlport < 1024)
3101         vlport = 0;             /* Privileged ports not allowed */
3102
3103     if (afs_pd_getInt(ain, &ls) != 0)
3104         return EINVAL;
3105
3106     if (afs_pd_getStringPtr(ain, &newcell) != 0)
3107         return EINVAL;
3108
3109     if (ls & 1) {
3110         if (afs_pd_getStringPtr(ain, &linkedcell) != 0)
3111             return EINVAL;
3112         linkedstate |= CLinkedCell;
3113     }
3114
3115     linkedstate |= CNoSUID;     /* setuid is disabled by default for fs newcell */
3116     code =
3117         afs_NewCell(newcell, cellHosts, linkedstate, linkedcell, fsport,
3118                     vlport, (int)0);
3119     return code;
3120 }
3121
3122 DECL_PIOCTL(PNewAlias)
3123 {
3124     /* create a new cell alias */
3125     char *realName, *aliasName;
3126
3127     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3128         return EIO;             /* Inappropriate ioctl for device */
3129
3130     if (!afs_osi_suser(*acred))
3131         return EACCES;
3132
3133     if (afs_pd_getStringPtr(ain, &aliasName) != 0)
3134         return EINVAL;
3135     if (afs_pd_getStringPtr(ain, &realName) != 0)
3136         return EINVAL;
3137
3138     return afs_NewCellAlias(aliasName, realName);
3139 }
3140
3141 /*!
3142  * VIOCGETCELL (27) - Get cell info
3143  *
3144  * \ingroup pioctl
3145  *
3146  * \param[in] ain       The cell index of a specific cell
3147  * \param[out] aout     list of servers in the cell
3148  *
3149  * \retval EIO          Error if the afs daemon hasn't started yet
3150  * \retval EDOM         Error if there is no cell asked about
3151  *
3152  * \post Lists the cell's server names and and addresses
3153  */
3154 DECL_PIOCTL(PListCells)
3155 {
3156     afs_int32 whichCell;
3157     struct cell *tcell = 0;
3158     afs_int32 i;
3159     int code;
3160
3161     AFS_STATCNT(PListCells);
3162     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3163         return EIO;             /* Inappropriate ioctl for device */
3164
3165     if (afs_pd_getInt(ain, &whichCell) != 0)
3166         return EINVAL;
3167
3168     tcell = afs_GetCellByIndex(whichCell, READ_LOCK);
3169     if (!tcell)
3170         return EDOM;
3171
3172     code = E2BIG;
3173
3174     for (i = 0; i < AFS_MAXCELLHOSTS; i++) {
3175         if (tcell->cellHosts[i] == 0)
3176             break;
3177         if (afs_pd_putInt(aout, tcell->cellHosts[i]->addr->sa_ip) != 0)
3178             goto out;
3179     }
3180     for (;i < AFS_MAXCELLHOSTS; i++) {
3181         if (afs_pd_putInt(aout, 0) != 0)
3182             goto out;
3183     }
3184     if (afs_pd_putString(aout, tcell->cellName) != 0)
3185         goto out;
3186     code = 0;
3187
3188 out:
3189     afs_PutCell(tcell, READ_LOCK);
3190     return code;
3191 }
3192
3193 DECL_PIOCTL(PListAliases)
3194 {
3195     afs_int32 whichAlias;
3196     struct cell_alias *tcalias = 0;
3197     int code;
3198
3199     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3200         return EIO;             /* Inappropriate ioctl for device */
3201
3202     if (afs_pd_getInt(ain, &whichAlias) != 0)
3203         return EINVAL;
3204
3205     tcalias = afs_GetCellAlias(whichAlias);
3206     if (tcalias == NULL)
3207         return EDOM;
3208
3209     code = E2BIG;
3210     if (afs_pd_putString(aout, tcalias->alias) != 0)
3211         goto out;
3212     if (afs_pd_putString(aout, tcalias->cell) != 0)
3213         goto out;
3214
3215     code = 0;
3216 out:
3217     afs_PutCellAlias(tcalias);
3218     return code;
3219 }
3220
3221 /*!
3222  * VIOC_AFS_DELETE_MT_PT (28) - Delete mount point
3223  *
3224  * \ingroup pioctl
3225  *
3226  * \param[in] ain       the name of the file in this dir to remove
3227  * \param[out] aout     not in use
3228  *
3229  * \retval EINVAL
3230  *      Error if some of the standard args aren't set
3231  * \retval ENOTDIR
3232  *      Error if the argument to remove is not a directory
3233  * \retval ENOENT
3234  *      Error if there is no cache to remove the mount point from or
3235  *      if a vcache doesn't exist
3236  *
3237  * \post
3238  *      Ensure that everything is OK before deleting the mountpoint.
3239  *      If not, don't delete.  Delete a mount point based on a file id.
3240  */
3241 DECL_PIOCTL(PRemoveMount)
3242 {
3243     afs_int32 code;
3244     char *bufp;
3245     char *name;
3246     struct sysname_info sysState;
3247     afs_size_t offset, len;
3248     struct afs_conn *tc;
3249     struct dcache *tdc;
3250     struct vcache *tvc;
3251     struct AFSFetchStatus OutDirStatus;
3252     struct VenusFid tfid;
3253     struct AFSVolSync tsync;
3254     struct rx_connection *rxconn;
3255     XSTATS_DECLS;
3256
3257     /* "ain" is the name of the file in this dir to remove */
3258
3259     AFS_STATCNT(PRemoveMount);
3260     if (!avc)
3261         return EINVAL;
3262     if (afs_pd_getStringPtr(ain, &name) != 0)
3263         return EINVAL;
3264
3265     code = afs_VerifyVCache(avc, areq);
3266     if (code)
3267         return code;
3268     if (vType(avc) != VDIR)
3269         return ENOTDIR;
3270
3271     tdc = afs_GetDCache(avc, (afs_size_t) 0, areq, &offset, &len, 1);   /* test for error below */
3272     if (!tdc)
3273         return EIO;
3274     Check_AtSys(avc, name, &sysState, areq);
3275     ObtainReadLock(&tdc->lock);
3276     do {
3277         code = afs_dir_Lookup(tdc, sysState.name, &tfid.Fid);
3278     } while (code == ENOENT && Next_AtSys(avc, areq, &sysState));
3279     ReleaseReadLock(&tdc->lock);
3280     bufp = sysState.name;
3281     if (code) {
3282         afs_PutDCache(tdc);
3283         goto out;
3284     }
3285     tfid.Cell = avc->f.fid.Cell;
3286     tfid.Fid.Volume = avc->f.fid.Fid.Volume;
3287     if (!tfid.Fid.Unique && (avc->f.states & CForeign)) {
3288         tvc = afs_LookupVCache(&tfid, areq, avc, bufp);
3289     } else {
3290         tvc = afs_GetVCache(&tfid, areq);
3291     }
3292     if (!tvc) {
3293         code = EIO;
3294         afs_PutDCache(tdc);
3295         goto out;
3296     }
3297     if (tvc->mvstat != AFS_MVSTAT_MTPT) {
3298         afs_PutDCache(tdc);
3299         afs_PutVCache(tvc);
3300         code = EINVAL;
3301         goto out;
3302     }
3303     ObtainWriteLock(&tvc->lock, 230);
3304     code = afs_HandleLink(tvc, areq);
3305     if (!code) {
3306         if (tvc->linkData) {
3307             if ((tvc->linkData[0] != '#') && (tvc->linkData[0] != '%'))
3308                 code = EINVAL;
3309         } else
3310             code = EIO;
3311     }
3312     ReleaseWriteLock(&tvc->lock);
3313     osi_dnlc_purgedp(tvc);
3314     afs_PutVCache(tvc);
3315     if (code) {
3316         afs_PutDCache(tdc);
3317         goto out;
3318     }
3319     ObtainWriteLock(&avc->lock, 231);
3320     osi_dnlc_remove(avc, bufp, tvc);
3321     do {
3322         tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
3323         if (tc) {
3324             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_REMOVEFILE);
3325             RX_AFS_GUNLOCK();
3326             code =
3327                 RXAFS_RemoveFile(rxconn, (struct AFSFid *)&avc->f.fid.Fid, bufp,
3328                                  &OutDirStatus, &tsync);
3329             RX_AFS_GLOCK();
3330             XSTATS_END_TIME;
3331         } else
3332             code = -1;
3333     } while (afs_Analyze
3334              (tc, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_REMOVEFILE,
3335               SHARED_LOCK, NULL));
3336
3337     if (code) {
3338         if (tdc)
3339             afs_PutDCache(tdc);
3340         ReleaseWriteLock(&avc->lock);
3341         goto out;
3342     }
3343     if (tdc) {
3344         /* we have the thing in the cache */
3345         ObtainWriteLock(&tdc->lock, 661);
3346         if (afs_LocalHero(avc, tdc, &OutDirStatus, 1)) {
3347             /* we can do it locally */
3348             code = afs_dir_Delete(tdc, bufp);
3349             if (code) {
3350                 ZapDCE(tdc);    /* surprise error -- invalid value */
3351                 DZap(tdc);
3352             }
3353         }
3354         ReleaseWriteLock(&tdc->lock);
3355         afs_PutDCache(tdc);     /* drop ref count */
3356     }
3357     avc->f.states &= ~CUnique;  /* For the dfs xlator */
3358     ReleaseWriteLock(&avc->lock);
3359     code = 0;
3360   out:
3361     if (sysState.allocked)
3362         osi_FreeLargeSpace(bufp);
3363     return code;
3364 }
3365
3366 /*!
3367  * VIOC_GETCELLSTATUS (35) - Get cell status info
3368  *
3369  * \ingroup pioctl
3370  *
3371  * \param[in] ain       The cell you want status information on
3372  * \param[out] aout     cell state (as a struct)
3373  *
3374  * \retval EIO          Error if the afs daemon hasn't started yet
3375  * \retval ENOENT       Error if the cell doesn't exist
3376  *
3377  * \post Returns the state of the cell as defined in a struct cell
3378  */
3379 DECL_PIOCTL(PGetCellStatus)
3380 {
3381     struct cell *tcell;
3382     char *cellName;
3383     afs_int32 temp;
3384
3385     AFS_STATCNT(PGetCellStatus);
3386     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3387         return EIO;             /* Inappropriate ioctl for device */
3388
3389     if (afs_pd_getStringPtr(ain, &cellName) != 0)
3390         return EINVAL;
3391
3392     tcell = afs_GetCellByName(cellName, READ_LOCK);
3393     if (!tcell)
3394         return ENOENT;
3395     temp = tcell->states;
3396     afs_PutCell(tcell, READ_LOCK);
3397
3398     return afs_pd_putInt(aout, temp);
3399 }
3400
3401 /*!
3402  * VIOC_SETCELLSTATUS (36) - Set corresponding info
3403  *
3404  * \ingroup pioctl
3405  *
3406  * \param[in] ain
3407  *      The cell you want to set information about, and the values you
3408  *      want to set
3409  * \param[out] aout
3410  *      not in use
3411  *
3412  * \retval EIO          Error if the afs daemon hasn't started yet
3413  * \retval EACCES       Error if the user doesn't have super-user credentials
3414  *
3415  * \post
3416  *      Set the state of the cell in a defined struct cell, based on
3417  *      whether or not SetUID is allowed
3418  */
3419 DECL_PIOCTL(PSetCellStatus)
3420 {
3421     struct cell *tcell;
3422     char *cellName;
3423     afs_int32 flags0, flags1;
3424
3425     if (!afs_osi_suser(*acred))
3426         return EACCES;
3427     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3428         return EIO;             /* Inappropriate ioctl for device */
3429
3430     if (afs_pd_getInt(ain, &flags0) != 0)
3431         return EINVAL;
3432     if (afs_pd_getInt(ain, &flags1) != 0)
3433         return EINVAL;
3434     if (afs_pd_getStringPtr(ain, &cellName) != 0)
3435         return EINVAL;
3436
3437     tcell = afs_GetCellByName(cellName, WRITE_LOCK);
3438     if (!tcell)
3439         return ENOENT;
3440     if (flags0 & CNoSUID)
3441         tcell->states |= CNoSUID;
3442     else
3443         tcell->states &= ~CNoSUID;
3444     afs_PutCell(tcell, WRITE_LOCK);
3445     return 0;
3446 }
3447
3448 static int
3449 FlushVolumeData(struct VenusFid *afid, afs_ucred_t * acred)
3450 {
3451     afs_int32 i;
3452     struct dcache *tdc;
3453     struct vcache *tvc;
3454     struct volume *tv;
3455     afs_int32 all = 0;
3456     afs_int32 cell = 0;
3457     afs_int32 volume = 0;
3458     struct afs_q *tq, *uq;
3459     int code = 0;
3460 #ifdef AFS_DARWIN80_ENV
3461     vnode_t vp;
3462 #endif
3463
3464     if (!afid) {
3465         all = 1;
3466     } else {
3467         volume = afid->Fid.Volume;      /* who to zap */
3468         cell = afid->Cell;
3469     }
3470
3471     /*
3472      * Clear stat'd flag from all vnodes from this volume; this will
3473      * invalidate all the vcaches associated with the volume.
3474      */
3475  loop:
3476     ObtainReadLock(&afs_xvcache);
3477     for (i = (afid ? VCHashV(afid) : 0); i < VCSIZE; i = (afid ? VCSIZE : i+1)) {
3478         for (tq = afs_vhashTV[i].prev; tq != &afs_vhashTV[i]; tq = uq) {
3479             uq = QPrev(tq);
3480             tvc = QTOVH(tq);
3481             if (all || (tvc->f.fid.Fid.Volume == volume && tvc->f.fid.Cell == cell)) {
3482                 if (tvc->f.states & CVInit) {
3483                     ReleaseReadLock(&afs_xvcache);
3484                     afs_osi_Sleep(&tvc->f.states);
3485                     goto loop;
3486                 }
3487 #ifdef AFS_DARWIN80_ENV
3488                 if (tvc->f.states & CDeadVnode) {
3489                     ReleaseReadLock(&afs_xvcache);
3490                     afs_osi_Sleep(&tvc->f.states);
3491                     goto loop;
3492                 }
3493                 vp = AFSTOV(tvc);
3494                 if (vnode_get(vp))
3495                     continue;
3496                 if (vnode_ref(vp)) {
3497                     AFS_GUNLOCK();
3498                     vnode_put(vp);
3499                     AFS_GLOCK();
3500                     continue;
3501                 }
3502 #else
3503                 AFS_FAST_HOLD(tvc);
3504 #endif
3505                 ReleaseReadLock(&afs_xvcache);
3506                 ObtainWriteLock(&tvc->lock, 232);
3507                 afs_ResetVCache(tvc, acred, 1);
3508                 ReleaseWriteLock(&tvc->lock);
3509 #ifdef AFS_DARWIN80_ENV
3510                 vnode_put(AFSTOV(tvc));
3511 #endif
3512                 ObtainReadLock(&afs_xvcache);
3513                 uq = QPrev(tq);
3514                 /* our tvc ptr is still good until now */
3515                 AFS_FAST_RELE(tvc);
3516             }
3517         }
3518     }
3519     ReleaseReadLock(&afs_xvcache);
3520
3521
3522     ObtainWriteLock(&afs_xdcache, 328); /* needed to flush any stuff */
3523     for (i = 0; i < afs_cacheFiles; i++) {
3524         if (!(afs_indexFlags[i] & IFEverUsed))
3525             continue;           /* never had any data */
3526         tdc = afs_GetValidDSlot(i);
3527         if (!tdc) {
3528             code = EIO;
3529             break;
3530         }
3531         if (tdc->refCount <= 1) {    /* too high, in use by running sys call */
3532             ReleaseReadLock(&tdc->tlock);
3533             if (all || (tdc->f.fid.Fid.Volume == volume && tdc->f.fid.Cell == cell)) {
3534                 if (!(afs_indexFlags[i] & (IFDataMod | IFFree | IFDiscarded))) {
3535                     /* if the file is modified, but has a ref cnt of only 1,
3536                      * then someone probably has the file open and is writing
3537                      * into it. Better to skip flushing such a file, it will be
3538                      * brought back immediately on the next write anyway.
3539                      *
3540                      * Skip if already freed.
3541                      *
3542                      * If we *must* flush, then this code has to be rearranged
3543                      * to call afs_storeAllSegments() first */
3544                     afs_FlushDCache(tdc);
3545                 }
3546             }
3547         } else {
3548             ReleaseReadLock(&tdc->tlock);
3549         }
3550         afs_PutDCache(tdc);     /* bumped by getdslot */
3551     }
3552     ReleaseWriteLock(&afs_xdcache);
3553
3554     ObtainReadLock(&afs_xvolume);
3555     for (i = all ? 0 : VHash(volume); i < NVOLS; i++) {
3556         for (tv = afs_volumes[i]; tv; tv = tv->next) {
3557             if (all || tv->volume == volume) {
3558                 afs_ResetVolumeInfo(tv);
3559                 if (!all)
3560                     goto last;
3561             }
3562         }
3563     }
3564  last:
3565     ReleaseReadLock(&afs_xvolume);
3566
3567     /* probably, a user is doing this, probably, because things are screwed up.
3568      * maybe it's the dnlc's fault? */
3569     osi_dnlc_purge();
3570     return code;
3571 }
3572
3573 /*!
3574  * VIOC_FLUSHVOLUME (37) - Flush whole volume's data
3575  *
3576  * \ingroup pioctl
3577  *
3578  * \param[in] ain       not in use (args in avc)
3579  * \param[out] aout     not in use
3580  *
3581  * \retval EINVAL       Error if some of the standard args aren't set
3582  * \retval EIO          Error if the afs daemon hasn't started yet
3583  *
3584  * \post
3585  *      Flush all cached contents of a volume.  Exactly what stays and what
3586  *      goes depends on the platform.
3587  *
3588  * \notes
3589  *      Does not flush a file that a user has open and is using, because
3590  *      it will be re-created on next write.  Also purges the dnlc,
3591  *      because things are screwed up.
3592  */
3593 DECL_PIOCTL(PFlushVolumeData)
3594 {
3595     AFS_STATCNT(PFlushVolumeData);
3596     if (!avc)
3597         return EINVAL;
3598     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3599         return EIO;             /* Inappropriate ioctl for device */
3600
3601     return FlushVolumeData(&avc->f.fid, *acred);
3602 }
3603
3604 /*!
3605  * VIOC_FLUSHALL (14) - Flush whole volume's data for all volumes
3606  *
3607  * \ingroup pioctl
3608  *
3609  * \param[in] ain       not in use
3610  * \param[out] aout     not in use
3611  *
3612  * \retval EINVAL       Error if some of the standard args aren't set
3613  * \retval EIO          Error if the afs daemon hasn't started yet
3614  *
3615  * \post
3616  *      Flush all cached contents.  Exactly what stays and what
3617  *      goes depends on the platform.
3618  *
3619  * \notes
3620  *      Does not flush a file that a user has open and is using, because
3621  *      it will be re-created on next write.  Also purges the dnlc,
3622  *      because things are screwed up.
3623  */
3624 DECL_PIOCTL(PFlushAllVolumeData)
3625 {
3626     AFS_STATCNT(PFlushAllVolumeData);
3627
3628     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3629         return EIO;             /* Inappropriate ioctl for device */
3630
3631     return FlushVolumeData(NULL, *acred);
3632 }
3633
3634 /*!
3635  * VIOCGETVCXSTATUS (41) - gets vnode x status
3636  *
3637  * \ingroup pioctl
3638  *
3639  * \param[in] ain
3640  *      not in use (avc used)
3641  * \param[out] aout
3642  *      vcxstat: the file id, the data version, any lock, the parent vnode,
3643  *      the parent unique id, the trunc position, the callback, cbExpires,
3644  *      what access is being made, what files are open,
3645  *      any users executing/writing, the flock count, the states,
3646  *      the move stat
3647  *
3648  * \retval EINVAL
3649  *      Error if some of the initial default arguments aren't set
3650  * \retval EACCES
3651  *      Error if access to check the mode bits is denied
3652  *
3653  * \post
3654  *      gets stats for the vnode, a struct listed in vcxstat
3655  */
3656 DECL_PIOCTL(PGetVnodeXStatus)
3657 {
3658     afs_int32 code;
3659     struct vcxstat stat;
3660     afs_int32 mode, i;
3661
3662 /*  AFS_STATCNT(PGetVnodeXStatus); */
3663     if (!avc)
3664         return EINVAL;
3665     code = afs_VerifyVCache(avc, areq);
3666     if (code)
3667         return code;
3668     if (vType(avc) == VDIR)
3669         mode = PRSFS_LOOKUP;
3670     else
3671         mode = PRSFS_READ;
3672     if (!afs_AccessOK(avc, mode, areq, CHECK_MODE_BITS))
3673         return EACCES;
3674
3675     memset(&stat, 0, sizeof(struct vcxstat));
3676     stat.fid = avc->f.fid;
3677     hset32(stat.DataVersion, hgetlo(avc->f.m.DataVersion));
3678     stat.lock = avc->lock;
3679     stat.parentVnode = avc->f.parent.vnode;
3680     stat.parentUnique = avc->f.parent.unique;
3681     hset(stat.flushDV, avc->flushDV);
3682     hset(stat.mapDV, avc->mapDV);
3683     stat.truncPos = avc->f.truncPos;
3684     {                   /* just grab the first two - won't break anything... */
3685         struct axscache *ac;
3686
3687         for (i = 0, ac = avc->Access; ac && i < CPSIZE; i++, ac = ac->next) {
3688             stat.randomUid[i] = ac->uid;
3689             stat.randomAccess[i] = ac->axess;
3690         }
3691     }
3692     stat.callback = afs_data_pointer_to_int32(avc->callback);
3693     stat.cbExpires = avc->cbExpires;
3694     stat.anyAccess = avc->f.anyAccess;
3695     stat.opens = avc->opens;
3696     stat.execsOrWriters = avc->execsOrWriters;
3697     stat.flockCount = avc->flockCount;
3698     stat.mvstat = avc->mvstat;
3699     stat.states = avc->f.states;
3700     return afs_pd_putBytes(aout, &stat, sizeof(struct vcxstat));
3701 }
3702
3703
3704 DECL_PIOCTL(PGetVnodeXStatus2)
3705 {
3706     afs_int32 code;
3707     struct vcxstat2 stat;
3708     afs_int32 mode;
3709
3710     if (!avc)
3711         return EINVAL;
3712     code = afs_VerifyVCache(avc, areq);
3713     if (code)
3714         return code;
3715     if (vType(avc) == VDIR)
3716         mode = PRSFS_LOOKUP;
3717     else
3718         mode = PRSFS_READ;
3719     if (!afs_AccessOK(avc, mode, areq, CHECK_MODE_BITS))
3720         return EACCES;
3721
3722     memset(&stat, 0, sizeof(struct vcxstat2));
3723
3724     stat.cbExpires = avc->cbExpires;
3725     stat.anyAccess = avc->f.anyAccess;
3726     stat.mvstat = avc->mvstat;
3727     stat.callerAccess = afs_GetAccessBits(avc, ~0, areq);
3728
3729     return afs_pd_putBytes(aout, &stat, sizeof(struct vcxstat2));
3730 }
3731
3732
3733 /*!
3734  * VIOC_AFS_SYSNAME (38) - Change @sys value
3735  *
3736  * \ingroup pioctl
3737  *
3738  * \param[in] ain       new value for @sys
3739  * \param[out] aout     count, entry, list (debug values?)
3740  *
3741  * \retval EINVAL
3742  *      Error if afsd isn't running, the new sysname is too large,
3743  *      the new sysname causes issues (starts with a . or ..),
3744  *      there is no PAG set in the credentials, or the user of a PAG
3745  *      can't be found
3746  * \retval EACCES
3747  *      Error if the user doesn't have super-user credentials
3748  *
3749  * \post
3750  *      Set the value of @sys if these things work: if the input isn't
3751  *      too long or if input doesn't start with . or ..
3752  *
3753  * \notes
3754  *      We require root for local sysname changes, but not for remote
3755  *      (since we don't really believe remote uids anyway)
3756  *      outname[] shouldn't really be needed- this is left as an
3757  *      exercise for the reader.
3758  */
3759 DECL_PIOCTL(PSetSysName)
3760 {
3761     char *inname = NULL;
3762     char outname[MAXSYSNAME];
3763     afs_int32 setsysname;
3764     int foundname = 0;
3765     struct afs_exporter *exporter;
3766     struct unixuser *au;
3767     afs_int32 pag, error;
3768     int t, count, num = 0, allpags = 0;
3769     char **sysnamelist;
3770     struct afs_pdata validate;
3771
3772     AFS_STATCNT(PSetSysName);
3773     if (!afs_globalVFS) {
3774         /* Afsd is NOT running; disable it */
3775 #if defined(KERNEL_HAVE_UERROR)
3776         return (setuerror(EINVAL), EINVAL);
3777 #else
3778         return (EINVAL);
3779 #endif
3780     }
3781     if (afs_pd_getInt(ain, &setsysname) != 0)
3782         return EINVAL;
3783     if (setsysname & 0x8000) {
3784         allpags = 1;
3785         setsysname &= ~0x8000;
3786     }
3787     if (setsysname) {
3788
3789         /* Check my args */
3790         if (setsysname < 0 || setsysname > MAXNUMSYSNAMES)
3791             return EINVAL;
3792         validate = *ain;
3793         for (count = 0; count < setsysname; count++) {
3794             if (afs_pd_getStringPtr(&validate, &inname) != 0)
3795                 return EINVAL;
3796             t = strlen(inname);
3797             if (t >= MAXSYSNAME || t <= 0)
3798                 return EINVAL;
3799             /* check