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/bootmem.h>
26 #include <linux/splice.h>
27 #include <linux/pfn.h>
28 #include <linux/export.h>
30 #include <linux/aio.h>
32 #include <asm/uaccess.h>
35 # include <linux/efi.h>
38 #define DEVPORT_MINOR 4
40 static inline unsigned long size_inside_page(unsigned long start,
45 sz = PAGE_SIZE - (start & (PAGE_SIZE - 1));
50 #ifndef ARCH_HAS_VALID_PHYS_ADDR_RANGE
51 static inline int valid_phys_addr_range(phys_addr_t addr, size_t count)
53 return addr + count <= __pa(high_memory);
56 static inline int valid_mmap_phys_addr_range(unsigned long pfn, size_t size)
62 #ifdef CONFIG_STRICT_DEVMEM
63 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
65 u64 from = ((u64)pfn) << PAGE_SHIFT;
70 if (!devmem_is_allowed(pfn)) {
72 "Program %s tried to access /dev/mem between %Lx->%Lx.\n",
73 current->comm, from, to);
82 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
88 void __weak unxlate_dev_mem_ptr(unsigned long phys, void *addr)
93 * This funcion reads the *physical* memory. The f_pos points directly to the
96 static ssize_t read_mem(struct file *file, char __user *buf,
97 size_t count, loff_t *ppos)
99 phys_addr_t p = *ppos;
103 if (!valid_phys_addr_range(p, count))
106 #ifdef __ARCH_HAS_NO_PAGE_ZERO_MAPPED
107 /* we don't have page 0 mapped on sparc and m68k.. */
109 sz = size_inside_page(p, count);
111 if (clear_user(buf, sz))
122 unsigned long remaining;
124 sz = size_inside_page(p, count);
126 if (!range_is_allowed(p >> PAGE_SHIFT, count))
130 * On ia64 if a page has been mapped somewhere as uncached, then
131 * it must also be accessed uncached by the kernel or data
132 * corruption may occur.
134 ptr = xlate_dev_mem_ptr(p);
138 remaining = copy_to_user(buf, ptr, sz);
139 unxlate_dev_mem_ptr(p, ptr);
153 static ssize_t write_mem(struct file *file, const char __user *buf,
154 size_t count, loff_t *ppos)
156 phys_addr_t p = *ppos;
158 unsigned long copied;
161 if (!valid_phys_addr_range(p, count))
166 #ifdef __ARCH_HAS_NO_PAGE_ZERO_MAPPED
167 /* we don't have page 0 mapped on sparc and m68k.. */
169 sz = size_inside_page(p, count);
170 /* Hmm. Do something? */
179 sz = size_inside_page(p, count);
181 if (!range_is_allowed(p >> PAGE_SHIFT, sz))
185 * On ia64 if a page has been mapped somewhere as uncached, then
186 * it must also be accessed uncached by the kernel or data
187 * corruption may occur.
189 ptr = xlate_dev_mem_ptr(p);
196 copied = copy_from_user(ptr, buf, sz);
197 unxlate_dev_mem_ptr(p, ptr);
199 written += sz - copied;
215 int __weak phys_mem_access_prot_allowed(struct file *file,
216 unsigned long pfn, unsigned long size, pgprot_t *vma_prot)
221 #ifndef __HAVE_PHYS_MEM_ACCESS_PROT
224 * Architectures vary in how they handle caching for addresses
225 * outside of main memory.
228 #ifdef pgprot_noncached
229 static int uncached_access(struct file *file, phys_addr_t addr)
231 #if defined(CONFIG_IA64)
233 * On ia64, we ignore O_DSYNC because we cannot tolerate memory
236 return !(efi_mem_attributes(addr) & EFI_MEMORY_WB);
237 #elif defined(CONFIG_MIPS)
239 extern int __uncached_access(struct file *file,
242 return __uncached_access(file, addr);
246 * Accessing memory above the top the kernel knows about or through a
248 * that was marked O_DSYNC will be done non-cached.
250 if (file->f_flags & O_DSYNC)
252 return addr >= __pa(high_memory);
257 static pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
258 unsigned long size, pgprot_t vma_prot)
260 #ifdef pgprot_noncached
261 phys_addr_t offset = pfn << PAGE_SHIFT;
263 if (uncached_access(file, offset))
264 return pgprot_noncached(vma_prot);
271 static unsigned long get_unmapped_area_mem(struct file *file,
277 if (!valid_mmap_phys_addr_range(pgoff, len))
278 return (unsigned long) -EINVAL;
279 return pgoff << PAGE_SHIFT;
282 /* can't do an in-place private mapping if there's no MMU */
283 static inline int private_mapping_ok(struct vm_area_struct *vma)
285 return vma->vm_flags & VM_MAYSHARE;
288 #define get_unmapped_area_mem NULL
290 static inline int private_mapping_ok(struct vm_area_struct *vma)
296 static const struct vm_operations_struct mmap_mem_ops = {
297 #ifdef CONFIG_HAVE_IOREMAP_PROT
298 .access = generic_access_phys
302 static int mmap_mem(struct file *file, struct vm_area_struct *vma)
304 size_t size = vma->vm_end - vma->vm_start;
306 if (!valid_mmap_phys_addr_range(vma->vm_pgoff, size))
309 if (!private_mapping_ok(vma))
312 if (!range_is_allowed(vma->vm_pgoff, size))
315 if (!phys_mem_access_prot_allowed(file, vma->vm_pgoff, size,
319 vma->vm_page_prot = phys_mem_access_prot(file, vma->vm_pgoff,
323 vma->vm_ops = &mmap_mem_ops;
325 /* Remap-pfn-range will mark the range VM_IO */
326 if (remap_pfn_range(vma,
330 vma->vm_page_prot)) {
336 #ifdef CONFIG_DEVKMEM
337 static int mmap_kmem(struct file *file, struct vm_area_struct *vma)
341 /* Turn a kernel-virtual address into a physical page frame */
342 pfn = __pa((u64)vma->vm_pgoff << PAGE_SHIFT) >> PAGE_SHIFT;
345 * RED-PEN: on some architectures there is more mapped memory than
346 * available in mem_map which pfn_valid checks for. Perhaps should add a
349 * RED-PEN: vmalloc is not supported right now.
355 return mmap_mem(file, vma);
359 #ifdef CONFIG_DEVKMEM
361 * This function reads the *virtual* memory as seen by the kernel.
363 static ssize_t read_kmem(struct file *file, char __user *buf,
364 size_t count, loff_t *ppos)
366 unsigned long p = *ppos;
367 ssize_t low_count, read, sz;
368 char *kbuf; /* k-addr because vread() takes vmlist_lock rwlock */
372 if (p < (unsigned long) high_memory) {
374 if (count > (unsigned long)high_memory - p)
375 low_count = (unsigned long)high_memory - p;
377 #ifdef __ARCH_HAS_NO_PAGE_ZERO_MAPPED
378 /* we don't have page 0 mapped on sparc and m68k.. */
379 if (p < PAGE_SIZE && low_count > 0) {
380 sz = size_inside_page(p, low_count);
381 if (clear_user(buf, sz))
390 while (low_count > 0) {
391 sz = size_inside_page(p, low_count);
394 * On ia64 if a page has been mapped somewhere as
395 * uncached, then it must also be accessed uncached
396 * by the kernel or data corruption may occur
398 kbuf = xlate_dev_kmem_ptr((char *)p);
400 if (copy_to_user(buf, kbuf, sz))
411 kbuf = (char *)__get_free_page(GFP_KERNEL);
415 sz = size_inside_page(p, count);
416 if (!is_vmalloc_or_module_addr((void *)p)) {
420 sz = vread(kbuf, (char *)p, sz);
423 if (copy_to_user(buf, kbuf, sz)) {
432 free_page((unsigned long)kbuf);
435 return read ? read : err;
439 static ssize_t do_write_kmem(unsigned long p, const char __user *buf,
440 size_t count, loff_t *ppos)
443 unsigned long copied;
446 #ifdef __ARCH_HAS_NO_PAGE_ZERO_MAPPED
447 /* we don't have page 0 mapped on sparc and m68k.. */
449 sz = size_inside_page(p, count);
450 /* Hmm. Do something? */
461 sz = size_inside_page(p, count);
464 * On ia64 if a page has been mapped somewhere as uncached, then
465 * it must also be accessed uncached by the kernel or data
466 * corruption may occur.
468 ptr = xlate_dev_kmem_ptr((char *)p);
470 copied = copy_from_user(ptr, buf, sz);
472 written += sz - copied;
488 * This function writes to the *virtual* memory as seen by the kernel.
490 static ssize_t write_kmem(struct file *file, const char __user *buf,
491 size_t count, loff_t *ppos)
493 unsigned long p = *ppos;
496 char *kbuf; /* k-addr because vwrite() takes vmlist_lock rwlock */
499 if (p < (unsigned long) high_memory) {
500 unsigned long to_write = min_t(unsigned long, count,
501 (unsigned long)high_memory - p);
502 wrote = do_write_kmem(p, buf, to_write, ppos);
503 if (wrote != to_write)
511 kbuf = (char *)__get_free_page(GFP_KERNEL);
513 return wrote ? wrote : -ENOMEM;
515 unsigned long sz = size_inside_page(p, count);
518 if (!is_vmalloc_or_module_addr((void *)p)) {
522 n = copy_from_user(kbuf, buf, sz);
527 vwrite(kbuf, (char *)p, sz);
533 free_page((unsigned long)kbuf);
537 return virtr + wrote ? : err;
541 #ifdef CONFIG_DEVPORT
542 static ssize_t read_port(struct file *file, char __user *buf,
543 size_t count, loff_t *ppos)
545 unsigned long i = *ppos;
546 char __user *tmp = buf;
548 if (!access_ok(VERIFY_WRITE, buf, count))
550 while (count-- > 0 && i < 65536) {
551 if (__put_user(inb(i), tmp) < 0)
560 static ssize_t write_port(struct file *file, const char __user *buf,
561 size_t count, loff_t *ppos)
563 unsigned long i = *ppos;
564 const char __user *tmp = buf;
566 if (!access_ok(VERIFY_READ, buf, count))
568 while (count-- > 0 && i < 65536) {
570 if (__get_user(c, tmp)) {
584 static ssize_t read_null(struct file *file, char __user *buf,
585 size_t count, loff_t *ppos)
590 static ssize_t write_null(struct file *file, const char __user *buf,
591 size_t count, loff_t *ppos)
596 static ssize_t aio_read_null(struct kiocb *iocb, const struct iovec *iov,
597 unsigned long nr_segs, loff_t pos)
602 static ssize_t aio_write_null(struct kiocb *iocb, const struct iovec *iov,
603 unsigned long nr_segs, loff_t pos)
605 return iov_length(iov, nr_segs);
608 static int pipe_to_null(struct pipe_inode_info *info, struct pipe_buffer *buf,
609 struct splice_desc *sd)
614 static ssize_t splice_write_null(struct pipe_inode_info *pipe, struct file *out,
615 loff_t *ppos, size_t len, unsigned int flags)
617 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_null);
620 static ssize_t read_zero(struct file *file, char __user *buf,
621 size_t count, loff_t *ppos)
628 if (!access_ok(VERIFY_WRITE, buf, count))
633 unsigned long unwritten;
634 size_t chunk = count;
636 if (chunk > PAGE_SIZE)
637 chunk = PAGE_SIZE; /* Just for latency reasons */
638 unwritten = __clear_user(buf, chunk);
639 written += chunk - unwritten;
642 if (signal_pending(current))
643 return written ? written : -ERESTARTSYS;
648 return written ? written : -EFAULT;
651 static ssize_t aio_read_zero(struct kiocb *iocb, const struct iovec *iov,
652 unsigned long nr_segs, loff_t pos)
658 for (i = 0; i < nr_segs; i++) {
659 ret = read_zero(iocb->ki_filp, iov[i].iov_base, iov[i].iov_len,
666 return written ? written : -EFAULT;
669 static int mmap_zero(struct file *file, struct vm_area_struct *vma)
674 if (vma->vm_flags & VM_SHARED)
675 return shmem_zero_setup(vma);
679 static ssize_t write_full(struct file *file, const char __user *buf,
680 size_t count, loff_t *ppos)
686 * Special lseek() function for /dev/null and /dev/zero. Most notably, you
687 * can fopen() both devices with "a" now. This was previously impossible.
690 static loff_t null_lseek(struct file *file, loff_t offset, int orig)
692 return file->f_pos = 0;
696 * The memory devices use the full 32/64 bits of the offset, and so we cannot
697 * check against negative addresses: they are ok. The return value is weird,
698 * though, in that case (0).
700 * also note that seeking relative to the "end of file" isn't supported:
701 * it has no meaning, so it returns -EINVAL.
703 static loff_t memory_lseek(struct file *file, loff_t offset, int orig)
707 mutex_lock(&file_inode(file)->i_mutex);
710 offset += file->f_pos;
712 /* to avoid userland mistaking f_pos=-9 as -EBADF=-9 */
713 if (IS_ERR_VALUE((unsigned long long)offset)) {
717 file->f_pos = offset;
719 force_successful_syscall_return();
724 mutex_unlock(&file_inode(file)->i_mutex);
728 static int open_port(struct inode *inode, struct file *filp)
730 return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
733 #define zero_lseek null_lseek
734 #define full_lseek null_lseek
735 #define write_zero write_null
736 #define read_full read_zero
737 #define aio_write_zero aio_write_null
738 #define open_mem open_port
739 #define open_kmem open_mem
741 static const struct file_operations mem_fops = {
742 .llseek = memory_lseek,
747 .get_unmapped_area = get_unmapped_area_mem,
750 #ifdef CONFIG_DEVKMEM
751 static const struct file_operations kmem_fops = {
752 .llseek = memory_lseek,
757 .get_unmapped_area = get_unmapped_area_mem,
761 static const struct file_operations null_fops = {
762 .llseek = null_lseek,
765 .aio_read = aio_read_null,
766 .aio_write = aio_write_null,
767 .splice_write = splice_write_null,
770 #ifdef CONFIG_DEVPORT
771 static const struct file_operations port_fops = {
772 .llseek = memory_lseek,
779 static const struct file_operations zero_fops = {
780 .llseek = zero_lseek,
783 .aio_read = aio_read_zero,
784 .aio_write = aio_write_zero,
789 * capabilities for /dev/zero
790 * - permits private mappings, "copies" are taken of the source of zeros
791 * - no writeback happens
793 static struct backing_dev_info zero_bdi = {
795 .capabilities = BDI_CAP_MAP_COPY | BDI_CAP_NO_ACCT_AND_WRITEBACK,
798 static const struct file_operations full_fops = {
799 .llseek = full_lseek,
804 static const struct memdev {
807 const struct file_operations *fops;
808 struct backing_dev_info *dev_info;
810 [1] = { "mem", 0, &mem_fops, &directly_mappable_cdev_bdi },
811 #ifdef CONFIG_DEVKMEM
812 [2] = { "kmem", 0, &kmem_fops, &directly_mappable_cdev_bdi },
814 [3] = { "null", 0666, &null_fops, NULL },
815 #ifdef CONFIG_DEVPORT
816 [4] = { "port", 0, &port_fops, NULL },
818 [5] = { "zero", 0666, &zero_fops, &zero_bdi },
819 [7] = { "full", 0666, &full_fops, NULL },
820 [8] = { "random", 0666, &random_fops, NULL },
821 [9] = { "urandom", 0666, &urandom_fops, NULL },
823 [11] = { "kmsg", 0644, &kmsg_fops, NULL },
827 static int memory_open(struct inode *inode, struct file *filp)
830 const struct memdev *dev;
832 minor = iminor(inode);
833 if (minor >= ARRAY_SIZE(devlist))
836 dev = &devlist[minor];
840 filp->f_op = dev->fops;
842 filp->f_mapping->backing_dev_info = dev->dev_info;
844 /* Is /dev/mem or /dev/kmem ? */
845 if (dev->dev_info == &directly_mappable_cdev_bdi)
846 filp->f_mode |= FMODE_UNSIGNED_OFFSET;
849 return dev->fops->open(inode, filp);
854 static const struct file_operations memory_fops = {
856 .llseek = noop_llseek,
859 static char *mem_devnode(struct device *dev, umode_t *mode)
861 if (mode && devlist[MINOR(dev->devt)].mode)
862 *mode = devlist[MINOR(dev->devt)].mode;
866 static struct class *mem_class;
868 static int __init chr_dev_init(void)
873 err = bdi_init(&zero_bdi);
877 if (register_chrdev(MEM_MAJOR, "mem", &memory_fops))
878 printk("unable to get major %d for memory devs\n", MEM_MAJOR);
880 mem_class = class_create(THIS_MODULE, "mem");
881 if (IS_ERR(mem_class))
882 return PTR_ERR(mem_class);
884 mem_class->devnode = mem_devnode;
885 for (minor = 1; minor < ARRAY_SIZE(devlist); minor++) {
886 if (!devlist[minor].name)
892 if ((minor == DEVPORT_MINOR) && !arch_has_dev_port())
895 device_create(mem_class, NULL, MKDEV(MEM_MAJOR, minor),
896 NULL, devlist[minor].name);
902 fs_initcall(chr_dev_init);