]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/kern/uipc_shm.c
Upgrade to version 9.8.0-P4
[FreeBSD/FreeBSD.git] / sys / kern / uipc_shm.c
1 /*-
2  * Copyright (c) 2006 Robert N. M. Watson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26
27 /*
28  * Support for shared swap-backed anonymous memory objects via
29  * shm_open(2) and shm_unlink(2).  While most of the implementation is
30  * here, vm_mmap.c contains mapping logic changes.
31  *
32  * TODO:
33  *
34  * (2) Need to export data to a userland tool via a sysctl.  Should ipcs(1)
35  *     and ipcrm(1) be expanded or should new tools to manage both POSIX
36  *     kernel semaphores and POSIX shared memory be written?
37  *
38  * (3) Add support for this file type to fstat(1).
39  *
40  * (4) Resource limits?  Does this need its own resource limits or are the
41  *     existing limits in mmap(2) sufficient?
42  *
43  * (5) Partial page truncation.  vnode_pager_setsize() will zero any parts
44  *     of a partially mapped page as a result of ftruncate(2)/truncate(2).
45  *     We can do the same (with the same pmap evil), but do we need to
46  *     worry about the bits on disk if the page is swapped out or will the
47  *     swapper zero the parts of a page that are invalid if the page is
48  *     swapped back in for us?
49  *
50  * (6) Add MAC support in mac_biba(4) and mac_mls(4).
51  *
52  * (7) Add a MAC check_create() hook for creating new named objects.
53  */
54
55 #include <sys/cdefs.h>
56 __FBSDID("$FreeBSD$");
57
58 #include "opt_capsicum.h"
59
60 #include <sys/param.h>
61 #include <sys/capability.h>
62 #include <sys/fcntl.h>
63 #include <sys/file.h>
64 #include <sys/filedesc.h>
65 #include <sys/fnv_hash.h>
66 #include <sys/kernel.h>
67 #include <sys/lock.h>
68 #include <sys/malloc.h>
69 #include <sys/mman.h>
70 #include <sys/mutex.h>
71 #include <sys/proc.h>
72 #include <sys/refcount.h>
73 #include <sys/resourcevar.h>
74 #include <sys/stat.h>
75 #include <sys/sysctl.h>
76 #include <sys/sysproto.h>
77 #include <sys/systm.h>
78 #include <sys/sx.h>
79 #include <sys/time.h>
80 #include <sys/vnode.h>
81
82 #include <security/mac/mac_framework.h>
83
84 #include <vm/vm.h>
85 #include <vm/vm_param.h>
86 #include <vm/pmap.h>
87 #include <vm/vm_map.h>
88 #include <vm/vm_object.h>
89 #include <vm/vm_page.h>
90 #include <vm/vm_pager.h>
91 #include <vm/swap_pager.h>
92
93 struct shm_mapping {
94         char            *sm_path;
95         Fnv32_t         sm_fnv;
96         struct shmfd    *sm_shmfd;
97         LIST_ENTRY(shm_mapping) sm_link;
98 };
99
100 static MALLOC_DEFINE(M_SHMFD, "shmfd", "shared memory file descriptor");
101 static LIST_HEAD(, shm_mapping) *shm_dictionary;
102 static struct sx shm_dict_lock;
103 static struct mtx shm_timestamp_lock;
104 static u_long shm_hash;
105
106 #define SHM_HASH(fnv)   (&shm_dictionary[(fnv) & shm_hash])
107
108 static int      shm_access(struct shmfd *shmfd, struct ucred *ucred, int flags);
109 static struct shmfd *shm_alloc(struct ucred *ucred, mode_t mode);
110 static void     shm_dict_init(void *arg);
111 static void     shm_drop(struct shmfd *shmfd);
112 static struct shmfd *shm_hold(struct shmfd *shmfd);
113 static void     shm_insert(char *path, Fnv32_t fnv, struct shmfd *shmfd);
114 static struct shmfd *shm_lookup(char *path, Fnv32_t fnv);
115 static int      shm_remove(char *path, Fnv32_t fnv, struct ucred *ucred);
116 static int      shm_dotruncate(struct shmfd *shmfd, off_t length);
117
118 static fo_rdwr_t        shm_read;
119 static fo_rdwr_t        shm_write;
120 static fo_truncate_t    shm_truncate;
121 static fo_ioctl_t       shm_ioctl;
122 static fo_poll_t        shm_poll;
123 static fo_kqfilter_t    shm_kqfilter;
124 static fo_stat_t        shm_stat;
125 static fo_close_t       shm_close;
126
127 /* File descriptor operations. */
128 static struct fileops shm_ops = {
129         .fo_read = shm_read,
130         .fo_write = shm_write,
131         .fo_truncate = shm_truncate,
132         .fo_ioctl = shm_ioctl,
133         .fo_poll = shm_poll,
134         .fo_kqfilter = shm_kqfilter,
135         .fo_stat = shm_stat,
136         .fo_close = shm_close,
137         .fo_flags = DFLAG_PASSABLE
138 };
139
140 FEATURE(posix_shm, "POSIX shared memory");
141
142 static int
143 shm_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
144     int flags, struct thread *td)
145 {
146
147         return (EOPNOTSUPP);
148 }
149
150 static int
151 shm_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
152     int flags, struct thread *td)
153 {
154
155         return (EOPNOTSUPP);
156 }
157
158 static int
159 shm_truncate(struct file *fp, off_t length, struct ucred *active_cred,
160     struct thread *td)
161 {
162         struct shmfd *shmfd;
163 #ifdef MAC
164         int error;
165 #endif
166
167         shmfd = fp->f_data;
168 #ifdef MAC
169         error = mac_posixshm_check_truncate(active_cred, fp->f_cred, shmfd);
170         if (error)
171                 return (error);
172 #endif
173         return (shm_dotruncate(shmfd, length));
174 }
175
176 static int
177 shm_ioctl(struct file *fp, u_long com, void *data,
178     struct ucred *active_cred, struct thread *td)
179 {
180
181         return (EOPNOTSUPP);
182 }
183
184 static int
185 shm_poll(struct file *fp, int events, struct ucred *active_cred,
186     struct thread *td)
187 {
188
189         return (EOPNOTSUPP);
190 }
191
192 static int
193 shm_kqfilter(struct file *fp, struct knote *kn)
194 {
195
196         return (EOPNOTSUPP);
197 }
198
199 static int
200 shm_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
201     struct thread *td)
202 {
203         struct shmfd *shmfd;
204 #ifdef MAC
205         int error;
206 #endif
207
208         shmfd = fp->f_data;
209
210 #ifdef MAC
211         error = mac_posixshm_check_stat(active_cred, fp->f_cred, shmfd);
212         if (error)
213                 return (error);
214 #endif
215         
216         /*
217          * Attempt to return sanish values for fstat() on a memory file
218          * descriptor.
219          */
220         bzero(sb, sizeof(*sb));
221         sb->st_mode = S_IFREG | shmfd->shm_mode;                /* XXX */
222         sb->st_blksize = PAGE_SIZE;
223         sb->st_size = shmfd->shm_size;
224         sb->st_blocks = (sb->st_size + sb->st_blksize - 1) / sb->st_blksize;
225         sb->st_atim = shmfd->shm_atime;
226         sb->st_ctim = shmfd->shm_ctime;
227         sb->st_mtim = shmfd->shm_mtime;
228         sb->st_birthtim = shmfd->shm_birthtime; 
229         sb->st_uid = shmfd->shm_uid;
230         sb->st_gid = shmfd->shm_gid;
231
232         return (0);
233 }
234
235 static int
236 shm_close(struct file *fp, struct thread *td)
237 {
238         struct shmfd *shmfd;
239
240         shmfd = fp->f_data;
241         fp->f_data = NULL;
242         shm_drop(shmfd);
243
244         return (0);
245 }
246
247 static int
248 shm_dotruncate(struct shmfd *shmfd, off_t length)
249 {
250         vm_object_t object;
251         vm_page_t m;
252         vm_pindex_t nobjsize;
253         vm_ooffset_t delta;
254
255         object = shmfd->shm_object;
256         VM_OBJECT_LOCK(object);
257         if (length == shmfd->shm_size) {
258                 VM_OBJECT_UNLOCK(object);
259                 return (0);
260         }
261         nobjsize = OFF_TO_IDX(length + PAGE_MASK);
262
263         /* Are we shrinking?  If so, trim the end. */
264         if (length < shmfd->shm_size) {
265                 delta = ptoa(object->size - nobjsize);
266
267                 /* Toss in memory pages. */
268                 if (nobjsize < object->size)
269                         vm_object_page_remove(object, nobjsize, object->size,
270                             0);
271
272                 /* Toss pages from swap. */
273                 if (object->type == OBJT_SWAP)
274                         swap_pager_freespace(object, nobjsize, delta);
275
276                 /* Free the swap accounted for shm */
277                 swap_release_by_cred(delta, object->cred);
278                 object->charge -= delta;
279
280                 /*
281                  * If the last page is partially mapped, then zero out
282                  * the garbage at the end of the page.  See comments
283                  * in vnode_pager_setsize() for more details.
284                  *
285                  * XXXJHB: This handles in memory pages, but what about
286                  * a page swapped out to disk?
287                  */
288                 if ((length & PAGE_MASK) &&
289                     (m = vm_page_lookup(object, OFF_TO_IDX(length))) != NULL &&
290                     m->valid != 0) {
291                         int base = (int)length & PAGE_MASK;
292                         int size = PAGE_SIZE - base;
293
294                         pmap_zero_page_area(m, base, size);
295
296                         /*
297                          * Update the valid bits to reflect the blocks that
298                          * have been zeroed.  Some of these valid bits may
299                          * have already been set.
300                          */
301                         vm_page_set_valid(m, base, size);
302
303                         /*
304                          * Round "base" to the next block boundary so that the
305                          * dirty bit for a partially zeroed block is not
306                          * cleared.
307                          */
308                         base = roundup2(base, DEV_BSIZE);
309
310                         vm_page_clear_dirty(m, base, PAGE_SIZE - base);
311                 } else if ((length & PAGE_MASK) &&
312                     __predict_false(object->cache != NULL)) {
313                         vm_page_cache_free(object, OFF_TO_IDX(length),
314                             nobjsize);
315                 }
316         } else {
317
318                 /* Attempt to reserve the swap */
319                 delta = ptoa(nobjsize - object->size);
320                 if (!swap_reserve_by_cred(delta, object->cred)) {
321                         VM_OBJECT_UNLOCK(object);
322                         return (ENOMEM);
323                 }
324                 object->charge += delta;
325         }
326         shmfd->shm_size = length;
327         mtx_lock(&shm_timestamp_lock);
328         vfs_timestamp(&shmfd->shm_ctime);
329         shmfd->shm_mtime = shmfd->shm_ctime;
330         mtx_unlock(&shm_timestamp_lock);
331         object->size = nobjsize;
332         VM_OBJECT_UNLOCK(object);
333         return (0);
334 }
335
336 /*
337  * shmfd object management including creation and reference counting
338  * routines.
339  */
340 static struct shmfd *
341 shm_alloc(struct ucred *ucred, mode_t mode)
342 {
343         struct shmfd *shmfd;
344
345         shmfd = malloc(sizeof(*shmfd), M_SHMFD, M_WAITOK | M_ZERO);
346         shmfd->shm_size = 0;
347         shmfd->shm_uid = ucred->cr_uid;
348         shmfd->shm_gid = ucred->cr_gid;
349         shmfd->shm_mode = mode;
350         shmfd->shm_object = vm_pager_allocate(OBJT_DEFAULT, NULL,
351             shmfd->shm_size, VM_PROT_DEFAULT, 0, ucred);
352         KASSERT(shmfd->shm_object != NULL, ("shm_create: vm_pager_allocate"));
353         VM_OBJECT_LOCK(shmfd->shm_object);
354         vm_object_clear_flag(shmfd->shm_object, OBJ_ONEMAPPING);
355         vm_object_set_flag(shmfd->shm_object, OBJ_NOSPLIT);
356         VM_OBJECT_UNLOCK(shmfd->shm_object);
357         vfs_timestamp(&shmfd->shm_birthtime);
358         shmfd->shm_atime = shmfd->shm_mtime = shmfd->shm_ctime =
359             shmfd->shm_birthtime;
360         refcount_init(&shmfd->shm_refs, 1);
361 #ifdef MAC
362         mac_posixshm_init(shmfd);
363         mac_posixshm_create(ucred, shmfd);
364 #endif
365
366         return (shmfd);
367 }
368
369 static struct shmfd *
370 shm_hold(struct shmfd *shmfd)
371 {
372
373         refcount_acquire(&shmfd->shm_refs);
374         return (shmfd);
375 }
376
377 static void
378 shm_drop(struct shmfd *shmfd)
379 {
380
381         if (refcount_release(&shmfd->shm_refs)) {
382 #ifdef MAC
383                 mac_posixshm_destroy(shmfd);
384 #endif
385                 vm_object_deallocate(shmfd->shm_object);
386                 free(shmfd, M_SHMFD);
387         }
388 }
389
390 /*
391  * Determine if the credentials have sufficient permissions for a
392  * specified combination of FREAD and FWRITE.
393  */
394 static int
395 shm_access(struct shmfd *shmfd, struct ucred *ucred, int flags)
396 {
397         accmode_t accmode;
398
399         accmode = 0;
400         if (flags & FREAD)
401                 accmode |= VREAD;
402         if (flags & FWRITE)
403                 accmode |= VWRITE;
404         return (vaccess(VREG, shmfd->shm_mode, shmfd->shm_uid, shmfd->shm_gid,
405             accmode, ucred, NULL));
406 }
407
408 /*
409  * Dictionary management.  We maintain an in-kernel dictionary to map
410  * paths to shmfd objects.  We use the FNV hash on the path to store
411  * the mappings in a hash table.
412  */
413 static void
414 shm_dict_init(void *arg)
415 {
416
417         mtx_init(&shm_timestamp_lock, "shm timestamps", NULL, MTX_DEF);
418         sx_init(&shm_dict_lock, "shm dictionary");
419         shm_dictionary = hashinit(1024, M_SHMFD, &shm_hash);
420 }
421 SYSINIT(shm_dict_init, SI_SUB_SYSV_SHM, SI_ORDER_ANY, shm_dict_init, NULL);
422
423 static struct shmfd *
424 shm_lookup(char *path, Fnv32_t fnv)
425 {
426         struct shm_mapping *map;
427
428         LIST_FOREACH(map, SHM_HASH(fnv), sm_link) {
429                 if (map->sm_fnv != fnv)
430                         continue;
431                 if (strcmp(map->sm_path, path) == 0)
432                         return (map->sm_shmfd);
433         }
434
435         return (NULL);
436 }
437
438 static void
439 shm_insert(char *path, Fnv32_t fnv, struct shmfd *shmfd)
440 {
441         struct shm_mapping *map;
442
443         map = malloc(sizeof(struct shm_mapping), M_SHMFD, M_WAITOK);
444         map->sm_path = path;
445         map->sm_fnv = fnv;
446         map->sm_shmfd = shm_hold(shmfd);
447         LIST_INSERT_HEAD(SHM_HASH(fnv), map, sm_link);
448 }
449
450 static int
451 shm_remove(char *path, Fnv32_t fnv, struct ucred *ucred)
452 {
453         struct shm_mapping *map;
454         int error;
455
456         LIST_FOREACH(map, SHM_HASH(fnv), sm_link) {
457                 if (map->sm_fnv != fnv)
458                         continue;
459                 if (strcmp(map->sm_path, path) == 0) {
460 #ifdef MAC
461                         error = mac_posixshm_check_unlink(ucred, map->sm_shmfd);
462                         if (error)
463                                 return (error);
464 #endif
465                         error = shm_access(map->sm_shmfd, ucred,
466                             FREAD | FWRITE);
467                         if (error)
468                                 return (error);
469                         LIST_REMOVE(map, sm_link);
470                         shm_drop(map->sm_shmfd);
471                         free(map->sm_path, M_SHMFD);
472                         free(map, M_SHMFD);
473                         return (0);
474                 }
475         }
476
477         return (ENOENT);
478 }
479
480 /* System calls. */
481 int
482 shm_open(struct thread *td, struct shm_open_args *uap)
483 {
484         struct filedesc *fdp;
485         struct shmfd *shmfd;
486         struct file *fp;
487         char *path;
488         Fnv32_t fnv;
489         mode_t cmode;
490         int fd, error;
491
492 #ifdef CAPABILITY_MODE
493         /*
494          * shm_open(2) is only allowed for anonymous objects.
495          */
496         if (IN_CAPABILITY_MODE(td) && (uap->path != SHM_ANON))
497                 return (ECAPMODE);
498 #endif
499
500         if ((uap->flags & O_ACCMODE) != O_RDONLY &&
501             (uap->flags & O_ACCMODE) != O_RDWR)
502                 return (EINVAL);
503
504         if ((uap->flags & ~(O_ACCMODE | O_CREAT | O_EXCL | O_TRUNC)) != 0)
505                 return (EINVAL);
506
507         fdp = td->td_proc->p_fd;
508         cmode = (uap->mode & ~fdp->fd_cmask) & ACCESSPERMS;
509
510         error = falloc(td, &fp, &fd, 0);
511         if (error)
512                 return (error);
513
514         /* A SHM_ANON path pointer creates an anonymous object. */
515         if (uap->path == SHM_ANON) {
516                 /* A read-only anonymous object is pointless. */
517                 if ((uap->flags & O_ACCMODE) == O_RDONLY) {
518                         fdclose(fdp, fp, fd, td);
519                         fdrop(fp, td);
520                         return (EINVAL);
521                 }
522                 shmfd = shm_alloc(td->td_ucred, cmode);
523         } else {
524                 path = malloc(MAXPATHLEN, M_SHMFD, M_WAITOK);
525                 error = copyinstr(uap->path, path, MAXPATHLEN, NULL);
526
527                 /* Require paths to start with a '/' character. */
528                 if (error == 0 && path[0] != '/')
529                         error = EINVAL;
530                 if (error) {
531                         fdclose(fdp, fp, fd, td);
532                         fdrop(fp, td);
533                         free(path, M_SHMFD);
534                         return (error);
535                 }
536
537                 fnv = fnv_32_str(path, FNV1_32_INIT);
538                 sx_xlock(&shm_dict_lock);
539                 shmfd = shm_lookup(path, fnv);
540                 if (shmfd == NULL) {
541                         /* Object does not yet exist, create it if requested. */
542                         if (uap->flags & O_CREAT) {
543                                 shmfd = shm_alloc(td->td_ucred, cmode);
544                                 shm_insert(path, fnv, shmfd);
545                         } else {
546                                 free(path, M_SHMFD);
547                                 error = ENOENT;
548                         }
549                 } else {
550                         /*
551                          * Object already exists, obtain a new
552                          * reference if requested and permitted.
553                          */
554                         free(path, M_SHMFD);
555                         if ((uap->flags & (O_CREAT | O_EXCL)) ==
556                             (O_CREAT | O_EXCL))
557                                 error = EEXIST;
558                         else {
559 #ifdef MAC
560                                 error = mac_posixshm_check_open(td->td_ucred,
561                                     shmfd);
562                                 if (error == 0)
563 #endif
564                                 error = shm_access(shmfd, td->td_ucred,
565                                     FFLAGS(uap->flags & O_ACCMODE));
566                         }
567
568                         /*
569                          * Truncate the file back to zero length if
570                          * O_TRUNC was specified and the object was
571                          * opened with read/write.
572                          */
573                         if (error == 0 &&
574                             (uap->flags & (O_ACCMODE | O_TRUNC)) ==
575                             (O_RDWR | O_TRUNC)) {
576 #ifdef MAC
577                                 error = mac_posixshm_check_truncate(
578                                         td->td_ucred, fp->f_cred, shmfd);
579                                 if (error == 0)
580 #endif
581                                         shm_dotruncate(shmfd, 0);
582                         }
583                         if (error == 0)
584                                 shm_hold(shmfd);
585                 }
586                 sx_xunlock(&shm_dict_lock);
587
588                 if (error) {
589                         fdclose(fdp, fp, fd, td);
590                         fdrop(fp, td);
591                         return (error);
592                 }
593         }
594
595         finit(fp, FFLAGS(uap->flags & O_ACCMODE), DTYPE_SHM, shmfd, &shm_ops);
596
597         FILEDESC_XLOCK(fdp);
598         if (fdp->fd_ofiles[fd] == fp)
599                 fdp->fd_ofileflags[fd] |= UF_EXCLOSE;
600         FILEDESC_XUNLOCK(fdp);
601         td->td_retval[0] = fd;
602         fdrop(fp, td);
603
604         return (0);
605 }
606
607 int
608 shm_unlink(struct thread *td, struct shm_unlink_args *uap)
609 {
610         char *path;
611         Fnv32_t fnv;
612         int error;
613
614         path = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
615         error = copyinstr(uap->path, path, MAXPATHLEN, NULL);
616         if (error) {
617                 free(path, M_TEMP);
618                 return (error);
619         }
620
621         fnv = fnv_32_str(path, FNV1_32_INIT);
622         sx_xlock(&shm_dict_lock);
623         error = shm_remove(path, fnv, td->td_ucred);
624         sx_xunlock(&shm_dict_lock);
625         free(path, M_TEMP);
626
627         return (error);
628 }
629
630 /*
631  * mmap() helper to validate mmap() requests against shm object state
632  * and give mmap() the vm_object to use for the mapping.
633  */
634 int
635 shm_mmap(struct shmfd *shmfd, vm_size_t objsize, vm_ooffset_t foff,
636     vm_object_t *obj)
637 {
638
639         /*
640          * XXXRW: This validation is probably insufficient, and subject to
641          * sign errors.  It should be fixed.
642          */
643         if (foff >= shmfd->shm_size ||
644             foff + objsize > round_page(shmfd->shm_size))
645                 return (EINVAL);
646
647         mtx_lock(&shm_timestamp_lock);
648         vfs_timestamp(&shmfd->shm_atime);
649         mtx_unlock(&shm_timestamp_lock);
650         vm_object_reference(shmfd->shm_object);
651         *obj = shmfd->shm_object;
652         return (0);
653 }