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