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