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