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
75 #ifdef _KERNEL
76
77 struct file;
78 struct filecaps;
79 struct kaiocb;
80 struct kinfo_file;
81 struct ucred;
82
83 #define FOF_OFFSET 0x01 /* Use the offset in uio argument */
84 #define FOF_NOLOCK 0x02 /* Do not take FOFFSET_LOCK */
85 #define FOF_NEXTOFF_R 0x04 /* Also update f_nextoff[UIO_READ] */
86 #define FOF_NEXTOFF_W 0x08 /* Also update f_nextoff[UIO_WRITE] */
87 #define FOF_NOUPDATE 0x10 /* Do not update f_offset */
88 off_t foffset_lock(struct file *fp, int flags);
89 void foffset_lock_pair(struct file *fp1, off_t *off1p, struct file *fp2,
90 off_t *off2p, int flags);
91 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
92 void foffset_unlock(struct file *fp, off_t val, int flags);
93 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
94
95 static inline off_t
foffset_get(struct file * fp)96 foffset_get(struct file *fp)
97 {
98
99 return (foffset_lock(fp, FOF_NOLOCK));
100 }
101
102 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
103 struct ucred *active_cred, int flags,
104 struct thread *td);
105 typedef int fo_truncate_t(struct file *fp, off_t length,
106 struct ucred *active_cred, struct thread *td);
107 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
108 struct ucred *active_cred, struct thread *td);
109 typedef int fo_poll_t(struct file *fp, int events,
110 struct ucred *active_cred, struct thread *td);
111 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
112 typedef int fo_stat_t(struct file *fp, struct stat *sb,
113 struct ucred *active_cred);
114 typedef int fo_close_t(struct file *fp, struct thread *td);
115 typedef int fo_chmod_t(struct file *fp, mode_t mode,
116 struct ucred *active_cred, struct thread *td);
117 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
118 struct ucred *active_cred, struct thread *td);
119 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio,
120 struct uio *trl_uio, off_t offset, size_t nbytes,
121 off_t *sent, int flags, struct thread *td);
122 typedef int fo_seek_t(struct file *fp, off_t offset, int whence,
123 struct thread *td);
124 typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif,
125 struct filedesc *fdp);
126 typedef int fo_mmap_t(struct file *fp, vm_map_t map, vm_offset_t *addr,
127 vm_size_t size, vm_prot_t prot, vm_prot_t cap_maxprot,
128 int flags, vm_ooffset_t foff, struct thread *td);
129 typedef int fo_aio_queue_t(struct file *fp, struct kaiocb *job);
130 typedef int fo_add_seals_t(struct file *fp, int flags);
131 typedef int fo_get_seals_t(struct file *fp, int *flags);
132 typedef int fo_fallocate_t(struct file *fp, off_t offset, off_t len,
133 struct thread *td);
134 typedef int fo_fspacectl_t(struct file *fp, int cmd,
135 off_t *offset, off_t *length, int flags,
136 struct ucred *active_cred, struct thread *td);
137 typedef int fo_cmp_t(struct file *fp, struct file *fp1, struct thread *td);
138 typedef int fo_spare_t(struct file *fp);
139 typedef int fo_flags_t;
140
141 struct fileops {
142 fo_rdwr_t *fo_read;
143 fo_rdwr_t *fo_write;
144 fo_truncate_t *fo_truncate;
145 fo_ioctl_t *fo_ioctl;
146 fo_poll_t *fo_poll;
147 fo_kqfilter_t *fo_kqfilter;
148 fo_stat_t *fo_stat;
149 fo_close_t *fo_close;
150 fo_chmod_t *fo_chmod;
151 fo_chown_t *fo_chown;
152 fo_sendfile_t *fo_sendfile;
153 fo_seek_t *fo_seek;
154 fo_fill_kinfo_t *fo_fill_kinfo;
155 fo_mmap_t *fo_mmap;
156 fo_aio_queue_t *fo_aio_queue;
157 fo_add_seals_t *fo_add_seals;
158 fo_get_seals_t *fo_get_seals;
159 fo_fallocate_t *fo_fallocate;
160 fo_fspacectl_t *fo_fspacectl;
161 fo_cmp_t *fo_cmp;
162 fo_spare_t *fo_spares[8]; /* Spare slots */
163 fo_flags_t fo_flags; /* DFLAG_* below */
164 };
165
166 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
167 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
168 #endif /* _KERNEL */
169
170 #if defined(_KERNEL) || defined(_WANT_FILE)
171 /*
172 * Kernel descriptor table.
173 * One entry for each open kernel vnode and socket.
174 *
175 * Below is the list of locks that protects members in struct file.
176 *
177 * (a) f_vnode lock required (shared allows both reads and writes)
178 * (f) updated with atomics and blocking on sleepq
179 * (d) cdevpriv_mtx
180 * none not locked
181 */
182
183 #if __BSD_VISIBLE
184 struct fadvise_info {
185 int fa_advice; /* (f) FADV_* type. */
186 off_t fa_start; /* (f) Region start. */
187 off_t fa_end; /* (f) Region end. */
188 };
189
190 struct file {
191 volatile u_int f_flag; /* see fcntl.h */
192 volatile u_int f_count; /* reference count */
193 void *f_data; /* file descriptor specific data */
194 const struct fileops *f_ops; /* File operations */
195 struct vnode *f_vnode; /* NULL or applicable vnode */
196 struct ucred *f_cred; /* associated credentials. */
197 short f_type; /* descriptor type */
198 short f_vnread_flags; /* (f) Sleep lock for f_offset */
199 /*
200 * DTYPE_VNODE specific fields.
201 */
202 union {
203 int16_t f_seqcount[2]; /* (a) Count of seq. reads and writes. */
204 int f_pipegen;
205 };
206 off_t f_nextoff[2]; /* next expected read/write offset. */
207 union {
208 struct cdev_privdata *fvn_cdevpriv;
209 /* (d) Private data for the cdev. */
210 struct fadvise_info *fvn_advice;
211 } f_vnun;
212 /*
213 * DFLAG_SEEKABLE specific fields
214 */
215 off_t f_offset;
216 };
217
218 #define f_cdevpriv f_vnun.fvn_cdevpriv
219 #define f_advice f_vnun.fvn_advice
220
221 #define FOFFSET_LOCKED 0x1
222 #define FOFFSET_LOCK_WAITING 0x2
223 #endif /* __BSD_VISIBLE */
224
225 #endif /* _KERNEL || _WANT_FILE */
226
227 /*
228 * Userland version of struct file, for sysctl
229 */
230 #if __BSD_VISIBLE
231 struct xfile {
232 ksize_t xf_size; /* size of struct xfile */
233 pid_t xf_pid; /* owning process */
234 uid_t xf_uid; /* effective uid of owning process */
235 int xf_fd; /* descriptor number */
236 int _xf_int_pad1;
237 kvaddr_t xf_file; /* address of struct file */
238 short xf_type; /* descriptor type */
239 short _xf_short_pad1;
240 int xf_count; /* reference count */
241 int xf_msgcount; /* references from message queue */
242 int _xf_int_pad2;
243 off_t xf_offset; /* file offset */
244 kvaddr_t xf_data; /* file descriptor specific data */
245 kvaddr_t xf_vnode; /* vnode pointer */
246 u_int xf_flag; /* flags (see fcntl.h) */
247 int _xf_int_pad3;
248 int64_t _xf_int64_pad[6];
249 };
250 #endif /* __BSD_VISIBLE */
251
252 #ifdef _KERNEL
253
254 extern const struct fileops vnops;
255 extern const struct fileops badfileops;
256 extern const struct fileops path_fileops;
257 extern const struct fileops socketops;
258 extern int maxfiles; /* kernel limit on number of open files */
259 extern int maxfilesperproc; /* per process limit on number of open files */
260
261 int fget(struct thread *td, int fd, const cap_rights_t *rightsp,
262 struct file **fpp);
263 int fget_mmap(struct thread *td, int fd, const cap_rights_t *rightsp,
264 vm_prot_t *maxprotp, struct file **fpp);
265 int fget_read(struct thread *td, int fd, const cap_rights_t *rightsp,
266 struct file **fpp);
267 int fget_write(struct thread *td, int fd, const cap_rights_t *rightsp,
268 struct file **fpp);
269 int fget_fcntl(struct thread *td, int fd, const cap_rights_t *rightsp,
270 int needfcntl, struct file **fpp);
271 int _fdrop(struct file *fp, struct thread *td);
272 int fget_remote(struct thread *td, struct proc *p, int fd, struct file **fpp);
273 int fget_remote_foreach(struct thread *td, struct proc *p,
274 int (*fn)(struct proc *, int, struct file *, void *), void *arg);
275
276 fo_rdwr_t invfo_rdwr;
277 fo_truncate_t invfo_truncate;
278 fo_ioctl_t invfo_ioctl;
279 fo_poll_t invfo_poll;
280 fo_kqfilter_t invfo_kqfilter;
281 fo_chmod_t invfo_chmod;
282 fo_chown_t invfo_chown;
283 fo_sendfile_t invfo_sendfile;
284 fo_stat_t vn_statfile;
285 fo_sendfile_t vn_sendfile;
286 fo_seek_t vn_seek;
287 fo_fill_kinfo_t vn_fill_kinfo;
288 fo_kqfilter_t vn_kqfilter_opath;
289 int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif);
290 int file_kcmp_generic(struct file *fp1, struct file *fp2, struct thread *td);
291
292 void finit(struct file *, u_int, short, void *, const struct fileops *);
293 void finit_vnode(struct file *, u_int, void *, const struct fileops *);
294 int fgetvp(struct thread *td, int fd, const cap_rights_t *rightsp,
295 struct vnode **vpp);
296 int fgetvp_exec(struct thread *td, int fd, const cap_rights_t *rightsp,
297 struct vnode **vpp);
298 int fgetvp_rights(struct thread *td, int fd, const cap_rights_t *needrightsp,
299 struct filecaps *havecaps, struct vnode **vpp);
300 int fgetvp_read(struct thread *td, int fd, const cap_rights_t *rightsp,
301 struct vnode **vpp);
302 int fgetvp_write(struct thread *td, int fd, const cap_rights_t *rightsp,
303 struct vnode **vpp);
304 int fgetvp_lookup_smr(struct nameidata *ndp, struct vnode **vpp, int *flagsp);
305 int fgetvp_lookup(struct nameidata *ndp, struct vnode **vpp);
306
307 static __inline __result_use_check bool
fhold(struct file * fp)308 fhold(struct file *fp)
309 {
310 return (refcount_acquire_checked(&fp->f_count));
311 }
312
313 #define fdrop(fp, td) ({ \
314 struct file *_fp; \
315 int _error; \
316 \
317 _error = 0; \
318 _fp = (fp); \
319 if (__predict_false(refcount_release(&_fp->f_count))) \
320 _error = _fdrop(_fp, td); \
321 _error; \
322 })
323
324 #define fdrop_close(fp, td) ({ \
325 struct file *_fp; \
326 int _error; \
327 \
328 _error = 0; \
329 _fp = (fp); \
330 if (__predict_true(refcount_release(&_fp->f_count))) \
331 _error = _fdrop(_fp, td); \
332 _error; \
333 })
334
335 static __inline fo_rdwr_t fo_read;
336 static __inline fo_rdwr_t fo_write;
337 static __inline fo_truncate_t fo_truncate;
338 static __inline fo_ioctl_t fo_ioctl;
339 static __inline fo_poll_t fo_poll;
340 static __inline fo_kqfilter_t fo_kqfilter;
341 static __inline fo_stat_t fo_stat;
342 static __inline fo_close_t fo_close;
343 static __inline fo_chmod_t fo_chmod;
344 static __inline fo_chown_t fo_chown;
345 static __inline fo_sendfile_t fo_sendfile;
346
347 static __inline int
fo_read(struct file * fp,struct uio * uio,struct ucred * active_cred,int flags,struct thread * td)348 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
349 int flags, struct thread *td)
350 {
351
352 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
353 }
354
355 static __inline int
fo_write(struct file * fp,struct uio * uio,struct ucred * active_cred,int flags,struct thread * td)356 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
357 int flags, struct thread *td)
358 {
359
360 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
361 }
362
363 static __inline int
fo_truncate(struct file * fp,off_t length,struct ucred * active_cred,struct thread * td)364 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
365 struct thread *td)
366 {
367
368 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
369 }
370
371 static __inline int
fo_ioctl(struct file * fp,u_long com,void * data,struct ucred * active_cred,struct thread * td)372 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
373 struct thread *td)
374 {
375
376 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
377 }
378
379 static __inline int
fo_poll(struct file * fp,int events,struct ucred * active_cred,struct thread * td)380 fo_poll(struct file *fp, int events, struct ucred *active_cred,
381 struct thread *td)
382 {
383
384 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
385 }
386
387 static __inline int
fo_stat(struct file * fp,struct stat * sb,struct ucred * active_cred)388 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred)
389 {
390
391 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred));
392 }
393
394 static __inline int
fo_close(struct file * fp,struct thread * td)395 fo_close(struct file *fp, struct thread *td)
396 {
397
398 return ((*fp->f_ops->fo_close)(fp, td));
399 }
400
401 static __inline int
fo_kqfilter(struct file * fp,struct knote * kn)402 fo_kqfilter(struct file *fp, struct knote *kn)
403 {
404
405 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
406 }
407
408 static __inline int
fo_chmod(struct file * fp,mode_t mode,struct ucred * active_cred,struct thread * td)409 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
410 struct thread *td)
411 {
412
413 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
414 }
415
416 static __inline int
fo_chown(struct file * fp,uid_t uid,gid_t gid,struct ucred * active_cred,struct thread * td)417 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
418 struct thread *td)
419 {
420
421 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
422 }
423
424 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)425 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
426 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
427 struct thread *td)
428 {
429
430 return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset,
431 nbytes, sent, flags, td));
432 }
433
434 static __inline int
fo_seek(struct file * fp,off_t offset,int whence,struct thread * td)435 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td)
436 {
437
438 return ((*fp->f_ops->fo_seek)(fp, offset, whence, td));
439 }
440
441 static __inline int
fo_fill_kinfo(struct file * fp,struct kinfo_file * kif,struct filedesc * fdp)442 fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
443 {
444
445 return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp));
446 }
447
448 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)449 fo_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size,
450 vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff,
451 struct thread *td)
452 {
453
454 if (fp->f_ops->fo_mmap == NULL)
455 return (ENODEV);
456 return ((*fp->f_ops->fo_mmap)(fp, map, addr, size, prot, cap_maxprot,
457 flags, foff, td));
458 }
459
460 static __inline int
fo_aio_queue(struct file * fp,struct kaiocb * job)461 fo_aio_queue(struct file *fp, struct kaiocb *job)
462 {
463
464 return ((*fp->f_ops->fo_aio_queue)(fp, job));
465 }
466
467 static __inline int
fo_add_seals(struct file * fp,int seals)468 fo_add_seals(struct file *fp, int seals)
469 {
470
471 if (fp->f_ops->fo_add_seals == NULL)
472 return (EINVAL);
473 return ((*fp->f_ops->fo_add_seals)(fp, seals));
474 }
475
476 static __inline int
fo_get_seals(struct file * fp,int * seals)477 fo_get_seals(struct file *fp, int *seals)
478 {
479
480 if (fp->f_ops->fo_get_seals == NULL)
481 return (EINVAL);
482 return ((*fp->f_ops->fo_get_seals)(fp, seals));
483 }
484
485 static __inline int
fo_fallocate(struct file * fp,off_t offset,off_t len,struct thread * td)486 fo_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td)
487 {
488
489 if (fp->f_ops->fo_fallocate == NULL)
490 return (ENODEV);
491 return ((*fp->f_ops->fo_fallocate)(fp, offset, len, td));
492 }
493
494 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)495 fo_fspacectl(struct file *fp, int cmd, off_t *offset, off_t *length,
496 int flags, struct ucred *active_cred, struct thread *td)
497 {
498
499 if (fp->f_ops->fo_fspacectl == NULL)
500 return (ENODEV);
501 return ((*fp->f_ops->fo_fspacectl)(fp, cmd, offset, length, flags,
502 active_cred, td));
503 }
504
505 static __inline int
fo_cmp(struct file * fp1,struct file * fp2,struct thread * td)506 fo_cmp(struct file *fp1, struct file *fp2, struct thread *td)
507 {
508
509 if (fp1->f_ops->fo_cmp == NULL)
510 return (ENODEV);
511 return ((*fp1->f_ops->fo_cmp)(fp1, fp2, td));
512 }
513
514 #endif /* _KERNEL */
515
516 #endif /* !SYS_FILE_H */
517