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