2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006, 2011, 2016-2017 Robert N. M. Watson
7 * Portions of this software were developed by BAE Systems, the University of
8 * Cambridge Computer Laboratory, and Memorial University under DARPA/AFRL
9 * contract FA8650-15-C-7558 ("CADETS"), as part of the DARPA Transparent
10 * Computing (TC) research program.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Support for shared swap-backed anonymous memory objects via
36 * shm_open(2), shm_rename(2), and shm_unlink(2).
37 * While most of the implementation is here, vm_mmap.c contains
38 * mapping logic changes.
40 * posixshmcontrol(1) allows users to inspect the state of the memory
41 * objects. Per-uid swap resource limit controls total amount of
42 * memory that user can consume for anonymous objects, including
46 #include <sys/cdefs.h>
47 __FBSDID("$FreeBSD$");
49 #include "opt_capsicum.h"
50 #include "opt_ktrace.h"
52 #include <sys/param.h>
53 #include <sys/capsicum.h>
55 #include <sys/fcntl.h>
57 #include <sys/filedesc.h>
58 #include <sys/filio.h>
59 #include <sys/fnv_hash.h>
60 #include <sys/kernel.h>
61 #include <sys/limits.h>
63 #include <sys/signal.h>
65 #include <sys/ktrace.h>
67 #include <sys/malloc.h>
69 #include <sys/mutex.h>
72 #include <sys/refcount.h>
73 #include <sys/resourcevar.h>
74 #include <sys/rwlock.h>
77 #include <sys/syscallsubr.h>
78 #include <sys/sysctl.h>
79 #include <sys/sysproto.h>
80 #include <sys/systm.h>
83 #include <sys/vnode.h>
84 #include <sys/unistd.h>
87 #include <security/audit/audit.h>
88 #include <security/mac/mac_framework.h>
91 #include <vm/vm_param.h>
93 #include <vm/vm_extern.h>
94 #include <vm/vm_map.h>
95 #include <vm/vm_kern.h>
96 #include <vm/vm_object.h>
97 #include <vm/vm_page.h>
98 #include <vm/vm_pageout.h>
99 #include <vm/vm_pager.h>
100 #include <vm/swap_pager.h>
105 struct shmfd *sm_shmfd;
106 LIST_ENTRY(shm_mapping) sm_link;
109 static MALLOC_DEFINE(M_SHMFD, "shmfd", "shared memory file descriptor");
110 static LIST_HEAD(, shm_mapping) *shm_dictionary;
111 static struct sx shm_dict_lock;
112 static struct mtx shm_timestamp_lock;
113 static u_long shm_hash;
114 static struct unrhdr64 shm_ino_unr;
115 static dev_t shm_dev_ino;
117 #define SHM_HASH(fnv) (&shm_dictionary[(fnv) & shm_hash])
119 static void shm_init(void *arg);
120 static void shm_insert(char *path, Fnv32_t fnv, struct shmfd *shmfd);
121 static struct shmfd *shm_lookup(char *path, Fnv32_t fnv);
122 static int shm_remove(char *path, Fnv32_t fnv, struct ucred *ucred);
123 static int shm_dotruncate_locked(struct shmfd *shmfd, off_t length,
125 static int shm_copyin_path(struct thread *td, const char *userpath_in,
128 static fo_rdwr_t shm_read;
129 static fo_rdwr_t shm_write;
130 static fo_truncate_t shm_truncate;
131 static fo_ioctl_t shm_ioctl;
132 static fo_stat_t shm_stat;
133 static fo_close_t shm_close;
134 static fo_chmod_t shm_chmod;
135 static fo_chown_t shm_chown;
136 static fo_seek_t shm_seek;
137 static fo_fill_kinfo_t shm_fill_kinfo;
138 static fo_mmap_t shm_mmap;
139 static fo_get_seals_t shm_get_seals;
140 static fo_add_seals_t shm_add_seals;
141 static fo_fallocate_t shm_fallocate;
143 /* File descriptor operations. */
144 struct fileops shm_ops = {
146 .fo_write = shm_write,
147 .fo_truncate = shm_truncate,
148 .fo_ioctl = shm_ioctl,
149 .fo_poll = invfo_poll,
150 .fo_kqfilter = invfo_kqfilter,
152 .fo_close = shm_close,
153 .fo_chmod = shm_chmod,
154 .fo_chown = shm_chown,
155 .fo_sendfile = vn_sendfile,
157 .fo_fill_kinfo = shm_fill_kinfo,
159 .fo_get_seals = shm_get_seals,
160 .fo_add_seals = shm_add_seals,
161 .fo_fallocate = shm_fallocate,
162 .fo_flags = DFLAG_PASSABLE | DFLAG_SEEKABLE
165 FEATURE(posix_shm, "POSIX shared memory");
168 uiomove_object_page(vm_object_t obj, size_t len, struct uio *uio)
173 int error, offset, rv;
175 idx = OFF_TO_IDX(uio->uio_offset);
176 offset = uio->uio_offset & PAGE_MASK;
177 tlen = MIN(PAGE_SIZE - offset, len);
179 rv = vm_page_grab_valid_unlocked(&m, obj, idx,
180 VM_ALLOC_SBUSY | VM_ALLOC_IGN_SBUSY | VM_ALLOC_NOCREAT);
181 if (rv == VM_PAGER_OK)
185 * Read I/O without either a corresponding resident page or swap
186 * page: use zero_region. This is intended to avoid instantiating
187 * pages on read from a sparse region.
189 VM_OBJECT_WLOCK(obj);
190 m = vm_page_lookup(obj, idx);
191 if (uio->uio_rw == UIO_READ && m == NULL &&
192 !vm_pager_has_page(obj, idx, NULL, NULL)) {
193 VM_OBJECT_WUNLOCK(obj);
194 return (uiomove(__DECONST(void *, zero_region), tlen, uio));
198 * Although the tmpfs vnode lock is held here, it is
199 * nonetheless safe to sleep waiting for a free page. The
200 * pageout daemon does not need to acquire the tmpfs vnode
201 * lock to page out tobj's pages because tobj is a OBJT_SWAP
204 rv = vm_page_grab_valid(&m, obj, idx,
205 VM_ALLOC_NORMAL | VM_ALLOC_SBUSY | VM_ALLOC_IGN_SBUSY);
206 if (rv != VM_PAGER_OK) {
207 VM_OBJECT_WUNLOCK(obj);
208 printf("uiomove_object: vm_obj %p idx %jd pager error %d\n",
212 VM_OBJECT_WUNLOCK(obj);
215 error = uiomove_fromphys(&m, offset, tlen, uio);
216 if (uio->uio_rw == UIO_WRITE && error == 0)
217 vm_page_set_dirty(m);
225 uiomove_object(vm_object_t obj, off_t obj_size, struct uio *uio)
232 while ((resid = uio->uio_resid) > 0) {
233 if (obj_size <= uio->uio_offset)
235 len = MIN(obj_size - uio->uio_offset, resid);
238 error = uiomove_object_page(obj, len, uio);
239 if (error != 0 || resid == uio->uio_resid)
246 shm_seek(struct file *fp, off_t offset, int whence, struct thread *td)
253 foffset = foffset_lock(fp, 0);
258 (offset > 0 && foffset > OFF_MAX - offset)) {
265 if (offset > 0 && shmfd->shm_size > OFF_MAX - offset) {
269 offset += shmfd->shm_size;
277 if (offset < 0 || offset > shmfd->shm_size)
280 td->td_uretoff.tdu_off = offset;
282 foffset_unlock(fp, offset, error != 0 ? FOF_NOUPDATE : 0);
287 shm_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
288 int flags, struct thread *td)
296 error = mac_posixshm_check_read(active_cred, fp->f_cred, shmfd);
300 foffset_lock_uio(fp, uio, flags);
301 rl_cookie = rangelock_rlock(&shmfd->shm_rl, uio->uio_offset,
302 uio->uio_offset + uio->uio_resid, &shmfd->shm_mtx);
303 error = uiomove_object(shmfd->shm_object, shmfd->shm_size, uio);
304 rangelock_unlock(&shmfd->shm_rl, rl_cookie, &shmfd->shm_mtx);
305 foffset_unlock_uio(fp, uio, flags);
310 shm_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
311 int flags, struct thread *td)
319 error = mac_posixshm_check_write(active_cred, fp->f_cred, shmfd);
323 foffset_lock_uio(fp, uio, flags);
324 if ((flags & FOF_OFFSET) == 0) {
325 rl_cookie = rangelock_wlock(&shmfd->shm_rl, 0, OFF_MAX,
328 rl_cookie = rangelock_wlock(&shmfd->shm_rl, uio->uio_offset,
329 uio->uio_offset + uio->uio_resid, &shmfd->shm_mtx);
331 if ((shmfd->shm_seals & F_SEAL_WRITE) != 0)
334 error = uiomove_object(shmfd->shm_object, shmfd->shm_size, uio);
335 rangelock_unlock(&shmfd->shm_rl, rl_cookie, &shmfd->shm_mtx);
336 foffset_unlock_uio(fp, uio, flags);
341 shm_truncate(struct file *fp, off_t length, struct ucred *active_cred,
351 error = mac_posixshm_check_truncate(active_cred, fp->f_cred, shmfd);
355 return (shm_dotruncate(shmfd, length));
359 shm_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
367 * Allow fcntl(fd, F_SETFL, O_NONBLOCK) to work,
368 * just like it would on an unlinked regular file
377 shm_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
388 error = mac_posixshm_check_stat(active_cred, fp->f_cred, shmfd);
394 * Attempt to return sanish values for fstat() on a memory file
397 bzero(sb, sizeof(*sb));
398 sb->st_blksize = PAGE_SIZE;
399 sb->st_size = shmfd->shm_size;
400 sb->st_blocks = howmany(sb->st_size, sb->st_blksize);
401 mtx_lock(&shm_timestamp_lock);
402 sb->st_atim = shmfd->shm_atime;
403 sb->st_ctim = shmfd->shm_ctime;
404 sb->st_mtim = shmfd->shm_mtime;
405 sb->st_birthtim = shmfd->shm_birthtime;
406 sb->st_mode = S_IFREG | shmfd->shm_mode; /* XXX */
407 sb->st_uid = shmfd->shm_uid;
408 sb->st_gid = shmfd->shm_gid;
409 mtx_unlock(&shm_timestamp_lock);
410 sb->st_dev = shm_dev_ino;
411 sb->st_ino = shmfd->shm_ino;
412 sb->st_nlink = shmfd->shm_object->ref_count;
418 shm_close(struct file *fp, struct thread *td)
430 shm_copyin_path(struct thread *td, const char *userpath_in, char **path_out) {
436 path = malloc(MAXPATHLEN, M_SHMFD, M_WAITOK);
437 pr_path = td->td_ucred->cr_prison->pr_path;
439 /* Construct a full pathname for jailed callers. */
440 pr_pathlen = strcmp(pr_path, "/") ==
441 0 ? 0 : strlcpy(path, pr_path, MAXPATHLEN);
442 error = copyinstr(userpath_in, path + pr_pathlen,
443 MAXPATHLEN - pr_pathlen, NULL);
448 if (KTRPOINT(curthread, KTR_NAMEI))
452 /* Require paths to start with a '/' character. */
453 if (path[pr_pathlen] != '/') {
468 shm_dotruncate_locked(struct shmfd *shmfd, off_t length, void *rl_cookie)
472 vm_pindex_t idx, nobjsize;
476 KASSERT(length >= 0, ("shm_dotruncate: length < 0"));
477 object = shmfd->shm_object;
478 VM_OBJECT_ASSERT_WLOCKED(object);
479 rangelock_cookie_assert(rl_cookie, RA_WLOCKED);
480 if (length == shmfd->shm_size)
482 nobjsize = OFF_TO_IDX(length + PAGE_MASK);
484 /* Are we shrinking? If so, trim the end. */
485 if (length < shmfd->shm_size) {
486 if ((shmfd->shm_seals & F_SEAL_SHRINK) != 0)
490 * Disallow any requests to shrink the size if this
491 * object is mapped into the kernel.
493 if (shmfd->shm_kmappings > 0)
497 * Zero the truncated part of the last page.
499 base = length & PAGE_MASK;
501 idx = OFF_TO_IDX(length);
503 m = vm_page_grab(object, idx, VM_ALLOC_NOCREAT);
505 MPASS(vm_page_all_valid(m));
506 } else if (vm_pager_has_page(object, idx, NULL, NULL)) {
507 m = vm_page_alloc(object, idx,
508 VM_ALLOC_NORMAL | VM_ALLOC_WAITFAIL);
511 vm_object_pip_add(object, 1);
512 VM_OBJECT_WUNLOCK(object);
513 rv = vm_pager_get_pages(object, &m, 1, NULL,
515 VM_OBJECT_WLOCK(object);
516 vm_object_pip_wakeup(object);
517 if (rv == VM_PAGER_OK) {
519 * Since the page was not resident,
520 * and therefore not recently
521 * accessed, immediately enqueue it
522 * for asynchronous laundering. The
523 * current operation is not regarded
529 VM_OBJECT_WUNLOCK(object);
534 pmap_zero_page_area(m, base, PAGE_SIZE - base);
535 KASSERT(vm_page_all_valid(m),
536 ("shm_dotruncate: page %p is invalid", m));
537 vm_page_set_dirty(m);
541 delta = IDX_TO_OFF(object->size - nobjsize);
543 /* Toss in memory pages. */
544 if (nobjsize < object->size)
545 vm_object_page_remove(object, nobjsize, object->size,
548 /* Toss pages from swap. */
549 if (object->type == OBJT_SWAP)
550 swap_pager_freespace(object, nobjsize, delta);
552 /* Free the swap accounted for shm */
553 swap_release_by_cred(delta, object->cred);
554 object->charge -= delta;
556 if ((shmfd->shm_seals & F_SEAL_GROW) != 0)
559 /* Try to reserve additional swap space. */
560 delta = IDX_TO_OFF(nobjsize - object->size);
561 if (!swap_reserve_by_cred(delta, object->cred))
563 object->charge += delta;
565 shmfd->shm_size = length;
566 mtx_lock(&shm_timestamp_lock);
567 vfs_timestamp(&shmfd->shm_ctime);
568 shmfd->shm_mtime = shmfd->shm_ctime;
569 mtx_unlock(&shm_timestamp_lock);
570 object->size = nobjsize;
575 shm_dotruncate(struct shmfd *shmfd, off_t length)
580 rl_cookie = rangelock_wlock(&shmfd->shm_rl, 0, OFF_MAX,
582 VM_OBJECT_WLOCK(shmfd->shm_object);
583 error = shm_dotruncate_locked(shmfd, length, rl_cookie);
584 VM_OBJECT_WUNLOCK(shmfd->shm_object);
585 rangelock_unlock(&shmfd->shm_rl, rl_cookie, &shmfd->shm_mtx);
590 * shmfd object management including creation and reference counting
594 shm_alloc(struct ucred *ucred, mode_t mode)
598 shmfd = malloc(sizeof(*shmfd), M_SHMFD, M_WAITOK | M_ZERO);
600 shmfd->shm_uid = ucred->cr_uid;
601 shmfd->shm_gid = ucred->cr_gid;
602 shmfd->shm_mode = mode;
603 shmfd->shm_object = vm_pager_allocate(OBJT_SWAP, NULL,
604 shmfd->shm_size, VM_PROT_DEFAULT, 0, ucred);
605 KASSERT(shmfd->shm_object != NULL, ("shm_create: vm_pager_allocate"));
606 vfs_timestamp(&shmfd->shm_birthtime);
607 shmfd->shm_atime = shmfd->shm_mtime = shmfd->shm_ctime =
608 shmfd->shm_birthtime;
609 shmfd->shm_ino = alloc_unr64(&shm_ino_unr);
610 refcount_init(&shmfd->shm_refs, 1);
611 mtx_init(&shmfd->shm_mtx, "shmrl", NULL, MTX_DEF);
612 rangelock_init(&shmfd->shm_rl);
614 mac_posixshm_init(shmfd);
615 mac_posixshm_create(ucred, shmfd);
622 shm_hold(struct shmfd *shmfd)
625 refcount_acquire(&shmfd->shm_refs);
630 shm_drop(struct shmfd *shmfd)
633 if (refcount_release(&shmfd->shm_refs)) {
635 mac_posixshm_destroy(shmfd);
637 rangelock_destroy(&shmfd->shm_rl);
638 mtx_destroy(&shmfd->shm_mtx);
639 vm_object_deallocate(shmfd->shm_object);
640 free(shmfd, M_SHMFD);
645 * Determine if the credentials have sufficient permissions for a
646 * specified combination of FREAD and FWRITE.
649 shm_access(struct shmfd *shmfd, struct ucred *ucred, int flags)
659 mtx_lock(&shm_timestamp_lock);
660 error = vaccess(VREG, shmfd->shm_mode, shmfd->shm_uid, shmfd->shm_gid,
661 accmode, ucred, NULL);
662 mtx_unlock(&shm_timestamp_lock);
667 * Dictionary management. We maintain an in-kernel dictionary to map
668 * paths to shmfd objects. We use the FNV hash on the path to store
669 * the mappings in a hash table.
675 mtx_init(&shm_timestamp_lock, "shm timestamps", NULL, MTX_DEF);
676 sx_init(&shm_dict_lock, "shm dictionary");
677 shm_dictionary = hashinit(1024, M_SHMFD, &shm_hash);
678 new_unrhdr64(&shm_ino_unr, 1);
679 shm_dev_ino = devfs_alloc_cdp_inode();
680 KASSERT(shm_dev_ino > 0, ("shm dev inode not initialized"));
682 SYSINIT(shm_init, SI_SUB_SYSV_SHM, SI_ORDER_ANY, shm_init, NULL);
684 static struct shmfd *
685 shm_lookup(char *path, Fnv32_t fnv)
687 struct shm_mapping *map;
689 LIST_FOREACH(map, SHM_HASH(fnv), sm_link) {
690 if (map->sm_fnv != fnv)
692 if (strcmp(map->sm_path, path) == 0)
693 return (map->sm_shmfd);
700 shm_insert(char *path, Fnv32_t fnv, struct shmfd *shmfd)
702 struct shm_mapping *map;
704 map = malloc(sizeof(struct shm_mapping), M_SHMFD, M_WAITOK);
707 map->sm_shmfd = shm_hold(shmfd);
708 shmfd->shm_path = path;
709 LIST_INSERT_HEAD(SHM_HASH(fnv), map, sm_link);
713 shm_remove(char *path, Fnv32_t fnv, struct ucred *ucred)
715 struct shm_mapping *map;
718 LIST_FOREACH(map, SHM_HASH(fnv), sm_link) {
719 if (map->sm_fnv != fnv)
721 if (strcmp(map->sm_path, path) == 0) {
723 error = mac_posixshm_check_unlink(ucred, map->sm_shmfd);
727 error = shm_access(map->sm_shmfd, ucred,
731 map->sm_shmfd->shm_path = NULL;
732 LIST_REMOVE(map, sm_link);
733 shm_drop(map->sm_shmfd);
734 free(map->sm_path, M_SHMFD);
744 kern_shm_open2(struct thread *td, const char *userpath, int flags, mode_t mode,
745 int shmflags, struct filecaps *fcaps, const char *name __unused)
747 struct filedesc *fdp;
754 int error, fd, initial_seals;
756 if ((shmflags & ~SHM_ALLOW_SEALING) != 0)
759 initial_seals = F_SEAL_SEAL;
760 if ((shmflags & SHM_ALLOW_SEALING) != 0)
761 initial_seals &= ~F_SEAL_SEAL;
763 #ifdef CAPABILITY_MODE
765 * shm_open(2) is only allowed for anonymous objects.
767 if (IN_CAPABILITY_MODE(td) && (userpath != SHM_ANON))
771 AUDIT_ARG_FFLAGS(flags);
772 AUDIT_ARG_MODE(mode);
774 if ((flags & O_ACCMODE) != O_RDONLY && (flags & O_ACCMODE) != O_RDWR)
777 if ((flags & ~(O_ACCMODE | O_CREAT | O_EXCL | O_TRUNC | O_CLOEXEC)) != 0)
781 * Currently only F_SEAL_SEAL may be set when creating or opening shmfd.
782 * If the decision is made later to allow additional seals, care must be
783 * taken below to ensure that the seals are properly set if the shmfd
784 * already existed -- this currently assumes that only F_SEAL_SEAL can
785 * be set and doesn't take further precautions to ensure the validity of
786 * the seals being added with respect to current mappings.
788 if ((initial_seals & ~F_SEAL_SEAL) != 0)
791 fdp = td->td_proc->p_fd;
792 cmode = (mode & ~fdp->fd_cmask) & ACCESSPERMS;
795 * shm_open(2) created shm should always have O_CLOEXEC set, as mandated
796 * by POSIX. We allow it to be unset here so that an in-kernel
797 * interface may be written as a thin layer around shm, optionally not
798 * setting CLOEXEC. For shm_open(2), O_CLOEXEC is set unconditionally
799 * in sys_shm_open() to keep this implementation compliant.
801 error = falloc_caps(td, &fp, &fd, flags & O_CLOEXEC, fcaps);
805 /* A SHM_ANON path pointer creates an anonymous object. */
806 if (userpath == SHM_ANON) {
807 /* A read-only anonymous object is pointless. */
808 if ((flags & O_ACCMODE) == O_RDONLY) {
813 shmfd = shm_alloc(td->td_ucred, cmode);
814 shmfd->shm_seals = initial_seals;
816 error = shm_copyin_path(td, userpath, &path);
823 AUDIT_ARG_UPATH1_CANON(path);
824 fnv = fnv_32_str(path, FNV1_32_INIT);
825 sx_xlock(&shm_dict_lock);
826 shmfd = shm_lookup(path, fnv);
828 /* Object does not yet exist, create it if requested. */
829 if (flags & O_CREAT) {
831 error = mac_posixshm_check_create(td->td_ucred,
835 shmfd = shm_alloc(td->td_ucred, cmode);
836 shmfd->shm_seals = initial_seals;
837 shm_insert(path, fnv, shmfd);
846 rl_cookie = rangelock_wlock(&shmfd->shm_rl, 0, OFF_MAX,
850 * kern_shm_open() likely shouldn't ever error out on
851 * trying to set a seal that already exists, unlike
852 * F_ADD_SEALS. This would break terribly as
853 * shm_open(2) actually sets F_SEAL_SEAL to maintain
854 * historical behavior where the underlying file could
857 initial_seals &= ~shmfd->shm_seals;
860 * Object already exists, obtain a new
861 * reference if requested and permitted.
866 * initial_seals can't set additional seals if we've
867 * already been set F_SEAL_SEAL. If F_SEAL_SEAL is set,
868 * then we've already removed that one from
869 * initial_seals. This is currently redundant as we
870 * only allow setting F_SEAL_SEAL at creation time, but
871 * it's cheap to check and decreases the effort required
872 * to allow additional seals.
874 if ((shmfd->shm_seals & F_SEAL_SEAL) != 0 &&
877 else if ((flags & (O_CREAT | O_EXCL)) ==
882 error = mac_posixshm_check_open(td->td_ucred,
883 shmfd, FFLAGS(flags & O_ACCMODE));
886 error = shm_access(shmfd, td->td_ucred,
887 FFLAGS(flags & O_ACCMODE));
891 * Truncate the file back to zero length if
892 * O_TRUNC was specified and the object was
893 * opened with read/write.
896 (flags & (O_ACCMODE | O_TRUNC)) ==
897 (O_RDWR | O_TRUNC)) {
898 VM_OBJECT_WLOCK(shmfd->shm_object);
900 error = mac_posixshm_check_truncate(
901 td->td_ucred, fp->f_cred, shmfd);
904 error = shm_dotruncate_locked(shmfd, 0,
906 VM_OBJECT_WUNLOCK(shmfd->shm_object);
910 * Currently we only allow F_SEAL_SEAL to be
911 * set initially. As noted above, this would
912 * need to be reworked should that change.
914 shmfd->shm_seals |= initial_seals;
917 rangelock_unlock(&shmfd->shm_rl, rl_cookie,
920 sx_xunlock(&shm_dict_lock);
929 finit(fp, FFLAGS(flags & O_ACCMODE), DTYPE_SHM, shmfd, &shm_ops);
931 td->td_retval[0] = fd;
938 #ifdef COMPAT_FREEBSD12
940 freebsd12_shm_open(struct thread *td, struct freebsd12_shm_open_args *uap)
943 return (kern_shm_open(td, uap->path, uap->flags | O_CLOEXEC,
949 sys_shm_unlink(struct thread *td, struct shm_unlink_args *uap)
955 error = shm_copyin_path(td, uap->path, &path);
959 AUDIT_ARG_UPATH1_CANON(path);
960 fnv = fnv_32_str(path, FNV1_32_INIT);
961 sx_xlock(&shm_dict_lock);
962 error = shm_remove(path, fnv, td->td_ucred);
963 sx_xunlock(&shm_dict_lock);
970 sys_shm_rename(struct thread *td, struct shm_rename_args *uap)
972 char *path_from = NULL, *path_to = NULL;
973 Fnv32_t fnv_from, fnv_to;
974 struct shmfd *fd_from;
980 AUDIT_ARG_FFLAGS(flags);
983 * Make sure the user passed only valid flags.
984 * If you add a new flag, please add a new term here.
987 SHM_RENAME_NOREPLACE |
995 * EXCHANGE and NOREPLACE don't quite make sense together. Let's
996 * force the user to choose one or the other.
998 if ((flags & SHM_RENAME_NOREPLACE) != 0 &&
999 (flags & SHM_RENAME_EXCHANGE) != 0) {
1004 /* Renaming to or from anonymous makes no sense */
1005 if (uap->path_from == SHM_ANON || uap->path_to == SHM_ANON) {
1010 error = shm_copyin_path(td, uap->path_from, &path_from);
1014 error = shm_copyin_path(td, uap->path_to, &path_to);
1018 AUDIT_ARG_UPATH1_CANON(path_from);
1019 AUDIT_ARG_UPATH2_CANON(path_to);
1021 /* Rename with from/to equal is a no-op */
1022 if (strcmp(path_from, path_to) == 0)
1025 fnv_from = fnv_32_str(path_from, FNV1_32_INIT);
1026 fnv_to = fnv_32_str(path_to, FNV1_32_INIT);
1028 sx_xlock(&shm_dict_lock);
1030 fd_from = shm_lookup(path_from, fnv_from);
1031 if (fd_from == NULL) {
1036 fd_to = shm_lookup(path_to, fnv_to);
1037 if ((flags & SHM_RENAME_NOREPLACE) != 0 && fd_to != NULL) {
1043 * Unconditionally prevents shm_remove from invalidating the 'from'
1047 error = shm_remove(path_from, fnv_from, td->td_ucred);
1050 * One of my assumptions failed if ENOENT (e.g. locking didn't
1053 KASSERT(error != ENOENT, ("Our shm disappeared during shm_rename: %s",
1061 * If we are exchanging, we need to ensure the shm_remove below
1062 * doesn't invalidate the dest shm's state.
1064 if ((flags & SHM_RENAME_EXCHANGE) != 0 && fd_to != NULL)
1068 * NOTE: if path_to is not already in the hash, c'est la vie;
1069 * it simply means we have nothing already at path_to to unlink.
1070 * That is the ENOENT case.
1072 * If we somehow don't have access to unlink this guy, but
1073 * did for the shm at path_from, then relink the shm to path_from
1074 * and abort with EACCES.
1076 * All other errors: that is weird; let's relink and abort the
1079 error = shm_remove(path_to, fnv_to, td->td_ucred);
1080 if (error != 0 && error != ENOENT) {
1081 shm_insert(path_from, fnv_from, fd_from);
1083 /* Don't free path_from now, since the hash references it */
1090 shm_insert(path_to, fnv_to, fd_from);
1092 /* Don't free path_to now, since the hash references it */
1095 /* We kept a ref when we removed, and incremented again in insert */
1097 KASSERT(fd_from->shm_refs > 0, ("Expected >0 refs; got: %d\n",
1098 fd_from->shm_refs));
1100 if ((flags & SHM_RENAME_EXCHANGE) != 0 && fd_to != NULL) {
1101 shm_insert(path_from, fnv_from, fd_to);
1104 KASSERT(fd_to->shm_refs > 0, ("Expected >0 refs; got: %d\n",
1109 sx_xunlock(&shm_dict_lock);
1112 free(path_from, M_SHMFD);
1113 free(path_to, M_SHMFD);
1118 shm_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t objsize,
1119 vm_prot_t prot, vm_prot_t cap_maxprot, int flags,
1120 vm_ooffset_t foff, struct thread *td)
1122 struct shmfd *shmfd;
1129 maxprot = VM_PROT_NONE;
1131 rl_cookie = rangelock_rlock(&shmfd->shm_rl, 0, objsize,
1133 /* FREAD should always be set. */
1134 if ((fp->f_flag & FREAD) != 0)
1135 maxprot |= VM_PROT_EXECUTE | VM_PROT_READ;
1138 * If FWRITE's set, we can allow VM_PROT_WRITE unless it's a shared
1139 * mapping with a write seal applied. Private mappings are always
1142 if ((flags & MAP_SHARED) == 0) {
1143 cap_maxprot |= VM_PROT_WRITE;
1144 maxprot |= VM_PROT_WRITE;
1147 if ((fp->f_flag & FWRITE) != 0 &&
1148 (shmfd->shm_seals & F_SEAL_WRITE) == 0)
1149 maxprot |= VM_PROT_WRITE;
1152 * Any mappings from a writable descriptor may be upgraded to
1153 * VM_PROT_WRITE with mprotect(2), unless a write-seal was
1154 * applied between the open and subsequent mmap(2). We want to
1155 * reject application of a write seal as long as any such
1156 * mapping exists so that the seal cannot be trivially bypassed.
1158 writecnt = (maxprot & VM_PROT_WRITE) != 0;
1159 if (!writecnt && (prot & VM_PROT_WRITE) != 0) {
1164 maxprot &= cap_maxprot;
1166 /* See comment in vn_mmap(). */
1169 objsize > OFF_MAX ||
1171 foff < 0 || foff > OFF_MAX - objsize) {
1177 error = mac_posixshm_check_mmap(td->td_ucred, shmfd, prot, flags);
1182 mtx_lock(&shm_timestamp_lock);
1183 vfs_timestamp(&shmfd->shm_atime);
1184 mtx_unlock(&shm_timestamp_lock);
1185 vm_object_reference(shmfd->shm_object);
1188 vm_pager_update_writecount(shmfd->shm_object, 0, objsize);
1189 error = vm_mmap_object(map, addr, objsize, prot, maxprot, flags,
1190 shmfd->shm_object, foff, writecnt, td);
1193 vm_pager_release_writecount(shmfd->shm_object, 0,
1195 vm_object_deallocate(shmfd->shm_object);
1198 rangelock_unlock(&shmfd->shm_rl, rl_cookie, &shmfd->shm_mtx);
1203 shm_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
1206 struct shmfd *shmfd;
1211 mtx_lock(&shm_timestamp_lock);
1213 * SUSv4 says that x bits of permission need not be affected.
1214 * Be consistent with our shm_open there.
1217 error = mac_posixshm_check_setmode(active_cred, shmfd, mode);
1221 error = vaccess(VREG, shmfd->shm_mode, shmfd->shm_uid,
1222 shmfd->shm_gid, VADMIN, active_cred, NULL);
1225 shmfd->shm_mode = mode & ACCESSPERMS;
1227 mtx_unlock(&shm_timestamp_lock);
1232 shm_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
1235 struct shmfd *shmfd;
1240 mtx_lock(&shm_timestamp_lock);
1242 error = mac_posixshm_check_setowner(active_cred, shmfd, uid, gid);
1246 if (uid == (uid_t)-1)
1247 uid = shmfd->shm_uid;
1248 if (gid == (gid_t)-1)
1249 gid = shmfd->shm_gid;
1250 if (((uid != shmfd->shm_uid && uid != active_cred->cr_uid) ||
1251 (gid != shmfd->shm_gid && !groupmember(gid, active_cred))) &&
1252 (error = priv_check_cred(active_cred, PRIV_VFS_CHOWN)))
1254 shmfd->shm_uid = uid;
1255 shmfd->shm_gid = gid;
1257 mtx_unlock(&shm_timestamp_lock);
1262 * Helper routines to allow the backing object of a shared memory file
1263 * descriptor to be mapped in the kernel.
1266 shm_map(struct file *fp, size_t size, off_t offset, void **memp)
1268 struct shmfd *shmfd;
1269 vm_offset_t kva, ofs;
1273 if (fp->f_type != DTYPE_SHM)
1276 obj = shmfd->shm_object;
1277 VM_OBJECT_WLOCK(obj);
1279 * XXXRW: This validation is probably insufficient, and subject to
1280 * sign errors. It should be fixed.
1282 if (offset >= shmfd->shm_size ||
1283 offset + size > round_page(shmfd->shm_size)) {
1284 VM_OBJECT_WUNLOCK(obj);
1288 shmfd->shm_kmappings++;
1289 vm_object_reference_locked(obj);
1290 VM_OBJECT_WUNLOCK(obj);
1292 /* Map the object into the kernel_map and wire it. */
1293 kva = vm_map_min(kernel_map);
1294 ofs = offset & PAGE_MASK;
1295 offset = trunc_page(offset);
1296 size = round_page(size + ofs);
1297 rv = vm_map_find(kernel_map, obj, offset, &kva, size, 0,
1298 VMFS_OPTIMAL_SPACE, VM_PROT_READ | VM_PROT_WRITE,
1299 VM_PROT_READ | VM_PROT_WRITE, 0);
1300 if (rv == KERN_SUCCESS) {
1301 rv = vm_map_wire(kernel_map, kva, kva + size,
1302 VM_MAP_WIRE_SYSTEM | VM_MAP_WIRE_NOHOLES);
1303 if (rv == KERN_SUCCESS) {
1304 *memp = (void *)(kva + ofs);
1307 vm_map_remove(kernel_map, kva, kva + size);
1309 vm_object_deallocate(obj);
1311 /* On failure, drop our mapping reference. */
1312 VM_OBJECT_WLOCK(obj);
1313 shmfd->shm_kmappings--;
1314 VM_OBJECT_WUNLOCK(obj);
1316 return (vm_mmap_to_errno(rv));
1320 * We require the caller to unmap the entire entry. This allows us to
1321 * safely decrement shm_kmappings when a mapping is removed.
1324 shm_unmap(struct file *fp, void *mem, size_t size)
1326 struct shmfd *shmfd;
1327 vm_map_entry_t entry;
1328 vm_offset_t kva, ofs;
1336 if (fp->f_type != DTYPE_SHM)
1339 kva = (vm_offset_t)mem;
1340 ofs = kva & PAGE_MASK;
1341 kva = trunc_page(kva);
1342 size = round_page(size + ofs);
1344 rv = vm_map_lookup(&map, kva, VM_PROT_READ | VM_PROT_WRITE, &entry,
1345 &obj, &pindex, &prot, &wired);
1346 if (rv != KERN_SUCCESS)
1348 if (entry->start != kva || entry->end != kva + size) {
1349 vm_map_lookup_done(map, entry);
1352 vm_map_lookup_done(map, entry);
1353 if (obj != shmfd->shm_object)
1355 vm_map_remove(map, kva, kva + size);
1356 VM_OBJECT_WLOCK(obj);
1357 KASSERT(shmfd->shm_kmappings > 0, ("shm_unmap: object not mapped"));
1358 shmfd->shm_kmappings--;
1359 VM_OBJECT_WUNLOCK(obj);
1364 shm_fill_kinfo_locked(struct shmfd *shmfd, struct kinfo_file *kif, bool list)
1366 const char *path, *pr_path;
1370 sx_assert(&shm_dict_lock, SA_LOCKED);
1371 kif->kf_type = KF_TYPE_SHM;
1372 kif->kf_un.kf_file.kf_file_mode = S_IFREG | shmfd->shm_mode;
1373 kif->kf_un.kf_file.kf_file_size = shmfd->shm_size;
1374 if (shmfd->shm_path != NULL) {
1375 if (shmfd->shm_path != NULL) {
1376 path = shmfd->shm_path;
1377 pr_path = curthread->td_ucred->cr_prison->pr_path;
1378 if (strcmp(pr_path, "/") != 0) {
1379 /* Return the jail-rooted pathname. */
1380 pr_pathlen = strlen(pr_path);
1381 visible = strncmp(path, pr_path, pr_pathlen)
1382 == 0 && path[pr_pathlen] == '/';
1383 if (list && !visible)
1388 strlcpy(kif->kf_path, path, sizeof(kif->kf_path));
1395 shm_fill_kinfo(struct file *fp, struct kinfo_file *kif,
1396 struct filedesc *fdp __unused)
1400 sx_slock(&shm_dict_lock);
1401 res = shm_fill_kinfo_locked(fp->f_data, kif, false);
1402 sx_sunlock(&shm_dict_lock);
1407 shm_add_seals(struct file *fp, int seals)
1409 struct shmfd *shmfd;
1411 vm_ooffset_t writemappings;
1416 rl_cookie = rangelock_wlock(&shmfd->shm_rl, 0, OFF_MAX,
1419 /* Even already-set seals should result in EPERM. */
1420 if ((shmfd->shm_seals & F_SEAL_SEAL) != 0) {
1424 nseals = seals & ~shmfd->shm_seals;
1425 if ((nseals & F_SEAL_WRITE) != 0) {
1427 * The rangelock above prevents writable mappings from being
1428 * added after we've started applying seals. The RLOCK here
1429 * is to avoid torn reads on ILP32 arches as unmapping/reducing
1430 * writemappings will be done without a rangelock.
1432 VM_OBJECT_RLOCK(shmfd->shm_object);
1433 writemappings = shmfd->shm_object->un_pager.swp.writemappings;
1434 VM_OBJECT_RUNLOCK(shmfd->shm_object);
1435 /* kmappings are also writable */
1436 if (writemappings > 0) {
1441 shmfd->shm_seals |= nseals;
1443 rangelock_unlock(&shmfd->shm_rl, rl_cookie, &shmfd->shm_mtx);
1448 shm_get_seals(struct file *fp, int *seals)
1450 struct shmfd *shmfd;
1453 *seals = shmfd->shm_seals;
1458 shm_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td)
1461 struct shmfd *shmfd;
1465 /* This assumes that the caller already checked for overflow. */
1468 size = offset + len;
1471 * Just grab the rangelock for the range that we may be attempting to
1472 * grow, rather than blocking read/write for regions we won't be
1473 * touching while this (potential) resize is in progress. Other
1474 * attempts to resize the shmfd will have to take a write lock from 0 to
1475 * OFF_MAX, so this being potentially beyond the current usable range of
1476 * the shmfd is not necessarily a concern. If other mechanisms are
1477 * added to grow a shmfd, this may need to be re-evaluated.
1479 rl_cookie = rangelock_wlock(&shmfd->shm_rl, offset, size,
1481 if (size > shmfd->shm_size) {
1482 VM_OBJECT_WLOCK(shmfd->shm_object);
1483 error = shm_dotruncate_locked(shmfd, size, rl_cookie);
1484 VM_OBJECT_WUNLOCK(shmfd->shm_object);
1486 rangelock_unlock(&shmfd->shm_rl, rl_cookie, &shmfd->shm_mtx);
1487 /* Translate to posix_fallocate(2) return value as needed. */
1488 if (error == ENOMEM)
1494 sysctl_posix_shm_list(SYSCTL_HANDLER_ARGS)
1496 struct shm_mapping *shmm;
1498 struct kinfo_file kif;
1503 sbuf_new_for_sysctl(&sb, NULL, sizeof(struct kinfo_file) * 5, req);
1504 sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
1507 sx_slock(&shm_dict_lock);
1508 for (i = 0; i < shm_hash + 1; i++) {
1509 LIST_FOREACH(shmm, &shm_dictionary[i], sm_link) {
1510 error = shm_fill_kinfo_locked(shmm->sm_shmfd,
1517 if (req->oldptr != NULL &&
1518 kif.kf_structsize + curlen > req->oldlen)
1520 error = sbuf_bcat(&sb, &kif, kif.kf_structsize) == 0 ?
1524 curlen += kif.kf_structsize;
1527 sx_sunlock(&shm_dict_lock);
1528 error2 = sbuf_finish(&sb);
1530 return (error != 0 ? error : error2);
1533 SYSCTL_PROC(_kern_ipc, OID_AUTO, posix_shm_list,
1534 CTLFLAG_RD | CTLFLAG_MPSAFE | CTLTYPE_OPAQUE,
1535 NULL, 0, sysctl_posix_shm_list, "",
1539 kern_shm_open(struct thread *td, const char *path, int flags, mode_t mode,
1540 struct filecaps *caps)
1543 return (kern_shm_open2(td, path, flags, mode, 0, caps, NULL));
1547 * This version of the shm_open() interface leaves CLOEXEC behavior up to the
1548 * caller, and libc will enforce it for the traditional shm_open() call. This
1549 * allows other consumers, like memfd_create(), to opt-in for CLOEXEC. This
1550 * interface also includes a 'name' argument that is currently unused, but could
1551 * potentially be exported later via some interface for debugging purposes.
1552 * From the kernel's perspective, it is optional. Individual consumers like
1553 * memfd_create() may require it in order to be compatible with other systems
1554 * implementing the same function.
1557 sys_shm_open2(struct thread *td, struct shm_open2_args *uap)
1560 return (kern_shm_open2(td, uap->path, uap->flags, uap->mode,
1561 uap->shmflags, NULL, uap->name));