diff --git a/ChangeLog b/ChangeLog new file mode 100644 --- /dev/null +++ b/ChangeLog @@ -0,0 +1,7 @@ +2016-06-24 Daniel Gröber + + * Release version 0.0.0.0 + +2016-06-23 Daniel Gröber + + * Initial release diff --git a/GHC/Way.hs b/GHC/Way.hs new file mode 100644 --- /dev/null +++ b/GHC/Way.hs @@ -0,0 +1,96 @@ +-- | +-- Module : GHC.Way +-- Copyright : (c) The University of Glasgow 2005 +-- Copyright (C) 2016 Daniel Gröber +-- License : BSD3 +-- Stability : unknown, ask the GHC guys I guess ;) +-- Portability : portable +-- +-- Stolen from GHC's 'DynFlags' module. +-- + +module GHC.Way where + +import Data.List + +-- The Glasgow Haskell Compiler License + +-- Copyright 2002, The University Court of the University of Glasgow. +-- All rights reserved. +-- +-- Redistribution and use in source and binary forms, with or without +-- modification, are permitted provided that the following conditions are met: +-- +-- - Redistributions of source code must retain the above copyright notice, +-- this list of conditions and the following disclaimer. +-- +-- - Redistributions in binary form must reproduce the above copyright notice, +-- this list of conditions and the following disclaimer in the documentation +-- and/or other materials provided with the distribution. +-- +-- - Neither name of the University nor the names of its contributors may be +-- used to endorse or promote products derived from this software without +-- specific prior written permission. +-- +-- THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY COURT OF THE UNIVERSITY OF +-- GLASGOW AND THE CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +-- INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +-- FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +-- UNIVERSITY COURT OF THE UNIVERSITY OF GLASGOW OR THE CONTRIBUTORS BE LIABLE +-- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +-- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +-- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +-- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +-- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +-- DAMAGE. + +-- | GHC library way, see +data Way + = WayCustom String -- for GHC API clients building custom variants + | WayThreaded + | WayDebug + | WayProf + | WayEventLog + | WayDyn + deriving (Eq, Ord, Show) + +allowed_way_combination :: [Way] -> Bool +allowed_way_combination way = and [ x `allowedWith` y + | x <- way, y <- way, x < y ] + where + -- Note ordering in these tests: the left argument is + -- <= the right argument, according to the Ord instance + -- on Way above. + + -- dyn is allowed with everything + _ `allowedWith` WayDyn = True + WayDyn `allowedWith` _ = True + + -- debug is allowed with everything + _ `allowedWith` WayDebug = True + WayDebug `allowedWith` _ = True + + (WayCustom {}) `allowedWith` _ = True + WayThreaded `allowedWith` WayProf = True + WayThreaded `allowedWith` WayEventLog = True + _ `allowedWith` _ = False + +mkBuildTag :: [Way] -> String +mkBuildTag ways = concat (intersperse "_" (map wayTag ways)) + +wayTag :: Way -> String +wayTag (WayCustom xs) = xs +wayTag WayThreaded = "thr" +wayTag WayDebug = "debug" +wayTag WayDyn = "dyn" +wayTag WayProf = "p" +wayTag WayEventLog = "l" + +wayRTSOnly :: Way -> Bool +wayRTSOnly (WayCustom {}) = False +wayRTSOnly WayThreaded = True +wayRTSOnly WayDebug = True +wayRTSOnly WayDyn = False +wayRTSOnly WayProf = False +wayRTSOnly WayEventLog = True diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state 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 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 3 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, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/LICENSE.GHC b/LICENSE.GHC new file mode 100644 --- /dev/null +++ b/LICENSE.GHC @@ -0,0 +1,31 @@ +The Glasgow Haskell Compiler License + +Copyright 2002, The University Court of the University of Glasgow. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +- Redistributions of source code must retain the above copyright notice, +this list of conditions and the following disclaimer. + +- Redistributions in binary form must reproduce the above copyright notice, +this list of conditions and the following disclaimer in the documentation +and/or other materials provided with the distribution. + +- Neither name of the University nor the names of its contributors may be +used to endorse or promote products derived from this software without +specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY COURT OF THE UNIVERSITY OF +GLASGOW AND THE CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +UNIVERSITY COURT OF THE UNIVERSITY OF GLASGOW OR THE CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +DAMAGE. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +Haskell dynamic library loader +============================== + +Load and execute functions from Haskell dynamic libraries without being +restricted to a single RTS/GHC version. + +This package consists of the initial loader executable `rts-loader` written +in plain C and a Haskell library providing a convinient interface to it. The +initial loader executable is implemented in C since writing it in Haskell would +mean linking against the RTS which means we can't load libraries compiled with +another version of GHC. + +In order to get Cabal to compile a pure C executable while not linking against +the RTS still some hacks in `Setup.hs` are employed to call `gcc` directly so +beware. + +Usage +----- + +The example below will locate the package "foopkg" in the package databases +configured for the Cabal project in the current directory and execute the +function "main" from the module "Lib". The package can be found in +`tests/lib` in the rts-loader source tree. + +To run the example, execute the following commands in the rts-loader source +tree. + +``` +$ cabal install --only-dependencies && cabal configure && cabal build && cabal install tests/lib +$ rts_loader_libexecdir=dist/build/rts-loader dist/build/rts-loader-example/rts-loader-example +``` + +`rts_loader_libexecdir=...` is only required if you didn't install rts-loader +into a sandbox or elsewhere already. + + import System.Loader.RTS + import System.Process + + import Distribution.Verbosity + import Distribution.Package + import Distribution.Simple.Configure + + import Distribution.Simple.LocalBuildInfo + import Distribution.Simple.Configure (getPersistBuildConfig) + + main :: IO () + main = do + lbi <- getPersistBuildConfig "dist" + + let verbosity = normal + comp = compiler lbi + pkg_db_stack = withPackageDB lbi + prog_conf = withPrograms lbi + + pidx <- getInstalledPackages verbosity comp pkg_db_stack prog_conf + + loader_exe <- loaderExecutablePath + loader_args <- loaderInvocation (SymbolIdentifier "Lib" "main") [] <$> + (resolveLibraryInfo comp [WayDyn] $ + lookupLibraryInfo pidx $ + PQName $ PackageName "foopkg") + + print =<< rawSystem loader_exe loader_args + +We use information written by `cabal configure` (see `getPersistBuildConfig`) +for convinience only this is not actually required to use the loader. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,138 @@ +{-# LANGUAGE NamedFieldPuns #-} +import Control.Applicative +import Control.Arrow +import Control.Monad +import Data.Maybe +import Distribution.Verbosity +import Distribution.Simple +import Distribution.Simple.Setup +import Distribution.Simple.Program.Builtin +import Distribution.Simple.Program.Run +import Distribution.Simple.Program.Db +import Distribution.Simple.LocalBuildInfo +import Distribution.Simple.GHC +import Distribution.Simple.Utils +import Distribution.Simple.Build +import Distribution.Simple.Install +import Distribution.Simple.Configure +import Distribution.PackageDescription +import System.FilePath + +import System.IO + +main = defaultMainWithHooks $ simpleUserHooks { + buildHook = myBuildHook, + preBuild = myPreBuild, + instHook = myInst, + copyHook = myCopy + } + +-- Set loader buildability to false since we're building that ourselfs +myPreBuild args flags = return $ buildableHBI "rts-loader" False + +myBuildHook pd lbi uh flags = do + buildLoaderExecutable pd lbi flags + -- gah Cabal throws an error if there are no buildable components + unless (null $ allBuildInfo pd) $ + (buildHook simpleUserHooks) pd lbi uh flags + +buildLoaderExecutable pd lbi flags = do + let distPref = fromFlag (buildDistPref flags) + verbosity = fromFlag (buildVerbosity flags) + + (ghc, _) <- requireProgram verbosity ghcProgram (withPrograms lbi) + (gcc, _) <- requireProgram verbosity gccProgram (withPrograms lbi) + + ghcInfo <- getGhcInfo verbosity ghc + + let [Executable {exeName=exeName', modulePath}] = + filter ((== "rts-loader") . exeName) $ executables pd + targetDir = buildDir lbi exeName' + exeDir = targetDir (exeName' ++ "-tmp") + + createDirectoryIfMissingVerbose verbosity True targetDir + createDirectoryIfMissingVerbose verbosity True exeDir + + let Just libDir = lookup "LibDir" ghcInfo + includes = [libDir "include"] + includeOpts = map ("-I"++) includes + libs = ["dl"] + libOpts = map ("-l"++) libs + opts = ["-o", targetDir exeName'] + ++ includeOpts + ++ libOpts + ++ [modulePath] + + gccInvokation = programInvocation gcc opts + + runProgramInvocation verbosity gccInvokation + + +myInst = myInstOrCopy instHook installVerbosity +myCopy = myInstOrCopy copyHook copyVerbosity + +myInstOrCopy :: (UserHooks + -> PackageDescription + -> LocalBuildInfo + -> UserHooks + -> flags + -> IO ()) + -> (flags -> Distribution.Simple.Setup.Flag Verbosity) + -> PackageDescription + -> LocalBuildInfo + -> UserHooks + -> flags + -> IO () +myInstOrCopy hook verbosity pd lbi hooks flags = do + let [exe] = filter ((=="rts-loader") . exeName) (executables pd) + Just install_dir = + lookup "x-install-dir" $ customFieldsBI $ buildInfo exe + + libexec = fromPathTemplate $ libexecdir (installDirTemplates lbi) + install_dir' = toPathTemplate $ substLibexecdir libexec install_dir + + lbi_libexec = modifyInstallDirTemplates (setBindir install_dir') lbi + + hbi_only_exe = disableAllInstallComponentsExcept pd "rts-loader" + hbi_not_exe = buildableHBI "rts-loader" False + + pd_only_exe = updatePackageDescription hbi_only_exe pd + pd_not_exe = updatePackageDescription hbi_not_exe pd + + distPref <- findDistPrefOrDefault (copyDistPref defaultCopyFlags) + + let copyFlags = defaultCopyFlags { copyDistPref = toFlag distPref + , copyVerbosity = verbosity flags + } + + install pd_only_exe lbi_libexec copyFlags + + (hook simpleUserHooks) pd_not_exe lbi hooks flags + where + modifyInstallDirTemplates f lbi = + lbi { installDirTemplates = f (installDirTemplates lbi) } + setBindir bindir' inst_dirs = + inst_dirs { bindir = bindir' } + + substLibexecdirComp libexec "$libexecdir" = libexec + substLibexecdirComp _ comp = comp + + substLibexecdir libexec = onSplitPath $ + map (substLibexecdirComp libexec . dropTrailingPathSeparator) + + + onSplitPath f p = joinPath $ f (splitPath p) + + +buildableHBI pkg build = + (Nothing, [(pkg, setBuildable build)]) + +setBuildable build = emptyBuildInfo { buildable = build } + +disableAllInstallComponentsExcept pd except = + let lib = (const (setBuildable False)) <$> library pd + exes = [ (exeName exe, setBuildable (exeName exe == except)) + | exe <- executables pd + ] + in + (lib, exes) diff --git a/System/Loader/RTS.hs b/System/Loader/RTS.hs new file mode 100644 --- /dev/null +++ b/System/Loader/RTS.hs @@ -0,0 +1,314 @@ +-- | +-- Module : System.Loader.RTS +-- Copyright : Copyright (C) 2016 Daniel Gröber +-- License : GPLv3+ +-- +-- Stability : experimental +-- +-- Portability : tested on Linux, might work on OSX, will support Win32 in the +-- future if possible +-- +-- Dynamically load entrypoints from Haskell libraries independent of the RTS +-- version. +-- + +-- 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 3 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, see . + +module System.Loader.RTS + ( + -- * Functions + lookupLibraryInfo + , resolveLibraryInfo + , loaderInvocation + , loaderExecutablePath + + -- * Type Synonyms + , ModuleName + , OccName + + -- * Datatypes + , PackageQualifier(..) + , SymbolIdentifier(..) + + -- * Internal Datatypes + , LibraryInfo + , ResolvedLibraryInfo + + , Way(..) + , module Distribution.Simple.PackageIndex + , module Distribution.Compiler + ) where + +import Control.Monad +import Data.Version +import Data.Maybe +import Data.List +import Text.Encoding.Z +import System.Info +import System.FilePath +import System.Directory + +import GHC.Way + +import Distribution.Text +import Distribution.Package hiding (installedUnitId) +import Distribution.Compiler +import Distribution.Simple.Compiler +import Distribution.Simple.PackageIndex +import Distribution.InstalledPackageInfo + +import Paths_rts_loader + +-- | Encodes the ways a package can be looked up in a 'PackageIndex' +data PackageQualifier = PQName PackageName -- ^ Identify a package by just its + -- name, if multiple packages match + -- the latest version is picked but + -- which unit id is picked is + -- undefined. + | PQId PackageId -- ^ Identify a package by its name + -- and version. If multiple packages + -- are found with varying unit ids + -- which one is picked is undefined. + | PQUnitId UnitId -- ^ Fully qualified package only one + -- package matching can be present in + -- a package database. + deriving(Eq, Ord, Read, Show) + +-- | Identify a binder (aka. a "symbol" at the object file level) within a +-- package. +data SymbolIdentifier = SymbolIdentifier ModuleName OccName + deriving(Eq, Ord, Read, Show) + +sortByVersion :: [(Version, [a])] -> [(Version, [a])] +sortByVersion = sortBy comp + where + comp (a,_) (b, _) = a `compare` b + +lookupPackageQualifier :: PackageIndex a -> PackageQualifier -> Maybe a +lookupPackageQualifier pidx (PQName pkg_name) = do + (_ver, pkgs) <- listToMaybe $ reverse $ sortByVersion $ + lookupPackageName pidx pkg_name + listToMaybe pkgs +lookupPackageQualifier pidx (PQId pkg_id) = + listToMaybe $ lookupSourcePackageId pidx pkg_id +lookupPackageQualifier pidx (PQUnitId unit_id) = + lookupUnitId pidx unit_id + +-- | Information about a library extracted from a package database stack. +data LibraryInfo = LibraryInfo String [FilePath] [InstalledPackageInfo] + +-- | Everything in 'LibraryInfo' plus fully resolved library paths. +data ResolvedLibraryInfo = ResolvedLibraryInfo LibraryInfo [FilePath] + + -- TODO: enumerating all packages is silly slow +-- pidx <- getInstalledPackages verbosity comp pkg_db_stack prog_conf + + +-- | CompilerId GHC ver <- compilerId comp = let + -- -> Compiler + -- -- ^ Compiler information used (among other things) to + -- -- construct the library suffix + -- -- ex. @libHSfoo-0.1-SOMEHASH-ghc7.10.3.so@ + -- -> PackageDBStack + -- -- ^ Where to look for installed libraries + -- -> ProgramConfiguration + -- -- ^ We need @ghc-pkg@ to list installed libraries + +-- | @lookupLibraryInfo pkg_index pkg_qual@ +-- +-- Gets all the information required for loading a library from a package +-- database out of the corresponding package index @pkg_index@. The desired +-- package is identified using @pkg_qual@ which allows doing the lookup by name, +-- name+version or the unique "unit id" associated with a package. +-- +-- The @pkg_index@ must at the very least contain the packages "base", "rts" and +-- the package identified by @pkg_qual@. The packages "base" and "rts" are +-- required because of GHC bug +-- thus this restriction might disappear eventually. +-- +-- The required package index can be obtained using +-- @'Distribution.Simple.Configure.getInstalledPackages' verbosity comp +-- pkg_db_stack prog_conf@ +lookupLibraryInfo :: InstalledPackageIndex -> PackageQualifier -> LibraryInfo +lookupLibraryInfo pidx pkg_qual = let + lookupPkg = lookupPackageQualifier pidx + + Just ipi = lookupPackageQualifier pidx pkg_qual + Just base_ipi = lookupPkg (PQName $ PackageName "base") + Just rts_ipi = lookupPkg (PQName $ PackageName "rts") + + pkg_key = compatPackageKey ipi + + ipis = [ipi, base_ipi, rts_ipi] + libdirs = libraryDirs `concatMap` ipis + in + LibraryInfo pkg_key libdirs ipis + +-- | @resolveLibraryInfo comp ways li@ +-- +-- Find libraries mentioned in @li@ on the filesystem. +-- +-- * @comp@ identifies the compiler (version, ABI etc.) and +-- +-- * @ways@ allows looking for the different library versions, i.e. "plain", +-- "profiled", "threaded" and combinations thereof (note that order is +-- significant"). Usually you'll just want @[WayDyn]@ though even this is +-- implied so @[]@ would suffice for a plain library. +-- +-- See . +resolveLibraryInfo :: Compiler + -> [Way] + -> LibraryInfo + -> IO ResolvedLibraryInfo +resolveLibraryInfo comp ways li@(LibraryInfo _ libdirs ipis) + | CompilerId GHC _ <- compilerId comp = + ResolvedLibraryInfo li <$> forM ipis resolveLibrary + where + comp_abi = showGHCCompilerIdWithAbi comp + resolveLibrary ipi = do + let PackageIdentifier (PackageName pkg_name) _ = sourcePackageId ipi + [lib] = filter (isPrefixOf ("HS"++pkg_name)) $ hsLibraries ipi + + ways' = filter wayRTSOnly ways + lib' | "rts" <- pkg_name, [] <- ways' = lib + | "rts" <- pkg_name = + lib ++ "_" ++ intercalate "-" (map wayTag ways') + | otherwise = lib + + Just lib'' <- findLibrary libdirs comp_abi lib' + return lib'' + +-- | @loaderInvocation sym args rli@ +-- +-- Construct the commandline for the @rts-loader@ program which +-- +-- * loads the library described by @rli@, +-- +-- * executes @sym@ as its "main" function (i.e. it should be of type @IO ()@) +-- and +-- +-- * passes the command line arguments @args@ via the environment. +loaderInvocation :: SymbolIdentifier + -> [String] -- ^ Command line arguments to pass to hs_main + -> ResolvedLibraryInfo + -> [String] +loaderInvocation sym args (ResolvedLibraryInfo (LibraryInfo pkey _ _) libs) = + let Symbol sym' = mkSymbol pkey sym "closure" + loader_args = concat [[sym'], libs, ["--"], args] + in + loader_args + +-- | Path to the "@rts-loader@" executable distributed along with this +-- library, "@$libexec/rts-loader@". If set the environment variable +-- @rts_loader_libexecdir@ is used instead of Cabal's "@$libexec@" variable +-- which was set during installation time. +loaderExecutablePath :: IO FilePath +loaderExecutablePath = ( "rts-loader") <$> getLibexecDir + +-- | Just the compiler flavor and version parts of 'showGHCCompilerIdWithAbi' +showGHCCompilerId :: Compiler -> String +showGHCCompilerId comp = let + CompilerId flav ver = compilerId comp + in + display flav ++ display ver + +-- | Print the library ABI string for GHC, returns something like @ghc7.10.3@ +-- depending on the version. This is the postfix appended to shared library +-- names eg. "libHSzenc-0.1.1-5nxwDFCcrv6wKRoUdekV7-ghc7.10.3.so". + +-- I'm not sure how other compilers handle this, probably none of them even +-- support shared libraries so what does it matter anyways ;) +showGHCCompilerIdWithAbi :: Compiler -> String +showGHCCompilerIdWithAbi comp = + showGHCCompilerId comp ++ + case compilerAbiTag comp of + NoAbiTag -> [] + AbiTag xs -> xs + +-- | @findLibrary dirs comp_abi lib@. +-- +-- Search for Haskell library @lib@ in @dirs@ while taking into account the +--compiler id @comp_abi@ (see 'showGHCCompilerIdWithAbi') as well as relevant +--platform conventions namely library prefix and extension. @lib@ must be given +--without a "lib" prefix and without an extension. +findLibrary :: [FilePath] -> String -> String -> IO (Maybe FilePath) +findLibrary dirs comp_abi lib = do + let (prefix, ext) = libraryPathStuff + lib' = prefix ++ intercalate "-" [lib, comp_abi] <.> ext + findFile dirs lib' + +-- | Library prefix and extension based on 'System.Info.os', eg. on Linux +-- @("lib", "so")@ +libraryPathStuff :: (String, String) +libraryPathStuff = + case os of + "linux" -> ("lib", "so") + + -- untested + "mingw32" -> ("", "dll") + "cygwin" -> ("", "dll") + "darwin" -> ("", "dylib") + _ -> error "libraryPathStuff: unknown operating system" + +-- | A regular Haskell module name eg. @System.Loader.RTS@ +type ModuleName = String + +-- | An unqualified name of a binder eg. @main@ +type OccName = String + +-- | The name of a symbol as it occurs in a compiled Haskell object file. Must +-- be constructed by 'mkSymbol'. The precise format varies across GHC versions, +-- see 'nameToCLabel' in compiler/ghci/ByteCodeLink.hs. +data Symbol = Symbol String + +-- | @mkSymbol pkg_key (SymbolIdentifier module_name occ_name) suffix@ +-- +-- Constructs a well formed 'Symbol' when +-- +-- * @pkg_key@ is a valid package key as can be found in the @key@ field of a +-- package database @.conf@ file, +-- +-- * @module_name@ is a valid Haskell module name (modid), +-- +-- * @occ_name@ is a valid Haskell variable identifier (varid), +-- +-- * @suffix@ is at least one of @["con_info", "closure"]@ (other valid options +-- can be found scattered across the GHC source code. The most interesting +-- option is "closure" as this is what the entry points to functions are called. +mkSymbol :: String -> SymbolIdentifier -> String -> Symbol +mkSymbol pkg_key (SymbolIdentifier module_name occ_name) suffix = + Symbol sym + where + sym = concat + [ prefixUnderscore + , if pkg_key == mainPackageKey then "" else zEncodeString pkg_key ++ "_" + , zEncodeString module_name + , '_':zEncodeString occ_name + , '_':suffix + ] + +-- I'm not sure I even need this here since we only deal with external libraries +-- but it shouldn't hurt +mainPackageKey :: String +mainPackageKey = "main" + +prefixUnderscore :: String +prefixUnderscore = + case (os,arch) of + ("mingw32","x86_64") -> "" + ("cygwin","x86_64") -> "" + ("mingw32",_) -> "_" + ("darwin",_) -> "_" + ("cygwin",_) -> "_" + _ -> "" diff --git a/rts-loader.c b/rts-loader.c new file mode 100644 --- /dev/null +++ b/rts-loader.c @@ -0,0 +1,238 @@ +/* + * rts-loader: Dynamically load the GHC runtime system + * Copyright (C) 2016 Daniel Gröber + * + * 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 3 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, see . + */ + +#define _GNU_SOURCE +#include +#include +#include +#include +#include + +#include + +#include "log.h" + +#if defined(__gnu_linux__) +#define LD_PRELOAD "LD_PRELOAD" +#elif defined(__APPLE__) +#define LD_PRELOAD "DYLD_INSERT_LIBRARIES" +#else +#error "unsupported OS" +#endif + +bool is_basename_prefix_of(const char *pfx, const char *path) +{ + // GNU basename "never modifies its argument" + return strncmp(pfx, basename(path), strlen(pfx)) == 0; +} + +bool is_rtslib(const char *path) +{ + return is_basename_prefix_of("libHSrts", path); +} + +bool is_baselib(const char *path) +{ + return is_basename_prefix_of("libHSbase", path); +} + +void usage(char *progname) +{ + printf("Usage: %s MAIN_CLOSURE [PRELOAD_LIBS..] libHSrts-*.so* libHSbase-*.so* [LIBS..] -- [HS_ARGV..]\n", progname); +} + +int preloader(int argc, char *argv[]) +{ + if(argc < 2) { + usage(argv[0]); + return 1; + } + + size_t preload_blen = 128; + size_t preload_slen = 0; + char* preload = calloc(preload_blen, 1); + char *preload_ptr = preload; + if(!preload) + log_error(return 1, "malloc() failed"); + + char *rts = NULL; + char *base = NULL; + + int i = 2; + for(; i < argc; i++) { + char *path = argv[i]; + log_debug("path: %s", path); + + if(preload_slen + strlen(path) + strlen(" ") + 1 > preload_blen) + { + preload_blen *= 2; + preload = realloc(preload, preload_blen); + preload_ptr = strchr(preload, '\0'); + } + + int nchar = snprintf(preload_ptr, preload_blen - preload_slen, "%s ", path); + if(nchar < 0) + log_errno(return 1, "snprintf() failed"); + preload_slen += nchar; + preload_ptr += nchar; + assert(strlen(preload_ptr) < preload_blen); + assert(preload_slen < preload_blen); + + if(is_rtslib(path)) { + rts = path; + } else if(is_baselib(path)) { + base = path; + } + + if(rts && base) { + break; + } + } + + const char *old_preload = getenv(LD_PRELOAD) ? getenv(LD_PRELOAD) : ""; + size_t final_preload_len = strlen(old_preload) + 1 + strlen(preload); + char *final_preload = malloc(final_preload_len); + if(!final_preload) + log_error(return 1, "malloc() failed"); + + int nchar = snprintf(final_preload, final_preload_len, "%s %s", old_preload, preload); + if(nchar < 0) + log_errno(return 1, "snprintf() failed"); + + + log_debug(LD_PRELOAD"=\"%s\"", final_preload); + + setenv("OLD_" LD_PRELOAD, old_preload, true); + setenv(LD_PRELOAD, final_preload, true); + free(final_preload); + + if(strlen(argv[0]) < 1) + abort(); + + char *argv0 = strdup(argv[0]); + + basename(argv[0])[0] = '='; + + int rv = execvp(argv0, argv); + if(rv < 0) + log_errno(return 1, "execvp() failed %d", errno); + + abort(); +} + +int loader(int argc, char *argv[], char ***hs_argv) +{ + if(argc < 2) + abort(); + + setenv(LD_PRELOAD, getenv("OLD_" LD_PRELOAD) ? getenv("OLD_" LD_PRELOAD) : "", true); + unsetenv("OLD_" LD_PRELOAD); + + char *rts = NULL; + char *base = NULL; + + int i=1; + for(; i < argc; i++) { + char *path = argv[i]; + if(is_rtslib(path)) { + rts = path; + } else if(is_baselib(path)) { + base = path; + } else + continue; + + if(rts && base) + break; + } + + for(i++; i < argc; i++) { + char *path = argv[i]; + + if(strcmp(path, "--") == 0) { + *hs_argv = &argv[i+1]; + return 0; + } + + log_debug("opening %s", path); + void* addr = dlopen(path, RTLD_GLOBAL | RTLD_LAZY); + if(!addr) + log_error(return 1, "dlopen(%s) failed: %s", path, dlerror()); + } + + log_error(return 1, "no libraries given or '--' missing"); +} + +typedef int (*rts_main_t)( int argc, char *argv[], StgClosure *main_closure, RtsConfig rts_config); +int main(int argc, char *argv[]) +{ + if(argc < 1) + abort(); + + char* progbase = basename(argv[0]); + + if(strncmp(progbase, "=", 1) != 0) { + return preloader(argc, argv); + } + + if(argc < 2) { + usage(argv[0]); + return 1; + } + + char *main_symbol = argv[1]; + char **hs_argv = NULL; + int rv = loader(argc, argv, &hs_argv); + if(rv != 0) + log_error(return rv, "loading libraries failed"); + + int hs_argc = 0; + + for(char **tmp = hs_argv; *tmp; tmp++) { + hs_argc++; + log_debug("hs_argv: %s", *tmp); + } + + log_debug("hs_argc: %d", hs_argc); + + void *defRtsCfg_p = dlsym(RTLD_DEFAULT, "defaultRtsConfig"); + if(!defRtsCfg_p) + log_error(return 1, "\"defaultRtsConfig\" symbol not found"); + + StgClosure *main_closure = + (StgClosure*) dlsym(RTLD_DEFAULT, main_symbol); + if(!main_closure) + log_error(return 1, "main closure (%s) not found", main_symbol); + + log_debug("main_symbol: %s %p", main_symbol, main_closure); + + RtsConfig __conf; + memcpy(&__conf, defRtsCfg_p, sizeof(__conf)); + __conf.rts_opts_enabled = RtsOptsSafeOnly; + #if __GLASGOW_HASKELL__ >= 708 + __conf.rts_hs_main = rtsTrue; + #endif + + rts_main_t hs_main_ = dlsym(RTLD_DEFAULT, "hs_main"); + if(!hs_main_) + log_error(return 1, "hs_main symbol not found"); + + log_debug("executing hs_main"); + return hs_main_(hs_argc, hs_argv, main_closure,__conf); + + return 0; +} diff --git a/rts-loader.cabal b/rts-loader.cabal new file mode 100644 --- /dev/null +++ b/rts-loader.cabal @@ -0,0 +1,61 @@ +name: rts-loader +version: 0.0.0.0 +synopsis: Dynamically load Haskell libraries +description: + Load and execute functions from Haskell dynamic libraries without being + restricted to a single RTS/GHC version. + . + See README.md below for more information. + +homepage: https://github.com/DanielG/rts-loader +license: GPL-3 +license-file: LICENSE +license-files: LICENSE LICENSE.GHC +author: Daneil Gröber +maintainer: dxld@darkboxed.org +copyright: Copyright (C) 2016 Daniel Gröber +category: Distribution +cabal-version: >= 1.24.0.0 +build-type: Custom +extra-source-files: ChangeLog, README.md +tested-with: GHC == 7.10.3, GHC == 8.0.1 + +library + exposed-modules: System.Loader.RTS + other-modules: Paths_rts_loader, + GHC.Way + default-language: Haskell2010 + build-depends: base < 4.10 && >= 4.8.0.0, + zenc == 0.1.1, + unix < 2.8 && >= 2.7.1.0, + filepath < 1.5 && >= 1.4.0.0, + directory < 1.3 && >= 1.2.2.0, + Cabal < 1.25 && >= 1.24.0.0 + +executable rts-loader + main-is: rts-loader.c + x-install-dir: $libexecdir + -- PR pending: https://github.com/haskell/cabal/pull/3461 + -- install-dir: $libexecdir + default-language: + -- Not really, it's C actually. See Setup.hs + Haskell98 + +executable rts-loader-example + main-is: Example.hs + default-language: Haskell2010 + hs-source-dirs: src + + build-depends: base < 4.10 && >= 4.8.0.0, + Cabal < 1.25 && >= 1.24.0.0, + process < 1.5 && >= 1.2.3.0, + rts-loader + +custom-setup + setup-depends: base < 4.10 && >= 4.8.0.0, + filepath < 1.5 && >= 1.4.0.0, + Cabal < 1.25 && >= 1.24.0.0 + +source-repository head + type: git + location: https://github.com/DanielG/rts-loader.git diff --git a/src/Example.hs b/src/Example.hs new file mode 100644 --- /dev/null +++ b/src/Example.hs @@ -0,0 +1,28 @@ +import System.Loader.RTS +import System.Process + +import Distribution.Verbosity +import Distribution.Package +import Distribution.Simple.Configure + +import Distribution.Simple.LocalBuildInfo +import Distribution.Simple.Configure (getPersistBuildConfig) + +main :: IO () +main = do + lbi <- getPersistBuildConfig "dist" + + let verbosity = normal + comp = compiler lbi + pkg_db_stack = withPackageDB lbi + prog_conf = withPrograms lbi + + pidx <- getInstalledPackages verbosity comp pkg_db_stack prog_conf + + loader_exe <- loaderExecutablePath + loader_args <- loaderInvocation (SymbolIdentifier "Lib" "main") [] <$> + (resolveLibraryInfo comp [WayDyn] $ + lookupLibraryInfo pidx $ + PQName $ PackageName "foopkg") + + print =<< rawSystem loader_exe loader_args