From a93619c70eb4d33267eff7cb50e37a1e6b141278 Mon Sep 17 00:00:00 2001 From: Nathan Hjelm Date: Mon, 21 Mar 2016 16:29:48 -0600 Subject: [PATCH 1/2] libxpmem: cleanup libxpmem and update license This commit moves the libxpmem internal portions of xpmem.h (ioctl and command structure definitions) into a seperate header (xpmem_internal.h). The doxygen documentation of libxpmem functions has been moved the xpmem.h and the use of the reserved identifier _XPMEM_H has been removed. This commit also updates the license of just libxpmem to LGPL. This change was approved by the upstream author (Cray Inc). The license on the headers xpmem.h and xpmem_internal.h remain GPL at this time. This should be sufficient to allow distribution of non-GPL software linked against libxpmem. Fixes #6 Signed-off-by: Nathan Hjelm --- COPYING.LESSER | 502 ++++++++++++++++++++++++++++++++++++ include/Makefile.am | 2 +- include/xpmem.h | 232 +++++++++++------ include/xpmem_internal.h | 138 ++++++++++ kernel/xpmem_attach.c | 2 +- kernel/xpmem_get.c | 3 +- kernel/xpmem_main.c | 2 +- kernel/xpmem_make.c | 3 +- kernel/xpmem_mmu_notifier.c | 3 +- kernel/xpmem_pfn.c | 3 +- kernel/xpmem_private.h | 2 +- lib/libxpmem.c | 103 +------- 12 files changed, 809 insertions(+), 186 deletions(-) create mode 100644 COPYING.LESSER create mode 100644 include/xpmem_internal.h diff --git a/COPYING.LESSER b/COPYING.LESSER new file mode 100644 index 00000000000..551cb4acb9d --- /dev/null +++ b/COPYING.LESSER @@ -0,0 +1,502 @@ + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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 + + 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. + + + Copyright (C) + + 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/include/Makefile.am b/include/Makefile.am index bdb26c16646..25cf9a46290 100644 --- a/include/Makefile.am +++ b/include/Makefile.am @@ -1,2 +1,2 @@ include_HEADERS = xpmem.h - +noinst_HEADERS = xpmem_internal.h diff --git a/include/xpmem.h b/include/xpmem.h index a8eb74555fc..8cb95230ab9 100644 --- a/include/xpmem.h +++ b/include/xpmem.h @@ -1,20 +1,21 @@ /* - * This file is subject to the terms and conditions of the GNU General Public - * License. See the file "COPYING" in the main directory of this archive - * for more details. + * This file is subject to the terms and conditions of the GNU Lesser General + * Public License. See the file "COPYING.LESSER" in the main directory of + * this archive for more details. The underlying library is subject to the + * terms and conditions of the GNU Lesser General Public License. * * Copyright (c) 2004-2007 Silicon Graphics, Inc. All Rights Reserved. + * Copyright (c) 2016 Nathan Hjelm. All rights reserved. */ /* * Cross Partition Memory (XPMEM) structures and macros. */ -#ifndef _XPMEM_H -#define _XPMEM_H +#ifndef XPMEM_H +#define XPMEM_H #include -#include #ifndef __KERNEL__ #include #endif @@ -22,28 +23,43 @@ /* * basic argument type definitions */ -typedef __s64 xpmem_segid_t; /* segid returned from xpmem_make() */ -typedef __s64 xpmem_apid_t; /* apid returned from xpmem_get() */ +/** + * segid returned from xpmem_make() + */ +typedef __s64 xpmem_segid_t; + +/** + * apid returned from xpmem_get() + */ +typedef __s64 xpmem_apid_t; +/** + * Structure used by xpmem_attach(). + */ struct xpmem_addr { - xpmem_apid_t apid; /* apid that represents memory */ - off_t offset; /* offset into apid's memory */ + /** apid that represents memory */ + xpmem_apid_t apid; + /** offset into apid's memory region */ + off_t offset; }; -#define XPMEM_MAXADDR_SIZE (size_t)(-1L) - -/* - * path to XPMEM device +/** + * Maximum address size for xpmem_make. Keep in mind that there may + * be platform-dependant restrictions beyond this size. Attempting + * to attach to an address range that goes outside the additional + * restriction will return an error. A new define may be added in + * the future to indicate the largest address that can be attached. */ -#define XPMEM_DEV_PATH "/dev/xpmem" +#define XPMEM_MAXADDR_SIZE (size_t)(-1L) /* * The following are the possible XPMEM related errors. */ -#define XPMEM_ERRNO_NOPROC 2004 /* unknown thread due to fork() */ +/** Unknown thread due to fork() */ +#define XPMEM_ERRNO_NOPROC 2004 /* - * flags for segment permissions + * Flags for segment permissions */ #define XPMEM_RDONLY 0x1 #define XPMEM_RDWR 0x2 @@ -51,70 +67,128 @@ struct xpmem_addr { /* * Valid permit_type values for xpmem_make(). */ -#define XPMEM_PERMIT_MODE 0x1 - -/* - * ioctl() commands used to interface to the kernel module. - */ -#define XPMEM_IOC_MAGIC 'x' -#define XPMEM_CMD_VERSION _IO(XPMEM_IOC_MAGIC, 0) -#define XPMEM_CMD_MAKE _IO(XPMEM_IOC_MAGIC, 1) -#define XPMEM_CMD_REMOVE _IO(XPMEM_IOC_MAGIC, 2) -#define XPMEM_CMD_GET _IO(XPMEM_IOC_MAGIC, 3) -#define XPMEM_CMD_RELEASE _IO(XPMEM_IOC_MAGIC, 4) -#define XPMEM_CMD_ATTACH _IO(XPMEM_IOC_MAGIC, 5) -#define XPMEM_CMD_DETACH _IO(XPMEM_IOC_MAGIC, 6) -#define XPMEM_CMD_FORK_BEGIN _IO(XPMEM_IOC_MAGIC, 7) -#define XPMEM_CMD_FORK_END _IO(XPMEM_IOC_MAGIC, 8) - -/* - * Structures used with the preceding ioctl() commands to pass data. - */ -struct xpmem_cmd_make { - __u64 vaddr; - size_t size; - int permit_type; - __u64 permit_value; - xpmem_segid_t segid; /* returned on success */ -}; - -struct xpmem_cmd_remove { - xpmem_segid_t segid; -}; - -struct xpmem_cmd_get { - xpmem_segid_t segid; - int flags; - int permit_type; - __u64 permit_value; - xpmem_apid_t apid; /* returned on success */ -}; - -struct xpmem_cmd_release { - xpmem_apid_t apid; +enum { + /** Permit value are unix-style permissions with mask 0777. Any bit + * set outside this range is an error. This is the only valid permit + * mode at this time. */ + XPMEM_PERMIT_MODE = 0x1, }; -struct xpmem_cmd_attach { - xpmem_apid_t apid; - off_t offset; - size_t size; - __u64 vaddr; - int fd; - int flags; -}; +#if !defined(__KERNEL__) -struct xpmem_cmd_detach { - __u64 vaddr; -}; +/** + * xpmem_version - get the XPMEM version + * + * Return Value: + * Success: XPMEM version number + * Failure: -1 + */ +int xpmem_version (void); + +/** + * xpmem_make - share a memory block + * @vaddr: IN: starting address of region to share + * @size: IN: number of bytes to share + * @permit_type: IN: only XPMEM_PERMIT_MODE currently defined + * @permit_value: IN: permissions mode expressed as an octal value + * Description: + * xpmem_make() shares a memory block by invoking the XPMEM driver. + * Context: + * Called by the source process to obtain a segment ID to share with other + * processes. It is common to call this function with vadder = NULL and + * size = XPMEM_MAXADDR_SIZE. This will share the entire address space of + * the calling process. + * Return Value: + * Success: 64-bit segment ID (xpmem_segid_t) + * Failure: -1 + */ +xpmem_segid_t xpmem_make (void *vaddr, size_t size, int permit_type, void *permit_value); + +/** + * xpmem_remove - revoke access to a shared memory block + * @segid: IN: 64-bit segment ID of the region to stop sharing + * Description: + * The opposite of xpmem_make(), this function deletes the mapping for a + * specified segid that was created from a previous xpmem_make() call. + * Context: + * Optionally called by the source process, otherwise automatically called + * by the driver when the source process exits. + * Return Value: + * Success: 0 + * Failure: -1 + */ +int xpmem_remove (xpmem_segid_t segid); + +/** + * xpmem_get - obtain permission to attach memory + * @segid: IN: segment ID returned from a previous xpmem_make() call + * @flags: IN: read-write (XPMEM_RDWR) or read-only (XPMEM_RDONLY) + * @permit_type: IN: only XPMEM_PERMIT_MODE currently defined + * @permit_value: IN: permissions mode expressed as an octal value + * Description: + * xpmem_get() attempts to get access to a shared memory block. + * Context: + * Called by the consumer process to get permission to attach memory from + * the source virtual address space associated with this segid. If access + * is granted, an apid will be returned to pass to xpmem_attach(). + * Return Value: + * Success: 64-bit access permit ID (xpmem_apid_t) + * Failure: -1 + */ +xpmem_apid_t xpmem_get (xpmem_segid_t segid, int flags, int permit_type, + void *permit_value); + +/** + * xpmem_release - give up access to the segment + * @apid: IN: 64-bit access permit ID to release + * Description: + * The opposite of xpmem_get(), this function deletes any mappings in the + * consumer's address space. + * Context: + * Optionally called by the consumer process, otherwise automatically + * called by the driver when the consumer process exits. + * Return Value: + * Success: 0 + * Failure: -1 + */ +int xpmem_release (xpmem_apid_t apid); + +/** + * xpmem_attach - map a source address to own address space + * @addr: IN: a structure consisting of a xpmem_apid_t apid and an off_t offset + * addr.apid: access permit ID returned from a previous xpmem_get() call + * addr.offset: offset into the source memory to begin the mapping + * @size: IN: number of bytes to map + * @vaddr: IN: address at which the mapping should be created, or NULL if the + * kernel should choose + * Description: + * Attaches a virtual address space range from the source process. + * Context: + * Called by the consumer to get a mapping between the shared source + * address and an address in the consumer process' own address space. If + * the mapping is successful, then the consumer process can now begin + * accessing the shared memory. + * Return Value: + * Success: virtual address at which the mapping was created + * Failure: -1 + */ +void *xpmem_attach (struct xpmem_addr addr, size_t size, void *vaddr); + +/** + * xpmem_detach - remove a mapping between consumer and source + * @vaddr: IN: virtual address within an XPMEM mapping in the consumer's + * address space + * Description: + * Detach from the virtual address space of the source process. + * Context: + * Optionally called by the consumer process, otherwise automatically + * called by the driver when the consumer process exits. + * Return Value: + * Success: 0 + * Failure: -1 + */ +int xpmem_detach (void *vaddr); -#ifndef __KERNEL__ -extern int xpmem_version(void); -extern xpmem_segid_t xpmem_make(void *, size_t, int, void *); -extern int xpmem_remove(xpmem_segid_t); -extern xpmem_apid_t xpmem_get(xpmem_segid_t, int, int, void *); -extern int xpmem_release(xpmem_apid_t); -extern void *xpmem_attach(struct xpmem_addr, size_t, void *); -extern int xpmem_detach(void *); -#endif +#endif /* !defined(__KERNEL__) */ -#endif /* _XPMEM_H */ +#endif /* XPMEM_H */ diff --git a/include/xpmem_internal.h b/include/xpmem_internal.h new file mode 100644 index 00000000000..c65297c1179 --- /dev/null +++ b/include/xpmem_internal.h @@ -0,0 +1,138 @@ +/* -*- Mode: C; indent-tabs-mode:nil -*- */ +/* + * Cross Partition Memory user-facing API (internal bits) + * Copyright (c) 2004-2007 Silicon Graphics, Inc. All Rights Reserved. + * Copyright © 2016 Nathan Hjelm + * + * 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 version + * version 2.1 of the License. See the "COPYING.LESSER" file in + * the main directory of this archive for more details. + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#if !defined(XPMEM_INTERNAL_H) +#define XPMEM_INTERNAL_H + +#include "xpmem.h" +#include + +/* ioctl()'s used to communicate with the xpmem kernel module */ +#define XPMEM_CMD_VERSION _IO('x', 0) + +/** ioctl to make an xpmem segment */ +#define XPMEM_CMD_MAKE _IO('x', 1) + +/** + * Structure to pass data for XPMEM_CMD_MAKE ioctl + */ +struct xpmem_cmd_make { + /** Base of virtual address range of new xpmem segment */ + __u64 vaddr; + /** Size of xpmem segment */ + size_t size; + /** Permit type */ + int permit_type; + /** Permit value (permissions) */ + __u64 permit_value; + /** New segment identifier (out) */ + xpmem_segid_t segid; +}; +typedef struct xpmem_cmd_make xpmem_cmd_make_t; + +/** ioctl to remove an xpmem segment */ +#define XPMEM_CMD_REMOVE _IO('x', 2) + +/** + * Structure to pass data for XPMEM_CMD_REMOVE ioctl + */ +struct xpmem_cmd_remove { + /** xpmem segment identifier of segment to remove */ + xpmem_segid_t segid; +}; +typedef struct xpmem_cmd_remove xpmem_cmd_remove_t; + +/** ioctl to get an xpmem access permit */ +#define XPMEM_CMD_GET _IO('x', 3) + +/** + * Structure to pass data for XPMEM_CMD_GET ioctl + */ +struct xpmem_cmd_get { + /** xpmem segment identifier of segment to request access */ + xpmem_segid_t segid; + /** xpmem access flags */ + int flags; + /** Access permit type (must be XPMEM_PERMIT_MODE) */ + int permit_type; + /** Access permit value (unix permissions with mask 0777) */ + __u64 permit_value; + /** New xpmem access permit (out) */ + xpmem_apid_t apid; +}; +typedef struct xpmem_cmd_get xpmem_cmd_get_t; + +/** ioctl to release an access permit */ +#define XPMEM_CMD_RELEASE _IO('x', 4) + +/** + * Structure to pass data for XPMEM_CMD_RELEASE ioctl + */ +struct xpmem_cmd_release { + /** Access permit to release */ + xpmem_apid_t apid; +}; +typedef struct xpmem_cmd_release xpmem_cmd_release_t; + +/** ioctl to attach to a region */ +#define XPMEM_CMD_ATTACH _IO('x', 5) + +/** + * Structure to pass data for XPMEM_CMD_ATTACH ioctl + */ +struct xpmem_cmd_attach { + /** Access permit */ + xpmem_apid_t apid; + /** Offset in xpmem segment */ + off_t offset; + /** Size of region */ + size_t size; + /** Local address of remote memory region (out) */ + __u64 vaddr; + /** File descriptor (not used). For compatibility with Cray XPMEM. */ + int fd; + /** Attach flags (not used). For compatibility with Cray XPMEM. */ + int flags; +}; +typedef struct xpmem_cmd_attach xpmem_cmd_attach_t; + +/** ioctl to detach a region */ +#define XPMEM_CMD_DETACH _IO('x', 6) + +/** + * Structure to pass data for XPMEM_CMD_DETACH ioctl + */ +struct xpmem_cmd_detach { + /** Local address of memory region to detach */ + __u64 vaddr; +}; +typedef struct xpmem_cmd_detach xpmem_cmd_detach_t; + +#define XPMEM_CMD_FORK_BEGIN _IO('x', 7) +#define XPMEM_CMD_FORK_END _IO('x', 8) + +/* + * path to XPMEM device + */ +#define XPMEM_DEV_PATH "/dev/xpmem" + +#endif /* !defined(XPMEM_INTERNAL_H) */ diff --git a/kernel/xpmem_attach.c b/kernel/xpmem_attach.c index f841c133636..b6b71cf0fba 100644 --- a/kernel/xpmem_attach.c +++ b/kernel/xpmem_attach.c @@ -17,7 +17,7 @@ #include #include #include -#include +#include "xpmem_internal.h" #include "xpmem_private.h" static void diff --git a/kernel/xpmem_get.c b/kernel/xpmem_get.c index 85a9aeedae7..f19f1eda669 100644 --- a/kernel/xpmem_get.c +++ b/kernel/xpmem_get.c @@ -4,6 +4,7 @@ * for more details. * * Copyright (c) 2004-2007 Silicon Graphics, Inc. All Rights Reserved. + * Copyright (c) 2016 Nathan Hjelm */ /* @@ -13,7 +14,7 @@ #include #include #include -#include +#include "xpmem_internal.h" #include "xpmem_private.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(3,5,0) diff --git a/kernel/xpmem_main.c b/kernel/xpmem_main.c index 4026e8037a2..67316f0fde1 100644 --- a/kernel/xpmem_main.c +++ b/kernel/xpmem_main.c @@ -30,7 +30,7 @@ #include #include #include -#include +#include "xpmem_internal.h" #include "xpmem_private.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(3,10,0) diff --git a/kernel/xpmem_make.c b/kernel/xpmem_make.c index 4c836f2dad4..add8cf25185 100644 --- a/kernel/xpmem_make.c +++ b/kernel/xpmem_make.c @@ -7,6 +7,7 @@ * Copyright (c) 2009 Cray Inc. All Rights Reserved * Copyright (c) 2014 Los Alamos National Security, LLC. All rights * reserved. + * Copyright (c) 2016 Nathan Hjelm */ /* @@ -15,7 +16,7 @@ #include #include -#include +#include "xpmem_internal.h" #include "xpmem_private.h" /* diff --git a/kernel/xpmem_mmu_notifier.c b/kernel/xpmem_mmu_notifier.c index fc999a42a59..bbd570ad693 100644 --- a/kernel/xpmem_mmu_notifier.c +++ b/kernel/xpmem_mmu_notifier.c @@ -4,6 +4,7 @@ * Copyright (c) 2010,2012 Cray, Inc. * Copyright (c) 2014-2015 Los Alamos National Security, LLC. All rights * reserved. + * Copyright (c) 2016 Nathan Hjelm * * This file is subject to the terms and conditions of the GNU General Public * License. See the file "COPYING" in the main directory of this archive for @@ -20,7 +21,7 @@ #include #include -#include +#include "xpmem_internal.h" #include "xpmem_private.h" static inline void diff --git a/kernel/xpmem_pfn.c b/kernel/xpmem_pfn.c index fbbc39c1de4..d02f242a796 100644 --- a/kernel/xpmem_pfn.c +++ b/kernel/xpmem_pfn.c @@ -6,6 +6,7 @@ * Copyright (c) 2004-2007 Silicon Graphics, Inc. All Rights Reserved. * Copyright 2009, 2014 Cray Inc. All Rights Reserved * Copyright 2016 ARM Inc. All Rights Reserved + * Copyright (c) 2016 Nathan Hjelm */ /* @@ -16,7 +17,7 @@ #include #include #include -#include +#include "xpmem_internal.h" #include "xpmem_private.h" /* #of pages rounded up that vaddr and size occupy */ diff --git a/kernel/xpmem_private.h b/kernel/xpmem_private.h index 24d83ba6c23..ab75186110c 100644 --- a/kernel/xpmem_private.h +++ b/kernel/xpmem_private.h @@ -244,7 +244,7 @@ struct xpmem_partition { /* * Attribute and state flags for various xpmem structures. Some values - * are defined in xpmem.h, so we reserved space here via XPMEM_DONT_USE_X + * are defined in xpmem_internal.h, so we reserved space here via XPMEM_DONT_USE_X * to prevent overlap. */ #define XPMEM_FLAG_DESTROYING 0x00040 /* being destroyed */ diff --git a/lib/libxpmem.c b/lib/libxpmem.c index 79fc8e1b8e8..f198734ecaa 100644 --- a/lib/libxpmem.c +++ b/lib/libxpmem.c @@ -1,8 +1,9 @@ /* * Copyright (c) 2009 Cray, Inc. + * Copyright (c) 2016 Nathan Hjelm * - * This file is subject to the terms and conditions of the GNU General Public - * License. See the file "COPYING" in the main directory of this archive + * This file is subject to the terms and conditions of the GNU Lesser General Public + * License. See the file "COPYING.LESSER" in the main directory of this archive * for more details. */ #include @@ -12,7 +13,7 @@ #include #include -#include +#include "xpmem_internal.h" static int xpmem_fd = -1; @@ -75,21 +76,6 @@ int xpmem_ioctl(int cmd, void *arg) return ret; } -/** - * xpmem_make - share a memory block - * @vaddr: IN: starting address of region to share - * @size: IN: number of bytes to share - * @permit_type: IN: only XPMEM_PERMIT_MODE currently defined - * @permit_value: IN: permissions mode expressed as an octal value - * Description: - * xpmem_make() shares a memory block by invoking the XPMEM driver. - * Context: - * Called by the source process to obtain a segment ID to share with other - * processes. - * Return Value: - * Success: 64-bit segment ID (xpmem_segid_t) - * Failure: -1 - */ xpmem_segid_t xpmem_make(void *vaddr, size_t size, int permit_type, void *permit_value) { @@ -106,19 +92,6 @@ xpmem_segid_t xpmem_make(void *vaddr, size_t size, int permit_type, return make_info.segid; } -/** - * xpmem_remove - revoke access to a shared memory block - * @segid: IN: 64-bit segment ID of the region to stop sharing - * Description: - * The opposite of xpmem_make(), this function deletes the mapping for a - * specified segid that was created from a previous xpmem_make() call. - * Context: - * Optionally called by the source process, otherwise automatically called - * by the driver when the source process exits. - * Return Value: - * Success: 0 - * Failure: -1 - */ int xpmem_remove(xpmem_segid_t segid) { struct xpmem_cmd_remove remove_info; @@ -129,22 +102,6 @@ int xpmem_remove(xpmem_segid_t segid) return 0; } -/** - * xpmem_get - obtain permission to attach memory - * @segid: IN: segment ID returned from a previous xpmem_make() call - * @flags: IN: read-write (XPMEM_RDWR) or read-only (XPMEM_RDONLY) - * @permit_type: IN: only XPMEM_PERMIT_MODE currently defined - * @permit_value: IN: permissions mode expressed as an octal value - * Description: - * xpmem_get() attempts to get access to a shared memory block. - * Context: - * Called by the consumer process to get permission to attach memory from - * the source virtual address space associated with this segid. If access - * is granted, an apid will be returned to pass to xpmem_attach(). - * Return Value: - * Success: 64-bit access permit ID (xpmem_apid_t) - * Failure: -1 - */ xpmem_apid_t xpmem_get(xpmem_segid_t segid, int flags, int permit_type, void *permit_value) { @@ -159,19 +116,6 @@ xpmem_apid_t xpmem_get(xpmem_segid_t segid, int flags, int permit_type, return get_info.apid; } -/** - * xpmem_release - give up access to the segment - * @apid: IN: 64-bit access permit ID to release - * Description: - * The opposite of xpmem_get(), this function deletes any mappings in the - * consumer's address space. - * Context: - * Optionally called by the consumer process, otherwise automatically - * called by the driver when the consumer process exits. - * Return Value: - * Success: 0 - * Failure: -1 - */ int xpmem_release(xpmem_apid_t apid) { struct xpmem_cmd_release release_info; @@ -182,25 +126,6 @@ int xpmem_release(xpmem_apid_t apid) return 0; } -/** - * xpmem_attach - map a source address to own address space - * @addr: IN: a structure consisting of a xpmem_apid_t apid and an off_t offset - * addr.apid: access permit ID returned from a previous xpmem_get() call - * addr.offset: offset into the source memory to begin the mapping - * @size: IN: number of bytes to map - * @vaddr: IN: address at which the mapping should be created, or NULL if the - * kernel should choose - * Description: - * Attaches a virtual address space range from the source process. - * Context: - * Called by the consumer to get a mapping between the shared source - * address and an address in the consumer process' own address space. If - * the mapping is successful, then the consumer process can now begin - * accessing the shared memory. - * Return Value: - * Success: virtual address at which the mapping was created - * Failure: -1 - */ void *xpmem_attach(struct xpmem_addr addr, size_t size, void *vaddr) { struct xpmem_cmd_attach attach_info; @@ -216,19 +141,6 @@ void *xpmem_attach(struct xpmem_addr addr, size_t size, void *vaddr) return (void *)attach_info.vaddr; } -/** - * xpmem_detach - remove a mapping between consumer and source - * @vaddr: IN: virtual address within an XPMEM mapping in the consumer's - * address space - * Description: - * Detach from the virtual address space of the source process. - * Context: - * Optionally called by the consumer process, otherwise automatically - * called by the driver when the consumer process exits. - * Return Value: - * Success: 0 - * Failure: -1 - */ int xpmem_detach(void *vaddr) { struct xpmem_cmd_detach detach_info; @@ -239,13 +151,6 @@ int xpmem_detach(void *vaddr) return 0; } -/** - * xpmem_version - get the XPMEM version - * - * Return Value: - * Success: XPMEM version number - * Failure: -1 - */ int xpmem_version(void) { return xpmem_ioctl(XPMEM_CMD_VERSION, NULL); From 7921d41e9989998a468e68d17ca0c921543bb99b Mon Sep 17 00:00:00 2001 From: Nathan Hjelm Date: Wed, 23 Mar 2016 12:32:50 -0600 Subject: [PATCH 2/2] test: run.sh does not need to be generated Signed-off-by: Nathan Hjelm --- test/Makefile.am | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Makefile.am b/test/Makefile.am index e803452047f..bbc99333d71 100644 --- a/test/Makefile.am +++ b/test/Makefile.am @@ -6,5 +6,5 @@ AM_LDFLAGS = @top_srcdir@/lib/libxpmem.la noinst_PROGRAMS = xpmem_proc1 xpmem_proc2 xpmem_master TESTS = run.sh -EXTRA_DIST = include/xpmem_test.h run.sh.in +EXTRA_DIST = include/xpmem_test.h run.sh