Skip to main content

Linux kernel module to add a proc file entry

A look at the proc_dir_entry structure

struct proc_dir_entry {
unsigned int low_ino;
unsigned short namelen;
const char *name; // name of our module
mode_t mode; // permissions ,who can read and write to it
nlink_t nlink;
uid_t uid;
gid_t gid;
loff_t size;
const struct inode_operations *proc_iops;
const struct file_operations *proc_fops;
struct proc_dir_entry *next, *parent, *subdir;
void *data;
read_proc_t *read_proc; // pointer to the function to be called when we
do a read to the proc entry
write_proc_t *write_proc;// pointer to the function to be called when we
do a write to the proc entry
atomic_t count;
int pde_users;
spinlock_t pde_unload_lock;
struct completion *pde_unload_completion;
struct list_head pde_openers;
};

Now let us write a LKM to add a proc entry . When you write to our proc entry it stores the msg you write and when you read from it , it displays the msg you
wrote to it CODE for the module:

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/proc_fs.h>
#include <linux/string.h>
#include <linux/uaccess.h>
MODULE_LICENSE("GPL");
MODULE_AUTHOR("SAnandNarayan.com");
MODULE_DESCRIPTION("LSP assignment");
static char our_buf[256];// our buffer to store the msg
int buf_read(char *buf, char **start, off_t offset, int
count, int *eof, void *data)
{
int len;
len = snprintf(buf, count, "%s", our_buf);
/*
when you read from the proc entry the snprintf function
prints the buffers msg to the user space
*/
return len;
}
static int buf_write(struct file *file, const char *buf,
unsigned long count, void *data)
{
if(count > 255)
count = 255; // reads only the first 255 bytes
copy_from_user(our_buf, buf, count);
/*copies from the user space buffer to our kernel space
buffer*/
our_buf[count] = '\0';
return count;
}
int __init start_module(void)
{
struct proc_dir_entry *de =
create_proc_entry("anand_lsp", 0666, 0);
//creates the proc entry and returns the pointer to the proc
//entry
de->read_proc = buf_read;
de->write_proc = buf_write;
// assigns the functions to be called for the respective
operations
sprintf(our_buf, "hello");
// initializing our buffer
return 0 ;
}
void __exit exit_module(void)
{
//cleaning up the proc entry
remove_proc_entry("anand_lsp", NULL);
}
module_init(start_module);
module_exit(exit_module);

Thanks to S Anand Narayanan for this post. Visit his website http://www.sanandnarayan.com/

Comments

  1. this is great site and i appreciate it but i feel its a purly commercial effort to make the site famous and get more and more hits. even the marks are posted on the site and the only reason i see behind that is to get more and more hits so that more expansive advertisements can be put onto the site.
    Thanks and regards,
    Kalyan Chandra

    ReplyDelete
  2. this is great site and i appreciate it but i feel its a purly commercial effort to make the site famous and get more and more hits. even the marks are posted on the site and the only reason i see behind that is to get more and more hits so that more expansive advertisements can be put onto the site.
    Hits
    23111
    its how u got it.
    Regards,
    Kalyan Chandra

    ReplyDelete
  3. How do you write to /proc/file_name from the device driver? What function can be used to write to /proc file from the char driver code? Can somebody help me please

    ReplyDelete

Post a Comment

Popular posts from this blog

Installing ns-3.34 in Ubuntu 20.04

This post shows how to install ns 3.34 in Ubuntu 20.04 LTS Prerequisites: Fresh installation of Ubuntu Version 20.04 LTS  ns3.34 can be downloaded from here Follow the video link for complete step by step instructions on the installation.  This version fixes the compilation issues of vanet-routing-compare.cc (bug in ns3.33)  Issue the following commands after opening a terminal  $ sudo apt update $ sudo apt install g++ python3 python3-dev python-dev pkg-config sqlite3 python3-setuptools git qt5-default gir1.2-goocanvas-2.0 python3-gi python3-gi-cairo python3-pygraphviz gir1.2-gtk-3.0 ipython3 openmpi-bin openmpi-common openmpi-doc libopenmpi-dev autoconf cvs bzr unrar openmpi-bin openmpi-common openmpi-doc libopenmpi-dev tcpdump wireshark libxml2 libxml2-dev Unzip or untar the ns-allinone-3.34.tar.bz2 in the home folder (in my case its /home/pradeepkumar) $ cd ns-allinone-3.34/ $ ./build.py --enable-examples --enable-tests  Once the installation is completed, you may get an output show

Installation of ns3 in Windows 10 and Windows 11 OS using WSL (Windows Subsystem for Linux)

This post shows how to install ns-3.33 in Windows 10 through WSL (Windows Subsystem for Linux) This posts works for Windows 11 also (I have tested it on a Windows 11 ISO and it works the Same way as mentioned in the following post.) This post will work for ns-3.3x version. Prerequisites : Install Windows Subsystem for Linux with GUI: Please refer the following video  System Information: OS used: Windows 10 and WSL (Ubuntu 20.04) GUI: XServer for Windows NS3 Version: ns-3.33 See the following complete video on how to install ns3 in Windows 10 Step 0 : Open XLaunch Step 1 :  Open WSL using PowerShell and open it as Administrator Command:/  wsl $ xfce4-session The GUI of Ubuntu Opens within Windows 10 OS. Step 2 : Download ns3 from nsnam.org website through Mozilla Firefox browser Step 3: Open a Terminal  $ sudo apt update $ sudo apt install build-essential autoconf automake libxmu-dev python3-pygraphviz cvs mercurial bzr git cmake p7zip-full python3-matplotlib python-tk python3-dev qt5-q

Installing NS-3.32 in Ubuntu 20.04

This is about installing ns version 3.32 in Ubuntu 20.04 LTS. #ns3 #ns3 .32 #networksimulation The commands used in the video are given here. $] sudo apt update $] sudo apt install build-essential autoconf automake libxmu-dev python3-pygraphviz cvs mercurial bzr git cmake p7zip-full python3-matplotlib python-tk python3-dev qt5-qmake qt5-default gnuplot-x11 wireshark Download the ns-allinone-3.32.tar.bz2 package from nsnam.org and copy it to /home/ folder See the full video for detailed instructions Extract it either in GUI or using command $] tar jxvf ns-allinone-3.32.tar.bz2 $] cd ns-allinone-3.32/ $] ./build.py --enable-examples --enable-tests The above command will take some time to install all the packages  You can see the output as shown below ns3 To check whether ns3 installed successfully, use the following commands. $] cd ns-3.32/ $] ./waf --run hello-simulator You should get the output as Hello Simulator $] ./waf --run first This is the example from the ns-3.32/exa