diff options
author | Lucas De Marchi <lucas.demarchi@intel.com> | 2014-03-10 04:23:19 -0300 |
---|---|---|
committer | Lucas De Marchi <lucas.demarchi@intel.com> | 2014-03-26 22:30:31 -0300 |
commit | 299a3adfe8e3fd9494d9b3bb8866bc0f45fdcbe9 (patch) | |
tree | 07c000c4787304ad239311836b79dff826f4bd0c | |
parent | db62153ea0beedbc6941e1d438c0b6e7189e78d9 (diff) | |
parent | c03dfbd5a7b722032c30fa5b532247b25ae87352 (diff) | |
download | kmod-299a3adfe8e3fd9494d9b3bb8866bc0f45fdcbe9.tar.gz kmod-299a3adfe8e3fd9494d9b3bb8866bc0f45fdcbe9.tar.bz2 kmod-299a3adfe8e3fd9494d9b3bb8866bc0f45fdcbe9.zip |
Merge branch 'master' of python-kmod
This is python-kmod is found in git@github.com:agrover/kmod.git
d5b6f22639c077b86659828bcc78dcedc9daaa94
Its history has being rewritten to prepare for a merge:
- Every commit has been prefixed with "python: " in its commit
message
- s-o-b's have been removed
- Every file has been moved to libkmod/python directory
Some files don't make much sense anymore and are being removed
in this merge.
Acked-by: Andy Grover <agrover@redhat.com>
-rw-r--r-- | libkmod/python/.gitignore | 7 | ||||
-rw-r--r-- | libkmod/python/.mailmap | 1 | ||||
-rw-r--r-- | libkmod/python/.update-copyright.conf | 25 | ||||
-rw-r--r-- | libkmod/python/AUTHORS | 3 | ||||
-rw-r--r-- | libkmod/python/COPYING | 340 | ||||
-rw-r--r-- | libkmod/python/COPYING.LESSER | 508 | ||||
-rw-r--r-- | libkmod/python/MANIFEST.in | 4 | ||||
-rw-r--r-- | libkmod/python/README | 40 | ||||
l--------- | libkmod/python/README.rst | 1 | ||||
-rw-r--r-- | libkmod/python/kmod/__init__.py | 24 | ||||
-rw-r--r-- | libkmod/python/kmod/_libkmod_h.pxd | 113 | ||||
-rw-r--r-- | libkmod/python/kmod/_util.pxd | 20 | ||||
-rw-r--r-- | libkmod/python/kmod/_util.pyx | 28 | ||||
-rw-r--r-- | libkmod/python/kmod/error.py | 18 | ||||
-rw-r--r-- | libkmod/python/kmod/kmod.pxd | 22 | ||||
-rw-r--r-- | libkmod/python/kmod/kmod.pyx | 125 | ||||
-rw-r--r-- | libkmod/python/kmod/list.pxd | 25 | ||||
-rw-r--r-- | libkmod/python/kmod/list.pyx | 45 | ||||
-rw-r--r-- | libkmod/python/kmod/module.pxd | 24 | ||||
-rw-r--r-- | libkmod/python/kmod/module.pyx | 158 | ||||
-rw-r--r-- | libkmod/python/kmod/version.py | 17 | ||||
-rw-r--r-- | libkmod/python/setup.py | 63 |
22 files changed, 1611 insertions, 0 deletions
diff --git a/libkmod/python/.gitignore b/libkmod/python/.gitignore new file mode 100644 index 0000000..a8bcce1 --- /dev/null +++ b/libkmod/python/.gitignore @@ -0,0 +1,7 @@ +__pycache__ +MANIFEST +build +dist +*.c +*.pyc +*.so diff --git a/libkmod/python/.mailmap b/libkmod/python/.mailmap new file mode 100644 index 0000000..c0f5fd2 --- /dev/null +++ b/libkmod/python/.mailmap @@ -0,0 +1 @@ +Andy Grover <agrover@redhat.com> <andy@groveronline.com> diff --git a/libkmod/python/.update-copyright.conf b/libkmod/python/.update-copyright.conf new file mode 100644 index 0000000..3462de2 --- /dev/null +++ b/libkmod/python/.update-copyright.conf @@ -0,0 +1,25 @@ +[project] +name: python-kmod +vcs: Git + +[files] +authors: yes +files: yes +ignored: COPYING | COPYING.LESSER | README | README.rst | MANIFEST.in | + .update-copyright.conf | .git* + +[aliases] +Red Hat, Inc.: Andy Grover <agrover@redhat.com> + +[author-hacks] +kmod/kmod.pyx: Red Hat, Inc. + +[copyright] +short: %(project)s comes with ABSOLUTELY NO WARRANTY and is licensed under the GNU Lesser General Public License. +long: This file is part of %(project)s. + + %(project)s is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation. + + %(project)s 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 Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License along with %(project)s. If not, see <http://www.gnu.org/licenses/>. diff --git a/libkmod/python/AUTHORS b/libkmod/python/AUTHORS new file mode 100644 index 0000000..3aa035b --- /dev/null +++ b/libkmod/python/AUTHORS @@ -0,0 +1,3 @@ +python-kmod was written by: +Red Hat, Inc. +W. Trevor King <wking@tremily.us> diff --git a/libkmod/python/COPYING b/libkmod/python/COPYING new file mode 100644 index 0000000..57f4943 --- /dev/null +++ b/libkmod/python/COPYING @@ -0,0 +1,340 @@ + 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 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 + + 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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 Library General +Public License instead of this License. diff --git a/libkmod/python/COPYING.LESSER b/libkmod/python/COPYING.LESSER new file mode 100644 index 0000000..4551037 --- /dev/null +++ b/libkmod/python/COPYING.LESSER @@ -0,0 +1,508 @@ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 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. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations +below. + + When we speak of free software, we are referring to freedom of use, +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 and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. +^L + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it +becomes a de-facto standard. To achieve this, non-free programs must +be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. +^L + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, 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 library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete 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 distribute a copy of this License along with the +Library. + + 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 Library or any portion +of it, thus forming a work based on the Library, 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) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +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 Library, 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 Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. +^L + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you 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. + + If distribution of 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 satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. +^L + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be 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. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. +^L + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library 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. + + 9. 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 Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +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 with +this License. +^L + 11. 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 Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library 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 Library. + +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. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library 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. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +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 Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. +^L + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +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 + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. 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 LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS +^L + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms +of the ordinary General Public License). + + To apply these terms, attach the following notices to the library. +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 library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the library, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James + Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/libkmod/python/MANIFEST.in b/libkmod/python/MANIFEST.in new file mode 100644 index 0000000..c46c425 --- /dev/null +++ b/libkmod/python/MANIFEST.in @@ -0,0 +1,4 @@ +include AUTHORS +include COPYING +include COPYING.LESSER +recursive-include kmod *.pxd diff --git a/libkmod/python/README b/libkmod/python/README new file mode 100644 index 0000000..f031476 --- /dev/null +++ b/libkmod/python/README @@ -0,0 +1,40 @@ +python-kmod +=========== + +Python bindings for kmod/libkmod + +kmod is a set of tools to handle common tasks with Linux kernel modules like +insert, remove, list, check properties, resolve dependencies and aliases. + +These tools are designed on top of libkmod, a library that is shipped with +kmod. It can be found at: + +http://git.kernel.org/?p=utils/kernel/kmod/kmod.git;a=summary + +python-kmod is a Python wrapper module for libkmod, exposing common +module operations: listing installed modules, modprobe, and rmmod. +It is at: + +https://github.com/agrover/python-kmod + +Example (python invoked as root) +-------------------------------- + +:: + + >>> import kmod + >>> km = kmod.Kmod() + >>> [(m.name, m.size) for m in km.loaded()] + [(u'nfs', 407706), + (u'nfs_acl', 12741) + ... + (u'virtio_blk', 17549)] + >>> km.modprobe("btrfs") + >>> km.rmmod("btrfs") + +Building +-------- + +Ensure Python, Cython, and the kmod headers are installed and run:: + + $ python setup.py build diff --git a/libkmod/python/README.rst b/libkmod/python/README.rst new file mode 120000 index 0000000..100b938 --- /dev/null +++ b/libkmod/python/README.rst @@ -0,0 +1 @@ +README
\ No newline at end of file diff --git a/libkmod/python/kmod/__init__.py b/libkmod/python/kmod/__init__.py new file mode 100644 index 0000000..0d79787 --- /dev/null +++ b/libkmod/python/kmod/__init__.py @@ -0,0 +1,24 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +"Libkmod -- Python interface to kmod API." + +from .version import __version__ +try: + from .kmod import Kmod +except ImportError: + # this is a non-Linux platform + pass diff --git a/libkmod/python/kmod/_libkmod_h.pxd b/libkmod/python/kmod/_libkmod_h.pxd new file mode 100644 index 0000000..547cf70 --- /dev/null +++ b/libkmod/python/kmod/_libkmod_h.pxd @@ -0,0 +1,113 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +cimport libc.stdint as _stdint + + +cdef extern from *: + ctypedef char* const_char_ptr 'const char *' + ctypedef char* const_char_const_ptr 'const char const *' + ctypedef void* const_void_ptr 'const void *' + + +cdef extern from 'stdbool.h': + ctypedef struct bool: + pass + + +cdef extern from 'libkmod.h': + # library user context - reads the config and system + # environment, user variables, allows custom logging + cdef struct kmod_ctx: + pass + + kmod_ctx *kmod_new( + const_char_ptr dirname, const_char_const_ptr config_paths) + kmod_ctx *kmod_ref(kmod_ctx *ctx) + kmod_ctx *kmod_unref(kmod_ctx *ctx) + + # Management of libkmod's resources + int kmod_load_resources(kmod_ctx *ctx) + void kmod_unload_resources(kmod_ctx *ctx) + + # access to kmod generated lists + cdef struct kmod_list: + pass + ctypedef kmod_list* const_kmod_list_ptr 'const struct kmod_list *' + kmod_list *kmod_list_next( + const_kmod_list_ptr list, const_kmod_list_ptr curr) + kmod_list *kmod_list_prev( + const_kmod_list_ptr list, const_kmod_list_ptr curr) + kmod_list *kmod_list_last(const_kmod_list_ptr list) + + # Operate on kernel modules + cdef struct kmod_module: + pass + ctypedef kmod_module* const_kmod_module_ptr 'const struct kmod_module *' + int kmod_module_new_from_name( + kmod_ctx *ctx, const_char_ptr name, kmod_module **mod) + int kmod_module_new_from_lookup( + kmod_ctx *ctx, const_char_ptr given_alias, kmod_list **list) + int kmod_module_new_from_loaded(kmod_ctx *ctx, kmod_list **list) + + kmod_module *kmod_module_ref(kmod_module *mod) + kmod_module *kmod_module_unref(kmod_module *mod) + int kmod_module_unref_list(kmod_list *list) + kmod_module *kmod_module_get_module(kmod_list *entry) + + # Flags to kmod_module_probe_insert_module + # codes below can be used in return value, too + enum: KMOD_PROBE_APPLY_BLACKLIST + + #ctypedef int (*install_callback_t)( + # kmod_module *m, const_char_ptr cmdline, const_void_ptr data) + #ctypedef void (*print_action_callback_t)( + # kmod_module *m, bool install, const_char_ptr options) + + int kmod_module_remove_module( + kmod_module *mod, unsigned int flags) + int kmod_module_insert_module( + kmod_module *mod, unsigned int flags, const_char_ptr options) + int kmod_module_probe_insert_module( + kmod_module *mod, unsigned int flags, const_char_ptr extra_options, + int (*run_install)( + kmod_module *m, const_char_ptr cmdline, void *data), + const_void_ptr data, + void (*print_action)( + kmod_module *m, bool install, const_char_ptr options), + ) + + const_char_ptr kmod_module_get_name(const_kmod_module_ptr mod) + const_char_ptr kmod_module_get_path(const_kmod_module_ptr mod) + const_char_ptr kmod_module_get_options(const_kmod_module_ptr mod) + const_char_ptr kmod_module_get_install_commands(const_kmod_module_ptr mod) + const_char_ptr kmod_module_get_remove_commands(const_kmod_module_ptr mod) + + # Information regarding "live information" from module's state, as + # returned by kernel + int kmod_module_get_refcnt(const_kmod_module_ptr mod) + long kmod_module_get_size(const_kmod_module_ptr mod) + + # Information retrieved from ELF headers and section + int kmod_module_get_info(const_kmod_module_ptr mod, kmod_list **list) + const_char_ptr kmod_module_info_get_key(const_kmod_list_ptr entry) + const_char_ptr kmod_module_info_get_value(const_kmod_list_ptr entry) + void kmod_module_info_free_list(kmod_list *list) + + int kmod_module_get_versions(const_kmod_module_ptr mod, kmod_list **list) + const_char_ptr kmod_module_version_get_symbol(const_kmod_list_ptr entry) + _stdint.uint64_t kmod_module_version_get_crc(const_kmod_list_ptr entry) + void kmod_module_versions_free_list(kmod_list *list) diff --git a/libkmod/python/kmod/_util.pxd b/libkmod/python/kmod/_util.pxd new file mode 100644 index 0000000..80cbb28 --- /dev/null +++ b/libkmod/python/kmod/_util.pxd @@ -0,0 +1,20 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +cimport _libkmod_h + + +cdef object char_ptr_to_str(_libkmod_h.const_char_ptr bytes) diff --git a/libkmod/python/kmod/_util.pyx b/libkmod/python/kmod/_util.pyx new file mode 100644 index 0000000..39eec3a --- /dev/null +++ b/libkmod/python/kmod/_util.pyx @@ -0,0 +1,28 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +import sys as _sys + +cimport _libkmod_h + + +cdef object char_ptr_to_str(_libkmod_h.const_char_ptr char_ptr): + if char_ptr is NULL: + return None + if _sys.version_info >= (3,): # Python 3 + return str(char_ptr, 'ascii') + # Python 2 + return unicode(char_ptr, 'ascii') diff --git a/libkmod/python/kmod/error.py b/libkmod/python/kmod/error.py new file mode 100644 index 0000000..123f4ce --- /dev/null +++ b/libkmod/python/kmod/error.py @@ -0,0 +1,18 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +class KmodError (Exception): + pass diff --git a/libkmod/python/kmod/kmod.pxd b/libkmod/python/kmod/kmod.pxd new file mode 100644 index 0000000..7805d71 --- /dev/null +++ b/libkmod/python/kmod/kmod.pxd @@ -0,0 +1,22 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +cimport _libkmod_h + + +cdef class Kmod (object): + cdef _libkmod_h.kmod_ctx *_kmod_ctx + cdef object mod_dir diff --git a/libkmod/python/kmod/kmod.pyx b/libkmod/python/kmod/kmod.pyx new file mode 100644 index 0000000..3e73a1c --- /dev/null +++ b/libkmod/python/kmod/kmod.pyx @@ -0,0 +1,125 @@ +# Copyright (C) 2012 Red Hat, Inc. +# W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +"Define the Kmod class" + +cimport cython as _cython +cimport _libkmod_h +from error import KmodError as _KmodError +cimport module as _module +import module as _module +cimport list as _list +import list as _list + + +cdef class Kmod (object): + "Wrap a struct kmod_ctx* item" + def __cinit__(self): + self._kmod_ctx = NULL + self.mod_dir = None + + def __dealloc__(self): + self._cleanup() + + def __init__(self, mod_dir=None): + self.set_mod_dir(mod_dir=mod_dir) + + def set_mod_dir(self, mod_dir=None): + self.mod_dir = mod_dir + self._setup() + + def _setup(self): + cdef char *mod_dir = NULL + self._cleanup() + if self.mod_dir: + mod_dir = self.mod_dir + self._kmod_ctx = _libkmod_h.kmod_new(mod_dir, NULL); + if self._kmod_ctx is NULL: + raise _KmodError('Could not initialize') + _libkmod_h.kmod_load_resources(self._kmod_ctx) + + def _cleanup(self): + if self._kmod_ctx is not NULL: + _libkmod_h.kmod_unload_resources(self._kmod_ctx); + self._kmod_ctx = NULL + + def loaded(self): + "iterate through currently loaded modules" + cdef _list.ModList ml = _list.ModList() + cdef _list.ModListItem mli + err = _libkmod_h.kmod_module_new_from_loaded(self._kmod_ctx, &ml.list) + if err < 0: + raise _KmodError('Could not get loaded modules') + for item in ml: + mli = <_list.ModListItem> item + mod = _module.Module() + mod.from_mod_list_item(item) + yield mod + + def lookup(self, alias_name, flags=_libkmod_h.KMOD_PROBE_APPLY_BLACKLIST): + "iterate through modules matching `alias_name`" + cdef _list.ModList ml = _list.ModList() + cdef _list.ModListItem mli + if hasattr(alias_name, 'encode'): + alias_name = alias_name.encode('ascii') + err = _libkmod_h.kmod_module_new_from_lookup( + self._kmod_ctx, alias_name, &ml.list) + if err < 0: + raise _KmodError('Could not modprobe') + for item in ml: + mli = <_list.ModListItem> item + mod = _module.Module() + mod.from_mod_list_item(item) + yield mod + + @_cython.always_allow_keywords(True) + def module_from_name(self, name): + cdef _module.Module mod = _module.Module() + if hasattr(name, 'encode'): + name = name.encode('ascii') + err = _libkmod_h.kmod_module_new_from_name( + self._kmod_ctx, name, &mod.module) + if err < 0: + raise _KmodError('Could not get module') + return mod + + def list(self): + "iterate through currently loaded modules and sizes" + for mod in self.loaded(): + yield (mod.name, mod.size) + + def modprobe(self, name, quiet=False, *args, **kwargs): + """ + Load a module (or alias) and all modules on which it depends. + The 'quiet' option defaults to False; set to True to mimic the behavior + of the '--quiet' commandline option. + """ + mods = list(self.lookup(alias_name=name)) + + if not mods and not quiet: + raise _KmodError('Could not modprobe %s' % name) + + for mod in mods: + mod.insert(*args, **kwargs) + + def rmmod(self, module_name, *args, **kwargs): + """ + remove module from current tree + e.g. km.rmmod("thinkpad_acpi") + """ + mod = self.module_from_name(name=module_name) + mod.remove(*args, **kwargs) diff --git a/libkmod/python/kmod/list.pxd b/libkmod/python/kmod/list.pxd new file mode 100644 index 0000000..8e5b388 --- /dev/null +++ b/libkmod/python/kmod/list.pxd @@ -0,0 +1,25 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +cimport _libkmod_h + + +cdef class ModListItem (object): + cdef _libkmod_h.kmod_list *list + + +cdef class ModList (ModListItem): + cdef _libkmod_h.kmod_list *_next diff --git a/libkmod/python/kmod/list.pyx b/libkmod/python/kmod/list.pyx new file mode 100644 index 0000000..ef0e0d4 --- /dev/null +++ b/libkmod/python/kmod/list.pyx @@ -0,0 +1,45 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +cimport _libkmod_h + + +cdef class ModListItem (object): + "Wrap a struct kmod_list* list item" + def __cinit__(self): + self.list = NULL + + +cdef class ModList (ModListItem): + "Wrap a struct kmod_list* list with iteration" + def __cinit__(self): + self._next = NULL + + def __dealloc__(self): + if self.list is not NULL: + _libkmod_h.kmod_module_unref_list(self.list) + + def __iter__(self): + self._next = self.list + return self + + def __next__(self): + if self._next is NULL: + raise StopIteration() + mli = ModListItem() + mli.list = self._next + self._next = _libkmod_h.kmod_list_next(self.list, self._next) + return mli diff --git a/libkmod/python/kmod/module.pxd b/libkmod/python/kmod/module.pxd new file mode 100644 index 0000000..c7d7da4 --- /dev/null +++ b/libkmod/python/kmod/module.pxd @@ -0,0 +1,24 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +cimport _libkmod_h +cimport list as _list + + +cdef class Module (object): + cdef _libkmod_h.kmod_module *module + + cpdef from_mod_list_item(self, _list.ModListItem item) diff --git a/libkmod/python/kmod/module.pyx b/libkmod/python/kmod/module.pyx new file mode 100644 index 0000000..42aa92e --- /dev/null +++ b/libkmod/python/kmod/module.pyx @@ -0,0 +1,158 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +import collections as _collections + +cimport libc.errno as _errno + +cimport _libkmod_h +from error import KmodError as _KmodError +cimport list as _list +import list as _list +cimport _util +import _util + + +cdef class Module (object): + "Wrap a struct kmod_module* item" + def __cinit__(self): + self.module = NULL + + def __dealloc__(self): + self._cleanup() + + def _cleanup(self): + if self.module is not NULL: + _libkmod_h.kmod_module_unref(self.module) + self.module = NULL + + cpdef from_mod_list_item(self, _list.ModListItem item): + self._cleanup() + self.module = _libkmod_h.kmod_module_get_module(item.list) + + def _name_get(self): + return _util.char_ptr_to_str( + _libkmod_h.kmod_module_get_name(self.module)) + name = property(fget=_name_get) + + def _path_get(self): + return _util.char_ptr_to_str( + _libkmod_h.kmod_module_get_path(self.module)) + path = property(fget=_path_get) + + def _options_get(self): + return _util.char_ptr_to_str( + _libkmod_h.kmod_module_get_options(self.module)) + options = property(fget=_options_get) + + def _install_commands_get(self): + return _util.char_ptr_to_str( + _libkmod_h.kmod_module_get_install_commands(self.module)) + install_commands = property(fget=_install_commands_get) + + def _remove_commands_get(self): + return _util.char_ptr_to_str( + _libkmod_h.kmod_module_get_remove_commands(self.module)) + remove_commands = property(fget=_remove_commands_get) + + def _refcnt_get(self): + return _libkmod_h.kmod_module_get_refcnt(self.module) + refcnt = property(fget=_refcnt_get) + + def _size_get(self): + return _libkmod_h.kmod_module_get_size(self.module) + size = property(fget=_size_get) + + def _info_get(self): + cdef _list.ModList ml = _list.ModList() + cdef _list.ModListItem mli + err = _libkmod_h.kmod_module_get_info(self.module, &ml.list) + if err < 0: + raise _KmodError('Could not get info') + info = _collections.OrderedDict() + try: + for item in ml: + mli = <_list.ModListItem> item + key = _util.char_ptr_to_str( + _libkmod_h.kmod_module_info_get_key(mli.list)) + value = _util.char_ptr_to_str( + _libkmod_h.kmod_module_info_get_value(mli.list)) + info[key] = value + finally: + _libkmod_h.kmod_module_info_free_list(ml.list) + ml.list = NULL + return info + info = property(fget=_info_get) + + def _versions_get(self): + cdef _list.ModList ml = _list.ModList() + cdef _list.ModListItem mli + err = _libkmod_h.kmod_module_get_versions(self.module, &ml.list) + if err < 0: + raise _KmodError('Could not get versions') + try: + for item in ml: + mli = <_list.ModListItem> item + symbol = _util.char_ptr_to_str( + _libkmod_h.kmod_module_version_get_symbol(mli.list)) + crc = _libkmod_h.kmod_module_version_get_crc(mli.list) + yield {'symbol': symbol, 'crc': crc} + finally: + _libkmod_h.kmod_module_versions_free_list(ml.list) + ml.list = NULL + versions = property(fget=_versions_get) + + def insert(self, flags=0, extra_options=None, install_callback=None, + data=None, print_action_callback=None): + """ + insert module to current tree. + e.g. + km = kmod.Kmod() + tp = km.module_from_name("thinkpad_acpi") + tp.insert(extra_options='fan_control=1') + """ + cdef char *opt = NULL + #cdef _libkmod_h.install_callback_t install = NULL + cdef int (*install)( + _libkmod_h.kmod_module *, _libkmod_h.const_char_ptr, void *) + install = NULL + cdef void *d = NULL + #cdef _libkmod_h.print_action_callback_t print_action = NULL + cdef void (*print_action)( + _libkmod_h.kmod_module *, _libkmod_h.bool, + _libkmod_h.const_char_ptr) + print_action = NULL + if extra_options: + opt = extra_options + # TODO: convert callbacks and data from Python object to C types + err = _libkmod_h.kmod_module_probe_insert_module( + self.module, flags, opt, install, d, print_action) + if err == -_errno.EEXIST: + raise _KmodError('Module already loaded') + elif err < 0: + raise _KmodError('Could not load module') + + def remove(self, flags=0): + """ + remove module from current tree + e.g. + km = kmod.Kmod() + tp = km.module_from_name("thinkpad_acpi") + tp.remove() + """ + err = _libkmod_h.kmod_module_remove_module(self.module, flags) + if err < 0: + raise _KmodError('Could not remove module') diff --git a/libkmod/python/kmod/version.py b/libkmod/python/kmod/version.py new file mode 100644 index 0000000..1ef04eb --- /dev/null +++ b/libkmod/python/kmod/version.py @@ -0,0 +1,17 @@ +# Copyright (C) 2012 W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. + +__version__ = '0.9.1' diff --git a/libkmod/python/setup.py b/libkmod/python/setup.py new file mode 100644 index 0000000..f6e25b7 --- /dev/null +++ b/libkmod/python/setup.py @@ -0,0 +1,63 @@ +# Copyright (C) 2012 Red Hat, Inc. +# W. Trevor King <wking@tremily.us> +# +# This file is part of python-kmod. +# +# python-kmod is free software: you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License version 2.1 as published +# by the Free Software Foundation. +# +# python-kmod 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 Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with python-kmod. If not, see <http://www.gnu.org/licenses/>. +from setuptools import setup +from distutils.extension import Extension as _Extension +import os as _os +import sys as _sys +import platform + +# setuptools DWIM monkey-patch madness +# http://mail.python.org/pipermail/distutils-sig/2007-September/thread.html#8204 +import sys +if 'setuptools.extension' in sys.modules: + m = sys.modules['setuptools.extension'] + m.Extension.__dict__ = m._Extension.__dict__ + +package_name = 'kmod' + +# read version from local kmod/version.py without pulling in +# kmod/__init__.py +_sys.path.insert(0, package_name) +from version import __version__ + + +_this_dir = _os.path.dirname(__file__) + +ext_modules = [] +if platform.system() == "Linux": + for filename in sorted(_os.listdir(package_name)): + basename,extension = _os.path.splitext(filename) + if extension == '.pyx': + ext_modules.append( + _Extension( + '{0}.{1}'.format(package_name, basename), + [_os.path.join(package_name, filename)], + libraries=['kmod'], + )) + +setup( + name=package_name, + version=__version__, + description='Python binding for kmod', + packages=[package_name], + provides=[package_name], + maintainer="Andy Grover", + maintainer_email="agrover@redhat.com", + ext_modules=ext_modules, + install_requires=["Cython"], + setup_requires=["setuptools_cython"], + ) |