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