kern_descrip.c revision 1.140.4.1 1 /* $NetBSD: kern_descrip.c,v 1.140.4.1 2006/04/22 11:39:58 simonb 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.140.4.1 2006/04/22 11:39:58 simonb 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
63 #include <sys/mount.h>
64 #include <sys/sa.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 proc *p, struct file **resultfp, int *resultfd)
954 {
955 struct file *fp, *fq;
956 int error, i;
957
958 restart:
959 if ((error = fdalloc(p, 0, &i)) != 0) {
960 if (error == ENOSPC) {
961 fdexpand(p);
962 goto restart;
963 }
964 return (error);
965 }
966
967 fp = pool_get(&file_pool, PR_WAITOK);
968 simple_lock(&filelist_slock);
969 if (nfiles >= maxfiles) {
970 tablefull("file", "increase kern.maxfiles or MAXFILES");
971 simple_unlock(&filelist_slock);
972 simple_lock(&p->p_fd->fd_slock);
973 fd_unused(p->p_fd, i);
974 simple_unlock(&p->p_fd->fd_slock);
975 pool_put(&file_pool, fp);
976 return (ENFILE);
977 }
978 /*
979 * Allocate a new file descriptor.
980 * If the process has file descriptor zero open, add to the list
981 * of open files at that point, otherwise put it at the front of
982 * the list of open files.
983 */
984 nfiles++;
985 memset(fp, 0, sizeof(struct file));
986 fp->f_iflags = FIF_LARVAL;
987 if ((fq = p->p_fd->fd_ofiles[0]) != NULL) {
988 LIST_INSERT_AFTER(fq, fp, f_list);
989 } else {
990 LIST_INSERT_HEAD(&filehead, fp, f_list);
991 }
992 simple_unlock(&filelist_slock);
993 KDASSERT(p->p_fd->fd_ofiles[i] == NULL);
994 p->p_fd->fd_ofiles[i] = fp;
995 simple_lock_init(&fp->f_slock);
996 fp->f_count = 1;
997 fp->f_cred = p->p_ucred;
998 crhold(fp->f_cred);
999 if (resultfp) {
1000 fp->f_usecount = 1;
1001 *resultfp = fp;
1002 }
1003 if (resultfd)
1004 *resultfd = i;
1005 return (0);
1006 }
1007
1008 /*
1009 * Free a file descriptor.
1010 */
1011 void
1012 ffree(struct file *fp)
1013 {
1014
1015 #ifdef DIAGNOSTIC
1016 if (fp->f_usecount)
1017 panic("ffree");
1018 #endif
1019
1020 simple_lock(&filelist_slock);
1021 LIST_REMOVE(fp, f_list);
1022 crfree(fp->f_cred);
1023 #ifdef DIAGNOSTIC
1024 fp->f_count = 0; /* What's the point? */
1025 #endif
1026 nfiles--;
1027 simple_unlock(&filelist_slock);
1028 pool_put(&file_pool, fp);
1029 }
1030
1031 /*
1032 * Create an initial cwdinfo structure, using the same current and root
1033 * directories as p.
1034 */
1035 struct cwdinfo *
1036 cwdinit(struct proc *p)
1037 {
1038 struct cwdinfo *cwdi;
1039
1040 cwdi = pool_get(&cwdi_pool, PR_WAITOK);
1041
1042 simple_lock_init(&cwdi->cwdi_slock);
1043 cwdi->cwdi_cdir = p->p_cwdi->cwdi_cdir;
1044 if (cwdi->cwdi_cdir)
1045 VREF(cwdi->cwdi_cdir);
1046 cwdi->cwdi_rdir = p->p_cwdi->cwdi_rdir;
1047 if (cwdi->cwdi_rdir)
1048 VREF(cwdi->cwdi_rdir);
1049 cwdi->cwdi_cmask = p->p_cwdi->cwdi_cmask;
1050 cwdi->cwdi_refcnt = 1;
1051
1052 return (cwdi);
1053 }
1054
1055 /*
1056 * Make p2 share p1's cwdinfo.
1057 */
1058 void
1059 cwdshare(struct proc *p1, struct proc *p2)
1060 {
1061 struct cwdinfo *cwdi = p1->p_cwdi;
1062
1063 simple_lock(&cwdi->cwdi_slock);
1064 cwdi->cwdi_refcnt++;
1065 simple_unlock(&cwdi->cwdi_slock);
1066 p2->p_cwdi = cwdi;
1067 }
1068
1069 /*
1070 * Make this process not share its cwdinfo structure, maintaining
1071 * all cwdinfo state.
1072 */
1073 void
1074 cwdunshare(struct proc *p)
1075 {
1076 struct cwdinfo *oldcwdi, *newcwdi;
1077
1078 if (p->p_cwdi->cwdi_refcnt == 1)
1079 return;
1080
1081 newcwdi = cwdinit(p);
1082 oldcwdi = p->p_cwdi;
1083 p->p_cwdi = newcwdi;
1084 cwdfree(oldcwdi);
1085 }
1086
1087 /*
1088 * Release a cwdinfo structure.
1089 */
1090 void
1091 cwdfree(struct cwdinfo *cwdi)
1092 {
1093 int n;
1094
1095 simple_lock(&cwdi->cwdi_slock);
1096 n = --cwdi->cwdi_refcnt;
1097 simple_unlock(&cwdi->cwdi_slock);
1098 if (n > 0)
1099 return;
1100
1101 vrele(cwdi->cwdi_cdir);
1102 if (cwdi->cwdi_rdir)
1103 vrele(cwdi->cwdi_rdir);
1104 pool_put(&cwdi_pool, cwdi);
1105 }
1106
1107 /*
1108 * Create an initial filedesc structure, using the same current and root
1109 * directories as p.
1110 */
1111 struct filedesc *
1112 fdinit(struct proc *p)
1113 {
1114 struct filedesc0 *newfdp;
1115
1116 newfdp = pool_get(&filedesc0_pool, PR_WAITOK);
1117 memset(newfdp, 0, sizeof(struct filedesc0));
1118
1119 fdinit1(newfdp);
1120
1121 return (&newfdp->fd_fd);
1122 }
1123
1124 /*
1125 * Initialize a file descriptor table.
1126 */
1127 void
1128 fdinit1(struct filedesc0 *newfdp)
1129 {
1130
1131 newfdp->fd_fd.fd_refcnt = 1;
1132 newfdp->fd_fd.fd_ofiles = newfdp->fd_dfiles;
1133 newfdp->fd_fd.fd_ofileflags = newfdp->fd_dfileflags;
1134 newfdp->fd_fd.fd_nfiles = NDFILE;
1135 newfdp->fd_fd.fd_knlistsize = -1;
1136 newfdp->fd_fd.fd_himap = newfdp->fd_dhimap;
1137 newfdp->fd_fd.fd_lomap = newfdp->fd_dlomap;
1138 newfdp->fd_fd.fd_lastfile = -1;
1139 simple_lock_init(&newfdp->fd_fd.fd_slock);
1140 }
1141
1142 /*
1143 * Make p2 share p1's filedesc structure.
1144 */
1145 void
1146 fdshare(struct proc *p1, struct proc *p2)
1147 {
1148 struct filedesc *fdp = p1->p_fd;
1149
1150 simple_lock(&fdp->fd_slock);
1151 p2->p_fd = fdp;
1152 fdp->fd_refcnt++;
1153 simple_unlock(&fdp->fd_slock);
1154 }
1155
1156 /*
1157 * Make this process not share its filedesc structure, maintaining
1158 * all file descriptor state.
1159 */
1160 void
1161 fdunshare(struct lwp *l)
1162 {
1163 struct proc *p = l->l_proc;
1164 struct filedesc *newfd;
1165
1166 if (p->p_fd->fd_refcnt == 1)
1167 return;
1168
1169 newfd = fdcopy(p);
1170 fdfree(l);
1171 p->p_fd = newfd;
1172 }
1173
1174 /*
1175 * Clear a process's fd table.
1176 */
1177 void
1178 fdclear(struct lwp *l)
1179 {
1180 struct proc *p = l->l_proc;
1181 struct filedesc *newfd;
1182
1183 newfd = fdinit(p);
1184 fdfree(l);
1185 p->p_fd = newfd;
1186 }
1187
1188 /*
1189 * Copy a filedesc structure.
1190 */
1191 struct filedesc *
1192 fdcopy(struct proc *p)
1193 {
1194 struct filedesc *newfdp, *fdp;
1195 struct file **fpp, **nfpp;
1196 int i, numfiles, lastfile;
1197
1198 fdp = p->p_fd;
1199 newfdp = pool_get(&filedesc0_pool, PR_WAITOK);
1200 newfdp->fd_refcnt = 1;
1201 simple_lock_init(&newfdp->fd_slock);
1202
1203 restart:
1204 numfiles = fdp->fd_nfiles;
1205 lastfile = fdp->fd_lastfile;
1206
1207 /*
1208 * If the number of open files fits in the internal arrays
1209 * of the open file structure, use them, otherwise allocate
1210 * additional memory for the number of descriptors currently
1211 * in use.
1212 */
1213 if (lastfile < NDFILE) {
1214 i = NDFILE;
1215 } else {
1216 /*
1217 * Compute the smallest multiple of NDEXTENT needed
1218 * for the file descriptors currently in use,
1219 * allowing the table to shrink.
1220 */
1221 i = numfiles;
1222 while (i >= 2 * NDEXTENT && i > lastfile * 2)
1223 i /= 2;
1224 newfdp->fd_ofiles = malloc(i * OFILESIZE, M_FILEDESC, M_WAITOK);
1225 }
1226 if (NDHISLOTS(i) > NDHISLOTS(NDFILE)) {
1227 newfdp->fd_himap = malloc(NDHISLOTS(i) * sizeof(uint32_t),
1228 M_FILEDESC, M_WAITOK);
1229 newfdp->fd_lomap = malloc(NDLOSLOTS(i) * sizeof(uint32_t),
1230 M_FILEDESC, M_WAITOK);
1231 }
1232
1233 simple_lock(&fdp->fd_slock);
1234 if (numfiles != fdp->fd_nfiles || lastfile != fdp->fd_lastfile) {
1235 simple_unlock(&fdp->fd_slock);
1236 if (i > NDFILE)
1237 free(newfdp->fd_ofiles, M_FILEDESC);
1238 if (NDHISLOTS(i) > NDHISLOTS(NDFILE)) {
1239 free(newfdp->fd_himap, M_FILEDESC);
1240 free(newfdp->fd_lomap, M_FILEDESC);
1241 }
1242 goto restart;
1243 }
1244
1245 if (lastfile < NDFILE) {
1246 newfdp->fd_ofiles = ((struct filedesc0 *) newfdp)->fd_dfiles;
1247 newfdp->fd_ofileflags =
1248 ((struct filedesc0 *) newfdp)->fd_dfileflags;
1249 } else {
1250 newfdp->fd_ofileflags = (char *) &newfdp->fd_ofiles[i];
1251 }
1252 if (NDHISLOTS(i) <= NDHISLOTS(NDFILE)) {
1253 newfdp->fd_himap =
1254 ((struct filedesc0 *) newfdp)->fd_dhimap;
1255 newfdp->fd_lomap =
1256 ((struct filedesc0 *) newfdp)->fd_dlomap;
1257 }
1258
1259 newfdp->fd_nfiles = i;
1260 newfdp->fd_lastfile = lastfile;
1261 newfdp->fd_freefile = fdp->fd_freefile;
1262
1263 /* Clear the entries that will not be copied over.
1264 * Avoid calling memset with 0 size (i.e. when
1265 * lastfile == i-1 */
1266 if (lastfile < (i-1))
1267 memset(newfdp->fd_ofiles + lastfile + 1, 0,
1268 (i - lastfile - 1) * sizeof(struct file **));
1269 memcpy(newfdp->fd_ofileflags, fdp->fd_ofileflags, i * sizeof(char));
1270 if (i < NDENTRIES * NDENTRIES)
1271 i = NDENTRIES * NDENTRIES; /* size of inlined bitmaps */
1272 memcpy(newfdp->fd_himap, fdp->fd_himap, NDHISLOTS(i)*sizeof(uint32_t));
1273 memcpy(newfdp->fd_lomap, fdp->fd_lomap, NDLOSLOTS(i)*sizeof(uint32_t));
1274
1275 fpp = fdp->fd_ofiles;
1276 nfpp = newfdp->fd_ofiles;
1277 for (i = 0; i <= lastfile; i++, fpp++, nfpp++) {
1278 if ((*nfpp = *fpp) == NULL)
1279 continue;
1280
1281 if ((*fpp)->f_type == DTYPE_KQUEUE)
1282 /* kq descriptors cannot be copied. */
1283 fdremove(newfdp, i);
1284 else {
1285 simple_lock(&(*fpp)->f_slock);
1286 (*fpp)->f_count++;
1287 simple_unlock(&(*fpp)->f_slock);
1288 }
1289 }
1290
1291 simple_unlock(&fdp->fd_slock);
1292
1293 newfdp->fd_knlist = NULL;
1294 newfdp->fd_knlistsize = -1;
1295 newfdp->fd_knhash = NULL;
1296 newfdp->fd_knhashmask = 0;
1297
1298 return (newfdp);
1299 }
1300
1301 /*
1302 * Release a filedesc structure.
1303 */
1304 void
1305 fdfree(struct lwp *l)
1306 {
1307 struct proc *p = l->l_proc;
1308 struct filedesc *fdp;
1309 struct file **fpp, *fp;
1310 int i;
1311
1312 fdp = p->p_fd;
1313 simple_lock(&fdp->fd_slock);
1314 i = --fdp->fd_refcnt;
1315 simple_unlock(&fdp->fd_slock);
1316 if (i > 0)
1317 return;
1318
1319 fpp = fdp->fd_ofiles;
1320 for (i = fdp->fd_lastfile; i >= 0; i--, fpp++) {
1321 fp = *fpp;
1322 if (fp != NULL) {
1323 *fpp = NULL;
1324 simple_lock(&fp->f_slock);
1325 FILE_USE(fp);
1326 if ((fdp->fd_lastfile - i) < fdp->fd_knlistsize)
1327 knote_fdclose(l, fdp->fd_lastfile - i);
1328 (void) closef(fp, l);
1329 }
1330 }
1331 p->p_fd = NULL;
1332 if (fdp->fd_nfiles > NDFILE)
1333 free(fdp->fd_ofiles, M_FILEDESC);
1334 if (NDHISLOTS(fdp->fd_nfiles) > NDHISLOTS(NDFILE)) {
1335 free(fdp->fd_himap, M_FILEDESC);
1336 free(fdp->fd_lomap, M_FILEDESC);
1337 }
1338 if (fdp->fd_knlist)
1339 free(fdp->fd_knlist, M_KEVENT);
1340 if (fdp->fd_knhash)
1341 hashdone(fdp->fd_knhash, M_KEVENT);
1342 pool_put(&filedesc0_pool, fdp);
1343 }
1344
1345 /*
1346 * Internal form of close.
1347 * Decrement reference count on file structure.
1348 * Note: p may be NULL when closing a file
1349 * that was being passed in a message.
1350 *
1351 * Note: we expect the caller is holding a usecount, and expects us
1352 * to drop it (the caller thinks the file is going away forever).
1353 */
1354 int
1355 closef(struct file *fp, struct lwp *l)
1356 {
1357 struct proc *p = l ? l->l_proc : NULL;
1358 struct vnode *vp;
1359 struct flock lf;
1360 int error;
1361
1362 if (fp == NULL)
1363 return (0);
1364
1365 /*
1366 * POSIX record locking dictates that any close releases ALL
1367 * locks owned by this process. This is handled by setting
1368 * a flag in the unlock to free ONLY locks obeying POSIX
1369 * semantics, and not to free BSD-style file locks.
1370 * If the descriptor was in a message, POSIX-style locks
1371 * aren't passed with the descriptor.
1372 */
1373 if (p && (p->p_flag & P_ADVLOCK) && fp->f_type == DTYPE_VNODE) {
1374 lf.l_whence = SEEK_SET;
1375 lf.l_start = 0;
1376 lf.l_len = 0;
1377 lf.l_type = F_UNLCK;
1378 vp = (struct vnode *)fp->f_data;
1379 (void) VOP_ADVLOCK(vp, p, F_UNLCK, &lf, F_POSIX);
1380 }
1381
1382 /*
1383 * If WANTCLOSE is set, then the reference count on the file
1384 * is 0, but there were multiple users of the file. This can
1385 * happen if a filedesc structure is shared by multiple
1386 * processes.
1387 */
1388 simple_lock(&fp->f_slock);
1389 if (fp->f_iflags & FIF_WANTCLOSE) {
1390 /*
1391 * Another user of the file is already closing, and is
1392 * simply waiting for other users of the file to drain.
1393 * Release our usecount, and wake up the closer if it
1394 * is the only remaining use.
1395 */
1396 #ifdef DIAGNOSTIC
1397 if (fp->f_count != 0)
1398 panic("closef: wantclose and count != 0");
1399 if (fp->f_usecount < 2)
1400 panic("closef: wantclose and usecount < 2");
1401 #endif
1402 if (--fp->f_usecount == 1)
1403 wakeup(&fp->f_usecount);
1404 simple_unlock(&fp->f_slock);
1405 return (0);
1406 } else {
1407 /*
1408 * Decrement the reference count. If we were not the
1409 * last reference, then release our use and just
1410 * return.
1411 */
1412 if (--fp->f_count > 0) {
1413 #ifdef DIAGNOSTIC
1414 if (fp->f_usecount < 1)
1415 panic("closef: no wantclose and usecount < 1");
1416 #endif
1417 fp->f_usecount--;
1418 simple_unlock(&fp->f_slock);
1419 return (0);
1420 }
1421 }
1422
1423 /*
1424 * The reference count is now 0. However, there may be
1425 * multiple potential users of this file. This can happen
1426 * if multiple processes shared a single filedesc structure.
1427 *
1428 * Notify these potential users that the file is closing.
1429 * This will prevent them from adding additional uses to
1430 * the file.
1431 */
1432 fp->f_iflags |= FIF_WANTCLOSE;
1433
1434 /*
1435 * We expect the caller to add a use to the file. So, if we
1436 * are the last user, usecount will be 1. If it is not, we
1437 * must wait for the usecount to drain. When it drains back
1438 * to 1, we will be awakened so that we may proceed with the
1439 * close.
1440 */
1441 #ifdef DIAGNOSTIC
1442 if (fp->f_usecount < 1)
1443 panic("closef: usecount < 1");
1444 #endif
1445 while (fp->f_usecount > 1)
1446 (void) ltsleep(&fp->f_usecount, PRIBIO, "closef", 0,
1447 &fp->f_slock);
1448 #ifdef DIAGNOSTIC
1449 if (fp->f_usecount != 1)
1450 panic("closef: usecount != 1");
1451 #endif
1452
1453 simple_unlock(&fp->f_slock);
1454 if ((fp->f_flag & FHASLOCK) && fp->f_type == DTYPE_VNODE) {
1455 lf.l_whence = SEEK_SET;
1456 lf.l_start = 0;
1457 lf.l_len = 0;
1458 lf.l_type = F_UNLCK;
1459 vp = (struct vnode *)fp->f_data;
1460 (void) VOP_ADVLOCK(vp, fp, F_UNLCK, &lf, F_FLOCK);
1461 }
1462 if (fp->f_ops)
1463 error = (*fp->f_ops->fo_close)(fp, l);
1464 else
1465 error = 0;
1466
1467 /* Nothing references the file now, drop the final use (us). */
1468 fp->f_usecount--;
1469
1470 ffree(fp);
1471 return (error);
1472 }
1473
1474 /*
1475 * Apply an advisory lock on a file descriptor.
1476 *
1477 * Just attempt to get a record lock of the requested type on
1478 * the entire file (l_whence = SEEK_SET, l_start = 0, l_len = 0).
1479 */
1480 /* ARGSUSED */
1481 int
1482 sys_flock(struct lwp *l, void *v, register_t *retval)
1483 {
1484 struct sys_flock_args /* {
1485 syscallarg(int) fd;
1486 syscallarg(int) how;
1487 } */ *uap = v;
1488 int fd, how, error;
1489 struct proc *p;
1490 struct filedesc *fdp;
1491 struct file *fp;
1492 struct vnode *vp;
1493 struct flock lf;
1494
1495 p = l->l_proc;
1496 fd = SCARG(uap, fd);
1497 how = SCARG(uap, how);
1498 fdp = p->p_fd;
1499 error = 0;
1500
1501 if ((fp = fd_getfile(fdp, fd)) == NULL)
1502 return (EBADF);
1503
1504 FILE_USE(fp);
1505
1506 if (fp->f_type != DTYPE_VNODE) {
1507 error = EOPNOTSUPP;
1508 goto out;
1509 }
1510
1511 vp = (struct vnode *)fp->f_data;
1512 lf.l_whence = SEEK_SET;
1513 lf.l_start = 0;
1514 lf.l_len = 0;
1515 if (how & LOCK_UN) {
1516 lf.l_type = F_UNLCK;
1517 fp->f_flag &= ~FHASLOCK;
1518 error = VOP_ADVLOCK(vp, fp, F_UNLCK, &lf, F_FLOCK);
1519 goto out;
1520 }
1521 if (how & LOCK_EX)
1522 lf.l_type = F_WRLCK;
1523 else if (how & LOCK_SH)
1524 lf.l_type = F_RDLCK;
1525 else {
1526 error = EINVAL;
1527 goto out;
1528 }
1529 fp->f_flag |= FHASLOCK;
1530 if (how & LOCK_NB)
1531 error = VOP_ADVLOCK(vp, fp, F_SETLK, &lf, F_FLOCK);
1532 else
1533 error = VOP_ADVLOCK(vp, fp, F_SETLK, &lf,
1534 F_FLOCK|F_WAIT);
1535 out:
1536 FILE_UNUSE(fp, l);
1537 return (error);
1538 }
1539
1540 /* ARGSUSED */
1541 int
1542 sys_posix_fadvise(struct lwp *l, void *v, register_t *retval)
1543 {
1544 const struct sys_posix_fadvise_args /* {
1545 syscallarg(int) fd;
1546 syscallarg(off_t) offset;
1547 syscallarg(off_t) len;
1548 syscallarg(int) advice;
1549 } */ *uap = v;
1550 const int fd = SCARG(uap, fd);
1551 const int advice = SCARG(uap, advice);
1552 struct proc *p = l->l_proc;
1553 struct file *fp;
1554 int error = 0;
1555
1556 fp = fd_getfile(p->p_fd, fd);
1557 if (fp == NULL) {
1558 error = EBADF;
1559 goto out;
1560 }
1561 FILE_USE(fp);
1562
1563 if (fp->f_type != DTYPE_VNODE) {
1564 if (fp->f_type == DTYPE_PIPE || fp->f_type == DTYPE_SOCKET) {
1565 error = ESPIPE;
1566 } else {
1567 error = EOPNOTSUPP;
1568 }
1569 goto out;
1570 }
1571
1572 switch (advice) {
1573 case POSIX_FADV_NORMAL:
1574 case POSIX_FADV_RANDOM:
1575 case POSIX_FADV_SEQUENTIAL:
1576 KASSERT(POSIX_FADV_NORMAL == UVM_ADV_NORMAL);
1577 KASSERT(POSIX_FADV_RANDOM == UVM_ADV_RANDOM);
1578 KASSERT(POSIX_FADV_SEQUENTIAL == UVM_ADV_SEQUENTIAL);
1579
1580 /*
1581 * we ignore offset and size.
1582 */
1583
1584 fp->f_advice = advice;
1585 break;
1586
1587 case POSIX_FADV_WILLNEED:
1588 case POSIX_FADV_DONTNEED:
1589 case POSIX_FADV_NOREUSE:
1590
1591 /*
1592 * not implemented yet.
1593 */
1594
1595 break;
1596 default:
1597 error = EINVAL;
1598 break;
1599 }
1600 out:
1601 if (fp != NULL) {
1602 FILE_UNUSE(fp, l);
1603 }
1604 *retval = error;
1605 return 0;
1606 }
1607
1608 /*
1609 * File Descriptor pseudo-device driver (/dev/fd/).
1610 *
1611 * Opening minor device N dup()s the file (if any) connected to file
1612 * descriptor N belonging to the calling process. Note that this driver
1613 * consists of only the ``open()'' routine, because all subsequent
1614 * references to this file will be direct to the other driver.
1615 */
1616 /* ARGSUSED */
1617 static int
1618 filedescopen(dev_t dev, int mode, int type, struct lwp *l)
1619 {
1620
1621 /*
1622 * XXX Kludge: set dupfd to contain the value of the
1623 * the file descriptor being sought for duplication. The error
1624 * return ensures that the vnode for this device will be released
1625 * by vn_open. Open will detect this special error and take the
1626 * actions in dupfdopen below. Other callers of vn_open or VOP_OPEN
1627 * will simply report the error.
1628 */
1629 l->l_dupfd = minor(dev); /* XXX */
1630 return EDUPFD;
1631 }
1632
1633 const struct cdevsw filedesc_cdevsw = {
1634 filedescopen, noclose, noread, nowrite, noioctl,
1635 nostop, notty, nopoll, nommap, nokqfilter,
1636 };
1637
1638 /*
1639 * Duplicate the specified descriptor to a free descriptor.
1640 *
1641 * 'indx' has been fdalloc'ed (and will be fdremove'ed on error) by the caller.
1642 */
1643 int
1644 dupfdopen(struct lwp *l, int indx, int dfd, int mode, int error)
1645 {
1646 struct proc *p = l->l_proc;
1647 struct filedesc *fdp;
1648 struct file *wfp;
1649
1650 fdp = p->p_fd;
1651
1652 /* should be cleared by the caller */
1653 KASSERT(fdp->fd_ofiles[indx] == NULL);
1654
1655 /*
1656 * If the to-be-dup'd fd number is greater than the allowed number
1657 * of file descriptors, or the fd to be dup'd has already been
1658 * closed, reject.
1659 */
1660
1661 /*
1662 * Note, in the case of indx == dfd, fd_getfile below returns NULL.
1663 */
1664 if ((wfp = fd_getfile(fdp, dfd)) == NULL)
1665 return (EBADF);
1666
1667 FILE_USE(wfp);
1668
1669 /*
1670 * There are two cases of interest here.
1671 *
1672 * For EDUPFD simply dup (dfd) to file descriptor
1673 * (indx) and return.
1674 *
1675 * For EMOVEFD steal away the file structure from (dfd) and
1676 * store it in (indx). (dfd) is effectively closed by
1677 * this operation.
1678 *
1679 * Any other error code is just returned.
1680 */
1681 switch (error) {
1682 case EDUPFD:
1683 /*
1684 * Check that the mode the file is being opened for is a
1685 * subset of the mode of the existing descriptor.
1686 */
1687 if (((mode & (FREAD|FWRITE)) | wfp->f_flag) != wfp->f_flag) {
1688 FILE_UNUSE(wfp, l);
1689 return (EACCES);
1690 }
1691 simple_lock(&fdp->fd_slock);
1692 fdp->fd_ofiles[indx] = wfp;
1693 fdp->fd_ofileflags[indx] = fdp->fd_ofileflags[dfd];
1694 simple_unlock(&fdp->fd_slock);
1695 simple_lock(&wfp->f_slock);
1696 wfp->f_count++;
1697 /* 'indx' has been fd_used'ed by caller */
1698 FILE_UNUSE_HAVELOCK(wfp, l);
1699 return (0);
1700
1701 case EMOVEFD:
1702 /*
1703 * Steal away the file pointer from dfd, and stuff it into indx.
1704 */
1705 simple_lock(&fdp->fd_slock);
1706 fdp->fd_ofiles[indx] = fdp->fd_ofiles[dfd];
1707 fdp->fd_ofileflags[indx] = fdp->fd_ofileflags[dfd];
1708 fdp->fd_ofiles[dfd] = NULL;
1709 fdp->fd_ofileflags[dfd] = 0;
1710 /*
1711 * Complete the clean up of the filedesc structure by
1712 * recomputing the various hints.
1713 */
1714 /* 'indx' has been fd_used'ed by caller */
1715 fd_unused(fdp, dfd);
1716 simple_unlock(&fdp->fd_slock);
1717 FILE_UNUSE(wfp, l);
1718 return (0);
1719
1720 default:
1721 FILE_UNUSE(wfp, l);
1722 return (error);
1723 }
1724 /* NOTREACHED */
1725 }
1726
1727 /*
1728 * Close any files on exec?
1729 */
1730 void
1731 fdcloseexec(struct lwp *l)
1732 {
1733 struct proc *p = l->l_proc;
1734 struct filedesc *fdp;
1735 int fd;
1736
1737 fdunshare(l);
1738 cwdunshare(p);
1739
1740 fdp = p->p_fd;
1741 for (fd = 0; fd <= fdp->fd_lastfile; fd++)
1742 if (fdp->fd_ofileflags[fd] & UF_EXCLOSE)
1743 (void) fdrelease(l, fd);
1744 }
1745
1746 /*
1747 * It is unsafe for set[ug]id processes to be started with file
1748 * descriptors 0..2 closed, as these descriptors are given implicit
1749 * significance in the Standard C library. fdcheckstd() will create a
1750 * descriptor referencing /dev/null for each of stdin, stdout, and
1751 * stderr that is not already open.
1752 */
1753 #define CHECK_UPTO 3
1754 int
1755 fdcheckstd(l)
1756 struct lwp *l;
1757 {
1758 struct proc *p;
1759 struct nameidata nd;
1760 struct filedesc *fdp;
1761 struct file *fp;
1762 struct file *devnullfp = NULL; /* Quell compiler warning */
1763 struct proc *pp;
1764 register_t retval;
1765 int fd, i, error, flags = FREAD|FWRITE, devnull = -1;
1766 char closed[CHECK_UPTO * 3 + 1], which[3 + 1];
1767
1768 p = l->l_proc;
1769 closed[0] = '\0';
1770 if ((fdp = p->p_fd) == NULL)
1771 return (0);
1772 for (i = 0; i < CHECK_UPTO; i++) {
1773 if (fdp->fd_ofiles[i] != NULL)
1774 continue;
1775 snprintf(which, sizeof(which), ",%d", i);
1776 strlcat(closed, which, sizeof(closed));
1777 if (devnullfp == NULL) {
1778 if ((error = falloc(p, &fp, &fd)) != 0)
1779 return (error);
1780 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, "/dev/null",
1781 l);
1782 if ((error = vn_open(&nd, flags, 0)) != 0) {
1783 FILE_UNUSE(fp, l);
1784 ffree(fp);
1785 fdremove(p->p_fd, fd);
1786 return (error);
1787 }
1788 fp->f_data = nd.ni_vp;
1789 fp->f_flag = flags;
1790 fp->f_ops = &vnops;
1791 fp->f_type = DTYPE_VNODE;
1792 VOP_UNLOCK(nd.ni_vp, 0);
1793 devnull = fd;
1794 devnullfp = fp;
1795 FILE_SET_MATURE(fp);
1796 } else {
1797 restart:
1798 if ((error = fdalloc(p, 0, &fd)) != 0) {
1799 if (error == ENOSPC) {
1800 fdexpand(p);
1801 goto restart;
1802 }
1803 return (error);
1804 }
1805
1806 simple_lock(&devnullfp->f_slock);
1807 FILE_USE(devnullfp);
1808 /* finishdup() will unuse the descriptors for us */
1809 if ((error = finishdup(l, devnull, fd, &retval)) != 0)
1810 return (error);
1811 }
1812 }
1813 if (devnullfp)
1814 FILE_UNUSE(devnullfp, l);
1815 if (closed[0] != '\0') {
1816 pp = p->p_pptr;
1817 log(LOG_WARNING, "set{u,g}id pid %d (%s) "
1818 "was invoked by uid %d ppid %d (%s) "
1819 "with fd %s closed\n",
1820 p->p_pid, p->p_comm, pp->p_ucred->cr_uid,
1821 pp->p_pid, pp->p_comm, &closed[1]);
1822 }
1823 return (0);
1824 }
1825 #undef CHECK_UPTO
1826
1827 /*
1828 * Sets descriptor owner. If the owner is a process, 'pgid'
1829 * is set to positive value, process ID. If the owner is process group,
1830 * 'pgid' is set to -pg_id.
1831 */
1832 int
1833 fsetown(struct proc *p, pid_t *pgid, int cmd, const void *data)
1834 {
1835 int id = *(const int *)data;
1836 int error;
1837
1838 switch (cmd) {
1839 case TIOCSPGRP:
1840 if (id < 0)
1841 return (EINVAL);
1842 id = -id;
1843 break;
1844 default:
1845 break;
1846 }
1847
1848 if (id > 0 && !pfind(id))
1849 return (ESRCH);
1850 else if (id < 0 && (error = pgid_in_session(p, -id)))
1851 return (error);
1852
1853 *pgid = id;
1854 return (0);
1855 }
1856
1857 /*
1858 * Return descriptor owner information. If the value is positive,
1859 * it's process ID. If it's negative, it's process group ID and
1860 * needs the sign removed before use.
1861 */
1862 int
1863 fgetown(struct proc *p, pid_t pgid, int cmd, void *data)
1864 {
1865 switch (cmd) {
1866 case TIOCGPGRP:
1867 *(int *)data = -pgid;
1868 break;
1869 default:
1870 *(int *)data = pgid;
1871 break;
1872 }
1873 return (0);
1874 }
1875
1876 /*
1877 * Send signal to descriptor owner, either process or process group.
1878 */
1879 void
1880 fownsignal(pid_t pgid, int signo, int code, int band, void *fdescdata)
1881 {
1882 struct proc *p1;
1883 ksiginfo_t ksi;
1884
1885 memset(&ksi, 0, sizeof(ksi));
1886 ksi.ksi_signo = signo;
1887 ksi.ksi_code = code;
1888 ksi.ksi_band = band;
1889
1890 if (pgid > 0 && (p1 = pfind(pgid)))
1891 kpsignal(p1, &ksi, fdescdata);
1892 else if (pgid < 0)
1893 kgsignal(-pgid, &ksi, fdescdata);
1894 }
1895
1896 int
1897 fdclone(struct lwp *l, struct file *fp, int fd, int flag,
1898 const struct fileops *fops, void *data)
1899 {
1900 fp->f_flag = flag;
1901 fp->f_type = DTYPE_MISC;
1902 fp->f_ops = fops;
1903 fp->f_data = data;
1904
1905 l->l_dupfd = fd;
1906
1907 FILE_SET_MATURE(fp);
1908 FILE_UNUSE(fp, l);
1909 return EMOVEFD;
1910 }
1911
1912 /* ARGSUSED */
1913 int
1914 fnullop_fcntl(struct file *fp, u_int cmd, void *data, struct lwp *l)
1915 {
1916 if (cmd == F_SETFL)
1917 return 0;
1918
1919 return EOPNOTSUPP;
1920 }
1921
1922 /* ARGSUSED */
1923 int
1924 fnullop_poll(struct file *fp, int which, struct lwp *l)
1925 {
1926 return 0;
1927 }
1928
1929
1930 /* ARGSUSED */
1931 int
1932 fnullop_kqfilter(struct file *fp, struct knote *kn)
1933 {
1934
1935 return 0;
1936 }
1937
1938 /* ARGSUSED */
1939 int
1940 fbadop_stat(struct file *fp, struct stat *sb, struct lwp *l)
1941 {
1942 return EOPNOTSUPP;
1943 }
1944