Initial import of the muenevents Linux kernel module master
authorAdrian-Ken Rueegsegger <ken@codelabs.ch>
Thu, 30 Apr 2020 09:28:30 +0000 (11:28 +0200)
committerAdrian-Ken Rueegsegger <ken@codelabs.ch>
Fri, 1 May 2020 08:56:05 +0000 (10:56 +0200)
The *muenevents* Linux kernel module implements a virtual file system
that facilitates user-space access to source events (subject-specific
hypercalls) provided by the Muen Separation Kernel [1]. Refer to the
README.md for more information.

[1] - http://muen.sk

.gitignore [new file with mode: 0644]
COPYING [new file with mode: 0644]
Makefile [new file with mode: 0644]
README.md [new file with mode: 0644]
fs.c [new file with mode: 0644]
internal.h [new file with mode: 0644]
main.c [new file with mode: 0644]

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..f4f823a
--- /dev/null
@@ -0,0 +1,9 @@
+*.o
+*~
+*.ko
+Module.*
+*.cmd
+.tmp_versions
+modules.order
+*.mod.c
+*.mod
diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..d159169
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..2492842
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,20 @@
+obj-m           := muenevents.o
+muenevents-objs := main.o fs.o
+
+KERNEL_SOURCE ?= /lib/modules/$(shell uname -r)/build
+
+PWD := $(shell pwd)
+
+all: compile-module
+
+compile-module:
+       $(MAKE) -C $(KERNEL_SOURCE) M=$(PWD) modules
+
+install: install-module
+
+install-module:
+       install -d $(DESTDIR)/lib/modules/extra
+       install -m 644 muenevents.ko $(DESTDIR)/lib/modules/extra
+
+clean:
+       $(MAKE) -C $(KERNEL_SOURCE) M=$(PWD) clean
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..5d68bef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Muenevents
+
+## Introduction
+
+The *muenevents* Linux kernel module implements a virtual file system that
+facilitates user-space access to source events (subject-specific hypercalls)
+provided by the [Muen Separation Kernel][1].
+
+For each source event a file with the corresponding logical name is shown in
+the file system. A program can *write(2)* to the files to trigger an event.
+Using *read(2)* to access the file returns the source event number.
+
+## Usage
+
+    $ modprobe muenevents
+    $ mkdir -p /muenevents
+    $ mount -t muenevents none /muenevents
+
+## Authentication
+
+The current authentication model is that the files are created with uid and gid
+set to 0 and permissions 0600. No further capability checking is done by this
+module.
+
+[1]: https://muen.sk
diff --git a/fs.c b/fs.c
new file mode 100644 (file)
index 0000000..aaa52c2
--- /dev/null
+++ b/fs.c
@@ -0,0 +1,347 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Muen source events file system.
+ *
+ * Copyright (C) 2020  secunet Security Networks AG
+ * Copyright (C) 2020  codelabs GmbH
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+/**
+ * @file fs.c
+ * @brief Implementation of the file system and the file operations.
+ *
+ * This kernel module implements a file system named "muenevents". It
+ * facilitates user-space to trigger source events (subject-specific
+ * hypercalls) provided by the Muen Separation Kernel.
+ *
+ * For each source event a file with the corresponding logical name is shown in
+ * the file system. A program can write to the files to trigger an event.
+ * Reading from a file returns the source event number.
+ *
+ * The current authentication model is that the files are created with uid and
+ * gid set to 0 and permissions 0600. No further capability checking is done by
+ * this module.
+ */
+
+#include <linux/module.h>
+#include <linux/uaccess.h>
+#include <linux/pagemap.h>
+#include <linux/slab.h>
+#include <linux/io.h>
+#include <linux/kvm_para.h>
+
+#include "internal.h"
+
+/**
+ * @brief Random magic value to identify this file system.
+ */
+#define MUENEVENTS_MAGIC 0x9a9bc92b
+
+/**
+ * @brief Size of temporary string buffer.
+ */
+#define TMPBUFLEN 20
+
+/**
+ * @brief Retrieve #source_event_t from file.
+ *
+ * This function retrieves the source event information previously stored with
+ * set_event_info().
+ *
+ * @param file file pointer
+ * @return the source_event_t stored in the private_data element.
+ */
+static inline struct source_event_t *get_event_info(struct file *file)
+{
+       return file->private_data;
+}
+
+/**
+ * @brief Store #source_event_t into file.
+ *
+ * This function uses the file private_data element to store the source event
+ * information.
+ *
+ * @param file file pointer
+ * @param info source event information
+ */
+static inline void set_event_info(struct file *file,
+                                  struct source_event_t *info)
+{
+       file->private_data = info;
+}
+
+/**
+ * @brief Open a file representing a source event.
+ *
+ * This function transfers the private data pointing to the
+ * source event from the inode to the file.
+ *
+ * @param inode inode information
+ * @param file file information
+ * @return 0 on success
+ */
+static int muenevents_open(struct inode *inode, struct file *file)
+{
+       struct source_event_t *cur_event = inode->i_private;
+
+       set_event_info(file, cur_event);
+       return 0;
+}
+
+/**
+ * @brief Read event number associated with given file.
+ *
+ * This function writes the source event number to the user area.
+ *
+ * @param file file pointer
+ * @param buffer user-space buffer to store the event number
+ * @param count maximum number of bytes to read
+ * @param offset pointer to current position
+ * @return number of bytes read
+ * @return -EFAULT on error
+ */
+static ssize_t muenevents_read(struct file *file,
+                          char __user *buffer,
+                          size_t count,
+                          loff_t *offset)
+{
+       const struct source_event_t * const cur_event = get_event_info(file);
+       int len;
+       char tmp[TMPBUFLEN];
+
+       len = snprintf(tmp, TMPBUFLEN, "%lu\n", cur_event->number);
+       if (len < 0)
+               return -EFAULT;
+
+       if (*offset > len)
+               return 0;
+
+       if (count > len - *offset)
+               count = len - *offset;
+
+       if (copy_to_user(buffer, tmp + *offset, count))
+               return -EFAULT;
+
+       *offset += count;
+       return count;
+}
+
+/**
+ * @brief Trigger source event identified by given file.
+ *
+ * This function triggers the source event associated with the file. Data
+ * provided by the user is ignored.
+ *
+ * @param file file pointer
+ * @param buffer user-space buffer, unused
+ * @param count maximum number of bytes to write
+ * @param offset pointer to current position, unused
+ * @return 1 on success
+ */
+static ssize_t muenevents_write(struct file *file,
+                           const char __user *buffer,
+                           size_t count,
+                           loff_t *offset)
+{
+       const struct source_event_t * const cur_event = get_event_info(file);
+
+       kvm_hypercall0(cur_event->number);
+       return count;
+}
+
+/**
+ * @brief File operations for this file system.
+ */
+static const struct file_operations muenevents_file_fops = {
+       .open  = muenevents_open,
+       .read  = muenevents_read,
+       .write = muenevents_write,
+};
+
+/**
+ * @brief Create a new inode.
+ *
+ * @param sb super block of our file system
+ * @param mode the file mode to use (includes specification of the file type)
+ * @return a new inode on success
+ * @return NULL if inode could not be allocated
+ */
+static struct inode *muenevents_make_inode(struct super_block *sb, int mode)
+{
+       struct inode *ret = new_inode(sb);
+
+       if (ret) {
+               ret->i_mode = mode;
+               ret->i_uid.val = ret->i_gid.val = 0;
+               ret->i_blocks = 0;
+               ret->i_atime = ret->i_mtime = ret->i_ctime = current_time(ret);
+       }
+       return ret;
+}
+
+/**
+ * @brief Callback parameter type.
+ */
+struct cb_arg {
+       struct super_block *sb; /**< the super block of the file system    */
+       struct dentry *dir;     /**< the parent directory to create a file */
+};
+
+/**
+ * @brief Create a file.
+ *
+ * This function creates a new file in our file system. The event given as
+ * parameter is stored in the private data of the inode for later retrieval.
+ * File mode is set to 0600 for read-write access. The file size is set to 1
+ * byte.
+ *
+ * @param event the source event associated with the file
+ * @param data refers to the super block of the file system and the base
+ *        directory
+ * @return true on success
+ * @return false if directory entry could not be allocated
+ */
+static bool muenevents_create_file(const struct muen_resource_type *const info,
+                              void *const data)
+{
+       const int file_mode = 0600;
+       struct cb_arg *arg = data;
+       struct dentry *dentry;
+       struct inode *inode;
+       struct qstr qname;
+       struct source_event_t *event;
+
+       /* only export event resources, skip other resources */
+       if (info->kind != MUEN_RES_EVENT)
+               return true;
+
+       event = kzalloc(sizeof(*event), GFP_KERNEL);
+       if (!event)
+               goto out;
+
+       strncpy(event->name, info->name.data, info->name.length);
+       event->number = info->data.number;
+
+       /* create hashed name */
+       qname.name = event->name;
+       qname.len = strlen(event->name);
+       qname.hash = full_name_hash(arg->dir, event->name, qname.len);
+
+       inode = muenevents_make_inode(arg->sb, S_IFREG | file_mode);
+       if (!inode)
+               goto out_free;
+
+       inode->i_ino = get_next_ino();
+       inode->i_size = 1;
+       inode->i_fop = &muenevents_file_fops;
+       inode->i_private = event;
+
+       dentry = d_alloc(arg->dir, &qname);
+       if (!dentry)
+               goto out_iput;
+
+       /* put into cache and return */
+       d_add(dentry, inode);
+       pr_info("muenevents: registered file %s - event number %lu",
+              event->name, event->number);
+       return true;
+
+out_iput:
+       iput(inode);
+out_free:
+       kfree(event);
+out:
+       return false;
+}
+
+/**
+ * @brief Create a file for each Muen source event
+ *
+ * This function creates a new file in the root directory for every Muen
+ * event that is present.
+ *
+ * @param sb super block of the file system
+ * @return 0 on success
+ * @return -ENOMEN on error
+ */
+static int muenevents_create_files(struct super_block *sb)
+{
+       struct cb_arg args = { .sb = sb, .dir = sb->s_root };
+
+       return muen_for_each_resource(muenevents_create_file, &args) ?
+               0 : -ENOMEM;
+}
+
+/**
+ * @brief Fills the super block of the file system.
+ *
+ * This functions initializes the super block, creates the root directory and
+ * the files using the muenevents_create_files() function.
+ *
+ * @param sb the super block of the file system
+ * @param data file system options, currently ignored
+ * @param silent don't display any printk message if true (ignored)
+ * @return 0 on success
+ * @see simple_fill_super() and muenevents_create_files() for possible error
+ * conditions
+ */
+static int muenevents_fill_super(struct super_block *sb, void *data, int silent)
+{
+       static struct tree_descr empty_descr = {""};
+       int err;
+
+       err = simple_fill_super(sb, MUENEVENTS_MAGIC, &empty_descr);
+       if (err)
+               return err;
+
+       return muenevents_create_files(sb);
+       /* TODO: Register dentry_operations to free
+        * allocated source event structures.
+        */
+}
+
+/**
+ * @brief Mount super block.
+ *
+ * This function uses mount_single() to provide a single instance of the file
+ * system. The function muenevents_fill_super() is specified to fill the super
+ * block of the instance.
+ *
+ * @param fst file system type specification
+ * @param flags parameters specified in the user-space for this mount operation
+ * @param devname device to mount, ignored
+ * @param data file system options specified in user-space
+ * @return pointer or error condition returned by mount_single()
+ */
+static struct dentry *muenevents_mount(struct file_system_type *fst,
+                                 int flags, const char *devname, void *data)
+{
+       return mount_single(fst, flags, data, muenevents_fill_super);
+}
+
+/**
+ * This description contains the owner, the name, the operation to get the
+ * super block, and the operation to destroy the super block. Here
+ * kill_litter_super() is required as we are holding references to the
+ * directory entries in the file system.
+ */
+struct file_system_type muenevents_type = {
+       .owner          = THIS_MODULE,
+       .name           = "muenevents",
+       .mount          = muenevents_mount,
+       .kill_sb        = kill_litter_super,
+};
diff --git a/internal.h b/internal.h
new file mode 100644 (file)
index 0000000..b33e4e9
--- /dev/null
@@ -0,0 +1,50 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
+/*
+ * Muen source events file system.
+ *
+ * Copyright (C) 2020  secunet Security Networks AG
+ * Copyright (C) 2020  codelabs GmbH
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef INTERNAL_H_
+#define INTERNAL_H_
+
+/**
+ * @file internal.h
+ * @brief Common information shared by the other source files.
+ */
+
+#include <linux/types.h>
+#include <linux/list.h>
+#include <muen/sinfo.h>
+
+/**
+ * @brief Structure holding information about source events.
+ *
+ * This structure holds information about each source event. The information is
+ * provided by the Muen SK in the subject info page.
+ */
+struct source_event_t {
+       char name[MAX_NAME_LENGTH + 1]; /**< the name of the source event   */
+       unsigned long number;           /**< the number of the source event */
+};
+
+/**
+ * @brief Description of the Muen events file system.
+ */
+extern struct file_system_type muenevents_type;
+
+#endif
diff --git a/main.c b/main.c
new file mode 100644 (file)
index 0000000..8056042
--- /dev/null
+++ b/main.c
@@ -0,0 +1,61 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Muen source events file system.
+ *
+ * Copyright (C) 2020  secunet Security Networks AG
+ * Copyright (C) 2020  codelabs GmbH
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+/**
+ * @file main.c
+ * @brief Muenevents register/unregister functionality.
+ *
+ * These routines are dealing with file system initialization and cleanup.
+ */
+
+#include <linux/module.h>
+#include <linux/fs.h>
+
+#include "internal.h"
+
+/**
+ * @brief Module initialization.
+ *
+ * This function registers the Muen events file system.
+ *
+ * @return 0 on success, negative values on error
+ */
+static int __init muenevents_init(void)
+{
+       return register_filesystem(&muenevents_type);
+}
+
+/**
+ * @brief Module finalization.
+ *
+ * This function unregisters the Muen events file system.
+ */
+static void __exit muenevents_exit(void)
+{
+       unregister_filesystem(&muenevents_type);
+}
+
+module_init(muenevents_init);
+module_exit(muenevents_exit);
+
+MODULE_DESCRIPTION("Muen SK source events file system");
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("Adrian-Ken Rueegsegger <ken@codelabs.ch>");