2 * linux/drivers/char/mem.c
4 * Copyright (C) 1991, 1992 Linus Torvalds
7 * Jan-11-1998, C. Scott Ananian <cananian@alumni.princeton.edu>
8 * Shared /dev/zero mmapping support, Feb 2000, Kanoj Sarcar <kanoj@sgi.com>
12 #include <linux/miscdevice.h>
13 #include <linux/slab.h>
14 #include <linux/vmalloc.h>
15 #include <linux/mman.h>
16 #include <linux/random.h>
17 #include <linux/init.h>
18 #include <linux/raw.h>
19 #include <linux/tty.h>
20 #include <linux/capability.h>
21 #include <linux/ptrace.h>
22 #include <linux/device.h>
23 #include <linux/highmem.h>
24 #include <linux/backing-dev.h>
25 #include <linux/splice.h>
26 #include <linux/pfn.h>
27 #include <linux/export.h>
29 #include <linux/aio.h>
31 #include <asm/uaccess.h>
34 # include <linux/efi.h>
37 #define DEVPORT_MINOR 4
39 static inline unsigned long size_inside_page(unsigned long start,
44 sz = PAGE_SIZE - (start & (PAGE_SIZE - 1));
49 #ifndef ARCH_HAS_VALID_PHYS_ADDR_RANGE
50 static inline int valid_phys_addr_range(phys_addr_t addr, size_t count)
52 return addr + count <= __pa(high_memory);
55 static inline int valid_mmap_phys_addr_range(unsigned long pfn, size_t size)
61 #ifdef CONFIG_STRICT_DEVMEM
62 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
64 u64 from = ((u64)pfn) << PAGE_SHIFT;
69 if (!devmem_is_allowed(pfn)) {
71 "Program %s tried to access /dev/mem between %Lx->%Lx.\n",
72 current->comm, from, to);
81 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
87 void __weak unxlate_dev_mem_ptr(unsigned long phys, void *addr)
92 * This funcion reads the *physical* memory. The f_pos points directly to the
95 static ssize_t read_mem(struct file *file, char __user *buf,
96 size_t count, loff_t *ppos)
98 phys_addr_t p = *ppos;
105 if (!valid_phys_addr_range(p, count))
108 #ifdef __ARCH_HAS_NO_PAGE_ZERO_MAPPED
109 /* we don't have page 0 mapped on sparc and m68k.. */
111 sz = size_inside_page(p, count);
113 if (clear_user(buf, sz))
124 unsigned long remaining;
126 sz = size_inside_page(p, count);
128 if (!range_is_allowed(p >> PAGE_SHIFT, count))
132 * On ia64 if a page has been mapped somewhere as uncached, then
133 * it must also be accessed uncached by the kernel or data
134 * corruption may occur.
136 ptr = xlate_dev_mem_ptr(p);
140 remaining = copy_to_user(buf, ptr, sz);
141 unxlate_dev_mem_ptr(p, ptr);
155 static ssize_t write_mem(struct file *file, const char __user *buf,
156 size_t count, loff_t *ppos)
158 phys_addr_t p = *ppos;
160 unsigned long copied;
166 if (!valid_phys_addr_range(p, count))
171 #ifdef __ARCH_HAS_NO_PAGE_ZERO_MAPPED
172 /* we don't have page 0 mapped on sparc and m68k.. */
174 sz = size_inside_page(p, count);
175 /* Hmm. Do something? */
184 sz = size_inside_page(p, count);
186 if (!range_is_allowed(p >> PAGE_SHIFT, sz))
190 * On ia64 if a page has been mapped somewhere as uncached, then
191 * it must also be accessed uncached by the kernel or data
192 * corruption may occur.
194 ptr = xlate_dev_mem_ptr(p);
201 copied = copy_from_user(ptr, buf, sz);
202 unxlate_dev_mem_ptr(p, ptr);
204 written += sz - copied;
220 int __weak phys_mem_access_prot_allowed(struct file *file,
221 unsigned long pfn, unsigned long size, pgprot_t *vma_prot)
226 #ifndef __HAVE_PHYS_MEM_ACCESS_PROT
229 * Architectures vary in how they handle caching for addresses
230 * outside of main memory.
233 #ifdef pgprot_noncached
234 static int uncached_access(struct file *file, phys_addr_t addr)
236 #if defined(CONFIG_IA64)
238 * On ia64, we ignore O_DSYNC because we cannot tolerate memory
241 return !(efi_mem_attributes(addr) & EFI_MEMORY_WB);
242 #elif defined(CONFIG_MIPS)
244 extern int __uncached_access(struct file *file,
247 return __uncached_access(file, addr);
251 * Accessing memory above the top the kernel knows about or through a
253 * that was marked O_DSYNC will be done non-cached.
255 if (file->f_flags & O_DSYNC)
257 return addr >= __pa(high_memory);
262 static pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
263 unsigned long size, pgprot_t vma_prot)
265 #ifdef pgprot_noncached
266 phys_addr_t offset = pfn << PAGE_SHIFT;
268 if (uncached_access(file, offset))
269 return pgprot_noncached(vma_prot);
276 static unsigned long get_unmapped_area_mem(struct file *file,
282 if (!valid_mmap_phys_addr_range(pgoff, len))
283 return (unsigned long) -EINVAL;
284 return pgoff << PAGE_SHIFT;
287 /* can't do an in-place private mapping if there's no MMU */
288 static inline int private_mapping_ok(struct vm_area_struct *vma)
290 return vma->vm_flags & VM_MAYSHARE;
293 #define get_unmapped_area_mem NULL
295 static inline int private_mapping_ok(struct vm_area_struct *vma)
301 static const struct vm_operations_struct mmap_mem_ops = {
302 #ifdef CONFIG_HAVE_IOREMAP_PROT
303 .access = generic_access_phys
307 static int mmap_mem(struct file *file, struct vm_area_struct *vma)
309 size_t size = vma->vm_end - vma->vm_start;
311 if (!valid_mmap_phys_addr_range(vma->vm_pgoff, size))
314 if (!private_mapping_ok(vma))
317 if (!range_is_allowed(vma->vm_pgoff, size))
320 if (!phys_mem_access_prot_allowed(file, vma->vm_pgoff, size,
324 vma->vm_page_prot = phys_mem_access_prot(file, vma->vm_pgoff,
328 vma->vm_ops = &mmap_mem_ops;
330 /* Remap-pfn-range will mark the range VM_IO */
331 if (remap_pfn_range(vma,
335 vma->vm_page_prot)) {
341 #ifdef CONFIG_DEVKMEM
342 static int mmap_kmem(struct file *file, struct vm_area_struct *vma)
346 /* Turn a kernel-virtual address into a physical page frame */
347 pfn = __pa((u64)vma->vm_pgoff << PAGE_SHIFT) >> PAGE_SHIFT;
350 * RED-PEN: on some architectures there is more mapped memory than
351 * available in mem_map which pfn_valid checks for. Perhaps should add a
354 * RED-PEN: vmalloc is not supported right now.
360 return mmap_mem(file, vma);
364 #ifdef CONFIG_DEVKMEM
366 * This function reads the *virtual* memory as seen by the kernel.
368 static ssize_t read_kmem(struct file *file, char __user *buf,
369 size_t count, loff_t *ppos)
371 unsigned long p = *ppos;
372 ssize_t low_count, read, sz;
373 char *kbuf; /* k-addr because vread() takes vmlist_lock rwlock */
377 if (p < (unsigned long) high_memory) {
379 if (count > (unsigned long)high_memory - p)
380 low_count = (unsigned long)high_memory - p;
382 #ifdef __ARCH_HAS_NO_PAGE_ZERO_MAPPED
383 /* we don't have page 0 mapped on sparc and m68k.. */
384 if (p < PAGE_SIZE && low_count > 0) {
385 sz = size_inside_page(p, low_count);
386 if (clear_user(buf, sz))
395 while (low_count > 0) {
396 sz = size_inside_page(p, low_count);
399 * On ia64 if a page has been mapped somewhere as
400 * uncached, then it must also be accessed uncached
401 * by the kernel or data corruption may occur
403 kbuf = xlate_dev_kmem_ptr((char *)p);
405 if (copy_to_user(buf, kbuf, sz))
416 kbuf = (char *)__get_free_page(GFP_KERNEL);
420 sz = size_inside_page(p, count);
421 if (!is_vmalloc_or_module_addr((void *)p)) {
425 sz = vread(kbuf, (char *)p, sz);
428 if (copy_to_user(buf, kbuf, sz)) {
437 free_page((unsigned long)kbuf);
440 return read ? read : err;
444 static ssize_t do_write_kmem(unsigned long p, const char __user *buf,
445 size_t count, loff_t *ppos)
448 unsigned long copied;
451 #ifdef __ARCH_HAS_NO_PAGE_ZERO_MAPPED
452 /* we don't have page 0 mapped on sparc and m68k.. */
454 sz = size_inside_page(p, count);
455 /* Hmm. Do something? */
466 sz = size_inside_page(p, count);
469 * On ia64 if a page has been mapped somewhere as uncached, then
470 * it must also be accessed uncached by the kernel or data
471 * corruption may occur.
473 ptr = xlate_dev_kmem_ptr((char *)p);
475 copied = copy_from_user(ptr, buf, sz);
477 written += sz - copied;
493 * This function writes to the *virtual* memory as seen by the kernel.
495 static ssize_t write_kmem(struct file *file, const char __user *buf,
496 size_t count, loff_t *ppos)
498 unsigned long p = *ppos;
501 char *kbuf; /* k-addr because vwrite() takes vmlist_lock rwlock */
504 if (p < (unsigned long) high_memory) {
505 unsigned long to_write = min_t(unsigned long, count,
506 (unsigned long)high_memory - p);
507 wrote = do_write_kmem(p, buf, to_write, ppos);
508 if (wrote != to_write)
516 kbuf = (char *)__get_free_page(GFP_KERNEL);
518 return wrote ? wrote : -ENOMEM;
520 unsigned long sz = size_inside_page(p, count);
523 if (!is_vmalloc_or_module_addr((void *)p)) {
527 n = copy_from_user(kbuf, buf, sz);
532 vwrite(kbuf, (char *)p, sz);
538 free_page((unsigned long)kbuf);
542 return virtr + wrote ? : err;
546 #ifdef CONFIG_DEVPORT
547 static ssize_t read_port(struct file *file, char __user *buf,
548 size_t count, loff_t *ppos)
550 unsigned long i = *ppos;
551 char __user *tmp = buf;
553 if (!access_ok(VERIFY_WRITE, buf, count))
555 while (count-- > 0 && i < 65536) {
556 if (__put_user(inb(i), tmp) < 0)
565 static ssize_t write_port(struct file *file, const char __user *buf,
566 size_t count, loff_t *ppos)
568 unsigned long i = *ppos;
569 const char __user *tmp = buf;
571 if (!access_ok(VERIFY_READ, buf, count))
573 while (count-- > 0 && i < 65536) {
575 if (__get_user(c, tmp)) {
589 static ssize_t read_null(struct file *file, char __user *buf,
590 size_t count, loff_t *ppos)
595 static ssize_t write_null(struct file *file, const char __user *buf,
596 size_t count, loff_t *ppos)
601 static ssize_t aio_read_null(struct kiocb *iocb, const struct iovec *iov,
602 unsigned long nr_segs, loff_t pos)
607 static ssize_t aio_write_null(struct kiocb *iocb, const struct iovec *iov,
608 unsigned long nr_segs, loff_t pos)
610 return iov_length(iov, nr_segs);
613 static int pipe_to_null(struct pipe_inode_info *info, struct pipe_buffer *buf,
614 struct splice_desc *sd)
619 static ssize_t splice_write_null(struct pipe_inode_info *pipe, struct file *out,
620 loff_t *ppos, size_t len, unsigned int flags)
622 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_null);
625 static ssize_t read_iter_zero(struct kiocb *iocb, struct iov_iter *iter)
629 while (iov_iter_count(iter)) {
630 size_t chunk = iov_iter_count(iter), n;
631 if (chunk > PAGE_SIZE)
632 chunk = PAGE_SIZE; /* Just for latency reasons */
633 n = iov_iter_zero(chunk, iter);
634 if (!n && iov_iter_count(iter))
635 return written ? written : -EFAULT;
637 if (signal_pending(current))
638 return written ? written : -ERESTARTSYS;
644 static int mmap_zero(struct file *file, struct vm_area_struct *vma)
649 if (vma->vm_flags & VM_SHARED)
650 return shmem_zero_setup(vma);
654 static ssize_t write_full(struct file *file, const char __user *buf,
655 size_t count, loff_t *ppos)
661 * Special lseek() function for /dev/null and /dev/zero. Most notably, you
662 * can fopen() both devices with "a" now. This was previously impossible.
665 static loff_t null_lseek(struct file *file, loff_t offset, int orig)
667 return file->f_pos = 0;
671 * The memory devices use the full 32/64 bits of the offset, and so we cannot
672 * check against negative addresses: they are ok. The return value is weird,
673 * though, in that case (0).
675 * also note that seeking relative to the "end of file" isn't supported:
676 * it has no meaning, so it returns -EINVAL.
678 static loff_t memory_lseek(struct file *file, loff_t offset, int orig)
682 mutex_lock(&file_inode(file)->i_mutex);
685 offset += file->f_pos;
687 /* to avoid userland mistaking f_pos=-9 as -EBADF=-9 */
688 if (IS_ERR_VALUE((unsigned long long)offset)) {
692 file->f_pos = offset;
694 force_successful_syscall_return();
699 mutex_unlock(&file_inode(file)->i_mutex);
703 static int open_port(struct inode *inode, struct file *filp)
705 return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
708 #define zero_lseek null_lseek
709 #define full_lseek null_lseek
710 #define write_zero write_null
711 #define aio_write_zero aio_write_null
712 #define open_mem open_port
713 #define open_kmem open_mem
715 static const struct file_operations mem_fops = {
716 .llseek = memory_lseek,
721 .get_unmapped_area = get_unmapped_area_mem,
724 #ifdef CONFIG_DEVKMEM
725 static const struct file_operations kmem_fops = {
726 .llseek = memory_lseek,
731 .get_unmapped_area = get_unmapped_area_mem,
735 static const struct file_operations null_fops = {
736 .llseek = null_lseek,
739 .aio_read = aio_read_null,
740 .aio_write = aio_write_null,
741 .splice_write = splice_write_null,
744 #ifdef CONFIG_DEVPORT
745 static const struct file_operations port_fops = {
746 .llseek = memory_lseek,
753 static const struct file_operations zero_fops = {
754 .llseek = zero_lseek,
755 .read = new_sync_read,
757 .read_iter = read_iter_zero,
758 .aio_write = aio_write_zero,
763 * capabilities for /dev/zero
764 * - permits private mappings, "copies" are taken of the source of zeros
765 * - no writeback happens
767 static struct backing_dev_info zero_bdi = {
769 .capabilities = BDI_CAP_MAP_COPY | BDI_CAP_NO_ACCT_AND_WRITEBACK,
772 static const struct file_operations full_fops = {
773 .llseek = full_lseek,
774 .read = new_sync_read,
775 .read_iter = read_iter_zero,
779 static const struct memdev {
782 const struct file_operations *fops;
783 struct backing_dev_info *dev_info;
785 [1] = { "mem", 0, &mem_fops, &directly_mappable_cdev_bdi },
786 #ifdef CONFIG_DEVKMEM
787 [2] = { "kmem", 0, &kmem_fops, &directly_mappable_cdev_bdi },
789 [3] = { "null", 0666, &null_fops, NULL },
790 #ifdef CONFIG_DEVPORT
791 [4] = { "port", 0, &port_fops, NULL },
793 [5] = { "zero", 0666, &zero_fops, &zero_bdi },
794 [7] = { "full", 0666, &full_fops, NULL },
795 [8] = { "random", 0666, &random_fops, NULL },
796 [9] = { "urandom", 0666, &urandom_fops, NULL },
798 [11] = { "kmsg", 0644, &kmsg_fops, NULL },
802 static int memory_open(struct inode *inode, struct file *filp)
805 const struct memdev *dev;
807 minor = iminor(inode);
808 if (minor >= ARRAY_SIZE(devlist))
811 dev = &devlist[minor];
815 filp->f_op = dev->fops;
817 filp->f_mapping->backing_dev_info = dev->dev_info;
819 /* Is /dev/mem or /dev/kmem ? */
820 if (dev->dev_info == &directly_mappable_cdev_bdi)
821 filp->f_mode |= FMODE_UNSIGNED_OFFSET;
824 return dev->fops->open(inode, filp);
829 static const struct file_operations memory_fops = {
831 .llseek = noop_llseek,
834 static char *mem_devnode(struct device *dev, umode_t *mode)
836 if (mode && devlist[MINOR(dev->devt)].mode)
837 *mode = devlist[MINOR(dev->devt)].mode;
841 static struct class *mem_class;
843 static int __init chr_dev_init(void)
848 err = bdi_init(&zero_bdi);
852 if (register_chrdev(MEM_MAJOR, "mem", &memory_fops))
853 printk("unable to get major %d for memory devs\n", MEM_MAJOR);
855 mem_class = class_create(THIS_MODULE, "mem");
856 if (IS_ERR(mem_class))
857 return PTR_ERR(mem_class);
859 mem_class->devnode = mem_devnode;
860 for (minor = 1; minor < ARRAY_SIZE(devlist); minor++) {
861 if (!devlist[minor].name)
867 if ((minor == DEVPORT_MINOR) && !arch_has_dev_port())
870 device_create(mem_class, NULL, MKDEV(MEM_MAJOR, minor),
871 NULL, devlist[minor].name);
877 fs_initcall(chr_dev_init);