gisel 0.2.0__py3-none-any.whl

gisel/vocab.py

@@ -0,0 +1,28 @@
+"""Facts about the DSL vocabulary that no single corpus can determine.
+
+Everything here is a property of the language or of the compatibility layer it
+targets, not of a target's rule set.  Each entry names the authority that fixes
+it, so a stale value is a bug you can look up rather than a number to trust.
+"""
+
+# The eleven operators the core IR has, sorted the way
+# `RecordKeeper::getAllDerivedDefinitions` returns them (by name).
+# Authority: llvm/include/llvm/Target/LegalizerCore.td:173-204
+# (widen, narrow, more, fewer, bitcast, ... scalarize), whose record names sort
+# into this order.
+CORE_OPERATORS = [
+    "bitcast", "custom", "fewer", "legal", "libcall", "lower",
+    "more", "narrow", "scalarize", "unsupported", "widen",
+]
+
+# The size of the TableGen compatibility layer, not of the DSL:
+#   builders = number of `LegalizeBuilder` records,
+#   entries  = number of `LegalizeLowering` records,
+#   overloads = sum of each builder's `Formals` length.
+# Authority: llvm/include/llvm/Target/LegalizerInfo.td at d48f5512a162,
+# pinned by tests/artifacts/*.check.json (both targets report 50/64/64).
+#
+# These are exactly the numbers the "the API is not the language" argument
+# turns on: fifty C++ builder methods and sixty-four overloads, against eleven
+# operators and three rule forms.
+BUILDER_VOCABULARY = {"builders": 50, "overloads": 64, "entries": 64}

gisel-0.2.0.dist-info/METADATA

@@ -0,0 +1,379 @@
+Metadata-Version: 2.4
+Name: gisel
+Version: 0.2.0
+Summary: A free-form language for GlobalISel legalizer rules
+License: ==============================================================================
+        The LLVM Project is under the Apache License v2.0 with LLVM Exceptions:
+        ==============================================================================
+        
+                                         Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+            1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+            2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+            3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+            4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+            5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+            6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+            7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+            8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+            9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+            END OF TERMS AND CONDITIONS
+        
+            APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+            Copyright [yyyy] [name of copyright owner]
+        
+            Licensed under the Apache License, Version 2.0 (the "License");
+            you may not use this file except in compliance with the License.
+            You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+            Unless required by applicable law or agreed to in writing, software
+            distributed under the License is distributed on an "AS IS" BASIS,
+            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+            See the License for the specific language governing permissions and
+            limitations under the License.
+        
+        
+        ---- LLVM Exceptions to the Apache 2.0 License ----
+        
+        As an exception, if, as a result of your compiling your source code, portions
+        of this Software are embedded into an Object form of such source code, you
+        may redistribute such embedded portions in such Object form without complying
+        with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+        
+        In addition, if you combine or link compiled forms of this Software with
+        software that is licensed under the GPLv2 ("Combined Software") and if a
+        court of competent jurisdiction determines that the patent provision (Section
+        3), the indemnity provision (Section 9) or other Section of the License
+        conflicts with the conditions of the GPLv2, you may retroactively and
+        prospectively choose to deem waived or otherwise exclude such Section(s) of
+        the License, but only in their entirety and only with respect to the Combined
+        Software.
+        
+        ==============================================================================
+        Software from third parties included in the LLVM Project:
+        ==============================================================================
+        The LLVM Project contains third party software which is under different license
+        terms. All such code will be identified clearly using at least one of two
+        mechanisms:
+        1) It will be in a separate directory tree with its own `LICENSE.txt` or
+           `LICENSE` file at the top containing the specific license and restrictions
+           which apply to that software, or
+        2) It will contain specific license and restriction terms at the top of every
+           file.
+        
+        ==============================================================================
+        Legacy LLVM License (https://llvm.org/docs/DeveloperPolicy.html#legacy):
+        ==============================================================================
+        University of Illinois/NCSA
+        Open Source License
+        
+        Copyright (c) 2003-2019 University of Illinois at Urbana-Champaign.
+        All rights reserved.
+        
+        Developed by:
+        
+            LLVM Team
+        
+            University of Illinois at Urbana-Champaign
+        
+            http://llvm.org
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal with
+        the Software without restriction, including without limitation the rights to
+        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+        of the Software, and to permit persons to whom the Software is furnished to do
+        so, subject to the following conditions:
+        
+            * Redistributions of source code must retain the above copyright notice,
+              this list of conditions and the following disclaimers.
+        
+            * Redistributions in binary form must reproduce the above copyright notice,
+              this list of conditions and the following disclaimers in the
+              documentation and/or other materials provided with the distribution.
+        
+            * Neither the names of the LLVM Team, University of Illinois at
+              Urbana-Champaign, nor the names of its contributors may be used to
+              endorse or promote products derived from this Software without specific
+              prior written permission.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+        CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
+        SOFTWARE.
+        
+        
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# gisel
+
+[![ci](https://github.com/nodecoda/gisel/actions/workflows/ci.yml/badge.svg)](https://github.com/nodecoda/gisel/actions/workflows/ci.yml)
+
+A free-form language for GlobalISel legalizer rules, and the toolchain that
+turns it into LLVM artifacts **without `llvm-tblgen`**.
+
+```sh
+# from a checkout: the corpus and frozen artifacts ship with the repo,
+# not with the wheel (the wheel carries the opcode table lint needs).
+python3 -m pip install .        # or: python3 -m gisel (no install)
+gisel gen   tests/corpus/X86LegalizerInfo.gisel --emit=inc --out x86.inc
+gisel check tests/corpus/X86LegalizerInfo.gisel --emit=inc --against x86.inc
+gisel gen   tests/corpus/X86LegalizerInfo.gisel --emit=td  --out X86LegalizerInfo.td
+gisel lint  tests/corpus/X86LegalizerInfo.gisel   # static checks, no LLVM
+```
+
+## Status
+
+| milestone | backend | gate | state |
+|---|---|---|---|
+| M0 | `--emit=td` | byte-identical to the generated `.td` | done |
+| M1 | `--emit=inc` | byte-identical to `-gen-legalizer` | done |
+| M2 | `--emit=check` | the `-gen-legalizer-check` JSON | done |
+| M3 | `--emit=table` | the `-gen-legalizer-table` fragment | done |
+| M4 | `--emit=core`, `eval` | core JSON (modulo `origin`) / 9632-point differential | done |
+| v0.2 | `lint` | 57 node kinds, 0 errors on both corpora | done |
+
+`tests/artifacts/` holds the eight frozen artifacts and their `SHA256`; the
+corpus is derivable, not hand-tuned: `gisel bootstrap` reproduces both `.gisel`
+files byte for byte from the frozen `.td` + core JSON (asserted in the suite).
+`tests/artifacts/SHA256` (relative paths) is the oracle every backend is measured
+against; `tools/refresh-oracle.sh` re-derives it from a built LLVM tree (development
+only — generation never runs llvm-tblgen).
+
+```sh
+python3 -m unittest discover -q -s tests      # 43 gates, ~9 s
+(cd tests/artifacts && sha256sum -c SHA256)   # 8/8
+```
+
+`gisel lint` runs the J1/J2b/J3a/J3b checks over the normal form and prints
+`path:line: RULESET: message` (exit 1 on errors, 2 on parse/IO).  It needs no
+LLVM source tree: the opcode arity table ships in `gisel/data/`.
+
+Errors point at the source, not at a synthetic string:
+
+```
+$ gisel gen bad.gisel --emit=td --out x.td
+bad.gisel:6: expected ,, got ID ('pow2')      # exit 2
+```
+
+## Evaluating without LLVM
+
+`--emit=core` produces the schema-0.4 normal form, and `gisel eval` answers
+queries against it without any LLVM binary:
+
+```sh
+gisel gen tests/corpus/AArch64LegalizerInfo.gisel --emit=core --out a.core.json
+gisel eval --doc a.core.json \
+  --features tests/cases/features.json --cases tests/cases/a64_ref_dump.jsonl
+# cases=9632 disagreements=0 errors=0
+
+gisel gen tests/corpus/X86LegalizerInfo.gisel --emit=core --out x.core.json
+gisel eval --doc x.core.json \
+  --features tests/cases/x86-features.json --cases tests/cases/x86_ref_dump.jsonl
+# cases=5632 disagreements=0 errors=0
+```
+
+`tests/cases/a64_ref_dump.jsonl` is the frozen AArch64 differential
+(9632 points) dumped from the in-tree reference; `tests/cases/features.json`
+is the subtarget truth table it was recorded with.
+
+## Layout
+
+```
+gisel/dsl.py            lexer, parser, core-IR normal form
+gisel/td.py             .gisel -> .td (M0, compatibility backend)
+gisel/backend/llvm_inc.py  normal form -> .inc (M1)
+gisel/backend/check_json.py / table.py / core_json.py   M2 / M3 / M4
+gisel/eval.py           standalone evaluator (9632 points, 0 disagreements)
+spec/m1-coverage.md     shim coverage of the corpus (25 triples, 0 uncovered)
+spec/grammar.md         the .gisel grammar, normative
+spec/semantics.md       what a rule means (and what the evaluator does)
+```
+
+Ported emitter logic keeps the LLVM license header and names its source commit
+(`d48f5512a162`).

gisel-0.2.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+gisel/__init__.py,sha256=KTFjWuzannEb1qcE6DeePoaQNwZTYwkEVLzGIif5apc,89
+gisel/__main__.py,sha256=4JMK66Wj4uLZTKbF-sT3LAxOsr6buig77PmOkJCRRxw,83
+gisel/cli.py,sha256=7S1RJ5WjXQly338dZjjyOlGbVeeqghPMZX0a8bwodAg,9342
+gisel/dsl.py,sha256=tYIoIE7_drOwm6L8jaTzScfT3lRx4ivjQc9A7bchb-o,59283
+gisel/eval.py,sha256=LiTqZm0C6EpX_CReHMKafMoSCckqOwjcoGlyD-Hacuk,37078
+gisel/td.py,sha256=wtpclJk1wFP29CFLz-QPHVRB2WzQEBfA15SR9iD54EU,33896
+gisel/vocab.py,sha256=IlavOjLwLmIPdfM3f3Z5IEFOdfX_0qLZvLL_dnY_5NI,1371
+gisel/backend/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gisel/backend/check_json.py,sha256=jPjYYPqf5hQUMbFfZwrhsMNh_fmJyW-wcFbn-QQAHOo,2180
+gisel/backend/core_json.py,sha256=XKcBL_Lh_E9ijWSsRppKLH6T-l2JZBGvqwriv5cPqFY,7709
+gisel/backend/llvm_inc.py,sha256=v8QN1APGM-CpDYeRR5cQsszWR_DpocEU7beKcm05gkA,20981
+gisel/backend/table.py,sha256=mbmHPz_wG_q8_D2eH_XGwwIdqc1PMsaPyNzyXUAfXag,23419
+gisel/data/generic_opcodes.json,sha256=iqRU7RKqEzSZ_AHB1PmYpo41osk25M2K01_X0AhG3fU,5981
+gisel-0.2.0.dist-info/licenses/LICENSE,sha256=jYXBBX10Lll5hcfU5jILAVqROThc_0y64G_8Dr6Jr-4,15141
+gisel-0.2.0.dist-info/METADATA,sha256=oQI76VH-Ki_pNOuQ6Uohs_XvU7TnJp9s8ZZWTVb2Ogc,21476
+gisel-0.2.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+gisel-0.2.0.dist-info/entry_points.txt,sha256=S3z8MPsomOfYz1PKNMxs_Sv1t4ig4ePXxS6lTlnzxm0,41
+gisel-0.2.0.dist-info/top_level.txt,sha256=fKPywnqxkUxUgQbWCj6AlhSEh2qV-fa0AOQbmAy3euU,6
+gisel-0.2.0.dist-info/RECORD,,

gisel-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gisel-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gisel = gisel.cli:main