diff --git a/.gitattributes b/.gitattributes index 3114ea516b8228b9c6b0f9dba1c8464f92442d89..a1f8a48b917e004be41b0bab0ffff2ea1fbc411b 100644 --- a/.gitattributes +++ b/.gitattributes @@ -4059,24 +4059,6 @@ tool_server/.venv/lib/python3.12/site-packages/nvidia/cufile/lib/libcufile.so.0 tool_server/.venv/lib/python3.12/site-packages/nvidia/cuda_runtime/lib/libcudart.so.12 filter=lfs diff=lfs merge=lfs -text tool_server/.venv/lib/python3.12/site-packages/nvidia/cuda_nvrtc/lib/libnvrtc-builtins.so.12.6 filter=lfs diff=lfs merge=lfs -text tool_server/.venv/lib/python3.12/site-packages/nvidia/cuda_nvrtc/lib/libnvrtc.so.12 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cuda_cupti/lib/libcheckpoint.so filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cuda_cupti/lib/libcupti.so.12 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cuda_cupti/lib/libnvperf_host.so filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cuda_cupti/lib/libnvperf_target.so filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cuda_cupti/lib/libpcsamplingutil.so filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cublas/lib/libcublas.so.12 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cublas/lib/libcublasLt.so.12 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cublas/lib/libnvblas.so.12 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cusparse/lib/libcusparse.so.12 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cufft/lib/libcufft.so.11 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cufft/lib/libcufftw.so.11 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cudnn/lib/libcudnn.so.9 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cudnn/lib/libcudnn_adv.so.9 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cudnn/lib/libcudnn_cnn.so.9 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cudnn/lib/libcudnn_engines_precompiled.so.9 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cudnn/lib/libcudnn_engines_runtime_compiled.so.9 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cudnn/lib/libcudnn_graph.so.9 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cudnn/lib/libcudnn_heuristic.so.9 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cudnn/lib/libcudnn_ops.so.9 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cusolver/lib/libcusolver.so.11 filter=lfs diff=lfs merge=lfs -text -tool_server/.venv/lib/python3.12/site-packages/nvidia/cusolver/lib/libcusolverMg.so.11 filter=lfs diff=lfs merge=lfs -text +tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/libllvmlite.so filter=lfs diff=lfs merge=lfs -text +tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_binding.cpython-312.pyc filter=lfs diff=lfs merge=lfs -text +tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_ir.cpython-312.pyc filter=lfs diff=lfs merge=lfs -text diff --git a/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..7b7ec664e53926aba1c07e270d2567dcdcf86a77 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/comparator.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/comparator.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..72b392afdc846fc6597036513876d08abbb18800 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/comparator.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/fsm.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/fsm.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..88629cadcc5370fca6fdeb59aca012ac429c9ca9 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/fsm.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/patterns.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/patterns.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..6bcd07f4a2ddd30fa3269b577c89e6ae95736fc5 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/interegular/__pycache__/patterns.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/__init__.py b/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..28b6d34680d11ff67f55ed85914b2d71c3fffd89 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/__init__.py @@ -0,0 +1,15 @@ +import logging +from typing import Iterable + +logger = logging.getLogger('interegular') +logger.addHandler(logging.StreamHandler()) +logger.setLevel(logging.CRITICAL) + + +def soft_repr(s: str): + """ + joins together the repr of each char in the string, while throwing away the repr + This for example turns `"'\""` into `'"` instead of `\'"` like the normal repr + would do. + """ + return ''.join(repr(c)[1:-1] for c in str(s)) diff --git a/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..6026c8dd678a3ac4146874d8314cfec4543c85b0 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/simple_parser.py b/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/simple_parser.py new file mode 100644 index 0000000000000000000000000000000000000000..5f92d75019f47733b04230671507e5e2e2c11d48 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/interegular/utils/simple_parser.py @@ -0,0 +1,165 @@ +""" +A small util to simplify the creation of Parsers for simple context-free-grammars. + +""" + +from abc import ABC, abstractmethod +from collections import defaultdict +from functools import wraps +from types import FunctionType, MethodType +from typing import Generic, TypeVar, Optional, List + +__all__ = ['nomatch', 'NoMatch', 'SimpleParser'] + + +class nomatch(BaseException): + def __init__(self): + pass + + +class NoMatch(ValueError): + def __init__(self, data: str, index: int, expected: List[str]): + self.data = data + self.index = index + self.expected = expected + super(NoMatch, self).__init__(f"Can not match at index {index}. Got {data[index:index + 5]!r}," + f" expected any of {expected}.\n" + f"Context(data[-10:+10]): {data[index - 10: index + 10]!r}") + + +T = TypeVar('T') + + +def _wrap_reset(m): + @wraps(m) + def w(self, *args, **kwargs): + p = self.index + try: + return m(self, *args, **kwargs) + except nomatch: + self.index = p + raise + + return w + + +class SimpleParser(Generic[T], ABC): + def __init__(self, data: str): + self.data = data + self.index = 0 + self._expected = defaultdict(list) + + def __init_subclass__(cls, **kwargs): + for n, v in cls.__dict__.items(): + if isinstance(v, FunctionType) and not n.startswith('_'): + setattr(cls, n, _wrap_reset(v)) + + def parse(self) -> T: + try: + result = self.start() + except nomatch: + raise NoMatch(self.data, max(self._expected), self._expected[max(self._expected)]) from None + if self.index < len(self.data): + raise NoMatch(self.data, max(self._expected), self._expected[max(self._expected)]) + return result + + @abstractmethod + def start(self) -> T: + raise NotImplementedError + + def peek_static(self, expected: str) -> bool: + l = len(expected) + if self.data[self.index:self.index + l] == expected: + return True + else: + self._expected[self.index].append(expected) + return False + + def static(self, expected: str): + length = len(expected) + if self.data[self.index:self.index + length] == expected: + self.index += length + else: + self._expected[self.index].append(expected) + raise nomatch + + def static_b(self, expected: str) -> bool: + l = len(expected) + if self.data[self.index:self.index + l] == expected: + self.index += l + return True + else: + self._expected[self.index].append(expected) + return False + + def anyof(self, *strings: str) -> str: + for s in strings: + if self.static_b(s): + return s + else: + raise nomatch + + def anyof_b(self, *strings: str) -> bool: + for s in strings: + if self.static_b(s): + return True + else: + return False + + def any(self, length: int = 1) -> str: + if self.index + length <= len(self.data): + res = self.data[self.index:self.index + length] + self.index += length + return res + else: + self._expected[self.index].append(f"") + raise nomatch + + def any_but(self, *strings, length: int = 1) -> str: + if self.index + length <= len(self.data): + res = self.data[self.index:self.index + length] + if res not in strings: + self.index += length + return res + else: + self._expected[self.index].append(f"") + raise nomatch + else: + self._expected[self.index].append(f"") + raise nomatch + + def multiple(self, chars: str, mi: int, ma: Optional[int]) -> str: + result = [] + try: + for off in range(mi): + if self.data[self.index + off] in chars: + result.append(self.data[self.index + off]) + else: + self._expected[self.index + off].extend(chars) + raise nomatch + except IndexError: + raise nomatch + self.index += mi + if ma is None: + try: + while True: + if self.data[self.index] in chars: + result.append(self.data[self.index]) + self.index += 1 + else: + self._expected[self.index].extend(chars) + break + except IndexError: + pass + else: + try: + for _ in range(ma - mi): + if self.data[self.index] in chars: + result.append(self.data[self.index]) + self.index += 1 + else: + self._expected[self.index].extend(chars) + break + except IndexError: + pass + return ''.join(result) diff --git a/tool_server/.venv/lib/python3.12/site-packages/jiter/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/jiter/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..8d09ee0976b9ce6eced436bb5a5b79953e6a61c8 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/jiter/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance-0.7.30.dist-info/licenses/LICENSE b/tool_server/.venv/lib/python3.12/site-packages/llguidance-0.7.30.dist-info/licenses/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..9e841e7a26e4eb057b24511e7b92d42b257a80e5 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llguidance-0.7.30.dist-info/licenses/LICENSE @@ -0,0 +1,21 @@ + MIT License + + Copyright (c) Microsoft Corporation. + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in 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: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + 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 + AUTHORS 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 IN THE + SOFTWARE diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..e6d9afabdd5dc2a24881efaaf85e8bdb9060b475 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_grammar_from.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_grammar_from.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..67c53e4b44c32ee8fd810a1e836649d634380772 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_grammar_from.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_struct_tag.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_struct_tag.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..0e8e41c5653b96234715e0a01490a39431a7278c Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_struct_tag.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_tokenizer.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_tokenizer.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..0f8cdb12af1757b742a1189d94ba91333f502da5 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_tokenizer.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_util.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_util.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..32c59e936cedfbd9d0885cd077dc4fa5b87b86f7 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/_util.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/cli.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/cli.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..d2c089e4b066dc5bb3b5e7071b05a1c3e1e2e4fa Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/cli.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/gbnf_to_lark.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/gbnf_to_lark.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..c3b9c2e526ed85a967ca5fa289f008b8af7834a9 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/gbnf_to_lark.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/hf.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/hf.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..cabfeb1280fe8e528d2f35599bb90f329a2e4f40 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/hf.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/llamacpp.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/llamacpp.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..3c22d57d6df415523b0e4224588406b450aeac3f Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/llamacpp.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/mlx.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/mlx.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..974ebfc969687bad23e7ebbc758a7a35fbc62ecb Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/mlx.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/numpy.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/numpy.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..2287dc92bdc1131152917564e99e22c969bf7be2 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/numpy.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/tiktoken.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/tiktoken.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..1d49b09b775189af0338d31b2389f834f5d65c71 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/tiktoken.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/torch.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/torch.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..9d279fb2b743a891a5816204906e358b5f5b6aee Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llguidance/__pycache__/torch.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..37c761ff91a64e674a07f04f26de567af447abe2 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/_version.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/_version.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..4493cbe70365d8a4663a10b1672a8e3eba60fe6d Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/_version.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/utils.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/utils.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..edef7c54121f6011ce77c57e594b2be99fe02b52 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/__pycache__/utils.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__init__.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..2eb177184ea23e984ea4baa44f596579bed534ed --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__init__.py @@ -0,0 +1,19 @@ +""" +Things that rely on the LLVM library +""" +from .dylib import * +from .executionengine import * +from .initfini import * +from .linker import * +from .module import * +from .options import * +from .newpassmanagers import * +from .passmanagers import * +from .targets import * +from .transforms import * +from .value import * +from .typeref import * +from .analysis import * +from .object_file import * +from .context import * +from .orcjit import * diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..9b593cb5a5e391038f5bd02094a60de6c228db6d Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/analysis.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/analysis.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..c4cef5d8925866dc6cb89019b334e3d46b2b9995 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/analysis.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/common.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/common.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..544410ebce5408afc4c8efd2b5fdd72c0d1a935f Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/common.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/context.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/context.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..b15187312d1ec455f1dcf9c2fe7a574d27d17aa8 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/context.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/dylib.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/dylib.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..82d847075811ef2108e69e159300b1161141d1d9 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/dylib.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/executionengine.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/executionengine.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..07943cb492093d22fbb2389c5bb8f5fd644491e4 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/executionengine.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/ffi.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/ffi.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..e3c884b692261598ff5c89c81fbeb386c1473716 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/ffi.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/initfini.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/initfini.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..24c351441469550ea5f5ce8185befb5742efbed3 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/initfini.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/linker.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/linker.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..cc60316e27ab1c19a6e752ad0ada6e420355eaf5 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/linker.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/module.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/module.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..e7fbc215373f566c791ca5a5c028f049c7e6fe0e Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/module.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/newpassmanagers.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/newpassmanagers.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..bc6a4d4c0f5869bda6365395d81f419459ea686b Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/newpassmanagers.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/object_file.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/object_file.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..5abc4cd9182a37fb2747ac82abc2a93cf5f63483 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/object_file.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/options.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/options.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..cb263a400908a6a5bbc8cfbef3e31faa6b7b226c Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/options.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/orcjit.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/orcjit.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..502c9360436585c3fe563bcd099ab4f3323dff0c Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/orcjit.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/passmanagers.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/passmanagers.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..099970f64e88b3294d95651509db9c44764ccf0f Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/passmanagers.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/targets.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/targets.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..c9f10cfc6276de805bbfa2444f34070a3c060f97 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/targets.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/transforms.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/transforms.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..e6163d503df7a18b235e22f07ec11136a7a5d262 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/transforms.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/typeref.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/typeref.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..6915817f8eafc784702ff48343d9768bef04e5c7 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/typeref.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/value.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/value.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..512151eb260f04f25f98598a902d8904529f1812 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/__pycache__/value.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/analysis.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/analysis.py new file mode 100644 index 0000000000000000000000000000000000000000..fe2692bf9c58478972ba4d2ce7f4a9c55bc0a068 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/analysis.py @@ -0,0 +1,69 @@ +""" +A collection of analysis utilities +""" + +from ctypes import POINTER, c_char_p, c_int + +from llvmlite.binding import ffi +from llvmlite.binding.module import parse_assembly + + +def get_function_cfg(func, show_inst=True): + """Return a string of the control-flow graph of the function in DOT + format. If the input `func` is not a materialized function, the module + containing the function is parsed to create an actual LLVM module. + The `show_inst` flag controls whether the instructions of each block + are printed. + """ + assert func is not None + from llvmlite import ir + if isinstance(func, ir.Function): + mod = parse_assembly(str(func.module)) + func = mod.get_function(func.name) + + # Assume func is a materialized function + with ffi.OutputString() as dotstr: + ffi.lib.LLVMPY_WriteCFG(func, dotstr, show_inst) + return str(dotstr) + + +def view_dot_graph(graph, filename=None, view=False): + """ + View the given DOT source. If view is True, the image is rendered + and viewed by the default application in the system. The file path of + the output is returned. If view is False, a graphviz.Source object is + returned. If view is False and the environment is in a IPython session, + an IPython image object is returned and can be displayed inline in the + notebook. + + This function requires the graphviz package. + + Args + ---- + - graph [str]: a DOT source code + - filename [str]: optional. if given and view is True, this specifies + the file path for the rendered output to write to. + - view [bool]: if True, opens the rendered output file. + + """ + # Optionally depends on graphviz package + import graphviz as gv + + src = gv.Source(graph) + if view: + # Returns the output file path + return src.render(filename, view=view) + else: + # Attempts to show the graph in IPython notebook + try: + __IPYTHON__ + except NameError: + return src + else: + import IPython.display as display + format = 'svg' + return display.SVG(data=src.pipe(format)) + + +# Ctypes binding +ffi.lib.LLVMPY_WriteCFG.argtypes = [ffi.LLVMValueRef, POINTER(c_char_p), c_int] diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/common.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/common.py new file mode 100644 index 0000000000000000000000000000000000000000..3f5746a5b057e76b1bf7b33c2892de1640919519 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/common.py @@ -0,0 +1,34 @@ +import atexit + + +def _encode_string(s): + encoded = s.encode('utf-8') + return encoded + + +def _decode_string(b): + return b.decode('utf-8') + + +_encode_string.__doc__ = """Encode a string for use by LLVM.""" +_decode_string.__doc__ = """Decode a LLVM character (byte)string.""" + + +_shutting_down = [False] + + +def _at_shutdown(): + _shutting_down[0] = True + + +atexit.register(_at_shutdown) + + +def _is_shutting_down(_shutting_down=_shutting_down): + """ + Whether the interpreter is currently shutting down. + For use in finalizers, __del__ methods, and similar; it is advised + to early bind this function rather than look it up when calling it, + since at shutdown module globals may be cleared. + """ + return _shutting_down[0] diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/context.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/context.py new file mode 100644 index 0000000000000000000000000000000000000000..192ebd8372588ef28319d4f06266ef9bef5936a0 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/context.py @@ -0,0 +1,39 @@ +from llvmlite.binding import ffi + +# FIXME: Remove me once typed pointers are no longer supported. +from llvmlite import opaque_pointers_enabled +from ctypes import c_bool + + +def create_context(): + return ContextRef( + ffi.lib.LLVMPY_ContextCreate(opaque_pointers_enabled)) + + +def get_global_context(): + return GlobalContextRef( + ffi.lib.LLVMPY_GetGlobalContext(opaque_pointers_enabled)) + + +class ContextRef(ffi.ObjectRef): + def __init__(self, context_ptr): + super(ContextRef, self).__init__(context_ptr) + + def _dispose(self): + ffi.lib.LLVMPY_ContextDispose(self) + + +class GlobalContextRef(ContextRef): + def _dispose(self): + pass + + +# FIXME: Remove argtypes once typed pointers are no longer supported. +ffi.lib.LLVMPY_GetGlobalContext.argtypes = [c_bool] +ffi.lib.LLVMPY_GetGlobalContext.restype = ffi.LLVMContextRef + +# FIXME: Remove argtypes once typed pointers are no longer supported. +ffi.lib.LLVMPY_ContextCreate.argtypes = [c_bool] +ffi.lib.LLVMPY_ContextCreate.restype = ffi.LLVMContextRef + +ffi.lib.LLVMPY_ContextDispose.argtypes = [ffi.LLVMContextRef] diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/dylib.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/dylib.py new file mode 100644 index 0000000000000000000000000000000000000000..e22542c496b7baadc002333f28e14a91e63a359a --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/dylib.py @@ -0,0 +1,45 @@ +from ctypes import c_void_p, c_char_p, c_bool, POINTER + +from llvmlite.binding import ffi +from llvmlite.binding.common import _encode_string + + +def address_of_symbol(name): + """ + Get the in-process address of symbol named *name*. + An integer is returned, or None if the symbol isn't found. + """ + return ffi.lib.LLVMPY_SearchAddressOfSymbol(_encode_string(name)) + + +def add_symbol(name, address): + """ + Register the *address* of global symbol *name*. This will make + it usable (e.g. callable) from LLVM-compiled functions. + """ + ffi.lib.LLVMPY_AddSymbol(_encode_string(name), c_void_p(address)) + + +def load_library_permanently(filename): + """ + Load an external library + """ + with ffi.OutputString() as outerr: + if ffi.lib.LLVMPY_LoadLibraryPermanently( + _encode_string(filename), outerr): + raise RuntimeError(str(outerr)) + +# ============================================================================ +# FFI + + +ffi.lib.LLVMPY_AddSymbol.argtypes = [ + c_char_p, + c_void_p, +] + +ffi.lib.LLVMPY_SearchAddressOfSymbol.argtypes = [c_char_p] +ffi.lib.LLVMPY_SearchAddressOfSymbol.restype = c_void_p + +ffi.lib.LLVMPY_LoadLibraryPermanently.argtypes = [c_char_p, POINTER(c_char_p)] +ffi.lib.LLVMPY_LoadLibraryPermanently.restype = c_bool diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/executionengine.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/executionengine.py new file mode 100644 index 0000000000000000000000000000000000000000..1ba0985ef618ba3d497da8fbf2ee24c7f291c2ec --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/executionengine.py @@ -0,0 +1,330 @@ +import platform +from ctypes import (POINTER, c_char_p, c_bool, c_void_p, + c_int, c_uint64, c_size_t, CFUNCTYPE, string_at, cast, + py_object, Structure) + +from llvmlite.binding import ffi, targets, object_file + + +# Just check these weren't optimized out of the DLL. +ffi.lib.LLVMPY_LinkInMCJIT + + +def create_mcjit_compiler(module, target_machine, use_lmm=None): + """ + Create a MCJIT ExecutionEngine from the given *module* and + *target_machine*. + + *lmm* controls whether the llvmlite memory manager is used. If not supplied, + the default choice for the platform will be used (``True`` on 64-bit ARM + systems, ``False`` otherwise). + """ + if use_lmm is None: + use_lmm = platform.machine() in ('arm64', 'aarch64') + + with ffi.OutputString() as outerr: + engine = ffi.lib.LLVMPY_CreateMCJITCompiler( + module, target_machine, use_lmm, outerr) + if not engine: + raise RuntimeError(str(outerr)) + + target_machine._owned = True + return ExecutionEngine(engine, module=module) + + +def check_jit_execution(): + """ + Check the system allows execution of in-memory JITted functions. + An exception is raised otherwise. + """ + errno = ffi.lib.LLVMPY_TryAllocateExecutableMemory() + if errno != 0: + raise OSError(errno, + "cannot allocate executable memory. " + "This may be due to security restrictions on your " + "system, such as SELinux or similar mechanisms." + ) + + +class ExecutionEngine(ffi.ObjectRef): + """An ExecutionEngine owns all Modules associated with it. + Deleting the engine will remove all associated modules. + It is an error to delete the associated modules. + """ + _object_cache = None + + def __init__(self, ptr, module): + """ + Module ownership is transferred to the EE + """ + self._modules = set([module]) + self._td = None + module._owned = True + ffi.ObjectRef.__init__(self, ptr) + + def get_function_address(self, name): + """ + Return the address of the function named *name* as an integer. + + It's a fatal error in LLVM if the symbol of *name* doesn't exist. + """ + return ffi.lib.LLVMPY_GetFunctionAddress(self, name.encode("ascii")) + + def get_global_value_address(self, name): + """ + Return the address of the global value named *name* as an integer. + + It's a fatal error in LLVM if the symbol of *name* doesn't exist. + """ + return ffi.lib.LLVMPY_GetGlobalValueAddress(self, name.encode("ascii")) + + def add_global_mapping(self, gv, addr): + ffi.lib.LLVMPY_AddGlobalMapping(self, gv, addr) + + def add_module(self, module): + """ + Ownership of module is transferred to the execution engine + """ + if module in self._modules: + raise KeyError("module already added to this engine") + ffi.lib.LLVMPY_AddModule(self, module) + module._owned = True + self._modules.add(module) + + def finalize_object(self): + """ + Make sure all modules owned by the execution engine are fully processed + and "usable" for execution. + """ + ffi.lib.LLVMPY_FinalizeObject(self) + + def run_static_constructors(self): + """ + Run static constructors which initialize module-level static objects. + """ + ffi.lib.LLVMPY_RunStaticConstructors(self) + + def run_static_destructors(self): + """ + Run static destructors which perform module-level cleanup of static + resources. + """ + ffi.lib.LLVMPY_RunStaticDestructors(self) + + def remove_module(self, module): + """ + Ownership of module is returned + """ + with ffi.OutputString() as outerr: + if ffi.lib.LLVMPY_RemoveModule(self, module, outerr): + raise RuntimeError(str(outerr)) + self._modules.remove(module) + module._owned = False + + @property + def target_data(self): + """ + The TargetData for this execution engine. + """ + if self._td is not None: + return self._td + ptr = ffi.lib.LLVMPY_GetExecutionEngineTargetData(self) + self._td = targets.TargetData(ptr) + self._td._owned = True + return self._td + + def enable_jit_events(self): + """ + Enable JIT events for profiling of generated code. + Return value indicates whether connection to profiling tool + was successful. + """ + ret = ffi.lib.LLVMPY_EnableJITEvents(self) + return ret + + def _find_module_ptr(self, module_ptr): + """ + Find the ModuleRef corresponding to the given pointer. + """ + ptr = cast(module_ptr, c_void_p).value + for module in self._modules: + if cast(module._ptr, c_void_p).value == ptr: + return module + return None + + def add_object_file(self, obj_file): + """ + Add object file to the jit. object_file can be instance of + :class:ObjectFile or a string representing file system path + """ + if isinstance(obj_file, str): + obj_file = object_file.ObjectFileRef.from_path(obj_file) + + ffi.lib.LLVMPY_MCJITAddObjectFile(self, obj_file) + + def set_object_cache(self, notify_func=None, getbuffer_func=None): + """ + Set the object cache "notifyObjectCompiled" and "getBuffer" + callbacks to the given Python functions. + """ + self._object_cache_notify = notify_func + self._object_cache_getbuffer = getbuffer_func + # Lifetime of the object cache is managed by us. + self._object_cache = _ObjectCacheRef(self) + # Note this doesn't keep a reference to self, to avoid reference + # cycles. + ffi.lib.LLVMPY_SetObjectCache(self, self._object_cache) + + def _raw_object_cache_notify(self, data): + """ + Low-level notify hook. + """ + if self._object_cache_notify is None: + return + module_ptr = data.contents.module_ptr + buf_ptr = data.contents.buf_ptr + buf_len = data.contents.buf_len + buf = string_at(buf_ptr, buf_len) + module = self._find_module_ptr(module_ptr) + if module is None: + # The LLVM EE should only give notifications for modules + # known by us. + raise RuntimeError("object compilation notification " + "for unknown module %s" % (module_ptr,)) + self._object_cache_notify(module, buf) + + def _raw_object_cache_getbuffer(self, data): + """ + Low-level getbuffer hook. + """ + if self._object_cache_getbuffer is None: + return + module_ptr = data.contents.module_ptr + module = self._find_module_ptr(module_ptr) + if module is None: + # The LLVM EE should only give notifications for modules + # known by us. + raise RuntimeError("object compilation notification " + "for unknown module %s" % (module_ptr,)) + + buf = self._object_cache_getbuffer(module) + if buf is not None: + # Create a copy, which will be freed by the caller + data[0].buf_ptr = ffi.lib.LLVMPY_CreateByteString(buf, len(buf)) + data[0].buf_len = len(buf) + + def _dispose(self): + # The modules will be cleaned up by the EE + for mod in self._modules: + mod.detach() + if self._td is not None: + self._td.detach() + self._modules.clear() + self._object_cache = None + self._capi.LLVMPY_DisposeExecutionEngine(self) + + +class _ObjectCacheRef(ffi.ObjectRef): + """ + Internal: an ObjectCache instance for use within an ExecutionEngine. + """ + + def __init__(self, obj): + ptr = ffi.lib.LLVMPY_CreateObjectCache(_notify_c_hook, + _getbuffer_c_hook, + obj) + ffi.ObjectRef.__init__(self, ptr) + + def _dispose(self): + self._capi.LLVMPY_DisposeObjectCache(self) + + +# ============================================================================ +# FFI + + +ffi.lib.LLVMPY_CreateMCJITCompiler.argtypes = [ + ffi.LLVMModuleRef, + ffi.LLVMTargetMachineRef, + c_bool, + POINTER(c_char_p), +] +ffi.lib.LLVMPY_CreateMCJITCompiler.restype = ffi.LLVMExecutionEngineRef + +ffi.lib.LLVMPY_RemoveModule.argtypes = [ + ffi.LLVMExecutionEngineRef, + ffi.LLVMModuleRef, + POINTER(c_char_p), +] +ffi.lib.LLVMPY_RemoveModule.restype = c_bool + +ffi.lib.LLVMPY_AddModule.argtypes = [ + ffi.LLVMExecutionEngineRef, + ffi.LLVMModuleRef +] + +ffi.lib.LLVMPY_AddGlobalMapping.argtypes = [ffi.LLVMExecutionEngineRef, + ffi.LLVMValueRef, + c_void_p] + +ffi.lib.LLVMPY_FinalizeObject.argtypes = [ffi.LLVMExecutionEngineRef] + +ffi.lib.LLVMPY_GetExecutionEngineTargetData.argtypes = [ + ffi.LLVMExecutionEngineRef +] +ffi.lib.LLVMPY_GetExecutionEngineTargetData.restype = ffi.LLVMTargetDataRef + +ffi.lib.LLVMPY_TryAllocateExecutableMemory.argtypes = [] +ffi.lib.LLVMPY_TryAllocateExecutableMemory.restype = c_int + +ffi.lib.LLVMPY_GetFunctionAddress.argtypes = [ + ffi.LLVMExecutionEngineRef, + c_char_p +] +ffi.lib.LLVMPY_GetFunctionAddress.restype = c_uint64 + +ffi.lib.LLVMPY_GetGlobalValueAddress.argtypes = [ + ffi.LLVMExecutionEngineRef, + c_char_p +] +ffi.lib.LLVMPY_GetGlobalValueAddress.restype = c_uint64 + +ffi.lib.LLVMPY_MCJITAddObjectFile.argtypes = [ + ffi.LLVMExecutionEngineRef, + ffi.LLVMObjectFileRef +] + + +class _ObjectCacheData(Structure): + _fields_ = [ + ('module_ptr', ffi.LLVMModuleRef), + ('buf_ptr', c_void_p), + ('buf_len', c_size_t), + ] + + +_ObjectCacheNotifyFunc = CFUNCTYPE(None, py_object, + POINTER(_ObjectCacheData)) +_ObjectCacheGetBufferFunc = CFUNCTYPE(None, py_object, + POINTER(_ObjectCacheData)) + +# XXX The ctypes function wrappers are created at the top-level, otherwise +# there are issues when creating CFUNCTYPEs in child processes on CentOS 5 +# 32 bits. +_notify_c_hook = _ObjectCacheNotifyFunc( + ExecutionEngine._raw_object_cache_notify) +_getbuffer_c_hook = _ObjectCacheGetBufferFunc( + ExecutionEngine._raw_object_cache_getbuffer) + +ffi.lib.LLVMPY_CreateObjectCache.argtypes = [_ObjectCacheNotifyFunc, + _ObjectCacheGetBufferFunc, + py_object] +ffi.lib.LLVMPY_CreateObjectCache.restype = ffi.LLVMObjectCacheRef + +ffi.lib.LLVMPY_DisposeObjectCache.argtypes = [ffi.LLVMObjectCacheRef] + +ffi.lib.LLVMPY_SetObjectCache.argtypes = [ffi.LLVMExecutionEngineRef, + ffi.LLVMObjectCacheRef] + +ffi.lib.LLVMPY_CreateByteString.restype = c_void_p +ffi.lib.LLVMPY_CreateByteString.argtypes = [c_void_p, c_size_t] diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/ffi.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/ffi.py new file mode 100644 index 0000000000000000000000000000000000000000..3464cb9c7eb9043c3d3120fb1f36d3f2c880f75a --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/ffi.py @@ -0,0 +1,395 @@ +import sys +import ctypes +import threading +import importlib.resources as _impres + +from llvmlite.binding.common import _decode_string, _is_shutting_down +from llvmlite.utils import get_library_name + + +def _make_opaque_ref(name): + newcls = type(name, (ctypes.Structure,), {}) + return ctypes.POINTER(newcls) + + +LLVMContextRef = _make_opaque_ref("LLVMContext") +LLVMModuleRef = _make_opaque_ref("LLVMModule") +LLVMValueRef = _make_opaque_ref("LLVMValue") +LLVMTypeRef = _make_opaque_ref("LLVMType") +LLVMExecutionEngineRef = _make_opaque_ref("LLVMExecutionEngine") +LLVMPassManagerBuilderRef = _make_opaque_ref("LLVMPassManagerBuilder") +LLVMPassManagerRef = _make_opaque_ref("LLVMPassManager") +LLVMTargetDataRef = _make_opaque_ref("LLVMTargetData") +LLVMTargetLibraryInfoRef = _make_opaque_ref("LLVMTargetLibraryInfo") +LLVMTargetRef = _make_opaque_ref("LLVMTarget") +LLVMTargetMachineRef = _make_opaque_ref("LLVMTargetMachine") +LLVMMemoryBufferRef = _make_opaque_ref("LLVMMemoryBuffer") +LLVMAttributeListIterator = _make_opaque_ref("LLVMAttributeListIterator") +LLVMElementIterator = _make_opaque_ref("LLVMElementIterator") +LLVMAttributeSetIterator = _make_opaque_ref("LLVMAttributeSetIterator") +LLVMGlobalsIterator = _make_opaque_ref("LLVMGlobalsIterator") +LLVMFunctionsIterator = _make_opaque_ref("LLVMFunctionsIterator") +LLVMBlocksIterator = _make_opaque_ref("LLVMBlocksIterator") +LLVMArgumentsIterator = _make_opaque_ref("LLVMArgumentsIterator") +LLVMInstructionsIterator = _make_opaque_ref("LLVMInstructionsIterator") +LLVMOperandsIterator = _make_opaque_ref("LLVMOperandsIterator") +LLVMIncomingBlocksIterator = _make_opaque_ref("LLVMIncomingBlocksIterator") +LLVMTypesIterator = _make_opaque_ref("LLVMTypesIterator") +LLVMObjectCacheRef = _make_opaque_ref("LLVMObjectCache") +LLVMObjectFileRef = _make_opaque_ref("LLVMObjectFile") +LLVMSectionIteratorRef = _make_opaque_ref("LLVMSectionIterator") +LLVMOrcLLJITRef = _make_opaque_ref("LLVMOrcLLJITRef") +LLVMOrcDylibTrackerRef = _make_opaque_ref("LLVMOrcDylibTrackerRef") + +LLVMPipelineTuningOptionsRef = _make_opaque_ref("LLVMPipeLineTuningOptions") +LLVMModulePassManagerRef = _make_opaque_ref("LLVMModulePassManager") +LLVMFunctionPassManagerRef = _make_opaque_ref("LLVMFunctionPassManager") +LLVMPassBuilderRef = _make_opaque_ref("LLVMPassBuilder") + + +class _LLVMLock: + """A Lock to guarantee thread-safety for the LLVM C-API. + + This class implements __enter__ and __exit__ for acquiring and releasing + the lock as a context manager. + + Also, callbacks can be attached so that every time the lock is acquired + and released the corresponding callbacks will be invoked. + """ + def __init__(self): + # The reentrant lock is needed for callbacks that re-enter + # the Python interpreter. + self._lock = threading.RLock() + self._cblist = [] + + def register(self, acq_fn, rel_fn): + """Register callbacks that are invoked immediately after the lock is + acquired (``acq_fn()``) and immediately before the lock is released + (``rel_fn()``). + """ + self._cblist.append((acq_fn, rel_fn)) + + def unregister(self, acq_fn, rel_fn): + """Remove the registered callbacks. + """ + self._cblist.remove((acq_fn, rel_fn)) + + def __enter__(self): + self._lock.acquire() + # Invoke all callbacks + for acq_fn, rel_fn in self._cblist: + acq_fn() + + def __exit__(self, *exc_details): + # Invoke all callbacks + for acq_fn, rel_fn in self._cblist: + rel_fn() + self._lock.release() + + +class _suppress_cleanup_errors: + def __init__(self, context): + self._context = context + + def __enter__(self): + return self._context.__enter__() + + def __exit__(self, exc_type, exc_value, traceback): + try: + return self._context.__exit__(exc_type, exc_value, traceback) + except PermissionError: + pass # Resource dylibs can't be deleted on Windows. + + +class _lib_wrapper(object): + """Wrap libllvmlite with a lock such that only one thread may access it at + a time. + + This class duck-types a CDLL. + """ + __slots__ = ['_lib_handle', '_fntab', '_lock'] + + def __init__(self): + self._lib_handle = None + self._fntab = {} + self._lock = _LLVMLock() + + def _load_lib(self): + try: + with _suppress_cleanup_errors(_importlib_resources_path( + __name__.rpartition(".")[0], + get_library_name())) as lib_path: + self._lib_handle = ctypes.CDLL(str(lib_path)) + # Check that we can look up expected symbols. + _ = self._lib_handle.LLVMPY_GetVersionInfo() + except (OSError, AttributeError) as e: + # OSError may be raised if the file cannot be opened, or is not + # a shared library. + # AttributeError is raised if LLVMPY_GetVersionInfo does not + # exist. + raise OSError("Could not find/load shared object file") from e + + @property + def _lib(self): + # Not threadsafe. + if not self._lib_handle: + self._load_lib() + return self._lib_handle + + def __getattr__(self, name): + try: + return self._fntab[name] + except KeyError: + # Lazily wraps new functions as they are requested + cfn = getattr(self._lib, name) + wrapped = _lib_fn_wrapper(self._lock, cfn) + self._fntab[name] = wrapped + return wrapped + + @property + def _name(self): + """The name of the library passed in the CDLL constructor. + + For duck-typing a ctypes.CDLL + """ + return self._lib._name + + @property + def _handle(self): + """The system handle used to access the library. + + For duck-typing a ctypes.CDLL + """ + return self._lib._handle + + +class _lib_fn_wrapper(object): + """Wraps and duck-types a ctypes.CFUNCTYPE to provide + automatic locking when the wrapped function is called. + + TODO: we can add methods to mark the function as threadsafe + and remove the locking-step on call when marked. + """ + __slots__ = ['_lock', '_cfn'] + + def __init__(self, lock, cfn): + self._lock = lock + self._cfn = cfn + + @property + def argtypes(self): + return self._cfn.argtypes + + @argtypes.setter + def argtypes(self, argtypes): + self._cfn.argtypes = argtypes + + @property + def restype(self): + return self._cfn.restype + + @restype.setter + def restype(self, restype): + self._cfn.restype = restype + + def __call__(self, *args, **kwargs): + with self._lock: + return self._cfn(*args, **kwargs) + + +def _importlib_resources_path_repl(package, resource): + """Replacement implementation of `import.resources.path` to avoid + deprecation warning following code at importlib_resources/_legacy.py + as suggested by https://importlib-resources.readthedocs.io/en/latest/using.html#migrating-from-legacy + + Notes on differences from importlib.resources implementation: + + The `_common.normalize_path(resource)` call is skipped because it is an + internal API and it is unnecessary for the use here. What it does is + ensuring `resource` is a str and that it does not contain path separators. + """ # noqa E501 + return _impres.as_file(_impres.files(package) / resource) + + +_importlib_resources_path = (_importlib_resources_path_repl + if sys.version_info[:2] >= (3, 10) + else _impres.path) + + +lib = _lib_wrapper() + + +def register_lock_callback(acq_fn, rel_fn): + """Register callback functions for lock acquire and release. + *acq_fn* and *rel_fn* are callables that take no arguments. + """ + lib._lock.register(acq_fn, rel_fn) + + +def unregister_lock_callback(acq_fn, rel_fn): + """Remove the registered callback functions for lock acquire and release. + The arguments are the same as used in `register_lock_callback()`. + """ + lib._lock.unregister(acq_fn, rel_fn) + + +class _DeadPointer(object): + """ + Dummy class to make error messages more helpful. + """ + + +class OutputString(object): + """ + Object for managing the char* output of LLVM APIs. + """ + _as_parameter_ = _DeadPointer() + + @classmethod + def from_return(cls, ptr): + """Constructing from a pointer returned from the C-API. + The pointer must be allocated with LLVMPY_CreateString. + + Note + ---- + Because ctypes auto-converts *restype* of *c_char_p* into a python + string, we must use *c_void_p* to obtain the raw pointer. + """ + return cls(init=ctypes.cast(ptr, ctypes.c_char_p)) + + def __init__(self, owned=True, init=None): + self._ptr = init if init is not None else ctypes.c_char_p(None) + self._as_parameter_ = ctypes.byref(self._ptr) + self._owned = owned + + def close(self): + if self._ptr is not None: + if self._owned: + lib.LLVMPY_DisposeString(self._ptr) + self._ptr = None + del self._as_parameter_ + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + self.close() + + def __del__(self, _is_shutting_down=_is_shutting_down): + # Avoid errors trying to rely on globals and modules at interpreter + # shutdown. + if not _is_shutting_down(): + if self.close is not None: + self.close() + + def __str__(self): + if self._ptr is None: + return "" + s = self._ptr.value + assert s is not None + return _decode_string(s) + + def __bool__(self): + return bool(self._ptr) + + __nonzero__ = __bool__ + + @property + def bytes(self): + """Get the raw bytes of content of the char pointer. + """ + return self._ptr.value + + +def ret_string(ptr): + """To wrap string return-value from C-API. + """ + if ptr is not None: + return str(OutputString.from_return(ptr)) + + +def ret_bytes(ptr): + """To wrap bytes return-value from C-API. + """ + if ptr is not None: + return OutputString.from_return(ptr).bytes + + +class ObjectRef(object): + """ + A wrapper around a ctypes pointer to a LLVM object ("resource"). + """ + _closed = False + _as_parameter_ = _DeadPointer() + # Whether this object pointer is owned by another one. + _owned = False + + def __init__(self, ptr): + if ptr is None: + raise ValueError("NULL pointer") + self._ptr = ptr + self._as_parameter_ = ptr + self._capi = lib + + def close(self): + """ + Close this object and do any required clean-up actions. + """ + try: + if not self._closed and not self._owned: + self._dispose() + finally: + self.detach() + + def detach(self): + """ + Detach the underlying LLVM resource without disposing of it. + """ + if not self._closed: + del self._as_parameter_ + self._closed = True + self._ptr = None + + def _dispose(self): + """ + Dispose of the underlying LLVM resource. Should be overriden + by subclasses. Automatically called by close(), __del__() and + __exit__() (unless the resource has been detached). + """ + + @property + def closed(self): + """ + Whether this object has been closed. A closed object can't + be used anymore. + """ + return self._closed + + def __enter__(self): + assert hasattr(self, "close") + if self._closed: + raise RuntimeError("%s instance already closed" % (self.__class__,)) + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + self.close() + + def __del__(self, _is_shutting_down=_is_shutting_down): + if not _is_shutting_down(): + if self.close is not None: + self.close() + + def __bool__(self): + return bool(self._ptr) + + def __eq__(self, other): + if not hasattr(other, "_ptr"): + return False + return ctypes.addressof(self._ptr[0]) == \ + ctypes.addressof(other._ptr[0]) + + __nonzero__ = __bool__ + + # XXX useful? + def __hash__(self): + return hash(ctypes.cast(self._ptr, ctypes.c_void_p).value) diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/initfini.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/initfini.py new file mode 100644 index 0000000000000000000000000000000000000000..4466d9da2f2c131b750a2a8ff61ed7381acb7363 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/initfini.py @@ -0,0 +1,73 @@ +from ctypes import c_uint + +from llvmlite.binding import ffi + + +def initialize(): + """ + Initialize the LLVM core. + """ + ffi.lib.LLVMPY_InitializeCore() + + +def initialize_all_targets(): + """ + Initialize all targets. Necessary before targets can be looked up + via the :class:`Target` class. + """ + ffi.lib.LLVMPY_InitializeAllTargetInfos() + ffi.lib.LLVMPY_InitializeAllTargets() + ffi.lib.LLVMPY_InitializeAllTargetMCs() + + +def initialize_all_asmprinters(): + """ + Initialize all code generators. Necessary before generating + any assembly or machine code via the :meth:`TargetMachine.emit_object` + and :meth:`TargetMachine.emit_assembly` methods. + """ + ffi.lib.LLVMPY_InitializeAllAsmPrinters() + + +def initialize_native_target(): + """ + Initialize the native (host) target. Necessary before doing any + code generation. + """ + ffi.lib.LLVMPY_InitializeNativeTarget() + + +def initialize_native_asmprinter(): + """ + Initialize the native ASM printer. + """ + ffi.lib.LLVMPY_InitializeNativeAsmPrinter() + + +def initialize_native_asmparser(): + """ + Initialize the native ASM parser. + """ + ffi.lib.LLVMPY_InitializeNativeAsmParser() + + +def shutdown(): + ffi.lib.LLVMPY_Shutdown() + + +# ============================================================================= +# Set function FFI + +ffi.lib.LLVMPY_GetVersionInfo.restype = c_uint + + +def _version_info(): + v = [] + x = ffi.lib.LLVMPY_GetVersionInfo() + while x: + v.append(x & 0xff) + x >>= 8 + return tuple(reversed(v)) + + +llvm_version_info = _version_info() diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/libllvmlite.so b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/libllvmlite.so new file mode 100644 index 0000000000000000000000000000000000000000..dca4e9f1e8048ffb411f0855ebab3a1a299ad655 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/libllvmlite.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8d5be916c2e4b8d9f7bc6489ab512eaef998f4642feff04c8b85ad207193ce76 +size 132875504 diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/linker.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/linker.py new file mode 100644 index 0000000000000000000000000000000000000000..31d1e26ffb99763af367d07c30fd77770103dc79 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/linker.py @@ -0,0 +1,20 @@ +from ctypes import c_int, c_char_p, POINTER +from llvmlite.binding import ffi + + +def link_modules(dst, src): + with ffi.OutputString() as outerr: + err = ffi.lib.LLVMPY_LinkModules(dst, src, outerr) + # The underlying module was destroyed + src.detach() + if err: + raise RuntimeError(str(outerr)) + + +ffi.lib.LLVMPY_LinkModules.argtypes = [ + ffi.LLVMModuleRef, + ffi.LLVMModuleRef, + POINTER(c_char_p), +] + +ffi.lib.LLVMPY_LinkModules.restype = c_int diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/module.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/module.py new file mode 100644 index 0000000000000000000000000000000000000000..dcbb1faa6545718f9226133ccef42b03a098fd37 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/module.py @@ -0,0 +1,349 @@ +from ctypes import (c_char_p, byref, POINTER, c_bool, create_string_buffer, + c_size_t, string_at) + +from llvmlite.binding import ffi +from llvmlite.binding.linker import link_modules +from llvmlite.binding.common import _decode_string, _encode_string +from llvmlite.binding.value import ValueRef, TypeRef +from llvmlite.binding.context import get_global_context + + +def parse_assembly(llvmir, context=None): + """ + Create Module from a LLVM IR string + """ + if context is None: + context = get_global_context() + llvmir = _encode_string(llvmir) + strbuf = c_char_p(llvmir) + with ffi.OutputString() as errmsg: + mod = ModuleRef( + ffi.lib.LLVMPY_ParseAssembly(context, strbuf, errmsg), + context) + if errmsg: + mod.close() + raise RuntimeError("LLVM IR parsing error\n{0}".format(errmsg)) + return mod + + +def parse_bitcode(bitcode, context=None): + """ + Create Module from a LLVM *bitcode* (a bytes object). + """ + if context is None: + context = get_global_context() + buf = c_char_p(bitcode) + bufsize = len(bitcode) + with ffi.OutputString() as errmsg: + mod = ModuleRef(ffi.lib.LLVMPY_ParseBitcode( + context, buf, bufsize, errmsg), context) + if errmsg: + mod.close() + raise RuntimeError( + "LLVM bitcode parsing error\n{0}".format(errmsg)) + return mod + + +class ModuleRef(ffi.ObjectRef): + """ + A reference to a LLVM module. + """ + + def __init__(self, module_ptr, context): + super(ModuleRef, self).__init__(module_ptr) + self._context = context + + def __str__(self): + with ffi.OutputString() as outstr: + ffi.lib.LLVMPY_PrintModuleToString(self, outstr) + return str(outstr) + + def as_bitcode(self): + """ + Return the module's LLVM bitcode, as a bytes object. + """ + ptr = c_char_p(None) + size = c_size_t(-1) + ffi.lib.LLVMPY_WriteBitcodeToString(self, byref(ptr), byref(size)) + if not ptr: + raise MemoryError + try: + assert size.value >= 0 + return string_at(ptr, size.value) + finally: + ffi.lib.LLVMPY_DisposeString(ptr) + + def _dispose(self): + self._capi.LLVMPY_DisposeModule(self) + + def get_function(self, name): + """ + Get a ValueRef pointing to the function named *name*. + NameError is raised if the symbol isn't found. + """ + p = ffi.lib.LLVMPY_GetNamedFunction(self, _encode_string(name)) + if not p: + raise NameError(name) + return ValueRef(p, 'function', dict(module=self)) + + def get_global_variable(self, name): + """ + Get a ValueRef pointing to the global variable named *name*. + NameError is raised if the symbol isn't found. + """ + p = ffi.lib.LLVMPY_GetNamedGlobalVariable(self, _encode_string(name)) + if not p: + raise NameError(name) + return ValueRef(p, 'global', dict(module=self)) + + def get_struct_type(self, name): + """ + Get a TypeRef pointing to a structure type named *name*. + NameError is raised if the struct type isn't found. + """ + p = ffi.lib.LLVMPY_GetNamedStructType(self, _encode_string(name)) + if not p: + raise NameError(name) + return TypeRef(p) + + def verify(self): + """ + Verify the module IR's correctness. RuntimeError is raised on error. + """ + with ffi.OutputString() as outmsg: + if ffi.lib.LLVMPY_VerifyModule(self, outmsg): + raise RuntimeError(str(outmsg)) + + @property + def name(self): + """ + The module's identifier. + """ + return _decode_string(ffi.lib.LLVMPY_GetModuleName(self)) + + @name.setter + def name(self, value): + ffi.lib.LLVMPY_SetModuleName(self, _encode_string(value)) + + @property + def source_file(self): + """ + The module's original source file name + """ + return _decode_string(ffi.lib.LLVMPY_GetModuleSourceFileName(self)) + + @property + def data_layout(self): + """ + This module's data layout specification, as a string. + """ + # LLVMGetDataLayout() points inside a std::string managed by LLVM. + with ffi.OutputString(owned=False) as outmsg: + ffi.lib.LLVMPY_GetDataLayout(self, outmsg) + return str(outmsg) + + @data_layout.setter + def data_layout(self, strrep): + ffi.lib.LLVMPY_SetDataLayout(self, + create_string_buffer( + strrep.encode('utf8'))) + + @property + def triple(self): + """ + This module's target "triple" specification, as a string. + """ + # LLVMGetTarget() points inside a std::string managed by LLVM. + with ffi.OutputString(owned=False) as outmsg: + ffi.lib.LLVMPY_GetTarget(self, outmsg) + return str(outmsg) + + @triple.setter + def triple(self, strrep): + ffi.lib.LLVMPY_SetTarget(self, + create_string_buffer( + strrep.encode('utf8'))) + + def link_in(self, other, preserve=False): + """ + Link the *other* module into this one. The *other* module will + be destroyed unless *preserve* is true. + """ + if preserve: + other = other.clone() + link_modules(self, other) + + @property + def global_variables(self): + """ + Return an iterator over this module's global variables. + The iterator will yield a ValueRef for each global variable. + + Note that global variables don't include functions + (a function is a "global value" but not a "global variable" in + LLVM parlance) + """ + it = ffi.lib.LLVMPY_ModuleGlobalsIter(self) + return _GlobalsIterator(it, dict(module=self)) + + @property + def functions(self): + """ + Return an iterator over this module's functions. + The iterator will yield a ValueRef for each function. + """ + it = ffi.lib.LLVMPY_ModuleFunctionsIter(self) + return _FunctionsIterator(it, dict(module=self)) + + @property + def struct_types(self): + """ + Return an iterator over the struct types defined in + the module. The iterator will yield a TypeRef. + """ + it = ffi.lib.LLVMPY_ModuleTypesIter(self) + return _TypesIterator(it, dict(module=self)) + + def clone(self): + return ModuleRef(ffi.lib.LLVMPY_CloneModule(self), self._context) + + +class _Iterator(ffi.ObjectRef): + + kind = None + + def __init__(self, ptr, parents): + ffi.ObjectRef.__init__(self, ptr) + self._parents = parents + assert self.kind is not None + + def __next__(self): + vp = self._next() + if vp: + return ValueRef(vp, self.kind, self._parents) + else: + raise StopIteration + + next = __next__ + + def __iter__(self): + return self + + +class _GlobalsIterator(_Iterator): + + kind = 'global' + + def _dispose(self): + self._capi.LLVMPY_DisposeGlobalsIter(self) + + def _next(self): + return ffi.lib.LLVMPY_GlobalsIterNext(self) + + +class _FunctionsIterator(_Iterator): + + kind = 'function' + + def _dispose(self): + self._capi.LLVMPY_DisposeFunctionsIter(self) + + def _next(self): + return ffi.lib.LLVMPY_FunctionsIterNext(self) + + +class _TypesIterator(_Iterator): + + kind = 'type' + + def _dispose(self): + self._capi.LLVMPY_DisposeTypesIter(self) + + def __next__(self): + vp = self._next() + if vp: + return TypeRef(vp) + else: + raise StopIteration + + def _next(self): + return ffi.lib.LLVMPY_TypesIterNext(self) + + next = __next__ + + +# ============================================================================= +# Set function FFI + +ffi.lib.LLVMPY_ParseAssembly.argtypes = [ffi.LLVMContextRef, + c_char_p, + POINTER(c_char_p)] +ffi.lib.LLVMPY_ParseAssembly.restype = ffi.LLVMModuleRef + +ffi.lib.LLVMPY_ParseBitcode.argtypes = [ffi.LLVMContextRef, + c_char_p, c_size_t, + POINTER(c_char_p)] +ffi.lib.LLVMPY_ParseBitcode.restype = ffi.LLVMModuleRef + +ffi.lib.LLVMPY_DisposeModule.argtypes = [ffi.LLVMModuleRef] + +ffi.lib.LLVMPY_PrintModuleToString.argtypes = [ffi.LLVMModuleRef, + POINTER(c_char_p)] +ffi.lib.LLVMPY_WriteBitcodeToString.argtypes = [ffi.LLVMModuleRef, + POINTER(c_char_p), + POINTER(c_size_t)] + +ffi.lib.LLVMPY_GetNamedFunction.argtypes = [ffi.LLVMModuleRef, + c_char_p] +ffi.lib.LLVMPY_GetNamedFunction.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_VerifyModule.argtypes = [ffi.LLVMModuleRef, + POINTER(c_char_p)] +ffi.lib.LLVMPY_VerifyModule.restype = c_bool + +ffi.lib.LLVMPY_GetDataLayout.argtypes = [ffi.LLVMModuleRef, POINTER(c_char_p)] +ffi.lib.LLVMPY_SetDataLayout.argtypes = [ffi.LLVMModuleRef, c_char_p] + +ffi.lib.LLVMPY_GetTarget.argtypes = [ffi.LLVMModuleRef, POINTER(c_char_p)] +ffi.lib.LLVMPY_SetTarget.argtypes = [ffi.LLVMModuleRef, c_char_p] + +ffi.lib.LLVMPY_GetNamedGlobalVariable.argtypes = [ffi.LLVMModuleRef, c_char_p] +ffi.lib.LLVMPY_GetNamedGlobalVariable.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_GetNamedStructType.argtypes = [ffi.LLVMModuleRef, c_char_p] +ffi.lib.LLVMPY_GetNamedStructType.restype = ffi.LLVMTypeRef + +ffi.lib.LLVMPY_ModuleGlobalsIter.argtypes = [ffi.LLVMModuleRef] +ffi.lib.LLVMPY_ModuleGlobalsIter.restype = ffi.LLVMGlobalsIterator + +ffi.lib.LLVMPY_DisposeGlobalsIter.argtypes = [ffi.LLVMGlobalsIterator] + +ffi.lib.LLVMPY_GlobalsIterNext.argtypes = [ffi.LLVMGlobalsIterator] +ffi.lib.LLVMPY_GlobalsIterNext.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_ModuleFunctionsIter.argtypes = [ffi.LLVMModuleRef] +ffi.lib.LLVMPY_ModuleFunctionsIter.restype = ffi.LLVMFunctionsIterator + +ffi.lib.LLVMPY_ModuleTypesIter.argtypes = [ffi.LLVMModuleRef] +ffi.lib.LLVMPY_ModuleTypesIter.restype = ffi.LLVMTypesIterator + +ffi.lib.LLVMPY_DisposeFunctionsIter.argtypes = [ffi.LLVMFunctionsIterator] + +ffi.lib.LLVMPY_DisposeTypesIter.argtypes = [ffi.LLVMTypesIterator] + +ffi.lib.LLVMPY_FunctionsIterNext.argtypes = [ffi.LLVMFunctionsIterator] +ffi.lib.LLVMPY_FunctionsIterNext.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_TypesIterNext.argtypes = [ffi.LLVMTypesIterator] +ffi.lib.LLVMPY_TypesIterNext.restype = ffi.LLVMTypeRef + +ffi.lib.LLVMPY_CloneModule.argtypes = [ffi.LLVMModuleRef] +ffi.lib.LLVMPY_CloneModule.restype = ffi.LLVMModuleRef + +ffi.lib.LLVMPY_GetModuleName.argtypes = [ffi.LLVMModuleRef] +ffi.lib.LLVMPY_GetModuleName.restype = c_char_p + +ffi.lib.LLVMPY_SetModuleName.argtypes = [ffi.LLVMModuleRef, c_char_p] + +ffi.lib.LLVMPY_GetModuleSourceFileName.argtypes = [ffi.LLVMModuleRef] +ffi.lib.LLVMPY_GetModuleSourceFileName.restype = c_char_p diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/newpassmanagers.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/newpassmanagers.py new file mode 100644 index 0000000000000000000000000000000000000000..c7082965ee83ada7e352baa8bc663941e5e70b21 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/newpassmanagers.py @@ -0,0 +1,357 @@ +from ctypes import c_bool, c_int, c_size_t +from enum import IntFlag +from llvmlite.binding import ffi + + +def create_new_module_pass_manager(): + return ModulePassManager() + + +def create_new_function_pass_manager(): + return FunctionPassManager() + + +def create_pass_builder(tm, pto): + return PassBuilder(tm, pto) + + +def create_pipeline_tuning_options(speed_level=2, size_level=0): + return PipelineTuningOptions(speed_level, size_level) + + +class RefPruneSubpasses(IntFlag): + PER_BB = 0b0001 # noqa: E221 + DIAMOND = 0b0010 # noqa: E221 + FANOUT = 0b0100 # noqa: E221 + FANOUT_RAISE = 0b1000 + ALL = PER_BB | DIAMOND | FANOUT | FANOUT_RAISE + + +class ModulePassManager(ffi.ObjectRef): + + def __init__(self, ptr=None): + if ptr is None: + ptr = ffi.lib.LLVMPY_CreateNewModulePassManager() + super().__init__(ptr) + + def run(self, module, pb): + ffi.lib.LLVMPY_RunNewModulePassManager(self, module, pb) + + def add_verifier(self): + ffi.lib.LLVMPY_AddVerifierPass(self) + + def add_aa_eval_pass(self): + ffi.lib.LLVMPY_AddAAEvalPass_module(self) + + def add_simplify_cfg_pass(self): + ffi.lib.LLVMPY_AddSimplifyCFGPass_module(self) + + def add_loop_unroll_pass(self): + ffi.lib.LLVMPY_AddLoopUnrollPass_module(self) + + def add_loop_rotate_pass(self): + ffi.lib.LLVMPY_AddLoopRotatePass_module(self) + + def add_instruction_combine_pass(self): + ffi.lib.LLVMPY_AddInstructionCombinePass_module(self) + + def add_jump_threading_pass(self, threshold=-1): + ffi.lib.LLVMPY_AddJumpThreadingPass_module(self, threshold) + + def _dispose(self): + ffi.lib.LLVMPY_DisposeNewModulePassManger(self) + + # Non-standard LLVM passes + def add_refprune_pass(self, subpasses_flags=RefPruneSubpasses.ALL, + subgraph_limit=1000): + """Add Numba specific Reference count pruning pass. + + Parameters + ---------- + subpasses_flags : RefPruneSubpasses + A bitmask to control the subpasses to be enabled. + subgraph_limit : int + Limit the fanout pruners to working on a subgraph no bigger than + this number of basic-blocks to avoid spending too much time in very + large graphs. Default is 1000. Subject to change in future + versions. + """ + iflags = RefPruneSubpasses(subpasses_flags) + ffi.lib.LLVMPY_AddRefPrunePass_module(self, iflags, subgraph_limit) + + +class FunctionPassManager(ffi.ObjectRef): + + def __init__(self, ptr=None): + if ptr is None: + ptr = ffi.lib.LLVMPY_CreateNewFunctionPassManager() + super().__init__(ptr) + + def run(self, fun, pb): + ffi.lib.LLVMPY_RunNewFunctionPassManager(self, fun, pb) + + def add_aa_eval_pass(self): + ffi.lib.LLVMPY_AddAAEvalPass_function(self) + + def add_simplify_cfg_pass(self): + ffi.lib.LLVMPY_AddSimplifyCFGPass_function(self) + + def add_loop_unroll_pass(self): + ffi.lib.LLVMPY_AddLoopUnrollPass_function(self) + + def add_loop_rotate_pass(self): + ffi.lib.LLVMPY_AddLoopRotatePass_function(self) + + def add_instruction_combine_pass(self): + ffi.lib.LLVMPY_AddInstructionCombinePass_function(self) + + def add_jump_threading_pass(self, threshold=-1): + ffi.lib.LLVMPY_AddJumpThreadingPass_function(self, threshold) + + def _dispose(self): + ffi.lib.LLVMPY_DisposeNewFunctionPassManger(self) + + # Non-standard LLVM passes + def add_refprune_pass(self, subpasses_flags=RefPruneSubpasses.ALL, + subgraph_limit=1000): + """Add Numba specific Reference count pruning pass. + + Parameters + ---------- + subpasses_flags : RefPruneSubpasses + A bitmask to control the subpasses to be enabled. + subgraph_limit : int + Limit the fanout pruners to working on a subgraph no bigger than + this number of basic-blocks to avoid spending too much time in very + large graphs. Default is 1000. Subject to change in future + versions. + """ + iflags = RefPruneSubpasses(subpasses_flags) + ffi.lib.LLVMPY_AddRefPrunePass_function(self, iflags, subgraph_limit) + + +class PipelineTuningOptions(ffi.ObjectRef): + + def __init__(self, speed_level=2, size_level=0): + self._speed_level = None + self._size_level = None + self.speed_level = speed_level + self.size_level = size_level + super().__init__(ffi.lib.LLVMPY_CreatePipelineTuningOptions()) + + @property + def speed_level(self): + return self._speed_level + + @speed_level.setter + def speed_level(self, value): + if not 0 <= value <= 3: + raise ValueError( + "Optimization level for speed should be 0, 1, 2, or 3") + self._speed_level = value + + @property + def size_level(self): + return self._size_level + + @size_level.setter + def size_level(self, value): + if not 0 <= value <= 2: + raise ValueError("Optimization level for size should be 0, 1, or 2") + if value != 0 and self.speed_level != 2: + raise ValueError( + "Optimization for size should be encoded with speed level == 2") + self._size_level = value + + @property + def loop_interleaving(self): + return ffi.lib.LLVMPY_PTOGetLoopInterleaving(self) + + @loop_interleaving.setter + def loop_interleaving(self, value): + ffi.lib.LLVMPY_PTOSetLoopInterleaving(self, value) + + @property + def loop_vectorization(self): + return ffi.lib.LLVMPY_PTOGetLoopVectorization(self) + + @loop_vectorization.setter + def loop_vectorization(self, value): + ffi.lib.LLVMPY_PTOSetLoopVectorization(self, value) + + @property + def slp_vectorization(self): + return ffi.lib.LLVMPY_PTOGetSLPVectorization(self) + + @slp_vectorization.setter + def slp_vectorization(self, value): + ffi.lib.LLVMPY_PTOSetSLPVectorization(self, value) + + @property + def loop_unrolling(self): + return ffi.lib.LLVMPY_PTOGetLoopUnrolling(self) + + @loop_unrolling.setter + def loop_unrolling(self, value): + ffi.lib.LLVMPY_PTOSetLoopUnrolling(self, value) + + # // FIXME: Available from llvm16 + # @property + # def inlining_threshold(self): + # return ffi.lib.LLVMPY_PTOGetInlinerThreshold(self) + + # @inlining_threshold.setter + # def inlining_threshold(self, value): + # ffi.lib.LLVMPY_PTOSetInlinerThreshold(self, value) + + def _dispose(self): + ffi.lib.LLVMPY_DisposePipelineTuningOptions(self) + + +class PassBuilder(ffi.ObjectRef): + + def __init__(self, tm, pto): + super().__init__(ffi.lib.LLVMPY_CreatePassBuilder(tm, pto)) + self._pto = pto + self._tm = tm + + def getModulePassManager(self): + return ModulePassManager( + ffi.lib.LLVMPY_buildPerModuleDefaultPipeline( + self, self._pto.speed_level, self._pto.size_level) + ) + + def getFunctionPassManager(self): + return FunctionPassManager( + ffi.lib.LLVMPY_buildFunctionSimplificationPipeline( + self, self._pto.speed_level, self._pto.size_level) + ) + + def _dispose(self): + ffi.lib.LLVMPY_DisposePassBuilder(self) + + +# ============================================================================ +# FFI + +# ModulePassManager + +ffi.lib.LLVMPY_CreateNewModulePassManager.restype = ffi.LLVMModulePassManagerRef + +ffi.lib.LLVMPY_RunNewModulePassManager.argtypes = [ + ffi.LLVMModulePassManagerRef, ffi.LLVMModuleRef, + ffi.LLVMPassBuilderRef,] + +ffi.lib.LLVMPY_AddVerifierPass.argtypes = [ffi.LLVMModulePassManagerRef,] +ffi.lib.LLVMPY_AddAAEvalPass_module.argtypes = [ffi.LLVMModulePassManagerRef,] +ffi.lib.LLVMPY_AddSimplifyCFGPass_module.argtypes = [ + ffi.LLVMModulePassManagerRef,] + +ffi.lib.LLVMPY_AddLoopUnrollPass_module.argtypes = [ + ffi.LLVMModulePassManagerRef,] + +ffi.lib.LLVMPY_AddLoopRotatePass_module.argtypes = [ + ffi.LLVMModulePassManagerRef,] + +ffi.lib.LLVMPY_AddInstructionCombinePass_module.argtypes = [ + ffi.LLVMModulePassManagerRef,] + +ffi.lib.LLVMPY_AddJumpThreadingPass_module.argtypes = [ + ffi.LLVMModulePassManagerRef,] + +ffi.lib.LLVMPY_DisposeNewModulePassManger.argtypes = [ + ffi.LLVMModulePassManagerRef,] + +ffi.lib.LLVMPY_AddRefPrunePass_module.argtypes = [ + ffi.LLVMModulePassManagerRef, c_int, c_size_t, +] + +# FunctionPassManager + +ffi.lib.LLVMPY_CreateNewFunctionPassManager.restype = \ + ffi.LLVMFunctionPassManagerRef + +ffi.lib.LLVMPY_RunNewFunctionPassManager.argtypes = [ + ffi.LLVMFunctionPassManagerRef, ffi.LLVMValueRef, + ffi.LLVMPassBuilderRef,] + +ffi.lib.LLVMPY_AddAAEvalPass_function.argtypes = [ + ffi.LLVMFunctionPassManagerRef,] + +ffi.lib.LLVMPY_AddSimplifyCFGPass_function.argtypes = [ + ffi.LLVMFunctionPassManagerRef,] + +ffi.lib.LLVMPY_AddLoopUnrollPass_function.argtypes = [ + ffi.LLVMFunctionPassManagerRef,] + +ffi.lib.LLVMPY_AddLoopRotatePass_function.argtypes = [ + ffi.LLVMFunctionPassManagerRef,] + +ffi.lib.LLVMPY_AddInstructionCombinePass_function.argtypes = [ + ffi.LLVMFunctionPassManagerRef,] + +ffi.lib.LLVMPY_AddJumpThreadingPass_function.argtypes = [ + ffi.LLVMFunctionPassManagerRef, c_int,] + +ffi.lib.LLVMPY_DisposeNewFunctionPassManger.argtypes = [ + ffi.LLVMFunctionPassManagerRef,] + +ffi.lib.LLVMPY_AddRefPrunePass_function.argtypes = [ + ffi.LLVMFunctionPassManagerRef, c_int, c_size_t, +] + +# PipelineTuningOptions + +ffi.lib.LLVMPY_CreatePipelineTuningOptions.restype = \ + ffi.LLVMPipelineTuningOptionsRef + +ffi.lib.LLVMPY_PTOGetLoopInterleaving.restype = c_bool +ffi.lib.LLVMPY_PTOGetLoopInterleaving.argtypes = [ + ffi.LLVMPipelineTuningOptionsRef,] + +ffi.lib.LLVMPY_PTOSetLoopInterleaving.argtypes = [ + ffi.LLVMPipelineTuningOptionsRef, c_bool] + +ffi.lib.LLVMPY_PTOGetLoopVectorization.restype = c_bool +ffi.lib.LLVMPY_PTOGetLoopVectorization.argtypes = [ + ffi.LLVMPipelineTuningOptionsRef,] + +ffi.lib.LLVMPY_PTOSetLoopVectorization.argtypes = [ + ffi.LLVMPipelineTuningOptionsRef, c_bool] + +ffi.lib.LLVMPY_PTOGetSLPVectorization.restype = c_bool +ffi.lib.LLVMPY_PTOGetSLPVectorization.argtypes = [ + ffi.LLVMPipelineTuningOptionsRef,] + +ffi.lib.LLVMPY_PTOSetSLPVectorization.argtypes = [ + ffi.LLVMPipelineTuningOptionsRef, c_bool] + +ffi.lib.LLVMPY_PTOGetLoopUnrolling.restype = c_bool +ffi.lib.LLVMPY_PTOGetLoopUnrolling.argtypes = [ + ffi.LLVMPipelineTuningOptionsRef,] + +ffi.lib.LLVMPY_PTOSetLoopUnrolling.argtypes = [ + ffi.LLVMPipelineTuningOptionsRef, c_bool] + +ffi.lib.LLVMPY_DisposePipelineTuningOptions.argtypes = \ + [ffi.LLVMPipelineTuningOptionsRef,] + +# PassBuilder + +ffi.lib.LLVMPY_CreatePassBuilder.restype = ffi.LLVMPassBuilderRef +ffi.lib.LLVMPY_CreatePassBuilder.argtypes = [ffi.LLVMTargetMachineRef, + ffi.LLVMPipelineTuningOptionsRef,] + +ffi.lib.LLVMPY_DisposePassBuilder.argtypes = [ffi.LLVMPassBuilderRef,] + +# Pipeline builders + +ffi.lib.LLVMPY_buildPerModuleDefaultPipeline.restype = \ + ffi.LLVMModulePassManagerRef +ffi.lib.LLVMPY_buildPerModuleDefaultPipeline.argtypes = [ + ffi.LLVMPassBuilderRef, c_int, c_int] + +ffi.lib.LLVMPY_buildFunctionSimplificationPipeline.restype = \ + ffi.LLVMFunctionPassManagerRef +ffi.lib.LLVMPY_buildFunctionSimplificationPipeline.argtypes = [ + ffi.LLVMPassBuilderRef, c_int, c_int] diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/object_file.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/object_file.py new file mode 100644 index 0000000000000000000000000000000000000000..e5961b079ef87393347436a8fd8e70fb0525b39d --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/object_file.py @@ -0,0 +1,82 @@ +from llvmlite.binding import ffi +from ctypes import (c_bool, c_char_p, c_char, c_size_t, string_at, c_uint64, + POINTER) + + +class SectionIteratorRef(ffi.ObjectRef): + def name(self): + return ffi.lib.LLVMPY_GetSectionName(self) + + def is_text(self): + return ffi.lib.LLVMPY_IsSectionText(self) + + def size(self): + return ffi.lib.LLVMPY_GetSectionSize(self) + + def address(self): + return ffi.lib.LLVMPY_GetSectionAddress(self) + + def data(self): + return string_at(ffi.lib.LLVMPY_GetSectionContents(self), self.size()) + + def is_end(self, object_file): + return ffi.lib.LLVMPY_IsSectionIteratorAtEnd(object_file, self) + + def next(self): + ffi.lib.LLVMPY_MoveToNextSection(self) + + def _dispose(self): + ffi.lib.LLVMPY_DisposeSectionIterator(self) + + +class ObjectFileRef(ffi.ObjectRef): + @classmethod + def from_data(cls, data): + return cls(ffi.lib.LLVMPY_CreateObjectFile(data, len(data))) + + @classmethod + def from_path(cls, path): + with open(path, 'rb') as f: + data = f.read() + return cls(ffi.lib.LLVMPY_CreateObjectFile(data, len(data))) + + def sections(self): + it = SectionIteratorRef(ffi.lib.LLVMPY_GetSections(self)) + while not it.is_end(self): + yield it + it.next() + + def _dispose(self): + ffi.lib.LLVMPY_DisposeObjectFile(self) + + +ffi.lib.LLVMPY_CreateObjectFile.argtypes = [c_char_p, c_size_t] +ffi.lib.LLVMPY_CreateObjectFile.restype = ffi.LLVMObjectFileRef + +ffi.lib.LLVMPY_DisposeObjectFile.argtypes = [ffi.LLVMObjectFileRef] + +ffi.lib.LLVMPY_GetSections.argtypes = [ffi.LLVMObjectFileRef] +ffi.lib.LLVMPY_GetSections.restype = ffi.LLVMSectionIteratorRef + +ffi.lib.LLVMPY_DisposeSectionIterator.argtypes = [ffi.LLVMSectionIteratorRef] + +ffi.lib.LLVMPY_MoveToNextSection.argtypes = [ffi.LLVMSectionIteratorRef] + +ffi.lib.LLVMPY_IsSectionIteratorAtEnd.argtypes = [ + ffi.LLVMObjectFileRef, ffi.LLVMSectionIteratorRef] +ffi.lib.LLVMPY_IsSectionIteratorAtEnd.restype = c_bool + +ffi.lib.LLVMPY_GetSectionName.argtypes = [ffi.LLVMSectionIteratorRef] +ffi.lib.LLVMPY_GetSectionName.restype = c_char_p + +ffi.lib.LLVMPY_GetSectionSize.argtypes = [ffi.LLVMSectionIteratorRef] +ffi.lib.LLVMPY_GetSectionSize.restype = c_uint64 + +ffi.lib.LLVMPY_GetSectionAddress.argtypes = [ffi.LLVMSectionIteratorRef] +ffi.lib.LLVMPY_GetSectionAddress.restype = c_uint64 + +ffi.lib.LLVMPY_GetSectionContents.argtypes = [ffi.LLVMSectionIteratorRef] +ffi.lib.LLVMPY_GetSectionContents.restype = POINTER(c_char) + +ffi.lib.LLVMPY_IsSectionText.argtypes = [ffi.LLVMSectionIteratorRef] +ffi.lib.LLVMPY_IsSectionText.restype = c_bool diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/options.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/options.py new file mode 100644 index 0000000000000000000000000000000000000000..15eedfaaf476938c97abcd7e75131e9590f34203 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/options.py @@ -0,0 +1,17 @@ +from llvmlite.binding import ffi +from llvmlite.binding.common import _encode_string +from ctypes import c_char_p + + +def set_option(name, option): + """ + Set the given LLVM "command-line" option. + + For example set_option("test", "-debug-pass=Structure") would display + all optimization passes when generating code. + """ + ffi.lib.LLVMPY_SetCommandLine(_encode_string(name), + _encode_string(option)) + + +ffi.lib.LLVMPY_SetCommandLine.argtypes = [c_char_p, c_char_p] diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/orcjit.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/orcjit.py new file mode 100644 index 0000000000000000000000000000000000000000..82996f586bf688bce389db15d29b0c294f5cba67 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/orcjit.py @@ -0,0 +1,342 @@ +import ctypes +from ctypes import POINTER, c_bool, c_char_p, c_uint8, c_uint64, c_size_t + +from llvmlite.binding import ffi, targets + + +class _LinkElement(ctypes.Structure): + _fields_ = [("element_kind", c_uint8), + ("value", c_char_p), + ("value_len", c_size_t)] + + +class _SymbolAddress(ctypes.Structure): + _fields_ = [("name", c_char_p), ("address", c_uint64)] + + +class JITLibraryBuilder: + """ + Create a library for linking by OrcJIT + + OrcJIT operates like a linker: a number of compilation units and + dependencies are collected together and linked into a single dynamic library + that can export functions to other libraries or to be consumed directly as + entry points into JITted code. The native OrcJIT has a lot of memory + management complications so this API is designed to work well with Python's + garbage collection. + + The creation of a new library is a bit like a linker command line where + compilation units, mostly as LLVM IR, and previously constructed libraries + are linked together, then loaded into memory, and the addresses of exported + symbols are extracted. Any static initializers are run and the exported + addresses and a resource tracker is produced. As long as the resource + tracker is referenced somewhere in Python, the exported addresses will be + valid. Once the resource tracker is garbage collected, the static + destructors will run and library will be unloaded from memory. + """ + def __init__(self): + self.__entries = [] + self.__exports = set() + self.__imports = {} + + def add_ir(self, llvmir): + """ + Adds a compilation unit to the library using LLVM IR as the input + format. + + This takes a string or an object that can be converted to a string, + including IRBuilder, that contains LLVM IR. + """ + self.__entries.append((0, str(llvmir).encode('utf-8'))) + return self + + def add_native_assembly(self, asm): + """ + Adds a compilation unit to the library using native assembly as the + input format. + + This takes a string or an object that can be converted to a string that + contains native assembly, which will be + parsed by LLVM. + """ + self.__entries.append((1, str(asm).encode('utf-8'))) + return self + + def add_object_img(self, data): + """ + Adds a compilation unit to the library using pre-compiled object code. + + This takes the bytes of the contents of an object artifact which will be + loaded by LLVM. + """ + self.__entries.append((2, bytes(data))) + return self + + def add_object_file(self, file_path): + """ + Adds a compilation unit to the library using pre-compiled object file. + + This takes a string or path-like object that references an object file + which will be loaded by LLVM. + """ + with open(file_path, "rb") as f: + self.__entries.append((2, f.read())) + return self + + def add_jit_library(self, name): + """ + Adds an existing JIT library as prerequisite. + + The name of the library must match the one provided in a previous link + command. + """ + self.__entries.append((3, str(name).encode('utf-8'))) + return self + + def add_current_process(self): + """ + Allows the JITted library to access symbols in the current binary. + + That is, it allows exporting the current binary's symbols, including + loaded libraries, as imports to the JITted + library. + """ + self.__entries.append((3, b'')) + return self + + def import_symbol(self, name, address): + """ + Register the *address* of global symbol *name*. This will make + it usable (e.g. callable) from LLVM-compiled functions. + """ + self.__imports[str(name)] = c_uint64(address) + return self + + def export_symbol(self, name): + """ + During linking, extract the address of a symbol that was defined in one + of the compilation units. + + This allows getting symbols, functions or global variables, out of the + JIT linked library. The addresses will be + available when the link method is called. + """ + self.__exports.add(str(name)) + return self + + def link(self, lljit, library_name): + """ + Link all the current compilation units into a JITted library and extract + the address of exported symbols. + + An instance of the OrcJIT instance must be provided and this will be the + scope that is used to find other JITted libraries that are dependencies + and also be the place where this library will be defined. + + After linking, the method will return a resource tracker that keeps the + library alive. This tracker also knows the addresses of any exported + symbols that were requested. + + The addresses will be valid as long as the resource tracker is + referenced. + + When the resource tracker is destroyed, the library will be cleaned up, + however, the name of the library cannot be reused. + """ + assert not lljit.closed, "Cannot add to closed JIT" + encoded_library_name = str(library_name).encode('utf-8') + assert len(encoded_library_name) > 0, "Library cannot be empty" + elements = (_LinkElement * len(self.__entries))() + for idx, (kind, value) in enumerate(self.__entries): + elements[idx].element_kind = c_uint8(kind) + elements[idx].value = c_char_p(value) + elements[idx].value_len = c_size_t(len(value)) + exports = (_SymbolAddress * len(self.__exports))() + for idx, name in enumerate(self.__exports): + exports[idx].name = name.encode('utf-8') + + imports = (_SymbolAddress * len(self.__imports))() + for idx, (name, addr) in enumerate(self.__imports.items()): + imports[idx].name = name.encode('utf-8') + imports[idx].address = addr + + with ffi.OutputString() as outerr: + tracker = lljit._capi.LLVMPY_LLJIT_Link( + lljit._ptr, + encoded_library_name, + elements, + len(self.__entries), + imports, + len(self.__imports), + exports, + len(self.__exports), + outerr) + if not tracker: + raise RuntimeError(str(outerr)) + return ResourceTracker(tracker, + library_name, + {name: exports[idx].address + for idx, name in enumerate(self.__exports)}) + + +class ResourceTracker(ffi.ObjectRef): + """ + A resource tracker is created for each loaded JIT library and keeps the + module alive. + + OrcJIT supports unloading libraries that are no longer used. This resource + tracker should be stored in any object that reference functions or constants + for a JITted library. When all references to the resource tracker are + dropped, this will trigger LLVM to unload the library and destroy any + functions. + + Failure to keep resource trackers while calling a function or accessing a + symbol can result in crashes or memory corruption. + + LLVM internally tracks references between different libraries, so only + "leaf" libraries need to be tracked. + """ + def __init__(self, ptr, name, addresses): + self.__addresses = addresses + self.__name = name + ffi.ObjectRef.__init__(self, ptr) + + def __getitem__(self, item): + """ + Get the address of an exported symbol as an integer + """ + return self.__addresses[item] + + @property + def name(self): + return self.__name + + def _dispose(self): + with ffi.OutputString() as outerr: + if self._capi.LLVMPY_LLJIT_Dylib_Tracker_Dispose(self, outerr): + raise RuntimeError(str(outerr)) + + +class LLJIT(ffi.ObjectRef): + """ + A OrcJIT-based LLVM JIT engine that can compile and run LLVM IR as a + collection of JITted dynamic libraries + + The C++ OrcJIT API has a lot of memory ownership patterns that do not work + with Python. This API attempts to provide ones that are safe at the expense + of some features. Each LLJIT instance is a collection of JIT-compiled + libraries. In the C++ API, there is a "main" library; this API does not + provide access to the main library. Use the JITLibraryBuilder to create a + new named library instead. + """ + def __init__(self, ptr): + self._td = None + ffi.ObjectRef.__init__(self, ptr) + + def lookup(self, dylib, fn): + """ + Find a function in this dynamic library and construct a new tracking + object for it + + If the library or function do not exist, an exception will occur. + + Parameters + ---------- + dylib : str or None + the name of the library containing the symbol + fn : str + the name of the function to get + """ + assert not self.closed, "Cannot lookup in closed JIT" + address = ctypes.c_uint64() + with ffi.OutputString() as outerr: + tracker = ffi.lib.LLVMPY_LLJITLookup(self, + dylib.encode("utf-8"), + fn.encode("utf-8"), + ctypes.byref(address), + outerr) + if not tracker: + raise RuntimeError(str(outerr)) + + return ResourceTracker(tracker, dylib, {fn: address.value}) + + @property + def target_data(self): + """ + The TargetData for this LLJIT instance. + """ + if self._td is not None: + return self._td + ptr = ffi.lib.LLVMPY_LLJITGetDataLayout(self) + self._td = targets.TargetData(ptr) + self._td._owned = True + return self._td + + def _dispose(self): + if self._td is not None: + self._td.detach() + self._capi.LLVMPY_LLJITDispose(self) + + +def create_lljit_compiler(target_machine=None, *, + use_jit_link=False, + suppress_errors=False): + """ + Create an LLJIT instance + """ + with ffi.OutputString() as outerr: + lljit = ffi.lib.LLVMPY_CreateLLJITCompiler(target_machine, + suppress_errors, + use_jit_link, + outerr) + if not lljit: + raise RuntimeError(str(outerr)) + + return LLJIT(lljit) + + +ffi.lib.LLVMPY_LLJITLookup.argtypes = [ + ffi.LLVMOrcLLJITRef, + c_char_p, + c_char_p, + POINTER(c_uint64), + POINTER(c_char_p), +] +ffi.lib.LLVMPY_LLJITLookup.restype = ffi.LLVMOrcDylibTrackerRef + +ffi.lib.LLVMPY_LLJITGetDataLayout.argtypes = [ + ffi.LLVMOrcLLJITRef, +] +ffi.lib.LLVMPY_LLJITGetDataLayout.restype = ffi.LLVMTargetDataRef + +ffi.lib.LLVMPY_CreateLLJITCompiler.argtypes = [ + ffi.LLVMTargetMachineRef, + c_bool, + c_bool, + POINTER(c_char_p), +] +ffi.lib.LLVMPY_CreateLLJITCompiler.restype = ffi.LLVMOrcLLJITRef + +ffi.lib.LLVMPY_LLJITDispose.argtypes = [ + ffi.LLVMOrcLLJITRef, +] + + +ffi.lib.LLVMPY_LLJIT_Link.argtypes = [ + ffi.LLVMOrcLLJITRef, + c_char_p, + POINTER(_LinkElement), + c_size_t, + POINTER(_SymbolAddress), + c_size_t, + POINTER(_SymbolAddress), + c_size_t, + POINTER(c_char_p) +] +ffi.lib.LLVMPY_LLJIT_Link.restype = ffi.LLVMOrcDylibTrackerRef + +ffi.lib.LLVMPY_LLJIT_Dylib_Tracker_Dispose.argtypes = [ + ffi.LLVMOrcDylibTrackerRef, + POINTER(c_char_p) +] +ffi.lib.LLVMPY_LLJIT_Dylib_Tracker_Dispose.restype = c_bool diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/passmanagers.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/passmanagers.py new file mode 100644 index 0000000000000000000000000000000000000000..0ce61aefcb9026b6c45b5a0c492817aea9966475 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/passmanagers.py @@ -0,0 +1,946 @@ +from ctypes import (c_bool, c_char_p, c_int, c_size_t, Structure, byref, + POINTER) +from collections import namedtuple +from enum import IntFlag +from llvmlite.binding import ffi +from llvmlite.binding.initfini import llvm_version_info +import os +from tempfile import mkstemp +from llvmlite.binding.common import _encode_string + +llvm_version_major = llvm_version_info[0] + +_prunestats = namedtuple('PruneStats', + ('basicblock diamond fanout fanout_raise')) + + +class PruneStats(_prunestats): + """ Holds statistics from reference count pruning. + """ + + def __add__(self, other): + if not isinstance(other, PruneStats): + msg = 'PruneStats can only be added to another PruneStats, got {}.' + raise TypeError(msg.format(type(other))) + return PruneStats(self.basicblock + other.basicblock, + self.diamond + other.diamond, + self.fanout + other.fanout, + self.fanout_raise + other.fanout_raise) + + def __sub__(self, other): + if not isinstance(other, PruneStats): + msg = ('PruneStats can only be subtracted from another PruneStats, ' + 'got {}.') + raise TypeError(msg.format(type(other))) + return PruneStats(self.basicblock - other.basicblock, + self.diamond - other.diamond, + self.fanout - other.fanout, + self.fanout_raise - other.fanout_raise) + + +class _c_PruneStats(Structure): + _fields_ = [ + ('basicblock', c_size_t), + ('diamond', c_size_t), + ('fanout', c_size_t), + ('fanout_raise', c_size_t)] + + +def dump_refprune_stats(printout=False): + """ Returns a namedtuple containing the current values for the refop pruning + statistics. If kwarg `printout` is True the stats are printed to stderr, + default is False. + """ + + stats = _c_PruneStats(0, 0, 0, 0) + do_print = c_bool(printout) + + ffi.lib.LLVMPY_DumpRefPruneStats(byref(stats), do_print) + return PruneStats(stats.basicblock, stats.diamond, stats.fanout, + stats.fanout_raise) + + +def set_time_passes(enable): + """Enable or disable the pass timers. + + Parameters + ---------- + enable : bool + Set to True to enable the pass timers. + Set to False to disable the pass timers. + """ + ffi.lib.LLVMPY_SetTimePasses(c_bool(enable)) + + +def report_and_reset_timings(): + """Returns the pass timings report and resets the LLVM internal timers. + + Pass timers are enabled by ``set_time_passes()``. If the timers are not + enabled, this function will return an empty string. + + Returns + ------- + res : str + LLVM generated timing report. + """ + with ffi.OutputString() as buf: + ffi.lib.LLVMPY_ReportAndResetTimings(buf) + return str(buf) + + +def create_module_pass_manager(): + return ModulePassManager() + + +def create_function_pass_manager(module): + return FunctionPassManager(module) + + +class RefPruneSubpasses(IntFlag): + PER_BB = 0b0001 # noqa: E221 + DIAMOND = 0b0010 # noqa: E221 + FANOUT = 0b0100 # noqa: E221 + FANOUT_RAISE = 0b1000 + ALL = PER_BB | DIAMOND | FANOUT | FANOUT_RAISE + + +class PassManager(ffi.ObjectRef): + """PassManager + """ + + def _dispose(self): + self._capi.LLVMPY_DisposePassManager(self) + + def add_aa_eval_pass(self): + """ + See https://llvm.org/docs/Passes.html#aa-eval-exhaustive-alias-analysis-precision-evaluator + + LLVM 14: `llvm::createAAEvalPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddAAEvalPass(self) + + def add_basic_aa_pass(self): + """ + See https://llvm.org/docs/Passes.html#basic-aa-basic-alias-analysis-stateless-aa-impl + + LLVM 14: `llvm::createBasicAAWrapperPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddBasicAAWrapperPass(self) + + def add_constant_merge_pass(self): + """ + See http://llvm.org/docs/Passes.html#constmerge-merge-duplicate-global-constants + + LLVM 14: `LLVMAddConstantMergePass` + """ # noqa E501 + ffi.lib.LLVMPY_AddConstantMergePass(self) + + def add_dead_arg_elimination_pass(self): + """ + See http://llvm.org/docs/Passes.html#deadargelim-dead-argument-elimination + + LLVM 14: `LLVMAddDeadArgEliminationPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddDeadArgEliminationPass(self) + + def add_dependence_analysis_pass(self): + """ + See https://llvm.org/docs/Passes.html#da-dependence-analysis + + LLVM 14: `llvm::createDependenceAnalysisWrapperPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddDependenceAnalysisPass(self) + + def add_dot_call_graph_pass(self): + """ + See https://llvm.org/docs/Passes.html#dot-callgraph-print-call-graph-to-dot-file + + LLVM 14: `llvm::createCallGraphDOTPrinterPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddCallGraphDOTPrinterPass(self) + + def add_dot_cfg_printer_pass(self): + """ + See https://llvm.org/docs/Passes.html#dot-cfg-print-cfg-of-function-to-dot-file + + LLVM 14: `llvm::createCFGPrinterLegacyPassPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddCFGPrinterPass(self) + + def add_dot_dom_printer_pass(self, show_body=False): + """ + See https://llvm.org/docs/Passes.html#dot-dom-print-dominance-tree-of-function-to-dot-file + + LLVM 14: `llvm::createDomPrinterPass` and `llvm::createDomOnlyPrinterPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddDotDomPrinterPass(self, show_body) + + def add_dot_postdom_printer_pass(self, show_body=False): + """ + See https://llvm.org/docs/Passes.html#dot-postdom-print-postdominance-tree-of-function-to-dot-file + + LLVM 14: `llvm::createPostDomPrinterPass` and `llvm::createPostDomOnlyPrinterPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddDotPostDomPrinterPass(self, show_body) + + def add_globals_mod_ref_aa_pass(self): + """ + See https://llvm.org/docs/Passes.html#globalsmodref-aa-simple-mod-ref-analysis-for-globals + + LLVM 14: `llvm::createGlobalsAAWrapperPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddGlobalsModRefAAPass(self) + + def add_iv_users_pass(self): + """ + See https://llvm.org/docs/Passes.html#iv-users-induction-variable-users + + LLVM 14: `llvm::createIVUsersPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddIVUsersPass(self) + + def add_lint_pass(self): + """ + See https://llvm.org/docs/Passes.html#lint-statically-lint-checks-llvm-ir + + LLVM 14: `llvm::createLintLegacyPassPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLintPass(self) + + def add_lazy_value_info_pass(self): + """ + See https://llvm.org/docs/Passes.html#lazy-value-info-lazy-value-information-analysis + + LLVM 14: `llvm::createLazyValueInfoPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLazyValueInfoPass(self) + + def add_module_debug_info_pass(self): + """ + See https://llvm.org/docs/Passes.html#module-debuginfo-decodes-module-level-debug-info + + LLVM 14: `llvm::createModuleDebugInfoPrinterPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddModuleDebugInfoPrinterPass(self) + + def add_region_info_pass(self): + """ + See https://llvm.org/docs/Passes.html#regions-detect-single-entry-single-exit-regions + + LLVM 14: `llvm::createRegionInfoPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddRegionInfoPass(self) + + def add_scalar_evolution_aa_pass(self): + """ + See https://llvm.org/docs/Passes.html#scev-aa-scalarevolution-based-alias-analysis + + LLVM 14: `llvm::createSCEVAAWrapperPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddScalarEvolutionAAPass(self) + + def add_aggressive_dead_code_elimination_pass(self): + """ + See https://llvm.org/docs/Passes.html#adce-aggressive-dead-code-elimination + + LLVM 14: `llvm::createAggressiveDCEPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddAggressiveDCEPass(self) + + def add_always_inliner_pass(self, insert_lifetime=True): + """ + See https://llvm.org/docs/Passes.html#always-inline-inliner-for-always-inline-functions + + LLVM 14: `llvm::createAlwaysInlinerLegacyPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddAlwaysInlinerPass(self, insert_lifetime) + + def add_arg_promotion_pass(self, max_elements=3): + """ + See https://llvm.org/docs/Passes.html#argpromotion-promote-by-reference-arguments-to-scalars + + LLVM 14: `llvm::createArgumentPromotionPass` + """ # noqa E501 + raise RuntimeError('ArgumentPromotionPass unavailable in LLVM > 14') + + def add_break_critical_edges_pass(self): + """ + See https://llvm.org/docs/Passes.html#break-crit-edges-break-critical-edges-in-cfg + + LLVM 14: `llvm::createBreakCriticalEdgesPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddBreakCriticalEdgesPass(self) + + def add_dead_store_elimination_pass(self): + """ + See https://llvm.org/docs/Passes.html#dse-dead-store-elimination + + LLVM 14: `llvm::createDeadStoreEliminationPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddDeadStoreEliminationPass(self) + + def add_reverse_post_order_function_attrs_pass(self): + """ + See https://llvm.org/docs/Passes.html#function-attrs-deduce-function-attributes + + LLVM 14: `llvm::createReversePostOrderFunctionAttrsPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddReversePostOrderFunctionAttrsPass(self) + + def add_function_attrs_pass(self): + """ + See http://llvm.org/docs/Passes.html#functionattrs-deduce-function-attributes + + LLVM 14: `LLVMAddFunctionAttrsPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddFunctionAttrsPass(self) + + def add_function_inlining_pass(self, threshold): + """ + See http://llvm.org/docs/Passes.html#inline-function-integration-inlining + + LLVM 14: `createFunctionInliningPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddFunctionInliningPass(self, threshold) + + def add_global_dce_pass(self): + """ + See http://llvm.org/docs/Passes.html#globaldce-dead-global-elimination + + LLVM 14: `LLVMAddGlobalDCEPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddGlobalDCEPass(self) + + def add_global_optimizer_pass(self): + """ + See http://llvm.org/docs/Passes.html#globalopt-global-variable-optimizer + + LLVM 14: `LLVMAddGlobalOptimizerPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddGlobalOptimizerPass(self) + + def add_ipsccp_pass(self): + """ + See http://llvm.org/docs/Passes.html#ipsccp-interprocedural-sparse-conditional-constant-propagation + + LLVM 14: `LLVMAddIPSCCPPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddIPSCCPPass(self) + + def add_dead_code_elimination_pass(self): + """ + See http://llvm.org/docs/Passes.html#dce-dead-code-elimination + LLVM 14: `llvm::createDeadCodeEliminationPass` + """ + ffi.lib.LLVMPY_AddDeadCodeEliminationPass(self) + + def add_aggressive_instruction_combining_pass(self): + """ + See https://llvm.org/docs/Passes.html#aggressive-instcombine-combine-expression-patterns + + LLVM 14: `llvm::createAggressiveInstCombinerPass` + """ # noqa E501 + if llvm_version_major > 15: + msg = "AggressiveInstrCombinerPass unavailable in LLVM > 15" + raise RuntimeError(msg) + + ffi.lib.LLVMPY_AddAggressiveInstructionCombiningPass(self) + + def add_internalize_pass(self): + """ + See https://llvm.org/docs/Passes.html#internalize-internalize-global-symbols + + LLVM 14: `llvm::createInternalizePass` + """ # noqa E501 + ffi.lib.LLVMPY_AddInternalizePass(self) + + def add_cfg_simplification_pass(self): + """ + See http://llvm.org/docs/Passes.html#simplifycfg-simplify-the-cfg + + LLVM 14: `LLVMAddCFGSimplificationPass` + """ + ffi.lib.LLVMPY_AddCFGSimplificationPass(self) + + def add_jump_threading_pass(self, threshold=-1): + """ + See https://llvm.org/docs/Passes.html#jump-threading-jump-threading + + LLVM 14: `llvm::createJumpThreadingPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddJumpThreadingPass(self, threshold) + + def add_lcssa_pass(self): + """ + See https://llvm.org/docs/Passes.html#lcssa-loop-closed-ssa-form-pass + + LLVM 14: `llvm::createLCSSAPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLCSSAPass(self) + + def add_gvn_pass(self): + """ + See http://llvm.org/docs/Passes.html#gvn-global-value-numbering + + LLVM 14: `LLVMAddGVNPass` + """ + ffi.lib.LLVMPY_AddGVNPass(self) + + def add_instruction_combining_pass(self): + """ + See http://llvm.org/docs/Passes.html#passes-instcombine + + LLVM 14: `LLVMAddInstructionCombiningPass` + """ + ffi.lib.LLVMPY_AddInstructionCombiningPass(self) + + def add_licm_pass(self): + """ + See http://llvm.org/docs/Passes.html#licm-loop-invariant-code-motion + + LLVM 14: `LLVMAddLICMPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLICMPass(self) + + def add_loop_deletion_pass(self): + """ + See https://llvm.org/docs/Passes.html#loop-deletion-delete-dead-loops + + LLVM 14: `llvm::createLoopDeletionPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLoopDeletionPass(self) + + def add_loop_extractor_pass(self): + """ + See https://llvm.org/docs/Passes.html#loop-extract-extract-loops-into-new-functions + + LLVM 14: `llvm::createLoopExtractorPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLoopExtractorPass(self) + + def add_single_loop_extractor_pass(self): + """ + See https://llvm.org/docs/Passes.html#loop-extract-single-extract-at-most-one-loop-into-a-new-function + + LLVM 14: `llvm::createSingleLoopExtractorPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddSingleLoopExtractorPass(self) + + def add_sccp_pass(self): + """ + See http://llvm.org/docs/Passes.html#sccp-sparse-conditional-constant-propagation + + LLVM 14: `LLVMAddSCCPPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddSCCPPass(self) + + def add_loop_strength_reduce_pass(self): + """ + See https://llvm.org/docs/Passes.html#loop-reduce-loop-strength-reduction + + LLVM 14: `llvm::createLoopStrengthReducePass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLoopStrengthReducePass(self) + + def add_loop_simplification_pass(self): + """ + See https://llvm.org/docs/Passes.html#loop-simplify-canonicalize-natural-loops + + LLVM 14: `llvm::createLoopSimplifyPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLoopSimplificationPass(self) + + def add_loop_unroll_pass(self): + """ + See https://llvm.org/docs/Passes.html#loop-unroll-unroll-loops + + LLVM 14: `LLVMAddLoopUnrollPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLoopUnrollPass(self) + + def add_loop_unroll_and_jam_pass(self): + """ + See https://llvm.org/docs/Passes.html#loop-unroll-and-jam-unroll-and-jam-loops + + LLVM 14: `LLVMAddLoopUnrollAndJamPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLoopUnrollAndJamPass(self) + + def add_loop_unswitch_pass(self, + optimize_for_size=False, + has_branch_divergence=False): + """ + See https://llvm.org/docs/Passes.html#loop-unswitch-unswitch-loops + + LLVM 14: `llvm::createLoopUnswitchPass` + LLVM 15: `llvm::createSimpleLoopUnswitchLegacyPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLoopUnswitchPass(self, optimize_for_size, + has_branch_divergence) + + def add_lower_atomic_pass(self): + """ + See https://llvm.org/docs/Passes.html#loweratomic-lower-atomic-intrinsics-to-non-atomic-form + + LLVM 14: `llvm::createLowerAtomicPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLowerAtomicPass(self) + + def add_lower_invoke_pass(self): + """ + See https://llvm.org/docs/Passes.html#lowerinvoke-lower-invokes-to-calls-for-unwindless-code-generators + + LLVM 14: `llvm::createLowerInvokePass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLowerInvokePass(self) + + def add_lower_switch_pass(self): + """ + See https://llvm.org/docs/Passes.html#lowerswitch-lower-switchinsts-to-branches + + LLVM 14: `llvm::createLowerSwitchPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddLowerSwitchPass(self) + + def add_memcpy_optimization_pass(self): + """ + See https://llvm.org/docs/Passes.html#memcpyopt-memcpy-optimization + + LLVM 14: `llvm::createMemCpyOptPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddMemCpyOptimizationPass(self) + + def add_merge_functions_pass(self): + """ + See https://llvm.org/docs/Passes.html#mergefunc-merge-functions + + LLVM 14: `llvm::createMergeFunctionsPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddMergeFunctionsPass(self) + + def add_merge_returns_pass(self): + """ + See https://llvm.org/docs/Passes.html#mergereturn-unify-function-exit-nodes + + LLVM 14: `llvm::createUnifyFunctionExitNodesPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddMergeReturnsPass(self) + + def add_partial_inlining_pass(self): + """ + See https://llvm.org/docs/Passes.html#partial-inliner-partial-inliner + + LLVM 14: `llvm::createPartialInliningPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddPartialInliningPass(self) + + def add_prune_exception_handling_pass(self): + """ + See https://llvm.org/docs/Passes.html#prune-eh-remove-unused-exception-handling-info + + LLVM 14: `llvm::createPruneEHPass` + """ # noqa E501 + if llvm_version_major > 15: + raise RuntimeError("PruneEHPass unavailable in LLVM > 15") + ffi.lib.LLVMPY_AddPruneExceptionHandlingPass(self) + + def add_reassociate_expressions_pass(self): + """ + See https://llvm.org/docs/Passes.html#reassociate-reassociate-expressions + + LLVM 14: `llvm::createReassociatePass` + """ # noqa E501 + ffi.lib.LLVMPY_AddReassociatePass(self) + + def add_demote_register_to_memory_pass(self): + """ + See https://llvm.org/docs/Passes.html#rel-lookup-table-converter-relative-lookup-table-converter + + LLVM 14: `llvm::createDemoteRegisterToMemoryPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddDemoteRegisterToMemoryPass(self) + + def add_sroa_pass(self): + """ + See http://llvm.org/docs/Passes.html#scalarrepl-scalar-replacement-of-aggregates-dt + Note that this pass corresponds to the ``opt -sroa`` command-line option, + despite the link above. + + LLVM 14: `llvm::createSROAPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddSROAPass(self) + + def add_sink_pass(self): + """ + See https://llvm.org/docs/Passes.html#sink-code-sinking + + LLVM 14: `llvm::createSinkingPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddSinkPass(self) + + def add_strip_symbols_pass(self, only_debug=False): + """ + See https://llvm.org/docs/Passes.html#strip-strip-all-symbols-from-a-module + + LLVM 14: `llvm::createStripSymbolsPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddStripSymbolsPass(self, only_debug) + + def add_strip_dead_debug_info_pass(self): + """ + See https://llvm.org/docs/Passes.html#strip-dead-debug-info-strip-debug-info-for-unused-symbols + + LLVM 14: `llvm::createStripDeadDebugInfoPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddStripDeadDebugInfoPass(self) + + def add_strip_dead_prototypes_pass(self): + """ + See https://llvm.org/docs/Passes.html#strip-dead-prototypes-strip-unused-function-prototypes + + LLVM 14: `llvm::createStripDeadPrototypesPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddStripDeadPrototypesPass(self) + + def add_strip_debug_declare_pass(self): + """ + See https://llvm.org/docs/Passes.html#strip-debug-declare-strip-all-llvm-dbg-declare-intrinsics + + LLVM 14: `llvm::createStripDebugDeclarePass` + """ # noqa E501 + ffi.lib.LLVMPY_AddStripDebugDeclarePrototypesPass(self) + + def add_strip_nondebug_symbols_pass(self): + """ + See https://llvm.org/docs/Passes.html#strip-nondebug-strip-all-symbols-except-dbg-symbols-from-a-module + + LLVM 14: `llvm::createStripNonDebugSymbolsPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddStripNondebugSymbolsPass(self) + + def add_tail_call_elimination_pass(self): + """ + See https://llvm.org/docs/Passes.html#tailcallelim-tail-call-elimination + + LLVM 14: `llvm::createTailCallEliminationPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddTailCallEliminationPass(self) + + def add_type_based_alias_analysis_pass(self): + """ + LLVM 14: `LLVMAddTypeBasedAliasAnalysisPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddTypeBasedAliasAnalysisPass(self) + + def add_basic_alias_analysis_pass(self): + """ + See http://llvm.org/docs/AliasAnalysis.html#the-basicaa-pass + + LLVM 14: `LLVMAddBasicAliasAnalysisPass` + """ + ffi.lib.LLVMPY_AddBasicAliasAnalysisPass(self) + + def add_loop_rotate_pass(self): + """http://llvm.org/docs/Passes.html#loop-rotate-rotate-loops.""" + ffi.lib.LLVMPY_AddLoopRotatePass(self) + + def add_target_library_info(self, triple): + ffi.lib.LLVMPY_AddTargetLibraryInfoPass(self, _encode_string(triple)) + + def add_instruction_namer_pass(self): + """ + See https://llvm.org/docs/Passes.html#instnamer-assign-names-to-anonymous-instructions. + + LLVM 14: `llvm::createInstructionNamerPass` + """ # noqa E501 + ffi.lib.LLVMPY_AddInstructionNamerPass(self) + + # Non-standard LLVM passes + + def add_refprune_pass(self, subpasses_flags=RefPruneSubpasses.ALL, + subgraph_limit=1000): + """Add Numba specific Reference count pruning pass. + + Parameters + ---------- + subpasses_flags : RefPruneSubpasses + A bitmask to control the subpasses to be enabled. + subgraph_limit : int + Limit the fanout pruners to working on a subgraph no bigger than + this number of basic-blocks to avoid spending too much time in very + large graphs. Default is 1000. Subject to change in future + versions. + """ + iflags = RefPruneSubpasses(subpasses_flags) + ffi.lib.LLVMPY_AddLegacyRefPrunePass(self, iflags, subgraph_limit) + + +class ModulePassManager(PassManager): + + def __init__(self, ptr=None): + if ptr is None: + ptr = ffi.lib.LLVMPY_CreatePassManager() + PassManager.__init__(self, ptr) + + def run(self, module, remarks_file=None, remarks_format='yaml', + remarks_filter=''): + """ + Run optimization passes on the given module. + + Parameters + ---------- + module : llvmlite.binding.ModuleRef + The module to be optimized inplace + remarks_file : str; optional + If not `None`, it is the file to store the optimization remarks. + remarks_format : str; optional + The format to write; YAML is default + remarks_filter : str; optional + The filter that should be applied to the remarks output. + """ + if remarks_file is None: + return ffi.lib.LLVMPY_RunPassManager(self, module) + else: + r = ffi.lib.LLVMPY_RunPassManagerWithRemarks( + self, module, _encode_string(remarks_format), + _encode_string(remarks_filter), + _encode_string(remarks_file)) + if r == -1: + raise IOError("Failed to initialize remarks file.") + return r > 0 + + def run_with_remarks(self, module, remarks_format='yaml', + remarks_filter=''): + """ + Run optimization passes on the given module and returns the result and + the remarks data. + + Parameters + ---------- + module : llvmlite.binding.ModuleRef + The module to be optimized + remarks_format : str + The remarks output; YAML is the default + remarks_filter : str; optional + The filter that should be applied to the remarks output. + """ + remarkdesc, remarkfile = mkstemp() + try: + with os.fdopen(remarkdesc, 'r'): + pass + r = self.run(module, remarkfile, remarks_format, remarks_filter) + if r == -1: + raise IOError("Failed to initialize remarks file.") + with open(remarkfile) as f: + return bool(r), f.read() + finally: + os.unlink(remarkfile) + + +class FunctionPassManager(PassManager): + + def __init__(self, module): + ptr = ffi.lib.LLVMPY_CreateFunctionPassManager(module) + self._module = module + module._owned = True + PassManager.__init__(self, ptr) + + def initialize(self): + """ + Initialize the FunctionPassManager. Returns True if it produced + any changes (?). + """ + return ffi.lib.LLVMPY_InitializeFunctionPassManager(self) + + def finalize(self): + """ + Finalize the FunctionPassManager. Returns True if it produced + any changes (?). + """ + return ffi.lib.LLVMPY_FinalizeFunctionPassManager(self) + + def run(self, function, remarks_file=None, remarks_format='yaml', + remarks_filter=''): + """ + Run optimization passes on the given function. + + Parameters + ---------- + function : llvmlite.binding.FunctionRef + The function to be optimized inplace + remarks_file : str; optional + If not `None`, it is the file to store the optimization remarks. + remarks_format : str; optional + The format of the remarks file; the default is YAML + remarks_filter : str; optional + The filter that should be applied to the remarks output. + """ + if remarks_file is None: + return ffi.lib.LLVMPY_RunFunctionPassManager(self, function) + else: + r = ffi.lib.LLVMPY_RunFunctionPassManagerWithRemarks( + self, function, _encode_string(remarks_format), + _encode_string(remarks_filter), + _encode_string(remarks_file)) + if r == -1: + raise IOError("Failed to initialize remarks file.") + return bool(r) + + def run_with_remarks(self, function, remarks_format='yaml', + remarks_filter=''): + """ + Run optimization passes on the given function and returns the result + and the remarks data. + + Parameters + ---------- + function : llvmlite.binding.FunctionRef + The function to be optimized inplace + remarks_format : str; optional + The format of the remarks file; the default is YAML + remarks_filter : str; optional + The filter that should be applied to the remarks output. + """ + # LLVM is going to need to close this file and then reopen it, so we + # can't use an unlinked temporary file. + remarkdesc, remarkfile = mkstemp() + try: + # We get an open handle, but we need LLVM to write first, so close + # it. + with os.fdopen(remarkdesc, 'r'): + pass + r = self.run(function, remarkfile, remarks_format, remarks_filter) + if r == -1: + raise IOError("Failed to initialize remarks file.") + with open(remarkfile) as f: + return bool(r), f.read() + finally: + os.unlink(remarkfile) + + +# ============================================================================ +# FFI + +ffi.lib.LLVMPY_CreatePassManager.restype = ffi.LLVMPassManagerRef + +ffi.lib.LLVMPY_CreateFunctionPassManager.argtypes = [ffi.LLVMModuleRef] +ffi.lib.LLVMPY_CreateFunctionPassManager.restype = ffi.LLVMPassManagerRef + +ffi.lib.LLVMPY_DisposePassManager.argtypes = [ffi.LLVMPassManagerRef] + +ffi.lib.LLVMPY_RunPassManager.argtypes = [ffi.LLVMPassManagerRef, + ffi.LLVMModuleRef] +ffi.lib.LLVMPY_RunPassManager.restype = c_bool + +ffi.lib.LLVMPY_RunPassManagerWithRemarks.argtypes = [ffi.LLVMPassManagerRef, + ffi.LLVMModuleRef, + c_char_p, + c_char_p, + c_char_p] +ffi.lib.LLVMPY_RunPassManagerWithRemarks.restype = c_int + +ffi.lib.LLVMPY_InitializeFunctionPassManager.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_InitializeFunctionPassManager.restype = c_bool + +ffi.lib.LLVMPY_FinalizeFunctionPassManager.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_FinalizeFunctionPassManager.restype = c_bool + +ffi.lib.LLVMPY_RunFunctionPassManager.argtypes = [ffi.LLVMPassManagerRef, + ffi.LLVMValueRef] +ffi.lib.LLVMPY_RunFunctionPassManager.restype = c_bool + +ffi.lib.LLVMPY_RunFunctionPassManagerWithRemarks.argtypes = [ + ffi.LLVMPassManagerRef, ffi.LLVMValueRef, c_char_p, c_char_p, c_char_p +] +ffi.lib.LLVMPY_RunFunctionPassManagerWithRemarks.restype = c_int + +ffi.lib.LLVMPY_AddAAEvalPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddBasicAAWrapperPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddConstantMergePass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddDeadArgEliminationPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddDependenceAnalysisPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddCallGraphDOTPrinterPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddCFGPrinterPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddDotDomPrinterPass.argtypes = [ffi.LLVMPassManagerRef, c_bool] +ffi.lib.LLVMPY_AddDotPostDomPrinterPass.argtypes = [ + ffi.LLVMPassManagerRef, + c_bool] +ffi.lib.LLVMPY_AddGlobalsModRefAAPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddInstructionCountPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddIVUsersPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLazyValueInfoPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLintPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddModuleDebugInfoPrinterPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddRegionInfoPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddScalarEvolutionAAPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddAggressiveDCEPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddAlwaysInlinerPass.argtypes = [ffi.LLVMPassManagerRef, c_bool] +ffi.lib.LLVMPY_AddBreakCriticalEdgesPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddDeadStoreEliminationPass.argtypes = [ + ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddReversePostOrderFunctionAttrsPass.argtypes = [ + ffi.LLVMPassManagerRef] + +if llvm_version_major < 16: + ffi.lib.LLVMPY_AddAggressiveInstructionCombiningPass.argtypes = [ + ffi.LLVMPassManagerRef] + +ffi.lib.LLVMPY_AddInternalizePass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLCSSAPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLoopDeletionPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLoopExtractorPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddSingleLoopExtractorPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLoopStrengthReducePass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLoopSimplificationPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLoopUnrollPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLoopUnrollAndJamPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLoopUnswitchPass.argtypes = [ffi.LLVMPassManagerRef, c_bool, + c_bool] +ffi.lib.LLVMPY_AddLowerAtomicPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLowerInvokePass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLowerSwitchPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddMemCpyOptimizationPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddMergeFunctionsPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddMergeReturnsPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddPartialInliningPass.argtypes = [ffi.LLVMPassManagerRef] + +if llvm_version_major < 16: + ffi.lib.LLVMPY_AddPruneExceptionHandlingPass.argtypes = [ + ffi.LLVMPassManagerRef + ] + +ffi.lib.LLVMPY_AddReassociatePass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddDemoteRegisterToMemoryPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddSinkPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddStripSymbolsPass.argtypes = [ffi.LLVMPassManagerRef, c_bool] +ffi.lib.LLVMPY_AddStripDeadDebugInfoPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddStripDeadPrototypesPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddStripDebugDeclarePrototypesPass.argtypes = [ + ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddStripNondebugSymbolsPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddTailCallEliminationPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddJumpThreadingPass.argtypes = [ffi.LLVMPassManagerRef, c_int] +ffi.lib.LLVMPY_AddFunctionAttrsPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddFunctionInliningPass.argtypes = [ + ffi.LLVMPassManagerRef, c_int] +ffi.lib.LLVMPY_AddGlobalDCEPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddGlobalOptimizerPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddIPSCCPPass.argtypes = [ffi.LLVMPassManagerRef] + +ffi.lib.LLVMPY_AddDeadCodeEliminationPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddCFGSimplificationPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddGVNPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddInstructionCombiningPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddLICMPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddSCCPPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddSROAPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddTypeBasedAliasAnalysisPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddBasicAliasAnalysisPass.argtypes = [ffi.LLVMPassManagerRef] +ffi.lib.LLVMPY_AddTargetLibraryInfoPass.argtypes = [ffi.LLVMPassManagerRef, + c_char_p] +ffi.lib.LLVMPY_AddInstructionNamerPass.argtypes = [ffi.LLVMPassManagerRef] + +ffi.lib.LLVMPY_AddLegacyRefPrunePass.argtypes = [ffi.LLVMPassManagerRef, c_int, + c_size_t] + +ffi.lib.LLVMPY_DumpRefPruneStats.argtypes = [POINTER(_c_PruneStats), c_bool] diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/targets.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/targets.py new file mode 100644 index 0000000000000000000000000000000000000000..8f2d7c317c15b26c04b62ab226362f203d1389d9 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/targets.py @@ -0,0 +1,520 @@ +import os +from ctypes import (POINTER, c_char_p, c_longlong, c_int, c_size_t, + c_void_p, string_at) + +from llvmlite.binding import ffi +from llvmlite.binding.initfini import llvm_version_info +from llvmlite.binding.common import _decode_string, _encode_string +from collections import namedtuple + +# FIXME: Remove `opaque_pointers_enabled` once typed pointers are no longer +# supported. +from llvmlite import opaque_pointers_enabled + +Triple = namedtuple('Triple', ['Arch', 'SubArch', 'Vendor', + 'OS', 'Env', 'ObjectFormat']) + + +def get_process_triple(): + """ + Return a target triple suitable for generating code for the current process. + An example when the default triple from ``get_default_triple()`` is not be + suitable is when LLVM is compiled for 32-bit but the process is executing + in 64-bit mode. + """ + with ffi.OutputString() as out: + ffi.lib.LLVMPY_GetProcessTriple(out) + return str(out) + + +def get_triple_parts(triple: str): + """ + Return a tuple of the parts of the given triple. + """ + with ffi.OutputString() as arch, \ + ffi.OutputString() as vendor, \ + ffi.OutputString() as os, ffi.OutputString() as env: + ffi.lib.LLVMPY_GetTripleParts(triple.encode('utf8'), + arch, vendor, os, env) + arch = str(arch) + subarch = '' + for _str in triple.split('-'): + if _str.startswith(arch): + subarch = _str[len(arch):] + break + return Triple(arch, subarch, str(vendor), str(os), + str(env), get_object_format(triple)) + + +class FeatureMap(dict): + """ + Maps feature name to a boolean indicating the availability of the feature. + Extends ``dict`` to add `.flatten()` method. + """ + + def flatten(self, sort=True): + """ + Args + ---- + sort: bool + Optional. If True, the features are sorted by name; otherwise, + the ordering is unstable between python session due to hash + randomization. Defaults to True. + + Returns a string suitable for use as the ``features`` argument to + ``Target.create_target_machine()``. + + """ + iterator = sorted(self.items()) if sort else iter(self.items()) + flag_map = {True: '+', False: '-'} + return ','.join('{0}{1}'.format(flag_map[v], k) + for k, v in iterator) + + +def get_host_cpu_features(): + """ + Returns a dictionary-like object indicating the CPU features for current + architecture and whether they are enabled for this CPU. The key-value pairs + are the feature name as string and a boolean indicating whether the feature + is available. The returned value is an instance of ``FeatureMap`` class, + which adds a new method ``.flatten()`` for returning a string suitable for + use as the "features" argument to ``Target.create_target_machine()``. + + If LLVM has not implemented this feature or it fails to get the information, + this function will raise a RuntimeError exception. + """ + with ffi.OutputString() as out: + outdict = FeatureMap() + if not ffi.lib.LLVMPY_GetHostCPUFeatures(out): + return outdict + flag_map = {'+': True, '-': False} + content = str(out) + if content: # protect against empty string + for feat in content.split(','): + if feat: # protect against empty feature + outdict[feat[1:]] = flag_map[feat[0]] + return outdict + + +def get_default_triple(): + """ + Return the default target triple LLVM is configured to produce code for. + """ + with ffi.OutputString() as out: + ffi.lib.LLVMPY_GetDefaultTargetTriple(out) + return str(out) + + +def get_host_cpu_name(): + """ + Get the name of the host's CPU, suitable for using with + :meth:`Target.create_target_machine()`. + """ + with ffi.OutputString() as out: + ffi.lib.LLVMPY_GetHostCPUName(out) + return str(out) + + +# Adapted from https://github.com/llvm/llvm-project/blob/release/15.x/llvm/include/llvm/ADT/Triple.h#L269 # noqa +llvm_version_major = llvm_version_info[0] + + +if llvm_version_major >= 15: + _object_formats = { + 0: "Unknown", + 1: "COFF", + 2: "DXContainer", + 3: "ELF", + 4: "GOFF", + 5: "MachO", + 6: "SPIRV", + 7: "Wasm", + 8: "XCOFF", + } +else: + _object_formats = { + 0: "Unknown", + 1: "COFF", + 2: "ELF", + 3: "GOFF", + 4: "MachO", + 5: "Wasm", + 6: "XCOFF", + } + + +def get_object_format(triple=None): + """ + Get the object format for the given *triple* string (or the default + triple if omitted). + A string is returned + """ + if triple is None: + triple = get_default_triple() + res = ffi.lib.LLVMPY_GetTripleObjectFormat(_encode_string(triple)) + return _object_formats[res] + + +def create_target_data(layout): + """ + Create a TargetData instance for the given *layout* string. + """ + return TargetData(ffi.lib.LLVMPY_CreateTargetData(_encode_string(layout))) + + +class TargetData(ffi.ObjectRef): + """ + A TargetData provides structured access to a data layout. + Use :func:`create_target_data` to create instances. + """ + + def __str__(self): + if self._closed: + return "" + with ffi.OutputString() as out: + ffi.lib.LLVMPY_CopyStringRepOfTargetData(self, out) + return str(out) + + def _dispose(self): + self._capi.LLVMPY_DisposeTargetData(self) + + def get_abi_size(self, ty): + """ + Get ABI size of LLVM type *ty*. + """ + return ffi.lib.LLVMPY_ABISizeOfType(self, ty) + + def get_element_offset(self, ty, position): + """ + Get byte offset of type's ty element at the given position + """ + + offset = ffi.lib.LLVMPY_OffsetOfElement(self, ty, position) + if offset == -1: + raise ValueError("Could not determined offset of {}th " + "element of the type '{}'. Is it a struct" + "type?".format(position, str(ty))) + return offset + + def get_abi_alignment(self, ty): + """ + Get minimum ABI alignment of LLVM type *ty*. + """ + return ffi.lib.LLVMPY_ABIAlignmentOfType(self, ty) + + def get_pointee_abi_size(self, ty): + """ + Get ABI size of pointee type of LLVM pointer type *ty*. + """ + if opaque_pointers_enabled: + raise RuntimeError("Cannot get pointee type in opaque pointer " + "mode.") + size = ffi.lib.LLVMPY_ABISizeOfElementType(self, ty) + if size == -1: + raise RuntimeError("Not a pointer type: %s" % (ty,)) + return size + + def get_pointee_abi_alignment(self, ty): + """ + Get minimum ABI alignment of pointee type of LLVM pointer type *ty*. + """ + if opaque_pointers_enabled: + raise RuntimeError("Cannot get pointee type in opaque pointer " + "mode.") + size = ffi.lib.LLVMPY_ABIAlignmentOfElementType(self, ty) + if size == -1: + raise RuntimeError("Not a pointer type: %s" % (ty,)) + return size + + +RELOC = frozenset(['default', 'static', 'pic', 'dynamicnopic']) +CODEMODEL = frozenset(['default', 'jitdefault', 'small', 'kernel', 'medium', + 'large']) + + +class Target(ffi.ObjectRef): + _triple = '' + + # No _dispose() method since LLVMGetTargetFromTriple() returns a + # persistent object. + + @classmethod + def from_default_triple(cls): + """ + Create a Target instance for the default triple. + """ + triple = get_default_triple() + return cls.from_triple(triple) + + @classmethod + def from_triple(cls, triple): + """ + Create a Target instance for the given triple (a string). + """ + with ffi.OutputString() as outerr: + target = ffi.lib.LLVMPY_GetTargetFromTriple(triple.encode('utf8'), + outerr) + if not target: + raise RuntimeError(str(outerr)) + target = cls(target) + target._triple = triple + return target + + @property + def name(self): + s = ffi.lib.LLVMPY_GetTargetName(self) + return _decode_string(s) + + @property + def description(self): + s = ffi.lib.LLVMPY_GetTargetDescription(self) + return _decode_string(s) + + @property + def triple(self): + return self._triple + + def __str__(self): + return "".format(self.name, self.description) + + def create_target_machine(self, cpu='', features='', + opt=2, reloc='default', codemodel='jitdefault', + printmc=False, jit=False, abiname=''): + """ + Create a new TargetMachine for this target and the given options. + + Specifying codemodel='default' will result in the use of the "small" + code model. Specifying codemodel='jitdefault' will result in the code + model being picked based on platform bitness (32="small", 64="large"). + + The `printmc` option corresponds to llvm's `-print-machineinstrs`. + + The `jit` option should be set when the target-machine is to be used + in a JIT engine. + + The `abiname` option specifies the ABI. RISC-V targets with hard-float + needs to pass the ABI name to LLVM. + """ + assert 0 <= opt <= 3 + assert reloc in RELOC + assert codemodel in CODEMODEL + triple = self._triple + # MCJIT under Windows only supports ELF objects, see + # http://lists.llvm.org/pipermail/llvm-dev/2013-December/068341.html + # Note we still want to produce regular COFF files in AOT mode. + if os.name == 'nt' and codemodel == 'jitdefault': + triple += '-elf' + tm = ffi.lib.LLVMPY_CreateTargetMachine(self, + _encode_string(triple), + _encode_string(cpu), + _encode_string(features), + opt, + _encode_string(reloc), + _encode_string(codemodel), + int(printmc), + int(jit), + _encode_string(abiname), + ) + if tm: + return TargetMachine(tm) + else: + raise RuntimeError("Cannot create target machine") + + +class TargetMachine(ffi.ObjectRef): + + def _dispose(self): + self._capi.LLVMPY_DisposeTargetMachine(self) + + def add_analysis_passes(self, pm): + """ + Register analysis passes for this target machine with a pass manager. + """ + ffi.lib.LLVMPY_AddAnalysisPasses(self, pm) + + def set_asm_verbosity(self, verbose): + """ + Set whether this target machine will emit assembly with human-readable + comments describing control flow, debug information, and so on. + """ + ffi.lib.LLVMPY_SetTargetMachineAsmVerbosity(self, verbose) + + def emit_object(self, module): + """ + Represent the module as a code object, suitable for use with + the platform's linker. Returns a byte string. + """ + return self._emit_to_memory(module, use_object=True) + + def emit_assembly(self, module): + """ + Return the raw assembler of the module, as a string. + + llvm.initialize_native_asmprinter() must have been called first. + """ + return _decode_string(self._emit_to_memory(module, use_object=False)) + + def _emit_to_memory(self, module, use_object=False): + """Returns bytes of object code of the module. + + Args + ---- + use_object : bool + Emit object code or (if False) emit assembly code. + """ + with ffi.OutputString() as outerr: + mb = ffi.lib.LLVMPY_TargetMachineEmitToMemory(self, module, + int(use_object), + outerr) + if not mb: + raise RuntimeError(str(outerr)) + + bufptr = ffi.lib.LLVMPY_GetBufferStart(mb) + bufsz = ffi.lib.LLVMPY_GetBufferSize(mb) + try: + return string_at(bufptr, bufsz) + finally: + ffi.lib.LLVMPY_DisposeMemoryBuffer(mb) + + @property + def target_data(self): + return TargetData(ffi.lib.LLVMPY_CreateTargetMachineData(self)) + + @property + def triple(self): + with ffi.OutputString() as out: + ffi.lib.LLVMPY_GetTargetMachineTriple(self, out) + return str(out) + + +def has_svml(): + """ + Returns True if SVML was enabled at FFI support compile time. + """ + if ffi.lib.LLVMPY_HasSVMLSupport() == 0: + return False + else: + return True + + +# ============================================================================ +# FFI + +ffi.lib.LLVMPY_GetProcessTriple.argtypes = [POINTER(c_char_p)] +ffi.lib.LLVMPY_GetTripleParts.argtypes = [c_char_p, POINTER(c_char_p), + POINTER(c_char_p), POINTER(c_char_p), + POINTER(c_char_p)] + +ffi.lib.LLVMPY_GetHostCPUFeatures.argtypes = [POINTER(c_char_p)] +ffi.lib.LLVMPY_GetHostCPUFeatures.restype = c_int + +ffi.lib.LLVMPY_GetDefaultTargetTriple.argtypes = [POINTER(c_char_p)] + +ffi.lib.LLVMPY_GetHostCPUName.argtypes = [POINTER(c_char_p)] + +ffi.lib.LLVMPY_GetTripleObjectFormat.argtypes = [c_char_p] +ffi.lib.LLVMPY_GetTripleObjectFormat.restype = c_int + +ffi.lib.LLVMPY_CreateTargetData.argtypes = [c_char_p] +ffi.lib.LLVMPY_CreateTargetData.restype = ffi.LLVMTargetDataRef + +ffi.lib.LLVMPY_CopyStringRepOfTargetData.argtypes = [ + ffi.LLVMTargetDataRef, + POINTER(c_char_p), +] + +ffi.lib.LLVMPY_DisposeTargetData.argtypes = [ + ffi.LLVMTargetDataRef, +] + +ffi.lib.LLVMPY_ABISizeOfType.argtypes = [ffi.LLVMTargetDataRef, + ffi.LLVMTypeRef] +ffi.lib.LLVMPY_ABISizeOfType.restype = c_longlong + +ffi.lib.LLVMPY_OffsetOfElement.argtypes = [ffi.LLVMTargetDataRef, + ffi.LLVMTypeRef, + c_int] +ffi.lib.LLVMPY_OffsetOfElement.restype = c_longlong + +ffi.lib.LLVMPY_ABIAlignmentOfType.argtypes = [ffi.LLVMTargetDataRef, + ffi.LLVMTypeRef] +ffi.lib.LLVMPY_ABIAlignmentOfType.restype = c_longlong + +# FIXME: Remove me once typed pointers are no longer supported. +ffi.lib.LLVMPY_ABISizeOfElementType.argtypes = [ffi.LLVMTargetDataRef, + ffi.LLVMTypeRef] +ffi.lib.LLVMPY_ABISizeOfElementType.restype = c_longlong + +# FIXME: Remove me once typed pointers are no longer supported. +ffi.lib.LLVMPY_ABIAlignmentOfElementType.argtypes = [ffi.LLVMTargetDataRef, + ffi.LLVMTypeRef] +ffi.lib.LLVMPY_ABIAlignmentOfElementType.restype = c_longlong + +ffi.lib.LLVMPY_GetTargetFromTriple.argtypes = [c_char_p, POINTER(c_char_p)] +ffi.lib.LLVMPY_GetTargetFromTriple.restype = ffi.LLVMTargetRef + +ffi.lib.LLVMPY_GetTargetName.argtypes = [ffi.LLVMTargetRef] +ffi.lib.LLVMPY_GetTargetName.restype = c_char_p + +ffi.lib.LLVMPY_GetTargetDescription.argtypes = [ffi.LLVMTargetRef] +ffi.lib.LLVMPY_GetTargetDescription.restype = c_char_p + +ffi.lib.LLVMPY_CreateTargetMachine.argtypes = [ + ffi.LLVMTargetRef, + # Triple + c_char_p, + # CPU + c_char_p, + # Features + c_char_p, + # OptLevel + c_int, + # Reloc + c_char_p, + # CodeModel + c_char_p, + # PrintMC + c_int, + # JIT + c_int, + # ABIName + c_char_p, +] +ffi.lib.LLVMPY_CreateTargetMachine.restype = ffi.LLVMTargetMachineRef + +ffi.lib.LLVMPY_DisposeTargetMachine.argtypes = [ffi.LLVMTargetMachineRef] + +ffi.lib.LLVMPY_GetTargetMachineTriple.argtypes = [ffi.LLVMTargetMachineRef, + POINTER(c_char_p)] + +ffi.lib.LLVMPY_SetTargetMachineAsmVerbosity.argtypes = [ + ffi.LLVMTargetMachineRef, c_int] + +ffi.lib.LLVMPY_AddAnalysisPasses.argtypes = [ + ffi.LLVMTargetMachineRef, + ffi.LLVMPassManagerRef, +] + +ffi.lib.LLVMPY_TargetMachineEmitToMemory.argtypes = [ + ffi.LLVMTargetMachineRef, + ffi.LLVMModuleRef, + c_int, + POINTER(c_char_p), +] +ffi.lib.LLVMPY_TargetMachineEmitToMemory.restype = ffi.LLVMMemoryBufferRef + +ffi.lib.LLVMPY_GetBufferStart.argtypes = [ffi.LLVMMemoryBufferRef] +ffi.lib.LLVMPY_GetBufferStart.restype = c_void_p + +ffi.lib.LLVMPY_GetBufferSize.argtypes = [ffi.LLVMMemoryBufferRef] +ffi.lib.LLVMPY_GetBufferSize.restype = c_size_t + +ffi.lib.LLVMPY_DisposeMemoryBuffer.argtypes = [ffi.LLVMMemoryBufferRef] + +ffi.lib.LLVMPY_CreateTargetMachineData.argtypes = [ + ffi.LLVMTargetMachineRef, +] +ffi.lib.LLVMPY_CreateTargetMachineData.restype = ffi.LLVMTargetDataRef + +ffi.lib.LLVMPY_HasSVMLSupport.argtypes = [] +ffi.lib.LLVMPY_HasSVMLSupport.restype = c_int diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/transforms.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/transforms.py new file mode 100644 index 0000000000000000000000000000000000000000..82c5dc157a54d7cb1730dadb9b453cc684640cbf --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/transforms.py @@ -0,0 +1,151 @@ +from ctypes import c_uint, c_bool +from llvmlite.binding import ffi +from llvmlite.binding import passmanagers + + +def create_pass_manager_builder(): + return PassManagerBuilder() + + +class PassManagerBuilder(ffi.ObjectRef): + __slots__ = () + + def __init__(self, ptr=None): + if ptr is None: + ptr = ffi.lib.LLVMPY_PassManagerBuilderCreate() + ffi.ObjectRef.__init__(self, ptr) + + @property + def opt_level(self): + """ + The general optimization level as an integer between 0 and 3. + """ + return ffi.lib.LLVMPY_PassManagerBuilderGetOptLevel(self) + + @opt_level.setter + def opt_level(self, level): + ffi.lib.LLVMPY_PassManagerBuilderSetOptLevel(self, level) + + @property + def size_level(self): + """ + Whether and how much to optimize for size. An integer between 0 and 2. + """ + return ffi.lib.LLVMPY_PassManagerBuilderGetSizeLevel(self) + + @size_level.setter + def size_level(self, size): + ffi.lib.LLVMPY_PassManagerBuilderSetSizeLevel(self, size) + + @property + def inlining_threshold(self): + """ + The integer threshold for inlining a function into another. The higher, + the more likely inlining a function is. This attribute is write-only. + """ + raise NotImplementedError("inlining_threshold is write-only") + + @inlining_threshold.setter + def inlining_threshold(self, threshold): + ffi.lib.LLVMPY_PassManagerBuilderUseInlinerWithThreshold( + self, threshold) + + @property + def disable_unroll_loops(self): + """ + If true, disable loop unrolling. + """ + return ffi.lib.LLVMPY_PassManagerBuilderGetDisableUnrollLoops(self) + + @disable_unroll_loops.setter + def disable_unroll_loops(self, disable=True): + ffi.lib.LLVMPY_PassManagerBuilderSetDisableUnrollLoops(self, disable) + + @property + def loop_vectorize(self): + """ + If true, allow vectorizing loops. + """ + return ffi.lib.LLVMPY_PassManagerBuilderGetLoopVectorize(self) + + @loop_vectorize.setter + def loop_vectorize(self, enable=True): + return ffi.lib.LLVMPY_PassManagerBuilderSetLoopVectorize(self, enable) + + @property + def slp_vectorize(self): + """ + If true, enable the "SLP vectorizer", which uses a different algorithm + from the loop vectorizer. Both may be enabled at the same time. + """ + return ffi.lib.LLVMPY_PassManagerBuilderGetSLPVectorize(self) + + @slp_vectorize.setter + def slp_vectorize(self, enable=True): + return ffi.lib.LLVMPY_PassManagerBuilderSetSLPVectorize(self, enable) + + def _populate_module_pm(self, pm): + ffi.lib.LLVMPY_PassManagerBuilderPopulateModulePassManager(self, pm) + + def _populate_function_pm(self, pm): + ffi.lib.LLVMPY_PassManagerBuilderPopulateFunctionPassManager(self, pm) + + def populate(self, pm): + if isinstance(pm, passmanagers.ModulePassManager): + self._populate_module_pm(pm) + elif isinstance(pm, passmanagers.FunctionPassManager): + self._populate_function_pm(pm) + else: + raise TypeError(pm) + + def _dispose(self): + self._capi.LLVMPY_PassManagerBuilderDispose(self) + + +# ============================================================================ +# FFI + +ffi.lib.LLVMPY_PassManagerBuilderCreate.restype = ffi.LLVMPassManagerBuilderRef + +ffi.lib.LLVMPY_PassManagerBuilderDispose.argtypes = [ + ffi.LLVMPassManagerBuilderRef, +] + +ffi.lib.LLVMPY_PassManagerBuilderPopulateModulePassManager.argtypes = [ + ffi.LLVMPassManagerBuilderRef, + ffi.LLVMPassManagerRef, +] + +ffi.lib.LLVMPY_PassManagerBuilderPopulateFunctionPassManager.argtypes = [ + ffi.LLVMPassManagerBuilderRef, + ffi.LLVMPassManagerRef, +] + +# Unsigned int PassManagerBuilder properties + +for _func in (ffi.lib.LLVMPY_PassManagerBuilderSetOptLevel, + ffi.lib.LLVMPY_PassManagerBuilderSetSizeLevel, + ffi.lib.LLVMPY_PassManagerBuilderUseInlinerWithThreshold, + ): + _func.argtypes = [ffi.LLVMPassManagerBuilderRef, c_uint] + +for _func in (ffi.lib.LLVMPY_PassManagerBuilderGetOptLevel, + ffi.lib.LLVMPY_PassManagerBuilderGetSizeLevel, + ): + _func.argtypes = [ffi.LLVMPassManagerBuilderRef] + _func.restype = c_uint + +# Boolean PassManagerBuilder properties + +for _func in (ffi.lib.LLVMPY_PassManagerBuilderSetDisableUnrollLoops, + ffi.lib.LLVMPY_PassManagerBuilderSetLoopVectorize, + ffi.lib.LLVMPY_PassManagerBuilderSetSLPVectorize, + ): + _func.argtypes = [ffi.LLVMPassManagerBuilderRef, c_bool] + +for _func in (ffi.lib.LLVMPY_PassManagerBuilderGetDisableUnrollLoops, + ffi.lib.LLVMPY_PassManagerBuilderGetLoopVectorize, + ffi.lib.LLVMPY_PassManagerBuilderGetSLPVectorize, + ): + _func.argtypes = [ffi.LLVMPassManagerBuilderRef] + _func.restype = c_bool diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/typeref.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/typeref.py new file mode 100644 index 0000000000000000000000000000000000000000..7f93599db76f16359d519921ee182aafb298d281 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/typeref.py @@ -0,0 +1,285 @@ +from ctypes import c_int, c_bool, c_void_p, c_uint64, c_uint, POINTER +import enum + +from llvmlite import ir +from llvmlite.binding import ffi + +# FIXME: Remove `opaque_pointers_enabled' when TP's are removed. +from llvmlite import opaque_pointers_enabled + + +class TypeKind(enum.IntEnum): + # The LLVMTypeKind enum from llvm-c/Core.h + + void = 0 + half = 1 + float = 2 + double = 3 + x86_fp80 = 4 + fp128 = 5 + ppc_fp128 = 6 + label = 7 + integer = 8 + function = 9 + struct = 10 + array = 11 + pointer = 12 + vector = 13 + metadata = 14 + x86_mmx = 15 + token = 16 + scalable_vector = 17 + bfloat = 18 + x86_amx = 19 + + +_TypeKindToIRType = { + # All TypeKind here must have a TypeRef.as_ir() implementation + TypeKind.void: ir.VoidType, + TypeKind.half: ir.HalfType, + TypeKind.float: ir.FloatType, + TypeKind.double: ir.DoubleType, + TypeKind.integer: ir.IntType, + TypeKind.function: ir.FunctionType, + TypeKind.pointer: ir.PointerType, + TypeKind.array: ir.ArrayType, + TypeKind.vector: ir.VectorType, + TypeKind.struct: ir.LiteralStructType, +} + + +class TypeRef(ffi.ObjectRef): + """A weak reference to a LLVM type + """ + @property + def name(self): + """ + Get type name + """ + return ffi.ret_string(ffi.lib.LLVMPY_GetTypeName(self)) + + @property + def is_struct(self): + """ + Returns true if the type is a struct type. + """ + return ffi.lib.LLVMPY_TypeIsStruct(self) + + @property + def is_pointer(self): + """ + Returns true if the type is a pointer type. + """ + return ffi.lib.LLVMPY_TypeIsPointer(self) + + @property + def is_array(self): + """ + Returns true if the type is an array type. + """ + return ffi.lib.LLVMPY_TypeIsArray(self) + + @property + def is_vector(self): + """ + Returns true if the type is a vector type. + """ + return ffi.lib.LLVMPY_TypeIsVector(self) + + @property + def is_function(self): + """ + Returns true if the type is a function type. + """ + return ffi.lib.LLVMPY_TypeIsFunction(self) + + @property + def is_function_vararg(self): + """ + Returns true if a function type accepts a variable number of arguments. + When the type is not a function, raises exception. + """ + if self.type_kind != TypeKind.function: + raise ValueError("Type {} is not a function".format(self)) + return ffi.lib.LLVMPY_IsFunctionVararg(self) + + @property + def elements(self): + """ + Returns iterator over enclosing types + """ + if self.is_pointer and opaque_pointers_enabled: + raise ValueError("Type {} doesn't contain elements.".format(self)) + return _TypeListIterator(ffi.lib.LLVMPY_ElementIter(self)) + + # FIXME: Remove me once typed pointers support is removed. + @property + def element_type(self): + """ + Returns the pointed-to type. When the type is not a pointer, + raises exception. + """ + if not self.is_pointer: + raise ValueError("Type {} is not a pointer".format(self)) + return TypeRef(ffi.lib.LLVMPY_GetElementType(self)) + + @property + def element_count(self): + """ + Returns the number of elements in an array or a vector. For scalable + vectors, returns minimum number of elements. When the type is neither + an array nor a vector, raises exception. + """ + if not self.is_array and not self.is_vector: + raise ValueError("Type {} is not an array nor vector".format(self)) + return ffi.lib.LLVMPY_GetTypeElementCount(self) + + @property + def type_width(self): + """ + Return the basic size of this type if it is a primitive type. These are + fixed by LLVM and are not target-dependent. + This will return zero if the type does not have a size or is not a + primitive type. + + If this is a scalable vector type, the scalable property will be set and + the runtime size will be a positive integer multiple of the base size. + + Note that this may not reflect the size of memory allocated for an + instance of the type or the number of bytes that are written when an + instance of the type is stored to memory. + """ + return ffi.lib.LLVMPY_GetTypeBitWidth(self) + + @property + def type_kind(self): + """ + Returns the LLVMTypeKind enumeration of this type. + """ + return TypeKind(ffi.lib.LLVMPY_GetTypeKind(self)) + + @property + def is_packed_struct(self): + return ffi.lib.LLVMPY_IsPackedStruct(self) + + @property + def is_literal_struct(self): + return ffi.lib.LLVMPY_IsLiteralStruct(self) + + @property + def is_opaque_struct(self): + return ffi.lib.LLVMPY_IsOpaqueStruct(self) + + def get_function_parameters(self) -> tuple["TypeRef"]: + nparams = ffi.lib.LLVMPY_CountParamTypes(self) + if nparams > 0: + out_buffer = (ffi.LLVMTypeRef * nparams)(None) + ffi.lib.LLVMPY_GetParamTypes(self, out_buffer) + return tuple(map(TypeRef, out_buffer)) + else: + return () + + def get_function_return(self) -> "TypeRef": + return TypeRef(ffi.lib.LLVMPY_GetReturnType(self)) + + def as_ir(self, ir_ctx: ir.Context) -> ir.Type: + """Convert into a ``llvmlite.ir.Type``. + """ + try: + cls = _TypeKindToIRType[self.type_kind] + except KeyError: + msg = f"as_ir() unsupported for TypeRef of {self.type_kind}" + raise TypeError(msg) + else: + return cls.from_llvm(self, ir_ctx) + + def __str__(self): + return ffi.ret_string(ffi.lib.LLVMPY_PrintType(self)) + + +class _TypeIterator(ffi.ObjectRef): + + def __next__(self): + vp = self._next() + if vp: + return TypeRef(vp) + else: + raise StopIteration + + next = __next__ + + def __iter__(self): + return self + + +class _TypeListIterator(_TypeIterator): + + def _dispose(self): + self._capi.LLVMPY_DisposeElementIter(self) + + def _next(self): + return ffi.lib.LLVMPY_ElementIterNext(self) + + +# FFI + +ffi.lib.LLVMPY_PrintType.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_PrintType.restype = c_void_p + +# FIXME: Remove me once typed pointers support is removed. +ffi.lib.LLVMPY_GetElementType.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_GetElementType.restype = ffi.LLVMTypeRef + +ffi.lib.LLVMPY_TypeIsPointer.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_TypeIsPointer.restype = c_bool + +ffi.lib.LLVMPY_TypeIsArray.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_TypeIsArray.restype = c_bool + +ffi.lib.LLVMPY_TypeIsVector.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_TypeIsVector.restype = c_bool + +ffi.lib.LLVMPY_TypeIsStruct.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_TypeIsStruct.restype = c_bool + +ffi.lib.LLVMPY_TypeIsFunction.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_TypeIsFunction.restype = c_bool + +ffi.lib.LLVMPY_IsPackedStruct.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_IsPackedStruct.restype = c_bool + +ffi.lib.LLVMPY_IsOpaqueStruct.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_IsOpaqueStruct.restype = c_bool + +ffi.lib.LLVMPY_IsLiteralStruct.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_IsLiteralStruct.restype = c_bool + +ffi.lib.LLVMPY_GetReturnType.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_GetReturnType.restype = ffi.LLVMTypeRef + +ffi.lib.LLVMPY_CountParamTypes.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_CountParamTypes.restype = c_uint + +ffi.lib.LLVMPY_GetParamTypes.argtypes = [ffi.LLVMTypeRef, + POINTER(ffi.LLVMTypeRef)] +ffi.lib.LLVMPY_GetParamTypes.restype = None + +ffi.lib.LLVMPY_IsFunctionVararg.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_IsFunctionVararg.restype = c_bool + +ffi.lib.LLVMPY_GetTypeKind.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_GetTypeKind.restype = c_int + +ffi.lib.LLVMPY_GetTypeElementCount.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_GetTypeElementCount.restype = c_int + +ffi.lib.LLVMPY_GetTypeBitWidth.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_GetTypeBitWidth.restype = c_uint64 + +ffi.lib.LLVMPY_ElementIter.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_ElementIter.restype = ffi.LLVMElementIterator + +ffi.lib.LLVMPY_ElementIterNext.argtypes = [ffi.LLVMElementIterator] +ffi.lib.LLVMPY_ElementIterNext.restype = ffi.LLVMTypeRef + +ffi.lib.LLVMPY_DisposeElementIter.argtypes = [ffi.LLVMElementIterator] diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/value.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/value.py new file mode 100644 index 0000000000000000000000000000000000000000..611daa2393df8234186baa38814681e6e068d7b1 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/binding/value.py @@ -0,0 +1,632 @@ +from ctypes import (POINTER, byref, cast, c_char_p, c_double, c_int, c_size_t, + c_uint, c_uint64, c_bool, c_void_p) +import enum + +from llvmlite.binding import ffi +from llvmlite.binding.common import _decode_string, _encode_string +from llvmlite.binding.typeref import TypeRef + + +class Linkage(enum.IntEnum): + # The LLVMLinkage enum from llvm-c/Core.h + + external = 0 + available_externally = 1 + linkonce_any = 2 + linkonce_odr = 3 + linkonce_odr_autohide = 4 + weak_any = 5 + weak_odr = 6 + appending = 7 + internal = 8 + private = 9 + dllimport = 10 + dllexport = 11 + external_weak = 12 + ghost = 13 + common = 14 + linker_private = 15 + linker_private_weak = 16 + + +class Visibility(enum.IntEnum): + # The LLVMVisibility enum from llvm-c/Core.h + + default = 0 + hidden = 1 + protected = 2 + + +class StorageClass(enum.IntEnum): + # The LLVMDLLStorageClass enum from llvm-c/Core.h + + default = 0 + dllimport = 1 + dllexport = 2 + + +class ValueKind(enum.IntEnum): + # The LLVMValueKind enum from llvm-c/Core.h + + argument = 0 + basic_block = 1 + memory_use = 2 + memory_def = 3 + memory_phi = 4 + + function = 5 + global_alias = 6 + global_ifunc = 7 + global_variable = 8 + block_address = 9 + constant_expr = 10 + constant_array = 11 + constant_struct = 12 + constant_vector = 13 + + undef_value = 14 + constant_aggregate_zero = 15 + constant_data_array = 16 + constant_data_vector = 17 + constant_int = 18 + constant_fp = 19 + constant_pointer_null = 20 + constant_token_none = 21 + + metadata_as_value = 22 + inline_asm = 23 + + instruction = 24 + poison_value = 25 + + +class ValueRef(ffi.ObjectRef): + """A weak reference to a LLVM value. + """ + + def __init__(self, ptr, kind, parents): + self._kind = kind + self._parents = parents + ffi.ObjectRef.__init__(self, ptr) + + def __str__(self): + with ffi.OutputString() as outstr: + ffi.lib.LLVMPY_PrintValueToString(self, outstr) + return str(outstr) + + @property + def module(self): + """ + The module this function or global variable value was obtained from. + """ + return self._parents.get('module') + + @property + def function(self): + """ + The function this argument or basic block value was obtained from. + """ + return self._parents.get('function') + + @property + def block(self): + """ + The block this instruction value was obtained from. + """ + return self._parents.get('block') + + @property + def instruction(self): + """ + The instruction this operand value was obtained from. + """ + return self._parents.get('instruction') + + @property + def is_global(self): + return self._kind == 'global' + + @property + def is_function(self): + return self._kind == 'function' + + @property + def is_block(self): + return self._kind == 'block' + + @property + def is_argument(self): + return self._kind == 'argument' + + @property + def is_instruction(self): + return self._kind == 'instruction' + + @property + def is_operand(self): + return self._kind == 'operand' + + @property + def is_constant(self): + return bool(ffi.lib.LLVMPY_IsConstant(self)) + + @property + def value_kind(self): + return ValueKind(ffi.lib.LLVMPY_GetValueKind(self)) + + @property + def name(self): + return _decode_string(ffi.lib.LLVMPY_GetValueName(self)) + + @name.setter + def name(self, val): + ffi.lib.LLVMPY_SetValueName(self, _encode_string(val)) + + @property + def linkage(self): + return Linkage(ffi.lib.LLVMPY_GetLinkage(self)) + + @linkage.setter + def linkage(self, value): + if not isinstance(value, Linkage): + value = Linkage[value] + ffi.lib.LLVMPY_SetLinkage(self, value) + + @property + def visibility(self): + return Visibility(ffi.lib.LLVMPY_GetVisibility(self)) + + @visibility.setter + def visibility(self, value): + if not isinstance(value, Visibility): + value = Visibility[value] + ffi.lib.LLVMPY_SetVisibility(self, value) + + @property + def storage_class(self): + return StorageClass(ffi.lib.LLVMPY_GetDLLStorageClass(self)) + + @storage_class.setter + def storage_class(self, value): + if not isinstance(value, StorageClass): + value = StorageClass[value] + ffi.lib.LLVMPY_SetDLLStorageClass(self, value) + + def add_function_attribute(self, attr): + """Only works on function value + + Parameters + ----------- + attr : str + attribute name + """ + if not self.is_function: + raise ValueError('expected function value, got %s' % (self._kind,)) + attrname = str(attr) + attrval = ffi.lib.LLVMPY_GetEnumAttributeKindForName( + _encode_string(attrname), len(attrname)) + if attrval == 0: + raise ValueError('no such attribute {!r}'.format(attrname)) + ffi.lib.LLVMPY_AddFunctionAttr(self, attrval) + + @property + def type(self): + """ + This value's LLVM type. + """ + # XXX what does this return? + return TypeRef(ffi.lib.LLVMPY_TypeOf(self)) + + @property + def global_value_type(self): + """ + Uses ``LLVMGlobalGetValueType()``. + Needed for opaque pointers in globals. + > For globals, use getValueType(). + See https://llvm.org/docs/OpaquePointers.html#migration-instructions + """ + assert self.is_global or self.is_function + return TypeRef(ffi.lib.LLVMPY_GlobalGetValueType(self)) + + @property + def is_declaration(self): + """ + Whether this value (presumably global) is defined in the current + module. + """ + if not (self.is_global or self.is_function): + raise ValueError('expected global or function value, got %s' + % (self._kind,)) + return ffi.lib.LLVMPY_IsDeclaration(self) + + @property + def attributes(self): + """ + Return an iterator over this value's attributes. + The iterator will yield a string for each attribute. + """ + itr = iter(()) + if self.is_function: + it = ffi.lib.LLVMPY_FunctionAttributesIter(self) + itr = _AttributeListIterator(it) + elif self.is_instruction: + if self.opcode == 'call': + it = ffi.lib.LLVMPY_CallInstAttributesIter(self) + itr = _AttributeListIterator(it) + elif self.opcode == 'invoke': + it = ffi.lib.LLVMPY_InvokeInstAttributesIter(self) + itr = _AttributeListIterator(it) + elif self.is_global: + it = ffi.lib.LLVMPY_GlobalAttributesIter(self) + itr = _AttributeSetIterator(it) + elif self.is_argument: + it = ffi.lib.LLVMPY_ArgumentAttributesIter(self) + itr = _AttributeSetIterator(it) + return itr + + @property + def blocks(self): + """ + Return an iterator over this function's blocks. + The iterator will yield a ValueRef for each block. + """ + if not self.is_function: + raise ValueError('expected function value, got %s' % (self._kind,)) + it = ffi.lib.LLVMPY_FunctionBlocksIter(self) + parents = self._parents.copy() + parents.update(function=self) + return _BlocksIterator(it, parents) + + @property + def arguments(self): + """ + Return an iterator over this function's arguments. + The iterator will yield a ValueRef for each argument. + """ + if not self.is_function: + raise ValueError('expected function value, got %s' % (self._kind,)) + it = ffi.lib.LLVMPY_FunctionArgumentsIter(self) + parents = self._parents.copy() + parents.update(function=self) + return _ArgumentsIterator(it, parents) + + @property + def instructions(self): + """ + Return an iterator over this block's instructions. + The iterator will yield a ValueRef for each instruction. + """ + if not self.is_block: + raise ValueError('expected block value, got %s' % (self._kind,)) + it = ffi.lib.LLVMPY_BlockInstructionsIter(self) + parents = self._parents.copy() + parents.update(block=self) + return _InstructionsIterator(it, parents) + + @property + def operands(self): + """ + Return an iterator over this instruction's operands. + The iterator will yield a ValueRef for each operand. + """ + if not self.is_instruction: + raise ValueError('expected instruction value, got %s' + % (self._kind,)) + it = ffi.lib.LLVMPY_InstructionOperandsIter(self) + parents = self._parents.copy() + parents.update(instruction=self) + return _OperandsIterator(it, parents) + + @property + def opcode(self): + if not self.is_instruction: + raise ValueError('expected instruction value, got %s' + % (self._kind,)) + return ffi.ret_string(ffi.lib.LLVMPY_GetOpcodeName(self)) + + @property + def incoming_blocks(self): + """ + Return an iterator over this phi instruction's incoming blocks. + The iterator will yield a ValueRef for each block. + """ + if not self.is_instruction or self.opcode != 'phi': + raise ValueError('expected phi instruction value, got %s' + % (self._kind,)) + it = ffi.lib.LLVMPY_PhiIncomingBlocksIter(self) + parents = self._parents.copy() + parents.update(instruction=self) + return _IncomingBlocksIterator(it, parents) + + def get_constant_value(self, signed_int=False, round_fp=False): + """ + Return the constant value, either as a literal (when supported) + or as a string. + + Parameters + ----------- + signed_int : bool + if True and the constant is an integer, returns a signed version + round_fp : bool + if True and the constant is a floating point value, rounds the + result upon accuracy loss (e.g., when querying an fp128 value). + By default, raises an exception on accuracy loss + """ + if not self.is_constant: + raise ValueError('expected constant value, got %s' + % (self._kind,)) + + if self.value_kind == ValueKind.constant_int: + # Python integers are also arbitrary-precision + little_endian = c_bool(False) + words = ffi.lib.LLVMPY_GetConstantIntNumWords(self) + ptr = ffi.lib.LLVMPY_GetConstantIntRawValue( + self, byref(little_endian)) + asbytes = bytes(cast(ptr, POINTER(c_uint64 * words)).contents) + return int.from_bytes( + asbytes, + ('little' if little_endian.value else 'big'), + signed=signed_int, + ) + elif self.value_kind == ValueKind.constant_fp: + # Convert floating-point values to double-precision (Python float) + accuracy_loss = c_bool(False) + value = ffi.lib.LLVMPY_GetConstantFPValue(self, + byref(accuracy_loss)) + if accuracy_loss.value and not round_fp: + raise ValueError( + 'Accuracy loss encountered in conversion of constant ' + f'value {str(self)}') + + return value + + # Otherwise, return the IR string + return str(self) + + +class _ValueIterator(ffi.ObjectRef): + + kind = None # derived classes must specify the Value kind value + # as class attribute + + def __init__(self, ptr, parents): + ffi.ObjectRef.__init__(self, ptr) + # Keep parent objects (module, function, etc) alive + self._parents = parents + if self.kind is None: + raise NotImplementedError('%s must specify kind attribute' + % (type(self).__name__,)) + + def __next__(self): + vp = self._next() + if vp: + return ValueRef(vp, self.kind, self._parents) + else: + raise StopIteration + + next = __next__ + + def __iter__(self): + return self + + +class _AttributeIterator(ffi.ObjectRef): + + def __next__(self): + vp = self._next() + if vp: + return vp + else: + raise StopIteration + + next = __next__ + + def __iter__(self): + return self + + +class _AttributeListIterator(_AttributeIterator): + + def _dispose(self): + self._capi.LLVMPY_DisposeAttributeListIter(self) + + def _next(self): + return ffi.ret_bytes(ffi.lib.LLVMPY_AttributeListIterNext(self)) + + +class _AttributeSetIterator(_AttributeIterator): + + def _dispose(self): + self._capi.LLVMPY_DisposeAttributeSetIter(self) + + def _next(self): + return ffi.ret_bytes(ffi.lib.LLVMPY_AttributeSetIterNext(self)) + + +class _BlocksIterator(_ValueIterator): + + kind = 'block' + + def _dispose(self): + self._capi.LLVMPY_DisposeBlocksIter(self) + + def _next(self): + return ffi.lib.LLVMPY_BlocksIterNext(self) + + +class _ArgumentsIterator(_ValueIterator): + + kind = 'argument' + + def _dispose(self): + self._capi.LLVMPY_DisposeArgumentsIter(self) + + def _next(self): + return ffi.lib.LLVMPY_ArgumentsIterNext(self) + + +class _InstructionsIterator(_ValueIterator): + + kind = 'instruction' + + def _dispose(self): + self._capi.LLVMPY_DisposeInstructionsIter(self) + + def _next(self): + return ffi.lib.LLVMPY_InstructionsIterNext(self) + + +class _OperandsIterator(_ValueIterator): + + kind = 'operand' + + def _dispose(self): + self._capi.LLVMPY_DisposeOperandsIter(self) + + def _next(self): + return ffi.lib.LLVMPY_OperandsIterNext(self) + + +class _IncomingBlocksIterator(_ValueIterator): + + kind = 'block' + + def _dispose(self): + self._capi.LLVMPY_DisposeIncomingBlocksIter(self) + + def _next(self): + return ffi.lib.LLVMPY_IncomingBlocksIterNext(self) + + +# FFI + +ffi.lib.LLVMPY_PrintValueToString.argtypes = [ + ffi.LLVMValueRef, + POINTER(c_char_p) +] + +ffi.lib.LLVMPY_GetGlobalParent.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GetGlobalParent.restype = ffi.LLVMModuleRef + +ffi.lib.LLVMPY_GetValueName.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GetValueName.restype = c_char_p + +ffi.lib.LLVMPY_SetValueName.argtypes = [ffi.LLVMValueRef, c_char_p] + +ffi.lib.LLVMPY_TypeOf.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_TypeOf.restype = ffi.LLVMTypeRef + +ffi.lib.LLVMPY_GlobalGetValueType.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GlobalGetValueType.restype = ffi.LLVMTypeRef + +ffi.lib.LLVMPY_GetTypeName.argtypes = [ffi.LLVMTypeRef] +ffi.lib.LLVMPY_GetTypeName.restype = c_void_p + +ffi.lib.LLVMPY_GetLinkage.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GetLinkage.restype = c_int + +ffi.lib.LLVMPY_SetLinkage.argtypes = [ffi.LLVMValueRef, c_int] + +ffi.lib.LLVMPY_GetVisibility.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GetVisibility.restype = c_int + +ffi.lib.LLVMPY_SetVisibility.argtypes = [ffi.LLVMValueRef, c_int] + +ffi.lib.LLVMPY_GetDLLStorageClass.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GetDLLStorageClass.restype = c_int + +ffi.lib.LLVMPY_SetDLLStorageClass.argtypes = [ffi.LLVMValueRef, c_int] + +ffi.lib.LLVMPY_GetEnumAttributeKindForName.argtypes = [c_char_p, c_size_t] +ffi.lib.LLVMPY_GetEnumAttributeKindForName.restype = c_uint + +ffi.lib.LLVMPY_AddFunctionAttr.argtypes = [ffi.LLVMValueRef, c_uint] + +ffi.lib.LLVMPY_IsDeclaration.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_IsDeclaration.restype = c_int + +ffi.lib.LLVMPY_FunctionAttributesIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_FunctionAttributesIter.restype = ffi.LLVMAttributeListIterator + +ffi.lib.LLVMPY_CallInstAttributesIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_CallInstAttributesIter.restype = ffi.LLVMAttributeListIterator + +ffi.lib.LLVMPY_InvokeInstAttributesIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_InvokeInstAttributesIter.restype = ffi.LLVMAttributeListIterator + +ffi.lib.LLVMPY_GlobalAttributesIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GlobalAttributesIter.restype = ffi.LLVMAttributeSetIterator + +ffi.lib.LLVMPY_ArgumentAttributesIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_ArgumentAttributesIter.restype = ffi.LLVMAttributeSetIterator + +ffi.lib.LLVMPY_FunctionBlocksIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_FunctionBlocksIter.restype = ffi.LLVMBlocksIterator + +ffi.lib.LLVMPY_FunctionArgumentsIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_FunctionArgumentsIter.restype = ffi.LLVMArgumentsIterator + +ffi.lib.LLVMPY_BlockInstructionsIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_BlockInstructionsIter.restype = ffi.LLVMInstructionsIterator + +ffi.lib.LLVMPY_InstructionOperandsIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_InstructionOperandsIter.restype = ffi.LLVMOperandsIterator + +ffi.lib.LLVMPY_PhiIncomingBlocksIter.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_PhiIncomingBlocksIter.restype = ffi.LLVMIncomingBlocksIterator + +ffi.lib.LLVMPY_DisposeAttributeListIter.argtypes = [ + ffi.LLVMAttributeListIterator] + +ffi.lib.LLVMPY_DisposeAttributeSetIter.argtypes = [ffi.LLVMAttributeSetIterator] + +ffi.lib.LLVMPY_DisposeBlocksIter.argtypes = [ffi.LLVMBlocksIterator] + +ffi.lib.LLVMPY_DisposeInstructionsIter.argtypes = [ffi.LLVMInstructionsIterator] + +ffi.lib.LLVMPY_DisposeOperandsIter.argtypes = [ffi.LLVMOperandsIterator] + +ffi.lib.LLVMPY_DisposeIncomingBlocksIter.argtypes = [ + ffi.LLVMIncomingBlocksIterator] + +ffi.lib.LLVMPY_AttributeListIterNext.argtypes = [ffi.LLVMAttributeListIterator] +ffi.lib.LLVMPY_AttributeListIterNext.restype = c_void_p + +ffi.lib.LLVMPY_AttributeSetIterNext.argtypes = [ffi.LLVMAttributeSetIterator] +ffi.lib.LLVMPY_AttributeSetIterNext.restype = c_void_p + +ffi.lib.LLVMPY_BlocksIterNext.argtypes = [ffi.LLVMBlocksIterator] +ffi.lib.LLVMPY_BlocksIterNext.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_ArgumentsIterNext.argtypes = [ffi.LLVMArgumentsIterator] +ffi.lib.LLVMPY_ArgumentsIterNext.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_InstructionsIterNext.argtypes = [ffi.LLVMInstructionsIterator] +ffi.lib.LLVMPY_InstructionsIterNext.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_OperandsIterNext.argtypes = [ffi.LLVMOperandsIterator] +ffi.lib.LLVMPY_OperandsIterNext.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_IncomingBlocksIterNext.argtypes = [ + ffi.LLVMIncomingBlocksIterator] +ffi.lib.LLVMPY_IncomingBlocksIterNext.restype = ffi.LLVMValueRef + +ffi.lib.LLVMPY_GetOpcodeName.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GetOpcodeName.restype = c_void_p + +ffi.lib.LLVMPY_IsConstant.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_IsConstant.restype = c_bool + +ffi.lib.LLVMPY_GetValueKind.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GetValueKind.restype = c_int + +ffi.lib.LLVMPY_GetConstantIntRawValue.argtypes = [ffi.LLVMValueRef, + POINTER(c_bool)] +ffi.lib.LLVMPY_GetConstantIntRawValue.restype = POINTER(c_uint64) + +ffi.lib.LLVMPY_GetConstantIntNumWords.argtypes = [ffi.LLVMValueRef] +ffi.lib.LLVMPY_GetConstantIntNumWords.restype = c_uint + +ffi.lib.LLVMPY_GetConstantFPValue.argtypes = [ffi.LLVMValueRef, + POINTER(c_bool)] +ffi.lib.LLVMPY_GetConstantFPValue.restype = c_double diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__init__.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..b7a0737b2d5325d5c40a8953520a260c013ed48f --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__init__.py @@ -0,0 +1,11 @@ +""" +This subpackage implements the LLVM IR classes in pure python +""" + +from .types import * +from .values import * +from .module import * +from .builder import * +from .instructions import * +from .transforms import * +from .context import Context, global_context diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..6cbf4435dd43e7b77d11e0ad929d196ba9446171 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/_utils.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/_utils.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..16a7416ae7e447dfbec6fc23689edf14bd2a5779 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/_utils.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/builder.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/builder.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..45a9d2b6ec905f4a6e9b775de75219436ae77632 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/builder.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/context.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/context.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..a6d7bd483e009e5f00824258905d783f7f683d9f Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/context.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/instructions.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/instructions.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..1de5600513088e80fcd288fe5efc3b7f26002382 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/instructions.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/module.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/module.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..07157952e8863f594ba09eb3aa537973572ccc42 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/module.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/transforms.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/transforms.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..e864b81d3bd9944e519a75f9d64e48d3aa359246 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/transforms.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/types.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/types.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..2ab804d0cd381e90fc09d11a746da7383165763b Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/types.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/values.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/values.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..ddc54c3d52d824b08076942ba1dbb3c3dbf0a5a7 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/__pycache__/values.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/_utils.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/_utils.py new file mode 100644 index 0000000000000000000000000000000000000000..8287d77afb84f750be00ef0b001a175507c59da4 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/_utils.py @@ -0,0 +1,80 @@ +from collections import defaultdict + + +class DuplicatedNameError(NameError): + pass + + +class NameScope(object): + def __init__(self): + self._useset = set(['']) + self._basenamemap = defaultdict(int) + + def is_used(self, name): + return name in self._useset + + def register(self, name, deduplicate=False): + if deduplicate: + name = self.deduplicate(name) + elif self.is_used(name): + raise DuplicatedNameError(name) + self._useset.add(name) + return name + + def deduplicate(self, name): + basename = name + while self.is_used(name): + ident = self._basenamemap[basename] + 1 + self._basenamemap[basename] = ident + name = "{0}.{1}".format(basename, ident) + return name + + def get_child(self): + return type(self)(parent=self) + + +class _StrCaching(object): + + def _clear_string_cache(self): + try: + del self.__cached_str + except AttributeError: + pass + + def __str__(self): + try: + return self.__cached_str + except AttributeError: + s = self.__cached_str = self._to_string() + return s + + +class _StringReferenceCaching(object): + + def get_reference(self): + try: + return self.__cached_refstr + except AttributeError: + s = self.__cached_refstr = self._get_reference() + return s + + +class _HasMetadata(object): + + def set_metadata(self, name, node): + """ + Attach unnamed metadata *node* to the metadata slot *name* of this + value. + """ + self.metadata[name] = node + + def _stringify_metadata(self, leading_comma=False): + if self.metadata: + buf = [] + if leading_comma: + buf.append("") + buf += ["!{0} {1}".format(k, v.get_reference()) + for k, v in self.metadata.items()] + return ', '.join(buf) + else: + return '' diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/builder.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/builder.py new file mode 100644 index 0000000000000000000000000000000000000000..5a1ecf74deb39d6ee92a4cba899702241c6b44cc --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/builder.py @@ -0,0 +1,1120 @@ +import contextlib +import functools + +from llvmlite.ir import instructions, types, values + +_CMP_MAP = { + '>': 'gt', + '<': 'lt', + '==': 'eq', + '!=': 'ne', + '>=': 'ge', + '<=': 'le', +} + + +def _unop(opname, cls=instructions.Instruction): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, arg, name='', flags=()): + instr = cls(self.block, arg.type, opname, [arg], name, flags) + self._insert(instr) + return instr + + return wrapped + + return wrap + + +def _binop(opname, cls=instructions.Instruction): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, lhs, rhs, name='', flags=()): + if lhs.type != rhs.type: + raise ValueError("Operands must be the same type, got (%s, %s)" + % (lhs.type, rhs.type)) + instr = cls(self.block, lhs.type, opname, (lhs, rhs), name, flags) + self._insert(instr) + return instr + + return wrapped + + return wrap + + +def _binop_with_overflow(opname, cls=instructions.Instruction): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, lhs, rhs, name=''): + if lhs.type != rhs.type: + raise ValueError("Operands must be the same type, got (%s, %s)" + % (lhs.type, rhs.type)) + ty = lhs.type + if not isinstance(ty, types.IntType): + raise TypeError("expected an integer type, got %s" % (ty,)) + bool_ty = types.IntType(1) + + mod = self.module + fnty = types.FunctionType(types.LiteralStructType([ty, bool_ty]), + [ty, ty]) + fn = mod.declare_intrinsic("llvm.%s.with.overflow" % (opname,), + [ty], fnty) + ret = self.call(fn, [lhs, rhs], name=name) + return ret + + return wrapped + + return wrap + + +def _uniop(opname, cls=instructions.Instruction): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, operand, name=''): + instr = cls(self.block, operand.type, opname, [operand], name) + self._insert(instr) + return instr + + return wrapped + + return wrap + + +def _uniop_intrinsic_int(opname): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, operand, name=''): + if not isinstance(operand.type, types.IntType): + raise TypeError( + "expected an integer type, got %s" % + operand.type) + fn = self.module.declare_intrinsic(opname, [operand.type]) + return self.call(fn, [operand], name) + + return wrapped + + return wrap + + +def _uniop_intrinsic_float(opname): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, operand, name=''): + if not isinstance( + operand.type, (types.FloatType, types.DoubleType)): + raise TypeError("expected a float type, got %s" % operand.type) + fn = self.module.declare_intrinsic(opname, [operand.type]) + return self.call(fn, [operand], name) + + return wrapped + + return wrap + + +def _uniop_intrinsic_with_flag(opname): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, operand, flag, name=''): + if not isinstance(operand.type, types.IntType): + raise TypeError( + "expected an integer type, got %s" % + operand.type) + if not (isinstance(flag.type, types.IntType) and + flag.type.width == 1): + raise TypeError("expected an i1 type, got %s" % flag.type) + fn = self.module.declare_intrinsic( + opname, [operand.type, flag.type]) + return self.call(fn, [operand, flag], name) + + return wrapped + + return wrap + + +def _triop_intrinsic(opname): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, a, b, c, name=''): + if a.type != b.type or b.type != c.type: + raise TypeError( + "expected types to be the same, got %s, %s, %s" % ( + a.type, + b.type, + c.type)) + elif not isinstance( + a.type, + (types.HalfType, types.FloatType, types.DoubleType)): + raise TypeError( + "expected an floating point type, got %s" % + a.type) + fn = self.module.declare_intrinsic(opname, [a.type, b.type, c.type]) + return self.call(fn, [a, b, c], name) + + return wrapped + + return wrap + + +def _castop(opname, cls=instructions.CastInstr): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, val, typ, name=''): + if val.type == typ: + return val + instr = cls(self.block, opname, val, typ, name) + self._insert(instr) + return instr + + return wrapped + + return wrap + + +def _label_suffix(label, suffix): + """Returns (label + suffix) or a truncated version if it's too long. + Parameters + ---------- + label : str + Label name + suffix : str + Label suffix + """ + if len(label) > 50: + nhead = 25 + return ''.join([label[:nhead], '..', suffix]) + else: + return label + suffix + + +class IRBuilder(object): + def __init__(self, block=None): + self._block = block + self._anchor = len(block.instructions) if block else 0 + self.debug_metadata = None + + @property + def block(self): + """ + The current basic block. + """ + return self._block + + basic_block = block + + @property + def function(self): + """ + The current function. + """ + return self.block.parent + + @property + def module(self): + """ + The current module. + """ + return self.block.parent.module + + def position_before(self, instr): + """ + Position immediately before the given instruction. The current block + is also changed to the instruction's basic block. + """ + self._block = instr.parent + self._anchor = self._block.instructions.index(instr) + + def position_after(self, instr): + """ + Position immediately after the given instruction. The current block + is also changed to the instruction's basic block. + """ + self._block = instr.parent + self._anchor = self._block.instructions.index(instr) + 1 + + def position_at_start(self, block): + """ + Position at the start of the basic *block*. + """ + self._block = block + self._anchor = 0 + + def position_at_end(self, block): + """ + Position at the end of the basic *block*. + """ + self._block = block + self._anchor = len(block.instructions) + + def append_basic_block(self, name=''): + """ + Append a basic block, with the given optional *name*, to the current + function. The current block is not changed. The new block is returned. + """ + return self.function.append_basic_block(name) + + def remove(self, instr): + """Remove the given instruction.""" + idx = self._block.instructions.index(instr) + del self._block.instructions[idx] + if self._block.terminator == instr: + self._block.terminator = None + if self._anchor > idx: + self._anchor -= 1 + + @contextlib.contextmanager + def goto_block(self, block): + """ + A context manager which temporarily positions the builder at the end + of basic block *bb* (but before any terminator). + """ + old_block = self.basic_block + term = block.terminator + if term is not None: + self.position_before(term) + else: + self.position_at_end(block) + try: + yield + finally: + self.position_at_end(old_block) + + @contextlib.contextmanager + def goto_entry_block(self): + """ + A context manager which temporarily positions the builder at the + end of the function's entry block. + """ + with self.goto_block(self.function.entry_basic_block): + yield + + @contextlib.contextmanager + def _branch_helper(self, bbenter, bbexit): + self.position_at_end(bbenter) + yield bbexit + if self.basic_block.terminator is None: + self.branch(bbexit) + + @contextlib.contextmanager + def if_then(self, pred, likely=None): + """ + A context manager which sets up a conditional basic block based + on the given predicate (a i1 value). If the conditional block + is not explicitly terminated, a branch will be added to the next + block. + If *likely* is given, its boolean value indicates whether the + predicate is likely to be true or not, and metadata is issued + for LLVM's optimizers to account for that. + """ + bb = self.basic_block + bbif = self.append_basic_block(name=_label_suffix(bb.name, '.if')) + bbend = self.append_basic_block(name=_label_suffix(bb.name, '.endif')) + br = self.cbranch(pred, bbif, bbend) + if likely is not None: + br.set_weights([99, 1] if likely else [1, 99]) + + with self._branch_helper(bbif, bbend): + yield bbend + + self.position_at_end(bbend) + + @contextlib.contextmanager + def if_else(self, pred, likely=None): + """ + A context manager which sets up two conditional basic blocks based + on the given predicate (a i1 value). + A tuple of context managers is yield'ed. Each context manager + acts as a if_then() block. + *likely* has the same meaning as in if_then(). + + Typical use:: + with builder.if_else(pred) as (then, otherwise): + with then: + # emit instructions for when the predicate is true + with otherwise: + # emit instructions for when the predicate is false + """ + bb = self.basic_block + bbif = self.append_basic_block(name=_label_suffix(bb.name, '.if')) + bbelse = self.append_basic_block(name=_label_suffix(bb.name, '.else')) + bbend = self.append_basic_block(name=_label_suffix(bb.name, '.endif')) + br = self.cbranch(pred, bbif, bbelse) + if likely is not None: + br.set_weights([99, 1] if likely else [1, 99]) + + then = self._branch_helper(bbif, bbend) + otherwise = self._branch_helper(bbelse, bbend) + + yield then, otherwise + + self.position_at_end(bbend) + + def _insert(self, instr): + if self.debug_metadata is not None and 'dbg' not in instr.metadata: + instr.metadata['dbg'] = self.debug_metadata + self._block.instructions.insert(self._anchor, instr) + self._anchor += 1 + + def _set_terminator(self, term): + assert not self.block.is_terminated + self._insert(term) + self.block.terminator = term + return term + + # + # Arithmetic APIs + # + + @_binop('shl') + def shl(self, lhs, rhs, name=''): + """ + Left integer shift: + name = lhs << rhs + """ + + @_binop('lshr') + def lshr(self, lhs, rhs, name=''): + """ + Logical (unsigned) right integer shift: + name = lhs >> rhs + """ + + @_binop('ashr') + def ashr(self, lhs, rhs, name=''): + """ + Arithmetic (signed) right integer shift: + name = lhs >> rhs + """ + + @_binop('add') + def add(self, lhs, rhs, name=''): + """ + Integer addition: + name = lhs + rhs + """ + + @_binop('fadd') + def fadd(self, lhs, rhs, name=''): + """ + Floating-point addition: + name = lhs + rhs + """ + + @_binop('sub') + def sub(self, lhs, rhs, name=''): + """ + Integer subtraction: + name = lhs - rhs + """ + + @_binop('fsub') + def fsub(self, lhs, rhs, name=''): + """ + Floating-point subtraction: + name = lhs - rhs + """ + + @_binop('mul') + def mul(self, lhs, rhs, name=''): + """ + Integer multiplication: + name = lhs * rhs + """ + + @_binop('fmul') + def fmul(self, lhs, rhs, name=''): + """ + Floating-point multiplication: + name = lhs * rhs + """ + + @_binop('udiv') + def udiv(self, lhs, rhs, name=''): + """ + Unsigned integer division: + name = lhs / rhs + """ + + @_binop('sdiv') + def sdiv(self, lhs, rhs, name=''): + """ + Signed integer division: + name = lhs / rhs + """ + + @_binop('fdiv') + def fdiv(self, lhs, rhs, name=''): + """ + Floating-point division: + name = lhs / rhs + """ + + @_binop('urem') + def urem(self, lhs, rhs, name=''): + """ + Unsigned integer remainder: + name = lhs % rhs + """ + + @_binop('srem') + def srem(self, lhs, rhs, name=''): + """ + Signed integer remainder: + name = lhs % rhs + """ + + @_binop('frem') + def frem(self, lhs, rhs, name=''): + """ + Floating-point remainder: + name = lhs % rhs + """ + + @_binop('or') + def or_(self, lhs, rhs, name=''): + """ + Bitwise integer OR: + name = lhs | rhs + """ + + @_binop('and') + def and_(self, lhs, rhs, name=''): + """ + Bitwise integer AND: + name = lhs & rhs + """ + + @_binop('xor') + def xor(self, lhs, rhs, name=''): + """ + Bitwise integer XOR: + name = lhs ^ rhs + """ + + @_binop_with_overflow('sadd') + def sadd_with_overflow(self, lhs, rhs, name=''): + """ + Signed integer addition with overflow: + name = {result, overflow bit} = lhs + rhs + """ + + @_binop_with_overflow('smul') + def smul_with_overflow(self, lhs, rhs, name=''): + """ + Signed integer multiplication with overflow: + name = {result, overflow bit} = lhs * rhs + """ + + @_binop_with_overflow('ssub') + def ssub_with_overflow(self, lhs, rhs, name=''): + """ + Signed integer subtraction with overflow: + name = {result, overflow bit} = lhs - rhs + """ + + @_binop_with_overflow('uadd') + def uadd_with_overflow(self, lhs, rhs, name=''): + """ + Unsigned integer addition with overflow: + name = {result, overflow bit} = lhs + rhs + """ + + @_binop_with_overflow('umul') + def umul_with_overflow(self, lhs, rhs, name=''): + """ + Unsigned integer multiplication with overflow: + name = {result, overflow bit} = lhs * rhs + """ + + @_binop_with_overflow('usub') + def usub_with_overflow(self, lhs, rhs, name=''): + """ + Unsigned integer subtraction with overflow: + name = {result, overflow bit} = lhs - rhs + """ + + # + # Unary APIs + # + + def not_(self, value, name=''): + """ + Bitwise integer complement: + name = ~value + """ + if isinstance(value.type, types.VectorType): + rhs = values.Constant(value.type, (-1,) * value.type.count) + else: + rhs = values.Constant(value.type, -1) + return self.xor(value, rhs, name=name) + + def neg(self, value, name=''): + """ + Integer negative: + name = -value + """ + return self.sub(values.Constant(value.type, 0), value, name=name) + + @_unop('fneg') + def fneg(self, arg, name='', flags=()): + """ + Floating-point negative: + name = -arg + """ + + # + # Comparison APIs + # + + def _icmp(self, prefix, cmpop, lhs, rhs, name): + try: + op = _CMP_MAP[cmpop] + except KeyError: + raise ValueError("invalid comparison %r for icmp" % (cmpop,)) + if cmpop not in ('==', '!='): + op = prefix + op + instr = instructions.ICMPInstr(self.block, op, lhs, rhs, name=name) + self._insert(instr) + return instr + + def icmp_signed(self, cmpop, lhs, rhs, name=''): + """ + Signed integer comparison: + name = lhs rhs + + where cmpop can be '==', '!=', '<', '<=', '>', '>=' + """ + return self._icmp('s', cmpop, lhs, rhs, name) + + def icmp_unsigned(self, cmpop, lhs, rhs, name=''): + """ + Unsigned integer (or pointer) comparison: + name = lhs rhs + + where cmpop can be '==', '!=', '<', '<=', '>', '>=' + """ + return self._icmp('u', cmpop, lhs, rhs, name) + + def fcmp_ordered(self, cmpop, lhs, rhs, name='', flags=()): + """ + Floating-point ordered comparison: + name = lhs rhs + + where cmpop can be '==', '!=', '<', '<=', '>', '>=', 'ord', 'uno' + """ + if cmpop in _CMP_MAP: + op = 'o' + _CMP_MAP[cmpop] + else: + op = cmpop + instr = instructions.FCMPInstr( + self.block, op, lhs, rhs, name=name, flags=flags) + self._insert(instr) + return instr + + def fcmp_unordered(self, cmpop, lhs, rhs, name='', flags=()): + """ + Floating-point unordered comparison: + name = lhs rhs + + where cmpop can be '==', '!=', '<', '<=', '>', '>=', 'ord', 'uno' + """ + if cmpop in _CMP_MAP: + op = 'u' + _CMP_MAP[cmpop] + else: + op = cmpop + instr = instructions.FCMPInstr( + self.block, op, lhs, rhs, name=name, flags=flags) + self._insert(instr) + return instr + + def select(self, cond, lhs, rhs, name='', flags=()): + """ + Ternary select operator: + name = cond ? lhs : rhs + """ + instr = instructions.SelectInstr(self.block, cond, lhs, rhs, name=name, + flags=flags) + self._insert(instr) + return instr + + # + # Cast APIs + # + + @_castop('trunc') + def trunc(self, value, typ, name=''): + """ + Truncating integer downcast to a smaller type: + name = (typ) value + """ + + @_castop('zext') + def zext(self, value, typ, name=''): + """ + Zero-extending integer upcast to a larger type: + name = (typ) value + """ + + @_castop('sext') + def sext(self, value, typ, name=''): + """ + Sign-extending integer upcast to a larger type: + name = (typ) value + """ + + @_castop('fptrunc') + def fptrunc(self, value, typ, name=''): + """ + Floating-point downcast to a less precise type: + name = (typ) value + """ + + @_castop('fpext') + def fpext(self, value, typ, name=''): + """ + Floating-point upcast to a more precise type: + name = (typ) value + """ + + @_castop('bitcast') + def bitcast(self, value, typ, name=''): + """ + Pointer cast to a different pointer type: + name = (typ) value + """ + + @_castop('addrspacecast') + def addrspacecast(self, value, typ, name=''): + """ + Pointer cast to a different address space: + name = (typ) value + """ + + @_castop('fptoui') + def fptoui(self, value, typ, name=''): + """ + Convert floating-point to unsigned integer: + name = (typ) value + """ + + @_castop('uitofp') + def uitofp(self, value, typ, name=''): + """ + Convert unsigned integer to floating-point: + name = (typ) value + """ + + @_castop('fptosi') + def fptosi(self, value, typ, name=''): + """ + Convert floating-point to signed integer: + name = (typ) value + """ + + @_castop('sitofp') + def sitofp(self, value, typ, name=''): + """ + Convert signed integer to floating-point: + name = (typ) value + """ + + @_castop('ptrtoint') + def ptrtoint(self, value, typ, name=''): + """ + Cast pointer to integer: + name = (typ) value + """ + + @_castop('inttoptr') + def inttoptr(self, value, typ, name=''): + """ + Cast integer to pointer: + name = (typ) value + """ + + # + # Memory APIs + # + + def alloca(self, typ, size=None, name=''): + """ + Stack-allocate a slot for *size* elements of the given type. + (default one element) + """ + if size is None: + pass + elif isinstance(size, (values.Value, values.Constant)): + assert isinstance(size.type, types.IntType) + else: + # If it is not a Value instance, + # assume to be a Python integer. + size = values.Constant(types.IntType(32), size) + + al = instructions.AllocaInstr(self.block, typ, size, name) + self._insert(al) + return al + + def load(self, ptr, name='', align=None, typ=None): + """ + Load value from pointer, with optional guaranteed alignment: + name = *ptr + """ + if not isinstance(ptr.type, types.PointerType): + msg = "cannot load from value of type %s (%r): not a pointer" + raise TypeError(msg % (ptr.type, str(ptr))) + ld = instructions.LoadInstr(self.block, ptr, name, typ=typ) + ld.align = align + self._insert(ld) + return ld + + def store(self, value, ptr, align=None): + """ + Store value to pointer, with optional guaranteed alignment: + *ptr = name + """ + if not isinstance(ptr.type, types.PointerType): + msg = "cannot store to value of type %s (%r): not a pointer" + raise TypeError(msg % (ptr.type, str(ptr))) + if not ptr.type.is_opaque and ptr.type.pointee != value.type: + raise TypeError("cannot store %s to %s: mismatching types" + % (value.type, ptr.type)) + st = instructions.StoreInstr(self.block, value, ptr) + st.align = align + self._insert(st) + return st + + def load_atomic(self, ptr, ordering, align, name='', typ=None): + """ + Load value from pointer, with optional guaranteed alignment: + name = *ptr + """ + if not isinstance(ptr.type, types.PointerType): + msg = "cannot load from value of type %s (%r): not a pointer" + raise TypeError(msg % (ptr.type, str(ptr))) + ld = instructions.LoadAtomicInstr( + self.block, ptr, ordering, align, name, typ=typ) + self._insert(ld) + return ld + + def store_atomic(self, value, ptr, ordering, align): + """ + Store value to pointer, with optional guaranteed alignment: + *ptr = name + """ + if not isinstance(ptr.type, types.PointerType): + msg = "cannot store to value of type %s (%r): not a pointer" + raise TypeError(msg % (ptr.type, str(ptr))) + if ptr.type.pointee != value.type: + raise TypeError("cannot store %s to %s: mismatching types" + % (value.type, ptr.type)) + st = instructions.StoreAtomicInstr( + self.block, value, ptr, ordering, align) + self._insert(st) + return st + + # + # Terminators APIs + # + + def switch(self, value, default): + """ + Create a switch-case with a single *default* target. + """ + swt = instructions.SwitchInstr(self.block, 'switch', value, default) + self._set_terminator(swt) + return swt + + def branch(self, target): + """ + Unconditional branch to *target*. + """ + br = instructions.Branch(self.block, "br", [target]) + self._set_terminator(br) + return br + + def cbranch(self, cond, truebr, falsebr): + """ + Conditional branch to *truebr* if *cond* is true, else to *falsebr*. + """ + br = instructions.ConditionalBranch(self.block, "br", + [cond, truebr, falsebr]) + self._set_terminator(br) + return br + + def branch_indirect(self, addr): + """ + Indirect branch to target *addr*. + """ + br = instructions.IndirectBranch(self.block, "indirectbr", addr) + self._set_terminator(br) + return br + + def ret_void(self): + """ + Return from function without a value. + """ + return self._set_terminator( + instructions.Ret(self.block, "ret void")) + + def ret(self, value): + """ + Return from function with the given *value*. + """ + return self._set_terminator( + instructions.Ret(self.block, "ret", value)) + + def resume(self, landingpad): + """ + Resume an in-flight exception. + """ + br = instructions.Branch(self.block, "resume", [landingpad]) + self._set_terminator(br) + return br + + # Call APIs + + def call(self, fn, args, name='', cconv=None, tail=False, fastmath=(), + attrs=(), arg_attrs=None): + """ + Call function *fn* with *args*: + name = fn(args...) + """ + inst = instructions.CallInstr(self.block, fn, args, name=name, + cconv=cconv, tail=tail, fastmath=fastmath, + attrs=attrs, arg_attrs=arg_attrs) + self._insert(inst) + return inst + + def asm(self, ftype, asm, constraint, args, side_effect, name=''): + """ + Inline assembler. + """ + asm = instructions.InlineAsm(ftype, asm, constraint, side_effect) + return self.call(asm, args, name) + + def load_reg(self, reg_type, reg_name, name=''): + """ + Load a register value into an LLVM value. + Example: v = load_reg(IntType(32), "eax") + """ + ftype = types.FunctionType(reg_type, []) + return self.asm(ftype, "", "={%s}" % reg_name, [], False, name) + + def store_reg(self, value, reg_type, reg_name, name=''): + """ + Store an LLVM value inside a register + Example: + store_reg(Constant(IntType(32), 0xAAAAAAAA), IntType(32), "eax") + """ + ftype = types.FunctionType(types.VoidType(), [reg_type]) + return self.asm(ftype, "", "{%s}" % reg_name, [value], True, name) + + def invoke(self, fn, args, normal_to, unwind_to, + name='', cconv=None, fastmath=(), attrs=(), arg_attrs=None): + inst = instructions.InvokeInstr(self.block, fn, args, normal_to, + unwind_to, name=name, cconv=cconv, + fastmath=fastmath, attrs=attrs, + arg_attrs=arg_attrs) + self._set_terminator(inst) + return inst + + # GEP APIs + + def gep(self, ptr, indices, inbounds=False, name='', source_etype=None): + """ + Compute effective address (getelementptr): + name = getelementptr ptr, + """ + instr = instructions.GEPInstr(self.block, ptr, indices, + inbounds=inbounds, name=name, + source_etype=source_etype) + self._insert(instr) + return instr + + # Vector Operations APIs + + def extract_element(self, vector, idx, name=''): + """ + Returns the value at position idx. + """ + instr = instructions.ExtractElement(self.block, vector, idx, name=name) + self._insert(instr) + return instr + + def insert_element(self, vector, value, idx, name=''): + """ + Returns vector with vector[idx] replaced by value. + The result is undefined if the idx is larger or equal the vector length. + """ + instr = instructions.InsertElement(self.block, vector, value, idx, + name=name) + self._insert(instr) + return instr + + def shuffle_vector(self, vector1, vector2, mask, name=''): + """ + Constructs a permutation of elements from *vector1* and *vector2*. + Returns a new vector in the same length of *mask*. + + * *vector1* and *vector2* must have the same element type. + * *mask* must be a constant vector of integer types. + """ + instr = instructions.ShuffleVector(self.block, vector1, vector2, mask, + name=name) + self._insert(instr) + return instr + + # Aggregate APIs + + def extract_value(self, agg, idx, name=''): + """ + Extract member number *idx* from aggregate. + """ + if not isinstance(idx, (tuple, list)): + idx = [idx] + instr = instructions.ExtractValue(self.block, agg, idx, name=name) + self._insert(instr) + return instr + + def insert_value(self, agg, value, idx, name=''): + """ + Insert *value* into member number *idx* from aggregate. + """ + if not isinstance(idx, (tuple, list)): + idx = [idx] + instr = instructions.InsertValue(self.block, agg, value, idx, name=name) + self._insert(instr) + return instr + + # PHI APIs + + def phi(self, typ, name='', flags=()): + inst = instructions.PhiInstr(self.block, typ, name=name, flags=flags) + self._insert(inst) + return inst + + # Special API + + def unreachable(self): + inst = instructions.Unreachable(self.block) + self._set_terminator(inst) + return inst + + def atomic_rmw(self, op, ptr, val, ordering, name=''): + inst = instructions.AtomicRMW( + self.block, op, ptr, val, ordering, name=name) + self._insert(inst) + return inst + + def cmpxchg(self, ptr, cmp, val, ordering, failordering=None, name=''): + """ + Atomic compared-and-set: + atomic { + old = *ptr + success = (old == cmp) + if (success) + *ptr = val + } + name = { old, success } + + If failordering is `None`, the value of `ordering` is used. + """ + failordering = ordering if failordering is None else failordering + inst = instructions.CmpXchg(self.block, ptr, cmp, val, ordering, + failordering, name=name) + self._insert(inst) + return inst + + def landingpad(self, typ, name='', cleanup=False): + inst = instructions.LandingPadInstr(self.block, typ, name, cleanup) + self._insert(inst) + return inst + + def assume(self, cond): + """ + Optimizer hint: assume *cond* is always true. + """ + fn = self.module.declare_intrinsic("llvm.assume") + return self.call(fn, [cond]) + + def fence(self, ordering, targetscope=None, name=''): + """ + Add a memory barrier, preventing certain reorderings of load and/or + store accesses with + respect to other processors and devices. + """ + inst = instructions.Fence(self.block, ordering, targetscope, name=name) + self._insert(inst) + return inst + + def comment(self, text): + """ + Puts a single-line comment into the generated IR. This will be ignored + by LLVM, but can be useful for debugging the output of a compiler. Adds + a comment to the source file. + + * *text* is a string that does not contain new line characters. + """ + inst = instructions.Comment(self.block, text) + self._insert(inst) + return inst + + @_uniop_intrinsic_int("llvm.bswap") + def bswap(self, cond): + """ + Used to byte swap integer values with an even number of bytes (positive + multiple of 16 bits) + """ + + @_uniop_intrinsic_int("llvm.bitreverse") + def bitreverse(self, cond): + """ + Reverse the bitpattern of an integer value; for example 0b10110110 + becomes 0b01101101. + """ + + @_uniop_intrinsic_int("llvm.ctpop") + def ctpop(self, cond): + """ + Counts the number of bits set in a value. + """ + + @_uniop_intrinsic_with_flag("llvm.ctlz") + def ctlz(self, cond, flag): + """ + Counts leading zero bits in *value*. Boolean *flag* indicates whether + the result is defined for ``0``. + """ + + @_uniop_intrinsic_with_flag("llvm.cttz") + def cttz(self, cond, flag): + """ + Counts trailing zero bits in *value*. Boolean *flag* indicates whether + the result is defined for ``0``. + """ + + @_triop_intrinsic("llvm.fma") + def fma(self, a, b, c): + """ + Perform the fused multiply-add operation. + """ + + def convert_from_fp16(self, a, to=None, name=''): + """ + Convert from an i16 to the given FP type + """ + if not to: + raise TypeError("expected a float return type") + if not isinstance(to, (types.FloatType, types.DoubleType)): + raise TypeError("expected a float type, got %s" % to) + if not (isinstance(a.type, types.IntType) and a.type.width == 16): + raise TypeError("expected an i16 type, got %s" % a.type) + + opname = 'llvm.convert.from.fp16' + fn = self.module.declare_intrinsic(opname, [to]) + return self.call(fn, [a], name) + + @_uniop_intrinsic_float("llvm.convert.to.fp16") + def convert_to_fp16(self, a): + """ + Convert the given FP number to an i16 + """ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/context.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/context.py new file mode 100644 index 0000000000000000000000000000000000000000..7152e1390fd2fc0819893ae43eefce62f4366472 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/context.py @@ -0,0 +1,20 @@ +from llvmlite.ir import _utils +from llvmlite.ir import types + + +class Context(object): + def __init__(self): + self.scope = _utils.NameScope() + self.identified_types = {} + + def get_identified_type(self, name, packed=False): + if name not in self.identified_types: + self.scope.register(name) + ty = types.IdentifiedStructType(self, name, packed) + self.identified_types[name] = ty + else: + ty = self.identified_types[name] + return ty + + +global_context = Context() diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/instructions.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/instructions.py new file mode 100644 index 0000000000000000000000000000000000000000..58039ab50ed99c86cbbbe075f866dc947f0a6195 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/instructions.py @@ -0,0 +1,920 @@ +""" +Implementation of LLVM IR instructions. +""" + +from llvmlite.ir import types +from llvmlite.ir.values import (Block, Function, Value, NamedValue, Constant, + MetaDataArgument, MetaDataString, AttributeSet, + Undefined, ArgumentAttributes) +from llvmlite.ir._utils import _HasMetadata + + +class Instruction(NamedValue, _HasMetadata): + def __init__(self, parent, typ, opname, operands, name='', flags=()): + super(Instruction, self).__init__(parent, typ, name=name) + assert isinstance(parent, Block) + assert isinstance(flags, (tuple, list)) + self.opname = opname + self.operands = operands + self.flags = list(flags) + self.metadata = {} + + @property + def function(self): + return self.parent.function + + @property + def module(self): + return self.parent.function.module + + def descr(self, buf): + opname = self.opname + if self.flags: + opname = ' '.join([opname] + self.flags) + operands = ', '.join([op.get_reference() for op in self.operands]) + typ = self.type + metadata = self._stringify_metadata(leading_comma=True) + buf.append("{0} {1} {2}{3}\n" + .format(opname, typ, operands, metadata)) + + def replace_usage(self, old, new): + if old in self.operands: + ops = [] + for op in self.operands: + ops.append(new if op is old else op) + self.operands = tuple(ops) + self._clear_string_cache() + + def __repr__(self): + return "" % ( + self.__class__.__name__, self.name, self.type, + self.opname, self.operands) + + +class CallInstrAttributes(AttributeSet): + _known = frozenset(['convergent', 'noreturn', 'nounwind', 'readonly', + 'readnone', 'noinline', 'alwaysinline']) + + +TailMarkerOptions = frozenset(['tail', 'musttail', 'notail']) + + +class FastMathFlags(AttributeSet): + _known = frozenset(['fast', 'nnan', 'ninf', 'nsz', 'arcp', 'contract', + 'afn', 'reassoc']) + + +class CallInstr(Instruction): + def __init__(self, parent, func, args, name='', cconv=None, tail=None, + fastmath=(), attrs=(), arg_attrs=None): + self.cconv = (func.calling_convention + if cconv is None and isinstance(func, Function) + else cconv) + + # For backwards compatibility with previous API of accepting a "truthy" + # value for a hint to the optimizer to potentially tail optimize. + if isinstance(tail, str) and tail in TailMarkerOptions: + pass + elif tail: + tail = "tail" + else: + tail = "" + + self.tail = tail + self.fastmath = FastMathFlags(fastmath) + self.attributes = CallInstrAttributes(attrs) + self.arg_attributes = {} + if arg_attrs: + for idx, attrs in arg_attrs.items(): + if not (0 <= idx < len(args)): + raise ValueError("Invalid argument index {}" + .format(idx)) + self.arg_attributes[idx] = ArgumentAttributes(attrs) + + # Fix and validate arguments + args = list(args) + for i in range(len(func.function_type.args)): + arg = args[i] + expected_type = func.function_type.args[i] + if (isinstance(expected_type, types.MetaDataType) and + arg.type != expected_type): + arg = MetaDataArgument(arg) + if arg.type != expected_type: + msg = ("Type of #{0} arg mismatch: {1} != {2}" + .format(1 + i, expected_type, arg.type)) + raise TypeError(msg) + args[i] = arg + + super(CallInstr, self).__init__(parent, func.function_type.return_type, + "call", [func] + list(args), name=name) + + @property + def callee(self): + return self.operands[0] + + @callee.setter + def callee(self, newcallee): + self.operands[0] = newcallee + + @property + def args(self): + return self.operands[1:] + + def replace_callee(self, newfunc): + if newfunc.function_type != self.callee.function_type: + raise TypeError("New function has incompatible type") + self.callee = newfunc + + @property + def called_function(self): + """The callee function""" + return self.callee + + def _descr(self, buf, add_metadata): + def descr_arg(i, a): + if i in self.arg_attributes: + attrs = ' '.join(self.arg_attributes[i]._to_list(a.type)) + ' ' + else: + attrs = '' + return '{0} {1}{2}'.format(a.type, attrs, a.get_reference()) + args = ', '.join([descr_arg(i, a) for i, a in enumerate(self.args)]) + + fnty = self.callee.function_type + # Only print function type if variable-argument + if fnty.var_arg: + ty = fnty + # Otherwise, just print the return type. + else: + # Fastmath flag work only in this case + ty = fnty.return_type + callee_ref = "{0} {1}".format(ty, self.callee.get_reference()) + if self.cconv: + callee_ref = "{0} {1}".format(self.cconv, callee_ref) + + tail_marker = "" + if self.tail: + tail_marker = "{0} ".format(self.tail) + + fn_attrs = ' ' + ' '.join(self.attributes._to_list(fnty.return_type))\ + if self.attributes else '' + + fm_attrs = ' ' + ' '.join(self.fastmath._to_list(fnty.return_type))\ + if self.fastmath else '' + + buf.append("{tail}{op}{fastmath} {callee}({args}){attr}{meta}\n".format( + tail=tail_marker, + op=self.opname, + callee=callee_ref, + fastmath=fm_attrs, + args=args, + attr=fn_attrs, + meta=(self._stringify_metadata(leading_comma=True) + if add_metadata else ""), + )) + + def descr(self, buf): + self._descr(buf, add_metadata=True) + + +class InvokeInstr(CallInstr): + def __init__(self, parent, func, args, normal_to, unwind_to, name='', + cconv=None, fastmath=(), attrs=(), arg_attrs=None): + assert isinstance(normal_to, Block) + assert isinstance(unwind_to, Block) + super(InvokeInstr, self).__init__(parent, func, args, name, cconv, + tail=False, fastmath=fastmath, + attrs=attrs, arg_attrs=arg_attrs) + self.opname = "invoke" + self.normal_to = normal_to + self.unwind_to = unwind_to + + def descr(self, buf): + super(InvokeInstr, self)._descr(buf, add_metadata=False) + buf.append(" to label {0} unwind label {1}{metadata}\n".format( + self.normal_to.get_reference(), + self.unwind_to.get_reference(), + metadata=self._stringify_metadata(leading_comma=True), + )) + + +class Terminator(Instruction): + def __init__(self, parent, opname, operands): + super(Terminator, self).__init__(parent, types.VoidType(), opname, + operands) + + def descr(self, buf): + opname = self.opname + operands = ', '.join(["{0} {1}".format(op.type, op.get_reference()) + for op in self.operands]) + metadata = self._stringify_metadata(leading_comma=True) + buf.append("{0} {1}{2}".format(opname, operands, metadata)) + + +class PredictableInstr(Instruction): + + def set_weights(self, weights): + operands = [MetaDataString(self.module, "branch_weights")] + for w in weights: + if w < 0: + raise ValueError("branch weight must be a positive integer") + operands.append(Constant(types.IntType(32), w)) + md = self.module.add_metadata(operands) + self.set_metadata("prof", md) + + +class Ret(Terminator): + def __init__(self, parent, opname, return_value=None): + operands = [return_value] if return_value is not None else [] + super(Ret, self).__init__(parent, opname, operands) + + @property + def return_value(self): + if self.operands: + return self.operands[0] + else: + return None + + def descr(self, buf): + return_value = self.return_value + metadata = self._stringify_metadata(leading_comma=True) + if return_value is not None: + buf.append("{0} {1} {2}{3}\n" + .format(self.opname, return_value.type, + return_value.get_reference(), + metadata)) + else: + buf.append("{0}{1}\n".format(self.opname, metadata)) + + +class Branch(Terminator): + pass + + +class ConditionalBranch(PredictableInstr, Terminator): + pass + + +class IndirectBranch(PredictableInstr, Terminator): + def __init__(self, parent, opname, addr): + super(IndirectBranch, self).__init__(parent, opname, [addr]) + self.destinations = [] + + @property + def address(self): + return self.operands[0] + + def add_destination(self, block): + assert isinstance(block, Block) + self.destinations.append(block) + + def descr(self, buf): + destinations = ["label {0}".format(blk.get_reference()) + for blk in self.destinations] + buf.append("indirectbr {0} {1}, [{2}] {3}\n".format( + self.address.type, + self.address.get_reference(), + ', '.join(destinations), + self._stringify_metadata(leading_comma=True), + )) + + +class SwitchInstr(PredictableInstr, Terminator): + + def __init__(self, parent, opname, val, default): + super(SwitchInstr, self).__init__(parent, opname, [val]) + self.default = default + self.cases = [] + + @property + def value(self): + return self.operands[0] + + def add_case(self, val, block): + assert isinstance(block, Block) + if not isinstance(val, Value): + val = Constant(self.value.type, val) + self.cases.append((val, block)) + + def descr(self, buf): + cases = ["{0} {1}, label {2}".format(val.type, val.get_reference(), + blk.get_reference()) + for val, blk in self.cases] + buf.append("switch {0} {1}, label {2} [{3}] {4}\n".format( + self.value.type, + self.value.get_reference(), + self.default.get_reference(), + ' '.join(cases), + self._stringify_metadata(leading_comma=True), + )) + + +class Resume(Terminator): + pass + + +class SelectInstr(Instruction): + def __init__(self, parent, cond, lhs, rhs, name='', flags=()): + assert lhs.type == rhs.type + super(SelectInstr, self).__init__(parent, lhs.type, "select", + [cond, lhs, rhs], name=name, + flags=flags) + + @property + def cond(self): + return self.operands[0] + + @property + def lhs(self): + return self.operands[1] + + @property + def rhs(self): + return self.operands[2] + + def descr(self, buf): + buf.append("select {0} {1} {2}, {3} {4}, {5} {6} {7}\n".format( + ' '.join(self.flags), + self.cond.type, self.cond.get_reference(), + self.lhs.type, self.lhs.get_reference(), + self.rhs.type, self.rhs.get_reference(), + self._stringify_metadata(leading_comma=True), + )) + + +class CompareInstr(Instruction): + # Define the following in subclasses + OPNAME = 'invalid-compare' + VALID_OP = {} + + def __init__(self, parent, op, lhs, rhs, name='', flags=[]): + if op not in self.VALID_OP: + raise ValueError("invalid comparison %r for %s" % (op, self.OPNAME)) + for flag in flags: + if flag not in self.VALID_FLAG: + raise ValueError("invalid flag %r for %s" % (flag, self.OPNAME)) + opname = self.OPNAME + if isinstance(lhs.type, types.VectorType): + typ = types.VectorType(types.IntType(1), lhs.type.count) + else: + typ = types.IntType(1) + super(CompareInstr, self).__init__(parent, typ, + opname, [lhs, rhs], flags=flags, + name=name) + self.op = op + + def descr(self, buf): + buf.append("{opname}{flags} {op} {ty} {lhs}, {rhs} {meta}\n".format( + opname=self.opname, + flags=''.join(' ' + it for it in self.flags), + op=self.op, + ty=self.operands[0].type, + lhs=self.operands[0].get_reference(), + rhs=self.operands[1].get_reference(), + meta=self._stringify_metadata(leading_comma=True), + )) + + +class ICMPInstr(CompareInstr): + OPNAME = 'icmp' + VALID_OP = { + 'eq': 'equal', + 'ne': 'not equal', + 'ugt': 'unsigned greater than', + 'uge': 'unsigned greater or equal', + 'ult': 'unsigned less than', + 'ule': 'unsigned less or equal', + 'sgt': 'signed greater than', + 'sge': 'signed greater or equal', + 'slt': 'signed less than', + 'sle': 'signed less or equal', + } + VALID_FLAG = set() + + +class FCMPInstr(CompareInstr): + OPNAME = 'fcmp' + VALID_OP = { + 'false': 'no comparison, always returns false', + 'oeq': 'ordered and equal', + 'ogt': 'ordered and greater than', + 'oge': 'ordered and greater than or equal', + 'olt': 'ordered and less than', + 'ole': 'ordered and less than or equal', + 'one': 'ordered and not equal', + 'ord': 'ordered (no nans)', + 'ueq': 'unordered or equal', + 'ugt': 'unordered or greater than', + 'uge': 'unordered or greater than or equal', + 'ult': 'unordered or less than', + 'ule': 'unordered or less than or equal', + 'une': 'unordered or not equal', + 'uno': 'unordered (either nans)', + 'true': 'no comparison, always returns true', + } + VALID_FLAG = {'nnan', 'ninf', 'nsz', 'arcp', 'contract', 'afn', 'reassoc', + 'fast'} + + +class CastInstr(Instruction): + def __init__(self, parent, op, val, typ, name=''): + super(CastInstr, self).__init__(parent, typ, op, [val], name=name) + + def descr(self, buf): + buf.append("{0} {1} {2} to {3} {4}\n".format( + self.opname, + self.operands[0].type, + self.operands[0].get_reference(), + self.type, + self._stringify_metadata(leading_comma=True), + )) + + +class LoadInstr(Instruction): + + def __init__(self, parent, ptr, name='', typ=None): + if typ is None: + if isinstance(ptr, AllocaInstr): + typ = ptr.allocated_type + # For compatibility with typed pointers. Eventually this should + # probably be removed (when typed pointers are fully removed). + elif not ptr.type.is_opaque: + typ = ptr.type.pointee + else: + raise ValueError("Load lacks type.") + super(LoadInstr, self).__init__(parent, typ, "load", [ptr], name=name) + self.align = None + + def descr(self, buf): + [val] = self.operands + if self.align is not None: + align = ', align %d' % (self.align) + else: + align = '' + buf.append("load {0}, {1} {2}{3}{4}\n".format( + self.type, + val.type, + val.get_reference(), + align, + self._stringify_metadata(leading_comma=True), + )) + + +class StoreInstr(Instruction): + def __init__(self, parent, val, ptr): + super(StoreInstr, self).__init__(parent, types.VoidType(), "store", + [val, ptr]) + + def descr(self, buf): + val, ptr = self.operands + if self.align is not None: + align = ', align %d' % (self.align) + else: + align = '' + buf.append("store {0} {1}, {2} {3}{4}{5}\n".format( + val.type, + val.get_reference(), + ptr.type, + ptr.get_reference(), + align, + self._stringify_metadata(leading_comma=True), + )) + + +class LoadAtomicInstr(Instruction): + def __init__(self, parent, ptr, ordering, align, name='', typ=None): + if typ is None: + if isinstance(ptr, AllocaInstr): + typ = ptr.allocated_type + # For compatibility with typed pointers. Eventually this should + # probably be removed (when typed pointers are fully removed). + elif not ptr.type.is_opaque: + typ = ptr.type.pointee + else: + raise ValueError("Load atomic lacks type.") + super(LoadAtomicInstr, self).__init__(parent, typ, "load atomic", + [ptr], name=name) + self.ordering = ordering + self.align = align + + def descr(self, buf): + [val] = self.operands + buf.append("load atomic {0}, {1} {2} {3}, align {4}{5}\n".format( + self.type, + val.type, + val.get_reference(), + self.ordering, + self.align, + self._stringify_metadata(leading_comma=True), + )) + + +class StoreAtomicInstr(Instruction): + def __init__(self, parent, val, ptr, ordering, align): + super(StoreAtomicInstr, self).__init__(parent, types.VoidType(), + "store atomic", [val, ptr]) + self.ordering = ordering + self.align = align + + def descr(self, buf): + val, ptr = self.operands + buf.append("store atomic {0} {1}, {2} {3} {4}, align {5}{6}\n".format( + val.type, + val.get_reference(), + ptr.type, + ptr.get_reference(), + self.ordering, + self.align, + self._stringify_metadata(leading_comma=True), + )) + + +class AllocaInstr(Instruction): + def __init__(self, parent, typ, count, name): + operands = [count] if count else () + super(AllocaInstr, self).__init__(parent, typ.as_pointer(), "alloca", + operands, name) + self.allocated_type = typ + self.align = None + + def descr(self, buf): + buf.append("{0} {1}".format(self.opname, self.allocated_type)) + if self.operands: + op, = self.operands + buf.append(", {0} {1}".format(op.type, op.get_reference())) + if self.align is not None: + buf.append(", align {0}".format(self.align)) + if self.metadata: + buf.append(self._stringify_metadata(leading_comma=True)) + + +class GEPInstr(Instruction): + def __init__(self, parent, ptr, indices, inbounds, name, + source_etype=None): + if source_etype is not None: + typ = ptr.type + self.source_etype = source_etype + # For compatibility with typed pointers. Eventually this should + # probably be removed (when typed pointers are fully removed). + elif not ptr.type.is_opaque: + typ = ptr.type + lasttyp = None + lastaddrspace = 0 + for i in indices: + lasttyp, typ = typ, typ.gep(i) + # inherit the addrspace from the last seen pointer + if isinstance(lasttyp, types.PointerType): + lastaddrspace = lasttyp.addrspace + + if (not isinstance(typ, types.PointerType) and + isinstance(lasttyp, types.PointerType)): + typ = lasttyp + else: + typ = typ.as_pointer(lastaddrspace) + self.source_etype = ptr.type.pointee + else: + raise ValueError("GEP lacks type.") + super(GEPInstr, self).__init__(parent, typ, "getelementptr", + [ptr] + list(indices), name=name) + self.pointer = ptr + self.indices = indices + self.inbounds = inbounds + + def descr(self, buf): + indices = ['{0} {1}'.format(i.type, i.get_reference()) + for i in self.indices] + op = "getelementptr inbounds" if self.inbounds else "getelementptr" + buf.append("{0} {1}, {2} {3}, {4} {5}\n".format( + op, + self.source_etype, + self.pointer.type, + self.pointer.get_reference(), + ', '.join(indices), + self._stringify_metadata(leading_comma=True), + )) + + +class PhiInstr(Instruction): + def __init__(self, parent, typ, name, flags=()): + super(PhiInstr, self).__init__(parent, typ, "phi", (), name=name, + flags=flags) + self.incomings = [] + + def descr(self, buf): + incs = ', '.join('[{0}, {1}]'.format(v.get_reference(), + b.get_reference()) + for v, b in self.incomings) + buf.append("phi {0} {1} {2} {3}\n".format( + ' '.join(self.flags), + self.type, + incs, + self._stringify_metadata(leading_comma=True), + )) + + def add_incoming(self, value, block): + assert isinstance(block, Block) + self.incomings.append((value, block)) + + def replace_usage(self, old, new): + self.incomings = [((new if val is old else val), blk) + for (val, blk) in self.incomings] + + +class ExtractElement(Instruction): + def __init__(self, parent, vector, index, name=''): + if not isinstance(vector.type, types.VectorType): + raise TypeError("vector needs to be of VectorType.") + if not isinstance(index.type, types.IntType): + raise TypeError("index needs to be of IntType.") + typ = vector.type.element + super(ExtractElement, self).__init__(parent, typ, "extractelement", + [vector, index], name=name) + + def descr(self, buf): + operands = ", ".join("{0} {1}".format( + op.type, op.get_reference()) for op in self.operands) + buf.append("{opname} {operands}\n".format( + opname=self.opname, operands=operands)) + + +class InsertElement(Instruction): + def __init__(self, parent, vector, value, index, name=''): + if not isinstance(vector.type, types.VectorType): + raise TypeError("vector needs to be of VectorType.") + if not value.type == vector.type.element: + raise TypeError( + "value needs to be of type {} not {}.".format( + vector.type.element, value.type)) + if not isinstance(index.type, types.IntType): + raise TypeError("index needs to be of IntType.") + typ = vector.type + super(InsertElement, self).__init__(parent, typ, "insertelement", + [vector, value, index], name=name) + + def descr(self, buf): + operands = ", ".join("{0} {1}".format( + op.type, op.get_reference()) for op in self.operands) + buf.append("{opname} {operands}\n".format( + opname=self.opname, operands=operands)) + + +class ShuffleVector(Instruction): + def __init__(self, parent, vector1, vector2, mask, name=''): + if not isinstance(vector1.type, types.VectorType): + raise TypeError("vector1 needs to be of VectorType.") + if vector2 != Undefined: + if vector2.type != vector1.type: + raise TypeError("vector2 needs to be " + + "Undefined or of the same type as vector1.") + if (not isinstance(mask, Constant) or + not isinstance(mask.type, types.VectorType) or + not (isinstance(mask.type.element, types.IntType) and + mask.type.element.width == 32)): + raise TypeError("mask needs to be a constant i32 vector.") + typ = types.VectorType(vector1.type.element, mask.type.count) + index_range = range(vector1.type.count + if vector2 == Undefined + else 2 * vector1.type.count) + if not all(ii.constant in index_range for ii in mask.constant): + raise IndexError( + "mask values need to be in {0}".format(index_range), + ) + super(ShuffleVector, self).__init__(parent, typ, "shufflevector", + [vector1, vector2, mask], name=name) + + def descr(self, buf): + buf.append("shufflevector {0} {1}\n".format( + ", ".join("{0} {1}".format(op.type, op.get_reference()) + for op in self.operands), + self._stringify_metadata(leading_comma=True), + )) + + +class ExtractValue(Instruction): + def __init__(self, parent, agg, indices, name=''): + typ = agg.type + try: + for i in indices: + typ = typ.elements[i] + except (AttributeError, IndexError): + raise TypeError("Can't index at %r in %s" + % (list(indices), agg.type)) + + super(ExtractValue, self).__init__(parent, typ, "extractvalue", + [agg], name=name) + + self.aggregate = agg + self.indices = indices + + def descr(self, buf): + indices = [str(i) for i in self.indices] + + buf.append("extractvalue {0} {1}, {2} {3}\n".format( + self.aggregate.type, + self.aggregate.get_reference(), + ', '.join(indices), + self._stringify_metadata(leading_comma=True), + )) + + +class InsertValue(Instruction): + def __init__(self, parent, agg, elem, indices, name=''): + typ = agg.type + try: + for i in indices: + typ = typ.elements[i] + except (AttributeError, IndexError): + raise TypeError("Can't index at %r in %s" + % (list(indices), agg.type)) + if elem.type != typ: + raise TypeError("Can only insert %s at %r in %s: got %s" + % (typ, list(indices), agg.type, elem.type)) + super(InsertValue, self).__init__(parent, agg.type, "insertvalue", + [agg, elem], name=name) + + self.aggregate = agg + self.value = elem + self.indices = indices + + def descr(self, buf): + indices = [str(i) for i in self.indices] + + buf.append("insertvalue {0} {1}, {2} {3}, {4} {5}\n".format( + self.aggregate.type, self.aggregate.get_reference(), + self.value.type, self.value.get_reference(), + ', '.join(indices), + self._stringify_metadata(leading_comma=True), + )) + + +class Unreachable(Instruction): + def __init__(self, parent): + super(Unreachable, self).__init__(parent, types.VoidType(), + "unreachable", (), name='') + + def descr(self, buf): + buf += (self.opname, "\n") + + +class InlineAsm(object): + def __init__(self, ftype, asm, constraint, side_effect=False): + self.type = ftype.return_type + self.function_type = ftype + self.asm = asm + self.constraint = constraint + self.side_effect = side_effect + + def descr(self, buf): + sideeffect = 'sideeffect' if self.side_effect else '' + fmt = 'asm {sideeffect} "{asm}", "{constraint}"\n' + buf.append(fmt.format(sideeffect=sideeffect, asm=self.asm, + constraint=self.constraint)) + + def get_reference(self): + buf = [] + self.descr(buf) + return "".join(buf) + + def __str__(self): + return "{0} {1}".format(self.type, self.get_reference()) + + +class AtomicRMW(Instruction): + def __init__(self, parent, op, ptr, val, ordering, name): + super(AtomicRMW, self).__init__(parent, val.type, "atomicrmw", + (ptr, val), name=name) + self.operation = op + self.ordering = ordering + + def descr(self, buf): + ptr, val = self.operands + fmt = ("atomicrmw {op} {ptrty} {ptr}, {valty} {val} {ordering} " + "{metadata}\n") + buf.append(fmt.format(op=self.operation, + ptrty=ptr.type, + ptr=ptr.get_reference(), + valty=val.type, + val=val.get_reference(), + ordering=self.ordering, + metadata=self._stringify_metadata( + leading_comma=True), + )) + + +class CmpXchg(Instruction): + """This instruction has changed since llvm3.5. It is not compatible with + older llvm versions. + """ + + def __init__(self, parent, ptr, cmp, val, ordering, failordering, name): + outtype = types.LiteralStructType([val.type, types.IntType(1)]) + super(CmpXchg, self).__init__(parent, outtype, "cmpxchg", + (ptr, cmp, val), name=name) + self.ordering = ordering + self.failordering = failordering + + def descr(self, buf): + ptr, cmpval, val = self.operands + fmt = "cmpxchg {ptrty} {ptr}, {ty} {cmp}, {ty} {val} {ordering} " \ + "{failordering} {metadata}\n" + buf.append(fmt.format(ptrty=ptr.type, + ptr=ptr.get_reference(), + ty=cmpval.type, + cmp=cmpval.get_reference(), + val=val.get_reference(), + ordering=self.ordering, + failordering=self.failordering, + metadata=self._stringify_metadata( + leading_comma=True), + )) + + +class _LandingPadClause(object): + def __init__(self, value): + self.value = value + + def __str__(self): + return "{kind} {type} {value}".format( + kind=self.kind, + type=self.value.type, + value=self.value.get_reference()) + + +class CatchClause(_LandingPadClause): + kind = 'catch' + + +class FilterClause(_LandingPadClause): + kind = 'filter' + + def __init__(self, value): + assert isinstance(value, Constant) + assert isinstance(value.type, types.ArrayType) + super(FilterClause, self).__init__(value) + + +class LandingPadInstr(Instruction): + def __init__(self, parent, typ, name='', cleanup=False): + super(LandingPadInstr, self).__init__(parent, typ, "landingpad", [], + name=name) + self.cleanup = cleanup + self.clauses = [] + + def add_clause(self, clause): + assert isinstance(clause, _LandingPadClause) + self.clauses.append(clause) + + def descr(self, buf): + fmt = "landingpad {type}{cleanup}{clauses}\n" + buf.append(fmt.format(type=self.type, + cleanup=' cleanup' if self.cleanup else '', + clauses=''.join(["\n {0}".format(clause) + for clause in self.clauses]), + )) + + +class Fence(Instruction): + """ + The `fence` instruction. + + As of LLVM 5.0.1: + + fence [syncscope("")] ; yields void + """ + + VALID_FENCE_ORDERINGS = {"acquire", "release", "acq_rel", "seq_cst"} + + def __init__(self, parent, ordering, targetscope=None, name=''): + super(Fence, self).__init__(parent, types.VoidType(), "fence", (), + name=name) + if ordering not in self.VALID_FENCE_ORDERINGS: + msg = "Invalid fence ordering \"{0}\"! Should be one of {1}." + raise ValueError(msg .format(ordering, + ", ".join(self.VALID_FENCE_ORDERINGS))) + self.ordering = ordering + self.targetscope = targetscope + + def descr(self, buf): + if self.targetscope is None: + syncscope = "" + else: + syncscope = 'syncscope("{0}") '.format(self.targetscope) + + fmt = "fence {syncscope}{ordering}\n" + buf.append(fmt.format(syncscope=syncscope, + ordering=self.ordering, + )) + + +class Comment(Instruction): + """ + A line comment. + """ + + def __init__(self, parent, text): + super(Comment, self).__init__(parent, types.VoidType(), ";", (), + name='') + assert "\n" not in text, "Comment cannot contain new line" + self.text = text + + def descr(self, buf): + buf.append(f"; {self.text}") diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/module.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/module.py new file mode 100644 index 0000000000000000000000000000000000000000..464f91ec34344e02bd9fb7e5f6dec46803407f00 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/module.py @@ -0,0 +1,246 @@ +import collections + +from llvmlite.ir import context, values, types, _utils + + +class Module(object): + def __init__(self, name='', context=context.global_context): + self.context = context + self.name = name # name is for debugging/informational + self.data_layout = "" + self.scope = _utils.NameScope() + self.triple = 'unknown-unknown-unknown' + self.globals = collections.OrderedDict() + # Innamed metadata nodes. + self.metadata = [] + # Named metadata nodes + self.namedmetadata = {} + # Cache for metadata node deduplication + self._metadatacache = {} + + def _fix_metadata_operands(self, operands): + fixed_ops = [] + for op in operands: + if op is None: + # A literal None creates a null metadata value + op = types.MetaDataType()(None) + elif isinstance(op, str): + # A literal string creates a metadata string value + op = values.MetaDataString(self, op) + elif isinstance(op, (list, tuple)): + # A sequence creates a metadata node reference + op = self.add_metadata(op) + fixed_ops.append(op) + return fixed_ops + + def _fix_di_operands(self, operands): + fixed_ops = [] + for name, op in operands: + if isinstance(op, (list, tuple)): + # A sequence creates a metadata node reference + op = self.add_metadata(op) + fixed_ops.append((name, op)) + return fixed_ops + + def add_metadata(self, operands): + """ + Add an unnamed metadata to the module with the given *operands* + (a sequence of values) or return a previous equivalent metadata. + A MDValue instance is returned, it can then be associated to + e.g. an instruction. + """ + if not isinstance(operands, (list, tuple)): + raise TypeError("expected a list or tuple of metadata values, " + "got %r" % (operands,)) + operands = self._fix_metadata_operands(operands) + key = tuple(operands) + if key not in self._metadatacache: + n = len(self.metadata) + md = values.MDValue(self, operands, name=str(n)) + self._metadatacache[key] = md + else: + md = self._metadatacache[key] + return md + + def add_debug_info(self, kind, operands, is_distinct=False): + """ + Add debug information metadata to the module with the given + *operands* (a dict of values with string keys) or return + a previous equivalent metadata. *kind* is a string of the + debug information kind (e.g. "DICompileUnit"). + + A DIValue instance is returned, it can then be associated to e.g. + an instruction. + """ + operands = tuple(sorted(self._fix_di_operands(operands.items()))) + key = (kind, operands, is_distinct) + if key not in self._metadatacache: + n = len(self.metadata) + di = values.DIValue(self, is_distinct, kind, operands, name=str(n)) + self._metadatacache[key] = di + else: + di = self._metadatacache[key] + return di + + def add_named_metadata(self, name, element=None): + """ + Add a named metadata node to the module, if it doesn't exist, + or return the existing node. + If *element* is given, it will append a new element to + the named metadata node. If *element* is a sequence of values + (rather than a metadata value), a new unnamed node will first be + created. + + Example:: + module.add_named_metadata("llvm.ident", ["llvmlite/1.0"]) + """ + if name in self.namedmetadata: + nmd = self.namedmetadata[name] + else: + nmd = self.namedmetadata[name] = values.NamedMetaData(self) + if element is not None: + if not isinstance(element, values.Value): + element = self.add_metadata(element) + if not isinstance(element.type, types.MetaDataType): + raise TypeError("wrong type for metadata element: got %r" + % (element,)) + nmd.add(element) + return nmd + + def get_named_metadata(self, name): + """ + Return the metadata node with the given *name*. KeyError is raised + if no such node exists (contrast with add_named_metadata()). + """ + return self.namedmetadata[name] + + @property + def functions(self): + """ + A list of functions declared or defined in this module. + """ + return [v for v in self.globals.values() + if isinstance(v, values.Function)] + + @property + def global_values(self): + """ + An iterable of global values in this module. + """ + return self.globals.values() + + def get_global(self, name): + """ + Get a global value by name. + """ + return self.globals[name] + + def add_global(self, globalvalue): + """ + Add a new global value. + """ + assert globalvalue.name not in self.globals + self.globals[globalvalue.name] = globalvalue + + def get_unique_name(self, name=''): + """ + Get a unique global name with the following *name* hint. + """ + return self.scope.deduplicate(name) + + def declare_intrinsic(self, intrinsic, tys=(), fnty=None): + def _error(): + raise NotImplementedError("unknown intrinsic %r with %d types" + % (intrinsic, len(tys))) + + if intrinsic in {'llvm.cttz', 'llvm.ctlz', 'llvm.fma'}: + suffixes = [tys[0].intrinsic_name] + else: + suffixes = [t.intrinsic_name for t in tys] + name = '.'.join([intrinsic] + suffixes) + if name in self.globals: + return self.globals[name] + + if fnty is not None: + # General case: function type is given + pass + # Compute function type if omitted for common cases + elif len(tys) == 0 and intrinsic == 'llvm.assume': + fnty = types.FunctionType(types.VoidType(), [types.IntType(1)]) + elif len(tys) == 1: + if intrinsic == 'llvm.powi': + fnty = types.FunctionType(tys[0], [tys[0], types.IntType(32)]) + elif intrinsic == 'llvm.pow': + fnty = types.FunctionType(tys[0], tys * 2) + elif intrinsic == 'llvm.convert.from.fp16': + fnty = types.FunctionType(tys[0], [types.IntType(16)]) + elif intrinsic == 'llvm.convert.to.fp16': + fnty = types.FunctionType(types.IntType(16), tys) + else: + fnty = types.FunctionType(tys[0], tys) + elif len(tys) == 2: + if intrinsic == 'llvm.memset': + tys = [tys[0], types.IntType(8), tys[1], + types.IntType(1)] + fnty = types.FunctionType(types.VoidType(), tys) + elif intrinsic in {'llvm.cttz', 'llvm.ctlz'}: + tys = [tys[0], types.IntType(1)] + fnty = types.FunctionType(tys[0], tys) + else: + _error() + elif len(tys) == 3: + if intrinsic in ('llvm.memcpy', 'llvm.memmove'): + tys = tys + [types.IntType(1)] + fnty = types.FunctionType(types.VoidType(), tys) + elif intrinsic == 'llvm.fma': + tys = [tys[0]] * 3 + fnty = types.FunctionType(tys[0], tys) + else: + _error() + else: + _error() + return values.Function(self, fnty, name=name) + + def get_identified_types(self): + return self.context.identified_types + + def _get_body_lines(self): + # Type declarations + lines = [it.get_declaration() + for it in self.get_identified_types().values()] + # Global values (including function definitions) + lines += [str(v) for v in self.globals.values()] + return lines + + def _get_metadata_lines(self): + mdbuf = [] + for k, v in self.namedmetadata.items(): + mdbuf.append("!{name} = !{{ {operands} }}".format( + name=k, operands=', '.join(i.get_reference() + for i in v.operands))) + for md in self.metadata: + mdbuf.append(str(md)) + return mdbuf + + def _stringify_body(self): + # For testing + return "\n".join(self._get_body_lines()) + + def _stringify_metadata(self): + # For testing + return "\n".join(self._get_metadata_lines()) + + def __repr__(self): + lines = [] + # Header + lines += [ + '; ModuleID = "%s"' % (self.name,), + 'target triple = "%s"' % (self.triple,), + 'target datalayout = "%s"' % (self.data_layout,), + ''] + # Body + lines += self._get_body_lines() + # Metadata + lines += self._get_metadata_lines() + + return "\n".join(lines) diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/transforms.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/transforms.py new file mode 100644 index 0000000000000000000000000000000000000000..a69113d36e93b6b9e42a2a15119697375cff62e5 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/transforms.py @@ -0,0 +1,64 @@ +from llvmlite.ir import CallInstr + + +class Visitor(object): + def visit(self, module): + self._module = module + for func in module.functions: + self.visit_Function(func) + + def visit_Function(self, func): + self._function = func + for bb in func.blocks: + self.visit_BasicBlock(bb) + + def visit_BasicBlock(self, bb): + self._basic_block = bb + for instr in bb.instructions: + self.visit_Instruction(instr) + + def visit_Instruction(self, instr): + raise NotImplementedError + + @property + def module(self): + return self._module + + @property + def function(self): + return self._function + + @property + def basic_block(self): + return self._basic_block + + +class CallVisitor(Visitor): + def visit_Instruction(self, instr): + if isinstance(instr, CallInstr): + self.visit_Call(instr) + + def visit_Call(self, instr): + raise NotImplementedError + + +class ReplaceCalls(CallVisitor): + def __init__(self, orig, repl): + super(ReplaceCalls, self).__init__() + self.orig = orig + self.repl = repl + self.calls = [] + + def visit_Call(self, instr): + if instr.callee == self.orig: + instr.replace_callee(self.repl) + self.calls.append(instr) + + +def replace_all_calls(mod, orig, repl): + """Replace all calls to `orig` to `repl` in module `mod`. + Returns the references to the returned calls + """ + rc = ReplaceCalls(orig, repl) + rc.visit(mod) + return rc.calls diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/types.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/types.py new file mode 100644 index 0000000000000000000000000000000000000000..eac3ada7a9dfea2f79a90a6a7ed43418edd8e95e --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/types.py @@ -0,0 +1,734 @@ +""" +Classes that are LLVM types +""" + +import struct + +from llvmlite.ir._utils import _StrCaching + +# FIXME: Remove me once typed pointers are no longer supported. +from llvmlite import opaque_pointers_enabled + + +def _wrapname(x): + return '"{0}"'.format(x.replace('\\', '\\5c').replace('"', '\\22')) + + +class Type(_StrCaching): + """ + The base class for all LLVM types. + """ + is_pointer = False + null = 'zeroinitializer' + + def __repr__(self): + return "<%s %s>" % (type(self), str(self)) + + def _to_string(self): + raise NotImplementedError + + def as_pointer(self, addrspace=0): + return PointerType(self, addrspace) + + def __ne__(self, other): + return not (self == other) + + def _get_ll_global_value_type(self, target_data, context=None): + """ + Convert this type object to an LLVM type. + """ + from llvmlite.ir import Module, GlobalVariable + from llvmlite.binding import parse_assembly + + if context is None: + m = Module() + else: + m = Module(context=context) + foo = GlobalVariable(m, self, name="foo") + with parse_assembly(str(m)) as llmod: + return llmod.get_global_variable(foo.name).global_value_type + + def get_abi_size(self, target_data, context=None): + """ + Get the ABI size of this type according to data layout *target_data*. + """ + llty = self._get_ll_global_value_type(target_data, context) + return target_data.get_abi_size(llty) + + def get_element_offset(self, target_data, ndx, context=None): + llty = self._get_ll_global_value_type(target_data, context) + return target_data.get_element_offset(llty, ndx) + + def get_abi_alignment(self, target_data, context=None): + """ + Get the minimum ABI alignment of this type according to data layout + *target_data*. + """ + llty = self._get_ll_global_value_type(target_data, context) + return target_data.get_abi_alignment(llty) + + def format_constant(self, value): + """ + Format constant *value* of this type. This method may be overriden + by subclasses. + """ + return str(value) + + def wrap_constant_value(self, value): + """ + Wrap constant *value* if necessary. This method may be overriden + by subclasses (especially aggregate types). + """ + return value + + def __call__(self, value): + """ + Create a LLVM constant of this type with the given Python value. + """ + from llvmlite.ir import Constant + return Constant(self, value) + + +class MetaDataType(Type): + + def _to_string(self): + return "metadata" + + def as_pointer(self): + raise TypeError + + def __eq__(self, other): + return isinstance(other, MetaDataType) + + def __hash__(self): + return hash(MetaDataType) + + +class LabelType(Type): + """ + The label type is the type of e.g. basic blocks. + """ + + def _to_string(self): + return "label" + + +class PointerType(Type): + """ + The type of all pointer values. + By default (without specialisation) represents an opaque pointer. + """ + is_opaque = True + is_pointer = True + null = 'null' + + # Factory to create typed or opaque pointers based on `pointee'. + def __new__(cls, pointee=None, addrspace=0): + if cls is PointerType and pointee is not None: + return super().__new__(_TypedPointerType) + return super(PointerType, cls).__new__(cls) + + def __init__(self, addrspace=0): + self.addrspace = addrspace + + def _to_string(self): + if self.addrspace != 0: + return "ptr addrspace({0})".format(self.addrspace) + else: + return "ptr" + + def __hash__(self): + return hash(PointerType) + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + if not opaque_pointers_enabled: + return _TypedPointerType.from_llvm(typeref, ir_ctx) + return cls() + + +class _TypedPointerType(PointerType): + """ + The type of typed pointer values. To be removed eventually. + """ + + def __init__(self, pointee, addrspace=0): + super(_TypedPointerType, self).__init__(addrspace) + assert pointee is not None + assert not isinstance(pointee, VoidType) + self.pointee = pointee + self.is_opaque = False + + def _to_string(self): + if not opaque_pointers_enabled: + return "{0}*".format(self.pointee) if self.addrspace == 0 else \ + "{0} addrspace({1})*".format(self.pointee, self.addrspace) + return super(_TypedPointerType, self)._to_string() + + # This implements ``isOpaqueOrPointeeTypeEquals''. + def __eq__(self, other): + if isinstance(other, _TypedPointerType): + return (self.pointee, self.addrspace) == (other.pointee, + other.addrspace) + return isinstance(other, PointerType) + + def __hash__(self): + return hash(_TypedPointerType) + + def gep(self, i): + """ + Resolve the type of the i-th element (for getelementptr lookups). + """ + if not isinstance(i.type, IntType): + raise TypeError(i.type) + return self.pointee + + @property + def intrinsic_name(self): + return 'p%d%s' % (self.addrspace, self.pointee.intrinsic_name) + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + assert not opaque_pointers_enabled + # opaque pointer will change this + [pointee] = typeref.elements + # addrspace is not handled + return cls(pointee.as_ir(ir_ctx=ir_ctx)) + + +class VoidType(Type): + """ + The type for empty values (e.g. a function returning no value). + """ + + def _to_string(self): + return 'void' + + def __eq__(self, other): + return isinstance(other, VoidType) + + def __hash__(self): + return hash(VoidType) + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + return cls() + + +class FunctionType(Type): + """ + The type for functions. + """ + + def __init__(self, return_type, args, var_arg=False): + self.return_type = return_type + self.args = tuple(args) + self.var_arg = var_arg + + def _to_string(self): + if self.args: + strargs = ', '.join([str(a) for a in self.args]) + if self.var_arg: + return '{0} ({1}, ...)'.format(self.return_type, strargs) + else: + return '{0} ({1})'.format(self.return_type, strargs) + elif self.var_arg: + return '{0} (...)'.format(self.return_type) + else: + return '{0} ()'.format(self.return_type) + + def __eq__(self, other): + if isinstance(other, FunctionType): + return (self.return_type == other.return_type and + self.args == other.args and self.var_arg == other.var_arg) + else: + return False + + def __hash__(self): + return hash(FunctionType) + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + params = tuple(x.as_ir(ir_ctx=ir_ctx) + for x in typeref.get_function_parameters()) + ret = typeref.get_function_return().as_ir(ir_ctx=ir_ctx) + is_vararg = typeref.is_function_vararg + return cls(ret, params, is_vararg) + + +class IntType(Type): + """ + The type for integers. + """ + null = '0' + _instance_cache = {} + width: int + + def __new__(cls, bits): + # Cache all common integer types + if 0 <= bits <= 128: + try: + return cls._instance_cache[bits] + except KeyError: + inst = cls._instance_cache[bits] = cls.__new(bits) + return inst + return cls.__new(bits) + + @classmethod + def __new(cls, bits): + assert isinstance(bits, int) and bits >= 0 + self = super(IntType, cls).__new__(cls) + self.width = bits + return self + + def __getnewargs__(self): + return self.width, + + def __copy__(self): + return self + + def _to_string(self): + return 'i%u' % (self.width,) + + def __eq__(self, other): + if isinstance(other, IntType): + return self.width == other.width + else: + return False + + def __hash__(self): + return hash(IntType) + + def format_constant(self, val): + if isinstance(val, bool): + return str(val).lower() + else: + return str(val) + + def wrap_constant_value(self, val): + if val is None: + return 0 + return val + + @property + def intrinsic_name(self): + return str(self) + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + return IntType(typeref.type_width) + + +def _as_float(value): + """ + Truncate to single-precision float. + """ + return struct.unpack('f', struct.pack('f', value))[0] + + +def _as_half(value): + """ + Truncate to half-precision float. + """ + try: + return struct.unpack('e', struct.pack('e', value))[0] + except struct.error: + # 'e' only added in Python 3.6+ + return _as_float(value) + + +def _format_float_as_hex(value, packfmt, unpackfmt, numdigits): + raw = struct.pack(packfmt, float(value)) + intrep = struct.unpack(unpackfmt, raw)[0] + out = '{{0:#{0}x}}'.format(numdigits).format(intrep) + return out + + +def _format_double(value): + """ + Format *value* as a hexadecimal string of its IEEE double precision + representation. + """ + return _format_float_as_hex(value, 'd', 'Q', 16) + + +class _BaseFloatType(Type): + + def __new__(cls): + return cls._instance_cache + + def __eq__(self, other): + return isinstance(other, type(self)) + + def __hash__(self): + return hash(type(self)) + + @classmethod + def _create_instance(cls): + cls._instance_cache = super(_BaseFloatType, cls).__new__(cls) + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + return cls() + + +class HalfType(_BaseFloatType): + """ + The type for single-precision floats. + """ + null = '0.0' + intrinsic_name = 'f16' + + def __str__(self): + return 'half' + + def format_constant(self, value): + return _format_double(_as_half(value)) + + +class FloatType(_BaseFloatType): + """ + The type for single-precision floats. + """ + null = '0.0' + intrinsic_name = 'f32' + + def __str__(self): + return 'float' + + def format_constant(self, value): + return _format_double(_as_float(value)) + + +class DoubleType(_BaseFloatType): + """ + The type for double-precision floats. + """ + null = '0.0' + intrinsic_name = 'f64' + + def __str__(self): + return 'double' + + def format_constant(self, value): + return _format_double(value) + + +for _cls in (HalfType, FloatType, DoubleType): + _cls._create_instance() + + +class _Repeat(object): + def __init__(self, value, size): + self.value = value + self.size = size + + def __len__(self): + return self.size + + def __getitem__(self, item): + if 0 <= item < self.size: + return self.value + else: + raise IndexError(item) + + +class VectorType(Type): + """ + The type for vectors of primitive data items (e.g. ""). + """ + + def __init__(self, element, count): + self.element = element + self.count = count + + @property + def elements(self): + return _Repeat(self.element, self.count) + + def __len__(self): + return self.count + + def _to_string(self): + return "<%d x %s>" % (self.count, self.element) + + def __eq__(self, other): + if isinstance(other, VectorType): + return self.element == other.element and self.count == other.count + + def __hash__(self): + # TODO: why does this not take self.element/self.count into account? + return hash(VectorType) + + def __copy__(self): + return self + + def format_constant(self, value): + itemstring = ", " .join(["{0} {1}".format(x.type, x.get_reference()) + for x in value]) + return "<{0}>".format(itemstring) + + def wrap_constant_value(self, values): + from . import Value, Constant + if not isinstance(values, (list, tuple)): + if isinstance(values, Constant): + if values.type != self.element: + raise TypeError("expected {} for {}".format( + self.element, values.type)) + return (values, ) * self.count + return (Constant(self.element, values), ) * self.count + if len(values) != len(self): + raise ValueError("wrong constant size for %s: got %d elements" + % (self, len(values))) + return [Constant(ty, val) if not isinstance(val, Value) else val + for ty, val in zip(self.elements, values)] + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + [elemtyperef] = typeref.elements + elemty = elemtyperef.as_ir(ir_ctx=ir_ctx) + count = typeref.element_count + return cls(elemty, count) + + +class Aggregate(Type): + """ + Base class for aggregate types. + See http://llvm.org/docs/LangRef.html#t-aggregate + """ + + def wrap_constant_value(self, values): + from . import Value, Constant + + if not isinstance(values, (list, tuple)): + return values + if len(values) != len(self): + raise ValueError("wrong constant size for %s: got %d elements" + % (self, len(values))) + return [Constant(ty, val) if not isinstance(val, Value) else val + for ty, val in zip(self.elements, values)] + + +class ArrayType(Aggregate): + """ + The type for fixed-size homogenous arrays (e.g. "[f32 x 3]"). + """ + + def __init__(self, element, count): + self.element = element + self.count = count + + @property + def elements(self): + return _Repeat(self.element, self.count) + + def __len__(self): + return self.count + + def _to_string(self): + return "[%d x %s]" % (self.count, self.element) + + def __eq__(self, other): + if isinstance(other, ArrayType): + return self.element == other.element and self.count == other.count + + def __hash__(self): + return hash(ArrayType) + + def gep(self, i): + """ + Resolve the type of the i-th element (for getelementptr lookups). + """ + if not isinstance(i.type, IntType): + raise TypeError(i.type) + return self.element + + def format_constant(self, value): + itemstring = ", " .join(["{0} {1}".format(x.type, x.get_reference()) + for x in value]) + return "[{0}]".format(itemstring) + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + [elemtyperef] = typeref.elements + elemty = elemtyperef.as_ir(ir_ctx=ir_ctx) + count = typeref.element_count + return cls(elemty, count) + + +class BaseStructType(Aggregate): + """ + The base type for heterogenous struct types. + """ + _packed = False + + @property + def packed(self): + """ + A boolean attribute that indicates whether the structure uses + packed layout. + """ + return self._packed + + @packed.setter + def packed(self, val): + self._packed = bool(val) + + def __len__(self): + assert self.elements is not None + return len(self.elements) + + def __iter__(self): + assert self.elements is not None + return iter(self.elements) + + @property + def is_opaque(self): + return self.elements is None + + def structure_repr(self): + """ + Return the LLVM IR for the structure representation + """ + ret = '{%s}' % ', '.join([str(x) for x in self.elements]) + return self._wrap_packed(ret) + + def format_constant(self, value): + itemstring = ", " .join(["{0} {1}".format(x.type, x.get_reference()) + for x in value]) + ret = "{{{0}}}".format(itemstring) + return self._wrap_packed(ret) + + def gep(self, i): + """ + Resolve the type of the i-th element (for getelementptr lookups). + + *i* needs to be a LLVM constant, so that the type can be determined + at compile-time. + """ + if not isinstance(i.type, IntType): + raise TypeError(i.type) + return self.elements[i.constant] + + def _wrap_packed(self, textrepr): + """ + Internal helper to wrap textual repr of struct type into packed struct + """ + if self.packed: + return '<{}>'.format(textrepr) + else: + return textrepr + + @classmethod + def from_llvm(cls, typeref, ir_ctx): + """ + Create from a llvmlite.binding.TypeRef + """ + if typeref.is_literal_struct: + elems = [el.as_ir(ir_ctx=ir_ctx) for el in typeref.elements] + return cls(elems, typeref.is_packed_struct) + else: + return ir_ctx.get_identified_type(typeref.name) + + +class LiteralStructType(BaseStructType): + """ + The type of "literal" structs, i.e. structs with a literally-defined + type (by contrast with IdentifiedStructType). + """ + + null = 'zeroinitializer' + + def __init__(self, elems, packed=False): + """ + *elems* is a sequence of types to be used as members. + *packed* controls the use of packed layout. + """ + self.elements = tuple(elems) + self.packed = packed + + def _to_string(self): + return self.structure_repr() + + def __eq__(self, other): + if isinstance(other, LiteralStructType): + return (self.elements == other.elements + and self.packed == other.packed) + + def __hash__(self): + return hash(LiteralStructType) + + +class IdentifiedStructType(BaseStructType): + """ + A type which is a named alias for another struct type, akin to a typedef. + While literal struct types can be structurally equal (see + LiteralStructType), identified struct types are compared by name. + + Do not use this directly. + """ + null = 'zeroinitializer' + + def __init__(self, context, name, packed=False): + """ + *context* is a llvmlite.ir.Context. + *name* is the identifier for the new struct type. + *packed* controls the use of packed layout. + """ + assert name + self.context = context + self.name = name + self.elements = None + self.packed = packed + + def _to_string(self): + return "%{name}".format(name=_wrapname(self.name)) + + def get_declaration(self): + """ + Returns the string for the declaration of the type + """ + if self.is_opaque: + out = "{strrep} = type opaque".format(strrep=str(self)) + else: + out = "{strrep} = type {struct}".format( + strrep=str(self), struct=self.structure_repr()) + return out + + def __eq__(self, other): + if isinstance(other, IdentifiedStructType): + return (self.name == other.name + and self.packed == other.packed) + + def __hash__(self): + return hash(IdentifiedStructType) + + def set_body(self, *elems): + if not self.is_opaque: + raise RuntimeError("{name} is already defined".format( + name=self.name)) + self.elements = tuple(elems) diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/values.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/values.py new file mode 100644 index 0000000000000000000000000000000000000000..7807eef6bc20708b6e770b670ac247bc6c8f7fa5 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/ir/values.py @@ -0,0 +1,1217 @@ +""" +Classes that are LLVM values: Value, Constant... +Instructions are in the instructions module. +""" + +import functools +import string +import re +from types import MappingProxyType + +from llvmlite.ir import values, types, _utils +from llvmlite.ir._utils import (_StrCaching, _StringReferenceCaching, + _HasMetadata) + +_VALID_CHARS = (frozenset(map(ord, string.ascii_letters)) | + frozenset(map(ord, string.digits)) | + frozenset(map(ord, ' !#$%&\'()*+,-./:;<=>?@[]^_`{|}~'))) + +_SIMPLE_IDENTIFIER_RE = re.compile(r"[-a-zA-Z$._][-a-zA-Z$._0-9]*$") + +_CMP_MAP = { + '>': 'gt', + '<': 'lt', + '==': 'eq', + '!=': 'ne', + '>=': 'ge', + '<=': 'le', +} + + +def _escape_string(text, _map={}): + """ + Escape the given bytestring for safe use as a LLVM array constant. + Any unicode string input is first encoded with utf8 into bytes. + """ + if isinstance(text, str): + text = text.encode() + assert isinstance(text, (bytes, bytearray)) + + if not _map: + for ch in range(256): + if ch in _VALID_CHARS: + _map[ch] = chr(ch) + else: + _map[ch] = '\\%02x' % ch + + buf = [_map[ch] for ch in text] + return ''.join(buf) + + +def _binop(opname): + def wrap(fn): + @functools.wraps(fn) + def wrapped(lhs, rhs): + if lhs.type != rhs.type: + raise ValueError("Operands must be the same type, got (%s, %s)" + % (lhs.type, rhs.type)) + + fmt = "{0} ({1} {2}, {3} {4})".format(opname, + lhs.type, lhs.get_reference(), + rhs.type, rhs.get_reference()) + return FormattedConstant(lhs.type, fmt) + + return wrapped + return wrap + + +def _castop(opname): + def wrap(fn): + @functools.wraps(fn) + def wrapped(self, typ): + fn(self, typ) + if typ == self.type: + return self + + op = "{0} ({1} {2} to {3})".format(opname, self.type, + self.get_reference(), typ) + return FormattedConstant(typ, op) + + return wrapped + return wrap + + +class _ConstOpMixin(object): + """ + A mixin defining constant operations, for use in constant-like classes. + """ + + # + # Arithmetic APIs + # + + @_binop('shl') + def shl(self, other): + """ + Left integer shift: + lhs << rhs + """ + + @_binop('lshr') + def lshr(self, other): + """ + Logical (unsigned) right integer shift: + lhs >> rhs + """ + + @_binop('ashr') + def ashr(self, other): + """ + Arithmetic (signed) right integer shift: + lhs >> rhs + """ + + @_binop('add') + def add(self, other): + """ + Integer addition: + lhs + rhs + """ + + @_binop('fadd') + def fadd(self, other): + """ + Floating-point addition: + lhs + rhs + """ + + @_binop('sub') + def sub(self, other): + """ + Integer subtraction: + lhs - rhs + """ + + @_binop('fsub') + def fsub(self, other): + """ + Floating-point subtraction: + lhs - rhs + """ + + @_binop('mul') + def mul(self, other): + """ + Integer multiplication: + lhs * rhs + """ + + @_binop('fmul') + def fmul(self, other): + """ + Floating-point multiplication: + lhs * rhs + """ + + @_binop('udiv') + def udiv(self, other): + """ + Unsigned integer division: + lhs / rhs + """ + + @_binop('sdiv') + def sdiv(self, other): + """ + Signed integer division: + lhs / rhs + """ + + @_binop('fdiv') + def fdiv(self, other): + """ + Floating-point division: + lhs / rhs + """ + + @_binop('urem') + def urem(self, other): + """ + Unsigned integer remainder: + lhs % rhs + """ + + @_binop('srem') + def srem(self, other): + """ + Signed integer remainder: + lhs % rhs + """ + + @_binop('frem') + def frem(self, other): + """ + Floating-point remainder: + lhs % rhs + """ + + @_binop('or') + def or_(self, other): + """ + Bitwise integer OR: + lhs | rhs + """ + + @_binop('and') + def and_(self, other): + """ + Bitwise integer AND: + lhs & rhs + """ + + @_binop('xor') + def xor(self, other): + """ + Bitwise integer XOR: + lhs ^ rhs + """ + + def _cmp(self, prefix, sign, cmpop, other): + ins = prefix + 'cmp' + try: + op = _CMP_MAP[cmpop] + except KeyError: + raise ValueError("invalid comparison %r for %s" % (cmpop, ins)) + + if not (prefix == 'i' and cmpop in ('==', '!=')): + op = sign + op + + if self.type != other.type: + raise ValueError("Operands must be the same type, got (%s, %s)" + % (self.type, other.type)) + + fmt = "{0} {1} ({2} {3}, {4} {5})".format( + ins, op, + self.type, self.get_reference(), + other.type, other.get_reference()) + + return FormattedConstant(types.IntType(1), fmt) + + def icmp_signed(self, cmpop, other): + """ + Signed integer comparison: + lhs rhs + + where cmpop can be '==', '!=', '<', '<=', '>', '>=' + """ + return self._cmp('i', 's', cmpop, other) + + def icmp_unsigned(self, cmpop, other): + """ + Unsigned integer (or pointer) comparison: + lhs rhs + + where cmpop can be '==', '!=', '<', '<=', '>', '>=' + """ + return self._cmp('i', 'u', cmpop, other) + + def fcmp_ordered(self, cmpop, other): + """ + Floating-point ordered comparison: + lhs rhs + + where cmpop can be '==', '!=', '<', '<=', '>', '>=', 'ord', 'uno' + """ + return self._cmp('f', 'o', cmpop, other) + + def fcmp_unordered(self, cmpop, other): + """ + Floating-point unordered comparison: + lhs rhs + + where cmpop can be '==', '!=', '<', '<=', '>', '>=', 'ord', 'uno' + """ + return self._cmp('f', 'u', cmpop, other) + + # + # Unary APIs + # + + def not_(self): + """ + Bitwise integer complement: + ~value + """ + if isinstance(self.type, types.VectorType): + rhs = values.Constant(self.type, (-1,) * self.type.count) + else: + rhs = values.Constant(self.type, -1) + + return self.xor(rhs) + + def neg(self): + """ + Integer negative: + -value + """ + zero = values.Constant(self.type, 0) + return zero.sub(self) + + def fneg(self): + """ + Floating-point negative: + -value + """ + fmt = "fneg ({0} {1})".format(self.type, self.get_reference()) + return FormattedConstant(self.type, fmt) + + # + # Cast APIs + # + + @_castop('trunc') + def trunc(self, typ): + """ + Truncating integer downcast to a smaller type. + """ + + @_castop('zext') + def zext(self, typ): + """ + Zero-extending integer upcast to a larger type + """ + + @_castop('sext') + def sext(self, typ): + """ + Sign-extending integer upcast to a larger type. + """ + + @_castop('fptrunc') + def fptrunc(self, typ): + """ + Floating-point downcast to a less precise type. + """ + + @_castop('fpext') + def fpext(self, typ): + """ + Floating-point upcast to a more precise type. + """ + + @_castop('bitcast') + def bitcast(self, typ): + """ + Pointer cast to a different pointer type. + """ + + @_castop('fptoui') + def fptoui(self, typ): + """ + Convert floating-point to unsigned integer. + """ + + @_castop('uitofp') + def uitofp(self, typ): + """ + Convert unsigned integer to floating-point. + """ + + @_castop('fptosi') + def fptosi(self, typ): + """ + Convert floating-point to signed integer. + """ + + @_castop('sitofp') + def sitofp(self, typ): + """ + Convert signed integer to floating-point. + """ + + @_castop('ptrtoint') + def ptrtoint(self, typ): + """ + Cast pointer to integer. + """ + if not isinstance(self.type, types.PointerType): + msg = "can only call ptrtoint() on pointer type, not '%s'" + raise TypeError(msg % (self.type,)) + if not isinstance(typ, types.IntType): + raise TypeError("can only ptrtoint() to integer type, not '%s'" + % (typ,)) + + @_castop('inttoptr') + def inttoptr(self, typ): + """ + Cast integer to pointer. + """ + if not isinstance(self.type, types.IntType): + msg = "can only call inttoptr() on integer constants, not '%s'" + raise TypeError(msg % (self.type,)) + if not isinstance(typ, types.PointerType): + raise TypeError("can only inttoptr() to pointer type, not '%s'" + % (typ,)) + + def gep(self, indices): + """ + Call getelementptr on this pointer constant. + """ + if not isinstance(self.type, types.PointerType): + raise TypeError("can only call gep() on pointer constants, not '%s'" + % (self.type,)) + + outtype = self.type + for i in indices: + outtype = outtype.gep(i) + + strindices = ["{0} {1}".format(idx.type, idx.get_reference()) + for idx in indices] + + op = "getelementptr ({0}, {1} {2}, {3})".format( + self.type.pointee, self.type, + self.get_reference(), ', '.join(strindices)) + return FormattedConstant(outtype.as_pointer(self.addrspace), op) + + +class Value(object): + """ + The base class for all values. + """ + + def __repr__(self): + return "" % (self.__class__.__name__, self.type,) + + +class _Undefined(object): + """ + 'undef': a value for undefined values. + """ + def __new__(cls): + try: + return Undefined + except NameError: + return object.__new__(_Undefined) + + +Undefined = _Undefined() + + +class Constant(_StrCaching, _StringReferenceCaching, _ConstOpMixin, Value): + """ + A constant LLVM value. + """ + + def __init__(self, typ, constant): + assert isinstance(typ, types.Type) + assert not isinstance(typ, types.VoidType) + self.type = typ + constant = typ.wrap_constant_value(constant) + self.constant = constant + + def _to_string(self): + return '{0} {1}'.format(self.type, self.get_reference()) + + def _get_reference(self): + if self.constant is None: + val = self.type.null + + elif self.constant is Undefined: + val = "undef" + + elif isinstance(self.constant, bytearray): + val = 'c"{0}"'.format(_escape_string(self.constant)) + + else: + val = self.type.format_constant(self.constant) + + return val + + @classmethod + def literal_array(cls, elems): + """ + Construct a literal array constant made of the given members. + """ + tys = [el.type for el in elems] + if len(tys) == 0: + raise ValueError("need at least one element") + ty = tys[0] + for other in tys: + if ty != other: + raise TypeError("all elements must have the same type") + return cls(types.ArrayType(ty, len(elems)), elems) + + @classmethod + def literal_struct(cls, elems, packed=False): + """ + Construct a literal structure constant made of the given members. + """ + tys = [el.type for el in elems] + return cls(types.LiteralStructType(tys, packed), elems) + + @property + def addrspace(self): + if not isinstance(self.type, types.PointerType): + raise TypeError("Only pointer constant have address spaces") + return self.type.addrspace + + def __eq__(self, other): + if isinstance(other, Constant): + return str(self) == str(other) + else: + return False + + def __ne__(self, other): + return not self.__eq__(other) + + def __hash__(self): + return hash(str(self)) + + def __repr__(self): + return "" % (self.type, self.constant) + + +class FormattedConstant(Constant): + """ + A constant with an already formatted IR representation. + """ + + def __init__(self, typ, constant): + assert isinstance(constant, str) + Constant.__init__(self, typ, constant) + + def _to_string(self): + return self.constant + + def _get_reference(self): + return self.constant + + +class NamedValue(_StrCaching, _StringReferenceCaching, Value): + """ + The base class for named values. + """ + name_prefix = '%' + deduplicate_name = True + + def __init__(self, parent, type, name): + assert parent is not None + assert isinstance(type, types.Type) + self.parent = parent + self.type = type + self._set_name(name) + + def _to_string(self): + buf = [] + if not isinstance(self.type, types.VoidType): + buf.append("{0} = ".format(self.get_reference())) + self.descr(buf) + return "".join(buf).rstrip() + + def descr(self, buf): + raise NotImplementedError + + def _get_name(self): + return self._name + + def _set_name(self, name): + name = self.parent.scope.register(name, + deduplicate=self.deduplicate_name) + self._name = name + + name = property(_get_name, _set_name) + + def _get_reference(self): + name = self.name + # Quote and escape value name + if '\\' in name or '"' in name: + name = name.replace('\\', '\\5c').replace('"', '\\22') + return '{0}"{1}"'.format(self.name_prefix, name) + + def __repr__(self): + return "" % ( + self.__class__.__name__, self.name, self.type) + + @property + def function_type(self): + ty = self.type + if isinstance(ty, types.PointerType): + ty = self.type.pointee + if isinstance(ty, types.FunctionType): + return ty + else: + raise TypeError("Not a function: {0}".format(self.type)) + + +class MetaDataString(NamedValue): + """ + A metadata string, i.e. a constant string used as a value in a metadata + node. + """ + + def __init__(self, parent, string): + super(MetaDataString, self).__init__(parent, + types.MetaDataType(), + name="") + self.string = string + + def descr(self, buf): + buf += (self.get_reference(), "\n") + + def _get_reference(self): + return '!"{0}"'.format(_escape_string(self.string)) + + _to_string = _get_reference + + def __eq__(self, other): + if isinstance(other, MetaDataString): + return self.string == other.string + else: + return False + + def __ne__(self, other): + return not self.__eq__(other) + + def __hash__(self): + return hash(self.string) + + +class MetaDataArgument(_StrCaching, _StringReferenceCaching, Value): + """ + An argument value to a function taking metadata arguments. + This can wrap any other kind of LLVM value. + + Do not instantiate directly, Builder.call() will create these + automatically. + """ + + def __init__(self, value): + assert isinstance(value, Value) + assert not isinstance(value.type, types.MetaDataType) + self.type = types.MetaDataType() + self.wrapped_value = value + + def _get_reference(self): + # e.g. "i32* %2" + return "{0} {1}".format(self.wrapped_value.type, + self.wrapped_value.get_reference()) + + _to_string = _get_reference + + +class NamedMetaData(object): + """ + A named metadata node. + + Do not instantiate directly, use Module.add_named_metadata() instead. + """ + + def __init__(self, parent): + self.parent = parent + self.operands = [] + + def add(self, md): + self.operands.append(md) + + +class MDValue(NamedValue): + """ + A metadata node's value, consisting of a sequence of elements ("operands"). + + Do not instantiate directly, use Module.add_metadata() instead. + """ + name_prefix = '!' + + def __init__(self, parent, values, name): + super(MDValue, self).__init__(parent, + types.MetaDataType(), + name=name) + self.operands = tuple(values) + parent.metadata.append(self) + + def descr(self, buf): + operands = [] + for op in self.operands: + if isinstance(op.type, types.MetaDataType): + if isinstance(op, Constant) and op.constant is None: + operands.append("null") + else: + operands.append(op.get_reference()) + else: + operands.append("{0} {1}".format(op.type, op.get_reference())) + operands = ', '.join(operands) + buf += ("!{{ {0} }}".format(operands), "\n") + + def _get_reference(self): + return self.name_prefix + str(self.name) + + def __eq__(self, other): + if isinstance(other, MDValue): + return self.operands == other.operands + else: + return False + + def __ne__(self, other): + return not self.__eq__(other) + + def __hash__(self): + return hash(self.operands) + + +class DIToken: + """ + A debug information enumeration value that should appear bare in + the emitted metadata. + + Use this to wrap known constants, e.g. the DW_* enumerations. + """ + + def __init__(self, value): + self.value = value + + +class DIValue(NamedValue): + """ + A debug information descriptor, containing key-value pairs. + + Do not instantiate directly, use Module.add_debug_info() instead. + """ + name_prefix = '!' + + def __init__(self, parent, is_distinct, kind, operands, name): + super(DIValue, self).__init__(parent, + types.MetaDataType(), + name=name) + self.is_distinct = is_distinct + self.kind = kind + self.operands = tuple(operands) + parent.metadata.append(self) + + def descr(self, buf): + if self.is_distinct: + buf += ("distinct ",) + operands = [] + for key, value in self.operands: + if value is None: + strvalue = "null" + elif value is True: + strvalue = "true" + elif value is False: + strvalue = "false" + elif isinstance(value, DIToken): + strvalue = value.value + elif isinstance(value, str): + strvalue = '"{}"'.format(_escape_string(value)) + elif isinstance(value, int): + strvalue = str(value) + elif isinstance(value, NamedValue): + strvalue = value.get_reference() + else: + raise TypeError("invalid operand type for debug info: %r" + % (value,)) + operands.append("{0}: {1}".format(key, strvalue)) + operands = ', '.join(operands) + buf += ("!", self.kind, "(", operands, ")\n") + + def _get_reference(self): + return self.name_prefix + str(self.name) + + def __eq__(self, other): + if isinstance(other, DIValue): + return self.is_distinct == other.is_distinct and \ + self.kind == other.kind and \ + self.operands == other.operands + else: + return False + + def __ne__(self, other): + return not self.__eq__(other) + + def __hash__(self): + return hash((self.is_distinct, self.kind, self.operands)) + + +class GlobalValue(NamedValue, _ConstOpMixin, _HasMetadata): + """ + A global value. + """ + name_prefix = '@' + deduplicate_name = False + + def __init__(self, *args, **kwargs): + super(GlobalValue, self).__init__(*args, **kwargs) + self.linkage = '' + self.storage_class = '' + self.section = '' + self.metadata = {} + + +class GlobalVariable(GlobalValue): + """ + A global variable. + """ + + def __init__(self, module, typ, name, addrspace=0): + assert isinstance(typ, types.Type) + super(GlobalVariable, self).__init__(module, typ.as_pointer(addrspace), + name=name) + self.value_type = typ + self.initializer = None + self.unnamed_addr = False + self.global_constant = False + self.addrspace = addrspace + self.align = None + self.parent.add_global(self) + + def descr(self, buf): + if self.global_constant: + kind = 'constant' + else: + kind = 'global' + + if not self.linkage: + # Default to external linkage + linkage = 'external' if self.initializer is None else '' + else: + linkage = self.linkage + + if linkage: + buf.append(linkage + " ") + if self.storage_class: + buf.append(self.storage_class + " ") + if self.unnamed_addr: + buf.append("unnamed_addr ") + if self.addrspace != 0: + buf.append('addrspace({0:d}) '.format(self.addrspace)) + + buf.append("{kind} {type}" .format(kind=kind, type=self.value_type)) + + if self.initializer is not None: + if self.initializer.type != self.value_type: + raise TypeError("got initializer of type %s " + "for global value type %s" + % (self.initializer.type, self.value_type)) + buf.append(" " + self.initializer.get_reference()) + elif linkage not in ('external', 'extern_weak'): + # emit 'undef' for non-external linkage GV + buf.append(" " + self.value_type(Undefined).get_reference()) + + if self.section: + buf.append(", section \"%s\"" % (self.section,)) + + if self.align is not None: + buf.append(", align %d" % (self.align,)) + + if self.metadata: + buf.append(self._stringify_metadata(leading_comma=True)) + + buf.append("\n") + + +class AttributeSet(set): + """A set of string attribute. + Only accept items listed in *_known*. + + Properties: + * Iterate in sorted order + """ + _known = () + + def __init__(self, args=()): + super().__init__() + if isinstance(args, str): + args = [args] + for name in args: + self.add(name) + + def _expand(self, name, typ): + return name + + def add(self, name): + if name not in self._known: + raise ValueError('unknown attr {!r} for {}'.format(name, self)) + return super(AttributeSet, self).add(name) + + def _to_list(self, typ): + return [self._expand(i, typ) for i in sorted(self)] + + +class FunctionAttributes(AttributeSet): + _known = frozenset([ + 'argmemonly', 'alwaysinline', 'builtin', 'cold', 'convergent', + 'inaccessiblememonly', 'inaccessiblemem_or_argmemonly', 'inlinehint', + 'jumptable', 'minsize', 'naked', 'nobuiltin', 'noduplicate', + 'noimplicitfloat', 'noinline', 'nonlazybind', 'norecurse', + 'noredzone', 'noreturn', 'nounwind', 'optnone', 'optsize', + 'readnone', 'readonly', 'returns_twice', 'sanitize_address', + 'sanitize_memory', 'sanitize_thread', 'ssp', + 'sspreg', 'sspstrong', 'uwtable']) + + def __init__(self, args=()): + self._alignstack = 0 + self._personality = None + super(FunctionAttributes, self).__init__(args) + + def add(self, name): + if ((name == 'alwaysinline' and 'noinline' in self) or + (name == 'noinline' and 'alwaysinline' in self)): + raise ValueError("Can't have alwaysinline and noinline") + + super().add(name) + + @property + def alignstack(self): + return self._alignstack + + @alignstack.setter + def alignstack(self, val): + assert val >= 0 + self._alignstack = val + + @property + def personality(self): + return self._personality + + @personality.setter + def personality(self, val): + assert val is None or isinstance(val, GlobalValue) + self._personality = val + + def _to_list(self, ret_type): + attrs = super()._to_list(ret_type) + if self.alignstack: + attrs.append('alignstack({0:d})'.format(self.alignstack)) + if self.personality: + attrs.append('personality {persty} {persfn}'.format( + persty=self.personality.type, + persfn=self.personality.get_reference())) + return attrs + + +class Function(GlobalValue): + """Represent a LLVM Function but does uses a Module as parent. + Global Values are stored as a set of dependencies (attribute `depends`). + """ + + def __init__(self, module, ftype, name): + assert isinstance(ftype, types.Type) + super(Function, self).__init__(module, ftype.as_pointer(), name=name) + self.ftype = ftype + self.scope = _utils.NameScope() + self.blocks = [] + self.attributes = FunctionAttributes() + self.args = tuple([Argument(self, t) + for t in ftype.args]) + self.return_value = ReturnValue(self, ftype.return_type) + self.parent.add_global(self) + self.calling_convention = '' + + @property + def module(self): + return self.parent + + @property + def entry_basic_block(self): + return self.blocks[0] + + @property + def basic_blocks(self): + return self.blocks + + def append_basic_block(self, name=''): + blk = Block(parent=self, name=name) + self.blocks.append(blk) + return blk + + def insert_basic_block(self, before, name=''): + """Insert block before + """ + blk = Block(parent=self, name=name) + self.blocks.insert(before, blk) + return blk + + def descr_prototype(self, buf): + """ + Describe the prototype ("head") of the function. + """ + state = "define" if self.blocks else "declare" + ret = self.return_value + args = ", ".join(str(a) for a in self.args) + name = self.get_reference() + attrs = ' ' + ' '.join(self.attributes._to_list( + self.ftype.return_type)) if self.attributes else '' + if any(self.args): + vararg = ', ...' if self.ftype.var_arg else '' + else: + vararg = '...' if self.ftype.var_arg else '' + linkage = self.linkage + cconv = self.calling_convention + prefix = " ".join(str(x) for x in [state, linkage, cconv, ret] if x) + metadata = self._stringify_metadata() + metadata = ' {}'.format(metadata) if metadata else '' + section = ' section "{}"'.format(self.section) if self.section else '' + pt_str = "{prefix} {name}({args}{vararg}){attrs}{section}{metadata}\n" + prototype = pt_str.format(prefix=prefix, name=name, args=args, + vararg=vararg, attrs=attrs, section=section, + metadata=metadata) + buf.append(prototype) + + def descr_body(self, buf): + """ + Describe of the body of the function. + """ + for blk in self.blocks: + blk.descr(buf) + + def descr(self, buf): + self.descr_prototype(buf) + if self.blocks: + buf.append("{\n") + self.descr_body(buf) + buf.append("}\n") + + def __str__(self): + buf = [] + self.descr(buf) + return "".join(buf) + + @property + def is_declaration(self): + return len(self.blocks) == 0 + + +class ArgumentAttributes(AttributeSet): + # List from + # https://releases.llvm.org/14.0.0/docs/LangRef.html#parameter-attributes + _known = MappingProxyType({ + # True (emit type), + # False (emit name only) + 'byref': True, + 'byval': True, + 'elementtype': True, + 'immarg': False, + 'inalloca': True, + 'inreg': False, + 'nest': False, + 'noalias': False, + 'nocapture': False, + 'nofree': False, + 'nonnull': False, + 'noundef': False, + 'preallocated': True, + 'returned': False, + 'signext': False, + 'sret': True, + 'swiftasync': False, + 'swifterror': False, + 'swiftself': False, + 'zeroext': False, + }) + + def __init__(self, args=()): + self._align = 0 + self._dereferenceable = 0 + self._dereferenceable_or_null = 0 + super(ArgumentAttributes, self).__init__(args) + + def _expand(self, name, typ): + requires_type = self._known.get(name) + if requires_type: + return f"{name}({typ.pointee})" + else: + return name + + @property + def align(self): + return self._align + + @align.setter + def align(self, val): + assert isinstance(val, int) and val >= 0 + self._align = val + + @property + def dereferenceable(self): + return self._dereferenceable + + @dereferenceable.setter + def dereferenceable(self, val): + assert isinstance(val, int) and val >= 0 + self._dereferenceable = val + + @property + def dereferenceable_or_null(self): + return self._dereferenceable_or_null + + @dereferenceable_or_null.setter + def dereferenceable_or_null(self, val): + assert isinstance(val, int) and val >= 0 + self._dereferenceable_or_null = val + + def _to_list(self, typ): + attrs = super()._to_list(typ) + if self.align: + attrs.append('align {0:d}'.format(self.align)) + if self.dereferenceable: + attrs.append('dereferenceable({0:d})'.format(self.dereferenceable)) + if self.dereferenceable_or_null: + dref = 'dereferenceable_or_null({0:d})' + attrs.append(dref.format(self.dereferenceable_or_null)) + return attrs + + +class _BaseArgument(NamedValue): + def __init__(self, parent, typ, name=''): + assert isinstance(typ, types.Type) + super(_BaseArgument, self).__init__(parent, typ, name=name) + self.parent = parent + self.attributes = ArgumentAttributes() + + def __repr__(self): + return "" % (self.__class__.__name__, self.name, + self.type) + + def add_attribute(self, attr): + self.attributes.add(attr) + + +class Argument(_BaseArgument): + """ + The specification of a function argument. + """ + + def __str__(self): + attrs = self.attributes._to_list(self.type) + if attrs: + return "{0} {1} {2}".format(self.type, ' '.join(attrs), + self.get_reference()) + else: + return "{0} {1}".format(self.type, self.get_reference()) + + +class ReturnValue(_BaseArgument): + """ + The specification of a function's return value. + """ + + def __str__(self): + attrs = self.attributes._to_list(self.type) + if attrs: + return "{0} {1}".format(' '.join(attrs), self.type) + else: + return str(self.type) + + +class Block(NamedValue): + """ + A LLVM IR basic block. A basic block is a sequence of + instructions whose execution always goes from start to end. That + is, a control flow instruction (branch) can only appear as the + last instruction, and incoming branches can only jump to the first + instruction. + """ + + def __init__(self, parent, name=''): + super(Block, self).__init__(parent, types.LabelType(), name=name) + self.scope = parent.scope + self.instructions = [] + self.terminator = None + + @property + def is_terminated(self): + return self.terminator is not None + + @property + def function(self): + return self.parent + + @property + def module(self): + return self.parent.module + + def descr(self, buf): + buf.append("{0}:\n".format(self._format_name())) + buf += [" {0}\n".format(instr) for instr in self.instructions] + + def replace(self, old, new): + """Replace an instruction""" + if old.type != new.type: + raise TypeError("new instruction has a different type") + pos = self.instructions.index(old) + self.instructions.remove(old) + self.instructions.insert(pos, new) + + for bb in self.parent.basic_blocks: + for instr in bb.instructions: + instr.replace_usage(old, new) + + def _format_name(self): + # Per the LLVM Language Ref on identifiers, names matching the following + # regex do not need to be quoted: [%@][-a-zA-Z$._][-a-zA-Z$._0-9]* + # Otherwise, the identifier must be quoted and escaped. + name = self.name + if not _SIMPLE_IDENTIFIER_RE.match(name): + name = name.replace('\\', '\\5c').replace('"', '\\22') + name = '"{0}"'.format(name) + return name + + +class BlockAddress(Value): + """ + The address of a basic block. + """ + + def __init__(self, function, basic_block): + assert isinstance(function, Function) + assert isinstance(basic_block, Block) + self.type = types.IntType(8).as_pointer() + self.function = function + self.basic_block = basic_block + + def __str__(self): + return '{0} {1}'.format(self.type, self.get_reference()) + + def get_reference(self): + return "blockaddress({0}, {1})".format( + self.function.get_reference(), + self.basic_block.get_reference()) diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__init__.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..7f2b3b082d2722e587263fb4ce5307287715a1d5 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__init__.py @@ -0,0 +1,57 @@ +import sys + +import unittest +from unittest import TestCase + +import faulthandler + + +try: + # May fail in IPython Notebook with UnsupportedOperation + faulthandler.enable() +except BaseException as e: + msg = "Failed to enable faulthandler due to:\n{err}" + warnings.warn(msg.format(err=e)) + + +# Try to inject Numba's unittest customizations. +from llvmlite.tests import customize + + +def discover_tests(startdir): + """Discover test under a directory + """ + # Avoid importing unittest + loader = unittest.TestLoader() + suite = loader.discover(startdir) + return suite + + +def run_tests(suite=None, xmloutput=None, verbosity=1): + """ + args + ---- + - suite [TestSuite] + A suite of all tests to run + - xmloutput [str or None] + Path of XML output directory (optional) + - verbosity [int] + Verbosity level of tests output + + Returns the TestResult object after running the test *suite*. + """ + if suite is None: + suite = discover_tests("llvmlite.tests") + if xmloutput is not None: + import xmlrunner + runner = xmlrunner.XMLTestRunner(output=xmloutput) + else: + runner = None + prog = unittest.main(suite=suite, testRunner=runner, exit=False, + verbosity=verbosity) + return prog.result + + +def main(): + res = run_tests() + sys.exit(0 if res.wasSuccessful() else 1) diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__main__.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__main__.py new file mode 100644 index 0000000000000000000000000000000000000000..97563d18687da90316eef738c8aa3ffbacec4007 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__main__.py @@ -0,0 +1,3 @@ +from llvmlite.tests import main + +main() diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..a8cdbd2d29f55797015c96a349091eaa6757df5a Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/__main__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/__main__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..48c887e1b5394e6ad5248d530e1e64143b3cc2a0 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/__main__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/customize.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/customize.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..3ffa11dac2e005ac88702939c16367651e26b9bc Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/customize.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/refprune_proto.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/refprune_proto.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..1ce1616dfbdea344fe42f5da47168e15f6d98c61 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/refprune_proto.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_binding.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_binding.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..ad93e4f96eb4b1f51fa5b23e2c5809df35eed1ab --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_binding.cpython-312.pyc @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e53e6d68ac4f81bcf2b14a7ab83bef87a4afdf61b49f06ebc8b59c31cf35a15 +size 179930 diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_ir.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_ir.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..d3980de5fd83f927e56a957d7610a313a6bf20e6 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_ir.cpython-312.pyc @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5f7325a80ddbdb4a02b662e9b133231f03694f2da6f46a1a7878e7302e866c9 +size 185478 diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_refprune.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_refprune.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..5944ef8aba0865902d45a1711374cb67eb2848c0 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_refprune.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_valuerepr.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_valuerepr.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..00afc2515b0bf401d64b7f76c6389b998c8bfdb0 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/__pycache__/test_valuerepr.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/customize.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/customize.py new file mode 100644 index 0000000000000000000000000000000000000000..7d747a3ca4343a7cb94911fa1283dbfbc35e0577 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/customize.py @@ -0,0 +1,407 @@ +# XXX Ripped off from numba.tests; we should factor it out somewhere? + +import collections +import contextlib +import cProfile +from io import StringIO +import gc +import os +import multiprocessing +import sys +import time +import unittest +import warnings +from unittest import result, runner, signals + + +# "unittest.main" is really the TestProgram class! +# (defined in a module named itself "unittest.main"...) + +class NumbaTestProgram(unittest.main): + """ + A TestProgram subclass adding the following options: + * a -R option to enable reference leak detection + * a --profile option to enable profiling of the test run + + Currently the options are only added in 3.4+. + """ + + refleak = False + profile = False + multiprocess = False + + def __init__(self, *args, **kwargs): + self.discovered_suite = kwargs.pop('suite', None) + # HACK to force unittest not to change warning display options + # (so that NumbaWarnings don't appear all over the place) + sys.warnoptions.append(':x') + super(NumbaTestProgram, self).__init__(*args, **kwargs) + + def createTests(self): + if self.discovered_suite is not None: + self.test = self.discovered_suite + else: + super(NumbaTestProgram, self).createTests() + + def _getParentArgParser(self): + # NOTE: this hook only exists on Python 3.4+. The options won't be + # added in earlier versions (which use optparse - 3.3 - or getopt() + # - 2.x). + parser = super(NumbaTestProgram, self)._getParentArgParser() + if self.testRunner is None: + parser.add_argument('-R', '--refleak', dest='refleak', + action='store_true', + help='Detect reference / memory leaks') + parser.add_argument('-m', '--multiprocess', dest='multiprocess', + action='store_true', + help='Parallelize tests') + parser.add_argument('--profile', dest='profile', + action='store_true', + help='Profile the test run') + return parser + + def parseArgs(self, argv): + if sys.version_info < (3, 4): + # We want these options to work on all versions, emulate them. + if '-R' in argv: + argv.remove('-R') + self.refleak = True + if '-m' in argv: + argv.remove('-m') + self.multiprocess = True + super(NumbaTestProgram, self).parseArgs(argv) + if self.verbosity <= 0: + # We aren't interested in informational messages / warnings when + # running with '-q'. + self.buffer = True + + def runTests(self): + if self.refleak: + self.testRunner = RefleakTestRunner + + if not hasattr(sys, "gettotalrefcount"): + warnings.warn("detecting reference leaks requires a debug " + "build of Python, only memory leaks will be " + "detected") + + elif self.testRunner is None: + self.testRunner = unittest.TextTestRunner + + if self.multiprocess: + self.testRunner = ParallelTestRunner(self.testRunner, + verbosity=self.verbosity, + failfast=self.failfast, + buffer=self.buffer) + + def run_tests_real(): + super(NumbaTestProgram, self).runTests() + + if self.profile: + filename = os.path.splitext( + os.path.basename(sys.modules['__main__'].__file__) + )[0] + '.prof' + p = cProfile.Profile(timer=time.perf_counter) # 3.3+ + p.enable() + try: + p.runcall(run_tests_real) + finally: + p.disable() + print("Writing test profile data into %r" % (filename,)) + p.dump_stats(filename) + else: + run_tests_real() + + +# Monkey-patch unittest so that individual test modules get our custom +# options for free. +unittest.main = NumbaTestProgram + + +# The reference leak detection code is liberally taken and adapted from +# Python's own Lib/test/regrtest.py. + +def _refleak_cleanup(): + # Collect cyclic trash and read memory statistics immediately after. + try: + func1 = sys.getallocatedblocks + except AttributeError: + def func1(): + return 42 + try: + func2 = sys.gettotalrefcount + except AttributeError: + def func2(): + return 42 + + # Flush standard output, so that buffered data is sent to the OS and + # associated Python objects are reclaimed. + for stream in (sys.stdout, sys.stderr, sys.__stdout__, sys.__stderr__): + if stream is not None: + stream.flush() + + sys._clear_type_cache() + # This also clears the various internal CPython freelists. + gc.collect() + return func1(), func2() + + +class ReferenceLeakError(RuntimeError): + pass + + +class IntPool(collections.defaultdict): + + def __missing__(self, key): + return key + + +class RefleakTestResult(runner.TextTestResult): + + warmup = 3 + repetitions = 6 + + def _huntLeaks(self, test): + self.stream.flush() + + repcount = self.repetitions + nwarmup = self.warmup + rc_deltas = [0] * (repcount - nwarmup) + alloc_deltas = [0] * (repcount - nwarmup) + # Preallocate ints likely to be stored in rc_deltas and alloc_deltas, + # to make sys.getallocatedblocks() less flaky. + _int_pool = IntPool() + for i in range(-200, 200): + _int_pool[i] + + alloc_before = rc_before = 0 + for i in range(repcount): + # Use a pristine, silent result object to avoid recursion + res = result.TestResult() + test.run(res) + # Poorly-written tests may fail when run several times. + # In this case, abort the refleak run and report the failure. + if not res.wasSuccessful(): + self.failures.extend(res.failures) + self.errors.extend(res.errors) + raise AssertionError + del res + alloc_after, rc_after = _refleak_cleanup() + if i >= nwarmup: + rc_deltas[i - nwarmup] = _int_pool[rc_after - rc_before] + alloc_deltas[i - + nwarmup] = _int_pool[alloc_after - + alloc_before] + alloc_before, rc_before = alloc_after, rc_after + return rc_deltas, alloc_deltas + + def addSuccess(self, test): + try: + rc_deltas, alloc_deltas = self._huntLeaks(test) + except AssertionError: + # Test failed when repeated + assert not self.wasSuccessful() + return + + # These checkers return False on success, True on failure + def check_rc_deltas(deltas): + return any(deltas) + + def check_alloc_deltas(deltas): + # At least 1/3rd of 0s + if 3 * deltas.count(0) < len(deltas): + return True + # Nothing else than 1s, 0s and -1s + if not set(deltas) <= set((1, 0, -1)): + return True + return False + + failed = False + + for deltas, item_name, checker in [ + (rc_deltas, 'references', check_rc_deltas), + (alloc_deltas, 'memory blocks', check_alloc_deltas)]: + if checker(deltas): + msg = '%s leaked %s %s, sum=%s' % ( + test, deltas, item_name, sum(deltas)) + failed = True + try: + raise ReferenceLeakError(msg) + except Exception: + exc_info = sys.exc_info() + if self.showAll: + self.stream.write("%s = %r " % (item_name, deltas)) + self.addFailure(test, exc_info) + + if not failed: + super(RefleakTestResult, self).addSuccess(test) + + +class RefleakTestRunner(runner.TextTestRunner): + resultclass = RefleakTestResult + + +def _flatten_suite(test): + """Expand suite into list of tests + """ + if isinstance(test, unittest.TestSuite): + tests = [] + for x in test: + tests.extend(_flatten_suite(x)) + return tests + else: + return [test] + + +class ParallelTestResult(runner.TextTestResult): + """ + A TestResult able to inject results from other results. + """ + + def add_results(self, result): + """ + Add the results from the other *result* to this result. + """ + self.stream.write(result.stream.getvalue()) + self.stream.flush() + self.testsRun += result.testsRun + self.failures.extend(result.failures) + self.errors.extend(result.errors) + self.skipped.extend(result.skipped) + self.expectedFailures.extend(result.expectedFailures) + self.unexpectedSuccesses.extend(result.unexpectedSuccesses) + + +class _MinimalResult(object): + """ + A minimal, picklable TestResult-alike object. + """ + + __slots__ = ( + 'failures', 'errors', 'skipped', 'expectedFailures', + 'unexpectedSuccesses', 'stream', 'shouldStop', 'testsRun') + + def fixup_case(self, case): + """ + Remove any unpicklable attributes from TestCase instance *case*. + """ + # Python 3.3 doesn't reset this one. + case._outcomeForDoCleanups = None + + def __init__(self, original_result): + for attr in self.__slots__: + setattr(self, attr, getattr(original_result, attr)) + for case, _ in self.expectedFailures: + self.fixup_case(case) + for case, _ in self.errors: + self.fixup_case(case) + for case, _ in self.failures: + self.fixup_case(case) + + +class _FakeStringIO(object): + """ + A trivial picklable StringIO-alike for Python 2. + """ + + def __init__(self, value): + self._value = value + + def getvalue(self): + return self._value + + +class _MinimalRunner(object): + """ + A minimal picklable object able to instantiate a runner in a + child process and run a test case with it. + """ + + def __init__(self, runner_cls, runner_args): + self.runner_cls = runner_cls + self.runner_args = runner_args + + # Python 2 doesn't know how to pickle instance methods, so we use __call__ + # instead. + + def __call__(self, test): + # Executed in child process + kwargs = self.runner_args + # Force recording of output in a buffer (it will be printed out + # by the parent). + kwargs['stream'] = StringIO() + runner = self.runner_cls(**kwargs) + result = runner._makeResult() + # Avoid child tracebacks when Ctrl-C is pressed. + signals.installHandler() + signals.registerResult(result) + result.failfast = runner.failfast + result.buffer = runner.buffer + with self.cleanup_object(test): + test(result) + # HACK as cStringIO.StringIO isn't picklable in 2.x + result.stream = _FakeStringIO(result.stream.getvalue()) + return _MinimalResult(result) + + @contextlib.contextmanager + def cleanup_object(self, test): + """ + A context manager which cleans up unwanted attributes on a test case + (or any other object). + """ + vanilla_attrs = set(test.__dict__) + try: + yield test + finally: + spurious_attrs = set(test.__dict__) - vanilla_attrs + for name in spurious_attrs: + del test.__dict__[name] + + +class ParallelTestRunner(runner.TextTestRunner): + """ + A test runner which delegates the actual running to a pool of child + processes. + """ + + resultclass = ParallelTestResult + + def __init__(self, runner_cls, **kwargs): + runner.TextTestRunner.__init__(self, **kwargs) + self.runner_cls = runner_cls + self.runner_args = kwargs + + def _run_inner(self, result): + # We hijack TextTestRunner.run()'s inner logic by passing this + # method as if it were a test case. + child_runner = _MinimalRunner(self.runner_cls, self.runner_args) + pool = multiprocessing.Pool() + imap = pool.imap_unordered + try: + for child_result in imap(child_runner, self._test_list): + result.add_results(child_result) + if child_result.shouldStop: + break + return result + finally: + # Kill the still active workers + pool.terminate() + pool.join() + + def run(self, test): + self._test_list = _flatten_suite(test) + # This will call self._run_inner() on the created result object, + # and print out the detailed test results at the end. + return super(ParallelTestRunner, self).run(self._run_inner) + + +try: + import faulthandler +except ImportError: + pass +else: + try: + # May fail in IPython Notebook with UnsupportedOperation + faulthandler.enable() + except BaseException as e: + msg = "Failed to enable faulthandler due to:\n{err}" + warnings.warn(msg.format(err=e)) diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/refprune_proto.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/refprune_proto.py new file mode 100644 index 0000000000000000000000000000000000000000..3edc58f4b42b18e4280873491bb65a0e0635b1d0 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/refprune_proto.py @@ -0,0 +1,329 @@ +""" +Contains tests and a prototype implementation for the fanout algorithm in +the LLVM refprune pass. +""" + +try: + from graphviz import Digraph +except ImportError: + pass +from collections import defaultdict + +# The entry block. It's always the same. +ENTRY = "A" + + +# The following caseNN() functions returns a 3-tuple of +# (nodes, edges, expected). +# `nodes` maps BB nodes to incref/decref inside the block. +# `edges` maps BB nodes to their successor BB. +# `expected` maps BB-node with incref to a set of BB-nodes with the decrefs, or +# the value can be None, indicating invalid prune. + +def case1(): + edges = { + "A": ["B"], + "B": ["C", "D"], + "C": [], + "D": ["E", "F"], + "E": ["G"], + "F": [], + "G": ["H", "I"], + "I": ["G", "F"], + "H": ["J", "K"], + "J": ["L", "M"], + "K": [], + "L": ["Z"], + "M": ["Z", "O", "P"], + "O": ["Z"], + "P": ["Z"], + "Z": [], + } + nodes = defaultdict(list) + nodes["D"] = ["incref"] + nodes["H"] = ["decref"] + nodes["F"] = ["decref", "decref"] + expected = {"D": {"H", "F"}} + return nodes, edges, expected + + +def case2(): + edges = { + "A": ["B", "C"], + "B": ["C"], + "C": [], + } + nodes = defaultdict(list) + nodes["A"] = ["incref"] + nodes["B"] = ["decref"] + nodes["C"] = ["decref"] + expected = {"A": None} + return nodes, edges, expected + + +def case3(): + nodes, edges, _ = case1() + # adds an invalid edge + edges["H"].append("F") + expected = {"D": None} + return nodes, edges, expected + + +def case4(): + nodes, edges, _ = case1() + # adds an invalid edge + edges["H"].append("E") + expected = {"D": None} + return nodes, edges, expected + + +def case5(): + nodes, edges, _ = case1() + # adds backedge to go before incref + edges["B"].append("I") + expected = {"D": None} + return nodes, edges, expected + + +def case6(): + nodes, edges, _ = case1() + # adds backedge to go before incref + edges["I"].append("B") + expected = {"D": None} + return nodes, edges, expected + + +def case7(): + nodes, edges, _ = case1() + # adds forward jump outside + edges["I"].append("M") + expected = {"D": None} + return nodes, edges, expected + + +def case8(): + edges = { + "A": ["B", "C"], + "B": ["C"], + "C": [], + } + nodes = defaultdict(list) + nodes["A"] = ["incref"] + nodes["C"] = ["decref"] + expected = {"A": {"C"}} + return nodes, edges, expected + + +def case9(): + nodes, edges, _ = case8() + # adds back edge + edges["C"].append("B") + expected = {"A": None} + return nodes, edges, expected + + +def case10(): + nodes, edges, _ = case8() + # adds back edge to A + edges["C"].append("A") + expected = {"A": {"C"}} + return nodes, edges, expected + + +def case11(): + nodes, edges, _ = case8() + edges["C"].append("D") + edges["D"] = [] + expected = {"A": {"C"}} + return nodes, edges, expected + + +def case12(): + nodes, edges, _ = case8() + edges["C"].append("D") + edges["D"] = ["A"] + expected = {"A": {"C"}} + return nodes, edges, expected + + +def case13(): + nodes, edges, _ = case8() + edges["C"].append("D") + edges["D"] = ["B"] + expected = {"A": None} + return nodes, edges, expected + + +def make_predecessor_map(edges): + d = defaultdict(set) + for src, outgoings in edges.items(): + for dst in outgoings: + d[dst].add(src) + return d + + +class FanoutAlgorithm: + def __init__(self, nodes, edges, verbose=False): + self.nodes = nodes + self.edges = edges + self.rev_edges = make_predecessor_map(edges) + self.print = print if verbose else self._null_print + + def run(self): + return self.find_fanout_in_function() + + def _null_print(self, *args, **kwargs): + pass + + def find_fanout_in_function(self): + got = {} + for cur_node in self.edges: + for incref in (x for x in self.nodes[cur_node] if x == "incref"): + decref_blocks = self.find_fanout(cur_node) + self.print(">>", cur_node, "===", decref_blocks) + got[cur_node] = decref_blocks + return got + + def find_fanout(self, head_node): + decref_blocks = self.find_decref_candidates(head_node) + self.print("candidates", decref_blocks) + if not decref_blocks: + return None + if not self.verify_non_overlapping( + head_node, decref_blocks, entry=ENTRY + ): + return None + return set(decref_blocks) + + def verify_non_overlapping(self, head_node, decref_blocks, entry): + self.print("verify_non_overlapping".center(80, "-")) + # reverse walk for each decref_blocks + # they should end at head_node + todo = list(decref_blocks) + while todo: + cur_node = todo.pop() + visited = set() + + workstack = [cur_node] + del cur_node + while workstack: + cur_node = workstack.pop() + self.print("cur_node", cur_node, "|", workstack) + if cur_node in visited: + continue # skip + if cur_node == entry: + # Entry node + self.print( + "!! failed because we arrived at entry", cur_node + ) + return False + visited.add(cur_node) + # check all predecessors + self.print( + f" {cur_node} preds {self.get_predecessors(cur_node)}" + ) + for pred in self.get_predecessors(cur_node): + if pred in decref_blocks: + # reject because there's a predecessor in decref_blocks + self.print( + "!! reject because predecessor in decref_blocks" + ) + return False + if pred != head_node: + + workstack.append(pred) + + return True + + def get_successors(self, node): + return tuple(self.edges[node]) + + def get_predecessors(self, node): + return tuple(self.rev_edges[node]) + + def has_decref(self, node): + return "decref" in self.nodes[node] + + def walk_child_for_decref( + self, cur_node, path_stack, decref_blocks, depth=10 + ): + indent = " " * len(path_stack) + self.print(indent, "walk", path_stack, cur_node) + if depth <= 0: + return False # missing + if cur_node in path_stack: + if cur_node == path_stack[0]: + return False # reject interior node backedge + return True # skip + if self.has_decref(cur_node): + decref_blocks.add(cur_node) + self.print(indent, "found decref") + return True + + depth -= 1 + path_stack += (cur_node,) + found = False + for child in self.get_successors(cur_node): + if not self.walk_child_for_decref( + child, path_stack, decref_blocks + ): + found = False + break + else: + found = True + + self.print(indent, f"ret {found}") + return found + + def find_decref_candidates(self, cur_node): + # Forward pass + self.print("find_decref_candidates".center(80, "-")) + path_stack = (cur_node,) + found = False + decref_blocks = set() + for child in self.get_successors(cur_node): + if not self.walk_child_for_decref( + child, path_stack, decref_blocks + ): + found = False + break + else: + found = True + if not found: + return set() + else: + return decref_blocks + + +def check_once(): + nodes, edges, expected = case13() + + # Render graph + G = Digraph() + for node in edges: + G.node(node, shape="rect", label=f"{node}\n" + r"\l".join(nodes[node])) + for node, children in edges.items(): + for child in children: + G.edge(node, child) + + G.view() + + algo = FanoutAlgorithm(nodes, edges, verbose=True) + got = algo.run() + assert expected == got + + +def check_all(): + for k, fn in list(globals().items()): + if k.startswith("case"): + print(f"{fn}".center(80, "-")) + nodes, edges, expected = fn() + algo = FanoutAlgorithm(nodes, edges) + got = algo.run() + assert expected == got + print("ALL PASSED") + + +if __name__ == "__main__": + # check_once() + check_all() diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_binding.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_binding.py new file mode 100644 index 0000000000000000000000000000000000000000..a6b01ab86740b5aeabdf9e1b81b039723fdb457c --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_binding.py @@ -0,0 +1,3208 @@ +import ctypes +import threading +from ctypes import CFUNCTYPE, c_int, c_int32 +from ctypes.util import find_library +import gc +import locale +import os +import platform +import re +import subprocess +import sys +import unittest +from contextlib import contextmanager +from tempfile import mkstemp + +from llvmlite import ir +from llvmlite import binding as llvm +from llvmlite.binding import ffi +from llvmlite.tests import TestCase + +# FIXME: Remove me once typed pointers are no longer supported. +from llvmlite import opaque_pointers_enabled + +# arvm7l needs extra ABI symbols to link successfully +if platform.machine() == 'armv7l': + llvm.load_library_permanently('libgcc_s.so.1') + + +def no_de_locale(): + cur = locale.setlocale(locale.LC_ALL) + try: + locale.setlocale(locale.LC_ALL, 'de_DE') + except locale.Error: + return True + else: + return False + finally: + locale.setlocale(locale.LC_ALL, cur) + + +asm_sum = r""" + ; ModuleID = '' + source_filename = "asm_sum.c" + target triple = "{triple}" + %struct.glob_type = type {{ i64, [2 x i64]}} + %struct.glob_type_vec = type {{ i64, <2 x i64>}} + + @glob = global i32 0 + @glob_b = global i8 0 + @glob_f = global float 1.5 + @glob_struct = global %struct.glob_type {{i64 0, [2 x i64] [i64 0, i64 0]}} + + define i32 @sum(i32 %.1, i32 %.2) {{ + %.3 = add i32 %.1, %.2 + %.4 = add i32 0, %.3 + ret i32 %.4 + }} + """ + +asm_sum2 = r""" + ; ModuleID = '' + target triple = "{triple}" + + define i32 @sum(i32 %.1, i32 %.2) {{ + %.3 = add i32 %.1, %.2 + ret i32 %.3 + }} + """ + +asm_sum3 = r""" + ; ModuleID = '' + target triple = "{triple}" + + define i64 @sum(i64 %.1, i64 %.2) {{ + %.3 = add i64 %.1, %.2 + %.4 = add i64 5, %.3 + %.5 = add i64 -5, %.4 + ret i64 %.5 + }} + """ + +asm_sum4 = r""" + ; ModuleID = '' + target triple = "{triple}" + + define i32 @sum(i32 %.1, i32 %.2) {{ + %.3 = add i32 %.1, %.2 + ret i32 0 + }} + """ + +asm_mul = r""" + ; ModuleID = '' + target triple = "{triple}" + @mul_glob = global i32 0 + + define i32 @mul(i32 %.1, i32 %.2) {{ + %.3 = mul i32 %.1, %.2 + ret i32 %.3 + }} + """ + +asm_square_sum = r""" + ; ModuleID = '' + target triple = "{triple}" + @mul_glob = global i32 0 + + declare i32 @sum(i32, i32) + define i32 @square_sum(i32 %.1, i32 %.2) {{ + %.3 = call i32 @sum(i32 %.1, i32 %.2) + %.4 = mul i32 %.3, %.3 + ret i32 %.4 + }} + """ + +asm_getversion = r""" + ; ModuleID = '' + target triple = "{triple}" + + declare i8* @Py_GetVersion() + + define void @getversion(i32 %.1, i32 %.2) {{ + %1 = call i8* @Py_GetVersion() + ret void + }} + """ + +if platform.python_implementation() == 'PyPy': + asm_getversion = asm_getversion.replace('Py_GetVersion', 'PyPy_GetVersion') + +# `fadd` used on integer inputs +asm_parse_error = r""" + ; ModuleID = '' + target triple = "{triple}" + + define i32 @sum(i32 %.1, i32 %.2) {{ + %.3 = fadd i32 %.1, %.2 + ret i32 %.3 + }} + """ + +# "%.bug" definition references itself +asm_verification_fail = r""" + ; ModuleID = '' + target triple = "{triple}" + + define void @sum() {{ + %.bug = add i32 1, %.bug + ret void + }} + """ + +asm_sum_declare = r""" + ; ModuleID = '' + target triple = "{triple}" + + declare i32 @sum(i32 %.1, i32 %.2) + """ + +asm_vararg_declare = r""" + ; ModuleID = '' + target triple = "{triple}" + + declare i32 @vararg(i32 %.1, ...) + """ + +asm_double_inaccurate = r""" + ; ModuleID = '' + target triple = "{triple}" + + define void @foo() {{ + %const = fadd fp128 0xLF3CB1CCF26FBC178452FB4EC7F91DEAD, 0xL00000000000000000000000000000001 + ret void + }} + """ # noqa E501 + +asm_double_locale = r""" + ; ModuleID = '' + target triple = "{triple}" + + define void @foo() {{ + %const = fadd double 0.0, 3.14 + ret void + }} + """ + + +asm_inlineasm = r""" + ; ModuleID = '' + target triple = "{triple}" + + define void @foo() {{ + call void asm sideeffect "nop", ""() + ret void + }} + """ + +asm_inlineasm2 = """ + ; ModuleID = '' + target triple = "{triple}" + + define void @inlineme() {{ + ret void + }} + + define i32 @caller(i32 %.1, i32 %.2) {{ + entry: + %stack = alloca i32 + store i32 %.1, i32* %stack + br label %main + main: + %loaded = load i32, i32* %stack + %.3 = add i32 %loaded, %.2 + %.4 = add i32 0, %.3 + call void @inlineme() + ret i32 %.4 + }} +""" + +asm_inlineasm3 = """ +; ModuleID = 'test.c' +source_filename = "test.c" +target triple = "{triple}" + +; Function Attrs: noinline nounwind optnone ssp uwtable +define void @inlineme() noinline !dbg !15 {{ + ret void, !dbg !18 +}} + +; Function Attrs: noinline nounwind optnone ssp uwtable +define i32 @foo(i32 %0, i32 %1) !dbg !19 {{ + %3 = alloca i32, align 4 + %4 = alloca i32, align 4 + store i32 %0, i32* %3, align 4 + call void @llvm.dbg.declare(metadata i32* %3, metadata !23, metadata !DIExpression()), !dbg !24 + store i32 %1, i32* %4, align 4 + call void @llvm.dbg.declare(metadata i32* %4, metadata !25, metadata !DIExpression()), !dbg !26 + call void @inlineme(), !dbg !27 + %5 = load i32, i32* %3, align 4, !dbg !28 + %6 = load i32, i32* %4, align 4, !dbg !29 + %7 = add nsw i32 %5, %6, !dbg !30 + ret i32 %7, !dbg !31 +}} + +; Function Attrs: nofree nosync nounwind readnone speculatable willreturn +declare void @llvm.dbg.declare(metadata, metadata, metadata) #1 + +attributes #1 = {{ nofree nosync nounwind readnone speculatable willreturn }} + +!llvm.module.flags = !{{!1, !2, !3, !4, !5, !6, !7, !8, !9, !10}} +!llvm.dbg.cu = !{{!11}} +!llvm.ident = !{{!14}} + +!0 = !{{i32 2, !"SDK Version", [2 x i32] [i32 12, i32 3]}} +!1 = !{{i32 7, !"Dwarf Version", i32 4}} +!2 = !{{i32 2, !"Debug Info Version", i32 3}} +!3 = !{{i32 1, !"wchar_size", i32 4}} +!4 = !{{i32 1, !"branch-target-enforcement", i32 0}} +!5 = !{{i32 1, !"sign-return-address", i32 0}} +!6 = !{{i32 1, !"sign-return-address-all", i32 0}} +!7 = !{{i32 1, !"sign-return-address-with-bkey", i32 0}} +!8 = !{{i32 7, !"PIC Level", i32 2}} +!9 = !{{i32 7, !"uwtable", i32 1}} +!10 = !{{i32 7, !"frame-pointer", i32 1}} +!11 = distinct !DICompileUnit(language: DW_LANG_C99, file: !12, producer: "Apple clang version 13.1.6 (clang-1316.0.21.2.3)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, enums: !13, splitDebugInlining: false, nameTableKind: None, sysroot: "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk", sdk: "MacOSX.sdk") +!12 = !DIFile(filename: "test.c", directory: "/") +!13 = !{{}} +!14 = !{{!"Apple clang version 13.1.6 (clang-1316.0.21.2.3)"}} +!15 = distinct !DISubprogram(name: "inlineme", scope: !12, file: !12, line: 1, type: !16, scopeLine: 1, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !11, retainedNodes: !13) +!16 = !DISubroutineType(types: !17) +!17 = !{{null}} +!18 = !DILocation(line: 1, column: 22, scope: !15) +!19 = distinct !DISubprogram(name: "foo", scope: !12, file: !12, line: 3, type: !20, scopeLine: 3, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !11, retainedNodes: !13) +!20 = !DISubroutineType(types: !21) +!21 = !{{!22, !22, !22}} +!22 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed) +!23 = !DILocalVariable(name: "a", arg: 1, scope: !19, file: !12, line: 3, type: !22) +!24 = !DILocation(line: 3, column: 13, scope: !19) +!25 = !DILocalVariable(name: "b", arg: 2, scope: !19, file: !12, line: 3, type: !22) +!26 = !DILocation(line: 3, column: 20, scope: !19) +!27 = !DILocation(line: 4, column: 5, scope: !19) +!28 = !DILocation(line: 5, column: 12, scope: !19) +!29 = !DILocation(line: 5, column: 16, scope: !19) +!30 = !DILocation(line: 5, column: 14, scope: !19) +!31 = !DILocation(line: 5, column: 5, scope: !19) +""" # noqa E501 + +licm_asm = r""" +; ModuleID = "" +target triple = "{triple}" + +define double @licm(i32 %0) {{ + %2 = alloca i32, align 4 + %3 = alloca double, align 8 + %4 = alloca i32, align 4 + %5 = alloca double, align 8 + store i32 %0, i32* %2, align 4 + store double 0.000000e+00, double* %3, align 8 + store i32 0, i32* %4, align 4 + br label %6 + +6: ; preds = %14, %1 + %7 = load i32, i32* %4, align 4 + %8 = load i32, i32* %2, align 4 + %9 = icmp slt i32 %7, %8 + br i1 %9, label %10, label %17 + +10: ; preds = %6 + store double 7.000000e+00, double* %5, align 8 + %11 = load double, double* %5, align 8 + %12 = load double, double* %3, align 8 + %13 = fadd double %12, %11 + store double %13, double* %3, align 8 + br label %14 + +14: ; preds = %10 + %15 = load i32, i32* %4, align 4 + %16 = add nsw i32 %15, 1 + store i32 %16, i32* %4, align 4 + br label %6 + +17: ; preds = %6 + %18 = load double, double* %3, align 8 + ret double %18 +}} +""" # noqa E501 + +asm_global_ctors = r""" + ; ModuleID = "" + target triple = "{triple}" + + @A = global i32 undef + + define void @ctor_A() + {{ + store i32 10, i32* @A + ret void + }} + + define void @dtor_A() + {{ + store i32 20, i32* @A + ret void + }} + + define i32 @foo() + {{ + %.2 = load i32, i32* @A + %.3 = add i32 %.2, 2 + ret i32 %.3 + }} + + @llvm.global_ctors = appending global [1 x {{i32, void ()*, i8*}}] [{{i32, void ()*, i8*}} {{i32 0, void ()* @ctor_A, i8* null}}] + @llvm.global_dtors = appending global [1 x {{i32, void ()*, i8*}}] [{{i32, void ()*, i8*}} {{i32 0, void ()* @dtor_A, i8* null}}] + """ # noqa E501 + +asm_ext_ctors = r""" + ; ModuleID = "" + target triple = "{triple}" + + @A = external global i32 + + define void @ctor_A() + {{ + store i32 10, i32* @A + ret void + }} + + define void @dtor_A() + {{ + store i32 20, i32* @A + ret void + }} + + define i32 @foo() + {{ + %.2 = load i32, i32* @A + %.3 = add i32 %.2, 2 + ret i32 %.3 + }} + + @llvm.global_ctors = appending global [1 x {{i32, void ()*, i8*}}] [{{i32, void ()*, i8*}} {{i32 0, void ()* @ctor_A, i8* null}}] + @llvm.global_dtors = appending global [1 x {{i32, void ()*, i8*}}] [{{i32, void ()*, i8*}} {{i32 0, void ()* @dtor_A, i8* null}}] + """ # noqa E501 + + +asm_nonalphanum_blocklabel = """; ModuleID = "" +target triple = "unknown-unknown-unknown" +target datalayout = "" + +define i32 @"foo"() +{ +"<>!*''#": + ret i32 12345 +} +""" # noqa W291 # trailing space needed for match later + + +asm_null_constant = r""" + ; ModuleID = '' + target triple = "{triple}" + + define void @foo(i64* %.1) {{ + ret void + }} + + define void @bar() {{ + call void @foo(i64* null) + ret void + }} +""" + + +riscv_asm_ilp32 = [ + 'addi\tsp, sp, -16', + 'sw\ta1, 8(sp)', + 'sw\ta2, 12(sp)', + 'fld\tft0, 8(sp)', + 'fmv.w.x\tft1, a0', + 'fcvt.d.s\tft1, ft1', + 'fadd.d\tft0, ft1, ft0', + 'fsd\tft0, 8(sp)', + 'lw\ta0, 8(sp)', + 'lw\ta1, 12(sp)', + 'addi\tsp, sp, 16', + 'ret' +] + + +riscv_asm_ilp32f = [ + 'addi\tsp, sp, -16', + 'sw\ta0, 8(sp)', + 'sw\ta1, 12(sp)', + 'fld\tft0, 8(sp)', + 'fcvt.d.s\tft1, fa0', + 'fadd.d\tft0, ft1, ft0', + 'fsd\tft0, 8(sp)', + 'lw\ta0, 8(sp)', + 'lw\ta1, 12(sp)', + 'addi\tsp, sp, 16', + 'ret' +] + + +riscv_asm_ilp32d = [ + 'fcvt.d.s\tft0, fa0', + 'fadd.d\tfa0, ft0, fa1', + 'ret' +] + + +asm_attributes = r""" +declare void @a_readonly_func(i8 *) readonly + +declare i8* @a_arg0_return_func(i8* returned, i32*) +""" + +asm_alloca_optnone = r""" +define double @foo(i32 %i, double %j) optnone noinline { + %I = alloca i32 ; [#uses=4] + %J = alloca double ; [#uses=2] + store i32 %i, i32* %I + store double %j, double* %J + %t1 = load i32, i32* %I ; [#uses=1] + %t2 = add i32 %t1, 1 ; [#uses=1] + store i32 %t2, i32* %I + %t3 = load i32, i32* %I ; [#uses=1] + %t4 = sitofp i32 %t3 to double ; [#uses=1] + %t5 = load double, double* %J ; [#uses=1] + %t6 = fmul double %t4, %t5 ; [#uses=1] + ret double %t6 +} +""" + +asm_declaration = r""" +declare void @test_declare(i32* ) +""" + +# This produces the following output from objdump: +# +# $ objdump -D 632.elf +# +# 632.elf: file format elf64-x86-64 +# +# +# Disassembly of section .text: +# +# 0000000000000000 <__arybo>: +# 0: 48 c1 e2 20 shl $0x20,%rdx +# 4: 48 09 c2 or %rax,%rdx +# 7: 48 89 d0 mov %rdx,%rax +# a: 48 c1 c0 3d rol $0x3d,%rax +# e: 48 31 d0 xor %rdx,%rax +# 11: 48 b9 01 20 00 04 80 movabs $0x7010008004002001,%rcx +# 18: 00 10 70 +# 1b: 48 0f af c8 imul %rax,%rcx + +issue_632_elf = \ + "7f454c4602010100000000000000000001003e00010000000000000000000000000000" \ + "0000000000e0000000000000000000000040000000000040000500010048c1e2204809" \ + "c24889d048c1c03d4831d048b90120000480001070480fafc800000000000000000000" \ + "0000000000000000000000000000002f0000000400f1ff000000000000000000000000" \ + "00000000070000001200020000000000000000001f00000000000000002e7465787400" \ + "5f5f617279626f002e6e6f74652e474e552d737461636b002e737472746162002e7379" \ + "6d746162003c737472696e673e00000000000000000000000000000000000000000000" \ + "0000000000000000000000000000000000000000000000000000000000000000000000" \ + "00000000000000001f0000000300000000000000000000000000000000000000a80000" \ + "0000000000380000000000000000000000000000000100000000000000000000000000" \ + "000001000000010000000600000000000000000000000000000040000000000000001f" \ + "000000000000000000000000000000100000000000000000000000000000000f000000" \ + "01000000000000000000000000000000000000005f0000000000000000000000000000" \ + "0000000000000000000100000000000000000000000000000027000000020000000000" \ + "0000000000000000000000000000600000000000000048000000000000000100000002" \ + "00000008000000000000001800000000000000" + + +issue_632_text = \ + "48c1e2204809c24889d048c1c03d4831d048b90120000480001070480fafc8" + + +asm_tli_exp2 = r""" +; ModuleID = '' +source_filename = "" +target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128" +target triple = "x86_64-pc-windows-msvc" + +declare float @llvm.exp2.f32(float %casted) + +define float @foo(i16 %arg) { +entry: + %casted = sitofp i16 %arg to float + %ret = call float @llvm.exp2.f32(float %casted) + ret float %ret +} +""" # noqa E501 + +asm_phi_blocks = r""" +; ModuleID = '' +target triple = "{triple}" + +define void @foo(i32 %N) {{ + ; unnamed block for testing + %cmp4 = icmp sgt i32 %N, 0 + br i1 %cmp4, label %for.body, label %for.cond.cleanup + +for.cond.cleanup: + ret void + +for.body: + %i.05 = phi i32 [ %inc, %for.body ], [ 0, %0 ] + %inc = add nuw nsw i32 %i.05, 1 + %exitcond.not = icmp eq i32 %inc, %N + br i1 %exitcond.not, label %for.cond.cleanup, label %for.body +}} +""" + +asm_cpp_class = r""" +; Source C++ +;----------------------------------------- +; class MyClass; +; +; class MyClassDefined{ +; MyClass *member; +; MyClass *m2; +; MyClass *m3; +; }; +; +; void foo(MyClass *c, MyClassDefined){ } +;----------------------------------------- +; LLVM-IR by: clang -arch arm64 -S -emit-llvm file.cpp +; ModuleID = 'file.cpp' +source_filename = "class.cpp" +target datalayout = "e-m:o-i64:64-i128:128-n32:64-S128" +target triple = "arm64-apple-macosx13.3.0" + +%class.MyClass = type opaque +%class.MyClassDefined = type { %class.MyClass*, %class.MyClass*, %class.MyClass* } + +; Function Attrs: noinline nounwind optnone ssp uwtable(sync) +define void @_Z3fooP7MyClass14MyClassDefined(%class.MyClass* noundef %0, %class.MyClassDefined* noundef %1) { + %3 = alloca %class.MyClass*, align 8 + store %class.MyClass* %0, %class.MyClass** %3, align 8 + ret void +} + +!llvm.module.flags = !{!0, !1, !2, !3, !4, !5, !6, !7, !8} +!llvm.ident = !{!9} + +!0 = !{i32 2, !"SDK Version", [2 x i32] [i32 13, i32 3]} +!1 = !{i32 1, !"wchar_size", i32 4} +!2 = !{i32 8, !"branch-target-enforcement", i32 0} +!3 = !{i32 8, !"sign-return-address", i32 0} +!4 = !{i32 8, !"sign-return-address-all", i32 0} +!5 = !{i32 8, !"sign-return-address-with-bkey", i32 0} +!6 = !{i32 7, !"PIC Level", i32 2} +!7 = !{i32 7, !"uwtable", i32 1} +!8 = !{i32 7, !"frame-pointer", i32 1} +!9 = !{!"Apple clang version 14.0.3 (clang-1403.0.22.14.1)"} + +""" # noqa + +asm_cpp_vector = r"""; Source C++ +;----------------------------------------- + +; struct Vector2D{ +; float x, y; +; }; +; +; void foo(Vector2D vec, Vector2D *out) { +; *out = vec; +; } +;----------------------------------------- +; LLVM-IR by: clang -arch x86_64 -S -emit-llvm file.cpp +; ModuleID = 'file.cpp' +source_filename = "class.cpp" +target datalayout = "e-m:o-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128" +target triple = "x86_64-apple-macosx13.3.0" + +%struct.Vector2D = type { float, float } + +; Function Attrs: noinline nounwind optnone ssp uwtable +define void @_Z3foo8Vector2DPS_(<2 x float> %0, %struct.Vector2D* noundef %1) #0 { + %3 = alloca %struct.Vector2D, align 4 + %4 = alloca %struct.Vector2D*, align 8 + %5 = bitcast %struct.Vector2D* %3 to <2 x float>* + store <2 x float> %0, <2 x float>* %5, align 4 + store %struct.Vector2D* %1, %struct.Vector2D** %4, align 8 + %6 = load %struct.Vector2D*, %struct.Vector2D** %4, align 8 + %7 = bitcast %struct.Vector2D* %6 to i8* + %8 = bitcast %struct.Vector2D* %3 to i8* + call void @llvm.memcpy.p0i8.p0i8.i64(i8* align 4 %7, i8* align 4 %8, i64 8, i1 false) + ret void +} + +; Function Attrs: argmemonly nofree nounwind willreturn +declare void @llvm.memcpy.p0i8.p0i8.i64(i8* noalias nocapture writeonly, i8* noalias nocapture readonly, i64, i1 immarg) #1 + +attributes #0 = { noinline nounwind optnone ssp uwtable "darwin-stkchk-strong-link" "frame-pointer"="all" "min-legal-vector-width"="64" "no-trapping-math"="true" "probe-stack"="___chkstk_darwin" "stack-protector-buffer-size"="8" "target-cpu"="penryn" "target-features"="+cx16,+cx8,+fxsr,+mmx,+sahf,+sse,+sse2,+sse3,+sse4.1,+ssse3,+x87" "tune-cpu"="generic" } +attributes #1 = { argmemonly nofree nounwind willreturn } + +!llvm.module.flags = !{!0, !1, !2, !3, !4} +!llvm.ident = !{!5} + +!0 = !{i32 2, !"SDK Version", [2 x i32] [i32 13, i32 3]} +!1 = !{i32 1, !"wchar_size", i32 4} +!2 = !{i32 7, !"PIC Level", i32 2} +!3 = !{i32 7, !"uwtable", i32 2} +!4 = !{i32 7, !"frame-pointer", i32 2} +!5 = !{!"Apple clang version 14.0.3 (clang-1403.0.22.14.1)"} + +""" # noqa + + +class BaseTest(TestCase): + + def setUp(self): + llvm.initialize() + llvm.initialize_native_target() + llvm.initialize_native_asmprinter() + gc.collect() + self.old_garbage = gc.garbage[:] + gc.garbage[:] = [] + + def tearDown(self): + # Test that no uncollectable objects were created + # (llvmlite objects have a __del__ so a reference cycle could + # create some). + gc.collect() + self.assertEqual(gc.garbage, []) + # This will probably put any existing garbage in gc.garbage again + del self.old_garbage + + def module(self, asm=asm_sum, context=None): + asm = asm.format(triple=llvm.get_default_triple()) + mod = llvm.parse_assembly(asm, context) + return mod + + def glob(self, name='glob', mod=None): + if mod is None: + mod = self.module() + return mod.get_global_variable(name) + + def target_machine(self, *, jit): + target = llvm.Target.from_default_triple() + return target.create_target_machine(jit=jit) + + +class TestDependencies(BaseTest): + """ + Test DLL dependencies are within a certain expected set. + """ + + @unittest.skipUnless(sys.platform.startswith('linux'), + "Linux-specific test") + @unittest.skipUnless(os.environ.get('LLVMLITE_DIST_TEST'), + "Distribution-specific test") + def test_linux(self): + lib_path = ffi.lib._name + env = os.environ.copy() + env['LANG'] = 'C' + p = subprocess.Popen(["objdump", "-p", lib_path], + stdout=subprocess.PIPE, env=env) + out, _ = p.communicate() + self.assertEqual(0, p.returncode) + # Parse library dependencies + lib_pat = re.compile(r'^([+-_a-zA-Z0-9]+)\.so(?:\.\d+){0,3}$') + deps = set() + for line in out.decode().splitlines(): + parts = line.split() + if parts and parts[0] == 'NEEDED': + dep = parts[1] + m = lib_pat.match(dep) + if len(parts) != 2 or not m: + self.fail("invalid NEEDED line: %r" % (line,)) + deps.add(m.group(1)) + # Sanity check that our dependencies were parsed ok + if 'libc' not in deps or 'libpthread' not in deps: + self.fail("failed parsing dependencies? got %r" % (deps,)) + # Ensure all dependencies are expected + allowed = set(['librt', 'libdl', 'libpthread', 'libz', 'libm', + 'libgcc_s', 'libc', 'ld-linux', 'ld64']) + if platform.python_implementation() == 'PyPy': + allowed.add('libtinfo') + + for dep in deps: + if not dep.startswith('ld-linux-') and dep not in allowed: + self.fail("unexpected dependency %r in %r" % (dep, deps)) + + +class TestRISCVABI(BaseTest): + """ + Test calling convention of floating point arguments of RISC-V + using different ABI. + """ + triple = "riscv32-unknown-linux" + + def setUp(self): + super().setUp() + llvm.initialize_all_targets() + llvm.initialize_all_asmprinters() + + def check_riscv_target(self): + try: + llvm.Target.from_triple(self.triple) + except RuntimeError as e: + if "No available targets are compatible with triple" in str(e): + self.skipTest("RISCV target unsupported by linked LLVM.") + else: + raise e + + def riscv_target_machine(self, **kwarg): + lltarget = llvm.Target.from_triple(self.triple) + return lltarget.create_target_machine(**kwarg) + + def fpadd_ll_module(self): + f64 = ir.DoubleType() + f32 = ir.FloatType() + fnty = ir.FunctionType(f64, (f32, f64)) + module = ir.Module() + func = ir.Function(module, fnty, name="fpadd") + block = func.append_basic_block() + builder = ir.IRBuilder(block) + a, b = func.args + arg0 = builder.fpext(a, f64) + result = builder.fadd(arg0, b) + builder.ret(result) + + llmod = llvm.parse_assembly(str(module)) + llmod.verify() + return llmod + + def break_up_asm(self, asm): + asm_list = [] + for line in asm.splitlines(): + s_line = line.strip() + if not (s_line.startswith(".") or s_line.startswith("fpadd") + or s_line == ""): + asm_list.append(s_line) + return asm_list + + def test_rv32d_ilp32(self): + self.check_riscv_target() + llmod = self.fpadd_ll_module() + target = self.riscv_target_machine(features="+f,+d", abiname="ilp32") + self.assertEqual(self.break_up_asm(target.emit_assembly(llmod)), + riscv_asm_ilp32) + + def test_rv32d_ilp32f(self): + self.check_riscv_target() + llmod = self.fpadd_ll_module() + target = self.riscv_target_machine(features="+f,+d", abiname="ilp32f") + self.assertEqual(self.break_up_asm(target.emit_assembly(llmod)), + riscv_asm_ilp32f) + + def test_rv32d_ilp32d(self): + self.check_riscv_target() + llmod = self.fpadd_ll_module() + target = self.riscv_target_machine(features="+f,+d", abiname="ilp32d") + self.assertEqual(self.break_up_asm(target.emit_assembly(llmod)), + riscv_asm_ilp32d) + + +class TestMisc(BaseTest): + """ + Test miscellaneous functions in llvm.binding. + """ + + def test_parse_assembly(self): + self.module(asm_sum) + + def test_parse_assembly_error(self): + with self.assertRaises(RuntimeError) as cm: + self.module(asm_parse_error) + s = str(cm.exception) + self.assertIn("parsing error", s) + self.assertIn("invalid operand type", s) + + def test_nonalphanum_block_name(self): + mod = ir.Module() + ft = ir.FunctionType(ir.IntType(32), []) + fn = ir.Function(mod, ft, "foo") + bd = ir.IRBuilder(fn.append_basic_block(name="<>!*''#")) + bd.ret(ir.Constant(ir.IntType(32), 12345)) + asm = str(mod) + self.assertEqual(asm, asm_nonalphanum_blocklabel) + + def test_global_context(self): + gcontext1 = llvm.context.get_global_context() + gcontext2 = llvm.context.get_global_context() + assert gcontext1 == gcontext2 + + def test_dylib_symbols(self): + llvm.add_symbol("__xyzzy", 1234) + llvm.add_symbol("__xyzzy", 5678) + addr = llvm.address_of_symbol("__xyzzy") + self.assertEqual(addr, 5678) + addr = llvm.address_of_symbol("__foobar") + self.assertIs(addr, None) + + def test_get_default_triple(self): + triple = llvm.get_default_triple() + self.assertIsInstance(triple, str) + self.assertTrue(triple) + + def test_get_process_triple(self): + # Sometimes we get synonyms for PPC + def normalize_ppc(arch): + if arch == 'powerpc64le': + return 'ppc64le' + else: + return arch + + triple = llvm.get_process_triple() + default = llvm.get_default_triple() + self.assertIsInstance(triple, str) + self.assertTrue(triple) + + default_arch = normalize_ppc(default.split('-')[0]) + triple_arch = normalize_ppc(triple.split('-')[0]) + # Arch must be equal + self.assertEqual(default_arch, triple_arch) + + def test_get_host_cpu_features(self): + features = llvm.get_host_cpu_features() + # Check the content of `features` + self.assertIsInstance(features, dict) + self.assertIsInstance(features, llvm.FeatureMap) + for k, v in features.items(): + self.assertIsInstance(k, str) + self.assertTrue(k) # single feature string cannot be empty + self.assertIsInstance(v, bool) + self.assertIsInstance(features.flatten(), str) + + re_term = r"[+\-][a-zA-Z0-9\._-]+" + regex = r"^({0}|{0}(,{0})*)?$".format(re_term) + # quick check for our regex + self.assertIsNotNone(re.match(regex, "")) + self.assertIsNotNone(re.match(regex, "+aa")) + self.assertIsNotNone(re.match(regex, "+a,-bb")) + # check CpuFeature.flatten() + if len(features) == 0: + self.assertEqual(features.flatten(), "") + else: + self.assertIsNotNone(re.match(regex, features.flatten())) + + def test_get_host_cpu_name(self): + cpu = llvm.get_host_cpu_name() + self.assertIsInstance(cpu, str) + self.assertTrue(cpu) + + def test_initfini(self): + code = """if 1: + from llvmlite import binding as llvm + + llvm.initialize() + llvm.initialize_native_target() + llvm.initialize_native_asmprinter() + llvm.initialize_all_targets() + llvm.initialize_all_asmprinters() + llvm.shutdown() + """ + subprocess.check_call([sys.executable, "-c", code]) + + def test_set_option(self): + # We cannot set an option multiple times (LLVM would exit() the + # process), so run the code in a subprocess. + code = """if 1: + from llvmlite import binding as llvm + + llvm.set_option("progname", "-debug-pass=Disabled") + """ + subprocess.check_call([sys.executable, "-c", code]) + + def test_version(self): + major, minor, patch = llvm.llvm_version_info + # one of these can be valid + valid = (15, 16) + self.assertIn(major, valid) + self.assertIn(patch, range(8)) + + def test_check_jit_execution(self): + llvm.check_jit_execution() + + @unittest.skipIf(no_de_locale(), "Locale not available") + def test_print_double_locale(self): + m = self.module(asm_double_locale) + expect = str(m) + # Change the locale so that comma is used as decimal-point + # to trigger the LLVM bug (llvmlite issue #80) + locale.setlocale(locale.LC_ALL, 'de_DE') + # The LLVM bug is trigged by print the module with double constant + got = str(m) + # Changing the locale should not affect the LLVM IR + self.assertEqual(expect, got) + + def test_no_accidental_warnings(self): + code = "from llvmlite import binding" + flags = "-Werror" + cmdargs = [sys.executable, flags, "-c", code] + subprocess.check_call(cmdargs) + + +class TestModuleRef(BaseTest): + + def test_str(self): + mod = self.module() + s = str(mod).strip() + self.assertTrue(s.startswith('; ModuleID ='), s) + + def test_close(self): + mod = self.module() + str(mod) + mod.close() + with self.assertRaises(ctypes.ArgumentError): + str(mod) + mod.close() + + def test_with(self): + mod = self.module() + str(mod) + with mod: + str(mod) + with self.assertRaises(ctypes.ArgumentError): + str(mod) + with self.assertRaises(RuntimeError): + with mod: + pass + + def test_name(self): + mod = self.module() + mod.name = "foo" + self.assertEqual(mod.name, "foo") + mod.name = "bar" + self.assertEqual(mod.name, "bar") + + def test_source_file(self): + mod = self.module() + self.assertEqual(mod.source_file, "asm_sum.c") + + def test_data_layout(self): + mod = self.module() + s = mod.data_layout + self.assertIsInstance(s, str) + mod.data_layout = s + self.assertEqual(s, mod.data_layout) + + def test_triple(self): + mod = self.module() + s = mod.triple + self.assertEqual(s, llvm.get_default_triple()) + mod.triple = '' + self.assertEqual(mod.triple, '') + + def test_verify(self): + # Verify successful + mod = self.module() + self.assertIs(mod.verify(), None) + # Verify failed + mod = self.module(asm_verification_fail) + with self.assertRaises(RuntimeError) as cm: + mod.verify() + s = str(cm.exception) + self.assertIn("%.bug = add i32 1, %.bug", s) + + def test_get_function(self): + mod = self.module() + fn = mod.get_function("sum") + self.assertIsInstance(fn, llvm.ValueRef) + self.assertEqual(fn.name, "sum") + + with self.assertRaises(NameError): + mod.get_function("foo") + + # Check that fn keeps the module instance alive + del mod + str(fn.module) + + def test_get_struct_type(self): + mod = self.module() + st_ty = mod.get_struct_type("struct.glob_type") + self.assertEqual(st_ty.name, "struct.glob_type") + # also match struct names of form "%struct.glob_type.{some_index}" + self.assertIsNotNone(re.match( + r'%struct\.glob_type(\.[\d]+)? = type { i64, \[2 x i64\] }', + str(st_ty))) + + with self.assertRaises(NameError): + mod.get_struct_type("struct.doesnt_exist") + + def test_get_global_variable(self): + mod = self.module() + gv = mod.get_global_variable("glob") + self.assertIsInstance(gv, llvm.ValueRef) + self.assertEqual(gv.name, "glob") + + with self.assertRaises(NameError): + mod.get_global_variable("bar") + + # Check that gv keeps the module instance alive + del mod + str(gv.module) + + def test_global_variables(self): + mod = self.module() + it = mod.global_variables + del mod + globs = sorted(it, key=lambda value: value.name) + self.assertEqual(len(globs), 4) + self.assertEqual([g.name for g in globs], + ["glob", "glob_b", "glob_f", "glob_struct"]) + + def test_functions(self): + mod = self.module() + it = mod.functions + del mod + funcs = list(it) + self.assertEqual(len(funcs), 1) + self.assertEqual(funcs[0].name, "sum") + + def test_structs(self): + mod = self.module() + it = mod.struct_types + del mod + structs = list(it) + self.assertEqual(len(structs), 1) + self.assertIsNotNone(re.match(r'struct\.glob_type(\.[\d]+)?', + structs[0].name)) + self.assertIsNotNone(re.match( + r'%struct\.glob_type(\.[\d]+)? = type { i64, \[2 x i64\] }', + str(structs[0]))) + + def test_link_in(self): + dest = self.module() + src = self.module(asm_mul) + dest.link_in(src) + self.assertEqual( + sorted(f.name for f in dest.functions), ["mul", "sum"]) + dest.get_function("mul") + dest.close() + with self.assertRaises(ctypes.ArgumentError): + src.get_function("mul") + + def test_link_in_preserve(self): + dest = self.module() + src2 = self.module(asm_mul) + dest.link_in(src2, preserve=True) + self.assertEqual( + sorted(f.name for f in dest.functions), ["mul", "sum"]) + dest.close() + self.assertEqual(sorted(f.name for f in src2.functions), ["mul"]) + src2.get_function("mul") + + def test_link_in_error(self): + # Raise an error by trying to link two modules with the same global + # definition "sum". + dest = self.module() + src = self.module(asm_sum2) + with self.assertRaises(RuntimeError) as cm: + dest.link_in(src) + self.assertIn("symbol multiply defined", str(cm.exception)) + + def test_as_bitcode(self): + mod = self.module() + bc = mod.as_bitcode() + # Refer to http://llvm.org/docs/doxygen/html/ReaderWriter_8h_source.html#l00064 # noqa E501 + # and http://llvm.org/docs/doxygen/html/ReaderWriter_8h_source.html#l00092 # noqa E501 + bitcode_wrapper_magic = b'\xde\xc0\x17\x0b' + bitcode_magic = b'BC' + self.assertTrue(bc.startswith(bitcode_magic) or + bc.startswith(bitcode_wrapper_magic)) + + def test_parse_bitcode_error(self): + with self.assertRaises(RuntimeError) as cm: + llvm.parse_bitcode(b"") + self.assertIn("LLVM bitcode parsing error", str(cm.exception)) + self.assertIn( + "file too small to contain bitcode header", str(cm.exception), + ) + + def test_bitcode_roundtrip(self): + # create a new context to avoid struct renaming + context1 = llvm.create_context() + bc = self.module(context=context1).as_bitcode() + context2 = llvm.create_context() + mod = llvm.parse_bitcode(bc, context2) + self.assertEqual(mod.as_bitcode(), bc) + + mod.get_function("sum") + mod.get_global_variable("glob") + + def test_cloning(self): + m = self.module() + cloned = m.clone() + self.assertIsNot(cloned, m) + self.assertEqual(cloned.as_bitcode(), m.as_bitcode()) + + +class JITTestMixin(object): + """ + Mixin for ExecutionEngine tests. + """ + + def get_sum(self, ee, func_name="sum"): + ee.finalize_object() + cfptr = ee.get_function_address(func_name) + self.assertTrue(cfptr) + return CFUNCTYPE(c_int, c_int, c_int)(cfptr) + + def test_run_code(self): + mod = self.module() + with self.jit(mod) as ee: + cfunc = self.get_sum(ee) + res = cfunc(2, -5) + self.assertEqual(-3, res) + + def test_close(self): + ee = self.jit(self.module()) + ee.close() + ee.close() + with self.assertRaises(ctypes.ArgumentError): + ee.finalize_object() + + def test_with(self): + ee = self.jit(self.module()) + with ee: + pass + with self.assertRaises(RuntimeError): + with ee: + pass + with self.assertRaises(ctypes.ArgumentError): + ee.finalize_object() + + def test_module_lifetime(self): + mod = self.module() + ee = self.jit(mod) + ee.close() + mod.close() + + def test_module_lifetime2(self): + mod = self.module() + ee = self.jit(mod) + mod.close() + ee.close() + + def test_add_module(self): + ee = self.jit(self.module()) + mod = self.module(asm_mul) + ee.add_module(mod) + with self.assertRaises(KeyError): + ee.add_module(mod) + self.assertFalse(mod.closed) + ee.close() + self.assertTrue(mod.closed) + + def test_add_module_lifetime(self): + ee = self.jit(self.module()) + mod = self.module(asm_mul) + ee.add_module(mod) + mod.close() + ee.close() + + def test_add_module_lifetime2(self): + ee = self.jit(self.module()) + mod = self.module(asm_mul) + ee.add_module(mod) + ee.close() + mod.close() + + def test_remove_module(self): + ee = self.jit(self.module()) + mod = self.module(asm_mul) + ee.add_module(mod) + ee.remove_module(mod) + with self.assertRaises(KeyError): + ee.remove_module(mod) + self.assertFalse(mod.closed) + ee.close() + self.assertFalse(mod.closed) + + def test_target_data(self): + mod = self.module() + ee = self.jit(mod) + td = ee.target_data + # A singleton is returned + self.assertIs(ee.target_data, td) + str(td) + del mod, ee + str(td) + + def test_target_data_abi_enquiries(self): + mod = self.module() + ee = self.jit(mod) + td = ee.target_data + gv_i32 = mod.get_global_variable("glob") + gv_i8 = mod.get_global_variable("glob_b") + gv_struct = mod.get_global_variable("glob_struct") + # A global is a pointer, it has the ABI size of a pointer + pointer_size = 4 if sys.maxsize < 2 ** 32 else 8 + for g in (gv_i32, gv_i8, gv_struct): + self.assertEqual(td.get_abi_size(g.type), pointer_size) + + self.assertEqual(td.get_abi_size(gv_i32.global_value_type), 4) + self.assertEqual(td.get_abi_alignment(gv_i32.global_value_type), 4) + + self.assertEqual(td.get_abi_size(gv_i8.global_value_type), 1) + self.assertIn(td.get_abi_alignment(gv_i8.global_value_type), (1, 2, 4)) + + self.assertEqual(td.get_abi_size(gv_struct.global_value_type), 24) + self.assertIn(td.get_abi_alignment(gv_struct.global_value_type), (4, 8)) + + def test_object_cache_notify(self): + notifies = [] + + def notify(mod, buf): + notifies.append((mod, buf)) + + mod = self.module() + ee = self.jit(mod) + ee.set_object_cache(notify) + + self.assertEqual(len(notifies), 0) + cfunc = self.get_sum(ee) + cfunc(2, -5) + self.assertEqual(len(notifies), 1) + # The right module object was found + self.assertIs(notifies[0][0], mod) + self.assertIsInstance(notifies[0][1], bytes) + + notifies[:] = [] + mod2 = self.module(asm_mul) + ee.add_module(mod2) + cfunc = self.get_sum(ee, "mul") + self.assertEqual(len(notifies), 1) + # The right module object was found + self.assertIs(notifies[0][0], mod2) + self.assertIsInstance(notifies[0][1], bytes) + + def test_object_cache_getbuffer(self): + notifies = [] + getbuffers = [] + + def notify(mod, buf): + notifies.append((mod, buf)) + + def getbuffer(mod): + getbuffers.append(mod) + + mod = self.module() + ee = self.jit(mod) + ee.set_object_cache(notify, getbuffer) + + # First return None from getbuffer(): the object is compiled normally + self.assertEqual(len(notifies), 0) + self.assertEqual(len(getbuffers), 0) + cfunc = self.get_sum(ee) + self.assertEqual(len(notifies), 1) + self.assertEqual(len(getbuffers), 1) + self.assertIs(getbuffers[0], mod) + sum_buffer = notifies[0][1] + + # Recreate a new EE, and use getbuffer() to return the previously + # compiled object. + + def getbuffer_successful(mod): + getbuffers.append(mod) + return sum_buffer + + notifies[:] = [] + getbuffers[:] = [] + # Use another source module to make sure it is ignored + mod = self.module(asm_mul) + ee = self.jit(mod) + ee.set_object_cache(notify, getbuffer_successful) + + self.assertEqual(len(notifies), 0) + self.assertEqual(len(getbuffers), 0) + cfunc = self.get_sum(ee) + self.assertEqual(cfunc(2, -5), -3) + self.assertEqual(len(notifies), 0) + self.assertEqual(len(getbuffers), 1) + + +class JITWithTMTestMixin(JITTestMixin): + + def test_emit_assembly(self): + """Test TargetMachineRef.emit_assembly()""" + target_machine = self.target_machine(jit=True) + mod = self.module() + ee = self.jit(mod, target_machine) # noqa F841 # Keeps pointers alive + raw_asm = target_machine.emit_assembly(mod) + self.assertIn("sum", raw_asm) + target_machine.set_asm_verbosity(True) + raw_asm_verbose = target_machine.emit_assembly(mod) + self.assertIn("sum", raw_asm) + self.assertNotEqual(raw_asm, raw_asm_verbose) + + def test_emit_object(self): + """Test TargetMachineRef.emit_object()""" + target_machine = self.target_machine(jit=True) + mod = self.module() + ee = self.jit(mod, target_machine) # noqa F841 # Keeps pointers alive + code_object = target_machine.emit_object(mod) + self.assertIsInstance(code_object, bytes) + if sys.platform.startswith('linux'): + # Sanity check + self.assertIn(b"ELF", code_object[:10]) + + +class TestMCJit(BaseTest, JITWithTMTestMixin): + """ + Test JIT engines created with create_mcjit_compiler(). + """ + + def jit(self, mod, target_machine=None): + if target_machine is None: + target_machine = self.target_machine(jit=True) + return llvm.create_mcjit_compiler(mod, target_machine) + + +# There are some memory corruption issues with OrcJIT on AArch64 - see Issue +# #1000. Since OrcJIT is experimental, and we don't test regularly during +# llvmlite development on non-x86 platforms, it seems safest to skip these +# tests on non-x86 platforms. +@unittest.skipUnless(platform.machine().startswith("x86"), "x86 only") +class TestOrcLLJIT(BaseTest): + + def jit(self, asm=asm_sum, func_name="sum", target_machine=None, + add_process=False, func_type=CFUNCTYPE(c_int, c_int, c_int), + suppress_errors=False): + lljit = llvm.create_lljit_compiler(target_machine, + use_jit_link=False, + suppress_errors=suppress_errors) + builder = llvm.JITLibraryBuilder() + if add_process: + builder.add_current_process() + rt = builder\ + .add_ir(asm.format(triple=llvm.get_default_triple()))\ + .export_symbol(func_name)\ + .link(lljit, func_name) + cfptr = rt[func_name] + self.assertTrue(cfptr) + self.assertEqual(func_name, rt.name) + return lljit, rt, func_type(cfptr) + + # From test_dylib_symbols + def test_define_symbol(self): + lljit = llvm.create_lljit_compiler() + rt = llvm.JITLibraryBuilder().import_symbol("__xyzzy", 1234)\ + .export_symbol("__xyzzy").link(lljit, "foo") + self.assertEqual(rt["__xyzzy"], 1234) + + def test_lookup_undefined_symbol_fails(self): + lljit = llvm.create_lljit_compiler() + with self.assertRaisesRegex(RuntimeError, 'No such library'): + lljit.lookup("foo", "__foobar") + rt = llvm.JITLibraryBuilder().import_symbol("__xyzzy", 1234)\ + .export_symbol("__xyzzy").link(lljit, "foo") + self.assertNotEqual(rt["__xyzzy"], 0) + with self.assertRaisesRegex(RuntimeError, + 'Symbols not found.*__foobar'): + lljit.lookup("foo", "__foobar") + + def test_jit_link(self): + if sys.platform == "win32": + with self.assertRaisesRegex(RuntimeError, + 'JITLink .* Windows'): + llvm.create_lljit_compiler(use_jit_link=True) + else: + self.assertIsNotNone(llvm.create_lljit_compiler(use_jit_link=True)) + + def test_run_code(self): + (lljit, rt, cfunc) = self.jit() + with lljit: + res = cfunc(2, -5) + self.assertEqual(-3, res) + + def test_close(self): + (lljit, rt, cfunc) = self.jit() + lljit.close() + lljit.close() + with self.assertRaises(AssertionError): + lljit.lookup("foo", "fn") + + def test_with(self): + (lljit, rt, cfunc) = self.jit() + with lljit: + pass + with self.assertRaises(RuntimeError): + with lljit: + pass + with self.assertRaises(AssertionError): + lljit.lookup("foo", "fn") + + def test_add_ir_module(self): + (lljit, rt_sum, cfunc_sum) = self.jit() + rt_mul = llvm.JITLibraryBuilder() \ + .add_ir(asm_mul.format(triple=llvm.get_default_triple())) \ + .export_symbol("mul") \ + .link(lljit, "mul") + res = CFUNCTYPE(c_int, c_int, c_int)(rt_mul["mul"])(2, -5) + self.assertEqual(-10, res) + self.assertNotEqual(lljit.lookup("sum", "sum")["sum"], 0) + self.assertNotEqual(lljit.lookup("mul", "mul")["mul"], 0) + with self.assertRaises(RuntimeError): + lljit.lookup("sum", "mul") + with self.assertRaises(RuntimeError): + lljit.lookup("mul", "sum") + + def test_remove_module(self): + (lljit, rt_sum, _) = self.jit() + del rt_sum + gc.collect() + with self.assertRaises(RuntimeError): + lljit.lookup("sum", "sum") + lljit.close() + + def test_lib_depends(self): + (lljit, rt_sum, cfunc_sum) = self.jit() + rt_mul = llvm.JITLibraryBuilder() \ + .add_ir(asm_square_sum.format(triple=llvm.get_default_triple())) \ + .export_symbol("square_sum") \ + .add_jit_library("sum") \ + .link(lljit, "square_sum") + res = CFUNCTYPE(c_int, c_int, c_int)(rt_mul["square_sum"])(2, -5) + self.assertEqual(9, res) + + def test_target_data(self): + (lljit, rt, _) = self.jit() + td = lljit.target_data + # A singleton is returned + self.assertIs(lljit.target_data, td) + str(td) + del lljit + str(td) + + def test_global_ctors_dtors(self): + # test issue #303 + # (https://github.com/numba/llvmlite/issues/303) + shared_value = c_int32(0) + lljit = llvm.create_lljit_compiler() + builder = llvm.JITLibraryBuilder() + rt = builder \ + .add_ir(asm_ext_ctors.format(triple=llvm.get_default_triple())) \ + .import_symbol("A", ctypes.addressof(shared_value)) \ + .export_symbol("foo") \ + .link(lljit, "foo") + foo = rt["foo"] + self.assertTrue(foo) + self.assertEqual(CFUNCTYPE(c_int)(foo)(), 12) + del rt + self.assertNotEqual(shared_value.value, 20) + + def test_lookup_current_process_symbol_fails(self): + # An attempt to lookup a symbol in the current process (Py_GetVersion, + # in this case) should fail with an appropriate error if we have not + # enabled searching the current process for symbols. + msg = 'Failed to materialize symbols:.*getversion' + with self.assertRaisesRegex(RuntimeError, msg): + self.jit(asm_getversion, "getversion", suppress_errors=True) + + def test_lookup_current_process_symbol(self): + self.jit(asm_getversion, "getversion", None, True) + + def test_thread_safe(self): + lljit = llvm.create_lljit_compiler() + llvm_ir = asm_sum.format(triple=llvm.get_default_triple()) + + def compile_many(i): + def do_work(): + tracking = [] + for c in range(50): + tracking.append(llvm.JITLibraryBuilder() + .add_ir(llvm_ir) + .export_symbol("sum") + .link(lljit, f"sum_{i}_{c}")) + + return do_work + + ths = [threading.Thread(target=compile_many(i)) + for i in range(os.cpu_count())] + for th in ths: + th.start() + for th in ths: + th.join() + + def test_add_object_file(self): + target_machine = self.target_machine(jit=False) + mod = self.module() + lljit = llvm.create_lljit_compiler(target_machine) + rt = llvm.JITLibraryBuilder()\ + .add_object_img(target_machine.emit_object(mod))\ + .export_symbol("sum")\ + .link(lljit, "sum") + sum = CFUNCTYPE(c_int, c_int, c_int)(rt["sum"]) + self.assertEqual(sum(2, 3), 5) + + def test_add_object_file_from_filesystem(self): + target_machine = self.target_machine(jit=False) + mod = self.module() + obj_bin = target_machine.emit_object(mod) + temp_desc, temp_path = mkstemp() + + try: + with os.fdopen(temp_desc, "wb") as f: + f.write(obj_bin) + lljit = llvm.create_lljit_compiler(target_machine) + rt = llvm.JITLibraryBuilder() \ + .add_object_file(temp_path) \ + .export_symbol("sum") \ + .link(lljit, "sum") + sum = CFUNCTYPE(c_int, c_int, c_int)(rt["sum"]) + self.assertEqual(sum(2, 3), 5) + finally: + os.unlink(temp_path) + + +class TestValueRef(BaseTest): + + def test_str(self): + mod = self.module() + glob = mod.get_global_variable("glob") + self.assertEqual(str(glob), "@glob = global i32 0") + + def test_name(self): + mod = self.module() + glob = mod.get_global_variable("glob") + self.assertEqual(glob.name, "glob") + glob.name = "foobar" + self.assertEqual(glob.name, "foobar") + + def test_linkage(self): + mod = self.module() + glob = mod.get_global_variable("glob") + linkage = glob.linkage + self.assertIsInstance(glob.linkage, llvm.Linkage) + glob.linkage = linkage + self.assertEqual(glob.linkage, linkage) + for linkage in ("internal", "external"): + glob.linkage = linkage + self.assertIsInstance(glob.linkage, llvm.Linkage) + self.assertEqual(glob.linkage.name, linkage) + + def test_visibility(self): + mod = self.module() + glob = mod.get_global_variable("glob") + visibility = glob.visibility + self.assertIsInstance(glob.visibility, llvm.Visibility) + glob.visibility = visibility + self.assertEqual(glob.visibility, visibility) + for visibility in ("hidden", "protected", "default"): + glob.visibility = visibility + self.assertIsInstance(glob.visibility, llvm.Visibility) + self.assertEqual(glob.visibility.name, visibility) + + def test_storage_class(self): + mod = self.module() + glob = mod.get_global_variable("glob") + storage_class = glob.storage_class + self.assertIsInstance(glob.storage_class, llvm.StorageClass) + glob.storage_class = storage_class + self.assertEqual(glob.storage_class, storage_class) + for storage_class in ("dllimport", "dllexport", "default"): + glob.storage_class = storage_class + self.assertIsInstance(glob.storage_class, llvm.StorageClass) + self.assertEqual(glob.storage_class.name, storage_class) + + def test_add_function_attribute(self): + mod = self.module() + fn = mod.get_function("sum") + fn.add_function_attribute("nocapture") + with self.assertRaises(ValueError) as raises: + fn.add_function_attribute("zext") + self.assertEqual(str(raises.exception), "no such attribute 'zext'") + + def test_module(self): + mod = self.module() + glob = mod.get_global_variable("glob") + self.assertIs(glob.module, mod) + + def test_type(self): + mod = self.module() + glob = mod.get_global_variable("glob") + tp = glob.type + self.assertIsInstance(tp, llvm.TypeRef) + + def test_type_name(self): + mod = self.module() + glob = mod.get_global_variable("glob") + tp = glob.type + self.assertEqual(tp.name, "") + st = mod.get_global_variable("glob_struct") + self.assertIsNotNone(re.match(r"struct\.glob_type(\.[\d]+)?", + st.global_value_type.name)) + + def test_type_printing_variable(self): + mod = self.module() + glob = mod.get_global_variable("glob") + tp = glob.global_value_type + self.assertEqual(str(tp), 'i32') + + def test_type_printing_function(self): + mod = self.module() + fn = mod.get_function("sum") + self.assertEqual(str(fn.global_value_type), "i32 (i32, i32)") + + def test_type_printing_struct(self): + mod = self.module() + st = mod.get_global_variable("glob_struct") + self.assertTrue(st.type.is_pointer) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertIsNotNone(re.match(r'ptr', str(st.type))) + else: + self.assertIsNotNone(re.match(r'%struct\.glob_type(\.[\d]+)?\*', + str(st.type))) + self.assertIsNotNone(re.match( + r"%struct\.glob_type(\.[\d]+)? = type { i64, \[2 x i64\] }", + str(st.global_value_type))) + + def test_close(self): + glob = self.glob() + glob.close() + glob.close() + + def test_is_declaration(self): + defined = self.module().get_function('sum') + declared = self.module(asm_sum_declare).get_function('sum') + self.assertFalse(defined.is_declaration) + self.assertTrue(declared.is_declaration) + + def test_module_global_variables(self): + mod = self.module(asm_sum) + gvars = list(mod.global_variables) + self.assertEqual(len(gvars), 4) + for v in gvars: + self.assertTrue(v.is_global) + + def test_module_functions(self): + mod = self.module() + funcs = list(mod.functions) + self.assertEqual(len(funcs), 1) + func = funcs[0] + self.assertTrue(func.is_function) + self.assertEqual(func.name, 'sum') + + with self.assertRaises(ValueError): + func.instructions + with self.assertRaises(ValueError): + func.operands + with self.assertRaises(ValueError): + func.opcode + + def test_function_arguments(self): + mod = self.module() + func = mod.get_function('sum') + self.assertTrue(func.is_function) + args = list(func.arguments) + self.assertEqual(len(args), 2) + self.assertTrue(args[0].is_argument) + self.assertTrue(args[1].is_argument) + self.assertEqual(args[0].name, '.1') + self.assertEqual(str(args[0].type), 'i32') + self.assertEqual(args[1].name, '.2') + self.assertEqual(str(args[1].type), 'i32') + + with self.assertRaises(ValueError): + args[0].blocks + with self.assertRaises(ValueError): + args[0].arguments + + def test_function_blocks(self): + func = self.module().get_function('sum') + blocks = list(func.blocks) + self.assertEqual(len(blocks), 1) + block = blocks[0] + self.assertTrue(block.is_block) + + def test_block_instructions(self): + func = self.module().get_function('sum') + insts = list(list(func.blocks)[0].instructions) + self.assertEqual(len(insts), 3) + self.assertTrue(insts[0].is_instruction) + self.assertTrue(insts[1].is_instruction) + self.assertTrue(insts[2].is_instruction) + self.assertEqual(insts[0].opcode, 'add') + self.assertEqual(insts[1].opcode, 'add') + self.assertEqual(insts[2].opcode, 'ret') + + def test_instruction_operands(self): + func = self.module().get_function('sum') + add = list(list(func.blocks)[0].instructions)[0] + self.assertEqual(add.opcode, 'add') + operands = list(add.operands) + self.assertEqual(len(operands), 2) + self.assertTrue(operands[0].is_operand) + self.assertTrue(operands[1].is_operand) + self.assertEqual(operands[0].name, '.1') + self.assertEqual(str(operands[0].type), 'i32') + self.assertEqual(operands[1].name, '.2') + self.assertEqual(str(operands[1].type), 'i32') + + def test_function_attributes(self): + ver = llvm.llvm_version_info[0] + readonly_attrs = [b'memory(read)' if ver == 16 else b'readonly'] + mod = self.module(asm_attributes) + for func in mod.functions: + attrs = list(func.attributes) + if func.name == 'a_readonly_func': + self.assertEqual(attrs, readonly_attrs) + elif func.name == 'a_arg0_return_func': + self.assertEqual(attrs, []) + args = list(func.arguments) + self.assertEqual(list(args[0].attributes), [b'returned']) + self.assertEqual(list(args[1].attributes), []) + + def test_value_kind(self): + mod = self.module() + self.assertEqual(mod.get_global_variable('glob').value_kind, + llvm.ValueKind.global_variable) + func = mod.get_function('sum') + self.assertEqual(func.value_kind, llvm.ValueKind.function) + block = list(func.blocks)[0] + self.assertEqual(block.value_kind, llvm.ValueKind.basic_block) + inst = list(block.instructions)[1] + self.assertEqual(inst.value_kind, llvm.ValueKind.instruction) + self.assertEqual(list(inst.operands)[0].value_kind, + llvm.ValueKind.constant_int) + self.assertEqual(list(inst.operands)[1].value_kind, + llvm.ValueKind.instruction) + + iasm_func = self.module(asm_inlineasm).get_function('foo') + iasm_inst = list(list(iasm_func.blocks)[0].instructions)[0] + self.assertEqual(list(iasm_inst.operands)[0].value_kind, + llvm.ValueKind.inline_asm) + + def test_is_constant(self): + mod = self.module() + self.assertTrue(mod.get_global_variable('glob').is_constant) + constant_operands = 0 + for func in mod.functions: + self.assertTrue(func.is_constant) + for block in func.blocks: + self.assertFalse(block.is_constant) + for inst in block.instructions: + self.assertFalse(inst.is_constant) + for op in inst.operands: + if op.is_constant: + constant_operands += 1 + + self.assertEqual(constant_operands, 1) + + def test_constant_int(self): + mod = self.module() + func = mod.get_function('sum') + insts = list(list(func.blocks)[0].instructions) + self.assertEqual(insts[1].opcode, 'add') + operands = list(insts[1].operands) + self.assertTrue(operands[0].is_constant) + self.assertFalse(operands[1].is_constant) + self.assertEqual(operands[0].get_constant_value(), 0) + with self.assertRaises(ValueError): + operands[1].get_constant_value() + + mod = self.module(asm_sum3) + func = mod.get_function('sum') + insts = list(list(func.blocks)[0].instructions) + posint64 = list(insts[1].operands)[0] + negint64 = list(insts[2].operands)[0] + self.assertEqual(posint64.get_constant_value(), 5) + self.assertEqual(negint64.get_constant_value(signed_int=True), -5) + + # Convert from unsigned arbitrary-precision integer to signed i64 + as_u64 = negint64.get_constant_value(signed_int=False) + as_i64 = int.from_bytes(as_u64.to_bytes(8, 'little'), 'little', + signed=True) + self.assertEqual(as_i64, -5) + + def test_constant_fp(self): + mod = self.module(asm_double_locale) + func = mod.get_function('foo') + insts = list(list(func.blocks)[0].instructions) + self.assertEqual(len(insts), 2) + self.assertEqual(insts[0].opcode, 'fadd') + operands = list(insts[0].operands) + self.assertTrue(operands[0].is_constant) + self.assertAlmostEqual(operands[0].get_constant_value(), 0.0) + self.assertTrue(operands[1].is_constant) + self.assertAlmostEqual(operands[1].get_constant_value(), 3.14) + + mod = self.module(asm_double_inaccurate) + func = mod.get_function('foo') + inst = list(list(func.blocks)[0].instructions)[0] + operands = list(inst.operands) + with self.assertRaises(ValueError): + operands[0].get_constant_value() + self.assertAlmostEqual(operands[1].get_constant_value(round_fp=True), 0) + + def test_constant_as_string(self): + mod = self.module(asm_null_constant) + func = mod.get_function('bar') + inst = list(list(func.blocks)[0].instructions)[0] + arg = list(inst.operands)[0] + self.assertTrue(arg.is_constant) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(arg.get_constant_value(), 'ptr null') + else: + self.assertEqual(arg.get_constant_value(), 'i64* null') + + def test_incoming_phi_blocks(self): + mod = self.module(asm_phi_blocks) + func = mod.get_function('foo') + blocks = list(func.blocks) + instructions = list(blocks[-1].instructions) + self.assertTrue(instructions[0].is_instruction) + self.assertEqual(instructions[0].opcode, 'phi') + + incoming_blocks = list(instructions[0].incoming_blocks) + self.assertEqual(len(incoming_blocks), 2) + self.assertTrue(incoming_blocks[0].is_block) + self.assertTrue(incoming_blocks[1].is_block) + # Test reference to blocks (named or unnamed) + self.assertEqual(incoming_blocks[0], blocks[-1]) + self.assertEqual(incoming_blocks[1], blocks[0]) + + # Test case that should fail + self.assertNotEqual(instructions[1].opcode, 'phi') + with self.assertRaises(ValueError): + instructions[1].incoming_blocks + + +class TestTypeRef(BaseTest): + + def test_str(self): + mod = self.module() + glob = mod.get_global_variable("glob") + self.assertEqual(str(glob.global_value_type), "i32") + glob_struct_type = mod.get_struct_type("struct.glob_type") + self.assertEqual(str(glob_struct_type), + "%struct.glob_type = type { i64, [2 x i64] }") + + elements = list(glob_struct_type.elements) + self.assertEqual(len(elements), 2) + self.assertEqual(str(elements[0]), "i64") + self.assertEqual(str(elements[1]), "[2 x i64]") + + def test_type_kind(self): + mod = self.module() + glob = mod.get_global_variable("glob") + self.assertEqual(glob.type.type_kind, llvm.TypeKind.pointer) + self.assertTrue(glob.type.is_pointer) + + glob_struct = mod.get_global_variable("glob_struct") + self.assertEqual(glob_struct.type.type_kind, llvm.TypeKind.pointer) + self.assertTrue(glob_struct.type.is_pointer) + + stype = glob_struct.global_value_type + self.assertEqual(stype.type_kind, llvm.TypeKind.struct) + self.assertTrue(stype.is_struct) + + stype_a, stype_b = stype.elements + self.assertEqual(stype_a.type_kind, llvm.TypeKind.integer) + self.assertEqual(stype_b.type_kind, llvm.TypeKind.array) + self.assertTrue(stype_b.is_array) + + glob_vec_struct_type = mod.get_struct_type("struct.glob_type_vec") + _, vector_type = glob_vec_struct_type.elements + self.assertEqual(vector_type.type_kind, llvm.TypeKind.vector) + self.assertTrue(vector_type.is_vector) + + funcptr = mod.get_function("sum").type + self.assertEqual(funcptr.type_kind, llvm.TypeKind.pointer) + functype = mod.get_function("sum").global_value_type + self.assertEqual(functype.type_kind, llvm.TypeKind.function) + + def test_element_count(self): + mod = self.module() + glob_struct_type = mod.get_struct_type("struct.glob_type") + _, array_type = glob_struct_type.elements + self.assertEqual(array_type.element_count, 2) + with self.assertRaises(ValueError): + glob_struct_type.element_count + + def test_type_width(self): + mod = self.module() + glob_struct_type = mod.get_struct_type("struct.glob_type") + glob_vec_struct_type = mod.get_struct_type("struct.glob_type_vec") + integer_type, array_type = glob_struct_type.elements + _, vector_type = glob_vec_struct_type.elements + self.assertEqual(integer_type.type_width, 64) + self.assertEqual(vector_type.type_width, 64 * 2) + + # Structs and arrays are not primitive types + self.assertEqual(glob_struct_type.type_width, 0) + self.assertEqual(array_type.type_width, 0) + + def test_vararg_function(self): + # Variadic function + mod = self.module(asm_vararg_declare) + func = mod.get_function('vararg') + decltype = func.global_value_type + self.assertTrue(decltype.is_function_vararg) + + mod = self.module(asm_sum_declare) + func = mod.get_function('sum') + decltype = func.global_value_type + self.assertFalse(decltype.is_function_vararg) + + # test that the function pointer type cannot use is_function_vararg + self.assertTrue(func.type.is_pointer) + with self.assertRaises(ValueError) as raises: + func.type.is_function_vararg + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertIn("Type ptr is not a function", str(raises.exception)) + else: + self.assertIn("Type i32 (i32, i32)* is not a function", + str(raises.exception)) + + def test_function_typeref_as_ir(self): + mod = self.module() + + [fn] = list(mod.functions) + # .type gives a pointer type, a problem if it's opaque (llvm15+) + self.assertEqual(fn.type.type_kind, llvm.TypeKind.pointer) + self.assertFalse(fn.type.is_function) + # Use .global_value_type instead + fnty = fn.global_value_type + self.assertEqual(fnty.type_kind, llvm.TypeKind.function) + self.assertTrue(fnty.is_function) + # Run .as_ir() to get llvmlite.ir.FunctionType + tyir = fnty.as_ir(ir.global_context) + self.assertIsInstance(tyir, ir.FunctionType) + self.assertEqual(tyir.args, (ir.IntType(32), ir.IntType(32))) + self.assertEqual(tyir.return_type ,ir.IntType(32)) + + def test_void_typeref_as_ir(self): + # Void type can only be used as return-type of llvmlite.ir.FunctionType. + fnty = ir.FunctionType(ir.VoidType(), ()) + irmod = ir.Module() + fn = ir.Function(irmod, fnty, "foo") + mod = self.module(str(irmod)) + fn = mod.get_function("foo") + gvty = fn.global_value_type + self.assertEqual(fnty.return_type, + gvty.as_ir(ir.global_context).return_type) + + def test_global_typeref_as_ir(self): + from llvmlite.binding.typeref import _TypeKindToIRType + ctx = ir.Context() + + skipped = { + "function", # tested in test_function_typeref_as_ir + "void", # tested in test_void_typeref_as_ir + } + + makers = {} + + def maker_half(): + yield ir.HalfType() + + makers['half'] = maker_half + + def maker_float(): + yield ir.FloatType() + + makers['float'] = maker_float + + def maker_double(): + yield ir.DoubleType() + + makers['double'] = maker_double + + def maker_integer(): + yield ir.IntType(32) + + makers['integer'] = maker_integer + + def maker_pointer(): + yield ir.PointerType(ir.IntType(8)) + # opaque struct ptr + yield ctx.get_identified_type("myclass").as_pointer() + # named struct with defined body + myclass2 = ctx.get_identified_type("myclass2") + myclass2.set_body(ir.IntType(8)) + yield myclass2.as_pointer() + + makers['pointer'] = maker_pointer + + def maker_array(): + yield ir.ArrayType(ir.IntType(8), 123) + + makers['array'] = maker_array + + def maker_vector(): + yield ir.VectorType(ir.FloatType(), 2) + + makers['vector'] = maker_vector + + def maker_struct(): + yield ir.LiteralStructType([ir.FloatType(), ir.IntType(64)]) + yield ir.LiteralStructType([ir.FloatType(), ir.IntType(64)], + packed=True) + + makers['struct'] = maker_struct + + # Ensure that number of supported TypeKind matches number of makers + self.assertEqual({x.name for x in _TypeKindToIRType.keys()}, + set(makers.keys()) | set(skipped)) + + # Test each type-kind + for type_kind, irtype in _TypeKindToIRType.items(): + if type_kind.name in skipped: + continue + for ty in makers[type_kind.name](): + with self.subTest(f"{type_kind!s} -> {ty}"): + irmod = ir.Module(context=ctx) + ir.GlobalVariable(irmod, ty, name='gv') + asm = str(irmod) + mod = llvm.parse_assembly(asm) + gv = mod.get_global_variable("gv") + gvty = gv.global_value_type + got = gvty.as_ir(ir.Context()) # fresh context + self.assertEqual(got, ty) + self.assertIsInstance(got, irtype) + + def _check_typeref_as_ir_for_wrappers(self, asm, target_symbol): + # Get a clang++ defined function from a llvm ir + mod = llvm.parse_assembly(asm) + cppfn = mod.get_function(target_symbol) + cppfntype = cppfn.global_value_type + + # Get the function type into a new context + my_context = ir.Context() # don't populate global context + ty = cppfntype.as_ir(ir_ctx=my_context) + + # Build a wrapper module for the cpp function + wrapper_mod = ir.Module(context=my_context) + # declare the original function + declfn = ir.Function(wrapper_mod, ty, name=cppfn.name) + # populate the wrapper function + wrapfn = ir.Function(wrapper_mod, ty, name="wrapper") + builder = ir.IRBuilder(wrapfn.append_basic_block()) + # just call the original function + builder.call(declfn, wrapfn.args) + builder.ret_void() + # Create a new LLVM module with the wrapper + new_mod = llvm.parse_assembly(str(wrapper_mod)) + self.assertTrue(new_mod.get_function(declfn.name).is_declaration, + msg="declfn must not have a body") + # Merge/link the original module into the new module + new_mod.link_in(mod, preserve=True) + self.assertEqual(len(list(new_mod.functions)), + len(list(mod.functions)) + 1, + msg="the only new function is the wrapper") + self.assertFalse(new_mod.get_function(declfn.name).is_declaration, + msg="declfn must have a body now") + self.assertEqual(new_mod.get_function(declfn.name).global_value_type, + new_mod.get_function(wrapfn.name).global_value_type, + msg="declfn and wrapfn must have the same llvm Type") + + def test_typeref_as_ir_for_wrappers_of_cpp_class(self): + """Exercise extracting C++ defined class types. + Contains both opaque and non-opaque class definitions. + """ + self._check_typeref_as_ir_for_wrappers( + asm_cpp_class, + "_Z3fooP7MyClass14MyClassDefined", + ) + + def test_typeref_as_ir_for_wrappers_of_cpp_vector_struct(self): + """Exercise extracting C++ struct types that are passed as vectors. + + IA64 ABI on x86_64 will put struct with two floats as + a vector of two floats. + """ + self._check_typeref_as_ir_for_wrappers( + asm_cpp_vector, + "_Z3foo8Vector2DPS_", + ) + + +class TestTarget(BaseTest): + + def test_from_triple(self): + f = llvm.Target.from_triple + with self.assertRaises(RuntimeError) as cm: + f("foobar") + self.assertIn("No available targets are compatible with", + str(cm.exception)) + triple = llvm.get_default_triple() + target = f(triple) + self.assertEqual(target.triple, triple) + target.close() + + def test_create_target_machine(self): + target = llvm.Target.from_triple(llvm.get_default_triple()) + # With the default settings + target.create_target_machine('', '', 1, 'default', 'default') + # With the host's CPU + cpu = llvm.get_host_cpu_name() + target.create_target_machine(cpu, '', 1, 'default', 'default') + + def test_name(self): + t = llvm.Target.from_triple(llvm.get_default_triple()) + u = llvm.Target.from_default_triple() + self.assertIsInstance(t.name, str) + self.assertEqual(t.name, u.name) + + def test_description(self): + t = llvm.Target.from_triple(llvm.get_default_triple()) + u = llvm.Target.from_default_triple() + self.assertIsInstance(t.description, str) + self.assertEqual(t.description, u.description) + + def test_str(self): + target = llvm.Target.from_triple(llvm.get_default_triple()) + s = str(target) + self.assertIn(target.name, s) + self.assertIn(target.description, s) + + def test_get_parts_from_triple(self): + # Tests adapted from llvm-14::llvm/unittests/ADT/TripleTest.cpp + cases = [ + ("x86_64-scei-ps4", + llvm.targets.Triple(Arch="x86_64", SubArch='', + Vendor="scei", OS="ps4", + Env="unknown", ObjectFormat="ELF")), + ("x86_64-sie-ps4", + llvm.targets.Triple(Arch="x86_64", SubArch='', + Vendor="scei", OS="ps4", + Env="unknown", ObjectFormat="ELF")), + ("powerpc-dunno-notsure", + llvm.targets.Triple(Arch="powerpc", SubArch='', + Vendor="unknown", OS="unknown", + Env="unknown", ObjectFormat="ELF")), + ("powerpcspe-unknown-freebsd", + llvm.targets.Triple(Arch="powerpc", SubArch='spe', + Vendor="unknown", OS="freebsd", + Env="unknown", ObjectFormat="ELF")), + ("armv6hl-none-linux-gnueabi", + llvm.targets.Triple(Arch="arm", SubArch='v6hl', + Vendor="unknown", OS="linux", + Env="gnueabi", ObjectFormat="ELF")), + ("i686-unknown-linux-gnu", + llvm.targets.Triple(Arch="i386", SubArch='', + Vendor="unknown", OS="linux", + Env="gnu", ObjectFormat="ELF")), + ("i686-apple-macosx", + llvm.targets.Triple(Arch="i386", SubArch='', + Vendor="apple", OS="macosx", + Env="unknown", ObjectFormat="MachO")), + ("i686-dunno-win32", + llvm.targets.Triple(Arch="i386", SubArch='', + Vendor="unknown", OS="windows", + Env="msvc", ObjectFormat="COFF")), + ("s390x-ibm-zos", + llvm.targets.Triple(Arch="s390x", SubArch='', + Vendor="ibm", OS="zos", + Env="unknown", ObjectFormat="GOFF")), + ("wasm64-wasi", + llvm.targets.Triple(Arch="wasm64", SubArch='', + Vendor="unknown", OS="wasi", + Env="unknown", ObjectFormat="Wasm")), + ] + + for case in cases: + triple_str, triple_obj = case + res = llvm.get_triple_parts(triple_str) + + self.assertEqual(res, triple_obj) + + +class TestTargetData(BaseTest): + + def target_data(self): + return llvm.create_target_data("e-m:e-i64:64-f80:128-n8:16:32:64-S128") + + def test_get_abi_size(self): + td = self.target_data() + glob = self.glob() + self.assertEqual(td.get_abi_size(glob.type), 8) + + def test_get_pointee_abi_size(self): + td = self.target_data() + + glob = self.glob() + self.assertEqual(td.get_abi_size(glob.global_value_type), 4) + + glob = self.glob("glob_struct") + self.assertEqual(td.get_abi_size(glob.global_value_type), 24) + + def test_get_struct_element_offset(self): + td = self.target_data() + glob = self.glob("glob_struct") + + with self.assertRaises(ValueError): + td.get_element_offset(glob.type, 0) + + struct_type = glob.global_value_type + self.assertEqual(td.get_element_offset(struct_type, 0), 0) + self.assertEqual(td.get_element_offset(struct_type, 1), 8) + + +class TestTargetMachine(BaseTest): + + def test_add_analysis_passes(self): + tm = self.target_machine(jit=False) + pm = llvm.create_module_pass_manager() + tm.add_analysis_passes(pm) + + def test_target_data_from_tm(self): + tm = self.target_machine(jit=False) + td = tm.target_data + mod = self.module() + gv_i32 = mod.get_global_variable("glob") + # A global is a pointer, it has the ABI size of a pointer + pointer_size = 4 if sys.maxsize < 2 ** 32 else 8 + self.assertEqual(td.get_abi_size(gv_i32.type), pointer_size) + + +class TestPassManagerBuilder(BaseTest): + + def pmb(self): + return llvm.PassManagerBuilder() + + def test_old_api(self): + # Test the create_pass_manager_builder() factory function + pmb = llvm.create_pass_manager_builder() + pmb.inlining_threshold = 2 + pmb.opt_level = 3 + + def test_close(self): + pmb = self.pmb() + pmb.close() + pmb.close() + + def test_opt_level(self): + pmb = self.pmb() + self.assertIsInstance(pmb.opt_level, int) + for i in range(4): + pmb.opt_level = i + self.assertEqual(pmb.opt_level, i) + + def test_size_level(self): + pmb = self.pmb() + self.assertIsInstance(pmb.size_level, int) + for i in range(4): + pmb.size_level = i + self.assertEqual(pmb.size_level, i) + + def test_inlining_threshold(self): + pmb = self.pmb() + with self.assertRaises(NotImplementedError): + pmb.inlining_threshold + for i in (25, 80, 350): + pmb.inlining_threshold = i + + def test_disable_unroll_loops(self): + pmb = self.pmb() + self.assertIsInstance(pmb.disable_unroll_loops, bool) + for b in (True, False): + pmb.disable_unroll_loops = b + self.assertEqual(pmb.disable_unroll_loops, b) + + def test_loop_vectorize(self): + pmb = self.pmb() + self.assertIsInstance(pmb.loop_vectorize, bool) + for b in (True, False): + pmb.loop_vectorize = b + self.assertEqual(pmb.loop_vectorize, b) + + def test_slp_vectorize(self): + pmb = self.pmb() + self.assertIsInstance(pmb.slp_vectorize, bool) + for b in (True, False): + pmb.slp_vectorize = b + self.assertEqual(pmb.slp_vectorize, b) + + def test_populate_module_pass_manager(self): + pmb = self.pmb() + pm = llvm.create_module_pass_manager() + pmb.populate(pm) + pmb.close() + pm.close() + + def test_populate_function_pass_manager(self): + mod = self.module() + pmb = self.pmb() + pm = llvm.create_function_pass_manager(mod) + pmb.populate(pm) + pmb.close() + pm.close() + + +class PassManagerTestMixin(object): + + def pmb(self): + pmb = llvm.create_pass_manager_builder() + pmb.opt_level = 2 + pmb.inlining_threshold = 300 + return pmb + + def test_close(self): + pm = self.pm() + pm.close() + pm.close() + + +class TestModulePassManager(BaseTest, PassManagerTestMixin): + + def pm(self): + return llvm.create_module_pass_manager() + + def test_run(self): + pm = self.pm() + self.pmb().populate(pm) + mod = self.module() + orig_asm = str(mod) + pm.run(mod) + opt_asm = str(mod) + # Quick check that optimizations were run, should get: + # define i32 @sum(i32 %.1, i32 %.2) local_unnamed_addr #0 { + # %.X = add i32 %.2, %.1 + # ret i32 %.X + # } + # where X in %.X is 3 or 4 + opt_asm_split = opt_asm.splitlines() + for idx, l in enumerate(opt_asm_split): + if l.strip().startswith('ret i32'): + toks = {'%.3', '%.4'} + for t in toks: + if t in l: + break + else: + raise RuntimeError("expected tokens not found") + othertoken = (toks ^ {t}).pop() + + self.assertIn("%.3", orig_asm) + self.assertNotIn(othertoken, opt_asm) + break + else: + raise RuntimeError("expected IR not found") + + def test_run_with_remarks_successful_inline(self): + pm = self.pm() + pm.add_function_inlining_pass(70) + self.pmb().populate(pm) + mod = self.module(asm_inlineasm2) + (status, remarks) = pm.run_with_remarks(mod) + self.assertTrue(status) + # Inlining has happened? The remark will tell us. + self.assertIn("Passed", remarks) + self.assertIn("inlineme", remarks) + + def test_run_with_remarks_failed_inline(self): + pm = self.pm() + pm.add_function_inlining_pass(0) + self.pmb().populate(pm) + mod = self.module(asm_inlineasm3) + (status, remarks) = pm.run_with_remarks(mod) + self.assertTrue(status) + + # Inlining has not happened? The remark will tell us. + self.assertIn("Missed", remarks) + self.assertIn("inlineme", remarks) + self.assertIn("noinline function attribute", remarks) + + def test_run_with_remarks_inline_filter_out(self): + pm = self.pm() + pm.add_function_inlining_pass(70) + self.pmb().populate(pm) + mod = self.module(asm_inlineasm2) + (status, remarks) = pm.run_with_remarks(mod, remarks_filter="nothing") + self.assertTrue(status) + self.assertEqual("", remarks) + + def test_run_with_remarks_inline_filter_in(self): + pm = self.pm() + pm.add_function_inlining_pass(70) + self.pmb().populate(pm) + mod = self.module(asm_inlineasm2) + (status, remarks) = pm.run_with_remarks(mod, remarks_filter="inlin.*") + self.assertTrue(status) + self.assertIn("Passed", remarks) + self.assertIn("inlineme", remarks) + + +class TestFunctionPassManager(BaseTest, PassManagerTestMixin): + + def pm(self, mod=None): + mod = mod or self.module() + return llvm.create_function_pass_manager(mod) + + def test_initfini(self): + pm = self.pm() + pm.initialize() + pm.finalize() + + def test_run(self): + mod = self.module() + fn = mod.get_function("sum") + pm = self.pm(mod) + self.pmb().populate(pm) + mod.close() + orig_asm = str(fn) + pm.initialize() + pm.run(fn) + pm.finalize() + opt_asm = str(fn) + # Quick check that optimizations were run + self.assertIn("%.4", orig_asm) + self.assertNotIn("%.4", opt_asm) + + def test_run_with_remarks(self): + mod = self.module(licm_asm) + fn = mod.get_function("licm") + pm = self.pm(mod) + pm.add_licm_pass() + self.pmb().populate(pm) + mod.close() + + pm.initialize() + (ok, remarks) = pm.run_with_remarks(fn) + pm.finalize() + self.assertTrue(ok) + self.assertIn("Passed", remarks) + self.assertIn("licm", remarks) + + def test_run_with_remarks_filter_out(self): + mod = self.module(licm_asm) + fn = mod.get_function("licm") + pm = self.pm(mod) + pm.add_licm_pass() + self.pmb().populate(pm) + mod.close() + + pm.initialize() + (ok, remarks) = pm.run_with_remarks(fn, remarks_filter="nothing") + pm.finalize() + self.assertTrue(ok) + self.assertEqual("", remarks) + + def test_run_with_remarks_filter_in(self): + mod = self.module(licm_asm) + fn = mod.get_function("licm") + pm = self.pm(mod) + pm.add_licm_pass() + self.pmb().populate(pm) + mod.close() + + pm.initialize() + (ok, remarks) = pm.run_with_remarks(fn, remarks_filter="licm") + pm.finalize() + self.assertTrue(ok) + self.assertIn("Passed", remarks) + self.assertIn("licm", remarks) + + +class TestPasses(BaseTest, PassManagerTestMixin): + + def pm(self): + return llvm.create_module_pass_manager() + + def test_populate(self): + llvm_ver = llvm.llvm_version_info[0] + + pm = self.pm() + pm.add_target_library_info("") # unspecified target triple + pm.add_constant_merge_pass() + pm.add_dead_arg_elimination_pass() + pm.add_function_attrs_pass() + pm.add_function_inlining_pass(225) + pm.add_global_dce_pass() + pm.add_global_optimizer_pass() + pm.add_ipsccp_pass() + pm.add_dead_code_elimination_pass() + pm.add_cfg_simplification_pass() + pm.add_gvn_pass() + pm.add_instruction_combining_pass() + pm.add_licm_pass() + pm.add_sccp_pass() + pm.add_sroa_pass() + pm.add_type_based_alias_analysis_pass() + pm.add_basic_alias_analysis_pass() + pm.add_loop_rotate_pass() + pm.add_region_info_pass() + pm.add_scalar_evolution_aa_pass() + pm.add_aggressive_dead_code_elimination_pass() + pm.add_aa_eval_pass() + pm.add_always_inliner_pass() + pm.add_break_critical_edges_pass() + pm.add_dead_store_elimination_pass() + pm.add_reverse_post_order_function_attrs_pass() + + if llvm_ver < 16: + pm.add_aggressive_instruction_combining_pass() + + pm.add_internalize_pass() + pm.add_jump_threading_pass(7) + pm.add_lcssa_pass() + pm.add_loop_deletion_pass() + pm.add_loop_extractor_pass() + pm.add_single_loop_extractor_pass() + pm.add_loop_strength_reduce_pass() + pm.add_loop_simplification_pass() + pm.add_loop_unroll_pass() + pm.add_loop_unroll_and_jam_pass() + pm.add_lower_atomic_pass() + pm.add_lower_invoke_pass() + pm.add_lower_switch_pass() + pm.add_memcpy_optimization_pass() + pm.add_merge_functions_pass() + pm.add_merge_returns_pass() + pm.add_partial_inlining_pass() + + if llvm_ver < 16: + pm.add_prune_exception_handling_pass() + + pm.add_reassociate_expressions_pass() + pm.add_demote_register_to_memory_pass() + pm.add_sink_pass() + pm.add_strip_symbols_pass() + pm.add_strip_dead_debug_info_pass() + pm.add_strip_dead_prototypes_pass() + pm.add_strip_debug_declare_pass() + pm.add_strip_nondebug_symbols_pass() + pm.add_tail_call_elimination_pass() + pm.add_basic_aa_pass() + pm.add_dependence_analysis_pass() + pm.add_dot_call_graph_pass() + pm.add_dot_cfg_printer_pass() + pm.add_dot_dom_printer_pass() + pm.add_dot_postdom_printer_pass() + pm.add_globals_mod_ref_aa_pass() + pm.add_iv_users_pass() + pm.add_lazy_value_info_pass() + pm.add_lint_pass() + pm.add_module_debug_info_pass() + pm.add_refprune_pass() + pm.add_instruction_namer_pass() + + @unittest.skipUnless(platform.machine().startswith("x86"), "x86 only") + def test_target_library_info_behavior(self): + """Test a specific situation that demonstrate TLI is affecting + optimization. See https://github.com/numba/numba/issues/8898. + """ + def run(use_tli): + mod = llvm.parse_assembly(asm_tli_exp2) + target = llvm.Target.from_triple(mod.triple) + tm = target.create_target_machine() + pm = llvm.ModulePassManager() + tm.add_analysis_passes(pm) + if use_tli: + pm.add_target_library_info(mod.triple) + pm.add_instruction_combining_pass() + pm.run(mod) + return mod + + # Run with TLI should suppress transformation of exp2 -> ldexpf + mod = run(use_tli=True) + self.assertIn("call float @llvm.exp2.f32", str(mod)) + + # Run without TLI will enable the transformation + mod = run(use_tli=False) + self.assertNotIn("call float @llvm.exp2.f32", str(mod)) + self.assertIn("call float @ldexpf", str(mod)) + + def test_instruction_namer_pass(self): + asm = asm_inlineasm3.format(triple=llvm.get_default_triple()) + mod = llvm.parse_assembly(asm) + + # Run instnamer pass + pm = llvm.ModulePassManager() + pm.add_instruction_namer_pass() + pm.run(mod) + + # Test that unnamed instructions are now named + func = mod.get_function('foo') + first_block = next(func.blocks) + instructions = list(first_block.instructions) + self.assertEqual(instructions[0].name, 'i') + self.assertEqual(instructions[1].name, 'i2') + + +class TestDylib(BaseTest): + + def test_bad_library(self): + with self.assertRaises(RuntimeError): + llvm.load_library_permanently("zzzasdkf;jasd;l") + + @unittest.skipUnless(platform.system() in ["Linux"], + "test only works on Linux") + def test_libm(self): + libm = find_library("m") + llvm.load_library_permanently(libm) + + +class TestAnalysis(BaseTest): + def build_ir_module(self): + m = ir.Module() + ft = ir.FunctionType(ir.IntType(32), [ir.IntType(32), ir.IntType(32)]) + fn = ir.Function(m, ft, "foo") + bd = ir.IRBuilder(fn.append_basic_block()) + x, y = fn.args + z = bd.add(x, y) + bd.ret(z) + return m + + def test_get_function_cfg_on_ir(self): + mod = self.build_ir_module() + foo = mod.get_global('foo') + dot_showing_inst = llvm.get_function_cfg(foo) + dot_without_inst = llvm.get_function_cfg(foo, show_inst=False) + inst = "%.5 = add i32 %.1, %.2" + self.assertIn(inst, dot_showing_inst) + self.assertNotIn(inst, dot_without_inst) + + def test_function_cfg_on_llvm_value(self): + defined = self.module().get_function('sum') + dot_showing_inst = llvm.get_function_cfg(defined, show_inst=True) + dot_without_inst = llvm.get_function_cfg(defined, show_inst=False) + # Check "digraph" + prefix = 'digraph' + self.assertIn(prefix, dot_showing_inst) + self.assertIn(prefix, dot_without_inst) + # Check function name + fname = "CFG for 'sum' function" + self.assertIn(fname, dot_showing_inst) + self.assertIn(fname, dot_without_inst) + # Check instruction + inst = "%.3 = add i32 %.1, %.2" + self.assertIn(inst, dot_showing_inst) + self.assertNotIn(inst, dot_without_inst) + + +class TestTypeParsing(BaseTest): + @contextmanager + def check_parsing(self): + mod = ir.Module() + # Yield to caller and provide the module for adding + # new GV. + yield mod + # Caller yield back and continue with testing + asm = str(mod) + llvm.parse_assembly(asm) + + def test_literal_struct(self): + # Natural layout + with self.check_parsing() as mod: + typ = ir.LiteralStructType([ir.IntType(32)]) + gv = ir.GlobalVariable(mod, typ, "foo") + # Also test constant text repr + gv.initializer = ir.Constant(typ, [1]) + + # Packed layout + with self.check_parsing() as mod: + typ = ir.LiteralStructType([ir.IntType(32)], + packed=True) + gv = ir.GlobalVariable(mod, typ, "foo") + # Also test constant text repr + gv.initializer = ir.Constant(typ, [1]) + + # Packed layout created from Constant.literal_struct + with self.check_parsing() as mod: + const = ir.Constant.literal_struct([ir.IntType(32)(1), + ir.IntType(32)(2)], + packed=True) + gv = ir.GlobalVariable(mod, const.type, "foo") + gv.initializer = const + + +class TestGlobalConstructors(TestMCJit): + def test_global_ctors_dtors(self): + # test issue #303 + # (https://github.com/numba/llvmlite/issues/303) + mod = self.module(asm_global_ctors) + ee = self.jit(mod) + ee.finalize_object() + + ee.run_static_constructors() + + # global variable should have been initialized + ptr_addr = ee.get_global_value_address("A") + ptr_t = ctypes.POINTER(ctypes.c_int32) + ptr = ctypes.cast(ptr_addr, ptr_t) + self.assertEqual(ptr.contents.value, 10) + + foo_addr = ee.get_function_address("foo") + foo = ctypes.CFUNCTYPE(ctypes.c_int32)(foo_addr) + self.assertEqual(foo(), 12) + + ee.run_static_destructors() + + # destructor should have run + self.assertEqual(ptr.contents.value, 20) + + +class TestGlobalVariables(BaseTest): + def check_global_variable_linkage(self, linkage, has_undef=True): + # This test default initializer on global variables with different + # linkages. Some linkages requires an initializer be present, while + # it is optional for others. This test uses ``parse_assembly()`` + # to verify that we are adding an `undef` automatically if user didn't + # specific one for certain linkages. It is a IR syntax error if the + # initializer is not present for certain linkages e.g. "external". + mod = ir.Module() + typ = ir.IntType(32) + gv = ir.GlobalVariable(mod, typ, "foo") + gv.linkage = linkage + asm = str(mod) + # check if 'undef' is present + if has_undef: + self.assertIn('undef', asm) + else: + self.assertNotIn('undef', asm) + # parse assembly to ensure correctness + self.module(asm) + + def test_internal_linkage(self): + self.check_global_variable_linkage('internal') + + def test_common_linkage(self): + self.check_global_variable_linkage('common') + + def test_external_linkage(self): + self.check_global_variable_linkage('external', has_undef=False) + + def test_available_externally_linkage(self): + self.check_global_variable_linkage('available_externally') + + def test_private_linkage(self): + self.check_global_variable_linkage('private') + + def test_linkonce_linkage(self): + self.check_global_variable_linkage('linkonce') + + def test_weak_linkage(self): + self.check_global_variable_linkage('weak') + + def test_appending_linkage(self): + self.check_global_variable_linkage('appending') + + def test_extern_weak_linkage(self): + self.check_global_variable_linkage('extern_weak', has_undef=False) + + def test_linkonce_odr_linkage(self): + self.check_global_variable_linkage('linkonce_odr') + + def test_weak_odr_linkage(self): + self.check_global_variable_linkage('weak_odr') + + +@unittest.skipUnless(platform.machine().startswith('x86'), "only on x86") +class TestInlineAsm(BaseTest): + def test_inlineasm(self): + llvm.initialize_native_asmparser() + m = self.module(asm=asm_inlineasm) + tm = self.target_machine(jit=False) + asm = tm.emit_assembly(m) + self.assertIn('nop', asm) + + +class TestObjectFile(BaseTest): + + mod_asm = """ + ;ModuleID = + target triple = "{triple}" + + declare i32 @sum(i32 %.1, i32 %.2) + + define i32 @sum_twice(i32 %.1, i32 %.2) {{ + %.3 = call i32 @sum(i32 %.1, i32 %.2) + %.4 = call i32 @sum(i32 %.3, i32 %.3) + ret i32 %.4 + }} + """ + + def test_object_file(self): + target_machine = self.target_machine(jit=False) + mod = self.module() + obj_bin = target_machine.emit_object(mod) + obj = llvm.ObjectFileRef.from_data(obj_bin) + # Check that we have a text section, and that she has a name and data + has_text = False + last_address = -1 + for s in obj.sections(): + if s.is_text(): + has_text = True + self.assertIsNotNone(s.name()) + self.assertTrue(s.size() > 0) + self.assertTrue(len(s.data()) > 0) + self.assertIsNotNone(s.address()) + self.assertTrue(last_address < s.address()) + last_address = s.address() + break + self.assertTrue(has_text) + + def test_add_object_file(self): + target_machine = self.target_machine(jit=False) + mod = self.module() + obj_bin = target_machine.emit_object(mod) + obj = llvm.ObjectFileRef.from_data(obj_bin) + + jit = llvm.create_mcjit_compiler(self.module(self.mod_asm), + target_machine) + + jit.add_object_file(obj) + + sum_twice = CFUNCTYPE(c_int, c_int, c_int)( + jit.get_function_address("sum_twice")) + + self.assertEqual(sum_twice(2, 3), 10) + + def test_add_object_file_from_filesystem(self): + target_machine = self.target_machine(jit=False) + mod = self.module() + obj_bin = target_machine.emit_object(mod) + temp_desc, temp_path = mkstemp() + + try: + try: + f = os.fdopen(temp_desc, "wb") + f.write(obj_bin) + f.flush() + finally: + f.close() + + jit = llvm.create_mcjit_compiler(self.module(self.mod_asm), + target_machine) + + jit.add_object_file(temp_path) + finally: + os.unlink(temp_path) + + sum_twice = CFUNCTYPE(c_int, c_int, c_int)( + jit.get_function_address("sum_twice")) + + self.assertEqual(sum_twice(2, 3), 10) + + def test_get_section_content(self): + # See Issue #632 - section contents were getting truncated at null + # bytes. + elf = bytes.fromhex(issue_632_elf) + obj = llvm.ObjectFileRef.from_data(elf) + for s in obj.sections(): + if s.is_text(): + self.assertEqual(len(s.data()), 31) + self.assertEqual(s.data().hex(), issue_632_text) + + +class TestTimePasses(BaseTest): + def test_reporting(self): + mp = llvm.create_module_pass_manager() + + pmb = llvm.create_pass_manager_builder() + pmb.opt_level = 3 + pmb.populate(mp) + + try: + llvm.set_time_passes(True) + mp.run(self.module()) + mp.run(self.module()) + mp.run(self.module()) + finally: + report = llvm.report_and_reset_timings() + llvm.set_time_passes(False) + + self.assertIsInstance(report, str) + self.assertEqual(report.count("Pass execution timing report"), 1) + + def test_empty_report(self): + # Returns empty str if no data is collected + self.assertFalse(llvm.report_and_reset_timings()) + + +class TestLLVMLockCallbacks(BaseTest): + def test_lock_callbacks(self): + events = [] + + def acq(): + events.append('acq') + + def rel(): + events.append('rel') + + # register callback + llvm.ffi.register_lock_callback(acq, rel) + + # Check: events are initially empty + self.assertFalse(events) + # Call LLVM functions + llvm.create_module_pass_manager() + # Check: there must be at least one acq and one rel + self.assertIn("acq", events) + self.assertIn("rel", events) + + # unregister callback + llvm.ffi.unregister_lock_callback(acq, rel) + + # Check: removing non-existent callbacks will trigger a ValueError + with self.assertRaises(ValueError): + llvm.ffi.unregister_lock_callback(acq, rel) + + +class TestPipelineTuningOptions(BaseTest): + + def pto(self): + return llvm.create_pipeline_tuning_options() + + def test_close(self): + pto = self.pto() + pto.close() + + def test_speed_level(self): + pto = self.pto() + self.assertIsInstance(pto.speed_level, int) + for i in range(4): + pto.speed_level = i + self.assertEqual(pto.speed_level, i) + + def test_size_level(self): + pto = self.pto() + self.assertIsInstance(pto.size_level, int) + for i in range(3): + pto.size_level = i + self.assertEqual(pto.size_level, i) + + # // FIXME: Available from llvm16 + # def test_inlining_threshold(self): + # pto = self.pto() + # with self.assertRaises(NotImplementedError): + # pto.inlining_threshold + # for i in (25, 80, 350): + # pto.inlining_threshold = i + + def test_loop_interleaving(self): + pto = self.pto() + self.assertIsInstance(pto.loop_interleaving, bool) + for b in (True, False): + pto.loop_interleaving = b + self.assertEqual(pto.loop_interleaving, b) + + def test_loop_vectorization(self): + pto = self.pto() + self.assertIsInstance(pto.loop_vectorization, bool) + for b in (True, False): + pto.loop_vectorization = b + self.assertEqual(pto.loop_vectorization, b) + + def test_slp_vectorization(self): + pto = self.pto() + self.assertIsInstance(pto.slp_vectorization, bool) + for b in (True, False): + pto.slp_vectorization = b + self.assertEqual(pto.slp_vectorization, b) + + def test_loop_unrolling(self): + pto = self.pto() + self.assertIsInstance(pto.loop_unrolling, bool) + for b in (True, False): + pto.loop_unrolling = b + self.assertEqual(pto.loop_unrolling, b) + + def test_speed_level_constraints(self): + pto = self.pto() + with self.assertRaises(ValueError): + pto.speed_level = 4 + with self.assertRaises(ValueError): + pto.speed_level = -1 + + def test_size_level_constraints(self): + pto = self.pto() + with self.assertRaises(ValueError): + pto.size_level = 3 + with self.assertRaises(ValueError): + pto.speed_level = -1 + with self.assertRaises(ValueError): + pto.speed_level = 3 + pto.size_level = 2 + + +class NewPassManagerMixin(object): + + def pb(self, speed_level=0, size_level=0): + tm = self.target_machine(jit=False) + pto = llvm.create_pipeline_tuning_options(speed_level, size_level) + pb = llvm.create_pass_builder(tm, pto) + return pb + + +class TestPassBuilder(BaseTest, NewPassManagerMixin): + + def test_close(self): + pb = self.pb() + pb.close() + + def test_pto(self): + tm = self.target_machine(jit=False) + pto = llvm.create_pipeline_tuning_options(3, 0) + pto.inlining_threshold = 2 + pto.loop_interleaving = True + pto.loop_vectorization = True + pto.slp_vectorization = True + pto.loop_unrolling = False + pb = llvm.create_pass_builder(tm, pto) + pb.close() + + def test_get_module_pass_manager(self): + pb = self.pb() + mpm = pb.getModulePassManager() + mpm.run(self.module(), pb) + pb.close() + + def test_get_function_pass_manager(self): + pb = self.pb() + fpm = pb.getFunctionPassManager() + fpm.run(self.module().get_function("sum"), pb) + pb.close() + + +class TestNewModulePassManager(BaseTest, NewPassManagerMixin): + def pm(self): + return llvm.create_new_module_pass_manager() + + def run_o_n(self, level): + mod = self.module() + orig_asm = str(mod) + pb = self.pb(speed_level=level, size_level=0) + mpm = pb.getModulePassManager() + mpm.run(mod, pb) + optimized_asm = str(mod) + return orig_asm, optimized_asm + + def test_close(self): + mpm = self.pm() + mpm.close() + + def test_run_o3(self): + orig_asm, optimized_asm = self.run_o_n(3) + self.assertIn("%.4", orig_asm) + self.assertNotIn("%.4", optimized_asm) + + def test_run_o0(self): + orig_asm, optimized_asm = self.run_o_n(0) + self.assertIn("%.4", orig_asm) + self.assertIn("%.4", optimized_asm) + + def test_instcombine(self): + pb = self.pb() + mpm = self.pm() + mpm.add_instruction_combine_pass() + mod = self.module(asm_sum4) + orig_asm = str(mod) + mpm.run(mod, pb) + optimized_asm = str(mod) + self.assertIn("%.3", orig_asm) + self.assertNotIn("%.3", optimized_asm) + + def test_optnone(self): + pb = self.pb(speed_level=3, size_level=0) + orig_asm = str(asm_alloca_optnone.replace("optnone ", "")) + mod = llvm.parse_assembly(orig_asm) + mpm = pb.getModulePassManager() + mpm.run(mod, pb) + optimized_asm = str(mod) + self.assertIn("alloca", orig_asm) + self.assertNotIn("alloca", optimized_asm) + + # Module shouldn't be optimized if the function has `optnone` attached + orig_asm_optnone = str(asm_alloca_optnone) + mpm = pb.getModulePassManager() + mod = llvm.parse_assembly(orig_asm_optnone) + mpm.run(mod, pb) + optimized_asm_optnone = str(mod) + self.assertIn("alloca", orig_asm_optnone) + self.assertIn("alloca", optimized_asm_optnone) + + def test_add_passes(self): + mpm = self.pm() + mpm.add_verifier() + mpm.add_aa_eval_pass() + mpm.add_simplify_cfg_pass() + mpm.add_loop_unroll_pass() + mpm.add_loop_rotate_pass() + mpm.add_instruction_combine_pass() + mpm.add_jump_threading_pass() + mpm.add_refprune_pass() + + +class TestNewFunctionPassManager(BaseTest, NewPassManagerMixin): + def pm(self): + return llvm.create_new_function_pass_manager() + + def test_close(self): + fpm = self.pm() + fpm.close() + + def run_o_n(self, level): + mod = self.module() + fun = mod.get_function("sum") + orig_asm = str(fun) + pb = self.pb(speed_level=level, size_level=0) + fpm = pb.getFunctionPassManager() + fpm.run(fun, pb) + optimized_asm = str(fun) + return orig_asm, optimized_asm + + def test_run_o3(self): + orig_asm, optimized_asm = self.run_o_n(3) + self.assertIn("%.4", orig_asm) + self.assertNotIn("%.4", optimized_asm) + + def test_run_o0(self): + orig_asm, optimized_asm = self.run_o_n(0) + self.assertIn("%.4", orig_asm) + self.assertIn("%.4", optimized_asm) + + def test_optnone(self): + pb = self.pb(speed_level=3, size_level=0) + orig_asm = str(asm_alloca_optnone.replace("optnone ", "")) + fun = llvm.parse_assembly(orig_asm).get_function("foo") + fpm = pb.getFunctionPassManager() + fpm.run(fun, pb) + optimized_asm = str(fun) + self.assertIn("alloca", orig_asm) + self.assertNotIn("alloca", optimized_asm) + + # Function shouldn't be optimized if the function has `optnone` attached + orig_asm_optnone = str(asm_alloca_optnone) + fun = llvm.parse_assembly(orig_asm_optnone).get_function("foo") + fpm = pb.getFunctionPassManager() + fpm.run(fun, pb) + optimized_asm_optnone = str(fun) + self.assertIn("alloca", orig_asm_optnone) + self.assertIn("alloca", optimized_asm_optnone) + + def test_instcombine(self): + pb = self.pb() + fpm = self.pm() + fun = self.module(asm_sum4).get_function("sum") + fpm.add_instruction_combine_pass() + orig_asm = str(fun) + fpm.run(fun, pb) + optimized_asm = str(fun) + self.assertIn("%.3", orig_asm) + self.assertNotIn("%.3", optimized_asm) + + # This should not crash + def test_declarations(self): + pb = self.pb(3) + fpm = pb.getFunctionPassManager() + for fun in llvm.parse_assembly(asm_declaration).functions: + fpm.run(fun, pb) + + def test_add_passes(self): + fpm = self.pm() + fpm.add_aa_eval_pass() + fpm.add_simplify_cfg_pass() + fpm.add_loop_unroll_pass() + fpm.add_loop_rotate_pass() + fpm.add_instruction_combine_pass() + fpm.add_jump_threading_pass() + fpm.add_refprune_pass() + + +if __name__ == "__main__": + unittest.main() diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_ir.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_ir.py new file mode 100644 index 0000000000000000000000000000000000000000..5b29aa82f6f0d9b42bea9a691e7541a57d5097fb --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_ir.py @@ -0,0 +1,2994 @@ +""" +IR Construction Tests +""" + +import copy +import itertools +import pickle +import re +import textwrap +import unittest + +from . import TestCase +from llvmlite import ir +from llvmlite import binding as llvm + +# FIXME: Remove me once typed pointers are no longer supported. +from llvmlite import opaque_pointers_enabled + + +int1 = ir.IntType(1) +int8 = ir.IntType(8) +int16 = ir.IntType(16) +int32 = ir.IntType(32) +int64 = ir.IntType(64) +hlf = ir.HalfType() +flt = ir.FloatType() +dbl = ir.DoubleType() + + +class TestBase(TestCase): + """ + Utilities for IR tests. + """ + + def assertInText(self, pattern, text): + """ + Assert *pattern* is in *text*, ignoring any whitespace differences + (including newlines). + """ + + def escape(c): + if not c.isalnum() and not c.isspace(): + return '\\' + c + return c + + pattern = ''.join(map(escape, pattern)) + regex = re.sub(r'\s+', r'\\s*', pattern) + self.assertRegex(text, regex) + + def assert_ir_line(self, line, mod): + lines = [line.strip() for line in str(mod).splitlines()] + self.assertIn(line, lines) + + def assert_valid_ir(self, mod): + llvm.parse_assembly(str(mod)) + + def assert_pickle_correctly(self, irobject): + """Assert that the IR object pickles and unpickles correctly. + The IR string is equal and that their type is equal + """ + newobject = pickle.loads(pickle.dumps(irobject, protocol=-1)) + self.assertIs(irobject.__class__, newobject.__class__) + self.assertEqual(str(irobject), str(newobject)) + return newobject + + def module(self): + return ir.Module() + + def function(self, module=None, name='my_func'): + module = module or self.module() + fnty = ir.FunctionType(int32, (int32, int32, dbl, + ir.PointerType(int32))) + return ir.Function(module, fnty, name) + + def block(self, func=None, name=''): + func = func or self.function() + return func.append_basic_block(name) + + def descr(self, thing): + buf = [] + thing.descr(buf) + return "".join(buf) + + def _normalize_asm(self, asm): + asm = textwrap.dedent(asm) + # Normalize indent + asm = asm.replace("\n ", "\n ") + return asm + + def check_descr_regex(self, descr, asm): + expected = self._normalize_asm(asm) + self.assertRegex(descr, expected) + + def check_descr(self, descr, asm): + expected = self._normalize_asm(asm) + self.assertEqual(descr, expected) + + def check_block(self, block, asm): + self.check_descr(self.descr(block), asm) + + def check_block_regex(self, block, asm): + self.check_descr_regex(self.descr(block), asm) + + def check_module_body(self, module, asm): + expected = self._normalize_asm(asm) + actual = module._stringify_body() + self.assertEqual(actual.strip(), expected.strip()) + + def check_metadata(self, module, asm): + """ + Check module metadata against *asm*. + """ + expected = self._normalize_asm(asm) + actual = module._stringify_metadata() + self.assertEqual(actual.strip(), expected.strip()) + + def check_func_body(self, func, asm): + expected = self._normalize_asm(asm) + actual = self.descr(func) + actual = actual.partition('{')[2].rpartition('}')[0] + self.assertEqual(actual.strip(), expected.strip()) + + +class TestFunction(TestBase): + + # FIXME: Remove `else' once TP are no longer supported. + proto = \ + """i32 @"my_func"(i32 %".1", i32 %".2", double %".3", ptr %".4")""" \ + if opaque_pointers_enabled else \ + """i32 @"my_func"(i32 %".1", i32 %".2", double %".3", i32* %".4")""" + + def test_declare(self): + # A simple declaration + func = self.function() + asm = self.descr(func).strip() + self.assertEqual(asm.strip(), "declare %s" % self.proto) + + def test_declare_attributes(self): + # Now with function attributes + func = self.function() + func.attributes.add("optsize") + func.attributes.add("alwaysinline") + func.attributes.add("convergent") + func.attributes.alignstack = 16 + tp_pers = ir.FunctionType(int8, (), var_arg=True) + pers = ir.Function(self.module(), tp_pers, '__gxx_personality_v0') + func.attributes.personality = pers + asm = self.descr(func).strip() + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(asm, + ("declare %s alwaysinline convergent optsize " + "alignstack(16) " + "personality ptr @\"__gxx_personality_v0\"") % + self.proto) + else: + self.assertEqual(asm, + ("declare %s alwaysinline convergent optsize " + "alignstack(16) personality " + "i8 (...)* @\"__gxx_personality_v0\"") % + self.proto) + # Check pickling + self.assert_pickle_correctly(func) + + def test_function_attributes(self): + # Now with parameter attributes + func = self.function() + func.args[0].add_attribute("zeroext") + func.args[1].attributes.dereferenceable = 5 + func.args[1].attributes.dereferenceable_or_null = 10 + func.args[3].attributes.align = 4 + func.args[3].add_attribute("nonnull") + func.return_value.add_attribute("noalias") + asm = self.descr(func).strip() + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(asm, + """declare noalias i32 @"my_func"(i32 zeroext %".1", i32 dereferenceable(5) dereferenceable_or_null(10) %".2", double %".3", ptr nonnull align 4 %".4")""" # noqa E501 + ) + else: + self.assertEqual(asm, + """declare noalias i32 @"my_func"(i32 zeroext %".1", i32 dereferenceable(5) dereferenceable_or_null(10) %".2", double %".3", i32* nonnull align 4 %".4")""" # noqa E501 + ) + # Check pickling + self.assert_pickle_correctly(func) + + def test_function_metadata(self): + # Now with function metadata + module = self.module() + func = self.function(module) + func.set_metadata('dbg', module.add_metadata([])) + asm = self.descr(func).strip() + self.assertEqual(asm, + f'declare {self.proto} !dbg !0' + ) + # Check pickling + self.assert_pickle_correctly(func) + + def test_function_section(self): + # Test function with section + func = self.function() + func.section = "a_section" + asm = self.descr(func).strip() + self.assertEqual(asm, + f'declare {self.proto} section "a_section"' + ) + # Check pickling + self.assert_pickle_correctly(func) + + def test_function_section_meta(self): + # Test function with section and metadata + module = self.module() + func = self.function(module) + func.section = "a_section" + func.set_metadata('dbg', module.add_metadata([])) + asm = self.descr(func).strip() + self.assertEqual(asm, + f'declare {self.proto} section "a_section" !dbg !0' + ) + # Check pickling + self.assert_pickle_correctly(func) + + def test_function_attr_meta(self): + # Test function with attributes and metadata + module = self.module() + func = self.function(module) + func.attributes.add("alwaysinline") + func.set_metadata('dbg', module.add_metadata([])) + asm = self.descr(func).strip() + self.assertEqual(asm, + f'declare {self.proto} alwaysinline !dbg !0' + ) + # Check pickling + self.assert_pickle_correctly(func) + + def test_function_attr_section(self): + # Test function with attributes and section + func = self.function() + func.attributes.add("optsize") + func.section = "a_section" + asm = self.descr(func).strip() + self.assertEqual(asm, + f'declare {self.proto} optsize section "a_section"') + # Check pickling + self.assert_pickle_correctly(func) + + def test_function_attr_section_meta(self): + # Test function with attributes, section and metadata + module = self.module() + func = self.function(module) + func.attributes.add("alwaysinline") + func.section = "a_section" + func.set_metadata('dbg', module.add_metadata([])) + asm = self.descr(func).strip() + self.assertEqual(asm, + f'declare {self.proto} alwaysinline section "a_section" !dbg !0' # noqa E501 + ) + # Check pickling + self.assert_pickle_correctly(func) + + def test_define(self): + # A simple definition + func = self.function() + func.attributes.add("alwaysinline") + block = func.append_basic_block('my_block') + builder = ir.IRBuilder(block) + builder.ret_void() + asm = self.descr(func) + self.check_descr(asm, """\ + define {proto} alwaysinline + {{ + my_block: + ret void + }} + """.format(proto=self.proto)) + + def test_declare_intrinsics(self): + module = self.module() + pint8 = int8.as_pointer() + + powi = module.declare_intrinsic('llvm.powi', [dbl]) + memset = module.declare_intrinsic('llvm.memset', [pint8, int32]) + memcpy = module.declare_intrinsic('llvm.memcpy', [pint8, pint8, int32]) + assume = module.declare_intrinsic('llvm.assume') + self.check_descr(self.descr(powi).strip(), """\ + declare double @"llvm.powi.f64"(double %".1", i32 %".2")""") + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_descr(self.descr(memset).strip(), """\ + declare void @"llvm.memset.p0i8.i32"(ptr %".1", i8 %".2", i32 %".3", i1 %".4")""") # noqa E501 + self.check_descr(self.descr(memcpy).strip(), """\ + declare void @"llvm.memcpy.p0i8.p0i8.i32"(ptr %".1", ptr %".2", i32 %".3", i1 %".4")""") # noqa E501 + else: + self.check_descr(self.descr(memset).strip(), """\ + declare void @"llvm.memset.p0i8.i32"(i8* %".1", i8 %".2", i32 %".3", i1 %".4")""") # noqa E501 + self.check_descr(self.descr(memcpy).strip(), """\ + declare void @"llvm.memcpy.p0i8.p0i8.i32"(i8* %".1", i8* %".2", i32 %".3", i1 %".4")""") # noqa E501 + self.check_descr(self.descr(assume).strip(), """\ + declare void @"llvm.assume"(i1 %".1")""") + + def test_redeclare_intrinsic(self): + module = self.module() + powi = module.declare_intrinsic('llvm.powi', [dbl]) + powi2 = module.declare_intrinsic('llvm.powi', [dbl]) + self.assertIs(powi, powi2) + + def test_pickling(self): + fn = self.function() + self.assert_pickle_correctly(fn) + + def test_alwaysinline_noinline_disallowed(self): + module = self.module() + func = self.function(module) + func.attributes.add('alwaysinline') + + msg = "Can't have alwaysinline and noinline" + with self.assertRaisesRegex(ValueError, msg): + func.attributes.add('noinline') + + def test_noinline_alwaysinline_disallowed(self): + module = self.module() + func = self.function(module) + func.attributes.add('noinline') + + msg = "Can't have alwaysinline and noinline" + with self.assertRaisesRegex(ValueError, msg): + func.attributes.add('alwaysinline') + + +class TestIR(TestBase): + + def test_unnamed_metadata(self): + # An unnamed metadata node + mod = self.module() + mod.add_metadata([int32(123), int8(42)]) + self.assert_ir_line("!0 = !{ i32 123, i8 42 }", mod) + self.assert_valid_ir(mod) + + def test_unnamed_metadata_2(self): + # Several unnamed metadata nodes + mod = self.module() + # First node has a literal metadata string + m0 = mod.add_metadata([int32(123), "kernel"]) + # Second node refers to the first one + m1 = mod.add_metadata([int64(456), m0]) + # Third node is the same as the second one + m2 = mod.add_metadata([int64(456), m0]) + self.assertIs(m2, m1) + # Fourth node refers to the first three + mod.add_metadata([m0, m1, m2]) + self.assert_ir_line('!0 = !{ i32 123, !"kernel" }', mod) + self.assert_ir_line('!1 = !{ i64 456, !0 }', mod) + self.assert_ir_line('!2 = !{ !0, !1, !1 }', mod) + + def test_unnamed_metadata_3(self): + # Passing nested metadata as a sequence + mod = self.module() + mod.add_metadata([int32(123), [int32(456)], [int32(789)], [int32(456)]]) + self.assert_ir_line('!0 = !{ i32 456 }', mod) + self.assert_ir_line('!1 = !{ i32 789 }', mod) + self.assert_ir_line('!2 = !{ i32 123, !0, !1, !0 }', mod) + + def test_metadata_string(self): + # Escaping contents of a metadata string + mod = self.module() + mod.add_metadata(["\"\\$"]) + self.assert_ir_line('!0 = !{ !"\\22\\5c$" }', mod) + + def test_named_metadata(self): + # Add a named metadata node and add metadata values to it + mod = self.module() + m0 = mod.add_metadata([int32(123)]) + m1 = mod.add_metadata([int64(456)]) + nmd = mod.add_named_metadata("foo") + nmd.add(m0) + nmd.add(m1) + nmd.add(m0) + self.assert_ir_line("!foo = !{ !0, !1, !0 }", mod) + self.assert_valid_ir(mod) + # Check get_named_metadata() + self.assertIs(nmd, mod.get_named_metadata("foo")) + with self.assertRaises(KeyError): + mod.get_named_metadata("bar") + + def test_named_metadata_2(self): + # Add and set named metadata through a single add_named_metadata() call + mod = self.module() + m0 = mod.add_metadata([int32(123)]) + mod.add_named_metadata("foo", m0) + mod.add_named_metadata("foo", [int64(456)]) + mod.add_named_metadata("foo", ["kernel"]) + mod.add_named_metadata("bar", []) + self.assert_ir_line("!foo = !{ !0, !1, !2 }", mod) + self.assert_ir_line("!0 = !{ i32 123 }", mod) + self.assert_ir_line("!1 = !{ i64 456 }", mod) + self.assert_ir_line('!2 = !{ !"kernel" }', mod) + self.assert_ir_line("!bar = !{ !3 }", mod) + self.assert_ir_line('!3 = !{ }', mod) + self.assert_valid_ir(mod) + + def test_metadata_null(self): + # A null metadata (typed) value + mod = self.module() + mod.add_metadata([int32.as_pointer()(None)]) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assert_ir_line("!0 = !{ ptr null }", mod) + else: + self.assert_ir_line("!0 = !{ i32* null }", mod) + self.assert_valid_ir(mod) + # A null metadata (untyped) value + mod = self.module() + mod.add_metadata([None, int32(123)]) + self.assert_ir_line("!0 = !{ null, i32 123 }", mod) + self.assert_valid_ir(mod) + + def test_debug_info(self): + # Add real world-looking debug information to a module + # (with various value types) + mod = self.module() + di_file = mod.add_debug_info("DIFile", { + "filename": "foo", + "directory": "bar", + }) + di_func_type = mod.add_debug_info("DISubroutineType", { + # None as `null` + "types": mod.add_metadata([None]), + }) + di_compileunit = mod.add_debug_info("DICompileUnit", { + "language": ir.DIToken("DW_LANG_Python"), + "file": di_file, + "producer": "ARTIQ", + "runtimeVersion": 0, + "isOptimized": True, + }, is_distinct=True) + mod.add_debug_info("DISubprogram", { + "name": "my_func", + "file": di_file, + "line": 11, + "type": di_func_type, + "isLocal": False, + "unit": di_compileunit, + }, is_distinct=True) + + # Check output + strmod = str(mod) + self.assert_ir_line('!0 = !DIFile(directory: "bar", filename: "foo")', + strmod) + self.assert_ir_line('!1 = !{ null }', strmod) + self.assert_ir_line('!2 = !DISubroutineType(types: !1)', strmod) + # self.assert_ir_line('!4 = !{ !3 }', strmod) + self.assert_ir_line('!3 = distinct !DICompileUnit(file: !0, ' + 'isOptimized: true, language: DW_LANG_Python, ' + 'producer: "ARTIQ", runtimeVersion: 0)', + strmod) + self.assert_ir_line('!4 = distinct !DISubprogram(file: !0, isLocal: ' + 'false, line: 11, name: "my_func", type: !2, unit: ' + '!3)', + strmod) + self.assert_valid_ir(mod) + + def test_debug_info_2(self): + # Identical debug info nodes should be merged + mod = self.module() + di1 = mod.add_debug_info("DIFile", + {"filename": "foo", + "directory": "bar", + }) + di2 = mod.add_debug_info("DIFile", + {"filename": "foo", + "directory": "bar", + }) + di3 = mod.add_debug_info("DIFile", + {"filename": "bar", + "directory": "foo", + }) + di4 = mod.add_debug_info("DIFile", + {"filename": "foo", + "directory": "bar", + }, is_distinct=True) + self.assertIs(di1, di2) + self.assertEqual(len({di1, di2, di3, di4}), 3) + # Check output + strmod = str(mod) + self.assert_ir_line('!0 = !DIFile(directory: "bar", filename: "foo")', + strmod) + self.assert_ir_line('!1 = !DIFile(directory: "foo", filename: "bar")', + strmod) + self.assert_ir_line('!2 = distinct !DIFile(directory: "bar", filename: ' + '"foo")', strmod) + self.assert_valid_ir(mod) + + def test_debug_info_gvar(self): + # This test defines a module with a global variable named 'gvar'. + # When the module is compiled and linked with a main function, gdb can + # be used to interpret and print the the value of 'gvar'. + mod = self.module() + + gvar = ir.GlobalVariable(mod, ir.FloatType(), 'gvar') + gvar.initializer = ir.Constant(ir.FloatType(), 42) + + di_float = mod.add_debug_info("DIBasicType", { + "name": "float", + "size": 32, + "encoding": ir.DIToken("DW_ATE_float") + }) + di_gvar = mod.add_debug_info("DIGlobalVariableExpression", { + "expr": mod.add_debug_info("DIExpression", {}), + "var": mod.add_debug_info("DIGlobalVariable", { + "name": gvar.name, + "type": di_float, + "isDefinition": True + }, is_distinct=True) + }) + gvar.set_metadata('dbg', di_gvar) + + # Check output + strmod = str(mod) + self.assert_ir_line('!0 = !DIBasicType(encoding: DW_ATE_float, ' + 'name: "float", size: 32)', strmod) + self.assert_ir_line('!1 = !DIExpression()', strmod) + self.assert_ir_line('!2 = distinct !DIGlobalVariable(isDefinition: ' + 'true, name: "gvar", type: !0)', strmod) + self.assert_ir_line('!3 = !DIGlobalVariableExpression(expr: !1, ' + 'var: !2)', strmod) + self.assert_ir_line('@"gvar" = global float 0x4045000000000000, ' + '!dbg !3', strmod) + + # The remaining debug info is not part of the automated test, but + # can be used to produce an object file that can be loaded into a + # debugger to print the value of gvar. This can be done by printing the + # module then compiling it with clang and inspecting with gdb: + # + # clang test_debug_info_gvar.ll -c + # printf "file test_debug_info_gvar.o \n p gvar" | gdb + # + # Which should result in the output: + # + # (gdb) $1 = 42 + + dver = [ir.IntType(32)(2), 'Dwarf Version', ir.IntType(32)(4)] + diver = [ir.IntType(32)(2), 'Debug Info Version', ir.IntType(32)(3)] + dver = mod.add_metadata(dver) + diver = mod.add_metadata(diver) + flags = mod.add_named_metadata('llvm.module.flags') + flags.add(dver) + flags.add(diver) + + di_file = mod.add_debug_info("DIFile", { + "filename": "foo", + "directory": "bar", + }) + di_cu = mod.add_debug_info("DICompileUnit", { + "language": ir.DIToken("DW_LANG_Python"), + "file": di_file, + 'emissionKind': ir.DIToken('FullDebug'), + "globals": mod.add_metadata([di_gvar]) + }, is_distinct=True) + mod.add_named_metadata('llvm.dbg.cu', di_cu) + + def test_debug_info_unicode_string(self): + mod = self.module() + mod.add_debug_info("DILocalVariable", {"name": "a∆"}) + # Check output + strmod = str(mod) + # The unicode character is utf8 encoded with \XX format, where XX is hex + name = ''.join(map(lambda x: f"\\{x:02x}", "∆".encode())) + self.assert_ir_line(f'!0 = !DILocalVariable(name: "a{name}")', strmod) + + def test_inline_assembly(self): + mod = self.module() + foo = ir.Function(mod, ir.FunctionType(ir.VoidType(), []), 'foo') + builder = ir.IRBuilder(foo.append_basic_block('')) + asmty = ir.FunctionType(int32, [int32]) + asm = ir.InlineAsm(asmty, "mov $1, $2", "=r,r", side_effect=True) + builder.call(asm, [int32(123)]) + builder.ret_void() + pat = 'call i32 asm sideeffect "mov $1, $2", "=r,r" ( i32 123 )' + self.assertInText(pat, str(mod)) + self.assert_valid_ir(mod) + + def test_builder_asm(self): + mod = self.module() + foo = ir.Function(mod, ir.FunctionType(ir.VoidType(), []), 'foo') + builder = ir.IRBuilder(foo.append_basic_block('')) + asmty = ir.FunctionType(int32, [int32]) + builder.asm(asmty, "mov $1, $2", "=r,r", [int32(123)], side_effect=True) + builder.ret_void() + pat = 'call i32 asm sideeffect "mov $1, $2", "=r,r" ( i32 123 )' + self.assertInText(pat, str(mod)) + self.assert_valid_ir(mod) + + def test_builder_load_reg(self): + mod = self.module() + foo = ir.Function(mod, ir.FunctionType(ir.VoidType(), []), 'foo') + builder = ir.IRBuilder(foo.append_basic_block('')) + builder.load_reg(ir.IntType(64), "rax") + builder.ret_void() + pat = 'call i64 asm "", "={rax}"' + self.assertInText(pat, str(mod)) + self.assert_valid_ir(mod) + + def test_builder_store_reg(self): + mod = self.module() + foo = ir.Function(mod, ir.FunctionType(ir.VoidType(), []), 'foo') + builder = ir.IRBuilder(foo.append_basic_block('')) + builder.store_reg(int64(123), ir.IntType(64), "rax") + builder.ret_void() + pat = 'call void asm sideeffect "", "{rax}" ( i64 123 )' + self.assertInText(pat, str(mod)) + self.assert_valid_ir(mod) + + +class TestGlobalValues(TestBase): + + def test_globals_access(self): + mod = self.module() + foo = ir.Function(mod, ir.FunctionType(ir.VoidType(), []), 'foo') + ir.Function(mod, ir.FunctionType(ir.VoidType(), []), 'bar') + globdouble = ir.GlobalVariable(mod, ir.DoubleType(), 'globdouble') + self.assertEqual(mod.get_global('foo'), foo) + self.assertEqual(mod.get_global('globdouble'), globdouble) + with self.assertRaises(KeyError): + mod.get_global('kkk') + # Globals should have a useful repr() + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(repr(globdouble), + "") + else: + self.assertEqual( + repr(globdouble), + "") + + def test_functions_global_values_access(self): + """ + Accessing functions and global values through Module.functions + and Module.global_values. + """ + mod = self.module() + fty = ir.FunctionType(ir.VoidType(), []) + foo = ir.Function(mod, fty, 'foo') + bar = ir.Function(mod, fty, 'bar') + globdouble = ir.GlobalVariable(mod, ir.DoubleType(), 'globdouble') + self.assertEqual(set(mod.functions), set((foo, bar))) + self.assertEqual(set(mod.global_values), set((foo, bar, globdouble))) + + def test_global_variables_ir(self): + """ + IR serialization of global variables. + """ + mod = self.module() + # the following have side effects and write to self.module() + a = ir.GlobalVariable(mod, int8, 'a') # noqa F841 + b = ir.GlobalVariable(mod, int8, 'b', addrspace=42) # noqa F841 + # Initialized global variable doesn't default to "external" + c = ir.GlobalVariable(mod, int32, 'c') + c.initializer = int32(123) + d = ir.GlobalVariable(mod, int32, 'd') + d.global_constant = True + # Non-external linkage implies default "undef" initializer + e = ir.GlobalVariable(mod, int32, 'e') + e.linkage = "internal" + f = ir.GlobalVariable(mod, int32, 'f', addrspace=456) + f.unnamed_addr = True + g = ir.GlobalVariable(mod, int32, 'g') + g.linkage = "internal" + g.initializer = int32(123) + g.align = 16 + h = ir.GlobalVariable(mod, int32, 'h') + h.linkage = "internal" + h.initializer = int32(123) + h.section = "h_section" + i = ir.GlobalVariable(mod, int32, 'i') + i.linkage = "internal" + i.initializer = int32(456) + i.align = 8 + i.section = "i_section" + self.check_module_body(mod, """\ + @"a" = external global i8 + @"b" = external addrspace(42) global i8 + @"c" = global i32 123 + @"d" = external constant i32 + @"e" = internal global i32 undef + @"f" = external unnamed_addr addrspace(456) global i32 + @"g" = internal global i32 123, align 16 + @"h" = internal global i32 123, section "h_section" + @"i" = internal global i32 456, section "i_section", align 8 + """) + + def test_pickle(self): + mod = self.module() + self.assert_pickle_correctly(mod) + + +class TestBlock(TestBase): + + def test_attributes(self): + func = self.function() + block = ir.Block(parent=func, name='start') + self.assertIs(block.parent, func) + self.assertFalse(block.is_terminated) + + def test_descr(self): + block = self.block(name='my_block') + self.assertEqual(self.descr(block), "my_block:\n") + block.instructions.extend(['a', 'b']) + self.assertEqual(self.descr(block), "my_block:\n a\n b\n") + + def test_replace(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + c = builder.add(a, b, 'c') + d = builder.sub(a, b, 'd') + builder.mul(d, b, 'e') + f = ir.Instruction(block, a.type, 'sdiv', (c, b), 'f') + self.check_block(block, """\ + my_block: + %"c" = add i32 %".1", %".2" + %"d" = sub i32 %".1", %".2" + %"e" = mul i32 %"d", %".2" + """) + block.replace(d, f) + self.check_block(block, """\ + my_block: + %"c" = add i32 %".1", %".2" + %"f" = sdiv i32 %"c", %".2" + %"e" = mul i32 %"f", %".2" + """) + + def test_repr(self): + """ + Blocks should have a useful repr() + """ + func = self.function() + block = ir.Block(parent=func, name='start') + self.assertEqual(repr(block), "") + + +class TestBuildInstructions(TestBase): + """ + Test IR generation of LLVM instructions through the IRBuilder class. + """ + + maxDiff = 4000 + + def test_simple(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + inst = builder.add(a, b, 'res') + self.check_block(block, """\ + my_block: + %"res" = add i32 %".1", %".2" + """) + # Instructions should have a useful repr() + self.assertEqual(repr(inst), + ", " + ")>") + + def test_binops(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b, ff = builder.function.args[:3] + builder.add(a, b, 'c') + builder.fadd(a, b, 'd') + builder.sub(a, b, 'e') + builder.fsub(a, b, 'f') + builder.mul(a, b, 'g') + builder.fmul(a, b, 'h') + builder.udiv(a, b, 'i') + builder.sdiv(a, b, 'j') + builder.fdiv(a, b, 'k') + builder.urem(a, b, 'l') + builder.srem(a, b, 'm') + builder.frem(a, b, 'n') + builder.or_(a, b, 'o') + builder.and_(a, b, 'p') + builder.xor(a, b, 'q') + builder.shl(a, b, 'r') + builder.ashr(a, b, 's') + builder.lshr(a, b, 't') + with self.assertRaises(ValueError) as cm: + builder.add(a, ff) + self.assertEqual(str(cm.exception), + "Operands must be the same type, got (i32, double)") + self.assertFalse(block.is_terminated) + self.check_block(block, """\ + my_block: + %"c" = add i32 %".1", %".2" + %"d" = fadd i32 %".1", %".2" + %"e" = sub i32 %".1", %".2" + %"f" = fsub i32 %".1", %".2" + %"g" = mul i32 %".1", %".2" + %"h" = fmul i32 %".1", %".2" + %"i" = udiv i32 %".1", %".2" + %"j" = sdiv i32 %".1", %".2" + %"k" = fdiv i32 %".1", %".2" + %"l" = urem i32 %".1", %".2" + %"m" = srem i32 %".1", %".2" + %"n" = frem i32 %".1", %".2" + %"o" = or i32 %".1", %".2" + %"p" = and i32 %".1", %".2" + %"q" = xor i32 %".1", %".2" + %"r" = shl i32 %".1", %".2" + %"s" = ashr i32 %".1", %".2" + %"t" = lshr i32 %".1", %".2" + """) + + def test_binop_flags(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + # As tuple + builder.add(a, b, 'c', flags=('nuw',)) + # and as list + builder.sub(a, b, 'd', flags=['nuw', 'nsw']) + self.check_block(block, """\ + my_block: + %"c" = add nuw i32 %".1", %".2" + %"d" = sub nuw nsw i32 %".1", %".2" + """) + + def test_binop_fastmath_flags(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + # As tuple + builder.fadd(a, b, 'c', flags=('fast',)) + # and as list + builder.fsub(a, b, 'd', flags=['ninf', 'nsz']) + self.check_block(block, """\ + my_block: + %"c" = fadd fast i32 %".1", %".2" + %"d" = fsub ninf nsz i32 %".1", %".2" + """) + + def test_binops_with_overflow(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + builder.sadd_with_overflow(a, b, 'c') + builder.smul_with_overflow(a, b, 'd') + builder.ssub_with_overflow(a, b, 'e') + builder.uadd_with_overflow(a, b, 'f') + builder.umul_with_overflow(a, b, 'g') + builder.usub_with_overflow(a, b, 'h') + self.check_block(block, """\ +my_block: + %"c" = call {i32, i1} @"llvm.sadd.with.overflow.i32"(i32 %".1", i32 %".2") + %"d" = call {i32, i1} @"llvm.smul.with.overflow.i32"(i32 %".1", i32 %".2") + %"e" = call {i32, i1} @"llvm.ssub.with.overflow.i32"(i32 %".1", i32 %".2") + %"f" = call {i32, i1} @"llvm.uadd.with.overflow.i32"(i32 %".1", i32 %".2") + %"g" = call {i32, i1} @"llvm.umul.with.overflow.i32"(i32 %".1", i32 %".2") + %"h" = call {i32, i1} @"llvm.usub.with.overflow.i32"(i32 %".1", i32 %".2") + """) + + def test_unary_ops(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b, c = builder.function.args[:3] + builder.neg(a, 'd') + builder.not_(b, 'e') + builder.fneg(c, 'f') + self.assertFalse(block.is_terminated) + self.check_block(block, """\ + my_block: + %"d" = sub i32 0, %".1" + %"e" = xor i32 %".2", -1 + %"f" = fneg double %".3" + """) + + def test_replace_operand(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + undef1 = ir.Constant(ir.IntType(32), ir.Undefined) + undef2 = ir.Constant(ir.IntType(32), ir.Undefined) + c = builder.add(undef1, undef2, 'c') + self.check_block(block, """\ + my_block: + %"c" = add i32 undef, undef + """) + c.replace_usage(undef1, a) + c.replace_usage(undef2, b) + self.check_block(block, """\ + my_block: + %"c" = add i32 %".1", %".2" + """) + + def test_integer_comparisons(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + builder.icmp_unsigned('==', a, b, 'c') + builder.icmp_unsigned('!=', a, b, 'd') + builder.icmp_unsigned('<', a, b, 'e') + builder.icmp_unsigned('<=', a, b, 'f') + builder.icmp_unsigned('>', a, b, 'g') + builder.icmp_unsigned('>=', a, b, 'h') + builder.icmp_signed('==', a, b, 'i') + builder.icmp_signed('!=', a, b, 'j') + builder.icmp_signed('<', a, b, 'k') + builder.icmp_signed('<=', a, b, 'l') + builder.icmp_signed('>', a, b, 'm') + builder.icmp_signed('>=', a, b, 'n') + with self.assertRaises(ValueError): + builder.icmp_signed('uno', a, b, 'zz') + with self.assertRaises(ValueError): + builder.icmp_signed('foo', a, b, 'zz') + self.assertFalse(block.is_terminated) + self.check_block(block, """\ + my_block: + %"c" = icmp eq i32 %".1", %".2" + %"d" = icmp ne i32 %".1", %".2" + %"e" = icmp ult i32 %".1", %".2" + %"f" = icmp ule i32 %".1", %".2" + %"g" = icmp ugt i32 %".1", %".2" + %"h" = icmp uge i32 %".1", %".2" + %"i" = icmp eq i32 %".1", %".2" + %"j" = icmp ne i32 %".1", %".2" + %"k" = icmp slt i32 %".1", %".2" + %"l" = icmp sle i32 %".1", %".2" + %"m" = icmp sgt i32 %".1", %".2" + %"n" = icmp sge i32 %".1", %".2" + """) + + def test_float_comparisons(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + builder.fcmp_ordered('==', a, b, 'c') + builder.fcmp_ordered('!=', a, b, 'd') + builder.fcmp_ordered('<', a, b, 'e') + builder.fcmp_ordered('<=', a, b, 'f') + builder.fcmp_ordered('>', a, b, 'g') + builder.fcmp_ordered('>=', a, b, 'h') + builder.fcmp_unordered('==', a, b, 'i') + builder.fcmp_unordered('!=', a, b, 'j') + builder.fcmp_unordered('<', a, b, 'k') + builder.fcmp_unordered('<=', a, b, 'l') + builder.fcmp_unordered('>', a, b, 'm') + builder.fcmp_unordered('>=', a, b, 'n') + # fcmp_ordered and fcmp_unordered are the same for these cases + builder.fcmp_ordered('ord', a, b, 'u') + builder.fcmp_ordered('uno', a, b, 'v') + builder.fcmp_unordered('ord', a, b, 'w') + builder.fcmp_unordered('uno', a, b, 'x') + builder.fcmp_unordered('olt', a, b, 'y', + flags=['nnan', 'ninf', 'nsz', 'arcp', 'fast']) + self.assertFalse(block.is_terminated) + self.check_block(block, """\ + my_block: + %"c" = fcmp oeq i32 %".1", %".2" + %"d" = fcmp one i32 %".1", %".2" + %"e" = fcmp olt i32 %".1", %".2" + %"f" = fcmp ole i32 %".1", %".2" + %"g" = fcmp ogt i32 %".1", %".2" + %"h" = fcmp oge i32 %".1", %".2" + %"i" = fcmp ueq i32 %".1", %".2" + %"j" = fcmp une i32 %".1", %".2" + %"k" = fcmp ult i32 %".1", %".2" + %"l" = fcmp ule i32 %".1", %".2" + %"m" = fcmp ugt i32 %".1", %".2" + %"n" = fcmp uge i32 %".1", %".2" + %"u" = fcmp ord i32 %".1", %".2" + %"v" = fcmp uno i32 %".1", %".2" + %"w" = fcmp ord i32 %".1", %".2" + %"x" = fcmp uno i32 %".1", %".2" + %"y" = fcmp nnan ninf nsz arcp fast olt i32 %".1", %".2" + """) + + def test_misc_ops(self): + block = self.block(name='my_block') + t = ir.Constant(int1, True) + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + builder.select(t, a, b, 'c', flags=('arcp', 'nnan')) + self.assertFalse(block.is_terminated) + builder.unreachable() + self.assertTrue(block.is_terminated) + self.check_block(block, """\ + my_block: + %"c" = select arcp nnan i1 true, i32 %".1", i32 %".2" + unreachable + """) + + def test_phi(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + bb2 = builder.function.append_basic_block('b2') + bb3 = builder.function.append_basic_block('b3') + phi = builder.phi(int32, 'my_phi', flags=('fast',)) + phi.add_incoming(a, bb2) + phi.add_incoming(b, bb3) + self.assertFalse(block.is_terminated) + self.check_block(block, """\ + my_block: + %"my_phi" = phi fast i32 [%".1", %"b2"], [%".2", %"b3"] + """) + + def test_mem_ops(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b, z = builder.function.args[:3] + c = builder.alloca(int32, name='c') + d = builder.alloca(int32, size=42, name='d') # noqa F841 + e = builder.alloca(dbl, size=a, name='e') + e.align = 8 + self.assertEqual(e.type, ir.PointerType(dbl)) + ee = builder.store(z, e) + self.assertEqual(ee.type, ir.VoidType()) + f = builder.store(b, c) + self.assertEqual(f.type, ir.VoidType()) + g = builder.load(c, 'g') + self.assertEqual(g.type, int32) + # With alignment + h = builder.store(b, c, align=1) + self.assertEqual(h.type, ir.VoidType()) + i = builder.load(c, 'i', align=1) + self.assertEqual(i.type, int32) + # Atomics + j = builder.store_atomic(b, c, ordering="seq_cst", align=4) + self.assertEqual(j.type, ir.VoidType()) + k = builder.load_atomic(c, ordering="seq_cst", align=4, name='k') + self.assertEqual(k.type, int32) + if opaque_pointers_enabled: + ptr = ir.Constant(ir.PointerType(), None) + else: + ptr = ir.Constant(ir.PointerType(int32), None) + builder.store(ir.Constant(int32, 5), ptr) + # Not pointer types + with self.assertRaises(TypeError): + builder.store(b, a) + with self.assertRaises(TypeError): + builder.load(b) + # Mismatching pointer type + with self.assertRaises(TypeError) as cm: + builder.store(b, e) + + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(cm.exception), + "cannot store i32 to ptr: mismatching types") + self.check_block(block, """\ + my_block: + %"c" = alloca i32 + %"d" = alloca i32, i32 42 + %"e" = alloca double, i32 %".1", align 8 + store double %".3", ptr %"e" + store i32 %".2", ptr %"c" + %"g" = load i32, ptr %"c" + store i32 %".2", ptr %"c", align 1 + %"i" = load i32, ptr %"c", align 1 + store atomic i32 %".2", ptr %"c" seq_cst, align 4 + %"k" = load atomic i32, ptr %"c" seq_cst, align 4 + store i32 5, ptr null + """) + else: + self.assertEqual(str(cm.exception), + "cannot store i32 to double*: mismatching types") + self.check_block(block, """\ + my_block: + %"c" = alloca i32 + %"d" = alloca i32, i32 42 + %"e" = alloca double, i32 %".1", align 8 + store double %".3", double* %"e" + store i32 %".2", i32* %"c" + %"g" = load i32, i32* %"c" + store i32 %".2", i32* %"c", align 1 + %"i" = load i32, i32* %"c", align 1 + store atomic i32 %".2", i32* %"c" seq_cst, align 4 + %"k" = load atomic i32, i32* %"c" seq_cst, align 4 + store i32 5, i32* null + """) + + def test_gep(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + c = builder.alloca(ir.PointerType(int32), name='c') + d = builder.gep(c, [ir.Constant(int32, 5), a], name='d') + self.assertEqual(d.type, ir.PointerType(int32)) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"c" = alloca ptr + %"d" = getelementptr ptr, ptr %"c", i32 5, i32 %".1" + """) + else: + self.check_block(block, """\ + my_block: + %"c" = alloca i32* + %"d" = getelementptr i32*, i32** %"c", i32 5, i32 %".1" + """) + # XXX test with more complex types + + def test_gep_castinstr(self): + # similar to: + # numba::runtime::nrtdynmod.py_define_nrt_meminfo_data() + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + int8ptr = int8.as_pointer() + ls = ir.LiteralStructType([int64, int8ptr, int8ptr, int8ptr, int64]) + d = builder.bitcast(a, ls.as_pointer(), name='d') + e = builder.gep(d, [ir.Constant(int32, x) for x in [0, 3]], name='e') + self.assertEqual(e.type, ir.PointerType(int8ptr)) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"d" = bitcast i32 %".1" to ptr + %"e" = getelementptr {i64, ptr, ptr, ptr, i64}, ptr %"d", i32 0, i32 3 + """) # noqa E501 + else: + self.check_block(block, """\ + my_block: + %"d" = bitcast i32 %".1" to {i64, i8*, i8*, i8*, i64}* + %"e" = getelementptr {i64, i8*, i8*, i8*, i64}, {i64, i8*, i8*, i8*, i64}* %"d", i32 0, i32 3 + """) # noqa E501 + + def test_gep_castinstr_addrspace(self): + # similar to: + # numba::runtime::nrtdynmod.py_define_nrt_meminfo_data() + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + addrspace = 4 + int8ptr = int8.as_pointer() + ls = ir.LiteralStructType([int64, int8ptr, int8ptr, int8ptr, int64]) + d = builder.bitcast(a, ls.as_pointer(addrspace=addrspace), name='d') + e = builder.gep(d, [ir.Constant(int32, x) for x in [0, 3]], name='e') + self.assertEqual(e.type.addrspace, addrspace) + self.assertEqual(e.type, ir.PointerType(int8ptr, addrspace=addrspace)) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"d" = bitcast i32 %".1" to ptr addrspace(4) + %"e" = getelementptr {i64, ptr, ptr, ptr, i64}, ptr addrspace(4) %"d", i32 0, i32 3 + """) # noqa E501 + else: + self.check_block(block, """\ + my_block: + %"d" = bitcast i32 %".1" to {i64, i8*, i8*, i8*, i64} addrspace(4)* + %"e" = getelementptr {i64, i8*, i8*, i8*, i64}, {i64, i8*, i8*, i8*, i64} addrspace(4)* %"d", i32 0, i32 3 + """) # noqa E501 + + def test_gep_addrspace(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + addrspace = 4 + c = builder.alloca(ir.PointerType(int32, addrspace=addrspace), name='c') + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(c.type), 'ptr') + else: + self.assertEqual(str(c.type), 'i32 addrspace(4)**') + self.assertEqual(c.type.pointee.addrspace, addrspace) + d = builder.gep(c, [ir.Constant(int32, 5), a], name='d') + self.assertEqual(d.type.addrspace, addrspace) + e = builder.gep(d, [ir.Constant(int32, 10)], name='e') + self.assertEqual(e.type.addrspace, addrspace) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"c" = alloca ptr addrspace(4) + %"d" = getelementptr ptr addrspace(4), ptr %"c", i32 5, i32 %".1" + %"e" = getelementptr i32, ptr addrspace(4) %"d", i32 10 + """) # noqa E501 + else: + self.check_block(block, """\ + my_block: + %"c" = alloca i32 addrspace(4)* + %"d" = getelementptr i32 addrspace(4)*, i32 addrspace(4)** %"c", i32 5, i32 %".1" + %"e" = getelementptr i32, i32 addrspace(4)* %"d", i32 10 + """) # noqa E501 + + def test_extract_insert_value(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + tp_inner = ir.LiteralStructType([int32, int1]) + tp_outer = ir.LiteralStructType([int8, tp_inner]) + c_inner = ir.Constant(tp_inner, (ir.Constant(int32, 4), + ir.Constant(int1, True))) + # Flat structure + c = builder.extract_value(c_inner, 0, name='c') # noqa F841 + d = builder.insert_value(c_inner, a, 0, name='d') # noqa F841 + e = builder.insert_value(d, ir.Constant(int1, False), 1, name='e') # noqa F841 E501 + self.assertEqual(d.type, tp_inner) + self.assertEqual(e.type, tp_inner) + # Nested structure + p_outer = builder.alloca(tp_outer, name='ptr') + j = builder.load(p_outer, name='j') + k = builder.extract_value(j, 0, name='k') + l = builder.extract_value(j, 1, name='l') + m = builder.extract_value(j, (1, 0), name='m') + n = builder.extract_value(j, (1, 1), name='n') + o = builder.insert_value(j, l, 1, name='o') + p = builder.insert_value(j, a, (1, 0), name='p') + self.assertEqual(k.type, int8) + self.assertEqual(l.type, tp_inner) + self.assertEqual(m.type, int32) + self.assertEqual(n.type, int1) + self.assertEqual(o.type, tp_outer) + self.assertEqual(p.type, tp_outer) + + with self.assertRaises(TypeError): + # Not an aggregate + builder.extract_value(p_outer, 0) + with self.assertRaises(TypeError): + # Indexing too deep + builder.extract_value(c_inner, (0, 0)) + with self.assertRaises(TypeError): + # Index out of structure bounds + builder.extract_value(c_inner, 5) + with self.assertRaises(TypeError): + # Not an aggregate + builder.insert_value(a, b, 0) + with self.assertRaises(TypeError): + # Replacement value has the wrong type + builder.insert_value(c_inner, a, 1) + + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"c" = extractvalue {i32, i1} {i32 4, i1 true}, 0 + %"d" = insertvalue {i32, i1} {i32 4, i1 true}, i32 %".1", 0 + %"e" = insertvalue {i32, i1} %"d", i1 false, 1 + %"ptr" = alloca {i8, {i32, i1}} + %"j" = load {i8, {i32, i1}}, ptr %"ptr" + %"k" = extractvalue {i8, {i32, i1}} %"j", 0 + %"l" = extractvalue {i8, {i32, i1}} %"j", 1 + %"m" = extractvalue {i8, {i32, i1}} %"j", 1, 0 + %"n" = extractvalue {i8, {i32, i1}} %"j", 1, 1 + %"o" = insertvalue {i8, {i32, i1}} %"j", {i32, i1} %"l", 1 + %"p" = insertvalue {i8, {i32, i1}} %"j", i32 %".1", 1, 0 + """) + else: + self.check_block(block, """\ + my_block: + %"c" = extractvalue {i32, i1} {i32 4, i1 true}, 0 + %"d" = insertvalue {i32, i1} {i32 4, i1 true}, i32 %".1", 0 + %"e" = insertvalue {i32, i1} %"d", i1 false, 1 + %"ptr" = alloca {i8, {i32, i1}} + %"j" = load {i8, {i32, i1}}, {i8, {i32, i1}}* %"ptr" + %"k" = extractvalue {i8, {i32, i1}} %"j", 0 + %"l" = extractvalue {i8, {i32, i1}} %"j", 1 + %"m" = extractvalue {i8, {i32, i1}} %"j", 1, 0 + %"n" = extractvalue {i8, {i32, i1}} %"j", 1, 1 + %"o" = insertvalue {i8, {i32, i1}} %"j", {i32, i1} %"l", 1 + %"p" = insertvalue {i8, {i32, i1}} %"j", i32 %".1", 1, 0 + """) + + def test_cast_ops(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b, fa, ptr = builder.function.args[:4] + c = builder.trunc(a, int8, name='c') + d = builder.zext(c, int32, name='d') # noqa F841 + e = builder.sext(c, int32, name='e') # noqa F841 + fb = builder.fptrunc(fa, flt, 'fb') + fc = builder.fpext(fb, dbl, 'fc') # noqa F841 + g = builder.fptoui(fa, int32, 'g') + h = builder.fptosi(fa, int8, 'h') + fd = builder.uitofp(g, flt, 'fd') # noqa F841 + fe = builder.sitofp(h, dbl, 'fe') # noqa F841 + i = builder.ptrtoint(ptr, int32, 'i') + j = builder.inttoptr(i, ir.PointerType(int8), 'j') # noqa F841 + k = builder.bitcast(a, flt, "k") # noqa F841 + self.assertFalse(block.is_terminated) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"c" = trunc i32 %".1" to i8 + %"d" = zext i8 %"c" to i32 + %"e" = sext i8 %"c" to i32 + %"fb" = fptrunc double %".3" to float + %"fc" = fpext float %"fb" to double + %"g" = fptoui double %".3" to i32 + %"h" = fptosi double %".3" to i8 + %"fd" = uitofp i32 %"g" to float + %"fe" = sitofp i8 %"h" to double + %"i" = ptrtoint ptr %".4" to i32 + %"j" = inttoptr i32 %"i" to ptr + %"k" = bitcast i32 %".1" to float + """) + else: + self.check_block(block, """\ + my_block: + %"c" = trunc i32 %".1" to i8 + %"d" = zext i8 %"c" to i32 + %"e" = sext i8 %"c" to i32 + %"fb" = fptrunc double %".3" to float + %"fc" = fpext float %"fb" to double + %"g" = fptoui double %".3" to i32 + %"h" = fptosi double %".3" to i8 + %"fd" = uitofp i32 %"g" to float + %"fe" = sitofp i8 %"h" to double + %"i" = ptrtoint i32* %".4" to i32 + %"j" = inttoptr i32 %"i" to i8* + %"k" = bitcast i32 %".1" to float + """) + + def test_atomicrmw(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + c = builder.alloca(int32, name='c') + d = builder.atomic_rmw('add', c, a, 'monotonic', 'd') + self.assertEqual(d.type, int32) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"c" = alloca i32 + %"d" = atomicrmw add ptr %"c", i32 %".1" monotonic + """) + else: + self.check_block(block, """\ + my_block: + %"c" = alloca i32 + %"d" = atomicrmw add i32* %"c", i32 %".1" monotonic + """) + + def test_branch(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + bb_target = builder.function.append_basic_block(name='target') + builder.branch(bb_target) + self.assertTrue(block.is_terminated) + self.check_block(block, """\ + my_block: + br label %"target" + """) + + def test_cbranch(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + bb_true = builder.function.append_basic_block(name='b_true') + bb_false = builder.function.append_basic_block(name='b_false') + builder.cbranch(ir.Constant(int1, False), bb_true, bb_false) + self.assertTrue(block.is_terminated) + self.check_block(block, """\ + my_block: + br i1 false, label %"b_true", label %"b_false" + """) + + def test_cbranch_weights(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + bb_true = builder.function.append_basic_block(name='b_true') + bb_false = builder.function.append_basic_block(name='b_false') + br = builder.cbranch(ir.Constant(int1, False), bb_true, bb_false) + br.set_weights([5, 42]) + self.assertTrue(block.is_terminated) + self.check_block(block, """\ + my_block: + br i1 false, label %"b_true", label %"b_false", !prof !0 + """) + self.check_metadata(builder.module, """\ + !0 = !{ !"branch_weights", i32 5, i32 42 } + """) + + def test_branch_indirect(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + bb_1 = builder.function.append_basic_block(name='b_1') + bb_2 = builder.function.append_basic_block(name='b_2') + indirectbr = builder.branch_indirect( + ir.BlockAddress(builder.function, bb_1)) + indirectbr.add_destination(bb_1) + indirectbr.add_destination(bb_2) + self.assertTrue(block.is_terminated) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + indirectbr ptr blockaddress(@"my_func", %"b_1"), [label %"b_1", label %"b_2"] + """) # noqa E501 + else: + self.check_block(block, """\ + my_block: + indirectbr i8* blockaddress(@"my_func", %"b_1"), [label %"b_1", label %"b_2"] + """) # noqa E501 + + def test_returns(self): + def check(block, expected_ir): + self.assertTrue(block.is_terminated) + self.check_block(block, expected_ir) + + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + builder.ret_void() + check(block, """\ + my_block: + ret void + """) + + block = self.block(name='other_block') + builder = ir.IRBuilder(block) + builder.ret(int32(5)) + check(block, """\ + other_block: + ret i32 5 + """) + + # With metadata + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + inst = builder.ret_void() + inst.set_metadata("dbg", block.module.add_metadata(())) + check(block, """\ + my_block: + ret void, !dbg !0 + """) + + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + inst = builder.ret(int32(6)) + inst.set_metadata("dbg", block.module.add_metadata(())) + check(block, """\ + my_block: + ret i32 6, !dbg !0 + """) + + def test_switch(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + bb_onzero = builder.function.append_basic_block(name='onzero') + bb_onone = builder.function.append_basic_block(name='onone') + bb_ontwo = builder.function.append_basic_block(name='ontwo') + bb_else = builder.function.append_basic_block(name='otherwise') + sw = builder.switch(a, bb_else) + sw.add_case(ir.Constant(int32, 0), bb_onzero) + sw.add_case(ir.Constant(int32, 1), bb_onone) + # A plain Python value gets converted into the right IR constant + sw.add_case(2, bb_ontwo) + self.assertTrue(block.is_terminated) + self.check_block(block, """\ + my_block: + switch i32 %".1", label %"otherwise" [i32 0, label %"onzero" i32 1, label %"onone" i32 2, label %"ontwo"] + """) # noqa E501 + + def test_call(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + tp_f = ir.FunctionType(flt, (int32, int32)) + tp_g = ir.FunctionType(dbl, (int32,), var_arg=True) + tp_h = ir.FunctionType(hlf, (int32, int32)) + f = ir.Function(builder.function.module, tp_f, 'f') + g = ir.Function(builder.function.module, tp_g, 'g') + h = ir.Function(builder.function.module, tp_h, 'h') + builder.call(f, (a, b), 'res_f') + builder.call(g, (b, a), 'res_g') + builder.call(h, (a, b), 'res_h') + builder.call(f, (a, b), 'res_f_fast', cconv='fastcc') + res_f_readonly = builder.call(f, (a, b), 'res_f_readonly') + res_f_readonly.attributes.add('readonly') + builder.call(f, (a, b), 'res_fast', fastmath='fast') + builder.call(f, (a, b), 'res_nnan_ninf', fastmath=('nnan', 'ninf')) + builder.call(f, (a, b), 'res_noinline', attrs='noinline') + builder.call(f, (a, b), 'res_alwaysinline', attrs='alwaysinline') + builder.call(f, (a, b), 'res_noinline_ro', attrs=('noinline', + 'readonly')) + builder.call(f, (a, b), 'res_convergent', attrs='convergent') + self.check_block(block, """\ + my_block: + %"res_f" = call float @"f"(i32 %".1", i32 %".2") + %"res_g" = call double (i32, ...) @"g"(i32 %".2", i32 %".1") + %"res_h" = call half @"h"(i32 %".1", i32 %".2") + %"res_f_fast" = call fastcc float @"f"(i32 %".1", i32 %".2") + %"res_f_readonly" = call float @"f"(i32 %".1", i32 %".2") readonly + %"res_fast" = call fast float @"f"(i32 %".1", i32 %".2") + %"res_nnan_ninf" = call ninf nnan float @"f"(i32 %".1", i32 %".2") + %"res_noinline" = call float @"f"(i32 %".1", i32 %".2") noinline + %"res_alwaysinline" = call float @"f"(i32 %".1", i32 %".2") alwaysinline + %"res_noinline_ro" = call float @"f"(i32 %".1", i32 %".2") noinline readonly + %"res_convergent" = call float @"f"(i32 %".1", i32 %".2") convergent + """) # noqa E501 + + def test_call_metadata(self): + """ + Function calls with metadata arguments. + """ + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + dbg_declare_ty = ir.FunctionType(ir.VoidType(), [ir.MetaDataType()] * 3) + dbg_declare = ir.Function( + builder.module, + dbg_declare_ty, + 'llvm.dbg.declare') + a = builder.alloca(int32, name="a") + b = builder.module.add_metadata(()) + builder.call(dbg_declare, (a, b, b)) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"a" = alloca i32 + call void @"llvm.dbg.declare"(metadata ptr %"a", metadata !0, metadata !0) + """) # noqa E501 + else: + self.check_block(block, """\ + my_block: + %"a" = alloca i32 + call void @"llvm.dbg.declare"(metadata i32* %"a", metadata !0, metadata !0) + """) # noqa E501 + + def test_call_attributes(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + fun_ty = ir.FunctionType( + ir.VoidType(), (int32.as_pointer(), int32, int32.as_pointer())) + fun = ir.Function(builder.function.module, fun_ty, 'fun') + fun.args[0].add_attribute('sret') + retval = builder.alloca(int32, name='retval') + other = builder.alloca(int32, name='other') + builder.call( + fun, + (retval, ir.Constant(int32, 42), other), + arg_attrs={ + 0: ('sret', 'noalias'), + 2: 'noalias' + } + ) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block_regex(block, """\ + my_block: + %"retval" = alloca i32 + %"other" = alloca i32 + call void @"fun"\\(ptr noalias sret(\\(i32\\))? %"retval", i32 42, ptr noalias %"other"\\) + """) # noqa E501 + else: + self.check_block_regex(block, """\ + my_block: + %"retval" = alloca i32 + %"other" = alloca i32 + call void @"fun"\\(i32\\* noalias sret(\\(i32\\))? %"retval", i32 42, i32\\* noalias %"other"\\) + """) # noqa E501 + + def test_call_tail(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + fun_ty = ir.FunctionType(ir.VoidType(), ()) + fun = ir.Function(builder.function.module, fun_ty, 'my_fun') + + builder.call(fun, ()) + builder.call(fun, (), tail=False) + builder.call(fun, (), tail=True) + builder.call(fun, (), tail='tail') + builder.call(fun, (), tail='notail') + builder.call(fun, (), tail='musttail') + builder.call(fun, (), tail=[]) # This is a falsy value + builder.call(fun, (), tail='not a marker') # This is a truthy value + + self.check_block(block, """\ + my_block: + call void @"my_fun"() + call void @"my_fun"() + tail call void @"my_fun"() + tail call void @"my_fun"() + notail call void @"my_fun"() + musttail call void @"my_fun"() + call void @"my_fun"() + tail call void @"my_fun"() + """) # noqa E501 + + def test_invalid_call_attributes(self): + block = self.block() + builder = ir.IRBuilder(block) + fun_ty = ir.FunctionType(ir.VoidType(), ()) + fun = ir.Function(builder.function.module, fun_ty, 'fun') + with self.assertRaises(ValueError): + # The function has no arguments, so this should fail. + builder.call(fun, (), arg_attrs={0: 'sret'}) + + def test_invoke(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + tp_f = ir.FunctionType(flt, (int32, int32)) + f = ir.Function(builder.function.module, tp_f, 'f') + bb_normal = builder.function.append_basic_block(name='normal') + bb_unwind = builder.function.append_basic_block(name='unwind') + builder.invoke(f, (a, b), bb_normal, bb_unwind, 'res_f') + self.check_block(block, """\ + my_block: + %"res_f" = invoke float @"f"(i32 %".1", i32 %".2") + to label %"normal" unwind label %"unwind" + """) + + def test_invoke_attributes(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + fun_ty = ir.FunctionType( + ir.VoidType(), (int32.as_pointer(), int32, int32.as_pointer())) + fun = ir.Function(builder.function.module, fun_ty, 'fun') + fun.calling_convention = "fastcc" + fun.args[0].add_attribute('sret') + retval = builder.alloca(int32, name='retval') + other = builder.alloca(int32, name='other') + bb_normal = builder.function.append_basic_block(name='normal') + bb_unwind = builder.function.append_basic_block(name='unwind') + builder.invoke( + fun, + (retval, ir.Constant(int32, 42), other), + bb_normal, + bb_unwind, + cconv='fastcc', + fastmath='fast', + attrs='noinline', + arg_attrs={ + 0: ('sret', 'noalias'), + 2: 'noalias' + } + ) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block_regex(block, """\ + my_block: + %"retval" = alloca i32 + %"other" = alloca i32 + invoke fast fastcc void @"fun"\\(ptr noalias sret(\\(i32\\))? %"retval", i32 42, ptr noalias %"other"\\) noinline + to label %"normal" unwind label %"unwind" + """) # noqa E501 + else: + self.check_block_regex(block, """\ + my_block: + %"retval" = alloca i32 + %"other" = alloca i32 + invoke fast fastcc void @"fun"\\(i32\\* noalias sret(\\(i32\\))? %"retval", i32 42, i32\\* noalias %"other"\\) noinline + to label %"normal" unwind label %"unwind" + """) # noqa E501 + + def test_landingpad(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + lp = builder.landingpad(ir.LiteralStructType([int32, + int8.as_pointer()]), 'lp') + int_typeinfo = ir.GlobalVariable(builder.function.module, + int8.as_pointer(), "_ZTIi") + int_typeinfo.global_constant = True + lp.add_clause(ir.CatchClause(int_typeinfo)) + lp.add_clause(ir.FilterClause(ir.Constant(ir.ArrayType( + int_typeinfo.type, 1), [int_typeinfo]))) + builder.resume(lp) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"lp" = landingpad {i32, ptr} + catch ptr @"_ZTIi" + filter [1 x ptr] [ptr @"_ZTIi"] + resume {i32, ptr} %"lp" + """) + else: + self.check_block(block, """\ + my_block: + %"lp" = landingpad {i32, i8*} + catch i8** @"_ZTIi" + filter [1 x i8**] [i8** @"_ZTIi"] + resume {i32, i8*} %"lp" + """) + + def test_assume(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + c = builder.icmp_signed('>', a, b, name='c') + builder.assume(c) + self.check_block(block, """\ + my_block: + %"c" = icmp sgt i32 %".1", %".2" + call void @"llvm.assume"(i1 %"c") + """) + + def test_vector_ops(self): + block = self.block(name='insert_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + a.name = 'a' + b.name = 'b' + + vecty = ir.VectorType(a.type, 2) + vec = ir.Constant(vecty, ir.Undefined) + idxty = ir.IntType(32) + vec = builder.insert_element(vec, a, idxty(0), name='vec1') + vec = builder.insert_element(vec, b, idxty(1), name='vec2') + + self.check_block(block, """\ +insert_block: + %"vec1" = insertelement <2 x i32> , i32 %"a", i32 0 + %"vec2" = insertelement <2 x i32> %"vec1", i32 %"b", i32 1 + """) + + block = builder.append_basic_block("shuffle_block") + builder.branch(block) + builder.position_at_end(block) + + mask = ir.Constant(vecty, [1, 0]) + builder.shuffle_vector(vec, vec, mask, name='shuf') + + self.check_block(block, """\ + shuffle_block: + %"shuf" = shufflevector <2 x i32> %"vec2", <2 x i32> %"vec2", <2 x i32> + """) # noqa E501 + + block = builder.append_basic_block("add_block") + builder.branch(block) + builder.position_at_end(block) + + builder.add(vec, vec, name='sum') + + self.check_block(block, """\ + add_block: + %"sum" = add <2 x i32> %"vec2", %"vec2" + """) + + block = builder.append_basic_block("extract_block") + builder.branch(block) + builder.position_at_end(block) + + c = builder.extract_element(vec, idxty(0), name='ex1') + d = builder.extract_element(vec, idxty(1), name='ex2') + + self.check_block(block, """\ + extract_block: + %"ex1" = extractelement <2 x i32> %"vec2", i32 0 + %"ex2" = extractelement <2 x i32> %"vec2", i32 1 + """) + + builder.ret(builder.add(c, d)) + self.assert_valid_ir(builder.module) + + def test_bitreverse(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int64, 5) + c = builder.bitreverse(a, name='c') + builder.ret(c) + self.check_block(block, """\ + my_block: + %"c" = call i64 @"llvm.bitreverse.i64"(i64 5) + ret i64 %"c" + """) + + def test_bitreverse_wrongtype(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(flt, 5) + + with self.assertRaises(TypeError) as raises: + builder.bitreverse(a, name='c') + self.assertIn( + "expected an integer type, got float", + str(raises.exception)) + + def test_fence(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + with self.assertRaises(ValueError) as raises: + builder.fence("monotonic", None) + self.assertIn( + "Invalid fence ordering \"monotonic\"!", + str(raises.exception)) + with self.assertRaises(ValueError) as raises: + builder.fence(None, "monotonic") + self.assertIn( + "Invalid fence ordering \"None\"!", + str(raises.exception)) + builder.fence("acquire", None) + builder.fence("release", "singlethread") + builder.fence("acq_rel", "singlethread") + builder.fence("seq_cst") + builder.ret_void() + self.check_block(block, """\ + my_block: + fence acquire + fence syncscope("singlethread") release + fence syncscope("singlethread") acq_rel + fence seq_cst + ret void + """) + + def test_comment(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + with self.assertRaises(AssertionError): + builder.comment("so\nmany lines") + builder.comment("my comment") + builder.ret_void() + self.check_block(block, """\ + my_block: + ; my comment + ret void + """) + + def test_bswap(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int32, 5) + c = builder.bswap(a, name='c') + builder.ret(c) + self.check_block(block, """\ + my_block: + %"c" = call i32 @"llvm.bswap.i32"(i32 5) + ret i32 %"c" + """) + + def test_ctpop(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int16, 5) + c = builder.ctpop(a, name='c') + builder.ret(c) + self.check_block(block, """\ + my_block: + %"c" = call i16 @"llvm.ctpop.i16"(i16 5) + ret i16 %"c" + """) + + def test_ctlz(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int16, 5) + b = ir.Constant(int1, 1) + c = builder.ctlz(a, b, name='c') + builder.ret(c) + self.check_block(block, """\ + my_block: + %"c" = call i16 @"llvm.ctlz.i16"(i16 5, i1 1) + ret i16 %"c" + """) + + def test_convert_to_fp16_f32(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(flt, 5.0) + b = builder.convert_to_fp16(a, name='b') + builder.ret(b) + self.check_block(block, """\ + my_block: + %"b" = call i16 @"llvm.convert.to.fp16.f32"(float 0x4014000000000000) + ret i16 %"b" + """) # noqa E501 + + def test_convert_to_fp16_f32_wrongtype(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int16, 5) + + with self.assertRaises(TypeError) as raises: + builder.convert_to_fp16(a, name='b') + self.assertIn( + "expected a float type, got i16", + str(raises.exception)) + + def test_convert_from_fp16_f32(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int16, 5) + b = builder.convert_from_fp16(a, name='b', to=flt) + builder.ret(b) + self.check_block(block, """\ + my_block: + %"b" = call float @"llvm.convert.from.fp16.f32"(i16 5) + ret float %"b" + """) + + def test_convert_from_fp16_f32_notype(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(flt, 5.5) + + with self.assertRaises(TypeError) as raises: + builder.convert_from_fp16(a, name='b') + self.assertIn( + "expected a float return type", + str(raises.exception)) + + def test_convert_from_fp16_f32_wrongtype(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(flt, 5.5) + + with self.assertRaises(TypeError) as raises: + builder.convert_from_fp16(a, name='b', to=flt) + self.assertIn( + "expected an i16 type, got float", + str(raises.exception)) + + def test_convert_from_fp16_f32_wrongtype2(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(flt, 5.5) + + with self.assertRaises(TypeError) as raises: + builder.convert_from_fp16(a, name='b', to=int16) + self.assertIn( + "expected a float type, got i16", + str(raises.exception)) + + def test_cttz(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int64, 5) + b = ir.Constant(int1, 1) + c = builder.cttz(a, b, name='c') + builder.ret(c) + self.check_block(block, """\ + my_block: + %"c" = call i64 @"llvm.cttz.i64"(i64 5, i1 1) + ret i64 %"c" + """) + + def test_cttz_wrongflag(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int64, 5) + b = ir.Constant(int32, 3) + + with self.assertRaises(TypeError) as raises: + builder.cttz(a, b, name='c') + self.assertIn( + "expected an i1 type, got i32", + str(raises.exception)) + + def test_cttz_wrongtype(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(flt, 5) + b = ir.Constant(int1, 1) + + with self.assertRaises(TypeError) as raises: + builder.cttz(a, b, name='c') + self.assertIn( + "expected an integer type, got float", + str(raises.exception)) + + def test_fma(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(flt, 5) + b = ir.Constant(flt, 1) + c = ir.Constant(flt, 2) + fma = builder.fma(a, b, c, name='fma') + builder.ret(fma) + self.check_block(block, """\ + my_block: + %"fma" = call float @"llvm.fma.f32"(float 0x4014000000000000, float 0x3ff0000000000000, float 0x4000000000000000) + ret float %"fma" + """) # noqa E501 + + def test_fma_wrongtype(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(int32, 5) + b = ir.Constant(int32, 1) + c = ir.Constant(int32, 2) + + with self.assertRaises(TypeError) as raises: + builder.fma(a, b, c, name='fma') + self.assertIn( + "expected an floating point type, got i32", + str(raises.exception)) + + def test_fma_mixedtypes(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a = ir.Constant(flt, 5) + b = ir.Constant(dbl, 1) + c = ir.Constant(flt, 2) + + with self.assertRaises(TypeError) as raises: + builder.fma(a, b, c, name='fma') + self.assertIn( + "expected types to be the same, got float, double, float", + str(raises.exception)) + + def test_arg_attributes(self): + def gen_code(attr_name): + fnty = ir.FunctionType(ir.IntType(32), [ir.IntType(32).as_pointer(), + ir.IntType(32)]) + module = ir.Module() + + func = ir.Function(module, fnty, name="sum") + + bb_entry = func.append_basic_block() + bb_loop = func.append_basic_block() + bb_exit = func.append_basic_block() + + builder = ir.IRBuilder() + builder.position_at_end(bb_entry) + + builder.branch(bb_loop) + builder.position_at_end(bb_loop) + + index = builder.phi(ir.IntType(32)) + index.add_incoming(ir.Constant(index.type, 0), bb_entry) + accum = builder.phi(ir.IntType(32)) + accum.add_incoming(ir.Constant(accum.type, 0), bb_entry) + + func.args[0].add_attribute(attr_name) + ptr = builder.gep(func.args[0], [index]) + value = builder.load(ptr) + + added = builder.add(accum, value) + accum.add_incoming(added, bb_loop) + + indexp1 = builder.add(index, ir.Constant(index.type, 1)) + index.add_incoming(indexp1, bb_loop) + + cond = builder.icmp_unsigned('<', indexp1, func.args[1]) + builder.cbranch(cond, bb_loop, bb_exit) + + builder.position_at_end(bb_exit) + builder.ret(added) + + return str(module) + + for attr_name in ( + 'byref', + 'byval', + 'elementtype', + 'immarg', + 'inalloca', + 'inreg', + 'nest', + 'noalias', + 'nocapture', + 'nofree', + 'nonnull', + 'noundef', + 'preallocated', + 'returned', + 'signext', + 'swiftasync', + 'swifterror', + 'swiftself', + 'zeroext', + ): + # If this parses, we emitted the right byval attribute format + llvm.parse_assembly(gen_code(attr_name)) + # sret doesn't fit this pattern and is tested in test_call_attributes + + +class TestBuilderMisc(TestBase): + """ + Test various other features of the IRBuilder class. + """ + + def test_attributes(self): + block = self.block(name='start') + builder = ir.IRBuilder(block) + self.assertIs(builder.function, block.parent) + self.assertIsInstance(builder.function, ir.Function) + self.assertIs(builder.module, block.parent.module) + self.assertIsInstance(builder.module, ir.Module) + + def test_goto_block(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + a, b = builder.function.args[:2] + builder.add(a, b, 'c') + bb_new = builder.append_basic_block(name='foo') + with builder.goto_block(bb_new): + builder.fadd(a, b, 'd') + with builder.goto_entry_block(): + builder.sub(a, b, 'e') + builder.fsub(a, b, 'f') + builder.branch(bb_new) + builder.mul(a, b, 'g') + with builder.goto_block(bb_new): + builder.fmul(a, b, 'h') + self.check_block(block, """\ + my_block: + %"c" = add i32 %".1", %".2" + %"e" = sub i32 %".1", %".2" + %"g" = mul i32 %".1", %".2" + """) + self.check_block(bb_new, """\ + foo: + %"d" = fadd i32 %".1", %".2" + %"f" = fsub i32 %".1", %".2" + %"h" = fmul i32 %".1", %".2" + br label %"foo" + """) + + def test_if_then(self): + block = self.block(name='one') + builder = ir.IRBuilder(block) + z = ir.Constant(int1, 0) + a = builder.add(z, z, 'a') + with builder.if_then(a) as bbend: + builder.add(z, z, 'b') + # Block will be terminated implicitly + self.assertIs(builder.block, bbend) + c = builder.add(z, z, 'c') + with builder.if_then(c): + builder.add(z, z, 'd') + builder.branch(block) + # No implicit termination + self.check_func_body(builder.function, """\ + one: + %"a" = add i1 0, 0 + br i1 %"a", label %"one.if", label %"one.endif" + one.if: + %"b" = add i1 0, 0 + br label %"one.endif" + one.endif: + %"c" = add i1 0, 0 + br i1 %"c", label %"one.endif.if", label %"one.endif.endif" + one.endif.if: + %"d" = add i1 0, 0 + br label %"one" + one.endif.endif: + """) + + def test_if_then_nested(self): + # Implicit termination in a nested if/then + block = self.block(name='one') + builder = ir.IRBuilder(block) + z = ir.Constant(int1, 0) + a = builder.add(z, z, 'a') + with builder.if_then(a): + b = builder.add(z, z, 'b') + with builder.if_then(b): + builder.add(z, z, 'c') + builder.ret_void() + self.check_func_body(builder.function, """\ + one: + %"a" = add i1 0, 0 + br i1 %"a", label %"one.if", label %"one.endif" + one.if: + %"b" = add i1 0, 0 + br i1 %"b", label %"one.if.if", label %"one.if.endif" + one.endif: + ret void + one.if.if: + %"c" = add i1 0, 0 + br label %"one.if.endif" + one.if.endif: + br label %"one.endif" + """) + + def test_if_then_long_label(self): + full_label = 'Long' * 20 + block = self.block(name=full_label) + builder = ir.IRBuilder(block) + z = ir.Constant(int1, 0) + a = builder.add(z, z, 'a') + with builder.if_then(a): + b = builder.add(z, z, 'b') + with builder.if_then(b): + builder.add(z, z, 'c') + builder.ret_void() + self.check_func_body(builder.function, """\ + {full_label}: + %"a" = add i1 0, 0 + br i1 %"a", label %"{label}.if", label %"{label}.endif" + {label}.if: + %"b" = add i1 0, 0 + br i1 %"b", label %"{label}.if.if", label %"{label}.if.endif" + {label}.endif: + ret void + {label}.if.if: + %"c" = add i1 0, 0 + br label %"{label}.if.endif" + {label}.if.endif: + br label %"{label}.endif" + """.format(full_label=full_label, label=full_label[:25] + '..')) + + def test_if_then_likely(self): + def check(likely): + block = self.block(name='one') + builder = ir.IRBuilder(block) + z = ir.Constant(int1, 0) + with builder.if_then(z, likely=likely): + pass + self.check_block(block, """\ + one: + br i1 0, label %"one.if", label %"one.endif", !prof !0 + """) + return builder + builder = check(True) + self.check_metadata(builder.module, """\ + !0 = !{ !"branch_weights", i32 99, i32 1 } + """) + builder = check(False) + self.check_metadata(builder.module, """\ + !0 = !{ !"branch_weights", i32 1, i32 99 } + """) + + def test_if_else(self): + block = self.block(name='one') + builder = ir.IRBuilder(block) + z = ir.Constant(int1, 0) + a = builder.add(z, z, 'a') + with builder.if_else(a) as (then, otherwise): + with then: + builder.add(z, z, 'b') + with otherwise: + builder.add(z, z, 'c') + # Each block will be terminated implicitly + with builder.if_else(a) as (then, otherwise): + with then: + builder.branch(block) + with otherwise: + builder.ret_void() + # No implicit termination + self.check_func_body(builder.function, """\ + one: + %"a" = add i1 0, 0 + br i1 %"a", label %"one.if", label %"one.else" + one.if: + %"b" = add i1 0, 0 + br label %"one.endif" + one.else: + %"c" = add i1 0, 0 + br label %"one.endif" + one.endif: + br i1 %"a", label %"one.endif.if", label %"one.endif.else" + one.endif.if: + br label %"one" + one.endif.else: + ret void + one.endif.endif: + """) + + def test_if_else_likely(self): + def check(likely): + block = self.block(name='one') + builder = ir.IRBuilder(block) + z = ir.Constant(int1, 0) + with builder.if_else(z, likely=likely) as (then, otherwise): + with then: + builder.branch(block) + with otherwise: + builder.ret_void() + self.check_func_body(builder.function, """\ + one: + br i1 0, label %"one.if", label %"one.else", !prof !0 + one.if: + br label %"one" + one.else: + ret void + one.endif: + """) + return builder + builder = check(True) + self.check_metadata(builder.module, """\ + !0 = !{ !"branch_weights", i32 99, i32 1 } + """) + builder = check(False) + self.check_metadata(builder.module, """\ + !0 = !{ !"branch_weights", i32 1, i32 99 } + """) + + def test_positioning(self): + """ + Test IRBuilder.position_{before,after,at_start,at_end}. + """ + func = self.function() + builder = ir.IRBuilder() + z = ir.Constant(int32, 0) + bb_one = func.append_basic_block(name='one') + bb_two = func.append_basic_block(name='two') + bb_three = func.append_basic_block(name='three') + # .at_start(empty block) + builder.position_at_start(bb_one) + builder.add(z, z, 'a') + # .at_end(empty block) + builder.position_at_end(bb_two) + builder.add(z, z, 'm') + builder.add(z, z, 'n') + # .at_start(block) + builder.position_at_start(bb_two) + o = builder.add(z, z, 'o') + builder.add(z, z, 'p') + # .at_end(block) + builder.position_at_end(bb_one) + b = builder.add(z, z, 'b') + # .after(instr) + builder.position_after(o) + builder.add(z, z, 'q') + # .before(instr) + builder.position_before(b) + builder.add(z, z, 'c') + self.check_block(bb_one, """\ + one: + %"a" = add i32 0, 0 + %"c" = add i32 0, 0 + %"b" = add i32 0, 0 + """) + self.check_block(bb_two, """\ + two: + %"o" = add i32 0, 0 + %"q" = add i32 0, 0 + %"p" = add i32 0, 0 + %"m" = add i32 0, 0 + %"n" = add i32 0, 0 + """) + self.check_block(bb_three, """\ + three: + """) + + def test_instruction_removal(self): + func = self.function() + builder = ir.IRBuilder() + blk = func.append_basic_block(name='entry') + builder.position_at_end(blk) + k = ir.Constant(int32, 1234) + a = builder.add(k, k, 'a') + retvoid = builder.ret_void() + self.assertTrue(blk.is_terminated) + builder.remove(retvoid) + self.assertFalse(blk.is_terminated) + b = builder.mul(a, a, 'b') + c = builder.add(b, b, 'c') + builder.remove(c) + builder.ret_void() + self.assertTrue(blk.is_terminated) + self.check_block(blk, """\ + entry: + %"a" = add i32 1234, 1234 + %"b" = mul i32 %"a", %"a" + ret void + """) + + def test_metadata(self): + block = self.block(name='my_block') + builder = ir.IRBuilder(block) + builder.debug_metadata = builder.module.add_metadata([]) + builder.alloca(ir.PointerType(int32), name='c') + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.check_block(block, """\ + my_block: + %"c" = alloca ptr, !dbg !0 + """) + else: + self.check_block(block, """\ + my_block: + %"c" = alloca i32*, !dbg !0 + """) + + +class TestTypes(TestBase): + + def has_logical_equality(self, ty): + while isinstance(ty, ir.PointerType): + ty = ty.pointee + return not isinstance(ty, ir.LabelType) + + def assorted_types(self): + """ + A bunch of mutually unequal types + """ + # Avoid polluting the namespace + context = ir.Context() + types = [ + ir.LabelType(), ir.VoidType(), + ir.FunctionType(int1, (int8, int8)), ir.FunctionType(int1, (int8,)), + ir.FunctionType(int1, (int8,), var_arg=True), + ir.FunctionType(int8, (int8,)), + int1, int8, int32, flt, dbl, + ir.ArrayType(flt, 5), ir.ArrayType(dbl, 5), ir.ArrayType(dbl, 4), + ir.LiteralStructType((int1, int8)), ir.LiteralStructType((int8, + int1)), + context.get_identified_type("MyType1"), + context.get_identified_type("MyType2"), + ] + types += [ir.PointerType(tp) for tp in types + if not isinstance(tp, (ir.VoidType, ir.LabelType))] + + return types + + def test_pickling(self): + types = self.assorted_types() + for ty in types: + newty = self.assert_pickle_correctly(ty) + if self.has_logical_equality(ty): + self.assertEqual(newty, ty) + + def test_comparisons(self): + types = self.assorted_types() + for a, b in itertools.product(types, types): + if a is not b: + self.assertFalse(a == b, (a, b)) + self.assertTrue(a != b, (a, b)) + # We assume copy.copy() works fine here... + for tp in types: + other = copy.copy(tp) + if self.has_logical_equality(tp): + self.assertTrue(tp == other, (tp, other)) + self.assertFalse(tp != other, (tp, other)) + else: + self.assertFalse(tp == other, (tp, other)) + self.assertTrue(tp != other, (tp, other)) + + def test_str(self): + """ + Test the string representation of types. + """ + self.assertEqual(str(int1), 'i1') + self.assertEqual(str(ir.IntType(29)), 'i29') + self.assertEqual(str(flt), 'float') + self.assertEqual(str(dbl), 'double') + self.assertEqual(str(ir.VoidType()), 'void') + self.assertEqual(str(ir.FunctionType(int1, ())), 'i1 ()') + self.assertEqual(str(ir.FunctionType(int1, (flt,))), 'i1 (float)') + self.assertEqual(str(ir.FunctionType(int1, (flt, dbl))), + 'i1 (float, double)') + self.assertEqual(str(ir.FunctionType(int1, (), var_arg=True)), + 'i1 (...)') + self.assertEqual(str(ir.FunctionType(int1, (flt,), var_arg=True)), + 'i1 (float, ...)') + self.assertEqual(str(ir.FunctionType(int1, (flt, dbl), var_arg=True)), + 'i1 (float, double, ...)') + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(ir.PointerType(int32)), 'ptr') + self.assertEqual(str(ir.PointerType(ir.PointerType(int32))), 'ptr') + else: + self.assertEqual(str(ir.PointerType(int32)), 'i32*') + self.assertEqual(str(ir.PointerType(ir.PointerType(int32))), + 'i32**') + self.assertEqual(str(ir.ArrayType(int1, 5)), '[5 x i1]') + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(ir.ArrayType(ir.PointerType(int1), 5)), + '[5 x ptr]') + self.assertEqual(str(ir.PointerType(ir.ArrayType(int1, 5))), 'ptr') + else: + self.assertEqual(str(ir.ArrayType(ir.PointerType(int1), 5)), + '[5 x i1*]') + self.assertEqual(str(ir.PointerType(ir.ArrayType(int1, 5))), + '[5 x i1]*') + self.assertEqual(str(ir.LiteralStructType((int1,))), '{i1}') + self.assertEqual(str(ir.LiteralStructType((int1, flt))), '{i1, float}') + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(ir.LiteralStructType(( + ir.PointerType(int1), ir.LiteralStructType((int32, int8))))), + '{ptr, {i32, i8}}') + else: + self.assertEqual(str(ir.LiteralStructType(( + ir.PointerType(int1), ir.LiteralStructType((int32, int8))))), + '{i1*, {i32, i8}}') + self.assertEqual(str(ir.LiteralStructType((int1,), packed=True)), + '<{i1}>') + self.assertEqual(str(ir.LiteralStructType((int1, flt), packed=True)), + '<{i1, float}>') + + # Avoid polluting the namespace + context = ir.Context() + mytype = context.get_identified_type("MyType") + self.assertEqual(str(mytype), "%\"MyType\"") + mytype1 = context.get_identified_type("MyType\\") + self.assertEqual(str(mytype1), "%\"MyType\\5c\"") + mytype2 = context.get_identified_type("MyType\"") + self.assertEqual(str(mytype2), "%\"MyType\\22\"") + + def test_hash(self): + for typ in filter(self.has_logical_equality, self.assorted_types()): + self.assertEqual(hash(typ), hash(copy.copy(typ))) + + def test_gep(self): + def check_constant(tp, i, expected): + actual = tp.gep(ir.Constant(int32, i)) + self.assertEqual(actual, expected) + + def check_index_type(tp): + index = ir.Constant(dbl, 1.0) + with self.assertRaises(TypeError): + tp.gep(index) + + tp = ir.PointerType(dbl) + for i in range(5): + check_constant(tp, i, dbl) + check_index_type(tp) + + tp = ir.ArrayType(int1, 3) + for i in range(3): + check_constant(tp, i, int1) + check_index_type(tp) + + tp = ir.LiteralStructType((dbl, ir.LiteralStructType((int1, int8)))) + check_constant(tp, 0, dbl) + check_constant(tp, 1, ir.LiteralStructType((int1, int8))) + with self.assertRaises(IndexError): + tp.gep(ir.Constant(int32, 2)) + check_index_type(tp) + + context = ir.Context() + tp = ir.IdentifiedStructType(context, "MyType") + tp.set_body(dbl, ir.LiteralStructType((int1, int8))) + check_constant(tp, 0, dbl) + check_constant(tp, 1, ir.LiteralStructType((int1, int8))) + with self.assertRaises(IndexError): + tp.gep(ir.Constant(int32, 2)) + check_index_type(tp) + + def test_abi_size(self): + td = llvm.create_target_data("e-m:e-i64:64-f80:128-n8:16:32:64-S128") + + def check(tp, expected): + self.assertEqual(tp.get_abi_size(td), expected) + check(int8, 1) + check(int32, 4) + check(int64, 8) + check(ir.ArrayType(int8, 5), 5) + check(ir.ArrayType(int32, 5), 20) + check(ir.LiteralStructType((dbl, flt, flt)), 16) + + def test_abi_alignment(self): + td = llvm.create_target_data("e-m:e-i64:64-f80:128-n8:16:32:64-S128") + + def check(tp, expected): + self.assertIn(tp.get_abi_alignment(td), expected) + check(int8, (1, 2, 4)) + check(int32, (4,)) + check(int64, (8,)) + check(ir.ArrayType(int8, 5), (1, 2, 4)) + check(ir.ArrayType(int32, 5), (4,)) + check(ir.LiteralStructType((dbl, flt, flt)), (8,)) + + def test_identified_struct(self): + context = ir.Context() + mytype = context.get_identified_type("MyType") + module = ir.Module(context=context) + self.assertTrue(mytype.is_opaque) + self.assert_valid_ir(module) + oldstr = str(module) + mytype.set_body(ir.IntType(32), ir.IntType(64), ir.FloatType()) + self.assertFalse(mytype.is_opaque) + self.assert_valid_ir(module) + self.assertNotEqual(oldstr, str(module)) + + def test_identified_struct_packed(self): + td = llvm.create_target_data("e-m:e-i64:64-f80:128-n8:16:32:64-S128") + context = ir.Context() + mytype = context.get_identified_type("MyType", True) + module = ir.Module(context=context) + self.assertTrue(mytype.is_opaque) + self.assert_valid_ir(module) + oldstr = str(module) + mytype.set_body(ir.IntType(16), ir.IntType(64), ir.FloatType()) + self.assertEqual(mytype.get_element_offset(td, 1, context), 2) + self.assertFalse(mytype.is_opaque) + self.assert_valid_ir(module) + self.assertNotEqual(oldstr, str(module)) + + def test_target_data_non_default_context(self): + context = ir.Context() + mytype = context.get_identified_type("MyType") + mytype.elements = [ir.IntType(32)] + td = llvm.create_target_data("e-m:e-i64:64-f80:128-n8:16:32:64-S128") + self.assertEqual(mytype.get_abi_size(td, context=context), 4) + + def test_vector(self): + vecty = ir.VectorType(ir.IntType(32), 8) + self.assertEqual(str(vecty), "<8 x i32>") + + +def c32(i): + return ir.Constant(int32, i) + + +class TestConstant(TestBase): + + def test_integers(self): + c = ir.Constant(int32, 42) + self.assertEqual(str(c), 'i32 42') + c = ir.Constant(int1, 1) + self.assertEqual(str(c), 'i1 1') + c = ir.Constant(int1, 0) + self.assertEqual(str(c), 'i1 0') + c = ir.Constant(int1, True) + self.assertEqual(str(c), 'i1 true') + c = ir.Constant(int1, False) + self.assertEqual(str(c), 'i1 false') + c = ir.Constant(int1, ir.Undefined) + self.assertEqual(str(c), 'i1 undef') + c = ir.Constant(int1, None) + self.assertEqual(str(c), 'i1 0') + + def test_reals(self): + # XXX Test NaNs and infs + c = ir.Constant(flt, 1.5) + self.assertEqual(str(c), 'float 0x3ff8000000000000') + c = ir.Constant(flt, -1.5) + self.assertEqual(str(c), 'float 0xbff8000000000000') + c = ir.Constant(dbl, 1.5) + self.assertEqual(str(c), 'double 0x3ff8000000000000') + c = ir.Constant(dbl, -1.5) + self.assertEqual(str(c), 'double 0xbff8000000000000') + c = ir.Constant(dbl, ir.Undefined) + self.assertEqual(str(c), 'double undef') + c = ir.Constant(dbl, None) + self.assertEqual(str(c), 'double 0.0') + + def test_arrays(self): + c = ir.Constant(ir.ArrayType(int32, 3), (c32(5), c32(6), c32(4))) + self.assertEqual(str(c), '[3 x i32] [i32 5, i32 6, i32 4]') + c = ir.Constant(ir.ArrayType(int32, 2), (c32(5), c32(ir.Undefined))) + self.assertEqual(str(c), '[2 x i32] [i32 5, i32 undef]') + + c = ir.Constant.literal_array((c32(5), c32(6), c32(ir.Undefined))) + self.assertEqual(str(c), '[3 x i32] [i32 5, i32 6, i32 undef]') + with self.assertRaises(TypeError) as raises: + ir.Constant.literal_array((c32(5), ir.Constant(flt, 1.5))) + self.assertEqual(str(raises.exception), + "all elements must have the same type") + + c = ir.Constant(ir.ArrayType(int32, 2), ir.Undefined) + self.assertEqual(str(c), '[2 x i32] undef') + c = ir.Constant(ir.ArrayType(int32, 2), None) + self.assertEqual(str(c), '[2 x i32] zeroinitializer') + # Raw array syntax + c = ir.Constant(ir.ArrayType(int8, 11), bytearray(b"foobar_123\x80")) + self.assertEqual(str(c), r'[11 x i8] c"foobar_123\80"') + c = ir.Constant(ir.ArrayType(int8, 4), bytearray(b"\x00\x01\x04\xff")) + self.assertEqual(str(c), r'[4 x i8] c"\00\01\04\ff"') + # Recursive instantiation of inner constants + c = ir.Constant(ir.ArrayType(int32, 3), (5, ir.Undefined, 6)) + self.assertEqual(str(c), '[3 x i32] [i32 5, i32 undef, i32 6]') + # Invalid number of args + with self.assertRaises(ValueError): + ir.Constant(ir.ArrayType(int32, 3), (5, 6)) + + def test_vector(self): + vecty = ir.VectorType(ir.IntType(32), 8) + vals = [1, 2, 4, 3, 8, 6, 9, 7] + vec = ir.Constant(vecty, vals) + vec_repr = "<8 x i32> <{}>".format( + ', '.join(map('i32 {}'.format, vals))) + self.assertEqual(str(vec), vec_repr) + + def test_non_nullable_int(self): + constant = ir.Constant(ir.IntType(32), None).constant + self.assertEqual(constant, 0) + + def test_structs(self): + st1 = ir.LiteralStructType((flt, int1)) + st2 = ir.LiteralStructType((int32, st1)) + c = ir.Constant(st1, (ir.Constant(ir.FloatType(), 1.5), + ir.Constant(int1, True))) + self.assertEqual(str(c), + '{float, i1} {float 0x3ff8000000000000, i1 true}') + c = ir.Constant.literal_struct((ir.Constant(ir.FloatType(), 1.5), + ir.Constant(int1, True))) + self.assertEqual(c.type, st1) + self.assertEqual(str(c), + '{float, i1} {float 0x3ff8000000000000, i1 true}') + c = ir.Constant.literal_struct((ir.Constant(ir.FloatType(), 1.5), + ir.Constant(int1, ir.Undefined))) + self.assertEqual(c.type, st1) + self.assertEqual(str(c), + '{float, i1} {float 0x3ff8000000000000, i1 undef}') + c = ir.Constant(st1, ir.Undefined) + self.assertEqual(str(c), '{float, i1} undef') + c = ir.Constant(st1, None) + self.assertEqual(str(c), '{float, i1} zeroinitializer') + # Recursive instantiation of inner constants + c1 = ir.Constant(st1, (1.5, True)) + self.assertEqual(str(c1), + '{float, i1} {float 0x3ff8000000000000, i1 true}') + c2 = ir.Constant(st2, (42, c1)) + self.assertEqual(str(c2), ('{i32, {float, i1}} {i32 42, {float, i1} ' + '{float 0x3ff8000000000000, i1 true}}')) + c3 = ir.Constant(st2, (42, (1.5, True))) + self.assertEqual(str(c3), str(c2)) + # Invalid number of args + with self.assertRaises(ValueError): + ir.Constant(st2, (4, 5, 6)) + + def test_undefined_literal_struct_pickling(self): + i8 = ir.IntType(8) + st = ir.Constant(ir.LiteralStructType([i8, i8]), ir.Undefined) + self.assert_pickle_correctly(st) + + def test_type_instantiaton(self): + """ + Instantiating a type should create a constant. + """ + c = int8(42) + self.assertIsInstance(c, ir.Constant) + self.assertEqual(str(c), 'i8 42') + c = int1(True) + self.assertIsInstance(c, ir.Constant) + self.assertEqual(str(c), 'i1 true') + # Arrays + at = ir.ArrayType(int32, 3) + c = at([c32(4), c32(5), c32(6)]) + self.assertEqual(str(c), '[3 x i32] [i32 4, i32 5, i32 6]') + c = at([4, 5, 6]) + self.assertEqual(str(c), '[3 x i32] [i32 4, i32 5, i32 6]') + c = at(None) + self.assertEqual(str(c), '[3 x i32] zeroinitializer') + with self.assertRaises(ValueError): + at([4, 5, 6, 7]) + # Structs + st1 = ir.LiteralStructType((flt, int1)) + st2 = ir.LiteralStructType((int32, st1)) + c = st1((1.5, True)) + self.assertEqual(str(c), ('{float, i1} {float 0x3ff8000000000000, i1 ' + 'true}')) + c = st2((42, (1.5, True))) + self.assertEqual(str(c), ('{i32, {float, i1}} {i32 42, {float, i1} ' + '{float 0x3ff8000000000000, i1 true}}')) + + def test_repr(self): + """ + Constants should have a useful repr(). + """ + c = int32(42) + self.assertEqual(repr(c), "") + + def test_encoding_problem(self): + c = ir.Constant(ir.ArrayType(ir.IntType(8), 256), + bytearray(range(256))) + m = self.module() + gv = ir.GlobalVariable(m, c.type, "myconstant") + gv.global_constant = True + gv.initializer = c + # With utf-8, the following will cause: + # UnicodeDecodeError: 'utf-8' codec can't decode byte 0xe0 in position + # 136: invalid continuation byte + parsed = llvm.parse_assembly(str(m)) + # Make sure the encoding does not modify the IR + reparsed = llvm.parse_assembly(str(parsed)) + self.assertEqual(str(parsed), str(reparsed)) + + def test_gep(self): + m = self.module() + tp = ir.LiteralStructType((flt, int1)) + gv = ir.GlobalVariable(m, tp, "myconstant") + c = gv.gep([ir.Constant(int32, x) for x in (0, 1)]) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(c), + 'getelementptr ({float, i1}, ptr @"myconstant", i32 0, i32 1)') # noqa E501 + else: + self.assertEqual(str(c), + 'getelementptr ({float, i1}, {float, i1}* @"myconstant", i32 0, i32 1)') # noqa E501 + self.assertEqual(c.type, ir.PointerType(int1)) + + const = ir.Constant(tp, None) + with self.assertRaises(TypeError): + const.gep([ir.Constant(int32, 0)]) + + const_ptr = ir.Constant(tp.as_pointer(), None) + c2 = const_ptr.gep([ir.Constant(int32, 0)]) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(c2), + 'getelementptr ({float, i1}, ptr null, i32 0)') # noqa E501 + else: + self.assertEqual(str(c2), + 'getelementptr ({float, i1}, {float, i1}* null, i32 0)') # noqa E501 + self.assertEqual(c.type, ir.PointerType(int1)) + + def test_gep_addrspace_globalvar(self): + m = self.module() + tp = ir.LiteralStructType((flt, int1)) + addrspace = 4 + + gv = ir.GlobalVariable(m, tp, "myconstant", addrspace=addrspace) + self.assertEqual(gv.addrspace, addrspace) + c = gv.gep([ir.Constant(int32, x) for x in (0, 1)]) + self.assertEqual(c.type.addrspace, addrspace) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(c), + ('getelementptr ({float, i1}, ptr ' + 'addrspace(4) @"myconstant", i32 0, i32 1)')) + else: + self.assertEqual(str(c), + ('getelementptr ({float, i1}, {float, i1} ' + 'addrspace(4)* @"myconstant", i32 0, i32 1)')) + self.assertEqual(c.type, ir.PointerType(int1, addrspace=addrspace)) + + def test_trunc(self): + c = ir.Constant(int64, 1).trunc(int32) + self.assertEqual(str(c), 'trunc (i64 1 to i32)') + + def test_zext(self): + c = ir.Constant(int32, 1).zext(int64) + self.assertEqual(str(c), 'zext (i32 1 to i64)') + + def test_sext(self): + c = ir.Constant(int32, -1).sext(int64) + self.assertEqual(str(c), 'sext (i32 -1 to i64)') + + def test_fptrunc(self): + c = ir.Constant(flt, 1).fptrunc(hlf) + self.assertEqual(str(c), 'fptrunc (float 0x3ff0000000000000 to half)') + + def test_fpext(self): + c = ir.Constant(flt, 1).fpext(dbl) + self.assertEqual(str(c), 'fpext (float 0x3ff0000000000000 to double)') + + def test_bitcast(self): + m = self.module() + gv = ir.GlobalVariable(m, int32, "myconstant") + c = gv.bitcast(int64.as_pointer()) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(c), 'bitcast (ptr @"myconstant" to ptr)') + else: + self.assertEqual(str(c), 'bitcast (i32* @"myconstant" to i64*)') + + def test_fptoui(self): + c = ir.Constant(flt, 1).fptoui(int32) + self.assertEqual(str(c), 'fptoui (float 0x3ff0000000000000 to i32)') + + def test_uitofp(self): + c = ir.Constant(int32, 1).uitofp(flt) + self.assertEqual(str(c), 'uitofp (i32 1 to float)') + + def test_fptosi(self): + c = ir.Constant(flt, 1).fptosi(int32) + self.assertEqual(str(c), 'fptosi (float 0x3ff0000000000000 to i32)') + + def test_sitofp(self): + c = ir.Constant(int32, 1).sitofp(flt) + self.assertEqual(str(c), 'sitofp (i32 1 to float)') + + def test_ptrtoint_1(self): + ptr = ir.Constant(int64.as_pointer(), None) + one = ir.Constant(int32, 1) + c = ptr.ptrtoint(int32) + + self.assertRaises(TypeError, one.ptrtoint, int64) + self.assertRaises(TypeError, ptr.ptrtoint, flt) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(c), 'ptrtoint (ptr null to i32)') + else: + self.assertEqual(str(c), 'ptrtoint (i64* null to i32)') + + def test_ptrtoint_2(self): + m = self.module() + gv = ir.GlobalVariable(m, int32, "myconstant") + c = gv.ptrtoint(int64) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(c), 'ptrtoint (ptr @"myconstant" to i64)') + + self.assertRaisesRegex( + TypeError, + r"can only ptrtoint\(\) to integer type, not 'ptr'", + gv.ptrtoint, + int64.as_pointer()) + else: + self.assertEqual(str(c), 'ptrtoint (i32* @"myconstant" to i64)') + + self.assertRaisesRegex( + TypeError, + r"can only ptrtoint\(\) to integer type, not 'i64\*'", + gv.ptrtoint, + int64.as_pointer()) + + c2 = ir.Constant(int32, 0) + self.assertRaisesRegex( + TypeError, + r"can only call ptrtoint\(\) on pointer type, not 'i32'", + c2.ptrtoint, + int64) + + def test_inttoptr(self): + one = ir.Constant(int32, 1) + pi = ir.Constant(flt, 3.14) + c = one.inttoptr(int64.as_pointer()) + + self.assertRaises(TypeError, one.inttoptr, int64) + self.assertRaises(TypeError, pi.inttoptr, int64.as_pointer()) + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertEqual(str(c), 'inttoptr (i32 1 to ptr)') + else: + self.assertEqual(str(c), 'inttoptr (i32 1 to i64*)') + + def test_neg(self): + one = ir.Constant(int32, 1) + self.assertEqual(str(one.neg()), 'sub (i32 0, i32 1)') + + def test_not(self): + one = ir.Constant(int32, 1) + self.assertEqual(str(one.not_()), 'xor (i32 1, i32 -1)') + + def test_fneg(self): + one = ir.Constant(flt, 1) + self.assertEqual(str(one.fneg()), 'fneg (float 0x3ff0000000000000)') + + def test_int_binops(self): + one = ir.Constant(int32, 1) + two = ir.Constant(int32, 2) + + oracle = {one.shl: 'shl', one.lshr: 'lshr', one.ashr: 'ashr', + one.add: 'add', one.sub: 'sub', one.mul: 'mul', + one.udiv: 'udiv', one.sdiv: 'sdiv', one.urem: 'urem', + one.srem: 'srem', one.or_: 'or', one.and_: 'and', + one.xor: 'xor'} + for fn, irop in oracle.items(): + self.assertEqual(str(fn(two)), irop + ' (i32 1, i32 2)') + + # unsigned integer compare + oracle = {'==': 'eq', '!=': 'ne', '>': + 'ugt', '>=': 'uge', '<': 'ult', '<=': 'ule'} + for cop, cond in oracle.items(): + actual = str(one.icmp_unsigned(cop, two)) + expected = 'icmp ' + cond + ' (i32 1, i32 2)' + self.assertEqual(actual, expected) + + # signed integer compare + oracle = {'==': 'eq', '!=': 'ne', + '>': 'sgt', '>=': 'sge', '<': 'slt', '<=': 'sle'} + for cop, cond in oracle.items(): + actual = str(one.icmp_signed(cop, two)) + expected = 'icmp ' + cond + ' (i32 1, i32 2)' + self.assertEqual(actual, expected) + + def test_flt_binops(self): + one = ir.Constant(flt, 1) + two = ir.Constant(flt, 2) + + oracle = {one.fadd: 'fadd', one.fsub: 'fsub', one.fmul: 'fmul', + one.fdiv: 'fdiv', one.frem: 'frem'} + for fn, irop in oracle.items(): + actual = str(fn(two)) + expected = irop + (' (float 0x3ff0000000000000,' + ' float 0x4000000000000000)') + self.assertEqual(actual, expected) + + # ordered float compare + oracle = {'==': 'oeq', '!=': 'one', '>': 'ogt', '>=': 'oge', + '<': 'olt', '<=': 'ole'} + for cop, cond in oracle.items(): + actual = str(one.fcmp_ordered(cop, two)) + expected = 'fcmp ' + cond + (' (float 0x3ff0000000000000,' + ' float 0x4000000000000000)') + self.assertEqual(actual, expected) + + # unordered float compare + oracle = {'==': 'ueq', '!=': 'une', '>': 'ugt', '>=': 'uge', + '<': 'ult', '<=': 'ule'} + for cop, cond in oracle.items(): + actual = str(one.fcmp_unordered(cop, two)) + expected = 'fcmp ' + cond + (' (float 0x3ff0000000000000,' + ' float 0x4000000000000000)') + self.assertEqual(actual, expected) + + +class TestTransforms(TestBase): + def test_call_transform(self): + mod = ir.Module() + foo = ir.Function(mod, ir.FunctionType(ir.VoidType(), ()), "foo") + bar = ir.Function(mod, ir.FunctionType(ir.VoidType(), ()), "bar") + builder = ir.IRBuilder() + builder.position_at_end(foo.append_basic_block()) + call = builder.call(foo, ()) + self.assertEqual(call.callee, foo) + modified = ir.replace_all_calls(mod, foo, bar) + self.assertIn(call, modified) + self.assertNotEqual(call.callee, foo) + self.assertEqual(call.callee, bar) + + +class TestSingleton(TestBase): + def test_undefined(self): + self.assertIs(ir.Undefined, ir.values._Undefined()) + self.assertIs(ir.Undefined, copy.copy(ir.Undefined)) + self.assertIs(ir.Undefined, copy.deepcopy(ir.Undefined)) + self.assert_pickle_correctly(ir.Undefined) + + +if __name__ == '__main__': + unittest.main() diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_refprune.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_refprune.py new file mode 100644 index 0000000000000000000000000000000000000000..2998520011ea16fb0ee37094f0cd58e00205b3e7 --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_refprune.py @@ -0,0 +1,730 @@ +import unittest +from llvmlite import ir +from llvmlite import binding as llvm +from llvmlite.tests import TestCase + +import llvmlite.tests.refprune_proto as proto + +# TODO:: Get rid of Legacy tests once completely transitioned to NewPassManager + +# FIXME: Remove me once typed pointers are no longer supported. +from llvmlite import opaque_pointers_enabled + + +def _iterate_cases(generate_test): + def wrap(fn): + def wrapped(self): + return generate_test(self, fn) + wrapped.__doc__ = f"generated test for {fn.__module__}.{fn.__name__}" + return wrapped + + for k, case_fn in proto.__dict__.items(): + if k.startswith('case'): + yield f'test_{k}', wrap(case_fn) + + +class PassManagerMixin(): + + def pb(self): + llvm.initialize_native_target() + tm = llvm.Target.from_default_triple().create_target_machine() + pto = llvm.create_pipeline_tuning_options(speed_level=0, size_level=0) + return llvm.create_pass_builder(tm, pto) + + +class TestRefPrunePrototype(TestCase): + """ + Test that the prototype is working. + """ + def generate_test(self, case_gen): + nodes, edges, expected = case_gen() + got = proto.FanoutAlgorithm(nodes, edges).run() + self.assertEqual(expected, got) + + # Generate tests + for name, case in _iterate_cases(generate_test): + locals()[name] = case + + +ptr_ty = ir.IntType(8).as_pointer() + + +class TestRefPrunePass(TestCase, PassManagerMixin): + """ + Test that the C++ implementation matches the expected behavior as for + the prototype. + + This generates a LLVM module for each test case, runs the pruner and checks + that the expected results are achieved. + """ + + def make_incref(self, m): + fnty = ir.FunctionType(ir.VoidType(), [ptr_ty]) + return ir.Function(m, fnty, name='NRT_incref') + + def make_decref(self, m): + fnty = ir.FunctionType(ir.VoidType(), [ptr_ty]) + return ir.Function(m, fnty, name='NRT_decref') + + def make_switcher(self, m): + fnty = ir.FunctionType(ir.IntType(32), ()) + return ir.Function(m, fnty, name='switcher') + + def make_brancher(self, m): + fnty = ir.FunctionType(ir.IntType(1), ()) + return ir.Function(m, fnty, name='brancher') + + def generate_ir(self, nodes, edges): + # Build LLVM module for the CFG + m = ir.Module() + + incref_fn = self.make_incref(m) + decref_fn = self.make_decref(m) + switcher_fn = self.make_switcher(m) + brancher_fn = self.make_brancher(m) + + fnty = ir.FunctionType(ir.VoidType(), [ptr_ty]) + fn = ir.Function(m, fnty, name='main') + [ptr] = fn.args + ptr.name = 'mem' + # populate the BB nodes + bbmap = {} + for bb in edges: + bbmap[bb] = fn.append_basic_block(bb) + # populate the BB + builder = ir.IRBuilder() + for bb, jump_targets in edges.items(): + builder.position_at_end(bbmap[bb]) + # Insert increfs and decrefs + for action in nodes[bb]: + if action == 'incref': + builder.call(incref_fn, [ptr]) + elif action == 'decref': + builder.call(decref_fn, [ptr]) + else: + raise AssertionError('unreachable') + + # Insert the terminator. + # Switch base on the number of jump targets. + n_targets = len(jump_targets) + if n_targets == 0: + builder.ret_void() + elif n_targets == 1: + [dst] = jump_targets + builder.branch(bbmap[dst]) + elif n_targets == 2: + [left, right] = jump_targets + sel = builder.call(brancher_fn, ()) + builder.cbranch(sel, bbmap[left], bbmap[right]) + elif n_targets > 2: + sel = builder.call(switcher_fn, ()) + [head, *tail] = jump_targets + + sw = builder.switch(sel, default=bbmap[head]) + for i, dst in enumerate(tail): + sw.add_case(sel.type(i), bbmap[dst]) + else: + raise AssertionError('unreachable') + + return m + + def apply_refprune(self, irmod): + mod = llvm.parse_assembly(str(irmod)) + pb = self.pb() + pm = pb.getModulePassManager() + pm.add_refprune_pass() + pm.run(mod, pb) + return mod + + def apply_refprune_legacy(self, irmod): + mod = llvm.parse_assembly(str(irmod)) + pm = llvm.ModulePassManager() + pm.add_refprune_pass() + pm.run(mod) + return mod + + def check(self, mod, expected, nodes): + # preprocess incref/decref locations + d = {} + for k, vs in nodes.items(): + n_incref = vs.count('incref') + n_decref = vs.count('decref') + d[k] = {'incref': n_incref, 'decref': n_decref} + for k, stats in d.items(): + if expected.get(k): + stats['incref'] -= 1 + for dec_bb in expected[k]: + d[dec_bb]['decref'] -= 1 + + # find the main function + for f in mod.functions: + if f.name == 'main': + break + # check each BB + for bb in f.blocks: + stats = d[bb.name] + text = str(bb) + n_incref = text.count('NRT_incref') + n_decref = text.count('NRT_decref') + self.assertEqual(stats['incref'], n_incref, msg=f'BB {bb}') + self.assertEqual(stats['decref'], n_decref, msg=f'BB {bb}') + + def generate_test(self, case_gen): + nodes, edges, expected = case_gen() + irmod = self.generate_ir(nodes, edges) + outmod = self.apply_refprune(irmod) + self.check(outmod, expected, nodes) + + def generate_test_legacy(self, case_gen): + nodes, edges, expected = case_gen() + irmod = self.generate_ir(nodes, edges) + outmod = self.apply_refprune_legacy(irmod) + self.check(outmod, expected, nodes) + + # Generate tests + for name, case in _iterate_cases(generate_test): + locals()[name] = case + + for name, case in _iterate_cases(generate_test_legacy): + locals()[name + "_legacy"] = case + + +class BaseTestByIR(TestCase, PassManagerMixin): + refprune_bitmask = 0 + + prologue = r""" +declare void @NRT_incref(i8* %ptr) +declare void @NRT_decref(i8* %ptr) +""" + + def check(self, irmod, subgraph_limit=None): + mod = llvm.parse_assembly(f"{self.prologue}\n{irmod}") + pb = self.pb() + pm = pb.getModulePassManager() + if subgraph_limit is None: + pm.add_refprune_pass(self.refprune_bitmask) + else: + pm.add_refprune_pass(self.refprune_bitmask, + subgraph_limit=subgraph_limit) + before = llvm.dump_refprune_stats() + pm.run(mod, pb) + after = llvm.dump_refprune_stats() + return mod, after - before + + def check_legacy(self, irmod, subgraph_limit=None): + mod = llvm.parse_assembly(f"{self.prologue}\n{irmod}") + pm = llvm.ModulePassManager() + if subgraph_limit is None: + pm.add_refprune_pass(self.refprune_bitmask) + else: + pm.add_refprune_pass(self.refprune_bitmask, + subgraph_limit=subgraph_limit) + before = llvm.dump_refprune_stats() + pm.run(mod) + after = llvm.dump_refprune_stats() + return mod, after - before + + +class TestPerBB(BaseTestByIR): + refprune_bitmask = llvm.RefPruneSubpasses.PER_BB + + per_bb_ir_1 = r""" +define void @main(i8* %ptr) { + call void @NRT_incref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_per_bb_1(self): + mod, stats = self.check(self.per_bb_ir_1) + self.assertEqual(stats.basicblock, 2) + + def test_per_bb_1_legacy(self): + mod, stats = self.check_legacy(self.per_bb_ir_1) + self.assertEqual(stats.basicblock, 2) + + per_bb_ir_2 = r""" +define void @main(i8* %ptr) { + call void @NRT_incref(i8* %ptr) + call void @NRT_incref(i8* %ptr) + call void @NRT_incref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_per_bb_2(self): + mod, stats = self.check(self.per_bb_ir_2) + self.assertEqual(stats.basicblock, 4) + # not pruned + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertIn("call void @NRT_incref(ptr %ptr)", str(mod)) + else: + self.assertIn("call void @NRT_incref(i8* %ptr)", str(mod)) + + def test_per_bb_2_legacy(self): + mod, stats = self.check_legacy(self.per_bb_ir_2) + self.assertEqual(stats.basicblock, 4) + # not pruned + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertIn("call void @NRT_incref(ptr %ptr)", str(mod)) + else: + self.assertIn("call void @NRT_incref(i8* %ptr)", str(mod)) + + per_bb_ir_3 = r""" +define void @main(ptr %ptr, ptr %other) { + call void @NRT_incref(ptr %ptr) + call void @NRT_incref(ptr %ptr) + call void @NRT_decref(ptr %ptr) + call void @NRT_decref(ptr %other) + ret void +} +""" if opaque_pointers_enabled else r""" +define void @main(i8* %ptr, i8* %other) { + call void @NRT_incref(i8* %ptr) + call void @NRT_incref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %other) + ret void +} +""" + + def test_per_bb_3(self): + mod, stats = self.check(self.per_bb_ir_3) + self.assertEqual(stats.basicblock, 2) + # not pruned + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertIn("call void @NRT_decref(ptr %other)", str(mod)) + else: + self.assertIn("call void @NRT_decref(i8* %other)", str(mod)) + + def test_per_bb_3_legacy(self): + mod, stats = self.check_legacy(self.per_bb_ir_3) + self.assertEqual(stats.basicblock, 2) + # not pruned + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertIn("call void @NRT_decref(ptr %other)", str(mod)) + else: + self.assertIn("call void @NRT_decref(i8* %other)", str(mod)) + + per_bb_ir_4 = r""" +; reordered +define void @main(ptr %ptr, ptr %other) { + call void @NRT_incref(ptr %ptr) + call void @NRT_decref(ptr %ptr) + call void @NRT_decref(ptr %ptr) + call void @NRT_decref(ptr %other) + call void @NRT_incref(ptr %ptr) + ret void +} +""" if opaque_pointers_enabled else r""" +; reordered +define void @main(i8* %ptr, i8* %other) { + call void @NRT_incref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %other) + call void @NRT_incref(i8* %ptr) + ret void +} +""" + + def test_per_bb_4(self): + mod, stats = self.check(self.per_bb_ir_4) + self.assertEqual(stats.basicblock, 4) + # not pruned + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertIn("call void @NRT_decref(ptr %other)", str(mod)) + else: + self.assertIn("call void @NRT_decref(i8* %other)", str(mod)) + + def test_per_bb_4_legacy(self): + mod, stats = self.check_legacy(self.per_bb_ir_4) + self.assertEqual(stats.basicblock, 4) + # not pruned + # FIXME: Remove `else' once TP are no longer supported. + if opaque_pointers_enabled: + self.assertIn("call void @NRT_decref(ptr %other)", str(mod)) + else: + self.assertIn("call void @NRT_decref(i8* %other)", str(mod)) + + +class TestDiamond(BaseTestByIR): + refprune_bitmask = llvm.RefPruneSubpasses.DIAMOND + + per_diamond_1 = r""" +define void @main(i8* %ptr) { +bb_A: + call void @NRT_incref(i8* %ptr) + br label %bb_B +bb_B: + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_per_diamond_1(self): + mod, stats = self.check(self.per_diamond_1) + self.assertEqual(stats.diamond, 2) + + def test_per_diamond_1_legacy(self): + mod, stats = self.check_legacy(self.per_diamond_1) + self.assertEqual(stats.diamond, 2) + + per_diamond_2 = r""" +define void @main(i8* %ptr, i1 %cond) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + br label %bb_D +bb_C: + br label %bb_D +bb_D: + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_per_diamond_2(self): + mod, stats = self.check(self.per_diamond_2) + self.assertEqual(stats.diamond, 2) + + def test_per_diamond_2_legacy(self): + mod, stats = self.check_legacy(self.per_diamond_2) + self.assertEqual(stats.diamond, 2) + + per_diamond_3 = r""" +define void @main(i8* %ptr, i1 %cond) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + br label %bb_D +bb_C: + call void @NRT_decref(i8* %ptr) ; reject because of decref in diamond + br label %bb_D +bb_D: + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_per_diamond_3(self): + mod, stats = self.check(self.per_diamond_3) + self.assertEqual(stats.diamond, 0) + + def test_per_diamond_3_legacy(self): + mod, stats = self.check_legacy(self.per_diamond_3) + self.assertEqual(stats.diamond, 0) + + per_diamond_4 = r""" +define void @main(i8* %ptr, i1 %cond) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + call void @NRT_incref(i8* %ptr) ; extra incref will not affect prune + br label %bb_D +bb_C: + br label %bb_D +bb_D: + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_per_diamond_4(self): + mod, stats = self.check(self.per_diamond_4) + self.assertEqual(stats.diamond, 2) + + def test_per_diamond_4_legacy(self): + mod, stats = self.check_legacy(self.per_diamond_4) + self.assertEqual(stats.diamond, 2) + + per_diamond_5 = r""" +define void @main(i8* %ptr, i1 %cond) { +bb_A: + call void @NRT_incref(i8* %ptr) + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + br label %bb_D +bb_C: + br label %bb_D +bb_D: + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_per_diamond_5(self): + mod, stats = self.check(self.per_diamond_5) + self.assertEqual(stats.diamond, 4) + + def test_per_diamond_5_legacy(self): + mod, stats = self.check_legacy(self.per_diamond_5) + self.assertEqual(stats.diamond, 4) + + +class TestFanout(BaseTestByIR): + """More complex cases are tested in TestRefPrunePass + """ + + refprune_bitmask = llvm.RefPruneSubpasses.FANOUT + + fanout_1 = r""" +define void @main(i8* %ptr, i1 %cond) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + call void @NRT_decref(i8* %ptr) + ret void +bb_C: + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_fanout_1(self): + mod, stats = self.check(self.fanout_1) + self.assertEqual(stats.fanout, 3) + + def test_fanout_1_legacy(self): + mod, stats = self.check_legacy(self.fanout_1) + self.assertEqual(stats.fanout, 3) + + fanout_2 = r""" +define void @main(i8* %ptr, i1 %cond, i8** %excinfo) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + call void @NRT_decref(i8* %ptr) + ret void +bb_C: + call void @NRT_decref(i8* %ptr) + br label %bb_B ; illegal jump to other decref +} +""" + + def test_fanout_2(self): + mod, stats = self.check(self.fanout_2) + self.assertEqual(stats.fanout, 0) + + def test_fanout_2_legacy(self): + mod, stats = self.check_legacy(self.fanout_2) + self.assertEqual(stats.fanout, 0) + + fanout_3 = r""" +define void @main(i8* %ptr, i1 %cond) { +bb_A: + call void @NRT_incref(i8* %ptr) + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + ret void +bb_C: + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + ret void +} +""" + + def test_fanout_3(self): + mod, stats = self.check(self.fanout_3) + self.assertEqual(stats.fanout, 6) + + def test_fanout_3_limited(self): + # With subgraph limit at 1, it is essentially turning off the fanout + # pruner. + mod, stats = self.check(self.fanout_3, subgraph_limit=1) + self.assertEqual(stats.fanout, 0) + + def test_fanout_3_legacy(self): + mod, stats = self.check_legacy(self.fanout_3) + self.assertEqual(stats.fanout, 6) + + def test_fanout_3_limited_legacy(self): + # With subgraph limit at 1, it is essentially turning off the fanout + # pruner. + mod, stats = self.check_legacy(self.fanout_3, subgraph_limit=1) + self.assertEqual(stats.fanout, 0) + + +class TestFanoutRaise(BaseTestByIR): + refprune_bitmask = llvm.RefPruneSubpasses.FANOUT_RAISE + + fanout_raise_1 = r""" +define i32 @main(i8* %ptr, i1 %cond, i8** %excinfo) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + call void @NRT_decref(i8* %ptr) + ret i32 0 +bb_C: + store i8* null, i8** %excinfo, !numba_exception_output !0 + ret i32 1 +} +!0 = !{i1 true} +""" + + def test_fanout_raise_1(self): + mod, stats = self.check(self.fanout_raise_1) + self.assertEqual(stats.fanout_raise, 2) + + def test_fanout_raise_1_legacy(self): + mod, stats = self.check_legacy(self.fanout_raise_1) + self.assertEqual(stats.fanout_raise, 2) + + fanout_raise_2 = r""" +define i32 @main(i8* %ptr, i1 %cond, i8** %excinfo) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + call void @NRT_decref(i8* %ptr) + ret i32 0 +bb_C: + store i8* null, i8** %excinfo, !numba_exception_typo !0 ; bad metadata + ret i32 1 +} + +!0 = !{i1 true} +""" + + def test_fanout_raise_2(self): + # This is ensuring that fanout_raise is not pruning when the metadata + # is incorrectly named. + mod, stats = self.check(self.fanout_raise_2) + self.assertEqual(stats.fanout_raise, 0) + + def test_fanout_raise_2_legacy(self): + # This is ensuring that fanout_raise is not pruning when the metadata + # is incorrectly named. + mod, stats = self.check_legacy(self.fanout_raise_2) + self.assertEqual(stats.fanout_raise, 0) + + fanout_raise_3 = r""" +define i32 @main(i8* %ptr, i1 %cond, i8** %excinfo) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + call void @NRT_decref(i8* %ptr) + ret i32 0 +bb_C: + store i8* null, i8** %excinfo, !numba_exception_output !0 + ret i32 1 +} + +!0 = !{i32 1} ; ok; use i32 +""" + + def test_fanout_raise_3(self): + mod, stats = self.check(self.fanout_raise_3) + self.assertEqual(stats.fanout_raise, 2) + + def test_fanout_raise_3_legacy(self): + mod, stats = self.check_legacy(self.fanout_raise_3) + self.assertEqual(stats.fanout_raise, 2) + + fanout_raise_4 = r""" +define i32 @main(i8* %ptr, i1 %cond, i8** %excinfo) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + ret i32 1 ; BAD; all tails are raising without decref +bb_C: + ret i32 1 ; BAD; all tails are raising without decref +} + +!0 = !{i1 1} +""" + + def test_fanout_raise_4(self): + mod, stats = self.check(self.fanout_raise_4) + self.assertEqual(stats.fanout_raise, 0) + + def test_fanout_raise_4_legacy(self): + mod, stats = self.check_legacy(self.fanout_raise_4) + self.assertEqual(stats.fanout_raise, 0) + + fanout_raise_5 = r""" +define i32 @main(i8* %ptr, i1 %cond, i8** %excinfo) { +bb_A: + call void @NRT_incref(i8* %ptr) + br i1 %cond, label %bb_B, label %bb_C +bb_B: + call void @NRT_decref(i8* %ptr) + br label %common.ret +bb_C: + store i8* null, i8** %excinfo, !numba_exception_output !0 + br label %common.ret +common.ret: + %common.ret.op = phi i32 [ 0, %bb_B ], [ 1, %bb_C ] + ret i32 %common.ret.op +} +!0 = !{i1 1} +""" + + def test_fanout_raise_5(self): + mod, stats = self.check(self.fanout_raise_5) + self.assertEqual(stats.fanout_raise, 2) + + def test_fanout_raise_5_legacy(self): + mod, stats = self.check_legacy(self.fanout_raise_5) + self.assertEqual(stats.fanout_raise, 2) + + # test case 6 is from https://github.com/numba/llvmlite/issues/1023 + fanout_raise_6 = r""" +define i32 @main(i8* %ptr, i1 %cond1, i1 %cond2, i1 %cond3, i8** %excinfo) { +bb_A: + call void @NRT_incref(i8* %ptr) + call void @NRT_incref(i8* %ptr) + br i1 %cond1, label %bb_B, label %bb_C +bb_B: + call void @NRT_decref(i8* %ptr) + br i1 %cond2, label %bb_D, label %bb_E +bb_C: + store i8* null, i8** %excinfo, !numba_exception_output !0 + ret i32 1 +bb_D: + call void @NRT_decref(i8* %ptr) + ret i32 0 +bb_E: + call void @NRT_incref(i8* %ptr) + br i1 %cond3, label %bb_F, label %bb_C +bb_F: + call void @NRT_decref(i8* %ptr) + call void @NRT_decref(i8* %ptr) + ret i32 0 +} +!0 = !{i1 1} +""" + + def test_fanout_raise_6(self): + mod, stats = self.check(self.fanout_raise_6) + self.assertEqual(stats.fanout_raise, 7) + + def test_fanout_raise_6_legacy(self): + mod, stats = self.check_legacy(self.fanout_raise_6) + self.assertEqual(stats.fanout_raise, 7) + + +if __name__ == '__main__': + unittest.main() diff --git a/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_valuerepr.py b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_valuerepr.py new file mode 100644 index 0000000000000000000000000000000000000000..f8d7e4b2c073ecdfd5ae8c985ebd9108245bd78f --- /dev/null +++ b/tool_server/.venv/lib/python3.12/site-packages/llvmlite/tests/test_valuerepr.py @@ -0,0 +1,60 @@ +import math +import sys +import unittest + +from llvmlite.ir import ( + Constant, FloatType, DoubleType, LiteralStructType, IntType, + ArrayType, HalfType) +from llvmlite.tests import TestCase + + +int8 = IntType(8) +int16 = IntType(16) + + +PY36_OR_LATER = sys.version_info[:2] >= (3, 6) + + +class TestValueRepr(TestCase): + + def test_double_repr(self): + def check_repr(val, expected): + c = Constant(DoubleType(), val) + self.assertEqual(str(c), expected) + check_repr(math.pi, "double 0x400921fb54442d18") + check_repr(float('inf'), "double 0x7ff0000000000000") + check_repr(float('-inf'), "double 0xfff0000000000000") + + def test_float_repr(self): + def check_repr(val, expected): + c = Constant(FloatType(), val) + self.assertEqual(str(c), expected) + check_repr(math.pi, "float 0x400921fb60000000") + check_repr(float('inf'), "float 0x7ff0000000000000") + check_repr(float('-inf'), "float 0xfff0000000000000") + + @unittest.skipUnless(PY36_OR_LATER, 'py36+ only') + def test_half_repr(self): + def check_repr(val, expected): + c = Constant(HalfType(), val) + self.assertEqual(str(c), expected) + check_repr(math.pi, "half 0x4009200000000000") + check_repr(float('inf'), "half 0x7ff0000000000000") + check_repr(float('-inf'), "half 0xfff0000000000000") + + def test_struct_repr(self): + tp = LiteralStructType([int8, int16]) + c = Constant(tp, (Constant(int8, 100), Constant(int16, 1000))) + self.assertEqual(str(c), "{i8, i16} {i8 100, i16 1000}") + + def test_array_repr(self): + tp = ArrayType(int8, 3) + values = [Constant(int8, x) for x in (5, 10, -15)] + c = Constant(tp, values) + self.assertEqual(str(c), "[3 x i8] [i8 5, i8 10, i8 -15]") + c = Constant(tp, bytearray(b"\x01\x02\x03")) + self.assertEqual(str(c), '[3 x i8] c"\\01\\02\\03"') + + +if __name__ == "__main__": + unittest.main() diff --git a/tool_server/.venv/lib/python3.12/site-packages/markupsafe/__pycache__/__init__.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/markupsafe/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..8ef909388b14bd70d0b23c0d30ff60965f422e78 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/markupsafe/__pycache__/__init__.cpython-312.pyc differ diff --git a/tool_server/.venv/lib/python3.12/site-packages/markupsafe/__pycache__/_native.cpython-312.pyc b/tool_server/.venv/lib/python3.12/site-packages/markupsafe/__pycache__/_native.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..81dcd422f9a10a878748ca3378ab44fdb2a493d3 Binary files /dev/null and b/tool_server/.venv/lib/python3.12/site-packages/markupsafe/__pycache__/_native.cpython-312.pyc differ