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