kern_descrip.c revision 1.145.2.5 1 /* $NetBSD: kern_descrip.c,v 1.145.2.5 2007/01/30 13:51:40 ad Exp $ */
2
3 /*
4 * Copyright (c) 1982, 1986, 1989, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)kern_descrip.c 8.8 (Berkeley) 2/14/95
37 */
38
39 #include <sys/cdefs.h>
40 __KERNEL_RCSID(0, "$NetBSD: kern_descrip.c,v 1.145.2.5 2007/01/30 13:51:40 ad Exp $");
41
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/filedesc.h>
45 #include <sys/kernel.h>
46 #include <sys/vnode.h>
47 #include <sys/proc.h>
48 #include <sys/file.h>
49 #include <sys/namei.h>
50 #include <sys/socket.h>
51 #include <sys/socketvar.h>
52 #include <sys/stat.h>
53 #include <sys/ioctl.h>
54 #include <sys/fcntl.h>
55 #include <sys/malloc.h>
56 #include <sys/pool.h>
57 #include <sys/syslog.h>
58 #include <sys/unistd.h>
59 #include <sys/resourcevar.h>
60 #include <sys/conf.h>
61 #include <sys/event.h>
62 #include <sys/kauth.h>
63
64 #include <sys/mount.h>
65 #include <sys/syscallargs.h>
66
67 /*
68 * Descriptor management.
69 */
70 struct filelist filehead; /* head of list of open files */
71 int nfiles; /* actual number of open files */
72 POOL_INIT(file_pool, sizeof(struct file), 0, 0, 0, "filepl",
73 &pool_allocator_nointr);
74 POOL_INIT(cwdi_pool, sizeof(struct cwdinfo), 0, 0, 0, "cwdipl",
75 &pool_allocator_nointr);
76 POOL_INIT(filedesc0_pool, sizeof(struct filedesc0), 0, 0, 0, "fdescpl",
77 &pool_allocator_nointr);
78
79 /* Global file list lock */
80 static struct simplelock filelist_slock = SIMPLELOCK_INITIALIZER;
81
82 MALLOC_DEFINE(M_FILE, "file", "Open file structure");
83 MALLOC_DEFINE(M_FILEDESC, "file desc", "Open file descriptor table");
84 MALLOC_DEFINE(M_IOCTLOPS, "ioctlops", "ioctl data buffer");
85
86 static inline int
87 find_next_zero(uint32_t *bitmap, int want, u_int bits)
88 {
89 int i, off, maxoff;
90 uint32_t sub;
91
92 if (want > bits)
93 return -1;
94
95 off = want >> NDENTRYSHIFT;
96 i = want & NDENTRYMASK;
97 if (i) {
98 sub = bitmap[off] | ((u_int)~0 >> (NDENTRIES - i));
99 if (sub != ~0)
100 goto found;
101 off++;
102 }
103
104 maxoff = NDLOSLOTS(bits);
105 while (off < maxoff) {
106 if ((sub = bitmap[off]) != ~0)
107 goto found;
108 off++;
109 }
110
111 return (-1);
112
113 found:
114 return (off << NDENTRYSHIFT) + ffs(~sub) - 1;
115 }
116
117 static int
118 find_last_set(struct filedesc *fd, int last)
119 {
120 int off, i;
121 struct file **ofiles = fd->fd_ofiles;
122 uint32_t *bitmap = fd->fd_lomap;
123
124 off = (last - 1) >> NDENTRYSHIFT;
125
126 while (off >= 0 && !bitmap[off])
127 off--;
128
129 if (off < 0)
130 return (-1);
131
132 i = ((off + 1) << NDENTRYSHIFT) - 1;
133 if (i >= last)
134 i = last - 1;
135
136 while (i > 0 && ofiles[i] == NULL)
137 i--;
138
139 return (i);
140 }
141
142 static inline void
143 fd_used(struct filedesc *fdp, int fd)
144 {
145 u_int off = fd >> NDENTRYSHIFT;
146
147 LOCK_ASSERT(simple_lock_held(&fdp->fd_slock));
148 KDASSERT((fdp->fd_lomap[off] & (1 << (fd & NDENTRYMASK))) == 0);
149
150 fdp->fd_lomap[off] |= 1 << (fd & NDENTRYMASK);
151 if (fdp->fd_lomap[off] == ~0) {
152 KDASSERT((fdp->fd_himap[off >> NDENTRYSHIFT] &
153 (1 << (off & NDENTRYMASK))) == 0);
154 fdp->fd_himap[off >> NDENTRYSHIFT] |= 1 << (off & NDENTRYMASK);
155 }
156
157 if (fd > fdp->fd_lastfile)
158 fdp->fd_lastfile = fd;
159 }
160
161 static inline void
162 fd_unused(struct filedesc *fdp, int fd)
163 {
164 u_int off = fd >> NDENTRYSHIFT;
165
166 LOCK_ASSERT(simple_lock_held(&fdp->fd_slock));
167 if (fd < fdp->fd_freefile)
168 fdp->fd_freefile = fd;
169
170 if (fdp->fd_lomap[off] == ~0) {
171 KDASSERT((fdp->fd_himap[off >> NDENTRYSHIFT] &
172 (1 << (off & NDENTRYMASK))) != 0);
173 fdp->fd_himap[off >> NDENTRYSHIFT] &=
174 ~(1 << (off & NDENTRYMASK));
175 }
176 KDASSERT((fdp->fd_lomap[off] & (1 << (fd & NDENTRYMASK))) != 0);
177 fdp->fd_lomap[off] &= ~(1 << (fd & NDENTRYMASK));
178
179 #ifdef DIAGNOSTIC
180 if (fd > fdp->fd_lastfile)
181 panic("fd_unused: fd_lastfile inconsistent");
182 #endif
183 if (fd == fdp->fd_lastfile)
184 fdp->fd_lastfile = find_last_set(fdp, fd);
185 }
186
187 /*
188 * Lookup the file structure corresponding to a file descriptor
189 * and return it locked.
190 * Note: typical usage is: `fp = fd_getfile(..); FILE_USE(fp);'
191 * The locking strategy has been optimised for this case, i.e.
192 * fd_getfile() returns the file locked while FILE_USE() will increment
193 * the file's use count and unlock.
194 */
195 struct file *
196 fd_getfile(struct filedesc *fdp, int fd)
197 {
198 struct file *fp;
199
200 if ((u_int) fd >= fdp->fd_nfiles || (fp = fdp->fd_ofiles[fd]) == NULL)
201 return (NULL);
202
203 simple_lock(&fp->f_slock);
204 if (FILE_IS_USABLE(fp) == 0) {
205 simple_unlock(&fp->f_slock);
206 return (NULL);
207 }
208
209 return (fp);
210 }
211
212 /*
213 * Common code for dup, dup2, and fcntl(F_DUPFD).
214 */
215 static int
216 finishdup(struct lwp *l, int old, int new, register_t *retval)
217 {
218 struct filedesc *fdp;
219 struct file *fp, *delfp;
220
221 fdp = l->l_proc->p_fd;
222
223 /*
224 * If there is a file in the new slot, remember it so we
225 * can close it after we've finished the dup. We need
226 * to do it after the dup is finished, since closing
227 * the file may block.
228 *
229 * Note: `old' is already used for us.
230 * Note: Caller already marked `new' slot "used".
231 */
232 simple_lock(&fdp->fd_slock);
233 delfp = fdp->fd_ofiles[new];
234
235 fp = fdp->fd_ofiles[old];
236 KDASSERT(fp != NULL);
237 fdp->fd_ofiles[new] = fp;
238 fdp->fd_ofileflags[new] = fdp->fd_ofileflags[old] &~ UF_EXCLOSE;
239 simple_unlock(&fdp->fd_slock);
240
241 *retval = new;
242 simple_lock(&fp->f_slock);
243 fp->f_count++;
244 FILE_UNUSE_HAVELOCK(fp, l);
245
246 if (delfp != NULL) {
247 simple_lock(&delfp->f_slock);
248 FILE_USE(delfp);
249 if (new < fdp->fd_knlistsize)
250 knote_fdclose(l, new);
251 (void) closef(delfp, l);
252 }
253 return (0);
254 }
255
256 /*
257 * System calls on descriptors.
258 */
259
260 /*
261 * Duplicate a file descriptor.
262 */
263 /* ARGSUSED */
264 int
265 sys_dup(struct lwp *l, void *v, register_t *retval)
266 {
267 struct sys_dup_args /* {
268 syscallarg(int) fd;
269 } */ *uap = v;
270 struct file *fp;
271 struct filedesc *fdp;
272 struct proc *p;
273 int old, new, error;
274
275 p = l->l_proc;
276 fdp = p->p_fd;
277 old = SCARG(uap, fd);
278
279 restart:
280 if ((fp = fd_getfile(fdp, old)) == NULL)
281 return (EBADF);
282
283 FILE_USE(fp);
284
285 if ((error = fdalloc(p, 0, &new)) != 0) {
286 if (error == ENOSPC) {
287 fdexpand(p);
288 FILE_UNUSE(fp, l);
289 goto restart;
290 }
291 FILE_UNUSE(fp, l);
292 return (error);
293 }
294
295 /* finishdup() will unuse the descriptors for us */
296 return (finishdup(l, old, new, retval));
297 }
298
299 /*
300 * Duplicate a file descriptor to a particular value.
301 */
302 /* ARGSUSED */
303 int
304 sys_dup2(struct lwp *l, void *v, register_t *retval)
305 {
306 struct sys_dup2_args /* {
307 syscallarg(int) from;
308 syscallarg(int) to;
309 } */ *uap = v;
310 struct file *fp;
311 struct filedesc *fdp;
312 struct proc *p;
313 int old, new, i, error;
314
315 p = l->l_proc;
316 fdp = p->p_fd;
317 old = SCARG(uap, from);
318 new = SCARG(uap, to);
319
320 restart:
321 if ((fp = fd_getfile(fdp, old)) == NULL)
322 return (EBADF);
323
324 if ((u_int)new >= p->p_rlimit[RLIMIT_NOFILE].rlim_cur ||
325 (u_int)new >= maxfiles) {
326 simple_unlock(&fp->f_slock);
327 return (EBADF);
328 }
329
330 if (old == new) {
331 simple_unlock(&fp->f_slock);
332 *retval = new;
333 return (0);
334 }
335
336 FILE_USE(fp);
337
338 if (new >= fdp->fd_nfiles) {
339 if ((error = fdalloc(p, new, &i)) != 0) {
340 if (error == ENOSPC) {
341 fdexpand(p);
342 FILE_UNUSE(fp, l);
343 goto restart;
344 }
345 FILE_UNUSE(fp, l);
346 return (error);
347 }
348 if (new != i)
349 panic("dup2: fdalloc");
350 } else {
351 simple_lock(&fdp->fd_slock);
352 /*
353 * Mark `new' slot "used" only if it was empty.
354 */
355 if (fdp->fd_ofiles[new] == NULL)
356 fd_used(fdp, new);
357 simple_unlock(&fdp->fd_slock);
358 }
359
360 /*
361 * finishdup() will close the file that's in the `new'
362 * slot, if there's one there.
363 */
364
365 /* finishdup() will unuse the descriptors for us */
366 return (finishdup(l, old, new, retval));
367 }
368
369 /*
370 * fcntl call which is being passed to the file's fs.
371 */
372 static int
373 fcntl_forfs(int fd, struct lwp *l, int cmd, void *arg)
374 {
375 struct file *fp;
376 struct filedesc *fdp;
377 int error;
378 u_int size;
379 void *data, *memp;
380 #define STK_PARAMS 128
381 char stkbuf[STK_PARAMS];
382
383 /* fd's value was validated in sys_fcntl before calling this routine */
384 fdp = l->l_proc->p_fd;
385 fp = fdp->fd_ofiles[fd];
386
387 if ((fp->f_flag & (FREAD | FWRITE)) == 0)
388 return (EBADF);
389
390 /*
391 * Interpret high order word to find amount of data to be
392 * copied to/from the user's address space.
393 */
394 size = (size_t)F_PARAM_LEN(cmd);
395 if (size > F_PARAM_MAX)
396 return (EINVAL);
397 memp = NULL;
398 if (size > sizeof(stkbuf)) {
399 memp = malloc((u_long)size, M_IOCTLOPS, M_WAITOK);
400 data = memp;
401 } else
402 data = stkbuf;
403 if (cmd & F_FSIN) {
404 if (size) {
405 error = copyin(arg, data, size);
406 if (error) {
407 if (memp)
408 free(memp, M_IOCTLOPS);
409 return (error);
410 }
411 } else
412 *(void **)data = arg;
413 } else if ((cmd & F_FSOUT) && size)
414 /*
415 * Zero the buffer so the user always
416 * gets back something deterministic.
417 */
418 memset(data, 0, size);
419 else if (cmd & F_FSVOID)
420 *(void **)data = arg;
421
422
423 error = (*fp->f_ops->fo_fcntl)(fp, cmd, data, l);
424
425 /*
426 * Copy any data to user, size was
427 * already set and checked above.
428 */
429 if (error == 0 && (cmd & F_FSOUT) && size)
430 error = copyout(data, arg, size);
431 if (memp)
432 free(memp, M_IOCTLOPS);
433 return (error);
434 }
435
436 /*
437 * The file control system call.
438 */
439 /* ARGSUSED */
440 int
441 sys_fcntl(struct lwp *l, void *v, register_t *retval)
442 {
443 struct sys_fcntl_args /* {
444 syscallarg(int) fd;
445 syscallarg(int) cmd;
446 syscallarg(void *) arg;
447 } */ *uap = v;
448 struct filedesc *fdp;
449 struct file *fp;
450 struct proc *p;
451 struct vnode *vp;
452 int fd, i, tmp, error, flg, cmd, newmin;
453 struct flock fl;
454
455 p = l->l_proc;
456 fd = SCARG(uap, fd);
457 cmd = SCARG(uap, cmd);
458 fdp = p->p_fd;
459 error = 0;
460 flg = F_POSIX;
461
462 switch (cmd) {
463 case F_CLOSEM:
464 if (fd < 0)
465 return EBADF;
466 while (fdp->fd_lastfile >= fd)
467 fdrelease(l, fdp->fd_lastfile);
468 return 0;
469
470 case F_MAXFD:
471 *retval = fdp->fd_lastfile;
472 return 0;
473
474 default:
475 /* Handled below */
476 break;
477 }
478
479 restart:
480 if ((fp = fd_getfile(fdp, fd)) == NULL)
481 return (EBADF);
482
483 FILE_USE(fp);
484
485 if ((cmd & F_FSCTL)) {
486 error = fcntl_forfs(fd, l, cmd, SCARG(uap, arg));
487 goto out;
488 }
489
490 switch (cmd) {
491
492 case F_DUPFD:
493 newmin = (long)SCARG(uap, arg);
494 if ((u_int)newmin >= p->p_rlimit[RLIMIT_NOFILE].rlim_cur ||
495 (u_int)newmin >= maxfiles) {
496 error = EINVAL;
497 goto out;
498 }
499 if ((error = fdalloc(p, newmin, &i)) != 0) {
500 if (error == ENOSPC) {
501 fdexpand(p);
502 FILE_UNUSE(fp, l);
503 goto restart;
504 }
505 goto out;
506 }
507
508 /* finishdup() will unuse the descriptors for us */
509 return (finishdup(l, fd, i, retval));
510
511 case F_GETFD:
512 *retval = fdp->fd_ofileflags[fd] & UF_EXCLOSE ? 1 : 0;
513 break;
514
515 case F_SETFD:
516 if ((long)SCARG(uap, arg) & 1)
517 fdp->fd_ofileflags[fd] |= UF_EXCLOSE;
518 else
519 fdp->fd_ofileflags[fd] &= ~UF_EXCLOSE;
520 break;
521
522 case F_GETFL:
523 *retval = OFLAGS(fp->f_flag);
524 break;
525
526 case F_SETFL:
527 tmp = FFLAGS((long)SCARG(uap, arg)) & FCNTLFLAGS;
528 error = (*fp->f_ops->fo_fcntl)(fp, F_SETFL, &tmp, l);
529 if (error)
530 break;
531 i = tmp ^ fp->f_flag;
532 if (i & FNONBLOCK) {
533 int flgs = tmp & FNONBLOCK;
534 error = (*fp->f_ops->fo_ioctl)(fp, FIONBIO, &flgs, l);
535 if (error)
536 goto reset_fcntl;
537 }
538 if (i & FASYNC) {
539 int flgs = tmp & FASYNC;
540 error = (*fp->f_ops->fo_ioctl)(fp, FIOASYNC, &flgs, l);
541 if (error) {
542 if (i & FNONBLOCK) {
543 tmp = fp->f_flag & FNONBLOCK;
544 (void)(*fp->f_ops->fo_ioctl)(fp,
545 FIONBIO, &tmp, l);
546 }
547 goto reset_fcntl;
548 }
549 }
550 fp->f_flag = (fp->f_flag & ~FCNTLFLAGS) | tmp;
551 break;
552 reset_fcntl:
553 (void)(*fp->f_ops->fo_fcntl)(fp, F_SETFL, &fp->f_flag, l);
554 break;
555
556 case F_GETOWN:
557 error = (*fp->f_ops->fo_ioctl)(fp, FIOGETOWN, &tmp, l);
558 *retval = tmp;
559 break;
560
561 case F_SETOWN:
562 tmp = (int)(intptr_t) SCARG(uap, arg);
563 error = (*fp->f_ops->fo_ioctl)(fp, FIOSETOWN, &tmp, l);
564 break;
565
566 case F_SETLKW:
567 flg |= F_WAIT;
568 /* Fall into F_SETLK */
569
570 case F_SETLK:
571 if (fp->f_type != DTYPE_VNODE) {
572 error = EINVAL;
573 goto out;
574 }
575 vp = (struct vnode *)fp->f_data;
576 /* Copy in the lock structure */
577 error = copyin(SCARG(uap, arg), &fl, sizeof(fl));
578 if (error)
579 goto out;
580 if (fl.l_whence == SEEK_CUR)
581 fl.l_start += fp->f_offset;
582 switch (fl.l_type) {
583 case F_RDLCK:
584 if ((fp->f_flag & FREAD) == 0) {
585 error = EBADF;
586 goto out;
587 }
588 p->p_flag |= P_ADVLOCK;
589 error = VOP_ADVLOCK(vp, p, F_SETLK, &fl, flg);
590 goto out;
591
592 case F_WRLCK:
593 if ((fp->f_flag & FWRITE) == 0) {
594 error = EBADF;
595 goto out;
596 }
597 p->p_flag |= P_ADVLOCK;
598 error = VOP_ADVLOCK(vp, p, F_SETLK, &fl, flg);
599 goto out;
600
601 case F_UNLCK:
602 error = VOP_ADVLOCK(vp, p, F_UNLCK, &fl, F_POSIX);
603 goto out;
604
605 default:
606 error = EINVAL;
607 goto out;
608 }
609
610 case F_GETLK:
611 if (fp->f_type != DTYPE_VNODE) {
612 error = EINVAL;
613 goto out;
614 }
615 vp = (struct vnode *)fp->f_data;
616 /* Copy in the lock structure */
617 error = copyin(SCARG(uap, arg), &fl, sizeof(fl));
618 if (error)
619 goto out;
620 if (fl.l_whence == SEEK_CUR)
621 fl.l_start += fp->f_offset;
622 if (fl.l_type != F_RDLCK &&
623 fl.l_type != F_WRLCK &&
624 fl.l_type != F_UNLCK) {
625 error = EINVAL;
626 goto out;
627 }
628 error = VOP_ADVLOCK(vp, p, F_GETLK, &fl, F_POSIX);
629 if (error)
630 goto out;
631 error = copyout(&fl, SCARG(uap, arg), sizeof(fl));
632 break;
633
634 default:
635 error = EINVAL;
636 }
637
638 out:
639 FILE_UNUSE(fp, l);
640 return (error);
641 }
642
643 void
644 fdremove(struct filedesc *fdp, int fd)
645 {
646
647 simple_lock(&fdp->fd_slock);
648 fdp->fd_ofiles[fd] = NULL;
649 fd_unused(fdp, fd);
650 simple_unlock(&fdp->fd_slock);
651 }
652
653 int
654 fdrelease(struct lwp *l, int fd)
655 {
656 struct proc *p = l->l_proc;
657 struct filedesc *fdp;
658 struct file **fpp, *fp;
659
660 fdp = p->p_fd;
661 simple_lock(&fdp->fd_slock);
662 if (fd < 0 || fd > fdp->fd_lastfile)
663 goto badf;
664 fpp = &fdp->fd_ofiles[fd];
665 fp = *fpp;
666 if (fp == NULL)
667 goto badf;
668
669 simple_lock(&fp->f_slock);
670 if (!FILE_IS_USABLE(fp)) {
671 simple_unlock(&fp->f_slock);
672 goto badf;
673 }
674
675 FILE_USE(fp);
676
677 *fpp = NULL;
678 fdp->fd_ofileflags[fd] = 0;
679 fd_unused(fdp, fd);
680 simple_unlock(&fdp->fd_slock);
681 if (fd < fdp->fd_knlistsize)
682 knote_fdclose(l, fd);
683 return (closef(fp, l));
684
685 badf:
686 simple_unlock(&fdp->fd_slock);
687 return (EBADF);
688 }
689
690 /*
691 * Close a file descriptor.
692 */
693 /* ARGSUSED */
694 int
695 sys_close(struct lwp *l, void *v, register_t *retval)
696 {
697 struct sys_close_args /* {
698 syscallarg(int) fd;
699 } */ *uap = v;
700 int fd;
701 struct filedesc *fdp;
702 struct proc *p;
703
704 p = l->l_proc;
705 fd = SCARG(uap, fd);
706 fdp = p->p_fd;
707
708 #if 0
709 if (fd_getfile(fdp, fd) == NULL)
710 return (EBADF);
711 #endif
712
713 return (fdrelease(l, fd));
714 }
715
716 /*
717 * Return status information about a file descriptor.
718 */
719 /* ARGSUSED */
720 int
721 sys___fstat30(struct lwp *l, void *v, register_t *retval)
722 {
723 struct sys___fstat30_args /* {
724 syscallarg(int) fd;
725 syscallarg(struct stat *) sb;
726 } */ *uap = v;
727 int fd;
728 struct filedesc *fdp;
729 struct file *fp;
730 struct proc *p;
731 struct stat ub;
732 int error;
733
734 p = l->l_proc;
735 fd = SCARG(uap, fd);
736 fdp = p->p_fd;
737
738 if ((fp = fd_getfile(fdp, fd)) == NULL)
739 return (EBADF);
740
741 FILE_USE(fp);
742 error = (*fp->f_ops->fo_stat)(fp, &ub, l);
743 FILE_UNUSE(fp, l);
744
745 if (error == 0)
746 error = copyout(&ub, SCARG(uap, sb), sizeof(ub));
747
748 return (error);
749 }
750
751 /*
752 * Return pathconf information about a file descriptor.
753 */
754 /* ARGSUSED */
755 int
756 sys_fpathconf(struct lwp *l, void *v, register_t *retval)
757 {
758 struct sys_fpathconf_args /* {
759 syscallarg(int) fd;
760 syscallarg(int) name;
761 } */ *uap = v;
762 int fd;
763 struct filedesc *fdp;
764 struct file *fp;
765 struct proc *p;
766 struct vnode *vp;
767 int error;
768
769 p = l->l_proc;
770 fd = SCARG(uap, fd);
771 fdp = p->p_fd;
772 error = 0;
773
774 if ((fp = fd_getfile(fdp, fd)) == NULL)
775 return (EBADF);
776
777 FILE_USE(fp);
778
779 switch (fp->f_type) {
780
781 case DTYPE_SOCKET:
782 case DTYPE_PIPE:
783 if (SCARG(uap, name) != _PC_PIPE_BUF)
784 error = EINVAL;
785 else
786 *retval = PIPE_BUF;
787 break;
788
789 case DTYPE_VNODE:
790 vp = (struct vnode *)fp->f_data;
791 error = VOP_PATHCONF(vp, SCARG(uap, name), retval);
792 break;
793
794 case DTYPE_KQUEUE:
795 error = EINVAL;
796 break;
797
798 default:
799 error = EOPNOTSUPP;
800 break;
801 }
802
803 FILE_UNUSE(fp, l);
804 return (error);
805 }
806
807 /*
808 * Allocate a file descriptor for the process.
809 */
810 int fdexpanded; /* XXX: what else uses this? */
811
812 int
813 fdalloc(struct proc *p, int want, int *result)
814 {
815 struct filedesc *fdp;
816 int i, lim, last, error;
817 u_int off, new;
818
819 fdp = p->p_fd;
820 simple_lock(&fdp->fd_slock);
821
822 /*
823 * Search for a free descriptor starting at the higher
824 * of want or fd_freefile. If that fails, consider
825 * expanding the ofile array.
826 */
827 lim = min((int)p->p_rlimit[RLIMIT_NOFILE].rlim_cur, maxfiles);
828 last = min(fdp->fd_nfiles, lim);
829 again:
830 if ((i = want) < fdp->fd_freefile)
831 i = fdp->fd_freefile;
832 off = i >> NDENTRYSHIFT;
833 new = find_next_zero(fdp->fd_himap, off,
834 (last + NDENTRIES - 1) >> NDENTRYSHIFT);
835 if (new != -1) {
836 i = find_next_zero(&fdp->fd_lomap[new],
837 new > off ? 0 : i & NDENTRYMASK, NDENTRIES);
838 if (i == -1) {
839 /*
840 * free file descriptor in this block was
841 * below want, try again with higher want.
842 */
843 want = (new + 1) << NDENTRYSHIFT;
844 goto again;
845 }
846 i += (new << NDENTRYSHIFT);
847 if (i < last) {
848 if (fdp->fd_ofiles[i] == NULL) {
849 fd_used(fdp, i);
850 if (want <= fdp->fd_freefile)
851 fdp->fd_freefile = i;
852 *result = i;
853 error = 0;
854 goto out;
855 }
856 }
857 }
858
859 /* No space in current array. Expand or let the caller do it. */
860 error = (fdp->fd_nfiles >= lim) ? EMFILE : ENOSPC;
861
862 out:
863 simple_unlock(&fdp->fd_slock);
864 return (error);
865 }
866
867 void
868 fdexpand(struct proc *p)
869 {
870 struct filedesc *fdp;
871 int i, numfiles, oldnfiles;
872 struct file **newofile;
873 char *newofileflags;
874 uint32_t *newhimap = NULL, *newlomap = NULL;
875
876 fdp = p->p_fd;
877
878 restart:
879 oldnfiles = fdp->fd_nfiles;
880
881 if (oldnfiles < NDEXTENT)
882 numfiles = NDEXTENT;
883 else
884 numfiles = 2 * oldnfiles;
885
886 newofile = malloc(numfiles * OFILESIZE, M_FILEDESC, M_WAITOK);
887 if (NDHISLOTS(numfiles) > NDHISLOTS(oldnfiles)) {
888 newhimap = malloc(NDHISLOTS(numfiles) * sizeof(uint32_t),
889 M_FILEDESC, M_WAITOK);
890 newlomap = malloc(NDLOSLOTS(numfiles) * sizeof(uint32_t),
891 M_FILEDESC, M_WAITOK);
892 }
893
894 simple_lock(&fdp->fd_slock);
895 /* lock fdp */
896 if (fdp->fd_nfiles != oldnfiles) {
897 /* fdp changed; retry */
898 simple_unlock(&fdp->fd_slock);
899 free(newofile, M_FILEDESC);
900 if (newhimap != NULL) free(newhimap, M_FILEDESC);
901 if (newlomap != NULL) free(newlomap, M_FILEDESC);
902 goto restart;
903 }
904
905 newofileflags = (char *) &newofile[numfiles];
906 /*
907 * Copy the existing ofile and ofileflags arrays
908 * and zero the new portion of each array.
909 */
910 memcpy(newofile, fdp->fd_ofiles,
911 (i = sizeof(struct file *) * fdp->fd_nfiles));
912 memset((char *)newofile + i, 0,
913 numfiles * sizeof(struct file *) - i);
914 memcpy(newofileflags, fdp->fd_ofileflags,
915 (i = sizeof(char) * fdp->fd_nfiles));
916 memset(newofileflags + i, 0, numfiles * sizeof(char) - i);
917 if (oldnfiles > NDFILE)
918 free(fdp->fd_ofiles, M_FILEDESC);
919
920 if (NDHISLOTS(numfiles) > NDHISLOTS(oldnfiles)) {
921 memcpy(newhimap, fdp->fd_himap,
922 (i = NDHISLOTS(oldnfiles) * sizeof(uint32_t)));
923 memset((char *)newhimap + i, 0,
924 NDHISLOTS(numfiles) * sizeof(uint32_t) - i);
925
926 memcpy(newlomap, fdp->fd_lomap,
927 (i = NDLOSLOTS(oldnfiles) * sizeof(uint32_t)));
928 memset((char *)newlomap + i, 0,
929 NDLOSLOTS(numfiles) * sizeof(uint32_t) - i);
930
931 if (NDHISLOTS(oldnfiles) > NDHISLOTS(NDFILE)) {
932 free(fdp->fd_himap, M_FILEDESC);
933 free(fdp->fd_lomap, M_FILEDESC);
934 }
935 fdp->fd_himap = newhimap;
936 fdp->fd_lomap = newlomap;
937 }
938
939 fdp->fd_ofiles = newofile;
940 fdp->fd_ofileflags = newofileflags;
941 fdp->fd_nfiles = numfiles;
942
943 simple_unlock(&fdp->fd_slock);
944
945 fdexpanded++;
946 }
947
948 /*
949 * Create a new open file structure and allocate
950 * a file descriptor for the process that refers to it.
951 */
952 int
953 falloc(struct lwp *l, struct file **resultfp, int *resultfd)
954 {
955 struct file *fp, *fq;
956 struct proc *p;
957 int error, i;
958
959 p = l->l_proc;
960
961 restart:
962 if ((error = fdalloc(p, 0, &i)) != 0) {
963 if (error == ENOSPC) {
964 fdexpand(p);
965 goto restart;
966 }
967 return (error);
968 }
969
970 fp = pool_get(&file_pool, PR_WAITOK);
971 simple_lock(&filelist_slock);
972 if (nfiles >= maxfiles) {
973 tablefull("file", "increase kern.maxfiles or MAXFILES");
974 simple_unlock(&filelist_slock);
975 simple_lock(&p->p_fd->fd_slock);
976 fd_unused(p->p_fd, i);
977 simple_unlock(&p->p_fd->fd_slock);
978 pool_put(&file_pool, fp);
979 return (ENFILE);
980 }
981 /*
982 * Allocate a new file descriptor.
983 * If the process has file descriptor zero open, add to the list
984 * of open files at that point, otherwise put it at the front of
985 * the list of open files.
986 */
987 nfiles++;
988 memset(fp, 0, sizeof(struct file));
989 fp->f_iflags = FIF_LARVAL;
990 if ((fq = p->p_fd->fd_ofiles[0]) != NULL) {
991 LIST_INSERT_AFTER(fq, fp, f_list);
992 } else {
993 LIST_INSERT_HEAD(&filehead, fp, f_list);
994 }
995 simple_unlock(&filelist_slock);
996 KDASSERT(p->p_fd->fd_ofiles[i] == NULL);
997 p->p_fd->fd_ofiles[i] = fp;
998 simple_lock_init(&fp->f_slock);
999 fp->f_count = 1;
1000 fp->f_cred = l->l_cred;
1001 kauth_cred_hold(fp->f_cred);
1002 if (resultfp) {
1003 fp->f_usecount = 1;
1004 *resultfp = fp;
1005 }
1006 if (resultfd)
1007 *resultfd = i;
1008 return (0);
1009 }
1010
1011 /*
1012 * Free a file descriptor.
1013 */
1014 void
1015 ffree(struct file *fp)
1016 {
1017
1018 #ifdef DIAGNOSTIC
1019 if (fp->f_usecount)
1020 panic("ffree");
1021 #endif
1022
1023 simple_lock(&filelist_slock);
1024 LIST_REMOVE(fp, f_list);
1025 kauth_cred_free(fp->f_cred);
1026 #ifdef DIAGNOSTIC
1027 fp->f_count = 0; /* What's the point? */
1028 #endif
1029 nfiles--;
1030 simple_unlock(&filelist_slock);
1031 pool_put(&file_pool, fp);
1032 }
1033
1034 /*
1035 * Create an initial cwdinfo structure, using the same current and root
1036 * directories as p.
1037 */
1038 struct cwdinfo *
1039 cwdinit(struct proc *p)
1040 {
1041 struct cwdinfo *cwdi;
1042
1043 cwdi = pool_get(&cwdi_pool, PR_WAITOK);
1044
1045 simple_lock_init(&cwdi->cwdi_slock);
1046 cwdi->cwdi_cdir = p->p_cwdi->cwdi_cdir;
1047 if (cwdi->cwdi_cdir)
1048 VREF(cwdi->cwdi_cdir);
1049 cwdi->cwdi_rdir = p->p_cwdi->cwdi_rdir;
1050 if (cwdi->cwdi_rdir)
1051 VREF(cwdi->cwdi_rdir);
1052 cwdi->cwdi_cmask = p->p_cwdi->cwdi_cmask;
1053 cwdi->cwdi_refcnt = 1;
1054
1055 return (cwdi);
1056 }
1057
1058 /*
1059 * Make p2 share p1's cwdinfo.
1060 */
1061 void
1062 cwdshare(struct proc *p1, struct proc *p2)
1063 {
1064 struct cwdinfo *cwdi = p1->p_cwdi;
1065
1066 simple_lock(&cwdi->cwdi_slock);
1067 cwdi->cwdi_refcnt++;
1068 simple_unlock(&cwdi->cwdi_slock);
1069 p2->p_cwdi = cwdi;
1070 }
1071
1072 /*
1073 * Make this process not share its cwdinfo structure, maintaining
1074 * all cwdinfo state.
1075 */
1076 void
1077 cwdunshare(struct proc *p)
1078 {
1079 struct cwdinfo *oldcwdi, *newcwdi;
1080
1081 if (p->p_cwdi->cwdi_refcnt == 1)
1082 return;
1083
1084 newcwdi = cwdinit(p);
1085 oldcwdi = p->p_cwdi;
1086 p->p_cwdi = newcwdi;
1087 cwdfree(oldcwdi);
1088 }
1089
1090 /*
1091 * Release a cwdinfo structure.
1092 */
1093 void
1094 cwdfree(struct cwdinfo *cwdi)
1095 {
1096 int n;
1097
1098 simple_lock(&cwdi->cwdi_slock);
1099 n = --cwdi->cwdi_refcnt;
1100 simple_unlock(&cwdi->cwdi_slock);
1101 if (n > 0)
1102 return;
1103
1104 vrele(cwdi->cwdi_cdir);
1105 if (cwdi->cwdi_rdir)
1106 vrele(cwdi->cwdi_rdir);
1107 pool_put(&cwdi_pool, cwdi);
1108 }
1109
1110 /*
1111 * Create an initial filedesc structure, using the same current and root
1112 * directories as p.
1113 */
1114 struct filedesc *
1115 fdinit(struct proc *p)
1116 {
1117 struct filedesc0 *newfdp;
1118
1119 newfdp = pool_get(&filedesc0_pool, PR_WAITOK);
1120 memset(newfdp, 0, sizeof(struct filedesc0));
1121
1122 fdinit1(newfdp);
1123
1124 return (&newfdp->fd_fd);
1125 }
1126
1127 /*
1128 * Initialize a file descriptor table.
1129 */
1130 void
1131 fdinit1(struct filedesc0 *newfdp)
1132 {
1133
1134 newfdp->fd_fd.fd_refcnt = 1;
1135 newfdp->fd_fd.fd_ofiles = newfdp->fd_dfiles;
1136 newfdp->fd_fd.fd_ofileflags = newfdp->fd_dfileflags;
1137 newfdp->fd_fd.fd_nfiles = NDFILE;
1138 newfdp->fd_fd.fd_knlistsize = -1;
1139 newfdp->fd_fd.fd_himap = newfdp->fd_dhimap;
1140 newfdp->fd_fd.fd_lomap = newfdp->fd_dlomap;
1141 newfdp->fd_fd.fd_lastfile = -1;
1142 simple_lock_init(&newfdp->fd_fd.fd_slock);
1143 }
1144
1145 /*
1146 * Make p2 share p1's filedesc structure.
1147 */
1148 void
1149 fdshare(struct proc *p1, struct proc *p2)
1150 {
1151 struct filedesc *fdp = p1->p_fd;
1152
1153 simple_lock(&fdp->fd_slock);
1154 p2->p_fd = fdp;
1155 fdp->fd_refcnt++;
1156 simple_unlock(&fdp->fd_slock);
1157 }
1158
1159 /*
1160 * Make this process not share its filedesc structure, maintaining
1161 * all file descriptor state.
1162 */
1163 void
1164 fdunshare(struct lwp *l)
1165 {
1166 struct proc *p = l->l_proc;
1167 struct filedesc *newfd;
1168
1169 if (p->p_fd->fd_refcnt == 1)
1170 return;
1171
1172 newfd = fdcopy(p);
1173 fdfree(l);
1174 p->p_fd = newfd;
1175 }
1176
1177 /*
1178 * Clear a process's fd table.
1179 */
1180 void
1181 fdclear(struct lwp *l)
1182 {
1183 struct proc *p = l->l_proc;
1184 struct filedesc *newfd;
1185
1186 newfd = fdinit(p);
1187 fdfree(l);
1188 p->p_fd = newfd;
1189 }
1190
1191 /*
1192 * Copy a filedesc structure.
1193 */
1194 struct filedesc *
1195 fdcopy(struct proc *p)
1196 {
1197 struct filedesc *newfdp, *fdp;
1198 struct file **fpp, **nfpp;
1199 int i, numfiles, lastfile;
1200
1201 fdp = p->p_fd;
1202 newfdp = pool_get(&filedesc0_pool, PR_WAITOK);
1203 newfdp->fd_refcnt = 1;
1204 simple_lock_init(&newfdp->fd_slock);
1205
1206 restart:
1207 numfiles = fdp->fd_nfiles;
1208 lastfile = fdp->fd_lastfile;
1209
1210 /*
1211 * If the number of open files fits in the internal arrays
1212 * of the open file structure, use them, otherwise allocate
1213 * additional memory for the number of descriptors currently
1214 * in use.
1215 */
1216 if (lastfile < NDFILE) {
1217 i = NDFILE;
1218 } else {
1219 /*
1220 * Compute the smallest multiple of NDEXTENT needed
1221 * for the file descriptors currently in use,
1222 * allowing the table to shrink.
1223 */
1224 i = numfiles;
1225 while (i >= 2 * NDEXTENT && i > lastfile * 2)
1226 i /= 2;
1227 newfdp->fd_ofiles = malloc(i * OFILESIZE, M_FILEDESC, M_WAITOK);
1228 }
1229 if (NDHISLOTS(i) > NDHISLOTS(NDFILE)) {
1230 newfdp->fd_himap = malloc(NDHISLOTS(i) * sizeof(uint32_t),
1231 M_FILEDESC, M_WAITOK);
1232 newfdp->fd_lomap = malloc(NDLOSLOTS(i) * sizeof(uint32_t),
1233 M_FILEDESC, M_WAITOK);
1234 }
1235
1236 simple_lock(&fdp->fd_slock);
1237 if (numfiles != fdp->fd_nfiles || lastfile != fdp->fd_lastfile) {
1238 simple_unlock(&fdp->fd_slock);
1239 if (i > NDFILE)
1240 free(newfdp->fd_ofiles, M_FILEDESC);
1241 if (NDHISLOTS(i) > NDHISLOTS(NDFILE)) {
1242 free(newfdp->fd_himap, M_FILEDESC);
1243 free(newfdp->fd_lomap, M_FILEDESC);
1244 }
1245 goto restart;
1246 }
1247
1248 if (lastfile < NDFILE) {
1249 newfdp->fd_ofiles = ((struct filedesc0 *) newfdp)->fd_dfiles;
1250 newfdp->fd_ofileflags =
1251 ((struct filedesc0 *) newfdp)->fd_dfileflags;
1252 } else {
1253 newfdp->fd_ofileflags = (char *) &newfdp->fd_ofiles[i];
1254 }
1255 if (NDHISLOTS(i) <= NDHISLOTS(NDFILE)) {
1256 newfdp->fd_himap =
1257 ((struct filedesc0 *) newfdp)->fd_dhimap;
1258 newfdp->fd_lomap =
1259 ((struct filedesc0 *) newfdp)->fd_dlomap;
1260 }
1261
1262 newfdp->fd_nfiles = i;
1263 newfdp->fd_lastfile = lastfile;
1264 newfdp->fd_freefile = fdp->fd_freefile;
1265
1266 /* Clear the entries that will not be copied over.
1267 * Avoid calling memset with 0 size (i.e. when
1268 * lastfile == i-1 */
1269 if (lastfile < (i-1))
1270 memset(newfdp->fd_ofiles + lastfile + 1, 0,
1271 (i - lastfile - 1) * sizeof(struct file **));
1272 memcpy(newfdp->fd_ofileflags, fdp->fd_ofileflags, i * sizeof(char));
1273 if (i < NDENTRIES * NDENTRIES)
1274 i = NDENTRIES * NDENTRIES; /* size of inlined bitmaps */
1275 memcpy(newfdp->fd_himap, fdp->fd_himap, NDHISLOTS(i)*sizeof(uint32_t));
1276 memcpy(newfdp->fd_lomap, fdp->fd_lomap, NDLOSLOTS(i)*sizeof(uint32_t));
1277
1278 fpp = fdp->fd_ofiles;
1279 nfpp = newfdp->fd_ofiles;
1280 for (i = 0; i <= lastfile; i++, fpp++, nfpp++) {
1281 if ((*nfpp = *fpp) == NULL)
1282 continue;
1283
1284 if ((*fpp)->f_type == DTYPE_KQUEUE)
1285 /* kq descriptors cannot be copied. */
1286 fdremove(newfdp, i);
1287 else {
1288 simple_lock(&(*fpp)->f_slock);
1289 (*fpp)->f_count++;
1290 simple_unlock(&(*fpp)->f_slock);
1291 }
1292 }
1293
1294 simple_unlock(&fdp->fd_slock);
1295
1296 newfdp->fd_knlist = NULL;
1297 newfdp->fd_knlistsize = -1;
1298 newfdp->fd_knhash = NULL;
1299 newfdp->fd_knhashmask = 0;
1300
1301 return (newfdp);
1302 }
1303
1304 /*
1305 * Release a filedesc structure.
1306 */
1307 void
1308 fdfree(struct lwp *l)
1309 {
1310 struct proc *p = l->l_proc;
1311 struct filedesc *fdp;
1312 struct file **fpp, *fp;
1313 int i;
1314
1315 fdp = p->p_fd;
1316 simple_lock(&fdp->fd_slock);
1317 i = --fdp->fd_refcnt;
1318 simple_unlock(&fdp->fd_slock);
1319 if (i > 0)
1320 return;
1321
1322 fpp = fdp->fd_ofiles;
1323 for (i = fdp->fd_lastfile; i >= 0; i--, fpp++) {
1324 fp = *fpp;
1325 if (fp != NULL) {
1326 *fpp = NULL;
1327 simple_lock(&fp->f_slock);
1328 FILE_USE(fp);
1329 if ((fdp->fd_lastfile - i) < fdp->fd_knlistsize)
1330 knote_fdclose(l, fdp->fd_lastfile - i);
1331 (void) closef(fp, l);
1332 }
1333 }
1334 p->p_fd = NULL;
1335 if (fdp->fd_nfiles > NDFILE)
1336 free(fdp->fd_ofiles, M_FILEDESC);
1337 if (NDHISLOTS(fdp->fd_nfiles) > NDHISLOTS(NDFILE)) {
1338 free(fdp->fd_himap, M_FILEDESC);
1339 free(fdp->fd_lomap, M_FILEDESC);
1340 }
1341 if (fdp->fd_knlist)
1342 free(fdp->fd_knlist, M_KEVENT);
1343 if (fdp->fd_knhash)
1344 hashdone(fdp->fd_knhash, M_KEVENT);
1345 pool_put(&filedesc0_pool, fdp);
1346 }
1347
1348 /*
1349 * Internal form of close.
1350 * Decrement reference count on file structure.
1351 * Note: p may be NULL when closing a file
1352 * that was being passed in a message.
1353 *
1354 * Note: we expect the caller is holding a usecount, and expects us
1355 * to drop it (the caller thinks the file is going away forever).
1356 */
1357 int
1358 closef(struct file *fp, struct lwp *l)
1359 {
1360 struct proc *p = l ? l->l_proc : NULL;
1361 struct vnode *vp;
1362 struct flock lf;
1363 int error;
1364
1365 if (fp == NULL)
1366 return (0);
1367
1368 /*
1369 * POSIX record locking dictates that any close releases ALL
1370 * locks owned by this process. This is handled by setting
1371 * a flag in the unlock to free ONLY locks obeying POSIX
1372 * semantics, and not to free BSD-style file locks.
1373 * If the descriptor was in a message, POSIX-style locks
1374 * aren't passed with the descriptor.
1375 */
1376 if (p && (p->p_flag & P_ADVLOCK) && fp->f_type == DTYPE_VNODE) {
1377 lf.l_whence = SEEK_SET;
1378 lf.l_start = 0;
1379 lf.l_len = 0;
1380 lf.l_type = F_UNLCK;
1381 vp = (struct vnode *)fp->f_data;
1382 (void) VOP_ADVLOCK(vp, p, F_UNLCK, &lf, F_POSIX);
1383 }
1384
1385 /*
1386 * If WANTCLOSE is set, then the reference count on the file
1387 * is 0, but there were multiple users of the file. This can
1388 * happen if a filedesc structure is shared by multiple
1389 * processes.
1390 */
1391 simple_lock(&fp->f_slock);
1392 if (fp->f_iflags & FIF_WANTCLOSE) {
1393 /*
1394 * Another user of the file is already closing, and is
1395 * simply waiting for other users of the file to drain.
1396 * Release our usecount, and wake up the closer if it
1397 * is the only remaining use.
1398 */
1399 #ifdef DIAGNOSTIC
1400 if (fp->f_count != 0)
1401 panic("closef: wantclose and count != 0");
1402 if (fp->f_usecount < 2)
1403 panic("closef: wantclose and usecount < 2");
1404 #endif
1405 if (--fp->f_usecount == 1)
1406 wakeup(&fp->f_usecount);
1407 simple_unlock(&fp->f_slock);
1408 return (0);
1409 } else {
1410 /*
1411 * Decrement the reference count. If we were not the
1412 * last reference, then release our use and just
1413 * return.
1414 */
1415 if (--fp->f_count > 0) {
1416 #ifdef DIAGNOSTIC
1417 if (fp->f_usecount < 1)
1418 panic("closef: no wantclose and usecount < 1");
1419 #endif
1420 fp->f_usecount--;
1421 simple_unlock(&fp->f_slock);
1422 return (0);
1423 }
1424 }
1425
1426 /*
1427 * The reference count is now 0. However, there may be
1428 * multiple potential users of this file. This can happen
1429 * if multiple processes shared a single filedesc structure.
1430 *
1431 * Notify these potential users that the file is closing.
1432 * This will prevent them from adding additional uses to
1433 * the file.
1434 */
1435 fp->f_iflags |= FIF_WANTCLOSE;
1436
1437 /*
1438 * We expect the caller to add a use to the file. So, if we
1439 * are the last user, usecount will be 1. If it is not, we
1440 * must wait for the usecount to drain. When it drains back
1441 * to 1, we will be awakened so that we may proceed with the
1442 * close.
1443 */
1444 #ifdef DIAGNOSTIC
1445 if (fp->f_usecount < 1)
1446 panic("closef: usecount < 1");
1447 #endif
1448 while (fp->f_usecount > 1)
1449 (void) ltsleep(&fp->f_usecount, PRIBIO, "closef", 0,
1450 &fp->f_slock);
1451 #ifdef DIAGNOSTIC
1452 if (fp->f_usecount != 1)
1453 panic("closef: usecount != 1");
1454 #endif
1455
1456 simple_unlock(&fp->f_slock);
1457 if ((fp->f_flag & FHASLOCK) && fp->f_type == DTYPE_VNODE) {
1458 lf.l_whence = SEEK_SET;
1459 lf.l_start = 0;
1460 lf.l_len = 0;
1461 lf.l_type = F_UNLCK;
1462 vp = (struct vnode *)fp->f_data;
1463 (void) VOP_ADVLOCK(vp, fp, F_UNLCK, &lf, F_FLOCK);
1464 }
1465 if (fp->f_ops)
1466 error = (*fp->f_ops->fo_close)(fp, l);
1467 else
1468 error = 0;
1469
1470 /* Nothing references the file now, drop the final use (us). */
1471 fp->f_usecount--;
1472
1473 ffree(fp);
1474 return (error);
1475 }
1476
1477 /*
1478 * Apply an advisory lock on a file descriptor.
1479 *
1480 * Just attempt to get a record lock of the requested type on
1481 * the entire file (l_whence = SEEK_SET, l_start = 0, l_len = 0).
1482 */
1483 /* ARGSUSED */
1484 int
1485 sys_flock(struct lwp *l, void *v, register_t *retval)
1486 {
1487 struct sys_flock_args /* {
1488 syscallarg(int) fd;
1489 syscallarg(int) how;
1490 } */ *uap = v;
1491 int fd, how, error;
1492 struct proc *p;
1493 struct filedesc *fdp;
1494 struct file *fp;
1495 struct vnode *vp;
1496 struct flock lf;
1497
1498 p = l->l_proc;
1499 fd = SCARG(uap, fd);
1500 how = SCARG(uap, how);
1501 fdp = p->p_fd;
1502 error = 0;
1503
1504 if ((fp = fd_getfile(fdp, fd)) == NULL)
1505 return (EBADF);
1506
1507 FILE_USE(fp);
1508
1509 if (fp->f_type != DTYPE_VNODE) {
1510 error = EOPNOTSUPP;
1511 goto out;
1512 }
1513
1514 vp = (struct vnode *)fp->f_data;
1515 lf.l_whence = SEEK_SET;
1516 lf.l_start = 0;
1517 lf.l_len = 0;
1518 if (how & LOCK_UN) {
1519 lf.l_type = F_UNLCK;
1520 fp->f_flag &= ~FHASLOCK;
1521 error = VOP_ADVLOCK(vp, fp, F_UNLCK, &lf, F_FLOCK);
1522 goto out;
1523 }
1524 if (how & LOCK_EX)
1525 lf.l_type = F_WRLCK;
1526 else if (how & LOCK_SH)
1527 lf.l_type = F_RDLCK;
1528 else {
1529 error = EINVAL;
1530 goto out;
1531 }
1532 fp->f_flag |= FHASLOCK;
1533 if (how & LOCK_NB)
1534 error = VOP_ADVLOCK(vp, fp, F_SETLK, &lf, F_FLOCK);
1535 else
1536 error = VOP_ADVLOCK(vp, fp, F_SETLK, &lf,
1537 F_FLOCK|F_WAIT);
1538 out:
1539 FILE_UNUSE(fp, l);
1540 return (error);
1541 }
1542
1543 /* ARGSUSED */
1544 int
1545 sys_posix_fadvise(struct lwp *l, void *v, register_t *retval)
1546 {
1547 const struct sys_posix_fadvise_args /* {
1548 syscallarg(int) fd;
1549 syscallarg(off_t) offset;
1550 syscallarg(off_t) len;
1551 syscallarg(int) advice;
1552 } */ *uap = v;
1553 const int fd = SCARG(uap, fd);
1554 const int advice = SCARG(uap, advice);
1555 struct proc *p = l->l_proc;
1556 struct file *fp;
1557 int error = 0;
1558
1559 fp = fd_getfile(p->p_fd, fd);
1560 if (fp == NULL) {
1561 error = EBADF;
1562 goto out;
1563 }
1564 FILE_USE(fp);
1565
1566 if (fp->f_type != DTYPE_VNODE) {
1567 if (fp->f_type == DTYPE_PIPE || fp->f_type == DTYPE_SOCKET) {
1568 error = ESPIPE;
1569 } else {
1570 error = EOPNOTSUPP;
1571 }
1572 goto out;
1573 }
1574
1575 switch (advice) {
1576 case POSIX_FADV_NORMAL:
1577 case POSIX_FADV_RANDOM:
1578 case POSIX_FADV_SEQUENTIAL:
1579 KASSERT(POSIX_FADV_NORMAL == UVM_ADV_NORMAL);
1580 KASSERT(POSIX_FADV_RANDOM == UVM_ADV_RANDOM);
1581 KASSERT(POSIX_FADV_SEQUENTIAL == UVM_ADV_SEQUENTIAL);
1582
1583 /*
1584 * we ignore offset and size.
1585 */
1586
1587 fp->f_advice = advice;
1588 break;
1589
1590 case POSIX_FADV_WILLNEED:
1591 case POSIX_FADV_DONTNEED:
1592 case POSIX_FADV_NOREUSE:
1593
1594 /*
1595 * not implemented yet.
1596 */
1597
1598 break;
1599 default:
1600 error = EINVAL;
1601 break;
1602 }
1603 out:
1604 if (fp != NULL) {
1605 FILE_UNUSE(fp, l);
1606 }
1607 *retval = error;
1608 return 0;
1609 }
1610
1611 /*
1612 * File Descriptor pseudo-device driver (/dev/fd/).
1613 *
1614 * Opening minor device N dup()s the file (if any) connected to file
1615 * descriptor N belonging to the calling process. Note that this driver
1616 * consists of only the ``open()'' routine, because all subsequent
1617 * references to this file will be direct to the other driver.
1618 */
1619 /* ARGSUSED */
1620 static int
1621 filedescopen(dev_t dev, int mode, int type, struct lwp *l)
1622 {
1623
1624 /*
1625 * XXX Kludge: set dupfd to contain the value of the
1626 * the file descriptor being sought for duplication. The error
1627 * return ensures that the vnode for this device will be released
1628 * by vn_open. Open will detect this special error and take the
1629 * actions in dupfdopen below. Other callers of vn_open or VOP_OPEN
1630 * will simply report the error.
1631 */
1632 l->l_dupfd = minor(dev); /* XXX */
1633 return EDUPFD;
1634 }
1635
1636 const struct cdevsw filedesc_cdevsw = {
1637 filedescopen, noclose, noread, nowrite, noioctl,
1638 nostop, notty, nopoll, nommap, nokqfilter, D_OTHER,
1639 };
1640
1641 /*
1642 * Duplicate the specified descriptor to a free descriptor.
1643 *
1644 * 'indx' has been fdalloc'ed (and will be fdremove'ed on error) by the caller.
1645 */
1646 int
1647 dupfdopen(struct lwp *l, int indx, int dfd, int mode, int error)
1648 {
1649 struct proc *p = l->l_proc;
1650 struct filedesc *fdp;
1651 struct file *wfp;
1652
1653 fdp = p->p_fd;
1654
1655 /* should be cleared by the caller */
1656 KASSERT(fdp->fd_ofiles[indx] == NULL);
1657
1658 /*
1659 * If the to-be-dup'd fd number is greater than the allowed number
1660 * of file descriptors, or the fd to be dup'd has already been
1661 * closed, reject.
1662 */
1663
1664 /*
1665 * Note, in the case of indx == dfd, fd_getfile below returns NULL.
1666 */
1667 if ((wfp = fd_getfile(fdp, dfd)) == NULL)
1668 return (EBADF);
1669
1670 FILE_USE(wfp);
1671
1672 /*
1673 * There are two cases of interest here.
1674 *
1675 * For EDUPFD simply dup (dfd) to file descriptor
1676 * (indx) and return.
1677 *
1678 * For EMOVEFD steal away the file structure from (dfd) and
1679 * store it in (indx). (dfd) is effectively closed by
1680 * this operation.
1681 *
1682 * Any other error code is just returned.
1683 */
1684 switch (error) {
1685 case EDUPFD:
1686 /*
1687 * Check that the mode the file is being opened for is a
1688 * subset of the mode of the existing descriptor.
1689 */
1690 if (((mode & (FREAD|FWRITE)) | wfp->f_flag) != wfp->f_flag) {
1691 FILE_UNUSE(wfp, l);
1692 return (EACCES);
1693 }
1694 simple_lock(&fdp->fd_slock);
1695 fdp->fd_ofiles[indx] = wfp;
1696 fdp->fd_ofileflags[indx] = fdp->fd_ofileflags[dfd];
1697 simple_unlock(&fdp->fd_slock);
1698 simple_lock(&wfp->f_slock);
1699 wfp->f_count++;
1700 /* 'indx' has been fd_used'ed by caller */
1701 FILE_UNUSE_HAVELOCK(wfp, l);
1702 return (0);
1703
1704 case EMOVEFD:
1705 /*
1706 * Steal away the file pointer from dfd, and stuff it into indx.
1707 */
1708 simple_lock(&fdp->fd_slock);
1709 fdp->fd_ofiles[indx] = fdp->fd_ofiles[dfd];
1710 fdp->fd_ofileflags[indx] = fdp->fd_ofileflags[dfd];
1711 fdp->fd_ofiles[dfd] = NULL;
1712 fdp->fd_ofileflags[dfd] = 0;
1713 /*
1714 * Complete the clean up of the filedesc structure by
1715 * recomputing the various hints.
1716 */
1717 /* 'indx' has been fd_used'ed by caller */
1718 fd_unused(fdp, dfd);
1719 simple_unlock(&fdp->fd_slock);
1720 FILE_UNUSE(wfp, l);
1721 return (0);
1722
1723 default:
1724 FILE_UNUSE(wfp, l);
1725 return (error);
1726 }
1727 /* NOTREACHED */
1728 }
1729
1730 /*
1731 * Close any files on exec?
1732 */
1733 void
1734 fdcloseexec(struct lwp *l)
1735 {
1736 struct proc *p = l->l_proc;
1737 struct filedesc *fdp;
1738 int fd;
1739
1740 fdunshare(l);
1741 cwdunshare(p);
1742
1743 fdp = p->p_fd;
1744 for (fd = 0; fd <= fdp->fd_lastfile; fd++)
1745 if (fdp->fd_ofileflags[fd] & UF_EXCLOSE)
1746 (void) fdrelease(l, fd);
1747 }
1748
1749 /*
1750 * It is unsafe for set[ug]id processes to be started with file
1751 * descriptors 0..2 closed, as these descriptors are given implicit
1752 * significance in the Standard C library. fdcheckstd() will create a
1753 * descriptor referencing /dev/null for each of stdin, stdout, and
1754 * stderr that is not already open.
1755 */
1756 #define CHECK_UPTO 3
1757 int
1758 fdcheckstd(l)
1759 struct lwp *l;
1760 {
1761 struct proc *p;
1762 struct nameidata nd;
1763 struct filedesc *fdp;
1764 struct file *fp;
1765 struct file *devnullfp = NULL; /* Quell compiler warning */
1766 struct proc *pp;
1767 register_t retval;
1768 int fd, i, error, flags = FREAD|FWRITE, devnull = -1;
1769 char closed[CHECK_UPTO * 3 + 1], which[3 + 1];
1770
1771 p = l->l_proc;
1772 closed[0] = '\0';
1773 if ((fdp = p->p_fd) == NULL)
1774 return (0);
1775 for (i = 0; i < CHECK_UPTO; i++) {
1776 if (fdp->fd_ofiles[i] != NULL)
1777 continue;
1778 snprintf(which, sizeof(which), ",%d", i);
1779 strlcat(closed, which, sizeof(closed));
1780 if (devnullfp == NULL) {
1781 if ((error = falloc(l, &fp, &fd)) != 0)
1782 return (error);
1783 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, "/dev/null",
1784 l);
1785 if ((error = vn_open(&nd, flags, 0)) != 0) {
1786 FILE_UNUSE(fp, l);
1787 ffree(fp);
1788 fdremove(p->p_fd, fd);
1789 return (error);
1790 }
1791 fp->f_data = nd.ni_vp;
1792 fp->f_flag = flags;
1793 fp->f_ops = &vnops;
1794 fp->f_type = DTYPE_VNODE;
1795 VOP_UNLOCK(nd.ni_vp, 0);
1796 devnull = fd;
1797 devnullfp = fp;
1798 FILE_SET_MATURE(fp);
1799 } else {
1800 restart:
1801 if ((error = fdalloc(p, 0, &fd)) != 0) {
1802 if (error == ENOSPC) {
1803 fdexpand(p);
1804 goto restart;
1805 }
1806 return (error);
1807 }
1808
1809 simple_lock(&devnullfp->f_slock);
1810 FILE_USE(devnullfp);
1811 /* finishdup() will unuse the descriptors for us */
1812 if ((error = finishdup(l, devnull, fd, &retval)) != 0)
1813 return (error);
1814 }
1815 }
1816 if (devnullfp)
1817 FILE_UNUSE(devnullfp, l);
1818 if (closed[0] != '\0') {
1819 rw_enter(&proclist_lock, RW_READER);
1820 pp = p->p_pptr;
1821 mutex_enter(&pp->p_mutex);
1822 log(LOG_WARNING, "set{u,g}id pid %d (%s) "
1823 "was invoked by uid %d ppid %d (%s) "
1824 "with fd %s closed\n",
1825 p->p_pid, p->p_comm, kauth_cred_geteuid(pp->p_cred),
1826 pp->p_pid, pp->p_comm, &closed[1]);
1827 mutex_exit(&pp->p_mutex);
1828 rw_exit(&proclist_lock);
1829 }
1830 return (0);
1831 }
1832 #undef CHECK_UPTO
1833
1834 /*
1835 * Sets descriptor owner. If the owner is a process, 'pgid'
1836 * is set to positive value, process ID. If the owner is process group,
1837 * 'pgid' is set to -pg_id.
1838 */
1839 int
1840 fsetown(struct proc *p, pid_t *pgid, int cmd, const void *data)
1841 {
1842 int id = *(const int *)data;
1843 int error;
1844
1845 switch (cmd) {
1846 case TIOCSPGRP:
1847 if (id < 0)
1848 return (EINVAL);
1849 id = -id;
1850 break;
1851 default:
1852 break;
1853 }
1854
1855 if (id > 0 && !pfind(id))
1856 return (ESRCH);
1857 else if (id < 0 && (error = pgid_in_session(p, -id)))
1858 return (error);
1859
1860 *pgid = id;
1861 return (0);
1862 }
1863
1864 /*
1865 * Return descriptor owner information. If the value is positive,
1866 * it's process ID. If it's negative, it's process group ID and
1867 * needs the sign removed before use.
1868 */
1869 int
1870 fgetown(struct proc *p, pid_t pgid, int cmd, void *data)
1871 {
1872 switch (cmd) {
1873 case TIOCGPGRP:
1874 *(int *)data = -pgid;
1875 break;
1876 default:
1877 *(int *)data = pgid;
1878 break;
1879 }
1880 return (0);
1881 }
1882
1883 /*
1884 * Send signal to descriptor owner, either process or process group.
1885 */
1886 void
1887 fownsignal(pid_t pgid, int signo, int code, int band, void *fdescdata)
1888 {
1889 struct proc *p1;
1890 struct pgrp *pgrp;
1891 ksiginfo_t ksi;
1892
1893 KSI_INIT(&ksi);
1894 ksi.ksi_signo = signo;
1895 ksi.ksi_code = code;
1896 ksi.ksi_band = band;
1897
1898 /*
1899 * Since we may be called from an interrupt context, we must use
1900 * the proclist_mutex.
1901 */
1902 mutex_enter(&proclist_mutex);
1903 if (pgid > 0 && (p1 = p_find(pgid, PFIND_LOCKED)))
1904 kpsignal(p1, &ksi, fdescdata);
1905 else if (pgid < 0 && (pgrp = pg_find(-pgid, PFIND_LOCKED)))
1906 kpgsignal(pgrp, &ksi, fdescdata, 0);
1907 mutex_exit(&proclist_mutex);
1908 }
1909
1910 int
1911 fdclone(struct lwp *l, struct file *fp, int fd, int flag,
1912 const struct fileops *fops, void *data)
1913 {
1914 fp->f_flag = flag;
1915 fp->f_type = DTYPE_MISC;
1916 fp->f_ops = fops;
1917 fp->f_data = data;
1918
1919 l->l_dupfd = fd;
1920
1921 FILE_SET_MATURE(fp);
1922 FILE_UNUSE(fp, l);
1923 return EMOVEFD;
1924 }
1925
1926 /* ARGSUSED */
1927 int
1928 fnullop_fcntl(struct file *fp, u_int cmd, void *data, struct lwp *l)
1929 {
1930
1931 if (cmd == F_SETFL)
1932 return 0;
1933
1934 return EOPNOTSUPP;
1935 }
1936
1937 /* ARGSUSED */
1938 int
1939 fnullop_poll(struct file *fp, int which, struct lwp *l)
1940 {
1941
1942 return 0;
1943 }
1944
1945
1946 /* ARGSUSED */
1947 int
1948 fnullop_kqfilter(struct file *fp, struct knote *kn)
1949 {
1950
1951 return 0;
1952 }
1953
1954 /* ARGSUSED */
1955 int
1956 fbadop_stat(struct file *fp, struct stat *sb, struct lwp *l)
1957 {
1958
1959 return EOPNOTSUPP;
1960 }
1961