Read/write files within a Linux kernel module

by

You should be aware that you should avoid file I/O from within Linux kernel when possible. The main idea is to go “one level deeper” and call VFS level functions instead of the syscall handler directly:

Includes:

#include <linux/fs.h>
#include <asm/segment.h>
#include <asm/uaccess.h>
#include <linux/buffer_head.h>

Opening a file (similar to open):

struct file *file_open(const char *path, int flags, int rights) 
{
    struct file *filp = NULL;
    mm_segment_t oldfs;
    int err = 0;

    oldfs = get_fs();
    set_fs(get_ds());
    filp = filp_open(path, flags, rights);
    set_fs(oldfs);
    if (IS_ERR(filp)) {
        err = PTR_ERR(filp);
        return NULL;
    }
    return filp;
}

Close a file (similar to close):

void file_close(struct file *file) 
{
    filp_close(file, NULL);
}

Reading data from a file (similar to pread):

int file_read(struct file *file, unsigned long long offset, unsigned char *data, unsigned int size) 
{
    mm_segment_t oldfs;
    int ret;

    oldfs = get_fs();
    set_fs(get_ds());

    ret = vfs_read(file, data, size, &offset);

    set_fs(oldfs);
    return ret;
}

Writing data to a file (similar to pwrite):

int file_write(struct file *file, unsigned long long offset, unsigned char *data, unsigned int size) 
{
    mm_segment_t oldfs;
    int ret;

    oldfs = get_fs();
    set_fs(get_ds());

    ret = vfs_write(file, data, size, &offset);

    set_fs(oldfs);
    return ret;
}

Syncing changes a file (similar to fsync):

int file_sync(struct file *file) 
{
    vfs_fsync(file, 0);
    return 0;
}

[Edit] Originally, I proposed using file_fsync, which is gone in newer kernel versions. Thanks to the poor guy suggesting the change, but whose change was rejected. The edit was rejected before I could review it.

More Related Contents:

  1. How can I get a filename from a file descriptor inside a kernel module?
  2. Why my kernel log is not showing the latest output?
  3. Understanding container_of macro in the Linux kernel
  4. Linux Kernel: System call hooking example
  5. Why is fseek or fflush always required between reading and writing in the update modes?
  6. Measure time in Linux – time vs clock vs getrusage vs clock_gettime vs gettimeofday vs timespec_get?
  7. Reading the whole text file into a char array in C
  8. read comma-separated input with `scanf()`
  9. What are vdso and vsyscall?
  10. What happens if I don’t call fclose() in a C program?
  11. Whole one core dedicated to single process
  12. What is the difference between read() and fread()?
  13. Building a kernel module from several source files which one of them has the same name as the module
  14. What is the function of “(void) (&_min1 == &_min2)” in the min macro in kernel.h?
  15. Read line from file without knowing the line length
  16. Is there a macro definition to check the Linux kernel version?
  17. Rationale behind the container_of macro in linux/list.h
  18. How to print both to stdout and file in C
  19. Read and write to binary files in C?
  20. File I/O in a Linux kernel module
  21. Why is the fgets function deprecated?
  22. Unable to open a file with fopen()
  23. What does request_mem_region() actually do and when it is needed?
  24. Reading a file character by character in C
  25. How to create a new Linux kernel scheduler
  26. How to use lockdep feature in linux kernel for deadlock detection
  27. /proc/[pid]/pagemaps and /proc/[pid]/maps | linux
  28. ftell at a position past 2GB
  29. How to print exact value of the program counter in C
  30. How do I insert and delete some characters in the middle of a file?

Leave a Comment