1 /*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1982, 1986, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32 #ifndef _SYS_FILE_H_
33 #define _SYS_FILE_H_
34
35 #ifndef _KERNEL
36 #include <sys/types.h> /* XXX */
37 #include <sys/fcntl.h>
38 #include <sys/unistd.h>
39 #else
40 #include <sys/errno.h>
41 #include <sys/_lock.h>
42 #include <sys/_mutex.h>
43 #include <sys/_null.h>
44 #include <sys/queue.h>
45 #include <sys/refcount.h>
46 #include <vm/vm.h>
47
48 struct filedesc;
49 struct proc;
50 struct stat;
51 struct thread;
52 struct uio;
53 struct knote;
54 struct vnode;
55 struct nameidata;
56
57 #endif /* _KERNEL */
58
59 #define DTYPE_NONE 0 /* not yet initialized */
60 #define DTYPE_VNODE 1 /* file */
61 #define DTYPE_SOCKET 2 /* communications endpoint */
62 #define DTYPE_PIPE 3 /* pipe */
63 #define DTYPE_FIFO 4 /* fifo (named pipe) */
64 #define DTYPE_KQUEUE 5 /* event queue */
65 #define DTYPE_CRYPTO 6 /* crypto */
66 #define DTYPE_MQUEUE 7 /* posix message queue */
67 #define DTYPE_SHM 8 /* swap-backed shared memory */
68 #define DTYPE_SEM 9 /* posix semaphore */
69 #define DTYPE_PTS 10 /* pseudo teletype master device */
70 #define DTYPE_DEV 11 /* Device specific fd type */
71 #define DTYPE_PROCDESC 12 /* process descriptor */
72 #define DTYPE_EVENTFD 13 /* eventfd */
73 #define DTYPE_TIMERFD 14 /* timerfd */
74 #define DTYPE_INOTIFY 15 /* inotify descriptor */
75 #define DTYPE_JAILDESC 16 /* jail descriptor */
76
77 #ifdef _KERNEL
78
79 struct file;
80 struct filecaps;
81 struct kaiocb;
82 struct kinfo_file;
83 struct ucred;
84
85 #define FOF_OFFSET 0x01 /* Use the offset in uio argument */
86 #define FOF_NOLOCK 0x02 /* Do not take FOFFSET_LOCK */
87 #define FOF_NEXTOFF_R 0x04 /* Also update f_nextoff[UIO_READ] */
88 #define FOF_NEXTOFF_W 0x08 /* Also update f_nextoff[UIO_WRITE] */
89 #define FOF_NOUPDATE 0x10 /* Do not update f_offset */
90 off_t foffset_lock(struct file *fp, int flags);
91 void foffset_lock_pair(struct file *fp1, off_t *off1p, struct file *fp2,
92 off_t *off2p, int flags);
93 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
94 void foffset_unlock(struct file *fp, off_t val, int flags);
95 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
96 void fsetfl_lock(struct file *fp);
97 void fsetfl_unlock(struct file *fp);
98
99 static inline off_t
foffset_get(struct file * fp)100 foffset_get(struct file *fp)
101 {
102
103 return (foffset_lock(fp, FOF_NOLOCK));
104 }
105
106 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
107 struct ucred *active_cred, int flags,
108 struct thread *td);
109 typedef int fo_truncate_t(struct file *fp, off_t length,
110 struct ucred *active_cred, struct thread *td);
111 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
112 struct ucred *active_cred, struct thread *td);
113 typedef int fo_poll_t(struct file *fp, int events,
114 struct ucred *active_cred, struct thread *td);
115 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
116 typedef int fo_stat_t(struct file *fp, struct stat *sb,
117 struct ucred *active_cred);
118 typedef int fo_close_t(struct file *fp, struct thread *td);
119 typedef void fo_fdclose_t(struct file *fp, int fd, struct thread *td);
120 typedef int fo_chmod_t(struct file *fp, mode_t mode,
121 struct ucred *active_cred, struct thread *td);
122 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
123 struct ucred *active_cred, struct thread *td);
124 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio,
125 struct uio *trl_uio, off_t offset, size_t nbytes,
126 off_t *sent, int flags, struct thread *td);
127 typedef int fo_seek_t(struct file *fp, off_t offset, int whence,
128 struct thread *td);
129 typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif,
130 struct filedesc *fdp);
131 typedef int fo_mmap_t(struct file *fp, vm_map_t map, vm_offset_t *addr,
132 vm_size_t size, vm_prot_t prot, vm_prot_t cap_maxprot,
133 int flags, vm_ooffset_t foff, struct thread *td);
134 typedef int fo_aio_queue_t(struct file *fp, struct kaiocb *job);
135 typedef int fo_add_seals_t(struct file *fp, int flags);
136 typedef int fo_get_seals_t(struct file *fp, int *flags);
137 typedef int fo_fallocate_t(struct file *fp, off_t offset, off_t len,
138 struct thread *td);
139 typedef int fo_fspacectl_t(struct file *fp, int cmd,
140 off_t *offset, off_t *length, int flags,
141 struct ucred *active_cred, struct thread *td);
142 typedef int fo_cmp_t(struct file *fp, struct file *fp1, struct thread *td);
143 typedef int fo_fork_t(struct filedesc *fdp, struct file *fp, struct file **fp1,
144 struct proc *p1, struct thread *td);
145 typedef int fo_spare_t(struct file *fp);
146 typedef int fo_flags_t;
147
148 struct fileops {
149 fo_rdwr_t *fo_read;
150 fo_rdwr_t *fo_write;
151 fo_truncate_t *fo_truncate;
152 fo_ioctl_t *fo_ioctl;
153 fo_poll_t *fo_poll;
154 fo_kqfilter_t *fo_kqfilter;
155 fo_stat_t *fo_stat;
156 fo_close_t *fo_close;
157 fo_fdclose_t *fo_fdclose;
158 fo_chmod_t *fo_chmod;
159 fo_chown_t *fo_chown;
160 fo_sendfile_t *fo_sendfile;
161 fo_seek_t *fo_seek;
162 fo_fill_kinfo_t *fo_fill_kinfo;
163 fo_mmap_t *fo_mmap;
164 fo_aio_queue_t *fo_aio_queue;
165 fo_add_seals_t *fo_add_seals;
166 fo_get_seals_t *fo_get_seals;
167 fo_fallocate_t *fo_fallocate;
168 fo_fspacectl_t *fo_fspacectl;
169 fo_cmp_t *fo_cmp;
170 fo_fork_t *fo_fork;
171 fo_spare_t *fo_spares[8]; /* Spare slots */
172 fo_flags_t fo_flags; /* DFLAG_* below */
173 };
174
175 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
176 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
177 #define DFLAG_FORK 0x04 /* copy on fork */
178 #endif /* _KERNEL */
179
180 #if defined(_KERNEL) || defined(_WANT_FILE)
181 /*
182 * Kernel descriptor table.
183 * One entry for each open kernel vnode and socket.
184 *
185 * Below is the list of locks that protects members in struct file.
186 *
187 * (a) f_vnode lock required (shared allows both reads and writes)
188 * (f) updated with atomics and blocking on sleepq
189 * (d) cdevpriv_mtx
190 * none not locked
191 */
192
193 #if __BSD_VISIBLE
194 struct fadvise_info {
195 int fa_advice; /* (f) FADV_* type. */
196 off_t fa_start; /* (f) Region start. */
197 off_t fa_end; /* (f) Region end. */
198 };
199
200 struct file {
201 volatile u_int f_flag; /* see fcntl.h */
202 volatile u_int f_count; /* reference count */
203 void *f_data; /* file descriptor specific data */
204 const struct fileops *f_ops; /* File operations */
205 struct vnode *f_vnode; /* NULL or applicable vnode */
206 struct ucred *f_cred; /* associated credentials. */
207 short f_type; /* descriptor type */
208 short f_vflags; /* (f) Sleep lock flags for members */
209 /*
210 * DTYPE_VNODE specific fields.
211 */
212 union {
213 int16_t f_seqcount[2]; /* (a) Count of seq. reads and writes. */
214 int f_pipegen;
215 };
216 off_t f_nextoff[2]; /* next expected read/write offset. */
217 union {
218 struct cdev_privdata *fvn_cdevpriv;
219 /* (d) Private data for the cdev. */
220 struct fadvise_info *fvn_advice;
221 } f_vnun;
222 /*
223 * DFLAG_SEEKABLE specific fields
224 */
225 off_t f_offset;
226 };
227
228 #define f_cdevpriv f_vnun.fvn_cdevpriv
229 #define f_advice f_vnun.fvn_advice
230
231 #define FILE_V_FOFFSET_LOCKED 0x0001
232 #define FILE_V_FOFFSET_LOCK_WAITING 0x0002
233 #define FILE_V_SETFL_LOCKED 0x0004
234 #define FILE_V_SETFL_LOCK_WAITING 0x0008
235 #endif /* __BSD_VISIBLE */
236
237 #endif /* _KERNEL || _WANT_FILE */
238
239 /*
240 * Userland version of struct file, for sysctl
241 */
242 #if __BSD_VISIBLE
243 struct xfile {
244 ksize_t xf_size; /* size of struct xfile */
245 pid_t xf_pid; /* owning process */
246 uid_t xf_uid; /* effective uid of owning process */
247 int xf_fd; /* descriptor number */
248 int _xf_int_pad1;
249 kvaddr_t xf_file; /* address of struct file */
250 short xf_type; /* descriptor type */
251 short _xf_short_pad1;
252 int xf_count; /* reference count */
253 int xf_msgcount; /* references from message queue */
254 int _xf_int_pad2;
255 off_t xf_offset; /* file offset */
256 kvaddr_t xf_data; /* file descriptor specific data */
257 kvaddr_t xf_vnode; /* vnode pointer */
258 u_int xf_flag; /* flags (see fcntl.h) */
259 int _xf_int_pad3;
260 int64_t _xf_int64_pad[6];
261 };
262 #endif /* __BSD_VISIBLE */
263
264 #ifdef _KERNEL
265
266 extern const struct fileops vnops;
267 extern const struct fileops badfileops;
268 extern const struct fileops path_fileops;
269 extern const struct fileops socketops;
270 extern int maxfiles; /* kernel limit on number of open files */
271 extern int maxfilesperproc; /* per process limit on number of open files */
272
273 int fget(struct thread *td, int fd, const cap_rights_t *rightsp,
274 struct file **fpp);
275 int fget_mmap(struct thread *td, int fd, const cap_rights_t *rightsp,
276 vm_prot_t *maxprotp, struct file **fpp);
277 int fget_read(struct thread *td, int fd, const cap_rights_t *rightsp,
278 struct file **fpp);
279 int fget_write(struct thread *td, int fd, const cap_rights_t *rightsp,
280 struct file **fpp);
281 int fget_fcntl(struct thread *td, int fd, const cap_rights_t *rightsp,
282 int needfcntl, struct file **fpp);
283 int _fdrop(struct file *fp, struct thread *td);
284 int fget_remote(struct thread *td, struct proc *p, int fd, struct file **fpp);
285 int fget_remote_foreach(struct thread *td, struct proc *p,
286 int (*fn)(struct proc *, int, struct file *, void *), void *arg);
287
288 fo_rdwr_t invfo_rdwr;
289 fo_truncate_t invfo_truncate;
290 fo_ioctl_t invfo_ioctl;
291 fo_poll_t invfo_poll;
292 fo_kqfilter_t invfo_kqfilter;
293 fo_chmod_t invfo_chmod;
294 fo_chown_t invfo_chown;
295 fo_sendfile_t invfo_sendfile;
296 fo_stat_t vn_statfile;
297 fo_sendfile_t vn_sendfile;
298 fo_seek_t vn_seek;
299 fo_fill_kinfo_t vn_fill_kinfo;
300 fo_kqfilter_t vn_kqfilter_opath;
301 int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif);
302 int file_kcmp_generic(struct file *fp1, struct file *fp2, struct thread *td);
303
304 void finit(struct file *, u_int, short, void *, const struct fileops *);
305 void finit_vnode(struct file *, u_int, void *, const struct fileops *);
306 int fgetvp(struct thread *td, int fd, const cap_rights_t *rightsp,
307 struct vnode **vpp);
308 int fgetvp_exec(struct thread *td, int fd, const cap_rights_t *rightsp,
309 struct vnode **vpp);
310 int fgetvp_rights(struct thread *td, int fd, const cap_rights_t *needrightsp,
311 struct filecaps *havecaps, struct vnode **vpp);
312 int fgetvp_read(struct thread *td, int fd, const cap_rights_t *rightsp,
313 struct vnode **vpp);
314 int fgetvp_write(struct thread *td, int fd, const cap_rights_t *rightsp,
315 struct vnode **vpp);
316 int fgetvp_lookup_smr(struct nameidata *ndp, struct vnode **vpp, int *flagsp);
317 int fgetvp_lookup(struct nameidata *ndp, struct vnode **vpp);
318
319 static __inline __result_use_check bool
fhold(struct file * fp)320 fhold(struct file *fp)
321 {
322 return (refcount_acquire_checked(&fp->f_count));
323 }
324
325 #define fdrop(fp, td) ({ \
326 struct file *_fp; \
327 int _error; \
328 \
329 _error = 0; \
330 _fp = (fp); \
331 if (__predict_false(refcount_release(&_fp->f_count))) \
332 _error = _fdrop(_fp, td); \
333 _error; \
334 })
335
336 #define fdrop_close(fp, td) ({ \
337 struct file *_fp; \
338 int _error; \
339 \
340 _error = 0; \
341 _fp = (fp); \
342 if (__predict_true(refcount_release(&_fp->f_count))) \
343 _error = _fdrop(_fp, td); \
344 _error; \
345 })
346
347 static __inline fo_rdwr_t fo_read;
348 static __inline fo_rdwr_t fo_write;
349 static __inline fo_truncate_t fo_truncate;
350 static __inline fo_ioctl_t fo_ioctl;
351 static __inline fo_poll_t fo_poll;
352 static __inline fo_kqfilter_t fo_kqfilter;
353 static __inline fo_stat_t fo_stat;
354 static __inline fo_close_t fo_close;
355 static __inline fo_chmod_t fo_chmod;
356 static __inline fo_chown_t fo_chown;
357 static __inline fo_sendfile_t fo_sendfile;
358
359 static __inline int
fo_read(struct file * fp,struct uio * uio,struct ucred * active_cred,int flags,struct thread * td)360 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
361 int flags, struct thread *td)
362 {
363
364 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
365 }
366
367 static __inline int
fo_write(struct file * fp,struct uio * uio,struct ucred * active_cred,int flags,struct thread * td)368 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
369 int flags, struct thread *td)
370 {
371
372 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
373 }
374
375 static __inline int
fo_truncate(struct file * fp,off_t length,struct ucred * active_cred,struct thread * td)376 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
377 struct thread *td)
378 {
379
380 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
381 }
382
383 static __inline int
fo_ioctl(struct file * fp,u_long com,void * data,struct ucred * active_cred,struct thread * td)384 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
385 struct thread *td)
386 {
387
388 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
389 }
390
391 static __inline int
fo_poll(struct file * fp,int events,struct ucred * active_cred,struct thread * td)392 fo_poll(struct file *fp, int events, struct ucred *active_cred,
393 struct thread *td)
394 {
395
396 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
397 }
398
399 static __inline int
fo_stat(struct file * fp,struct stat * sb,struct ucred * active_cred)400 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred)
401 {
402
403 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred));
404 }
405
406 static __inline int
fo_close(struct file * fp,struct thread * td)407 fo_close(struct file *fp, struct thread *td)
408 {
409
410 return ((*fp->f_ops->fo_close)(fp, td));
411 }
412
413 static __inline int
fo_kqfilter(struct file * fp,struct knote * kn)414 fo_kqfilter(struct file *fp, struct knote *kn)
415 {
416
417 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
418 }
419
420 static __inline int
fo_chmod(struct file * fp,mode_t mode,struct ucred * active_cred,struct thread * td)421 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
422 struct thread *td)
423 {
424
425 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
426 }
427
428 static __inline int
fo_chown(struct file * fp,uid_t uid,gid_t gid,struct ucred * active_cred,struct thread * td)429 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
430 struct thread *td)
431 {
432
433 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
434 }
435
436 static __inline int
fo_sendfile(struct file * fp,int sockfd,struct uio * hdr_uio,struct uio * trl_uio,off_t offset,size_t nbytes,off_t * sent,int flags,struct thread * td)437 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
438 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
439 struct thread *td)
440 {
441
442 return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset,
443 nbytes, sent, flags, td));
444 }
445
446 static __inline int
fo_seek(struct file * fp,off_t offset,int whence,struct thread * td)447 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td)
448 {
449
450 return ((*fp->f_ops->fo_seek)(fp, offset, whence, td));
451 }
452
453 static __inline int
fo_fill_kinfo(struct file * fp,struct kinfo_file * kif,struct filedesc * fdp)454 fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
455 {
456
457 return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp));
458 }
459
460 static __inline int
fo_mmap(struct file * fp,vm_map_t map,vm_offset_t * addr,vm_size_t size,vm_prot_t prot,vm_prot_t cap_maxprot,int flags,vm_ooffset_t foff,struct thread * td)461 fo_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size,
462 vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff,
463 struct thread *td)
464 {
465
466 if (fp->f_ops->fo_mmap == NULL)
467 return (ENODEV);
468 return ((*fp->f_ops->fo_mmap)(fp, map, addr, size, prot, cap_maxprot,
469 flags, foff, td));
470 }
471
472 static __inline int
fo_aio_queue(struct file * fp,struct kaiocb * job)473 fo_aio_queue(struct file *fp, struct kaiocb *job)
474 {
475
476 return ((*fp->f_ops->fo_aio_queue)(fp, job));
477 }
478
479 static __inline int
fo_add_seals(struct file * fp,int seals)480 fo_add_seals(struct file *fp, int seals)
481 {
482
483 if (fp->f_ops->fo_add_seals == NULL)
484 return (EINVAL);
485 return ((*fp->f_ops->fo_add_seals)(fp, seals));
486 }
487
488 static __inline int
fo_get_seals(struct file * fp,int * seals)489 fo_get_seals(struct file *fp, int *seals)
490 {
491
492 if (fp->f_ops->fo_get_seals == NULL)
493 return (EINVAL);
494 return ((*fp->f_ops->fo_get_seals)(fp, seals));
495 }
496
497 static __inline int
fo_fallocate(struct file * fp,off_t offset,off_t len,struct thread * td)498 fo_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td)
499 {
500
501 if (fp->f_ops->fo_fallocate == NULL)
502 return (ENODEV);
503 return ((*fp->f_ops->fo_fallocate)(fp, offset, len, td));
504 }
505
506 static __inline int
fo_fspacectl(struct file * fp,int cmd,off_t * offset,off_t * length,int flags,struct ucred * active_cred,struct thread * td)507 fo_fspacectl(struct file *fp, int cmd, off_t *offset, off_t *length,
508 int flags, struct ucred *active_cred, struct thread *td)
509 {
510
511 if (fp->f_ops->fo_fspacectl == NULL)
512 return (ENODEV);
513 return ((*fp->f_ops->fo_fspacectl)(fp, cmd, offset, length, flags,
514 active_cred, td));
515 }
516
517 static __inline int
fo_cmp(struct file * fp1,struct file * fp2,struct thread * td)518 fo_cmp(struct file *fp1, struct file *fp2, struct thread *td)
519 {
520
521 if (fp1->f_ops->fo_cmp == NULL)
522 return (ENODEV);
523 return ((*fp1->f_ops->fo_cmp)(fp1, fp2, td));
524 }
525
526 #endif /* _KERNEL */
527
528 #endif /* !SYS_FILE_H */
529