diff options
| -rw-r--r-- | .gitignore | 9 | ||||
| -rw-r--r-- | ChangeLog | 3 | ||||
| -rw-r--r-- | LICENSE | 280 | ||||
| -rw-r--r-- | Makefile | 17 | ||||
| -rw-r--r-- | README.rst | 149 | ||||
| -rw-r--r-- | include/cyber.h | 31 | ||||
| -rw-r--r-- | include/cyber_device.h | 62 | ||||
| -rw-r--r-- | include/cyber_file.h | 75 | ||||
| -rw-r--r-- | include/cyber_lifecycle.h | 33 | ||||
| -rw-r--r-- | src/cyber.c | 29 | ||||
| -rw-r--r-- | src/cyber_device.c | 103 | ||||
| -rw-r--r-- | src/cyber_device_character_device.c | 53 | ||||
| -rw-r--r-- | src/cyber_device_device_class.c | 77 | ||||
| -rw-r--r-- | src/cyber_device_kernel_device.c | 52 | ||||
| -rw-r--r-- | src/cyber_file.c | 84 | ||||
| -rw-r--r-- | src/cyber_lifecycle.c | 49 |
16 files changed, 1106 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ad2e3aa --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.color_coded +.ycm_extra_conf.py +*.o +*.cmd +.tmp_versions/ +Module.symvers +cyber.ko +cyber.mod.c +modules.order diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..ee3f8df --- /dev/null +++ b/ChangeLog @@ -0,0 +1,3 @@ +2017-02-25 Felix Morgner <felix.morgner@gmail.com> + + * cyber: initial implementation @@ -0,0 +1,280 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin St, 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 Library 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 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..16ea2f5 --- /dev/null +++ b/Makefile @@ -0,0 +1,17 @@ +EXTRA_CFLAGS := -I$(src)/include + +obj-m := cyber.o + +cyber-objs := src/cyber_device.o \ + src/cyber_device_character_device.o \ + src/cyber_device_device_class.o \ + src/cyber_device_kernel_device.o \ + src/cyber_file.o \ + src/cyber_lifecycle.o \ + src/cyber.o + +all: + make -C /lib/modules/$(shell uname -r)/build/ M=$(PWD) modules + +clean: + make -C /lib/modules/$(shell uname -r)/build/ M=$(PWD) clean diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..df69293 --- /dev/null +++ b/README.rst @@ -0,0 +1,149 @@ +/dev/cyber +========== + +The device we do not need, but the one we deserve. + +Features +-------- + +`/dev/cyber` uses a bleeding-edge architecture and state-of-the-art technologies +to provide you with the following features (all benchmarks have been done on a +Purism Librem 13): + +- High throughput access to **CYBER** space + + - Up-to 4.2 Gibibyte per second read speed + - Up-to 12 Gibibyte per second write speed + +- Unlimited storage + + - Uses brand spanking new **Condensed Di-hydrogen-monoxide Numbering** (CDN) + storage. + - Typically requires only 4kB of plain old RAM to instantiate **CYBER** + space + - Does **not** require Internet connectivity + +- NSA-level security + + - **Real-Time Flux Masking** (RTFM) provides secure privilege separation + - An average of 32768-Bit **CYBER Space Splitting** (CSS) encoding to + protect your data + +- High Availability through **Inverse Nodal Tachyon Equilibrium Layering** + (INTEL) +- Ultra low power consumption through **Virtual Xenotropic** (VX) scheduling +- Minute system impact thanks to **Correlative Cloud Compression** (CCC) + +Installing +---------- + +Building and installing `/dev/cyber` is extremely easy! Follow these steps to +CYBER enable your system today: + +1. Acquire the source code via **Generative Integration Traversal** (GIT):: + + $ git clone https://github.com/fmorgner/dev-cyber.git + +2. Enter the newly created directory using **Coupling Demodulation** (CD):: + + $ cd dev-cyber + +3. Build the module with **Magnetic Amplitude Knocking Extraction** (MAKE):: + + $ make + +4. Load the module through **Systematic Unity Dissolution Orchestration** + combined with **Instant Naturalistic System MODification** (SUDO INSMOD):: + + $ sudo insmod cyber.ko + +5. **PROFIT!** (through unlimited CYBER) + +Using `/dev/cyber` +------------------ + +`/dev/cyber` is just as easy to use as all your other favorite devices like +`/dev/zero` or `/dev/random` (Although it is **MUCH** more secure!). The +following examples will give you an example on how to use `/dev/cyber` for +maximum effect. + +Transferring backups into **CYBER** space +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Often times, especially in big server systems, backups take up a lot of physical +(e.g **NON-CYBER**) space. Instead of tediously moving old data to other +locations via the net or physical media, `/dev/cyber` provides you with a much +faster and way more **SECURE** alternative:: + + $ tar cf - /your_backup_storage_location > /dev/cyber + +Transferring your backups to **CYBER** space is fast and easy! + +Seeding random number generators +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You have probably heard of numerous issues concerning initialization of secure +random number generators. What if `/dev/random` just has bad entropy? Fear no +more! `/dev/cyber` supports **CYBER Space Splitting**, a state-of-the-art +**Entropy Sourcing Mechanism** (ESM). By simply reading all your entropy from +`/dev/cyber`, you are guaranteed to never run out of first-class randomness! + +Statistics +---------- + +As is the case with all good Linux kernel modules, `/dev/cyber` exports +statistics and configuration information via the **Stabilized Yarn Segregation +Flash Structure** (SYSFS). To view the currently used storage technology or the +amount of **CYBER** available at the moment, you can use these commands:: + + # Check how much CYBER is available + $ cat /sys/class/cyber/available + + # Check wich storage technology is being used at the moment + $ cat /sys/class/cyber/storage_technology + +Contributing +------------ + +This project is the result of all the pain induced by all the +"cyber"-thingamajigging and buzzword-flinging that is going on in the media +(even *specialist media*) these days. If you want to contribute to a CYBER-free +world consider one or more of the following options: + +- Stop using the word/prefix CYBER! + + - Tell your friends to stop too! + - Tell you colleagues to stop also! + - Ban it from your company! + +- Spread the word about this module. It would be great if we could manage to + convince people to actually use it. Maybe the will stop CYBERing around when + the have lost their data to **CYBER** space! + +- Implement new features! + + - Having a block device would be **really** cool! + - Asynchronous I/O would also **rock**! + +- Improve this README + + - Add more examples! + - Fix typos (VIM kinda sucks at highlighting typos is already highlighted + text)! + - **CYBER** it up even more! + +- Or at least, buy me a beer (technically does not fight **CYBER**, but it helps + alleviate the pain) using + `BTC <bitcoin:17UjLY7p9hKHJZ7XJKFrNoUyNkDEtPMdSV?label=cyber_beer>`_ or + `LTC <litecoin:LLi8TSBbwAoeigS4SuzBwa8hcYDkBDxutW?label=cyber_beer>`_ + + - BTC address (because github...): 17UjLY7p9hKHJZ7XJKFrNoUyNkDEtPMdSV + - LTC address (because github...): LLi8TSBbwAoeigS4SuzBwa8hcYDkBDxutW + +DISCLAIMER +---------- + +I have looked through the code a couple of times, but this is my first-ever +Linux kernel module. It should be fine, since it pretty much is little more than +`/dev/zero` (just with **CYBER**). You and your system should be fine but I +cannot guarantee it! diff --git a/include/cyber.h b/include/cyber.h new file mode 100644 index 0000000..f5ca28b --- /dev/null +++ b/include/cyber.h @@ -0,0 +1,31 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#ifndef CYBER_H +#define CYBER_H + +/** + * The name of the CYBER device + */ +#define DEV_NAME "cyber" + +/** + * The class of the CYBER device + */ +#define CLS_NAME "cyber" + +#endif diff --git a/include/cyber_device.h b/include/cyber_device.h new file mode 100644 index 0000000..1da9e37 --- /dev/null +++ b/include/cyber_device.h @@ -0,0 +1,62 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#ifndef CYBER_DEVICE_H +#define CYBER_DEVICE_H + +#include <linux/cdev.h> +#include <linux/device.h> +#include <linux/fs.h> + +/** + * This structure holds information about the CYBER device + */ +extern struct cyber_device +{ + /** + * The kernel character device structure + */ + struct cdev character; + + /** + * The kernel device structure + */ + struct device kernel; + + /** + * The kernel device class structure + */ + struct class class; + + /** + * The kernel device number + */ + dev_t number; + +} device; + +/** + * Initialize the CYBER device + */ +int cyber_device_init(void); + +/** + * Deinitialize the CYBER device + */ +void cyber_device_shutdown(void); + +#endif diff --git a/include/cyber_file.h b/include/cyber_file.h new file mode 100644 index 0000000..01ea0c7 --- /dev/null +++ b/include/cyber_file.h @@ -0,0 +1,75 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#ifndef CYBER_FILE_H +#define CYBER_FILE_H + +#include <linux/fs.h> + +/** + * Initialize the CYBER file + * + * @return zero on success, non-zero otherwise + */ +int cyber_file_init(void); + +/** + * Shutdown the CYBER file + */ +void cyber_file_shutdown(void); + +/** + * Handler for CYBER device open events + * + * @param inode The kernel inode associated with the CYBER device + * @param file The kernel file associated with the CYBER device + * @return zero on success, non-zero otherwise + */ +int cyber_file_open(struct inode * inode, struct file * file); + +/** + * Handler for CYBER device read events + * + * @param file The kernel file associated with the CYBER device + * @param buffer The user-space target buffer for all the CYBER + * @param size The size of the user-space buffer + * @param offset The offset into the CYBER + * @return The number of bytes that were read, negative on error + */ +ssize_t cyber_file_read(struct file * file, char * buffer, size_t size, loff_t * offset); + +/** + * Handler for CYBER device write events + * + * @param file The kernel file associated with the CYBER device + * @param buffer The user-space source buffer for all the CYBER + * @param size The size of the user-space buffer + * @param offset The offset into the CYBER + * @param The number of bytes that were written, negative on error + */ +ssize_t cyber_file_write(struct file * file, char const * buffer, size_t size, loff_t * offset); + +/** + * Handler for CYBER device close events + * + * @param inode The kernel inode associated with the CYBER device + * @param file The kernel file associated with the CYBER device + * @param zero on success, non-zero otherwise + */ +int cyber_file_close(struct inode * inode, struct file * file); + +#endif diff --git a/include/cyber_lifecycle.h b/include/cyber_lifecycle.h new file mode 100644 index 0000000..ea2f6dd --- /dev/null +++ b/include/cyber_lifecycle.h @@ -0,0 +1,33 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#ifndef CYBER_LIFECYCLE_H +#define CYBER_LIFECYCLE_H + +#include <linux/init.h> + +/** + * The CYBER driver intialization + */ +int __init cyber_driver_init(void); + +/** + * The CYBER driver deinitialization + */ +void __exit cyber_driver_exit(void); + +#endif diff --git a/src/cyber.c b/src/cyber.c new file mode 100644 index 0000000..3f454af --- /dev/null +++ b/src/cyber.c @@ -0,0 +1,29 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#include "cyber.h" +#include "cyber_device.h" +#include "cyber_lifecycle.h" + +#include <linux/device.h> +#include <linux/init.h> +#include <linux/module.h> + +MODULE_LICENSE("GPL v2"); +MODULE_AUTHOR("Felix Morgner"); +MODULE_VERSION("42.1337"); +MODULE_DESCRIPTION("Add CYBER to your system"); diff --git a/src/cyber_device.c b/src/cyber_device.c new file mode 100644 index 0000000..67b9695 --- /dev/null +++ b/src/cyber_device.c @@ -0,0 +1,103 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#include "cyber.h" +#include "cyber_device.h" + +#include <linux/device.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/string.h> + +struct cyber_device device = {}; + +/** + * Initialize the sysfs CYBER device class + * + * @return zero on success, non-zero otherwise + */ +int cyber_device_init_device_class(void); + +/** + * Shutdown the sysfs CYBER device class + */ +void cyber_device_shutdown_device_class(void); + +/** + * Initialize the CYBER character device + * + * @return zero on success, non-zero otherwise + */ +int cyber_device_init_character_device(void); + +/** + * Shutdown the CYBER character device + */ +void cyber_device_shutdown_character_device(void); + +/** + * Initialize the CYBER kernel device + * + * @return zero on success, non-zero otherwise + */ +int cyber_device_init_kernel_device(void); + +/** + * Shutdown the CYBER kernel device + */ +void cyber_device_shutdown_kernel_device(void); + +int cyber_device_init(void) +{ + int error = 0; + + printk(KERN_INFO DEV_NAME ": Initializing CYBER device\n"); + + if((error = cyber_device_init_character_device())) + { + return error; + } + + if((error = cyber_device_init_device_class())) + { + cyber_device_shutdown_character_device(); + return error; + } + + if((error = cyber_device_init_kernel_device())) + { + cyber_device_shutdown_character_device(); + cyber_device_shutdown_device_class(); + return error; + } + + printk(KERN_INFO DEV_NAME ": New CYBER device with major %d minor %d\n", MAJOR(device.number), MINOR(device.number)); + return error; +} + +void cyber_device_shutdown(void) +{ + printk(KERN_INFO DEV_NAME ": Shutting down CYBER device\n"); + cyber_device_shutdown_kernel_device(); + cyber_device_shutdown_device_class(); + cyber_device_shutdown_character_device(); +} + +void cyber_device_release(struct device * device) +{ + printk(KERN_INFO DEV_NAME ": Closing kernel CYBER device\n"); +} diff --git a/src/cyber_device_character_device.c b/src/cyber_device_character_device.c new file mode 100644 index 0000000..f99e97e --- /dev/null +++ b/src/cyber_device_character_device.c @@ -0,0 +1,53 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#include "cyber.h" +#include "cyber_device.h" + +#include <linux/device.h> +#include <linux/kernel.h> +#include <linux/module.h> + +extern struct cyber_device device; +extern struct file_operations const cyber_operations; + +int cyber_device_init_character_device(void) +{ + int error = 0; + + if((error = alloc_chrdev_region(&device.number, 0, 1, DEV_NAME))) + { + printk(KERN_ALERT DEV_NAME ": Failed to allocate character device!\n"); + } + + cdev_init(&device.character, &cyber_operations); + device.character.owner = THIS_MODULE; + device.character.ops = &cyber_operations; + + if((error = cdev_add(&device.character, device.number, 1))) + { + printk(KERN_ALERT DEV_NAME ": Failed to add character device (Error: %d)!\n", error); + } + + return error; +} + +void cyber_device_shutdown_character_device(void) +{ + cdev_del(&device.character); + unregister_chrdev_region(device.number, 1); +} diff --git a/src/cyber_device_device_class.c b/src/cyber_device_device_class.c new file mode 100644 index 0000000..c0d108b --- /dev/null +++ b/src/cyber_device_device_class.c @@ -0,0 +1,77 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#include "cyber.h" +#include "cyber_device.h" + +#include <linux/device.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/string.h> + +extern struct cyber_device device; + +static ssize_t cyber_device_show_attribute(struct class * class, struct class_attribute * attribute, char __user * buffer) +{ + char const * const name = attribute->attr.name; + + if(!strcmp(name, "available")) + { + return sprintf(buffer, "infinite\n"); + } + else if(!strcmp(name, "storage_technology")) + { + return sprintf(buffer, "condensed di-hydrogen-monoxide\n"); + } + + return -EINVAL; +} + +CLASS_ATTR(available, 0444, cyber_device_show_attribute, NULL); +CLASS_ATTR(storage_technology, 0444, cyber_device_show_attribute, NULL); + +static int cyber_device_handle_uevent(struct device * kernelDevice, struct kobj_uevent_env * environment) +{ + add_uevent_var(environment, "DEVMODE=%#o", 0666); + return 0; +} + +int cyber_device_init_device_class(void) +{ + int error = 0; + + device.class.name = CLS_NAME; + device.class.owner = THIS_MODULE; + device.class.dev_uevent = cyber_device_handle_uevent; + if((error = class_register(&device.class))) + { + printk(KERN_ALERT DEV_NAME ": Failed to register CYBER device class!\n"); + } + + if((error = class_create_file(&device.class, &class_attr_available)) || + (error = class_create_file(&device.class, &class_attr_storage_technology))) + { + printk(KERN_ALERT DEV_NAME ": Failed to register sysfs CYBER attributes!\n"); + } + + return error; +} + +void cyber_device_shutdown_device_class(void) +{ + class_unregister(&device.class); +} diff --git a/src/cyber_device_kernel_device.c b/src/cyber_device_kernel_device.c new file mode 100644 index 0000000..6a2be4b --- /dev/null +++ b/src/cyber_device_kernel_device.c @@ -0,0 +1,52 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#include "cyber.h" +#include "cyber_device.h" + +#include <linux/device.h> +#include <linux/kernel.h> +#include <linux/module.h> + +extern struct cyber_device device; + +static void cyber_device_close_kernel_device(struct device * device) +{ + printk(KERN_INFO DEV_NAME ": Closing kernel CYBER device\n"); +} + +int cyber_device_init_kernel_device(void) +{ + int error = 0; + + device.kernel.class = &device.class; + device.kernel.devt = device.number; + device.kernel.init_name = DEV_NAME; + device.kernel.release = cyber_device_close_kernel_device; + + if((error = device_register(&device.kernel))) + { + printk(KERN_ALERT DEV_NAME ": Failed to create CYBER device!\n"); + } + + return error; +} + +void cyber_device_shutdown_kernel_device(void) +{ + device_unregister(&device.kernel); +} diff --git a/src/cyber_file.c b/src/cyber_file.c new file mode 100644 index 0000000..d7264c1 --- /dev/null +++ b/src/cyber_file.c @@ -0,0 +1,84 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#include "cyber.h" +#include "cyber_file.h" + +#include <asm/uaccess.h> +#include <linux/module.h> + +struct file_operations const cyber_operations = { + .owner = THIS_MODULE, + .open = cyber_file_open, + .read = cyber_file_read, + .write = cyber_file_write, + .release = cyber_file_close, +}; + +static char const * cyberPattern = "!CYBER! "; +static char * cyberSpace; + +int cyber_file_open(struct inode * inode, struct file * file) +{ + return 0; +} + +ssize_t cyber_file_read(struct file * file, char __user * buffer, size_t size, loff_t * offset) +{ + int const cybers = (size > PAGE_SIZE ? PAGE_SIZE : size) / 8; + if(copy_to_user(buffer, cyberSpace, cybers * 8)) + { + return -EFAULT; + } + return cybers * 8; +} + +ssize_t cyber_file_write(struct file * file, char __user const * buffer, size_t size, loff_t * offset) +{ + return size; +} + +int cyber_file_close(struct inode * inode, struct file * file) +{ + return 0; +} + +int cyber_file_init(void) +{ + int i; + + printk(KERN_INFO DEV_NAME ": Initializing CYBER space\n"); + cyberSpace = (char *)__get_free_page(GFP_KERNEL); + if(!cyberSpace) + { + printk(KERN_ALERT DEV_NAME ": Out of CYBER space!\n"); + return ENOMEM; + } + + for(i = 0; i < PAGE_SIZE; ++i) + { + cyberSpace[i] = cyberPattern[i % 8]; + } + + return 0; +} + +void cyber_file_shutdown(void) +{ + printk(KERN_INFO DEV_NAME ": Releasing CYBER space\n"); + free_page((unsigned long)cyberSpace); +} diff --git a/src/cyber_lifecycle.c b/src/cyber_lifecycle.c new file mode 100644 index 0000000..02df37d --- /dev/null +++ b/src/cyber_lifecycle.c @@ -0,0 +1,49 @@ +/* + * cyber - Add CYBER to your system + * Copyright (C) 2017 Felix Morgner + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#include "cyber_device.h" +#include "cyber_file.h" +#include "cyber_lifecycle.h" + +#include <linux/module.h> + +int cyber_driver_init(void) +{ + int error; + + if((error = cyber_file_init())) + { + return error; + } + + if((error = cyber_device_init()) < 0) + { + cyber_file_shutdown(); + return error; + } + + return 0; +} + +void cyber_driver_exit(void) +{ + cyber_device_shutdown(); + cyber_file_shutdown(); +} + +module_init(cyber_driver_init) +module_exit(cyber_driver_exit) |