diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 54f9fba5..dea07418 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-22T16:57:28","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-12-02T13:49:35","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index ecf6fb48..eaa0857c 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · LLVM.jl</title><meta name="title" content="Home · LLVM.jl"/><meta property="og:title" content="Home · LLVM.jl"/><meta property="twitter:title" content="Home · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="man/essentials/">Essentials</a></li><li><a class="tocitem" href="man/types/">Types</a></li><li><a class="tocitem" href="man/values/">Values</a></li><li><a class="tocitem" href="man/modules/">Modules</a></li><li><a class="tocitem" href="man/functions/">Functions</a></li><li><a class="tocitem" href="man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="man/instructions/">Instructions</a></li><li><a class="tocitem" href="man/metadata/">Metadata</a></li><li><a class="tocitem" href="man/analyses/">Analyses</a></li><li><a class="tocitem" href="man/transforms/">Transforms</a></li><li><a class="tocitem" href="man/codegen/">Code generation</a></li><li><a class="tocitem" href="man/execution/">Execution</a></li><li><a class="tocitem" href="man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="lib/essentials/">Essentials</a></li><li><a class="tocitem" href="lib/types/">Types</a></li><li><a class="tocitem" href="lib/values/">Values</a></li><li><a class="tocitem" href="lib/modules/">Modules</a></li><li><a class="tocitem" href="lib/functions/">Functions</a></li><li><a class="tocitem" href="lib/blocks/">Basic blocks</a></li><li><a class="tocitem" href="lib/instructions/">Instructions</a></li><li><a class="tocitem" href="lib/metadata/">Metadata</a></li><li><a class="tocitem" href="lib/analyses/">Analyses</a></li><li><a class="tocitem" href="lib/transforms/">Transforms</a></li><li><a class="tocitem" href="lib/codegen/">Code generation</a></li><li><a class="tocitem" href="lib/execution/">Execution</a></li><li><a class="tocitem" href="lib/interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="LLVM.jl"><a class="docs-heading-anchor" href="#LLVM.jl">LLVM.jl</a><a id="LLVM.jl-1"></a><a class="docs-heading-anchor-permalink" href="#LLVM.jl" title="Permalink"></a></h1><p><em>A Julia wrapper for LLVM.</em></p><p>This package provides a wrapper for the LLVM compiler framework, based on the LLVM C API. You can use LLVM.jl to work with LLVM code generated by Julia, to interoperate with the Julia compiler, or to create your own compiler. It is heavily used by the different GPU compilers for the Julia programming language.</p><p>There are different levels of abstraction and functionality available in this package:</p><ul><li>functionality in the top-level <code>LLVM</code> module: high-level wrappers for the LLVM C API, and additional functionality to make working with LLVM easier;</li><li>functionality in <code>LLVM.Interop</code>: specific functionality to interoperate with the Julia compiler, and to work with LLVM code generated by Julia;</li><li>functionality in the <code>LLVM.API</code> submodule: a direct mapping of the LLVM C API to Julia. This is useful when you need to work with the LLVM C API directly, or when you need functionality that is not yet wrapped in the top-level module.</li></ul><p>For installation instructions, please refer to the <a href="https://github.com/maleadt/LLVM.jl/blob/master/README.md">README</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/essentials/">Essentials »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · LLVM.jl</title><meta name="title" content="Home · LLVM.jl"/><meta property="og:title" content="Home · LLVM.jl"/><meta property="twitter:title" content="Home · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="man/essentials/">Essentials</a></li><li><a class="tocitem" href="man/types/">Types</a></li><li><a class="tocitem" href="man/values/">Values</a></li><li><a class="tocitem" href="man/modules/">Modules</a></li><li><a class="tocitem" href="man/functions/">Functions</a></li><li><a class="tocitem" href="man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="man/instructions/">Instructions</a></li><li><a class="tocitem" href="man/metadata/">Metadata</a></li><li><a class="tocitem" href="man/analyses/">Analyses</a></li><li><a class="tocitem" href="man/transforms/">Transforms</a></li><li><a class="tocitem" href="man/codegen/">Code generation</a></li><li><a class="tocitem" href="man/execution/">Execution</a></li><li><a class="tocitem" href="man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="lib/essentials/">Essentials</a></li><li><a class="tocitem" href="lib/types/">Types</a></li><li><a class="tocitem" href="lib/values/">Values</a></li><li><a class="tocitem" href="lib/modules/">Modules</a></li><li><a class="tocitem" href="lib/functions/">Functions</a></li><li><a class="tocitem" href="lib/blocks/">Basic blocks</a></li><li><a class="tocitem" href="lib/instructions/">Instructions</a></li><li><a class="tocitem" href="lib/metadata/">Metadata</a></li><li><a class="tocitem" href="lib/analyses/">Analyses</a></li><li><a class="tocitem" href="lib/transforms/">Transforms</a></li><li><a class="tocitem" href="lib/codegen/">Code generation</a></li><li><a class="tocitem" href="lib/execution/">Execution</a></li><li><a class="tocitem" href="lib/interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="LLVM.jl"><a class="docs-heading-anchor" href="#LLVM.jl">LLVM.jl</a><a id="LLVM.jl-1"></a><a class="docs-heading-anchor-permalink" href="#LLVM.jl" title="Permalink"></a></h1><p><em>A Julia wrapper for LLVM.</em></p><p>This package provides a wrapper for the LLVM compiler framework, based on the LLVM C API. You can use LLVM.jl to work with LLVM code generated by Julia, to interoperate with the Julia compiler, or to create your own compiler. It is heavily used by the different GPU compilers for the Julia programming language.</p><p>There are different levels of abstraction and functionality available in this package:</p><ul><li>functionality in the top-level <code>LLVM</code> module: high-level wrappers for the LLVM C API, and additional functionality to make working with LLVM easier;</li><li>functionality in <code>LLVM.Interop</code>: specific functionality to interoperate with the Julia compiler, and to work with LLVM code generated by Julia;</li><li>functionality in the <code>LLVM.API</code> submodule: a direct mapping of the LLVM C API to Julia. This is useful when you need to work with the LLVM C API directly, or when you need functionality that is not yet wrapped in the top-level module.</li></ul><p>For installation instructions, please refer to the <a href="https://github.com/maleadt/LLVM.jl/blob/master/README.md">README</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/essentials/">Essentials »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/analyses/index.html b/dev/lib/analyses/index.html index 0d4b24e0..a7a31489 100644 --- a/dev/lib/analyses/index.html +++ b/dev/lib/analyses/index.html @@ -1,4 +1,4 @@ <!DOCTYPE html> <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Analyses · LLVM.jl</title><meta name="title" content="Analyses · LLVM.jl"/><meta property="og:title" content="Analyses · LLVM.jl"/><meta property="twitter:title" content="Analyses · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li class="is-active"><a class="tocitem" href>Analyses</a><ul class="internal"><li><a class="tocitem" href="#IR-verification"><span>IR verification</span></a></li><li><a class="tocitem" href="#Dominator-and-post-dominator"><span>Dominator and post-dominator</span></a></li></ul></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Analyses</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Analyses</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/analyses.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Analyses"><a class="docs-heading-anchor" href="#Analyses">Analyses</a><a id="Analyses-1"></a><a class="docs-heading-anchor-permalink" href="#Analyses" title="Permalink"></a></h1><h2 id="IR-verification"><a class="docs-heading-anchor" href="#IR-verification">IR verification</a><a id="IR-verification-1"></a><a class="docs-heading-anchor-permalink" href="#IR-verification" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.verify" href="#LLVM.verify"><code>LLVM.verify</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">verify(mod::Module) -verify(f::Function)</code></pre><p>Verify the module or function <code>mod</code> or <code>f</code>. If verification fails, an exception is thrown.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/analysis.jl#L5-L10">source</a></section></article><h2 id="Dominator-and-post-dominator"><a class="docs-heading-anchor" href="#Dominator-and-post-dominator">Dominator and post-dominator</a><a id="Dominator-and-post-dominator-1"></a><a class="docs-heading-anchor-permalink" href="#Dominator-and-post-dominator" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DomTree" href="#LLVM.DomTree"><code>LLVM.DomTree</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DomTree</code></pre><p>Dominator tree for a function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/analysis.jl#L48-L52">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{DomTree}" href="#LLVM.dispose-Tuple{DomTree}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(::DomTree)</code></pre><p>Dispose of a dominator tree.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/analysis.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PostDomTree" href="#LLVM.PostDomTree"><code>LLVM.PostDomTree</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">PostDomTree</code></pre><p>Post-dominator tree for a function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/analysis.jl#L85-L89">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{PostDomTree}" href="#LLVM.dispose-Tuple{PostDomTree}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(tree::PostDomTree)</code></pre><p>Dispose of a post-dominator tree.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/analysis.jl#L106-L110">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dominates" href="#LLVM.dominates"><code>LLVM.dominates</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dominates(tree::DomTree, A::Instruction, B::Instruction) -dominates(tree::PostDomTree, A::Instruction, B::Instruction)</code></pre><p>Check if instruction <code>A</code> dominates instruction <code>B</code> in the dominator tree <code>tree</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/analysis.jl#L36-L41">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../metadata/">« Metadata</a><a class="docs-footer-nextpage" href="../transforms/">Transforms »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +verify(f::Function)</code></pre><p>Verify the module or function <code>mod</code> or <code>f</code>. If verification fails, an exception is thrown.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/analysis.jl#L5-L10">source</a></section></article><h2 id="Dominator-and-post-dominator"><a class="docs-heading-anchor" href="#Dominator-and-post-dominator">Dominator and post-dominator</a><a id="Dominator-and-post-dominator-1"></a><a class="docs-heading-anchor-permalink" href="#Dominator-and-post-dominator" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DomTree" href="#LLVM.DomTree"><code>LLVM.DomTree</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DomTree</code></pre><p>Dominator tree for a function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/analysis.jl#L48-L52">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{DomTree}" href="#LLVM.dispose-Tuple{DomTree}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(::DomTree)</code></pre><p>Dispose of a dominator tree.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/analysis.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PostDomTree" href="#LLVM.PostDomTree"><code>LLVM.PostDomTree</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">PostDomTree</code></pre><p>Post-dominator tree for a function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/analysis.jl#L85-L89">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{PostDomTree}" href="#LLVM.dispose-Tuple{PostDomTree}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(tree::PostDomTree)</code></pre><p>Dispose of a post-dominator tree.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/analysis.jl#L106-L110">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dominates" href="#LLVM.dominates"><code>LLVM.dominates</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dominates(tree::DomTree, A::Instruction, B::Instruction) +dominates(tree::PostDomTree, A::Instruction, B::Instruction)</code></pre><p>Check if instruction <code>A</code> dominates instruction <code>B</code> in the dominator tree <code>tree</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/analysis.jl#L36-L41">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../metadata/">« Metadata</a><a class="docs-footer-nextpage" href="../transforms/">Transforms »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/blocks/index.html b/dev/lib/blocks/index.html index 5a4a4ad5..3e60fbca 100644 --- a/dev/lib/blocks/index.html +++ b/dev/lib/blocks/index.html @@ -1,2 +1,2 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Basic blocks · LLVM.jl</title><meta name="title" content="Basic blocks · LLVM.jl"/><meta property="og:title" content="Basic blocks · LLVM.jl"/><meta property="twitter:title" content="Basic blocks · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li class="is-active"><a class="tocitem" href>Basic blocks</a><ul class="internal"><li><a class="tocitem" href="#Properties-and-operations"><span>Properties and operations</span></a></li><li><a class="tocitem" href="#Control-flow"><span>Control flow</span></a></li><li><a class="tocitem" href="#Instructions"><span>Instructions</span></a></li></ul></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Basic blocks</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Basic blocks</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/blocks.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Basic-blocks"><a class="docs-heading-anchor" href="#Basic-blocks">Basic blocks</a><a id="Basic-blocks-1"></a><a class="docs-heading-anchor-permalink" href="#Basic-blocks" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BasicBlock" href="#LLVM.BasicBlock"><code>LLVM.BasicBlock</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">BasicBlock</code></pre><p>A basic block in the IR. A basic block is a sequence of instructions that always ends in a terminator instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L5-L10">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BasicBlock-Tuple{String}" href="#LLVM.BasicBlock-Tuple{String}"><code>LLVM.BasicBlock</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">BasicBlock(name::String)</code></pre><p>Create a new, empty basic block with the given name.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L19-L23">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BasicBlock-Tuple{LLVM.Function, String}" href="#LLVM.BasicBlock-Tuple{LLVM.Function, String}"><code>LLVM.BasicBlock</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">BasicBlock(f::LLVM.Function, name::String)</code></pre><p>Create a new, empty basic block with the given name, and insert it at the end of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L27-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BasicBlock-Tuple{BasicBlock, String}" href="#LLVM.BasicBlock-Tuple{BasicBlock, String}"><code>LLVM.BasicBlock</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">BasicBlock(bb::BasicBlock, name::String)</code></pre><p>Create a new, empty basic block with the given name, and insert it before the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L36-L41">source</a></section></article><h2 id="Properties-and-operations"><a class="docs-heading-anchor" href="#Properties-and-operations">Properties and operations</a><a id="Properties-and-operations-1"></a><a class="docs-heading-anchor-permalink" href="#Properties-and-operations" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.remove!-Tuple{BasicBlock}" href="#LLVM.remove!-Tuple{BasicBlock}"><code>LLVM.remove!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">remove!(bb::BasicBlock)</code></pre><p>Remove the given basic block from its parent function, but do not free the object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L45-L49">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.erase!-Tuple{BasicBlock}" href="#LLVM.erase!-Tuple{BasicBlock}"><code>LLVM.erase!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">erase!(fun::Function, bb::BasicBlock)</code></pre><p>Remove the given basic block from its parent function and free the object.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is unsafe because it does not check if the basic block is used elsewhere.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L52-L60">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parent-Tuple{BasicBlock}" href="#LLVM.parent-Tuple{BasicBlock}"><code>LLVM.parent</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parent(bb::BasicBlock) -> LLVM.Function</code></pre><p>Get the function that contains the given basic block, or <code>nothing</code> if the block is not part of a function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L63-L68">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.terminator-Tuple{BasicBlock}" href="#LLVM.terminator-Tuple{BasicBlock}"><code>LLVM.terminator</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">terminator(bb::BasicBlock) -> LLVM.Instruction</code></pre><p>Get the terminator instruction of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L75-L79">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{BasicBlock}" href="#LLVM.name-Tuple{BasicBlock}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(bb::BasicBlock) -> String</code></pre><p>Get the name of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L86-L90">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.move_before" href="#LLVM.move_before"><code>LLVM.move_before</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">move_before(bb::BasicBlock, pos::BasicBlock)</code></pre><p>Move the given basic block before the given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L93-L97">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.move_after" href="#LLVM.move_after"><code>LLVM.move_after</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">move_after(bb::BasicBlock, pos::BasicBlock)</code></pre><p>Move the given basic block after the given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L101-L105">source</a></section></article><h2 id="Control-flow"><a class="docs-heading-anchor" href="#Control-flow">Control flow</a><a id="Control-flow-1"></a><a class="docs-heading-anchor-permalink" href="#Control-flow" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.predecessors-Tuple{BasicBlock}" href="#LLVM.predecessors-Tuple{BasicBlock}"><code>LLVM.predecessors</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">predecessors(bb::BasicBlock)</code></pre><p>Get the predecessors of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L178-L182">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.successors-Tuple{BasicBlock}" href="#LLVM.successors-Tuple{BasicBlock}"><code>LLVM.successors</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">successors(bb::BasicBlock)</code></pre><p>Get the successors of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L193-L197">source</a></section></article><h2 id="Instructions"><a class="docs-heading-anchor" href="#Instructions">Instructions</a><a id="Instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.instructions" href="#LLVM.instructions"><code>LLVM.instructions</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">instructions(bb::BasicBlock)</code></pre><p>Get an iterator over the instructions in the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L118-L122">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.previnst" href="#LLVM.previnst"><code>LLVM.previnst</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">previnst(inst::Instruction)</code></pre><p>Get the instruction before the given instruction in the basic block, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L149-L154">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.nextinst" href="#LLVM.nextinst"><code>LLVM.nextinst</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">nextinst(inst::Instruction)</code></pre><p>Get the instruction after the given instruction in the basic block, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/basicblock.jl#L161-L166">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../functions/">« Functions</a><a class="docs-footer-nextpage" href="../instructions/">Instructions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Basic blocks · LLVM.jl</title><meta name="title" content="Basic blocks · LLVM.jl"/><meta property="og:title" content="Basic blocks · LLVM.jl"/><meta property="twitter:title" content="Basic blocks · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li class="is-active"><a class="tocitem" href>Basic blocks</a><ul class="internal"><li><a class="tocitem" href="#Properties-and-operations"><span>Properties and operations</span></a></li><li><a class="tocitem" href="#Control-flow"><span>Control flow</span></a></li><li><a class="tocitem" href="#Instructions"><span>Instructions</span></a></li></ul></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Basic blocks</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Basic blocks</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/blocks.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Basic-blocks"><a class="docs-heading-anchor" href="#Basic-blocks">Basic blocks</a><a id="Basic-blocks-1"></a><a class="docs-heading-anchor-permalink" href="#Basic-blocks" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BasicBlock" href="#LLVM.BasicBlock"><code>LLVM.BasicBlock</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">BasicBlock</code></pre><p>A basic block in the IR. A basic block is a sequence of instructions that always ends in a terminator instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L5-L10">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BasicBlock-Tuple{String}" href="#LLVM.BasicBlock-Tuple{String}"><code>LLVM.BasicBlock</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">BasicBlock(name::String)</code></pre><p>Create a new, empty basic block with the given name.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L19-L23">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BasicBlock-Tuple{LLVM.Function, String}" href="#LLVM.BasicBlock-Tuple{LLVM.Function, String}"><code>LLVM.BasicBlock</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">BasicBlock(f::LLVM.Function, name::String)</code></pre><p>Create a new, empty basic block with the given name, and insert it at the end of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L27-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BasicBlock-Tuple{BasicBlock, String}" href="#LLVM.BasicBlock-Tuple{BasicBlock, String}"><code>LLVM.BasicBlock</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">BasicBlock(bb::BasicBlock, name::String)</code></pre><p>Create a new, empty basic block with the given name, and insert it before the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L36-L41">source</a></section></article><h2 id="Properties-and-operations"><a class="docs-heading-anchor" href="#Properties-and-operations">Properties and operations</a><a id="Properties-and-operations-1"></a><a class="docs-heading-anchor-permalink" href="#Properties-and-operations" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.remove!-Tuple{BasicBlock}" href="#LLVM.remove!-Tuple{BasicBlock}"><code>LLVM.remove!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">remove!(bb::BasicBlock)</code></pre><p>Remove the given basic block from its parent function, but do not free the object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L45-L49">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.erase!-Tuple{BasicBlock}" href="#LLVM.erase!-Tuple{BasicBlock}"><code>LLVM.erase!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">erase!(fun::Function, bb::BasicBlock)</code></pre><p>Remove the given basic block from its parent function and free the object.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is unsafe because it does not check if the basic block is used elsewhere.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L52-L60">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parent-Tuple{BasicBlock}" href="#LLVM.parent-Tuple{BasicBlock}"><code>LLVM.parent</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parent(bb::BasicBlock) -> LLVM.Function</code></pre><p>Get the function that contains the given basic block, or <code>nothing</code> if the block is not part of a function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L63-L68">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.terminator-Tuple{BasicBlock}" href="#LLVM.terminator-Tuple{BasicBlock}"><code>LLVM.terminator</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">terminator(bb::BasicBlock) -> LLVM.Instruction</code></pre><p>Get the terminator instruction of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L75-L79">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{BasicBlock}" href="#LLVM.name-Tuple{BasicBlock}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(bb::BasicBlock) -> String</code></pre><p>Get the name of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L86-L90">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.move_before" href="#LLVM.move_before"><code>LLVM.move_before</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">move_before(bb::BasicBlock, pos::BasicBlock)</code></pre><p>Move the given basic block before the given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L93-L97">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.move_after" href="#LLVM.move_after"><code>LLVM.move_after</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">move_after(bb::BasicBlock, pos::BasicBlock)</code></pre><p>Move the given basic block after the given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L101-L105">source</a></section></article><h2 id="Control-flow"><a class="docs-heading-anchor" href="#Control-flow">Control flow</a><a id="Control-flow-1"></a><a class="docs-heading-anchor-permalink" href="#Control-flow" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.predecessors-Tuple{BasicBlock}" href="#LLVM.predecessors-Tuple{BasicBlock}"><code>LLVM.predecessors</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">predecessors(bb::BasicBlock)</code></pre><p>Get the predecessors of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L178-L182">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.successors-Tuple{BasicBlock}" href="#LLVM.successors-Tuple{BasicBlock}"><code>LLVM.successors</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">successors(bb::BasicBlock)</code></pre><p>Get the successors of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L193-L197">source</a></section></article><h2 id="Instructions"><a class="docs-heading-anchor" href="#Instructions">Instructions</a><a id="Instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.instructions" href="#LLVM.instructions"><code>LLVM.instructions</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">instructions(bb::BasicBlock)</code></pre><p>Get an iterator over the instructions in the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L118-L122">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.previnst" href="#LLVM.previnst"><code>LLVM.previnst</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">previnst(inst::Instruction)</code></pre><p>Get the instruction before the given instruction in the basic block, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L149-L154">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.nextinst" href="#LLVM.nextinst"><code>LLVM.nextinst</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">nextinst(inst::Instruction)</code></pre><p>Get the instruction after the given instruction in the basic block, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/basicblock.jl#L161-L166">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../functions/">« Functions</a><a class="docs-footer-nextpage" href="../instructions/">Instructions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/codegen/index.html b/dev/lib/codegen/index.html index da40ed9d..2dd92140 100644 --- a/dev/lib/codegen/index.html +++ b/dev/lib/codegen/index.html @@ -1,4 +1,4 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Code generation · LLVM.jl</title><meta name="title" content="Code generation · LLVM.jl"/><meta property="og:title" content="Code generation · LLVM.jl"/><meta property="twitter:title" content="Code generation · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li class="is-active"><a class="tocitem" href>Code generation</a><ul class="internal"><li><a class="tocitem" href="#Targets"><span>Targets</span></a></li><li><a class="tocitem" href="#Target-machines"><span>Target machines</span></a></li><li><a class="tocitem" href="#Data-layout"><span>Data layout</span></a></li></ul></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Code generation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Code generation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/codegen.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Code-generation"><a class="docs-heading-anchor" href="#Code-generation">Code generation</a><a id="Code-generation-1"></a><a class="docs-heading-anchor-permalink" href="#Code-generation" title="Permalink"></a></h1><h2 id="Targets"><a class="docs-heading-anchor" href="#Targets">Targets</a><a id="Targets-1"></a><a class="docs-heading-anchor-permalink" href="#Targets" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Target" href="#LLVM.Target"><code>LLVM.Target</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Target</code></pre><p>A structure exposing target-specific information.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/target.jl#L7-L11">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{Target}" href="#LLVM.name-Tuple{Target}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(target::Target)</code></pre><p>Get the name of the given target.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/target.jl#L48-L52">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.description-Tuple{Target}" href="#LLVM.description-Tuple{Target}"><code>LLVM.description</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">description(target::Target)</code></pre><p>Get a short description of the given target.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/target.jl#L55-L59">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.hasjit-Tuple{Target}" href="#LLVM.hasjit-Tuple{Target}"><code>LLVM.hasjit</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">hasjit(target::Target)</code></pre><p>Check if this targets supports the just-in-time compilation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/target.jl#L62-L66">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.hastargetmachine-Tuple{Target}" href="#LLVM.hastargetmachine-Tuple{Target}"><code>LLVM.hastargetmachine</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">hastargetmachine(target::Target)</code></pre><p>Check if this target supports code generation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/target.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.hasasmparser-Tuple{Target}" href="#LLVM.hasasmparser-Tuple{Target}"><code>LLVM.hasasmparser</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">hasasmparser(target::Target)</code></pre><p>Check if this target supports assembly parsing.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/target.jl#L76-L80">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.targets" href="#LLVM.targets"><code>LLVM.targets</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">targets()</code></pre><p>Get an iterator over the available targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/target.jl#L94-L98">source</a></section></article><h2 id="Target-machines"><a class="docs-heading-anchor" href="#Target-machines">Target machines</a><a id="Target-machines-1"></a><a class="docs-heading-anchor-permalink" href="#Target-machines" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.TargetMachine" href="#LLVM.TargetMachine"><code>LLVM.TargetMachine</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TargetMachine</code></pre><p>Primary interface to the complete machine description for the target machine.</p><p>All target-specific information should be accessible through this interface.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L8-L14">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{TargetMachine}" href="#LLVM.dispose-Tuple{TargetMachine}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(tm::TargetMachine)</code></pre><p>Dispose of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L43-L47">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.target-Tuple{TargetMachine}" href="#LLVM.target-Tuple{TargetMachine}"><code>LLVM.target</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">target(tm::TargetMachine)</code></pre><p>Get the target of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L59-L63">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.triple-Tuple{TargetMachine}" href="#LLVM.triple-Tuple{TargetMachine}"><code>LLVM.triple</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">triple(tm::TargetMachine)</code></pre><p>Get the triple of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L66-L70">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.triple-Tuple{}" href="#LLVM.triple-Tuple{}"><code>LLVM.triple</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">triple()</code></pre><p>Get the default target triple.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L73-L77">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.normalize-Tuple{String}" href="#LLVM.normalize-Tuple{String}"><code>LLVM.normalize</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">normalize(triple::String)</code></pre><p>Normalize the given target triple.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L80-L84">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.cpu-Tuple{TargetMachine}" href="#LLVM.cpu-Tuple{TargetMachine}"><code>LLVM.cpu</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">cpu(tm::TargetMachine)</code></pre><p>Get the CPU of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L87-L91">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.features-Tuple{TargetMachine}" href="#LLVM.features-Tuple{TargetMachine}"><code>LLVM.features</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">features(tm::TargetMachine)</code></pre><p>Get the feature string of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L94-L98">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.asm_verbosity!" href="#LLVM.asm_verbosity!"><code>LLVM.asm_verbosity!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">asm_verbosity!(tm::TargetMachine, verbose::Bool)</code></pre><p>Set the verbosity of the target machine's assembly output.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L101-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.emit" href="#LLVM.emit"><code>LLVM.emit</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">emit(tm::TargetMachine, mod::Module, filetype::LLVMCodeGenFileType) -> UInt8[]</code></pre><p>Generate code for the given module using the target machine, returning the binary data. If assembly code was requested, the binary data can be converted back using <code>String</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L109-L114">source</a></section><section><div><pre><code class="language-julia hljs">emit(tm::TargetMachine, mod::Module, filetype::LLVMCodeGenFileType, path::String)</code></pre><p>Generate code for the given module using the target machine, writing it to the given file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L129-L133">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.add_transform_info!" href="#LLVM.add_transform_info!"><code>LLVM.add_transform_info!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">add_transform_info!(pm::PassManager, [tm::TargetMachine])</code></pre><p>Add target-specific analysis passes to the given pass manager.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L146-L150">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.add_library_info!" href="#LLVM.add_library_info!"><code>LLVM.add_library_info!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">add_library_info!(pm::PassManager, triple::String)</code></pre><p>Add target-specific library information to the given pass manager.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L159-L163">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.JITTargetMachine" href="#LLVM.JITTargetMachine"><code>LLVM.JITTargetMachine</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JITTargetMachine(; triple=LLVM.triple(), cpu="", features="", - optlevel=API.LLVMCodeGenLevelDefault)</code></pre><p>Create a target machine suitable for JIT compilation with the ORC JIT.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/targetmachine.jl#L167-L172">source</a></section></article><h2 id="Data-layout"><a class="docs-heading-anchor" href="#Data-layout">Data layout</a><a id="Data-layout-1"></a><a class="docs-heading-anchor-permalink" href="#Data-layout" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DataLayout" href="#LLVM.DataLayout"><code>LLVM.DataLayout</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DataLayout</code></pre><p>A parsed version of the target data layout string in and methods for querying it.</p><p>The target data layout string is specified by the target - a frontend generating LLVM IR is required to generate the right target data for the target being codegen'd to.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L9-L16">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{DataLayout}" href="#LLVM.dispose-Tuple{DataLayout}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(data::DataLayout)</code></pre><p>Dispose of the given target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L40-L44">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.byteorder" href="#LLVM.byteorder"><code>LLVM.byteorder</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">byteorder(data::DataLayout)</code></pre><p>Get the byte order of the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L63-L67">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.pointersize" href="#LLVM.pointersize"><code>LLVM.pointersize</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">pointersize(data::DataLayout, [addrspace::Integer])</code></pre><p>Get the pointer size of the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L70-L74">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.intptr" href="#LLVM.intptr"><code>LLVM.intptr</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">intptr(data::DataLayout, [addrspace::Integer])</code></pre><p>Get the integer type that is the same size as a pointer for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L78-L82">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.sizeof-Tuple{DataLayout, LLVMType}" href="#Base.sizeof-Tuple{DataLayout, LLVMType}"><code>Base.sizeof</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sizeof(data::DataLayout, typ::LLVMType)</code></pre><p>Get the size of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L86-L90">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.storage_size" href="#LLVM.storage_size"><code>LLVM.storage_size</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">storage_size(data::DataLayout, typ::LLVMType)</code></pre><p>Get the storage size of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L93-L97">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.abi_size" href="#LLVM.abi_size"><code>LLVM.abi_size</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">abi_size(data::DataLayout, typ::LLVMType)</code></pre><p>Get the ABI size of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L100-L104">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.abi_alignment" href="#LLVM.abi_alignment"><code>LLVM.abi_alignment</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">abi_alignment(data::DataLayout, typ::LLVMType)</code></pre><p>Get the ABI alignment of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L107-L111">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.frame_alignment" href="#LLVM.frame_alignment"><code>LLVM.frame_alignment</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">frame_alignment(data::DataLayout, typ::LLVMType)</code></pre><p>Get the call frame alignment of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L115-L119">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.preferred_alignment" href="#LLVM.preferred_alignment"><code>LLVM.preferred_alignment</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">preferred_alignment(data::DataLayout, typ::LLVMType) -preferred_alignment(data::DataLayout, var::GlobalVariable)</code></pre><p>Get the preferred alignment of the given type or global variable in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L124-L130">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.element_at" href="#LLVM.element_at"><code>LLVM.element_at</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">element_at(data::DataLayout, typ::StructType, offset::Integer)</code></pre><p>Get the element at the given offset in a struct type for the target data layout.</p><p>See also: <a href="#LLVM.offsetof"><code>offsetof</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L138-L144">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.offsetof" href="#LLVM.offsetof"><code>LLVM.offsetof</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">offsetof(data::DataLayout, typ::StructType, element::Integer)</code></pre><p>Get the offset of the given element in a struct type for the target data layout.</p><p>See also: <a href="#LLVM.element_at"><code>element_at</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/datalayout.jl#L148-L154">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transforms/">« Transforms</a><a class="docs-footer-nextpage" href="../execution/">Execution »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Code generation · LLVM.jl</title><meta name="title" content="Code generation · LLVM.jl"/><meta property="og:title" content="Code generation · LLVM.jl"/><meta property="twitter:title" content="Code generation · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li class="is-active"><a class="tocitem" href>Code generation</a><ul class="internal"><li><a class="tocitem" href="#Targets"><span>Targets</span></a></li><li><a class="tocitem" href="#Target-machines"><span>Target machines</span></a></li><li><a class="tocitem" href="#Data-layout"><span>Data layout</span></a></li></ul></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Code generation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Code generation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/codegen.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Code-generation"><a class="docs-heading-anchor" href="#Code-generation">Code generation</a><a id="Code-generation-1"></a><a class="docs-heading-anchor-permalink" href="#Code-generation" title="Permalink"></a></h1><h2 id="Targets"><a class="docs-heading-anchor" href="#Targets">Targets</a><a id="Targets-1"></a><a class="docs-heading-anchor-permalink" href="#Targets" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Target" href="#LLVM.Target"><code>LLVM.Target</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Target</code></pre><p>A structure exposing target-specific information.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/target.jl#L7-L11">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{Target}" href="#LLVM.name-Tuple{Target}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(target::Target)</code></pre><p>Get the name of the given target.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/target.jl#L48-L52">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.description-Tuple{Target}" href="#LLVM.description-Tuple{Target}"><code>LLVM.description</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">description(target::Target)</code></pre><p>Get a short description of the given target.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/target.jl#L55-L59">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.hasjit-Tuple{Target}" href="#LLVM.hasjit-Tuple{Target}"><code>LLVM.hasjit</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">hasjit(target::Target)</code></pre><p>Check if this targets supports the just-in-time compilation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/target.jl#L62-L66">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.hastargetmachine-Tuple{Target}" href="#LLVM.hastargetmachine-Tuple{Target}"><code>LLVM.hastargetmachine</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">hastargetmachine(target::Target)</code></pre><p>Check if this target supports code generation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/target.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.hasasmparser-Tuple{Target}" href="#LLVM.hasasmparser-Tuple{Target}"><code>LLVM.hasasmparser</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">hasasmparser(target::Target)</code></pre><p>Check if this target supports assembly parsing.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/target.jl#L76-L80">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.targets" href="#LLVM.targets"><code>LLVM.targets</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">targets()</code></pre><p>Get an iterator over the available targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/target.jl#L94-L98">source</a></section></article><h2 id="Target-machines"><a class="docs-heading-anchor" href="#Target-machines">Target machines</a><a id="Target-machines-1"></a><a class="docs-heading-anchor-permalink" href="#Target-machines" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.TargetMachine" href="#LLVM.TargetMachine"><code>LLVM.TargetMachine</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TargetMachine</code></pre><p>Primary interface to the complete machine description for the target machine.</p><p>All target-specific information should be accessible through this interface.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L8-L14">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{TargetMachine}" href="#LLVM.dispose-Tuple{TargetMachine}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(tm::TargetMachine)</code></pre><p>Dispose of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L43-L47">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.target-Tuple{TargetMachine}" href="#LLVM.target-Tuple{TargetMachine}"><code>LLVM.target</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">target(tm::TargetMachine)</code></pre><p>Get the target of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L59-L63">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.triple-Tuple{TargetMachine}" href="#LLVM.triple-Tuple{TargetMachine}"><code>LLVM.triple</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">triple(tm::TargetMachine)</code></pre><p>Get the triple of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L66-L70">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.triple-Tuple{}" href="#LLVM.triple-Tuple{}"><code>LLVM.triple</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">triple()</code></pre><p>Get the default target triple.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L73-L77">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.normalize-Tuple{String}" href="#LLVM.normalize-Tuple{String}"><code>LLVM.normalize</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">normalize(triple::String)</code></pre><p>Normalize the given target triple.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L80-L84">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.cpu-Tuple{TargetMachine}" href="#LLVM.cpu-Tuple{TargetMachine}"><code>LLVM.cpu</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">cpu(tm::TargetMachine)</code></pre><p>Get the CPU of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L87-L91">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.features-Tuple{TargetMachine}" href="#LLVM.features-Tuple{TargetMachine}"><code>LLVM.features</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">features(tm::TargetMachine)</code></pre><p>Get the feature string of the given target machine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L94-L98">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.asm_verbosity!" href="#LLVM.asm_verbosity!"><code>LLVM.asm_verbosity!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">asm_verbosity!(tm::TargetMachine, verbose::Bool)</code></pre><p>Set the verbosity of the target machine's assembly output.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L101-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.emit" href="#LLVM.emit"><code>LLVM.emit</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">emit(tm::TargetMachine, mod::Module, filetype::LLVMCodeGenFileType) -> UInt8[]</code></pre><p>Generate code for the given module using the target machine, returning the binary data. If assembly code was requested, the binary data can be converted back using <code>String</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L109-L114">source</a></section><section><div><pre><code class="language-julia hljs">emit(tm::TargetMachine, mod::Module, filetype::LLVMCodeGenFileType, path::String)</code></pre><p>Generate code for the given module using the target machine, writing it to the given file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L129-L133">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.add_transform_info!" href="#LLVM.add_transform_info!"><code>LLVM.add_transform_info!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">add_transform_info!(pm::PassManager, [tm::TargetMachine])</code></pre><p>Add target-specific analysis passes to the given pass manager.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L146-L150">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.add_library_info!" href="#LLVM.add_library_info!"><code>LLVM.add_library_info!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">add_library_info!(pm::PassManager, triple::String)</code></pre><p>Add target-specific library information to the given pass manager.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L159-L163">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.JITTargetMachine" href="#LLVM.JITTargetMachine"><code>LLVM.JITTargetMachine</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JITTargetMachine(; triple=LLVM.triple(), cpu="", features="", + optlevel=API.LLVMCodeGenLevelDefault)</code></pre><p>Create a target machine suitable for JIT compilation with the ORC JIT.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/targetmachine.jl#L167-L172">source</a></section></article><h2 id="Data-layout"><a class="docs-heading-anchor" href="#Data-layout">Data layout</a><a id="Data-layout-1"></a><a class="docs-heading-anchor-permalink" href="#Data-layout" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DataLayout" href="#LLVM.DataLayout"><code>LLVM.DataLayout</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DataLayout</code></pre><p>A parsed version of the target data layout string in and methods for querying it.</p><p>The target data layout string is specified by the target - a frontend generating LLVM IR is required to generate the right target data for the target being codegen'd to.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L9-L16">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{DataLayout}" href="#LLVM.dispose-Tuple{DataLayout}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(data::DataLayout)</code></pre><p>Dispose of the given target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L40-L44">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.byteorder" href="#LLVM.byteorder"><code>LLVM.byteorder</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">byteorder(data::DataLayout)</code></pre><p>Get the byte order of the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L63-L67">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.pointersize" href="#LLVM.pointersize"><code>LLVM.pointersize</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">pointersize(data::DataLayout, [addrspace::Integer])</code></pre><p>Get the pointer size of the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L70-L74">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.intptr" href="#LLVM.intptr"><code>LLVM.intptr</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">intptr(data::DataLayout, [addrspace::Integer])</code></pre><p>Get the integer type that is the same size as a pointer for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L78-L82">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.sizeof-Tuple{DataLayout, LLVMType}" href="#Base.sizeof-Tuple{DataLayout, LLVMType}"><code>Base.sizeof</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sizeof(data::DataLayout, typ::LLVMType)</code></pre><p>Get the size of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L86-L90">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.storage_size" href="#LLVM.storage_size"><code>LLVM.storage_size</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">storage_size(data::DataLayout, typ::LLVMType)</code></pre><p>Get the storage size of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L93-L97">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.abi_size" href="#LLVM.abi_size"><code>LLVM.abi_size</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">abi_size(data::DataLayout, typ::LLVMType)</code></pre><p>Get the ABI size of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L100-L104">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.abi_alignment" href="#LLVM.abi_alignment"><code>LLVM.abi_alignment</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">abi_alignment(data::DataLayout, typ::LLVMType)</code></pre><p>Get the ABI alignment of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L107-L111">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.frame_alignment" href="#LLVM.frame_alignment"><code>LLVM.frame_alignment</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">frame_alignment(data::DataLayout, typ::LLVMType)</code></pre><p>Get the call frame alignment of the given type in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L115-L119">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.preferred_alignment" href="#LLVM.preferred_alignment"><code>LLVM.preferred_alignment</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">preferred_alignment(data::DataLayout, typ::LLVMType) +preferred_alignment(data::DataLayout, var::GlobalVariable)</code></pre><p>Get the preferred alignment of the given type or global variable in bytes for the target data layout.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L124-L130">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.element_at" href="#LLVM.element_at"><code>LLVM.element_at</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">element_at(data::DataLayout, typ::StructType, offset::Integer)</code></pre><p>Get the element at the given offset in a struct type for the target data layout.</p><p>See also: <a href="#LLVM.offsetof"><code>offsetof</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L138-L144">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.offsetof" href="#LLVM.offsetof"><code>LLVM.offsetof</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">offsetof(data::DataLayout, typ::StructType, element::Integer)</code></pre><p>Get the offset of the given element in a struct type for the target data layout.</p><p>See also: <a href="#LLVM.element_at"><code>element_at</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/datalayout.jl#L148-L154">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transforms/">« Transforms</a><a class="docs-footer-nextpage" href="../execution/">Execution »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/essentials/index.html b/dev/lib/essentials/index.html index a94c6070..d9966fc8 100644 --- a/dev/lib/essentials/index.html +++ b/dev/lib/essentials/index.html @@ -1,18 +1,18 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Essentials · LLVM.jl</title><meta name="title" content="Essentials · LLVM.jl"/><meta property="og:title" content="Essentials · LLVM.jl"/><meta property="twitter:title" content="Essentials · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li class="is-active"><a class="tocitem" href>Essentials</a><ul class="internal"><li><a class="tocitem" href="#Initialization"><span>Initialization</span></a></li><li><a class="tocitem" href="#Contexts"><span>Contexts</span></a></li><li><a class="tocitem" href="#Resources"><span>Resources</span></a></li><li><a class="tocitem" href="#Exceptions"><span>Exceptions</span></a></li><li><a class="tocitem" href="#Memory-buffers"><span>Memory buffers</span></a></li><li><a class="tocitem" href="#Other"><span>Other</span></a></li></ul></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Essentials</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Essentials</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/essentials.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Essentials"><a class="docs-heading-anchor" href="#Essentials">Essentials</a><a id="Essentials-1"></a><a class="docs-heading-anchor-permalink" href="#Essentials" title="Permalink"></a></h1><h2 id="Initialization"><a class="docs-heading-anchor" href="#Initialization">Initialization</a><a id="Initialization-1"></a><a class="docs-heading-anchor-permalink" href="#Initialization" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.backends" href="#LLVM.backends"><code>LLVM.backends</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">backends()</code></pre><p>Return a list of back-ends supported by the LLVM library.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L79-L83">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllTargetInfos" href="#LLVM.InitializeAllTargetInfos"><code>LLVM.InitializeAllTargetInfos</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllTargets" href="#LLVM.InitializeAllTargets"><code>LLVM.InitializeAllTargets</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Essentials · LLVM.jl</title><meta name="title" content="Essentials · LLVM.jl"/><meta property="og:title" content="Essentials · LLVM.jl"/><meta property="twitter:title" content="Essentials · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li class="is-active"><a class="tocitem" href>Essentials</a><ul class="internal"><li><a class="tocitem" href="#Initialization"><span>Initialization</span></a></li><li><a class="tocitem" href="#Contexts"><span>Contexts</span></a></li><li><a class="tocitem" href="#Resources"><span>Resources</span></a></li><li><a class="tocitem" href="#Exceptions"><span>Exceptions</span></a></li><li><a class="tocitem" href="#Memory-buffers"><span>Memory buffers</span></a></li><li><a class="tocitem" href="#Other"><span>Other</span></a></li></ul></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Essentials</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Essentials</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/essentials.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Essentials"><a class="docs-heading-anchor" href="#Essentials">Essentials</a><a id="Essentials-1"></a><a class="docs-heading-anchor-permalink" href="#Essentials" title="Permalink"></a></h1><h2 id="Initialization"><a class="docs-heading-anchor" href="#Initialization">Initialization</a><a id="Initialization-1"></a><a class="docs-heading-anchor-permalink" href="#Initialization" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.backends" href="#LLVM.backends"><code>LLVM.backends</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">backends()</code></pre><p>Return a list of back-ends supported by the LLVM library.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L79-L83">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllTargetInfos" href="#LLVM.InitializeAllTargetInfos"><code>LLVM.InitializeAllTargetInfos</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllTargets" href="#LLVM.InitializeAllTargets"><code>LLVM.InitializeAllTargets</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllTargetMCs" href="#LLVM.InitializeAllTargetMCs"><code>LLVM.InitializeAllTargetMCs</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllAsmParsers" href="#LLVM.InitializeAllAsmParsers"><code>LLVM.InitializeAllAsmParsers</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllTargetMCs" href="#LLVM.InitializeAllTargetMCs"><code>LLVM.InitializeAllTargetMCs</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllAsmParsers" href="#LLVM.InitializeAllAsmParsers"><code>LLVM.InitializeAllAsmParsers</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllAsmPrinters" href="#LLVM.InitializeAllAsmPrinters"><code>LLVM.InitializeAllAsmPrinters</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllAsmPrinters" href="#LLVM.InitializeAllAsmPrinters"><code>LLVM.InitializeAllAsmPrinters</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllDisassemblers" href="#LLVM.InitializeAllDisassemblers"><code>LLVM.InitializeAllDisassemblers</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAllDisassemblers" href="#LLVM.InitializeAllDisassemblers"><code>LLVM.InitializeAllDisassemblers</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><h2 id="Contexts"><a class="docs-heading-anchor" href="#Contexts">Contexts</a><a id="Contexts-1"></a><a class="docs-heading-anchor-permalink" href="#Contexts" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Context" href="#LLVM.Context"><code>LLVM.Context</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Context</code></pre><p>Execution state for the core LLVM IR system. Created by calling the <code>Context()</code> constructor, and should be disposed of.</p><p>Most types are tied to a context instance. Multiple contexts can exist simultaneously. A single context is not thread safe. However, different contexts can execute on different threads simultaneously.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/context.jl#L5-L14">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Context-Tuple{}" href="#LLVM.Context-Tuple{}"><code>LLVM.Context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Context(; opaque_pointers=nothing)</code></pre><p>Create a new LLVM context. If <code>opaque_pointers</code> is <code>true</code>, the context will use opaque pointers instead of typed pointers (if suppoprted). Otherwise the behavior of the context depends on the LLVM version.</p><p>This object needs to be disposed of using <a href="#LLVM.dispose-Tuple{Context}"><code>dispose(::Context)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/context.jl#L21-L29">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{Context}" href="#LLVM.dispose-Tuple{Context}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(ctx::Context)</code></pre><p>Dispose of the context, releasing all resources associated with it. The context should not be used after this operation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/context.jl#L40-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.supports_typed_pointers" href="#LLVM.supports_typed_pointers"><code>LLVM.supports_typed_pointers</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">supports_typed_pointers()</code></pre><p>Check whether the current context supports typed pointers.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/context.jl#L81-L85">source</a></section></article><p>LLVM.jl also tracks the context in task-local scope:</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{}" href="#LLVM.context-Tuple{}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(; throw_error::Bool=true)</code></pre><p>Get the active LLVM context for the current tasks. Throws an exception if no context is active, unless <code>throw_error=false</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/state.jl#L14-L19">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.activate-Tuple{Context}" href="#LLVM.activate-Tuple{Context}"><code>LLVM.activate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">activate(ctx::LLVM.Context)</code></pre><p>Pushes a new context onto the context stack.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/state.jl#L28-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.deactivate-Tuple{Context}" href="#LLVM.deactivate-Tuple{Context}"><code>LLVM.deactivate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">deactivate(ctx::LLVM.Context)</code></pre><p>Pops the current context from the context stack.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/state.jl#L41-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context!" href="#LLVM.context!"><code>LLVM.context!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context!(ctx::LLVM.Context) do +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><h2 id="Contexts"><a class="docs-heading-anchor" href="#Contexts">Contexts</a><a id="Contexts-1"></a><a class="docs-heading-anchor-permalink" href="#Contexts" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Context" href="#LLVM.Context"><code>LLVM.Context</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Context</code></pre><p>Execution state for the core LLVM IR system. Created by calling the <code>Context()</code> constructor, and should be disposed of.</p><p>Most types are tied to a context instance. Multiple contexts can exist simultaneously. A single context is not thread safe. However, different contexts can execute on different threads simultaneously.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/context.jl#L5-L14">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Context-Tuple{}" href="#LLVM.Context-Tuple{}"><code>LLVM.Context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Context(; opaque_pointers=nothing)</code></pre><p>Create a new LLVM context. If <code>opaque_pointers</code> is <code>true</code>, the context will use opaque pointers instead of typed pointers (if suppoprted). Otherwise the behavior of the context depends on the LLVM version.</p><p>This object needs to be disposed of using <a href="#LLVM.dispose-Tuple{Context}"><code>dispose(::Context)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/context.jl#L21-L29">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{Context}" href="#LLVM.dispose-Tuple{Context}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(ctx::Context)</code></pre><p>Dispose of the context, releasing all resources associated with it. The context should not be used after this operation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/context.jl#L40-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.supports_typed_pointers" href="#LLVM.supports_typed_pointers"><code>LLVM.supports_typed_pointers</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">supports_typed_pointers()</code></pre><p>Check whether the current context supports typed pointers.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/context.jl#L81-L85">source</a></section></article><p>LLVM.jl also tracks the context in task-local scope:</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{}" href="#LLVM.context-Tuple{}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(; throw_error::Bool=true)</code></pre><p>Get the active LLVM context for the current tasks. Throws an exception if no context is active, unless <code>throw_error=false</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/state.jl#L14-L19">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.activate-Tuple{Context}" href="#LLVM.activate-Tuple{Context}"><code>LLVM.activate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">activate(ctx::LLVM.Context)</code></pre><p>Pushes a new context onto the context stack.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/state.jl#L28-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.deactivate-Tuple{Context}" href="#LLVM.deactivate-Tuple{Context}"><code>LLVM.deactivate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">deactivate(ctx::LLVM.Context)</code></pre><p>Pops the current context from the context stack.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/state.jl#L41-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context!" href="#LLVM.context!"><code>LLVM.context!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context!(ctx::LLVM.Context) do ... -end</code></pre><p>Temporarily activates the given context for the duration of the block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/state.jl#L51-L57">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ts_context" href="#LLVM.ts_context"><code>LLVM.ts_context</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ts_context(; throw_error::Bool=true)</code></pre><p>Get the active LLVM thread-safe context for the current tasks. Throws an exception if no context is active, unless <code>throw_error=false</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/state.jl#L75-L80">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.activate-Tuple{ThreadSafeContext}" href="#LLVM.activate-Tuple{ThreadSafeContext}"><code>LLVM.activate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">activate(ts_ctx::LLVM.ThreadSafeContext)</code></pre><p>Pushes a new thread-safe context onto the context stack.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/state.jl#L89-L93">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.deactivate-Tuple{ThreadSafeContext}" href="#LLVM.deactivate-Tuple{ThreadSafeContext}"><code>LLVM.deactivate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">deactivate(ts_ctx::LLVM.ThreadSafeContext)</code></pre><p>Pops the current thread-safe context from the context stack.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/state.jl#L102-L106">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ts_context!" href="#LLVM.ts_context!"><code>LLVM.ts_context!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ts_context!(ts_ctx::LLVM.ThreadSafeContext) do +end</code></pre><p>Temporarily activates the given context for the duration of the block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/state.jl#L51-L57">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ts_context" href="#LLVM.ts_context"><code>LLVM.ts_context</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ts_context(; throw_error::Bool=true)</code></pre><p>Get the active LLVM thread-safe context for the current tasks. Throws an exception if no context is active, unless <code>throw_error=false</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/state.jl#L75-L80">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.activate-Tuple{ThreadSafeContext}" href="#LLVM.activate-Tuple{ThreadSafeContext}"><code>LLVM.activate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">activate(ts_ctx::LLVM.ThreadSafeContext)</code></pre><p>Pushes a new thread-safe context onto the context stack.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/state.jl#L89-L93">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.deactivate-Tuple{ThreadSafeContext}" href="#LLVM.deactivate-Tuple{ThreadSafeContext}"><code>LLVM.deactivate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">deactivate(ts_ctx::LLVM.ThreadSafeContext)</code></pre><p>Pops the current thread-safe context from the context stack.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/state.jl#L102-L106">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ts_context!" href="#LLVM.ts_context!"><code>LLVM.ts_context!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ts_context!(ts_ctx::LLVM.ThreadSafeContext) do ... -end</code></pre><p>Temporarily activates the given thread-safe context for the duration of the block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/state.jl#L112-L118">source</a></section></article><h2 id="Resources"><a class="docs-heading-anchor" href="#Resources">Resources</a><a id="Resources-1"></a><a class="docs-heading-anchor-permalink" href="#Resources" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.@dispose" href="#LLVM.@dispose"><code>LLVM.@dispose</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@dispose foo=Foo() bar=Bar() begin +end</code></pre><p>Temporarily activates the given thread-safe context for the duration of the block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/state.jl#L112-L118">source</a></section></article><h2 id="Resources"><a class="docs-heading-anchor" href="#Resources">Resources</a><a id="Resources-1"></a><a class="docs-heading-anchor-permalink" href="#Resources" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.@dispose" href="#LLVM.@dispose"><code>LLVM.@dispose</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@dispose foo=Foo() bar=Bar() begin ... -end</code></pre><p>Helper macro for disposing resources (by calling the <code>dispose</code> function for every resource in reverse order) after executing a block of code. This is often equivalent to calling the recourse constructor with do-block syntax, but without using (potentially costly) closures.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/base.jl#L70-L78">source</a></section></article><h2 id="Exceptions"><a class="docs-heading-anchor" href="#Exceptions">Exceptions</a><a id="Exceptions-1"></a><a class="docs-heading-anchor-permalink" href="#Exceptions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.LLVMException" href="#LLVM.LLVMException"><code>LLVM.LLVMException</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVMException</code></pre><p>Exception type for errors in the LLVM API. Possibly thrown by diagnostic handlers, and fatal eror handlers.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/context.jl#L123-L128">source</a></section></article><h2 id="Memory-buffers"><a class="docs-heading-anchor" href="#Memory-buffers">Memory buffers</a><a id="Memory-buffers-1"></a><a class="docs-heading-anchor-permalink" href="#Memory-buffers" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MemoryBuffer" href="#LLVM.MemoryBuffer"><code>LLVM.MemoryBuffer</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MemoryBuffer</code></pre><p>A memory buffer representing a simple block of memory.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/buffer.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MemoryBuffer-Union{Tuple{T}, Tuple{Vector{T}, String, Bool}} where T<:Union{Int8, UInt8}" href="#LLVM.MemoryBuffer-Union{Tuple{T}, Tuple{Vector{T}, String, Bool}} where T<:Union{Int8, UInt8}"><code>LLVM.MemoryBuffer</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MemoryBuffer(data::Vector{T}, name::String="", copy::Bool=true)</code></pre><p>Create a memory buffer from the given data. If <code>copy</code> is <code>true</code>, the data is copied into the buffer. Otherwise, the user is responsible for keeping the data alive across the lifetime of the buffer.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/buffer.jl#L15-L23">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MemoryBufferFile" href="#LLVM.MemoryBufferFile"><code>LLVM.MemoryBufferFile</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MemoryBufferFile(path::String)</code></pre><p>Create a memory buffer from the contents of a file.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/buffer.jl#L44-L50">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{MemoryBuffer}" href="#LLVM.dispose-Tuple{MemoryBuffer}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(membuf::MemoryBuffer)</code></pre><p>Dispose of the given memory buffer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/buffer.jl#L74-L78">source</a></section></article><h2 id="Other"><a class="docs-heading-anchor" href="#Other">Other</a><a id="Other-1"></a><a class="docs-heading-anchor-permalink" href="#Other" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.clopts" href="#LLVM.clopts"><code>LLVM.clopts</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">clopts(opts...)</code></pre><p>Parse the given arguments using the LLVM command-line parser.</p><p>Note that this function modifies the global state of the LLVM library. It is also not safe to rely on the stability of the command-line options between different versions of LLVM.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/support.jl#L3-L10">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ismultithreaded" href="#LLVM.ismultithreaded"><code>LLVM.ismultithreaded</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ismultithreaded()</code></pre><p>Check whether LLVM is executing in thread-safe mode or not.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L5-L9">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../man/interop/">« Julia integration</a><a class="docs-footer-nextpage" href="../types/">Types »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +end</code></pre><p>Helper macro for disposing resources (by calling the <code>dispose</code> function for every resource in reverse order) after executing a block of code. This is often equivalent to calling the recourse constructor with do-block syntax, but without using (potentially costly) closures.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/base.jl#L70-L78">source</a></section></article><h2 id="Exceptions"><a class="docs-heading-anchor" href="#Exceptions">Exceptions</a><a id="Exceptions-1"></a><a class="docs-heading-anchor-permalink" href="#Exceptions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.LLVMException" href="#LLVM.LLVMException"><code>LLVM.LLVMException</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVMException</code></pre><p>Exception type for errors in the LLVM API. Possibly thrown by diagnostic handlers, and fatal eror handlers.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/context.jl#L123-L128">source</a></section></article><h2 id="Memory-buffers"><a class="docs-heading-anchor" href="#Memory-buffers">Memory buffers</a><a id="Memory-buffers-1"></a><a class="docs-heading-anchor-permalink" href="#Memory-buffers" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MemoryBuffer" href="#LLVM.MemoryBuffer"><code>LLVM.MemoryBuffer</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MemoryBuffer</code></pre><p>A memory buffer representing a simple block of memory.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/buffer.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MemoryBuffer-Union{Tuple{T}, Tuple{Vector{T}, String, Bool}} where T<:Union{Int8, UInt8}" href="#LLVM.MemoryBuffer-Union{Tuple{T}, Tuple{Vector{T}, String, Bool}} where T<:Union{Int8, UInt8}"><code>LLVM.MemoryBuffer</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MemoryBuffer(data::Vector{T}, name::String="", copy::Bool=true)</code></pre><p>Create a memory buffer from the given data. If <code>copy</code> is <code>true</code>, the data is copied into the buffer. Otherwise, the user is responsible for keeping the data alive across the lifetime of the buffer.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/buffer.jl#L15-L23">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MemoryBufferFile" href="#LLVM.MemoryBufferFile"><code>LLVM.MemoryBufferFile</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MemoryBufferFile(path::String)</code></pre><p>Create a memory buffer from the contents of a file.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/buffer.jl#L44-L50">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{MemoryBuffer}" href="#LLVM.dispose-Tuple{MemoryBuffer}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(membuf::MemoryBuffer)</code></pre><p>Dispose of the given memory buffer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/buffer.jl#L74-L78">source</a></section></article><h2 id="Other"><a class="docs-heading-anchor" href="#Other">Other</a><a id="Other-1"></a><a class="docs-heading-anchor-permalink" href="#Other" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.clopts" href="#LLVM.clopts"><code>LLVM.clopts</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">clopts(opts...)</code></pre><p>Parse the given arguments using the LLVM command-line parser.</p><p>Note that this function modifies the global state of the LLVM library. It is also not safe to rely on the stability of the command-line options between different versions of LLVM.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/support.jl#L3-L10">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ismultithreaded" href="#LLVM.ismultithreaded"><code>LLVM.ismultithreaded</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ismultithreaded()</code></pre><p>Check whether LLVM is executing in thread-safe mode or not.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L5-L9">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../man/interop/">« Julia integration</a><a class="docs-footer-nextpage" href="../types/">Types »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/execution/index.html b/dev/lib/execution/index.html index 5feb7062..574972ac 100644 --- a/dev/lib/execution/index.html +++ b/dev/lib/execution/index.html @@ -1,2 +1,2 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Execution · LLVM.jl</title><meta name="title" content="Execution · LLVM.jl"/><meta property="og:title" content="Execution · LLVM.jl"/><meta property="twitter:title" content="Execution · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li class="is-active"><a class="tocitem" href>Execution</a><ul class="internal"><li><a class="tocitem" href="#Generic-Value"><span>Generic Value</span></a></li><li><a class="tocitem" href="#Floating-Point"><span>Floating Point</span></a></li><li><a class="tocitem" href="#Pointer"><span>Pointer</span></a></li><li><a class="tocitem" href="#MCJIT"><span>MCJIT</span></a></li><li><a class="tocitem" href="#ORCJIT"><span>ORCJIT</span></a></li></ul></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Execution</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Execution</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/execution.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Execution"><a class="docs-heading-anchor" href="#Execution">Execution</a><a id="Execution-1"></a><a class="docs-heading-anchor-permalink" href="#Execution" title="Permalink"></a></h1><h2 id="Generic-Value"><a class="docs-heading-anchor" href="#Generic-Value">Generic Value</a><a id="Generic-Value-1"></a><a class="docs-heading-anchor-permalink" href="#Generic-Value" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GenericValue" href="#LLVM.GenericValue"><code>LLVM.GenericValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GenericValue</code></pre><p>A generic value that can be passed to or returned from a function in the execution engine.</p><p>Note that only simple types are supported, and for most use cases it is recommended to look up the address of the compiled function and <code>ccall</code> it directly.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L9-L18">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{GenericValue}" href="#LLVM.dispose-Tuple{GenericValue}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(val::GenericValue)</code></pre><p>Dispose of the given generic value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L25-L29">source</a></section></article><h3 id="Integer"><a class="docs-heading-anchor" href="#Integer">Integer</a><a id="Integer-1"></a><a class="docs-heading-anchor-permalink" href="#Integer" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GenericValue-Tuple{LLVM.IntegerType, Integer}" href="#LLVM.GenericValue-Tuple{LLVM.IntegerType, Integer}"><code>LLVM.GenericValue</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GenericValue(typ::LLVM.IntegerType, N::Integer)</code></pre><p>Create a generic value from an integer of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L32-L36">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.intwidth" href="#LLVM.intwidth"><code>LLVM.intwidth</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">intwidth(val::GenericValue)</code></pre><p>Get the bit width of the integer value stored in the generic value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L49-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{T}, GenericValue}} where T<:Integer" href="#Base.convert-Union{Tuple{T}, Tuple{Type{T}, GenericValue}} where T<:Integer"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{<:Integer}, val::GenericValue)</code></pre><p>Convert a generic value to an integer of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L56-L60">source</a></section></article><h2 id="Floating-Point"><a class="docs-heading-anchor" href="#Floating-Point">Floating Point</a><a id="Floating-Point-1"></a><a class="docs-heading-anchor-permalink" href="#Floating-Point" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GenericValue-Tuple{LLVM.FloatingPointType, AbstractFloat}" href="#LLVM.GenericValue-Tuple{LLVM.FloatingPointType, AbstractFloat}"><code>LLVM.GenericValue</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GenericValue(typ::LLVM.FloatingPointType, N::AbstractFloat)</code></pre><p>Create a generic value from a floating point number of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{T}, GenericValue, LLVMType}} where T<:AbstractFloat" href="#Base.convert-Union{Tuple{T}, Tuple{Type{T}, GenericValue, LLVMType}} where T<:AbstractFloat"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{<:AbstractFloat}, val::GenericValue, typ::LLVM.FloatingPointType)</code></pre><p>Convert a generic value to a floating point number of the given type.</p><p>Contrary to the integer conversion, the LLVM type is also required to be passed explicitly.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L80-L86">source</a></section></article><h2 id="Pointer"><a class="docs-heading-anchor" href="#Pointer">Pointer</a><a id="Pointer-1"></a><a class="docs-heading-anchor-permalink" href="#Pointer" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GenericValue-Tuple{Ptr}" href="#LLVM.GenericValue-Tuple{Ptr}"><code>LLVM.GenericValue</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GenericValue(ptr::Ptr)</code></pre><p>Create a generic value from a pointer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L90-L94">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{Ptr{T}}, GenericValue}} where T" href="#Base.convert-Union{Tuple{T}, Tuple{Type{Ptr{T}}, GenericValue}} where T"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{Ptr{T}}, val::GenericValue)</code></pre><p>Convert a generic value to a pointer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L98-L102">source</a></section></article><h2 id="MCJIT"><a class="docs-heading-anchor" href="#MCJIT">MCJIT</a><a id="MCJIT-1"></a><a class="docs-heading-anchor-permalink" href="#MCJIT" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ExecutionEngine" href="#LLVM.ExecutionEngine"><code>LLVM.ExecutionEngine</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.ExecutionEngine</code></pre><p>An execution engine that can run functions in a module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L112-L116">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interpreter" href="#LLVM.Interpreter"><code>LLVM.Interpreter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Interpreter(mod::Module)</code></pre><p>Create an interpreter for the given module.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L139-L145">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.JIT" href="#LLVM.JIT"><code>LLVM.JIT</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JIT(mod::Module)</code></pre><p>Create a JIT compiler for the given module.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L161-L167">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{LLVM.ExecutionEngine}" href="#LLVM.dispose-Tuple{LLVM.ExecutionEngine}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(engine::ExecutionEngine)</code></pre><p>Dispose of the given execution engine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L183-L187">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.push!-Tuple{LLVM.ExecutionEngine, LLVM.Module}" href="#Base.push!-Tuple{LLVM.ExecutionEngine, LLVM.Module}"><code>Base.push!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">push!(engine::LLVM.ExecutionEngine, mod::Module)</code></pre><p>Add another module to the execution engine.</p><p>This takes ownership of the module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L204-L210">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.delete!-Tuple{LLVM.ExecutionEngine, LLVM.Module}" href="#Base.delete!-Tuple{LLVM.ExecutionEngine, LLVM.Module}"><code>Base.delete!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">delete!(engine::ExecutionEngine, mod::Module)</code></pre><p>Remove a module from the execution engine.</p><p>Ownership of the module is transferred back to the user.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L216-L222">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.run-Tuple{LLVM.ExecutionEngine, LLVM.Function, Vector{GenericValue}}" href="#Base.run-Tuple{LLVM.ExecutionEngine, LLVM.Function, Vector{GenericValue}}"><code>Base.run</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">run(engine::ExecutionEngine, f::Function, [args::Vector{GenericValue}])</code></pre><p>Run the given function with the given arguments in the execution engine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L231-L235">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.lookup-Tuple{LLVM.ExecutionEngine, String}" href="#LLVM.lookup-Tuple{LLVM.ExecutionEngine, String}"><code>LLVM.lookup</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">lookup(engine::ExecutionEngine, fn::String)</code></pre><p>Look up the address of the given function in the execution engine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L240-L244">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.functions-Tuple{LLVM.ExecutionEngine}" href="#LLVM.functions-Tuple{LLVM.ExecutionEngine}"><code>LLVM.functions</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">functions(engine::ExecutionEngine)</code></pre><p>Get an iterator over the functions in the execution engine.</p><p>The iterator object is not actually iterable, but supports <code>get</code> and <code>haskey</code> queries with function names, and <code>getindex</code> to get the function object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/execution.jl#L261-L268">source</a></section></article><h2 id="ORCJIT"><a class="docs-heading-anchor" href="#ORCJIT">ORCJIT</a><a id="ORCJIT-1"></a><a class="docs-heading-anchor-permalink" href="#ORCJIT" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeContext" href="#LLVM.ThreadSafeContext"><code>LLVM.ThreadSafeContext</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ThreadSafeContext</code></pre><p>A thread-safe version of <a href="../essentials/#LLVM.Context"><code>Context</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/ts_module.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeContext-Tuple{}" href="#LLVM.ThreadSafeContext-Tuple{}"><code>LLVM.ThreadSafeContext</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ThreadSafeContext(; opaque_pointers=nothing)</code></pre><p>Create a new thread-safe context. The behavior of <code>opaque_pointers</code> is the same as in <a href="../essentials/#LLVM.Context"><code>Context</code></a>.</p><p>This object needs to be disposed of using <a href="#LLVM.dispose-Tuple{ThreadSafeContext}"><code>dispose(::ThreadSafeContext)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/ts_module.jl#L13-L20">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{ThreadSafeContext}" href="#LLVM.context-Tuple{ThreadSafeContext}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(ts_ctx::ThreadSafeContext)</code></pre><p>Obtain the context associated with a thread-safe context.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This is an usafe operation, as the return context can be accessed in a thread-unsafe manner.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/ts_module.jl#L39-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{ThreadSafeContext}" href="#LLVM.dispose-Tuple{ThreadSafeContext}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(ctx::ThreadSafeContext)</code></pre><p>Dispose of the thread-safe context, releasing all resources associated with it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/ts_module.jl#L54-L58">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeModule" href="#LLVM.ThreadSafeModule"><code>LLVM.ThreadSafeModule</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ThreadSafeModule</code></pre><p>A thread-safe version of <a href="../modules/#LLVM.Module"><code>LLVM.Module</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/ts_module.jl#L64-L68">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeModule-Tuple{String}" href="#LLVM.ThreadSafeModule-Tuple{String}"><code>LLVM.ThreadSafeModule</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ThreadSafeModule(name::String)</code></pre><p>Create a thread-safe module with the given name.</p><p>This object needs to be disposed of using <a href="#LLVM.dispose-Tuple{ThreadSafeModule}"><code>dispose(::ThreadSafeModule)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/ts_module.jl#L108-L114">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeModule-Tuple{Module}" href="#LLVM.ThreadSafeModule-Tuple{Module}"><code>LLVM.ThreadSafeModule</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">(mod::ThreadSafeModule)(f)</code></pre><p>Apply <code>f</code> to the LLVM module contained within <code>mod</code>, after locking the module and activating its context.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/ts_module.jl#L157-L162">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{ThreadSafeModule}" href="#LLVM.dispose-Tuple{ThreadSafeModule}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(mod::ThreadSafeModule)</code></pre><p>Dispose of the thread-safe module, releasing all resources associated with it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/ts_module.jl#L125-L129">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.LLJIT" href="#LLVM.LLJIT"><code>LLVM.LLJIT</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLJIT(::LLJITBuilder)</code></pre><p>Creates a LLJIT stack based on the provided builder.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Takes ownership of the provided builder.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/lljit.jl#L28-L35">source</a></section><section><div><pre><code class="language-julia hljs">LLJIT(;tm::Union{Nothing, TargetMachine})</code></pre><p>Use the provided TargetMachine and construct an LLJIT from it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/executionengine/lljit.jl#L46-L50">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.JITDylib" href="#LLVM.JITDylib"><code>LLVM.JITDylib</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JITDylib(lljit::LLJIT)</code></pre><p>Get the main JITDylib</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/orc.jl#L134-L138">source</a></section><section><div><pre><code class="language-julia hljs">JITDylib(es::ExecutionSession, name; bare=false)</code></pre><p>Adds a new JITDylib to the ExecutionSession. The name must be unique and the <code>bare=true</code> no standard platform symbols are made available.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/orc.jl#L145-L150">source</a></section><section><div><pre><code class="language-julia hljs">JITDylib(jljit::JuliaOJIT)</code></pre><p>Get the external JITDylib from the Julia JIT</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/orc.jl#L392-L396">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.lookup-Tuple{LLJIT, Any}" href="#LLVM.lookup-Tuple{LLJIT, Any}"><code>LLVM.lookup</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">lookup(lljit::LLJIT, name)</code></pre><p>Takes an unmangled symbol names and searches for it in the LLJIT.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/orc.jl#L223-L227">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.linkinglayercreator!" href="#LLVM.linkinglayercreator!"><code>LLVM.linkinglayercreator!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">linkinglayercreator!(builder::LLJITBuilder, creator::ObjectLinkingLayerCreator)</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The creator object needs to be rooted by the caller for the lifetime of the builder argument.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/orc.jl#L74-L80">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../codegen/">« Code generation</a><a class="docs-footer-nextpage" href="../interop/">Julia integration »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Execution · LLVM.jl</title><meta name="title" content="Execution · LLVM.jl"/><meta property="og:title" content="Execution · LLVM.jl"/><meta property="twitter:title" content="Execution · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li class="is-active"><a class="tocitem" href>Execution</a><ul class="internal"><li><a class="tocitem" href="#Generic-Value"><span>Generic Value</span></a></li><li><a class="tocitem" href="#Floating-Point"><span>Floating Point</span></a></li><li><a class="tocitem" href="#Pointer"><span>Pointer</span></a></li><li><a class="tocitem" href="#MCJIT"><span>MCJIT</span></a></li><li><a class="tocitem" href="#ORCJIT"><span>ORCJIT</span></a></li></ul></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Execution</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Execution</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/execution.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Execution"><a class="docs-heading-anchor" href="#Execution">Execution</a><a id="Execution-1"></a><a class="docs-heading-anchor-permalink" href="#Execution" title="Permalink"></a></h1><h2 id="Generic-Value"><a class="docs-heading-anchor" href="#Generic-Value">Generic Value</a><a id="Generic-Value-1"></a><a class="docs-heading-anchor-permalink" href="#Generic-Value" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GenericValue" href="#LLVM.GenericValue"><code>LLVM.GenericValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GenericValue</code></pre><p>A generic value that can be passed to or returned from a function in the execution engine.</p><p>Note that only simple types are supported, and for most use cases it is recommended to look up the address of the compiled function and <code>ccall</code> it directly.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L9-L18">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{GenericValue}" href="#LLVM.dispose-Tuple{GenericValue}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(val::GenericValue)</code></pre><p>Dispose of the given generic value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L25-L29">source</a></section></article><h3 id="Integer"><a class="docs-heading-anchor" href="#Integer">Integer</a><a id="Integer-1"></a><a class="docs-heading-anchor-permalink" href="#Integer" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GenericValue-Tuple{LLVM.IntegerType, Integer}" href="#LLVM.GenericValue-Tuple{LLVM.IntegerType, Integer}"><code>LLVM.GenericValue</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GenericValue(typ::LLVM.IntegerType, N::Integer)</code></pre><p>Create a generic value from an integer of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L32-L36">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.intwidth" href="#LLVM.intwidth"><code>LLVM.intwidth</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">intwidth(val::GenericValue)</code></pre><p>Get the bit width of the integer value stored in the generic value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L49-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{T}, GenericValue}} where T<:Integer" href="#Base.convert-Union{Tuple{T}, Tuple{Type{T}, GenericValue}} where T<:Integer"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{<:Integer}, val::GenericValue)</code></pre><p>Convert a generic value to an integer of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L56-L60">source</a></section></article><h2 id="Floating-Point"><a class="docs-heading-anchor" href="#Floating-Point">Floating Point</a><a id="Floating-Point-1"></a><a class="docs-heading-anchor-permalink" href="#Floating-Point" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GenericValue-Tuple{LLVM.FloatingPointType, AbstractFloat}" href="#LLVM.GenericValue-Tuple{LLVM.FloatingPointType, AbstractFloat}"><code>LLVM.GenericValue</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GenericValue(typ::LLVM.FloatingPointType, N::AbstractFloat)</code></pre><p>Create a generic value from a floating point number of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{T}, GenericValue, LLVMType}} where T<:AbstractFloat" href="#Base.convert-Union{Tuple{T}, Tuple{Type{T}, GenericValue, LLVMType}} where T<:AbstractFloat"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{<:AbstractFloat}, val::GenericValue, typ::LLVM.FloatingPointType)</code></pre><p>Convert a generic value to a floating point number of the given type.</p><p>Contrary to the integer conversion, the LLVM type is also required to be passed explicitly.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L80-L86">source</a></section></article><h2 id="Pointer"><a class="docs-heading-anchor" href="#Pointer">Pointer</a><a id="Pointer-1"></a><a class="docs-heading-anchor-permalink" href="#Pointer" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GenericValue-Tuple{Ptr}" href="#LLVM.GenericValue-Tuple{Ptr}"><code>LLVM.GenericValue</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GenericValue(ptr::Ptr)</code></pre><p>Create a generic value from a pointer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L90-L94">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{Ptr{T}}, GenericValue}} where T" href="#Base.convert-Union{Tuple{T}, Tuple{Type{Ptr{T}}, GenericValue}} where T"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{Ptr{T}}, val::GenericValue)</code></pre><p>Convert a generic value to a pointer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L98-L102">source</a></section></article><h2 id="MCJIT"><a class="docs-heading-anchor" href="#MCJIT">MCJIT</a><a id="MCJIT-1"></a><a class="docs-heading-anchor-permalink" href="#MCJIT" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ExecutionEngine" href="#LLVM.ExecutionEngine"><code>LLVM.ExecutionEngine</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.ExecutionEngine</code></pre><p>An execution engine that can run functions in a module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L112-L116">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interpreter" href="#LLVM.Interpreter"><code>LLVM.Interpreter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Interpreter(mod::Module)</code></pre><p>Create an interpreter for the given module.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L139-L145">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.JIT" href="#LLVM.JIT"><code>LLVM.JIT</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JIT(mod::Module)</code></pre><p>Create a JIT compiler for the given module.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L161-L167">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{LLVM.ExecutionEngine}" href="#LLVM.dispose-Tuple{LLVM.ExecutionEngine}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(engine::ExecutionEngine)</code></pre><p>Dispose of the given execution engine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L183-L187">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.push!-Tuple{LLVM.ExecutionEngine, LLVM.Module}" href="#Base.push!-Tuple{LLVM.ExecutionEngine, LLVM.Module}"><code>Base.push!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">push!(engine::LLVM.ExecutionEngine, mod::Module)</code></pre><p>Add another module to the execution engine.</p><p>This takes ownership of the module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L204-L210">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.delete!-Tuple{LLVM.ExecutionEngine, LLVM.Module}" href="#Base.delete!-Tuple{LLVM.ExecutionEngine, LLVM.Module}"><code>Base.delete!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">delete!(engine::ExecutionEngine, mod::Module)</code></pre><p>Remove a module from the execution engine.</p><p>Ownership of the module is transferred back to the user.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L216-L222">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.run-Tuple{LLVM.ExecutionEngine, LLVM.Function, Vector{GenericValue}}" href="#Base.run-Tuple{LLVM.ExecutionEngine, LLVM.Function, Vector{GenericValue}}"><code>Base.run</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">run(engine::ExecutionEngine, f::Function, [args::Vector{GenericValue}])</code></pre><p>Run the given function with the given arguments in the execution engine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L231-L235">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.lookup-Tuple{LLVM.ExecutionEngine, String}" href="#LLVM.lookup-Tuple{LLVM.ExecutionEngine, String}"><code>LLVM.lookup</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">lookup(engine::ExecutionEngine, fn::String)</code></pre><p>Look up the address of the given function in the execution engine.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L240-L244">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.functions-Tuple{LLVM.ExecutionEngine}" href="#LLVM.functions-Tuple{LLVM.ExecutionEngine}"><code>LLVM.functions</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">functions(engine::ExecutionEngine)</code></pre><p>Get an iterator over the functions in the execution engine.</p><p>The iterator object is not actually iterable, but supports <code>get</code> and <code>haskey</code> queries with function names, and <code>getindex</code> to get the function object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/execution.jl#L261-L268">source</a></section></article><h2 id="ORCJIT"><a class="docs-heading-anchor" href="#ORCJIT">ORCJIT</a><a id="ORCJIT-1"></a><a class="docs-heading-anchor-permalink" href="#ORCJIT" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeContext" href="#LLVM.ThreadSafeContext"><code>LLVM.ThreadSafeContext</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ThreadSafeContext</code></pre><p>A thread-safe version of <a href="../essentials/#LLVM.Context"><code>Context</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/ts_module.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeContext-Tuple{}" href="#LLVM.ThreadSafeContext-Tuple{}"><code>LLVM.ThreadSafeContext</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ThreadSafeContext(; opaque_pointers=nothing)</code></pre><p>Create a new thread-safe context. The behavior of <code>opaque_pointers</code> is the same as in <a href="../essentials/#LLVM.Context"><code>Context</code></a>.</p><p>This object needs to be disposed of using <a href="#LLVM.dispose-Tuple{ThreadSafeContext}"><code>dispose(::ThreadSafeContext)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/ts_module.jl#L13-L20">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{ThreadSafeContext}" href="#LLVM.context-Tuple{ThreadSafeContext}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(ts_ctx::ThreadSafeContext)</code></pre><p>Obtain the context associated with a thread-safe context.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This is an usafe operation, as the return context can be accessed in a thread-unsafe manner.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/ts_module.jl#L39-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{ThreadSafeContext}" href="#LLVM.dispose-Tuple{ThreadSafeContext}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(ctx::ThreadSafeContext)</code></pre><p>Dispose of the thread-safe context, releasing all resources associated with it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/ts_module.jl#L54-L58">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeModule" href="#LLVM.ThreadSafeModule"><code>LLVM.ThreadSafeModule</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ThreadSafeModule</code></pre><p>A thread-safe version of <a href="../modules/#LLVM.Module"><code>LLVM.Module</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/ts_module.jl#L64-L68">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeModule-Tuple{String}" href="#LLVM.ThreadSafeModule-Tuple{String}"><code>LLVM.ThreadSafeModule</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ThreadSafeModule(name::String)</code></pre><p>Create a thread-safe module with the given name.</p><p>This object needs to be disposed of using <a href="#LLVM.dispose-Tuple{ThreadSafeModule}"><code>dispose(::ThreadSafeModule)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/ts_module.jl#L108-L114">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ThreadSafeModule-Tuple{Module}" href="#LLVM.ThreadSafeModule-Tuple{Module}"><code>LLVM.ThreadSafeModule</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">(mod::ThreadSafeModule)(f)</code></pre><p>Apply <code>f</code> to the LLVM module contained within <code>mod</code>, after locking the module and activating its context.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/ts_module.jl#L157-L162">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{ThreadSafeModule}" href="#LLVM.dispose-Tuple{ThreadSafeModule}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(mod::ThreadSafeModule)</code></pre><p>Dispose of the thread-safe module, releasing all resources associated with it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/ts_module.jl#L125-L129">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.LLJIT" href="#LLVM.LLJIT"><code>LLVM.LLJIT</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLJIT(::LLJITBuilder)</code></pre><p>Creates a LLJIT stack based on the provided builder.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Takes ownership of the provided builder.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/lljit.jl#L28-L35">source</a></section><section><div><pre><code class="language-julia hljs">LLJIT(;tm::Union{Nothing, TargetMachine})</code></pre><p>Use the provided TargetMachine and construct an LLJIT from it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/executionengine/lljit.jl#L46-L50">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.JITDylib" href="#LLVM.JITDylib"><code>LLVM.JITDylib</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JITDylib(lljit::LLJIT)</code></pre><p>Get the main JITDylib</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/orc.jl#L134-L138">source</a></section><section><div><pre><code class="language-julia hljs">JITDylib(es::ExecutionSession, name; bare=false)</code></pre><p>Adds a new JITDylib to the ExecutionSession. The name must be unique and the <code>bare=true</code> no standard platform symbols are made available.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/orc.jl#L145-L150">source</a></section><section><div><pre><code class="language-julia hljs">JITDylib(jljit::JuliaOJIT)</code></pre><p>Get the external JITDylib from the Julia JIT</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/orc.jl#L392-L396">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.lookup-Tuple{LLJIT, Any}" href="#LLVM.lookup-Tuple{LLJIT, Any}"><code>LLVM.lookup</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">lookup(lljit::LLJIT, name)</code></pre><p>Takes an unmangled symbol names and searches for it in the LLJIT.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/orc.jl#L223-L227">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.linkinglayercreator!" href="#LLVM.linkinglayercreator!"><code>LLVM.linkinglayercreator!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">linkinglayercreator!(builder::LLJITBuilder, creator::ObjectLinkingLayerCreator)</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The creator object needs to be rooted by the caller for the lifetime of the builder argument.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/orc.jl#L74-L80">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../codegen/">« Code generation</a><a class="docs-footer-nextpage" href="../interop/">Julia integration »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/functions/index.html b/dev/lib/functions/index.html index ea3bcc4b..1bdd3521 100644 --- a/dev/lib/functions/index.html +++ b/dev/lib/functions/index.html @@ -1,2 +1,2 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Functions · LLVM.jl</title><meta name="title" content="Functions · LLVM.jl"/><meta property="og:title" content="Functions · LLVM.jl"/><meta property="twitter:title" content="Functions · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li class="is-active"><a class="tocitem" href>Functions</a><ul class="internal"><li><a class="tocitem" href="#Properties-and-operations"><span>Properties and operations</span></a></li><li><a class="tocitem" href="#Attributes"><span>Attributes</span></a></li><li><a class="tocitem" href="#Parameters"><span>Parameters</span></a></li><li><a class="tocitem" href="#Basic-Blocks"><span>Basic Blocks</span></a></li><li><a class="tocitem" href="#Intrinsics"><span>Intrinsics</span></a></li></ul></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Functions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Functions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/functions.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Function" href="#LLVM.Function"><code>LLVM.Function</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Function</code></pre><p>A function in the IR.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L7-L11">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Function-Tuple{LLVM.Module, String, LLVM.FunctionType}" href="#LLVM.Function-Tuple{LLVM.Module, String, LLVM.FunctionType}"><code>LLVM.Function</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Function(mod::Module, name::String, ft::FunctionType)</code></pre><p>Create a new function in the given module with the given name and function type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L17-L21">source</a></section></article><h2 id="Properties-and-operations"><a class="docs-heading-anchor" href="#Properties-and-operations">Properties and operations</a><a id="Properties-and-operations-1"></a><a class="docs-heading-anchor-permalink" href="#Properties-and-operations" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.function_type" href="#LLVM.function_type"><code>LLVM.function_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">function_type(f::Function) -> LLVM.FunctionType</code></pre><p>Get the function type of the given function. This returns a function type, as opposed to <a href="../values/#LLVM.value_type"><code>value_type</code></a> which returns the pointer type of the function constant.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L25-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.empty!" href="#Base.empty!"><code>Base.empty!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">empty!(f::Function)</code></pre><p>Delete the body of the given function, and convert the linkage to external.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L33-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.erase!-Tuple{LLVM.Function}" href="#LLVM.erase!-Tuple{LLVM.Function}"><code>LLVM.erase!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">erase!(f::Function)</code></pre><p>Remove the given function from its parent module and free the object.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is unsafe because it does not check if the function is used elsewhere.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L40-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.personality" href="#LLVM.personality"><code>LLVM.personality</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">personality(f::Function)</code></pre><p>Get the personality function of the given function, or <code>nothing</code> if it has none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L51-L55">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.personality!" href="#LLVM.personality!"><code>LLVM.personality!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">personality!(f::Function, persfn::Function)</code></pre><p>Set the personality function of the given function. Pass <code>nothing</code> to remove the personality function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L61-L66">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.callconv" href="#LLVM.callconv"><code>LLVM.callconv</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">callconv(f::Function)</code></pre><p>Get the calling convention of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L72-L76">source</a></section><section><div><pre><code class="language-julia hljs">callconv(call_inst::Instruction)</code></pre><p>Get the calling convention of the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L222-L226">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.callconv!" href="#LLVM.callconv!"><code>LLVM.callconv!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">callconv!(f::Function, cc)</code></pre><p>Set the calling convention of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L79-L83">source</a></section><section><div><pre><code class="language-julia hljs">callconv!(call_inst::Instruction, cc)</code></pre><p>Set the calling convention of the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L229-L233">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.gc" href="#LLVM.gc"><code>LLVM.gc</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">gc(f::Function)</code></pre><p>Get the garbage collector name of the given function, or an empty string if it has none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L86-L90">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.gc!" href="#LLVM.gc!"><code>LLVM.gc!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">gc!(f::Function, name::String)</code></pre><p>Set the garbage collector name of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L96-L100">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.entry" href="#LLVM.entry"><code>LLVM.entry</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">entry(f::Function) -> BasicBlock</code></pre><p>Get the entry basic block of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L103-L107">source</a></section></article><h2 id="Attributes"><a class="docs-heading-anchor" href="#Attributes">Attributes</a><a id="Attributes-1"></a><a class="docs-heading-anchor-permalink" href="#Attributes" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.function_attributes" href="#LLVM.function_attributes"><code>LLVM.function_attributes</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">function_attributes(f::Function)</code></pre><p>Get the attributes of the given function.</p><p>This is a mutable iterator, supporting <code>push!</code>, <code>append!</code> and <code>delete!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L120-L126">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parameter_attributes" href="#LLVM.parameter_attributes"><code>LLVM.parameter_attributes</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parameter_attributes(f::Function, idx::Integer)</code></pre><p>Get the attributes of the given parameter of the given function.</p><p>This is a mutable iterator, supporting <code>push!</code>, <code>append!</code> and <code>delete!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L130-L136">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.return_attributes" href="#LLVM.return_attributes"><code>LLVM.return_attributes</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">return_attributes(f::Function)</code></pre><p>Get the attributes of the return value of the given function.</p><p>This is a mutable iterator, supporting <code>push!</code>, <code>append!</code> and <code>delete!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L140-L146">source</a></section></article><h2 id="Parameters"><a class="docs-heading-anchor" href="#Parameters">Parameters</a><a id="Parameters-1"></a><a class="docs-heading-anchor-permalink" href="#Parameters" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parameters" href="#LLVM.parameters"><code>LLVM.parameters</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parameters(ft::LLVM.FunctionType)</code></pre><p>Get the parameter types of the given function type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L239-L243">source</a></section><section><div><pre><code class="language-julia hljs">parameters(f::Function)</code></pre><p>Get an iterator over the parameters of the given function. These are values that can be used as inputs to other instructions.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L192-L197">source</a></section></article><h2 id="Basic-Blocks"><a class="docs-heading-anchor" href="#Basic-Blocks">Basic Blocks</a><a id="Basic-Blocks-1"></a><a class="docs-heading-anchor-permalink" href="#Basic-Blocks" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.blocks" href="#LLVM.blocks"><code>LLVM.blocks</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">blocks(f::Function)</code></pre><p>Get an iterator over the basic blocks of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L244-L248">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.prevblock" href="#LLVM.prevblock"><code>LLVM.prevblock</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">prevblock(bb::BasicBlock)</code></pre><p>Get the previous basic block of the given basic block, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L269-L273">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.nextblock" href="#LLVM.nextblock"><code>LLVM.nextblock</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">nextblock(bb::BasicBlock)</code></pre><p>Get the next basic block of the given basic block, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L280-L284">source</a></section></article><h2 id="Intrinsics"><a class="docs-heading-anchor" href="#Intrinsics">Intrinsics</a><a id="Intrinsics-1"></a><a class="docs-heading-anchor-permalink" href="#Intrinsics" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isintrinsic" href="#LLVM.isintrinsic"><code>LLVM.isintrinsic</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isintrinsic(f::Function)</code></pre><p>Check if the given function is an intrinsic.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L319-L323">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isoverloaded" href="#LLVM.isoverloaded"><code>LLVM.isoverloaded</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isoverloaded(intr::Intrinsic)</code></pre><p>Check if the given intrinsic is overloaded.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L364-L368">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{Intrinsic}" href="#LLVM.name-Tuple{Intrinsic}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(intr::LLVM.Intrinsic)</code></pre><p>Get the name of the given intrinsic.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L342-L346">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{Intrinsic, Vector{<:LLVMType}}" href="#LLVM.name-Tuple{Intrinsic, Vector{<:LLVMType}}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(intr::LLVM.Intrinsic, params::Vector{<:LLVMType})</code></pre><p>Get the name of the given overloaded intrinsic with the given parameter types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L353-L357">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Function-Tuple{LLVM.Module, Intrinsic, Vector{<:LLVMType}}" href="#LLVM.Function-Tuple{LLVM.Module, Intrinsic, Vector{<:LLVMType}}"><code>LLVM.Function</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Function(mod::Module, intr::Intrinsic, params::Vector{<:LLVMType}=LLVMType[])</code></pre><p>Get the declaration of the given intrinsic in the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L373-L377">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.FunctionType-Tuple{Intrinsic, Vector{<:LLVMType}}" href="#LLVM.FunctionType-Tuple{Intrinsic, Vector{<:LLVMType}}"><code>LLVM.FunctionType</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">FunctionType(intr::Intrinsic, params::Vector{<:LLVMType}=LLVMType[])</code></pre><p>Get the function type of the given intrinsic with the given parameter types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/function.jl#L382-L386">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../modules/">« Modules</a><a class="docs-footer-nextpage" href="../blocks/">Basic blocks »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Functions · LLVM.jl</title><meta name="title" content="Functions · LLVM.jl"/><meta property="og:title" content="Functions · LLVM.jl"/><meta property="twitter:title" content="Functions · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li class="is-active"><a class="tocitem" href>Functions</a><ul class="internal"><li><a class="tocitem" href="#Properties-and-operations"><span>Properties and operations</span></a></li><li><a class="tocitem" href="#Attributes"><span>Attributes</span></a></li><li><a class="tocitem" href="#Parameters"><span>Parameters</span></a></li><li><a class="tocitem" href="#Basic-Blocks"><span>Basic Blocks</span></a></li><li><a class="tocitem" href="#Intrinsics"><span>Intrinsics</span></a></li></ul></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Functions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Functions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/functions.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Function" href="#LLVM.Function"><code>LLVM.Function</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Function</code></pre><p>A function in the IR.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L7-L11">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Function-Tuple{LLVM.Module, String, LLVM.FunctionType}" href="#LLVM.Function-Tuple{LLVM.Module, String, LLVM.FunctionType}"><code>LLVM.Function</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Function(mod::Module, name::String, ft::FunctionType)</code></pre><p>Create a new function in the given module with the given name and function type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L17-L21">source</a></section></article><h2 id="Properties-and-operations"><a class="docs-heading-anchor" href="#Properties-and-operations">Properties and operations</a><a id="Properties-and-operations-1"></a><a class="docs-heading-anchor-permalink" href="#Properties-and-operations" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.function_type" href="#LLVM.function_type"><code>LLVM.function_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">function_type(f::Function) -> LLVM.FunctionType</code></pre><p>Get the function type of the given function. This returns a function type, as opposed to <a href="../values/#LLVM.value_type"><code>value_type</code></a> which returns the pointer type of the function constant.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L25-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.empty!" href="#Base.empty!"><code>Base.empty!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">empty!(f::Function)</code></pre><p>Delete the body of the given function, and convert the linkage to external.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L33-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.erase!-Tuple{LLVM.Function}" href="#LLVM.erase!-Tuple{LLVM.Function}"><code>LLVM.erase!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">erase!(f::Function)</code></pre><p>Remove the given function from its parent module and free the object.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is unsafe because it does not check if the function is used elsewhere.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L40-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.personality" href="#LLVM.personality"><code>LLVM.personality</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">personality(f::Function)</code></pre><p>Get the personality function of the given function, or <code>nothing</code> if it has none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L51-L55">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.personality!" href="#LLVM.personality!"><code>LLVM.personality!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">personality!(f::Function, persfn::Function)</code></pre><p>Set the personality function of the given function. Pass <code>nothing</code> to remove the personality function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L61-L66">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.callconv" href="#LLVM.callconv"><code>LLVM.callconv</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">callconv(f::Function)</code></pre><p>Get the calling convention of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L72-L76">source</a></section><section><div><pre><code class="language-julia hljs">callconv(call_inst::Instruction)</code></pre><p>Get the calling convention of the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L222-L226">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.callconv!" href="#LLVM.callconv!"><code>LLVM.callconv!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">callconv!(f::Function, cc)</code></pre><p>Set the calling convention of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L79-L83">source</a></section><section><div><pre><code class="language-julia hljs">callconv!(call_inst::Instruction, cc)</code></pre><p>Set the calling convention of the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L229-L233">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.gc" href="#LLVM.gc"><code>LLVM.gc</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">gc(f::Function)</code></pre><p>Get the garbage collector name of the given function, or an empty string if it has none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L86-L90">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.gc!" href="#LLVM.gc!"><code>LLVM.gc!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">gc!(f::Function, name::String)</code></pre><p>Set the garbage collector name of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L96-L100">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.entry" href="#LLVM.entry"><code>LLVM.entry</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">entry(f::Function) -> BasicBlock</code></pre><p>Get the entry basic block of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L103-L107">source</a></section></article><h2 id="Attributes"><a class="docs-heading-anchor" href="#Attributes">Attributes</a><a id="Attributes-1"></a><a class="docs-heading-anchor-permalink" href="#Attributes" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.function_attributes" href="#LLVM.function_attributes"><code>LLVM.function_attributes</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">function_attributes(f::Function)</code></pre><p>Get the attributes of the given function.</p><p>This is a mutable iterator, supporting <code>push!</code>, <code>append!</code> and <code>delete!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L120-L126">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parameter_attributes" href="#LLVM.parameter_attributes"><code>LLVM.parameter_attributes</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parameter_attributes(f::Function, idx::Integer)</code></pre><p>Get the attributes of the given parameter of the given function.</p><p>This is a mutable iterator, supporting <code>push!</code>, <code>append!</code> and <code>delete!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L130-L136">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.return_attributes" href="#LLVM.return_attributes"><code>LLVM.return_attributes</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">return_attributes(f::Function)</code></pre><p>Get the attributes of the return value of the given function.</p><p>This is a mutable iterator, supporting <code>push!</code>, <code>append!</code> and <code>delete!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L140-L146">source</a></section></article><h2 id="Parameters"><a class="docs-heading-anchor" href="#Parameters">Parameters</a><a id="Parameters-1"></a><a class="docs-heading-anchor-permalink" href="#Parameters" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parameters" href="#LLVM.parameters"><code>LLVM.parameters</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parameters(ft::LLVM.FunctionType)</code></pre><p>Get the parameter types of the given function type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L239-L243">source</a></section><section><div><pre><code class="language-julia hljs">parameters(f::Function)</code></pre><p>Get an iterator over the parameters of the given function. These are values that can be used as inputs to other instructions.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L192-L197">source</a></section></article><h2 id="Basic-Blocks"><a class="docs-heading-anchor" href="#Basic-Blocks">Basic Blocks</a><a id="Basic-Blocks-1"></a><a class="docs-heading-anchor-permalink" href="#Basic-Blocks" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.blocks" href="#LLVM.blocks"><code>LLVM.blocks</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">blocks(f::Function)</code></pre><p>Get an iterator over the basic blocks of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L244-L248">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.prevblock" href="#LLVM.prevblock"><code>LLVM.prevblock</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">prevblock(bb::BasicBlock)</code></pre><p>Get the previous basic block of the given basic block, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L269-L273">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.nextblock" href="#LLVM.nextblock"><code>LLVM.nextblock</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">nextblock(bb::BasicBlock)</code></pre><p>Get the next basic block of the given basic block, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L280-L284">source</a></section></article><h2 id="Intrinsics"><a class="docs-heading-anchor" href="#Intrinsics">Intrinsics</a><a id="Intrinsics-1"></a><a class="docs-heading-anchor-permalink" href="#Intrinsics" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isintrinsic" href="#LLVM.isintrinsic"><code>LLVM.isintrinsic</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isintrinsic(f::Function)</code></pre><p>Check if the given function is an intrinsic.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L319-L323">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isoverloaded" href="#LLVM.isoverloaded"><code>LLVM.isoverloaded</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isoverloaded(intr::Intrinsic)</code></pre><p>Check if the given intrinsic is overloaded.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L364-L368">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{Intrinsic}" href="#LLVM.name-Tuple{Intrinsic}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(intr::LLVM.Intrinsic)</code></pre><p>Get the name of the given intrinsic.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L342-L346">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{Intrinsic, Vector{<:LLVMType}}" href="#LLVM.name-Tuple{Intrinsic, Vector{<:LLVMType}}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(intr::LLVM.Intrinsic, params::Vector{<:LLVMType})</code></pre><p>Get the name of the given overloaded intrinsic with the given parameter types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L353-L357">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Function-Tuple{LLVM.Module, Intrinsic, Vector{<:LLVMType}}" href="#LLVM.Function-Tuple{LLVM.Module, Intrinsic, Vector{<:LLVMType}}"><code>LLVM.Function</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Function(mod::Module, intr::Intrinsic, params::Vector{<:LLVMType}=LLVMType[])</code></pre><p>Get the declaration of the given intrinsic in the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L373-L377">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.FunctionType-Tuple{Intrinsic, Vector{<:LLVMType}}" href="#LLVM.FunctionType-Tuple{Intrinsic, Vector{<:LLVMType}}"><code>LLVM.FunctionType</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">FunctionType(intr::Intrinsic, params::Vector{<:LLVMType}=LLVMType[])</code></pre><p>Get the function type of the given intrinsic with the given parameter types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/function.jl#L382-L386">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../modules/">« Modules</a><a class="docs-footer-nextpage" href="../blocks/">Basic blocks »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/hidden/index.html b/dev/lib/hidden/index.html index a8b25f4f..ad7476e7 100644 --- a/dev/lib/hidden/index.html +++ b/dev/lib/hidden/index.html @@ -1,242 +1,242 @@ <!DOCTYPE html> <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Hidden · LLVM.jl</title><meta name="title" content="Hidden · LLVM.jl"/><meta property="og:title" content="Hidden · LLVM.jl"/><meta property="twitter:title" content="Hidden · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Hidden</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Hidden</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/hidden.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Hidden"><a class="docs-heading-anchor" href="#Hidden">Hidden</a><a id="Hidden-1"></a><a class="docs-heading-anchor-permalink" href="#Hidden" title="Permalink"></a></h1><p>Hidden docstrings that we don't want to show up, but we want to avoid failing checkdocs for:</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64AsmParser" href="#LLVM.InitializeAArch64AsmParser"><code>LLVM.InitializeAArch64AsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64AsmPrinter" href="#LLVM.InitializeAArch64AsmPrinter"><code>LLVM.InitializeAArch64AsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64AsmPrinter" href="#LLVM.InitializeAArch64AsmPrinter"><code>LLVM.InitializeAArch64AsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64Disassembler" href="#LLVM.InitializeAArch64Disassembler"><code>LLVM.InitializeAArch64Disassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64Disassembler" href="#LLVM.InitializeAArch64Disassembler"><code>LLVM.InitializeAArch64Disassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64Target" href="#LLVM.InitializeAArch64Target"><code>LLVM.InitializeAArch64Target</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64Target" href="#LLVM.InitializeAArch64Target"><code>LLVM.InitializeAArch64Target</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64TargetInfo" href="#LLVM.InitializeAArch64TargetInfo"><code>LLVM.InitializeAArch64TargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64TargetMC" href="#LLVM.InitializeAArch64TargetMC"><code>LLVM.InitializeAArch64TargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUAsmParser" href="#LLVM.InitializeAMDGPUAsmParser"><code>LLVM.InitializeAMDGPUAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64TargetInfo" href="#LLVM.InitializeAArch64TargetInfo"><code>LLVM.InitializeAArch64TargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAArch64TargetMC" href="#LLVM.InitializeAArch64TargetMC"><code>LLVM.InitializeAArch64TargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUAsmParser" href="#LLVM.InitializeAMDGPUAsmParser"><code>LLVM.InitializeAMDGPUAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUAsmPrinter" href="#LLVM.InitializeAMDGPUAsmPrinter"><code>LLVM.InitializeAMDGPUAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUAsmPrinter" href="#LLVM.InitializeAMDGPUAsmPrinter"><code>LLVM.InitializeAMDGPUAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUDisassembler" href="#LLVM.InitializeAMDGPUDisassembler"><code>LLVM.InitializeAMDGPUDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUDisassembler" href="#LLVM.InitializeAMDGPUDisassembler"><code>LLVM.InitializeAMDGPUDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUTarget" href="#LLVM.InitializeAMDGPUTarget"><code>LLVM.InitializeAMDGPUTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUTarget" href="#LLVM.InitializeAMDGPUTarget"><code>LLVM.InitializeAMDGPUTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUTargetInfo" href="#LLVM.InitializeAMDGPUTargetInfo"><code>LLVM.InitializeAMDGPUTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUTargetMC" href="#LLVM.InitializeAMDGPUTargetMC"><code>LLVM.InitializeAMDGPUTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCAsmParser" href="#LLVM.InitializeARCAsmParser"><code>LLVM.InitializeARCAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUTargetInfo" href="#LLVM.InitializeAMDGPUTargetInfo"><code>LLVM.InitializeAMDGPUTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAMDGPUTargetMC" href="#LLVM.InitializeAMDGPUTargetMC"><code>LLVM.InitializeAMDGPUTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCAsmParser" href="#LLVM.InitializeARCAsmParser"><code>LLVM.InitializeARCAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCAsmPrinter" href="#LLVM.InitializeARCAsmPrinter"><code>LLVM.InitializeARCAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCAsmPrinter" href="#LLVM.InitializeARCAsmPrinter"><code>LLVM.InitializeARCAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCDisassembler" href="#LLVM.InitializeARCDisassembler"><code>LLVM.InitializeARCDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCDisassembler" href="#LLVM.InitializeARCDisassembler"><code>LLVM.InitializeARCDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCTarget" href="#LLVM.InitializeARCTarget"><code>LLVM.InitializeARCTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCTarget" href="#LLVM.InitializeARCTarget"><code>LLVM.InitializeARCTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCTargetInfo" href="#LLVM.InitializeARCTargetInfo"><code>LLVM.InitializeARCTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCTargetMC" href="#LLVM.InitializeARCTargetMC"><code>LLVM.InitializeARCTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMAsmParser" href="#LLVM.InitializeARMAsmParser"><code>LLVM.InitializeARMAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCTargetInfo" href="#LLVM.InitializeARCTargetInfo"><code>LLVM.InitializeARCTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARCTargetMC" href="#LLVM.InitializeARCTargetMC"><code>LLVM.InitializeARCTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMAsmParser" href="#LLVM.InitializeARMAsmParser"><code>LLVM.InitializeARMAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMAsmPrinter" href="#LLVM.InitializeARMAsmPrinter"><code>LLVM.InitializeARMAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMAsmPrinter" href="#LLVM.InitializeARMAsmPrinter"><code>LLVM.InitializeARMAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMDisassembler" href="#LLVM.InitializeARMDisassembler"><code>LLVM.InitializeARMDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMDisassembler" href="#LLVM.InitializeARMDisassembler"><code>LLVM.InitializeARMDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMTarget" href="#LLVM.InitializeARMTarget"><code>LLVM.InitializeARMTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMTarget" href="#LLVM.InitializeARMTarget"><code>LLVM.InitializeARMTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMTargetInfo" href="#LLVM.InitializeARMTargetInfo"><code>LLVM.InitializeARMTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMTargetMC" href="#LLVM.InitializeARMTargetMC"><code>LLVM.InitializeARMTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRAsmParser" href="#LLVM.InitializeAVRAsmParser"><code>LLVM.InitializeAVRAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMTargetInfo" href="#LLVM.InitializeARMTargetInfo"><code>LLVM.InitializeARMTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeARMTargetMC" href="#LLVM.InitializeARMTargetMC"><code>LLVM.InitializeARMTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRAsmParser" href="#LLVM.InitializeAVRAsmParser"><code>LLVM.InitializeAVRAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRAsmPrinter" href="#LLVM.InitializeAVRAsmPrinter"><code>LLVM.InitializeAVRAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRAsmPrinter" href="#LLVM.InitializeAVRAsmPrinter"><code>LLVM.InitializeAVRAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRDisassembler" href="#LLVM.InitializeAVRDisassembler"><code>LLVM.InitializeAVRDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRDisassembler" href="#LLVM.InitializeAVRDisassembler"><code>LLVM.InitializeAVRDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRTarget" href="#LLVM.InitializeAVRTarget"><code>LLVM.InitializeAVRTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRTarget" href="#LLVM.InitializeAVRTarget"><code>LLVM.InitializeAVRTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRTargetInfo" href="#LLVM.InitializeAVRTargetInfo"><code>LLVM.InitializeAVRTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRTargetMC" href="#LLVM.InitializeAVRTargetMC"><code>LLVM.InitializeAVRTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFAsmParser" href="#LLVM.InitializeBPFAsmParser"><code>LLVM.InitializeBPFAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRTargetInfo" href="#LLVM.InitializeAVRTargetInfo"><code>LLVM.InitializeAVRTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeAVRTargetMC" href="#LLVM.InitializeAVRTargetMC"><code>LLVM.InitializeAVRTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFAsmParser" href="#LLVM.InitializeBPFAsmParser"><code>LLVM.InitializeBPFAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFAsmPrinter" href="#LLVM.InitializeBPFAsmPrinter"><code>LLVM.InitializeBPFAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFAsmPrinter" href="#LLVM.InitializeBPFAsmPrinter"><code>LLVM.InitializeBPFAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFDisassembler" href="#LLVM.InitializeBPFDisassembler"><code>LLVM.InitializeBPFDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFDisassembler" href="#LLVM.InitializeBPFDisassembler"><code>LLVM.InitializeBPFDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFTarget" href="#LLVM.InitializeBPFTarget"><code>LLVM.InitializeBPFTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFTarget" href="#LLVM.InitializeBPFTarget"><code>LLVM.InitializeBPFTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFTargetInfo" href="#LLVM.InitializeBPFTargetInfo"><code>LLVM.InitializeBPFTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFTargetMC" href="#LLVM.InitializeBPFTargetMC"><code>LLVM.InitializeBPFTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusAsmParser" href="#LLVM.InitializeColossusAsmParser"><code>LLVM.InitializeColossusAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFTargetInfo" href="#LLVM.InitializeBPFTargetInfo"><code>LLVM.InitializeBPFTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeBPFTargetMC" href="#LLVM.InitializeBPFTargetMC"><code>LLVM.InitializeBPFTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusAsmParser" href="#LLVM.InitializeColossusAsmParser"><code>LLVM.InitializeColossusAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusAsmPrinter" href="#LLVM.InitializeColossusAsmPrinter"><code>LLVM.InitializeColossusAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusAsmPrinter" href="#LLVM.InitializeColossusAsmPrinter"><code>LLVM.InitializeColossusAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusDisassembler" href="#LLVM.InitializeColossusDisassembler"><code>LLVM.InitializeColossusDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusDisassembler" href="#LLVM.InitializeColossusDisassembler"><code>LLVM.InitializeColossusDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusTarget" href="#LLVM.InitializeColossusTarget"><code>LLVM.InitializeColossusTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusTarget" href="#LLVM.InitializeColossusTarget"><code>LLVM.InitializeColossusTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusTargetInfo" href="#LLVM.InitializeColossusTargetInfo"><code>LLVM.InitializeColossusTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusTargetMC" href="#LLVM.InitializeColossusTargetMC"><code>LLVM.InitializeColossusTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonAsmParser" href="#LLVM.InitializeHexagonAsmParser"><code>LLVM.InitializeHexagonAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusTargetInfo" href="#LLVM.InitializeColossusTargetInfo"><code>LLVM.InitializeColossusTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeColossusTargetMC" href="#LLVM.InitializeColossusTargetMC"><code>LLVM.InitializeColossusTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonAsmParser" href="#LLVM.InitializeHexagonAsmParser"><code>LLVM.InitializeHexagonAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonAsmPrinter" href="#LLVM.InitializeHexagonAsmPrinter"><code>LLVM.InitializeHexagonAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonAsmPrinter" href="#LLVM.InitializeHexagonAsmPrinter"><code>LLVM.InitializeHexagonAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonDisassembler" href="#LLVM.InitializeHexagonDisassembler"><code>LLVM.InitializeHexagonDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonDisassembler" href="#LLVM.InitializeHexagonDisassembler"><code>LLVM.InitializeHexagonDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonTarget" href="#LLVM.InitializeHexagonTarget"><code>LLVM.InitializeHexagonTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonTarget" href="#LLVM.InitializeHexagonTarget"><code>LLVM.InitializeHexagonTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonTargetInfo" href="#LLVM.InitializeHexagonTargetInfo"><code>LLVM.InitializeHexagonTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonTargetMC" href="#LLVM.InitializeHexagonTargetMC"><code>LLVM.InitializeHexagonTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiAsmParser" href="#LLVM.InitializeLanaiAsmParser"><code>LLVM.InitializeLanaiAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonTargetInfo" href="#LLVM.InitializeHexagonTargetInfo"><code>LLVM.InitializeHexagonTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeHexagonTargetMC" href="#LLVM.InitializeHexagonTargetMC"><code>LLVM.InitializeHexagonTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiAsmParser" href="#LLVM.InitializeLanaiAsmParser"><code>LLVM.InitializeLanaiAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiAsmPrinter" href="#LLVM.InitializeLanaiAsmPrinter"><code>LLVM.InitializeLanaiAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiAsmPrinter" href="#LLVM.InitializeLanaiAsmPrinter"><code>LLVM.InitializeLanaiAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiDisassembler" href="#LLVM.InitializeLanaiDisassembler"><code>LLVM.InitializeLanaiDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiDisassembler" href="#LLVM.InitializeLanaiDisassembler"><code>LLVM.InitializeLanaiDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiTarget" href="#LLVM.InitializeLanaiTarget"><code>LLVM.InitializeLanaiTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiTarget" href="#LLVM.InitializeLanaiTarget"><code>LLVM.InitializeLanaiTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiTargetInfo" href="#LLVM.InitializeLanaiTargetInfo"><code>LLVM.InitializeLanaiTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiTargetMC" href="#LLVM.InitializeLanaiTargetMC"><code>LLVM.InitializeLanaiTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsAsmParser" href="#LLVM.InitializeMipsAsmParser"><code>LLVM.InitializeMipsAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiTargetInfo" href="#LLVM.InitializeLanaiTargetInfo"><code>LLVM.InitializeLanaiTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeLanaiTargetMC" href="#LLVM.InitializeLanaiTargetMC"><code>LLVM.InitializeLanaiTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsAsmParser" href="#LLVM.InitializeMipsAsmParser"><code>LLVM.InitializeMipsAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsAsmPrinter" href="#LLVM.InitializeMipsAsmPrinter"><code>LLVM.InitializeMipsAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsAsmPrinter" href="#LLVM.InitializeMipsAsmPrinter"><code>LLVM.InitializeMipsAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsDisassembler" href="#LLVM.InitializeMipsDisassembler"><code>LLVM.InitializeMipsDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsDisassembler" href="#LLVM.InitializeMipsDisassembler"><code>LLVM.InitializeMipsDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsTarget" href="#LLVM.InitializeMipsTarget"><code>LLVM.InitializeMipsTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsTarget" href="#LLVM.InitializeMipsTarget"><code>LLVM.InitializeMipsTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsTargetInfo" href="#LLVM.InitializeMipsTargetInfo"><code>LLVM.InitializeMipsTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsTargetMC" href="#LLVM.InitializeMipsTargetMC"><code>LLVM.InitializeMipsTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430AsmParser" href="#LLVM.InitializeMSP430AsmParser"><code>LLVM.InitializeMSP430AsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsTargetInfo" href="#LLVM.InitializeMipsTargetInfo"><code>LLVM.InitializeMipsTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMipsTargetMC" href="#LLVM.InitializeMipsTargetMC"><code>LLVM.InitializeMipsTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430AsmParser" href="#LLVM.InitializeMSP430AsmParser"><code>LLVM.InitializeMSP430AsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430AsmPrinter" href="#LLVM.InitializeMSP430AsmPrinter"><code>LLVM.InitializeMSP430AsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430AsmPrinter" href="#LLVM.InitializeMSP430AsmPrinter"><code>LLVM.InitializeMSP430AsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430Disassembler" href="#LLVM.InitializeMSP430Disassembler"><code>LLVM.InitializeMSP430Disassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430Disassembler" href="#LLVM.InitializeMSP430Disassembler"><code>LLVM.InitializeMSP430Disassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430Target" href="#LLVM.InitializeMSP430Target"><code>LLVM.InitializeMSP430Target</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430Target" href="#LLVM.InitializeMSP430Target"><code>LLVM.InitializeMSP430Target</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430TargetInfo" href="#LLVM.InitializeMSP430TargetInfo"><code>LLVM.InitializeMSP430TargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430TargetMC" href="#LLVM.InitializeMSP430TargetMC"><code>LLVM.InitializeMSP430TargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNativeAsmParser" href="#LLVM.InitializeNativeAsmParser"><code>LLVM.InitializeNativeAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430TargetInfo" href="#LLVM.InitializeMSP430TargetInfo"><code>LLVM.InitializeMSP430TargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeMSP430TargetMC" href="#LLVM.InitializeMSP430TargetMC"><code>LLVM.InitializeMSP430TargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNativeAsmParser" href="#LLVM.InitializeNativeAsmParser"><code>LLVM.InitializeNativeAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNativeAsmPrinter" href="#LLVM.InitializeNativeAsmPrinter"><code>LLVM.InitializeNativeAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNativeAsmPrinter" href="#LLVM.InitializeNativeAsmPrinter"><code>LLVM.InitializeNativeAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNativeDisassembler" href="#LLVM.InitializeNativeDisassembler"><code>LLVM.InitializeNativeDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNativeDisassembler" href="#LLVM.InitializeNativeDisassembler"><code>LLVM.InitializeNativeDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNativeTarget" href="#LLVM.InitializeNativeTarget"><code>LLVM.InitializeNativeTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNativeTarget" href="#LLVM.InitializeNativeTarget"><code>LLVM.InitializeNativeTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXAsmParser" href="#LLVM.InitializeNVPTXAsmParser"><code>LLVM.InitializeNVPTXAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXAsmParser" href="#LLVM.InitializeNVPTXAsmParser"><code>LLVM.InitializeNVPTXAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXAsmPrinter" href="#LLVM.InitializeNVPTXAsmPrinter"><code>LLVM.InitializeNVPTXAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXAsmPrinter" href="#LLVM.InitializeNVPTXAsmPrinter"><code>LLVM.InitializeNVPTXAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXDisassembler" href="#LLVM.InitializeNVPTXDisassembler"><code>LLVM.InitializeNVPTXDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXDisassembler" href="#LLVM.InitializeNVPTXDisassembler"><code>LLVM.InitializeNVPTXDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXTarget" href="#LLVM.InitializeNVPTXTarget"><code>LLVM.InitializeNVPTXTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXTarget" href="#LLVM.InitializeNVPTXTarget"><code>LLVM.InitializeNVPTXTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXTargetInfo" href="#LLVM.InitializeNVPTXTargetInfo"><code>LLVM.InitializeNVPTXTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXTargetMC" href="#LLVM.InitializeNVPTXTargetMC"><code>LLVM.InitializeNVPTXTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCAsmParser" href="#LLVM.InitializePowerPCAsmParser"><code>LLVM.InitializePowerPCAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXTargetInfo" href="#LLVM.InitializeNVPTXTargetInfo"><code>LLVM.InitializeNVPTXTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeNVPTXTargetMC" href="#LLVM.InitializeNVPTXTargetMC"><code>LLVM.InitializeNVPTXTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCAsmParser" href="#LLVM.InitializePowerPCAsmParser"><code>LLVM.InitializePowerPCAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCAsmPrinter" href="#LLVM.InitializePowerPCAsmPrinter"><code>LLVM.InitializePowerPCAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCAsmPrinter" href="#LLVM.InitializePowerPCAsmPrinter"><code>LLVM.InitializePowerPCAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCDisassembler" href="#LLVM.InitializePowerPCDisassembler"><code>LLVM.InitializePowerPCDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCDisassembler" href="#LLVM.InitializePowerPCDisassembler"><code>LLVM.InitializePowerPCDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCTarget" href="#LLVM.InitializePowerPCTarget"><code>LLVM.InitializePowerPCTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCTarget" href="#LLVM.InitializePowerPCTarget"><code>LLVM.InitializePowerPCTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCTargetInfo" href="#LLVM.InitializePowerPCTargetInfo"><code>LLVM.InitializePowerPCTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCTargetMC" href="#LLVM.InitializePowerPCTargetMC"><code>LLVM.InitializePowerPCTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVAsmParser" href="#LLVM.InitializeRISCVAsmParser"><code>LLVM.InitializeRISCVAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCTargetInfo" href="#LLVM.InitializePowerPCTargetInfo"><code>LLVM.InitializePowerPCTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializePowerPCTargetMC" href="#LLVM.InitializePowerPCTargetMC"><code>LLVM.InitializePowerPCTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVAsmParser" href="#LLVM.InitializeRISCVAsmParser"><code>LLVM.InitializeRISCVAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVAsmPrinter" href="#LLVM.InitializeRISCVAsmPrinter"><code>LLVM.InitializeRISCVAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVAsmPrinter" href="#LLVM.InitializeRISCVAsmPrinter"><code>LLVM.InitializeRISCVAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVDisassembler" href="#LLVM.InitializeRISCVDisassembler"><code>LLVM.InitializeRISCVDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVDisassembler" href="#LLVM.InitializeRISCVDisassembler"><code>LLVM.InitializeRISCVDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVTarget" href="#LLVM.InitializeRISCVTarget"><code>LLVM.InitializeRISCVTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVTarget" href="#LLVM.InitializeRISCVTarget"><code>LLVM.InitializeRISCVTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVTargetInfo" href="#LLVM.InitializeRISCVTargetInfo"><code>LLVM.InitializeRISCVTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVTargetMC" href="#LLVM.InitializeRISCVTargetMC"><code>LLVM.InitializeRISCVTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcAsmParser" href="#LLVM.InitializeSparcAsmParser"><code>LLVM.InitializeSparcAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVTargetInfo" href="#LLVM.InitializeRISCVTargetInfo"><code>LLVM.InitializeRISCVTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeRISCVTargetMC" href="#LLVM.InitializeRISCVTargetMC"><code>LLVM.InitializeRISCVTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcAsmParser" href="#LLVM.InitializeSparcAsmParser"><code>LLVM.InitializeSparcAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcAsmPrinter" href="#LLVM.InitializeSparcAsmPrinter"><code>LLVM.InitializeSparcAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcAsmPrinter" href="#LLVM.InitializeSparcAsmPrinter"><code>LLVM.InitializeSparcAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcDisassembler" href="#LLVM.InitializeSparcDisassembler"><code>LLVM.InitializeSparcDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcDisassembler" href="#LLVM.InitializeSparcDisassembler"><code>LLVM.InitializeSparcDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcTarget" href="#LLVM.InitializeSparcTarget"><code>LLVM.InitializeSparcTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcTarget" href="#LLVM.InitializeSparcTarget"><code>LLVM.InitializeSparcTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcTargetInfo" href="#LLVM.InitializeSparcTargetInfo"><code>LLVM.InitializeSparcTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcTargetMC" href="#LLVM.InitializeSparcTargetMC"><code>LLVM.InitializeSparcTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZAsmParser" href="#LLVM.InitializeSystemZAsmParser"><code>LLVM.InitializeSystemZAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcTargetInfo" href="#LLVM.InitializeSparcTargetInfo"><code>LLVM.InitializeSparcTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSparcTargetMC" href="#LLVM.InitializeSparcTargetMC"><code>LLVM.InitializeSparcTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZAsmParser" href="#LLVM.InitializeSystemZAsmParser"><code>LLVM.InitializeSystemZAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZAsmPrinter" href="#LLVM.InitializeSystemZAsmPrinter"><code>LLVM.InitializeSystemZAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZAsmPrinter" href="#LLVM.InitializeSystemZAsmPrinter"><code>LLVM.InitializeSystemZAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZDisassembler" href="#LLVM.InitializeSystemZDisassembler"><code>LLVM.InitializeSystemZDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZDisassembler" href="#LLVM.InitializeSystemZDisassembler"><code>LLVM.InitializeSystemZDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZTarget" href="#LLVM.InitializeSystemZTarget"><code>LLVM.InitializeSystemZTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZTarget" href="#LLVM.InitializeSystemZTarget"><code>LLVM.InitializeSystemZTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZTargetInfo" href="#LLVM.InitializeSystemZTargetInfo"><code>LLVM.InitializeSystemZTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZTargetMC" href="#LLVM.InitializeSystemZTargetMC"><code>LLVM.InitializeSystemZTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVEAsmParser" href="#LLVM.InitializeVEAsmParser"><code>LLVM.InitializeVEAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZTargetInfo" href="#LLVM.InitializeSystemZTargetInfo"><code>LLVM.InitializeSystemZTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeSystemZTargetMC" href="#LLVM.InitializeSystemZTargetMC"><code>LLVM.InitializeSystemZTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVEAsmParser" href="#LLVM.InitializeVEAsmParser"><code>LLVM.InitializeVEAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVEAsmPrinter" href="#LLVM.InitializeVEAsmPrinter"><code>LLVM.InitializeVEAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVEAsmPrinter" href="#LLVM.InitializeVEAsmPrinter"><code>LLVM.InitializeVEAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVEDisassembler" href="#LLVM.InitializeVEDisassembler"><code>LLVM.InitializeVEDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVEDisassembler" href="#LLVM.InitializeVEDisassembler"><code>LLVM.InitializeVEDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVETarget" href="#LLVM.InitializeVETarget"><code>LLVM.InitializeVETarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVETarget" href="#LLVM.InitializeVETarget"><code>LLVM.InitializeVETarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVETargetInfo" href="#LLVM.InitializeVETargetInfo"><code>LLVM.InitializeVETargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVETargetMC" href="#LLVM.InitializeVETargetMC"><code>LLVM.InitializeVETargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyAsmParser" href="#LLVM.InitializeWebAssemblyAsmParser"><code>LLVM.InitializeWebAssemblyAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVETargetInfo" href="#LLVM.InitializeVETargetInfo"><code>LLVM.InitializeVETargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeVETargetMC" href="#LLVM.InitializeVETargetMC"><code>LLVM.InitializeVETargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyAsmParser" href="#LLVM.InitializeWebAssemblyAsmParser"><code>LLVM.InitializeWebAssemblyAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyAsmPrinter" href="#LLVM.InitializeWebAssemblyAsmPrinter"><code>LLVM.InitializeWebAssemblyAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyAsmPrinter" href="#LLVM.InitializeWebAssemblyAsmPrinter"><code>LLVM.InitializeWebAssemblyAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyDisassembler" href="#LLVM.InitializeWebAssemblyDisassembler"><code>LLVM.InitializeWebAssemblyDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyDisassembler" href="#LLVM.InitializeWebAssemblyDisassembler"><code>LLVM.InitializeWebAssemblyDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyTarget" href="#LLVM.InitializeWebAssemblyTarget"><code>LLVM.InitializeWebAssemblyTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyTarget" href="#LLVM.InitializeWebAssemblyTarget"><code>LLVM.InitializeWebAssemblyTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyTargetInfo" href="#LLVM.InitializeWebAssemblyTargetInfo"><code>LLVM.InitializeWebAssemblyTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyTargetMC" href="#LLVM.InitializeWebAssemblyTargetMC"><code>LLVM.InitializeWebAssemblyTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86AsmParser" href="#LLVM.InitializeX86AsmParser"><code>LLVM.InitializeX86AsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyTargetInfo" href="#LLVM.InitializeWebAssemblyTargetInfo"><code>LLVM.InitializeWebAssemblyTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeWebAssemblyTargetMC" href="#LLVM.InitializeWebAssemblyTargetMC"><code>LLVM.InitializeWebAssemblyTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86AsmParser" href="#LLVM.InitializeX86AsmParser"><code>LLVM.InitializeX86AsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86AsmPrinter" href="#LLVM.InitializeX86AsmPrinter"><code>LLVM.InitializeX86AsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86AsmPrinter" href="#LLVM.InitializeX86AsmPrinter"><code>LLVM.InitializeX86AsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86Disassembler" href="#LLVM.InitializeX86Disassembler"><code>LLVM.InitializeX86Disassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86Disassembler" href="#LLVM.InitializeX86Disassembler"><code>LLVM.InitializeX86Disassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86Target" href="#LLVM.InitializeX86Target"><code>LLVM.InitializeX86Target</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86Target" href="#LLVM.InitializeX86Target"><code>LLVM.InitializeX86Target</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86TargetInfo" href="#LLVM.InitializeX86TargetInfo"><code>LLVM.InitializeX86TargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86TargetMC" href="#LLVM.InitializeX86TargetMC"><code>LLVM.InitializeX86TargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreAsmParser" href="#LLVM.InitializeXCoreAsmParser"><code>LLVM.InitializeXCoreAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86TargetInfo" href="#LLVM.InitializeX86TargetInfo"><code>LLVM.InitializeX86TargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeX86TargetMC" href="#LLVM.InitializeX86TargetMC"><code>LLVM.InitializeX86TargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreAsmParser" href="#LLVM.InitializeXCoreAsmParser"><code>LLVM.InitializeXCoreAsmParser</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmParsers() LLVM.InitializeXXXAsmParser() -LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreAsmPrinter" href="#LLVM.InitializeXCoreAsmPrinter"><code>LLVM.InitializeXCoreAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() +LLVM.InitializeNativeAsmParser()</code></pre><p>Enables use of assembly parsing functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L47-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreAsmPrinter" href="#LLVM.InitializeXCoreAsmPrinter"><code>LLVM.InitializeXCoreAsmPrinter</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllAsmPrinters() LLVM.InitializeXXXAsmPrinter() -LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreDisassembler" href="#LLVM.InitializeXCoreDisassembler"><code>LLVM.InitializeXCoreDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() +LLVM.InitializeNativeAsmPrinter()</code></pre><p>Enables use of assembly output functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L39-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreDisassembler" href="#LLVM.InitializeXCoreDisassembler"><code>LLVM.InitializeXCoreDisassembler</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllDisassemblers() LLVM.InitializeXXXDisassembler() -LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreTarget" href="#LLVM.InitializeXCoreTarget"><code>LLVM.InitializeXCoreTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() +LLVM.InitializeNativeDisassembler()</code></pre><p>Enables use of disassembly functionality for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreTarget" href="#LLVM.InitializeXCoreTarget"><code>LLVM.InitializeXCoreTarget</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargets() LLVM.InitializeXXXTarget() -LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreTargetInfo" href="#LLVM.InitializeXCoreTargetInfo"><code>LLVM.InitializeXCoreTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() -LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreTargetMC" href="#LLVM.InitializeXCoreTargetMC"><code>LLVM.InitializeXCoreTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() -LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int1Type" href="#LLVM.Int1Type"><code>LLVM.Int1Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int8Type" href="#LLVM.Int8Type"><code>LLVM.Int8Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int16Type" href="#LLVM.Int16Type"><code>LLVM.Int16Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int32Type" href="#LLVM.Int32Type"><code>LLVM.Int32Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int64Type" href="#LLVM.Int64Type"><code>LLVM.Int64Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int128Type" href="#LLVM.Int128Type"><code>LLVM.Int128Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMModulePassManager" href="#LLVM.NewPMModulePassManager"><code>LLVM.NewPMModulePassManager</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() +LLVM.InitializeNativeTarget()</code></pre><p>Enables use of specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L24-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreTargetInfo" href="#LLVM.InitializeXCoreTargetInfo"><code>LLVM.InitializeXCoreTargetInfo</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetInfos() +LLVM.InitializeXXXTargetInfo()</code></pre><p>Enables access to specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InitializeXCoreTargetMC" href="#LLVM.InitializeXCoreTargetMC"><code>LLVM.InitializeXCoreTargetMC</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.InitializeAllTargetMCs() +LLVM.InitializeXXXTargetMC()</code></pre><p>Enable use of machine code generation for specific targets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/init.jl#L32-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int1Type" href="#LLVM.Int1Type"><code>LLVM.Int1Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int8Type" href="#LLVM.Int8Type"><code>LLVM.Int8Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int16Type" href="#LLVM.Int16Type"><code>LLVM.Int16Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int32Type" href="#LLVM.Int32Type"><code>LLVM.Int32Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int64Type" href="#LLVM.Int64Type"><code>LLVM.Int64Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Int128Type" href="#LLVM.Int128Type"><code>LLVM.Int128Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMModulePassManager" href="#LLVM.NewPMModulePassManager"><code>LLVM.NewPMModulePassManager</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() NewPMCGSCCPassManager() NewPMFunctionPassManager() NewPMLoopPassManager(; use_memory_ssa=false) NewPMAAManager()</code></pre><p>Create a new pass manager of the specified type. These objects can be used to construct pass pipelines, by <code>add!</code>ing passes to them, and finally <code>add!</code>ing them to a parent pass manager or pass builder.</p><p>Creating a pass manager and adding it to a parent manager or builder can be shortened using a single <code>add!</code>:</p><pre><code class="language-julia hljs">add!(parent, NewPMModulePassManager()) do mpm add!(mpm, SomeModulePass()) -end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMCGSCCPassManager" href="#LLVM.NewPMCGSCCPassManager"><code>LLVM.NewPMCGSCCPassManager</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() +end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMCGSCCPassManager" href="#LLVM.NewPMCGSCCPassManager"><code>LLVM.NewPMCGSCCPassManager</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() NewPMCGSCCPassManager() NewPMFunctionPassManager() NewPMLoopPassManager(; use_memory_ssa=false) NewPMAAManager()</code></pre><p>Create a new pass manager of the specified type. These objects can be used to construct pass pipelines, by <code>add!</code>ing passes to them, and finally <code>add!</code>ing them to a parent pass manager or pass builder.</p><p>Creating a pass manager and adding it to a parent manager or builder can be shortened using a single <code>add!</code>:</p><pre><code class="language-julia hljs">add!(parent, NewPMModulePassManager()) do mpm add!(mpm, SomeModulePass()) -end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMFunctionPassManager" href="#LLVM.NewPMFunctionPassManager"><code>LLVM.NewPMFunctionPassManager</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() +end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMFunctionPassManager" href="#LLVM.NewPMFunctionPassManager"><code>LLVM.NewPMFunctionPassManager</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() NewPMCGSCCPassManager() NewPMFunctionPassManager() NewPMLoopPassManager(; use_memory_ssa=false) NewPMAAManager()</code></pre><p>Create a new pass manager of the specified type. These objects can be used to construct pass pipelines, by <code>add!</code>ing passes to them, and finally <code>add!</code>ing them to a parent pass manager or pass builder.</p><p>Creating a pass manager and adding it to a parent manager or builder can be shortened using a single <code>add!</code>:</p><pre><code class="language-julia hljs">add!(parent, NewPMModulePassManager()) do mpm add!(mpm, SomeModulePass()) -end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMLoopPassManager" href="#LLVM.NewPMLoopPassManager"><code>LLVM.NewPMLoopPassManager</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() +end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMLoopPassManager" href="#LLVM.NewPMLoopPassManager"><code>LLVM.NewPMLoopPassManager</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() NewPMCGSCCPassManager() NewPMFunctionPassManager() NewPMLoopPassManager(; use_memory_ssa=false) NewPMAAManager()</code></pre><p>Create a new pass manager of the specified type. These objects can be used to construct pass pipelines, by <code>add!</code>ing passes to them, and finally <code>add!</code>ing them to a parent pass manager or pass builder.</p><p>Creating a pass manager and adding it to a parent manager or builder can be shortened using a single <code>add!</code>:</p><pre><code class="language-julia hljs">add!(parent, NewPMModulePassManager()) do mpm add!(mpm, SomeModulePass()) -end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMAAManager" href="#LLVM.NewPMAAManager"><code>LLVM.NewPMAAManager</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() +end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMAAManager" href="#LLVM.NewPMAAManager"><code>LLVM.NewPMAAManager</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() NewPMCGSCCPassManager() NewPMFunctionPassManager() NewPMLoopPassManager(; use_memory_ssa=false) NewPMAAManager()</code></pre><p>Create a new pass manager of the specified type. These objects can be used to construct pass pipelines, by <code>add!</code>ing passes to them, and finally <code>add!</code>ing them to a parent pass manager or pass builder.</p><p>Creating a pass manager and adding it to a parent manager or builder can be shortened using a single <code>add!</code>:</p><pre><code class="language-julia hljs">add!(parent, NewPMModulePassManager()) do mpm add!(mpm, SomeModulePass()) -end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMModulePass" href="#LLVM.NewPMModulePass"><code>LLVM.NewPMModulePass</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePass(name, callback) -NewPMFunctionPass(name, callback)</code></pre><p>Create a new custom pass. The <code>name</code> is a string that will be used to identify the pass in the pass manager. The <code>callback</code> is a function that will be called when the pass is run. The function should take a single argument, the module or function to be processed, and return a boolean indicating whether the pass made any changes.</p><p>Before using a custom pass, it must be registered with a pass builder using <code>register!</code>.</p><p>See also: <a href="../transforms/#LLVM.register!"><code>register!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L85-L97">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMFunctionPass" href="#LLVM.NewPMFunctionPass"><code>LLVM.NewPMFunctionPass</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePass(name, callback) -NewPMFunctionPass(name, callback)</code></pre><p>Create a new custom pass. The <code>name</code> is a string that will be used to identify the pass in the pass manager. The <code>callback</code> is a function that will be called when the pass is run. The function should take a single argument, the module or function to be processed, and return a boolean indicating whether the pass made any changes.</p><p>Before using a custom pass, it must be registered with a pass builder using <code>register!</code>.</p><p>See also: <a href="../transforms/#LLVM.register!"><code>register!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L85-L97">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +end</code></pre><p>See also: <a href="../transforms/#LLVM.add!"><code>add!</code></a>, <a href="../transforms/#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMModulePass" href="#LLVM.NewPMModulePass"><code>LLVM.NewPMModulePass</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePass(name, callback) +NewPMFunctionPass(name, callback)</code></pre><p>Create a new custom pass. The <code>name</code> is a string that will be used to identify the pass in the pass manager. The <code>callback</code> is a function that will be called when the pass is run. The function should take a single argument, the module or function to be processed, and return a boolean indicating whether the pass made any changes.</p><p>Before using a custom pass, it must be registered with a pass builder using <code>register!</code>.</p><p>See also: <a href="../transforms/#LLVM.register!"><code>register!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L85-L97">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMFunctionPass" href="#LLVM.NewPMFunctionPass"><code>LLVM.NewPMFunctionPass</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePass(name, callback) +NewPMFunctionPass(name, callback)</code></pre><p>Create a new custom pass. The <code>name</code> is a string that will be used to identify the pass in the pass manager. The <code>callback</code> is a function that will be called when the pass is run. The function should take a single argument, the module or function to be processed, and return a boolean indicating whether the pass made any changes.</p><p>Before using a custom pass, it must be registered with a pass builder using <code>register!</code>.</p><p>See also: <a href="../transforms/#LLVM.register!"><code>register!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L85-L97">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/instructions/index.html b/dev/lib/instructions/index.html index 6480070e..cb28fdaf 100644 --- a/dev/lib/instructions/index.html +++ b/dev/lib/instructions/index.html @@ -1,3 +1,3 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Instructions · LLVM.jl</title><meta name="title" content="Instructions · LLVM.jl"/><meta property="og:title" content="Instructions · LLVM.jl"/><meta property="twitter:title" content="Instructions · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li class="is-active"><a class="tocitem" href>Instructions</a><ul class="internal"><li><a class="tocitem" href="#Creating-instructions"><span>Creating instructions</span></a></li><li><a class="tocitem" href="#Comparison-instructions"><span>Comparison instructions</span></a></li><li><a class="tocitem" href="#Atomic-instructions"><span>Atomic instructions</span></a></li><li><a class="tocitem" href="#Call-instructions"><span>Call instructions</span></a></li><li><a class="tocitem" href="#Terminator-instructions"><span>Terminator instructions</span></a></li><li><a class="tocitem" href="#Phi-instructions"><span>Phi instructions</span></a></li><li><a class="tocitem" href="#Floating-Point-instructions"><span>Floating Point instructions</span></a></li><li><a class="tocitem" href="#Alignment"><span>Alignment</span></a></li></ul></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Instructions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Instructions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/instructions.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Instructions"><a class="docs-heading-anchor" href="#Instructions">Instructions</a><a id="Instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Instructions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Instruction" href="#LLVM.Instruction"><code>LLVM.Instruction</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Instruction</code></pre><p>An instruction in the LLVM IR.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.copy-Tuple{Instruction}" href="#Base.copy-Tuple{Instruction}"><code>Base.copy</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">copy(inst::Instruction)</code></pre><p>Create a copy of the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L41-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.remove!-Tuple{Instruction}" href="#LLVM.remove!-Tuple{Instruction}"><code>LLVM.remove!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">remove!(inst::Instruction)</code></pre><p>Remove the given instruction from the containing basic block, but do not delete the object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L48-L52">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.erase!-Tuple{Instruction}" href="#LLVM.erase!-Tuple{Instruction}"><code>LLVM.erase!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">erase!(inst::Instruction)</code></pre><p>Remove the given instruction from the containing basic block and delete the object.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is unsafe because it does not check if the instruction is used elsewhere.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L55-L63">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parent-Tuple{Instruction}" href="#LLVM.parent-Tuple{Instruction}"><code>LLVM.parent</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parent(inst::Instruction)</code></pre><p>Get the basic block that contains the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L66-L70">source</a></section></article><h2 id="Creating-instructions"><a class="docs-heading-anchor" href="#Creating-instructions">Creating instructions</a><a id="Creating-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.IRBuilder" href="#LLVM.IRBuilder"><code>LLVM.IRBuilder</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">IRBuilder</code></pre><p>An instruction builder, which is used to build instructions within a basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L8-L12">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.IRBuilder-Tuple{}" href="#LLVM.IRBuilder-Tuple{}"><code>LLVM.IRBuilder</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">IRBuilder()</code></pre><p>Create a new, unpositioned instruction builder.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L20-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{IRBuilder}" href="#LLVM.dispose-Tuple{IRBuilder}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(builder::IRBuilder)</code></pre><p>Dispose of an instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L29-L33">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{IRBuilder}" href="#LLVM.context-Tuple{IRBuilder}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(builder::IRBuilder)</code></pre><p>Get the context associated with an instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L36-L40">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.position" href="#Base.position"><code>Base.position</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">position(builder::IRBuilder)</code></pre><p>Return the current position of the instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L54-L58">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.position!-Tuple{IRBuilder, Instruction}" href="#LLVM.position!-Tuple{IRBuilder, Instruction}"><code>LLVM.position!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">position!(builder::IRBuilder, inst::Instruction)</code></pre><p>Position the instruction builder before the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L61-L65">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.position!-Tuple{IRBuilder, BasicBlock}" href="#LLVM.position!-Tuple{IRBuilder, BasicBlock}"><code>LLVM.position!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">position!(builder::IRBuilder, bb::BasicBlock)</code></pre><p>Position the instruction builder at the end of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.position!-Tuple{IRBuilder}" href="#LLVM.position!-Tuple{IRBuilder}"><code>LLVM.position!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">position!(builder::IRBuilder)</code></pre><p>Clear the current position of the instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L77-L81">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.insert!-Tuple{IRBuilder, Instruction, String}" href="#Base.insert!-Tuple{IRBuilder, Instruction, String}"><code>Base.insert!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">insert!(builder::IRBuilder, inst::Instruction, [name::String])</code></pre><p>Insert an instruction into the current basic block at the current position, optionally giving it a name.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L84-L89">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.debuglocation" href="#LLVM.debuglocation"><code>LLVM.debuglocation</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">debuglocation(builder::IRBuilder)</code></pre><p>Get the current debug location of the instruction builder, or <code>nothing</code> if no location is set.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L93-L98">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.debuglocation!" href="#LLVM.debuglocation!"><code>LLVM.debuglocation!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">debuglocation!(builder::IRBuilder)</code></pre><p>Clear the current debug location of the instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L104-L108">source</a></section><section><div><pre><code class="language-julia hljs">debuglocation!(builder::IRBuilder, loc)</code></pre><p>Set the current debug location of the instruction builder to <code>loc</code>, which can be a <code>Metadata</code> or <code>MetadataAsValue</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L112-L117">source</a></section><section><div><pre><code class="language-julia hljs">debuglocation!(builder::IRBuilder, inst::Instruction)</code></pre><p>Set the current debug location of the instruction builder to the location of the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/irbuilder.jl#L124-L129">source</a></section></article><h2 id="Comparison-instructions"><a class="docs-heading-anchor" href="#Comparison-instructions">Comparison instructions</a><a id="Comparison-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Comparison-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.predicate" href="#LLVM.predicate"><code>LLVM.predicate</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">predicate(inst::ICmpInst) -predicate(inst::FCmpInst)</code></pre><p>Get the comparison predicate of the given integer or floating-point comparison instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L110-L115">source</a></section></article><h2 id="Atomic-instructions"><a class="docs-heading-anchor" href="#Atomic-instructions">Atomic instructions</a><a id="Atomic-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Atomic-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.is_atomic" href="#LLVM.is_atomic"><code>LLVM.is_atomic</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">is_atomic(inst::Instruction)</code></pre><p>Check if the given instruction is atomic. This includes atomic operations such as <code>atomicrmw</code> or <code>fence</code>, but also loads and stores that have been made atomic by setting an atomic ordering.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L128-L134">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ordering" href="#LLVM.ordering"><code>LLVM.ordering</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ordering(atomic_inst::Instruction)</code></pre><p>Get the atomic ordering of the given atomic instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L137-L141">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ordering!" href="#LLVM.ordering!"><code>LLVM.ordering!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ordering!(inst::Instruction, ordering::LLVM.AtomicOrdering)</code></pre><p>Set the atomic ordering of the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L147-L151">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.SyncScope" href="#LLVM.SyncScope"><code>LLVM.SyncScope</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">SyncScope</code></pre><p>A synchronization scope for atomic operations.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L157-L161">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.syncscope" href="#LLVM.syncscope"><code>LLVM.syncscope</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">syncscope(inst::AtomicInst)</code></pre><p>Get the synchronization scope of the given atomic instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L192-L196">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.syncscope!" href="#LLVM.syncscope!"><code>LLVM.syncscope!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">syncscope!(inst::AtomicInst, scope::SyncScope)</code></pre><p>Set the synchronization scope of the given atomic instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L202-L206">source</a></section></article><h2 id="Call-instructions"><a class="docs-heading-anchor" href="#Call-instructions">Call instructions</a><a id="Call-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Call-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.callconv-Tuple{Union{LLVM.CallBrInst, LLVM.CallInst, LLVM.InvokeInst}}" href="#LLVM.callconv-Tuple{Union{LLVM.CallBrInst, LLVM.CallInst, LLVM.InvokeInst}}"><code>LLVM.callconv</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">callconv(call_inst::Instruction)</code></pre><p>Get the calling convention of the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L222-L226">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.callconv!-Tuple{Union{LLVM.CallBrInst, LLVM.CallInst, LLVM.InvokeInst}, Any}" href="#LLVM.callconv!-Tuple{Union{LLVM.CallBrInst, LLVM.CallInst, LLVM.InvokeInst}, Any}"><code>LLVM.callconv!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">callconv!(call_inst::Instruction, cc)</code></pre><p>Set the calling convention of the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L229-L233">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.istailcall" href="#LLVM.istailcall"><code>LLVM.istailcall</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">istailcall(call_inst::Instruction)</code></pre><p>Tests if this call site must be tail call optimized.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L237-L241">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.tailcall!" href="#LLVM.tailcall!"><code>LLVM.tailcall!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">tailcall!(call_inst::Instruction, is_tail::Bool)</code></pre><p>Sets whether this call site must be tail call optimized.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L244-L248">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.called_operand" href="#LLVM.called_operand"><code>LLVM.called_operand</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">called_operand(call_inst::Instruction)</code></pre><p>Get the operand of a callable instruction that represents the called function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L251-L255">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.arguments" href="#LLVM.arguments"><code>LLVM.arguments</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">arguments(call_inst::Instruction)</code></pre><p>Get the arguments of a callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L271-L275">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.called_type" href="#LLVM.called_type"><code>LLVM.called_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">called_type(call_inst::Instruction)</code></pre><p>Get the type of the function being called by the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L258-L262">source</a></section></article><h3 id="Operand-Bundles"><a class="docs-heading-anchor" href="#Operand-Bundles">Operand Bundles</a><a id="Operand-Bundles-1"></a><a class="docs-heading-anchor-permalink" href="#Operand-Bundles" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.OperandBundle" href="#LLVM.OperandBundle"><code>LLVM.OperandBundle</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">OperandBundle</code></pre><p>An operand bundle attached to a call site.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L288-L292">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.operand_bundles" href="#LLVM.operand_bundles"><code>LLVM.operand_bundles</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">operand_bundles(call_inst::Instruction)</code></pre><p>Get the operand bundles attached to the given call instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L315-L319">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.tag" href="#LLVM.tag"><code>LLVM.tag</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">tag(bundle::OperandBundle)</code></pre><p>Get the tag of the given operand bundle.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L334-L338">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.inputs" href="#LLVM.inputs"><code>LLVM.inputs</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">inputs(bundle::OperandBundle)</code></pre><p>Get an iterator over the inputs of the given operand bundle.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L349-L353">source</a></section></article><h2 id="Terminator-instructions"><a class="docs-heading-anchor" href="#Terminator-instructions">Terminator instructions</a><a id="Terminator-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Terminator-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isterminator" href="#LLVM.isterminator"><code>LLVM.isterminator</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isterminator(inst::Instruction)</code></pre><p>Check if the given instruction is a terminator instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L382-L386">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isconditional" href="#LLVM.isconditional"><code>LLVM.isconditional</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isconditional(br::BrInst)</code></pre><p>Check if the given branch instruction is conditional.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L389-L393">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.condition" href="#LLVM.condition"><code>LLVM.condition</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">condition(br::BrInst)</code></pre><p>Get the condition of the given branch instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L396-L400">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.condition!" href="#LLVM.condition!"><code>LLVM.condition!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">condition!(br::BrInst, cond::Value)</code></pre><p>Set the condition of the given branch instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L403-L407">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.default_dest" href="#LLVM.default_dest"><code>LLVM.default_dest</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">default_dest(switch::SwitchInst)</code></pre><p>Get the default destination of the given switch instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L410-L414">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.successors-Tuple{Instruction}" href="#LLVM.successors-Tuple{Instruction}"><code>LLVM.successors</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">successors(term::Instruction)</code></pre><p>Get an iterator over the successors of the given terminator instruction.</p><p>This is a mutable iterator, so you can modify the successors of the terminator by calling <code>setindex!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L425-L432">source</a></section></article><h2 id="Phi-instructions"><a class="docs-heading-anchor" href="#Phi-instructions">Phi instructions</a><a id="Phi-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Phi-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.incoming" href="#LLVM.incoming"><code>LLVM.incoming</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">incoming(phi::PhiInst)</code></pre><p>Get an iterator over the incoming values of the given phi node.</p><p>This is a mutable iterator, so you can modify the incoming values of the phi node by calling <code>push!</code> or <code>append!</code>, passing a tuple of the incoming value and the originating basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L458-L466">source</a></section></article><h2 id="Floating-Point-instructions"><a class="docs-heading-anchor" href="#Floating-Point-instructions">Floating Point instructions</a><a id="Floating-Point-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Floating-Point-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.fast_math" href="#LLVM.fast_math"><code>LLVM.fast_math</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">fast_math(inst::Instruction)</code></pre><p>Get the fast math flags on an instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L491-L495">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.fast_math!" href="#LLVM.fast_math!"><code>LLVM.fast_math!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">fast_math!(inst::Instruction; [flag=...], [all=...])</code></pre><p>Set the fast math flags on an instruction. If <code>all</code> is <code>true</code>, then all flags are set.</p><p>The following flags are supported:</p><ul><li><code>nnan</code>: assume arguments and results are not NaN</li><li><code>ninf</code>: assume arguments and results are not Inf</li><li><code>nsz</code>: treat the sign of zero arguments and results as insignificant</li><li><code>arcp</code>: allow use of reciprocal rather than perform division</li><li><code>contract</code>: allow contraction of operations</li><li><code>afn</code>: allow substitution of approximate calculations for functions</li><li><code>reassoc</code>: allow reassociation of operations</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L512-L525">source</a></section></article><h2 id="Alignment"><a class="docs-heading-anchor" href="#Alignment">Alignment</a><a id="Alignment-1"></a><a class="docs-heading-anchor-permalink" href="#Alignment" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.alignment" href="#LLVM.alignment"><code>LLVM.alignment</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">alignment(val::LLVM.GlobalValue)</code></pre><p>Get the alignment of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L906-L910">source</a></section><section><div><pre><code class="language-julia hljs">alignment(val::Instruction)</code></pre><p>Get the alignment of the instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L551-L555">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.alignment!" href="#LLVM.alignment!"><code>LLVM.alignment!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">alignment!(val::LLVM.GlobalValue, bytes::Integer)</code></pre><p>Set the alignment of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L913-L917">source</a></section><section><div><pre><code class="language-julia hljs">alignment!(val::Instruction, bytes::Integer)</code></pre><p>Set the alignment of the instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/instructions.jl#L558-L562">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../blocks/">« Basic blocks</a><a class="docs-footer-nextpage" href="../metadata/">Metadata »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Instructions · LLVM.jl</title><meta name="title" content="Instructions · LLVM.jl"/><meta property="og:title" content="Instructions · LLVM.jl"/><meta property="twitter:title" content="Instructions · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li class="is-active"><a class="tocitem" href>Instructions</a><ul class="internal"><li><a class="tocitem" href="#Creating-instructions"><span>Creating instructions</span></a></li><li><a class="tocitem" href="#Comparison-instructions"><span>Comparison instructions</span></a></li><li><a class="tocitem" href="#Atomic-instructions"><span>Atomic instructions</span></a></li><li><a class="tocitem" href="#Call-instructions"><span>Call instructions</span></a></li><li><a class="tocitem" href="#Terminator-instructions"><span>Terminator instructions</span></a></li><li><a class="tocitem" href="#Phi-instructions"><span>Phi instructions</span></a></li><li><a class="tocitem" href="#Floating-Point-instructions"><span>Floating Point instructions</span></a></li><li><a class="tocitem" href="#Alignment"><span>Alignment</span></a></li></ul></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Instructions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Instructions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/instructions.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Instructions"><a class="docs-heading-anchor" href="#Instructions">Instructions</a><a id="Instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Instructions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Instruction" href="#LLVM.Instruction"><code>LLVM.Instruction</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Instruction</code></pre><p>An instruction in the LLVM IR.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.copy-Tuple{Instruction}" href="#Base.copy-Tuple{Instruction}"><code>Base.copy</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">copy(inst::Instruction)</code></pre><p>Create a copy of the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L41-L45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.remove!-Tuple{Instruction}" href="#LLVM.remove!-Tuple{Instruction}"><code>LLVM.remove!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">remove!(inst::Instruction)</code></pre><p>Remove the given instruction from the containing basic block, but do not delete the object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L48-L52">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.erase!-Tuple{Instruction}" href="#LLVM.erase!-Tuple{Instruction}"><code>LLVM.erase!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">erase!(inst::Instruction)</code></pre><p>Remove the given instruction from the containing basic block and delete the object.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is unsafe because it does not check if the instruction is used elsewhere.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L55-L63">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parent-Tuple{Instruction}" href="#LLVM.parent-Tuple{Instruction}"><code>LLVM.parent</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parent(inst::Instruction)</code></pre><p>Get the basic block that contains the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L66-L70">source</a></section></article><h2 id="Creating-instructions"><a class="docs-heading-anchor" href="#Creating-instructions">Creating instructions</a><a id="Creating-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.IRBuilder" href="#LLVM.IRBuilder"><code>LLVM.IRBuilder</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">IRBuilder</code></pre><p>An instruction builder, which is used to build instructions within a basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L8-L12">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.IRBuilder-Tuple{}" href="#LLVM.IRBuilder-Tuple{}"><code>LLVM.IRBuilder</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">IRBuilder()</code></pre><p>Create a new, unpositioned instruction builder.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L20-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{IRBuilder}" href="#LLVM.dispose-Tuple{IRBuilder}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(builder::IRBuilder)</code></pre><p>Dispose of an instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L29-L33">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{IRBuilder}" href="#LLVM.context-Tuple{IRBuilder}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(builder::IRBuilder)</code></pre><p>Get the context associated with an instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L36-L40">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.position" href="#Base.position"><code>Base.position</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">position(builder::IRBuilder)</code></pre><p>Return the current position of the instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L54-L58">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.position!-Tuple{IRBuilder, Instruction}" href="#LLVM.position!-Tuple{IRBuilder, Instruction}"><code>LLVM.position!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">position!(builder::IRBuilder, inst::Instruction)</code></pre><p>Position the instruction builder before the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L61-L65">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.position!-Tuple{IRBuilder, BasicBlock}" href="#LLVM.position!-Tuple{IRBuilder, BasicBlock}"><code>LLVM.position!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">position!(builder::IRBuilder, bb::BasicBlock)</code></pre><p>Position the instruction builder at the end of the given basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.position!-Tuple{IRBuilder}" href="#LLVM.position!-Tuple{IRBuilder}"><code>LLVM.position!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">position!(builder::IRBuilder)</code></pre><p>Clear the current position of the instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L77-L81">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.insert!-Tuple{IRBuilder, Instruction, String}" href="#Base.insert!-Tuple{IRBuilder, Instruction, String}"><code>Base.insert!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">insert!(builder::IRBuilder, inst::Instruction, [name::String])</code></pre><p>Insert an instruction into the current basic block at the current position, optionally giving it a name.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L84-L89">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.debuglocation" href="#LLVM.debuglocation"><code>LLVM.debuglocation</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">debuglocation(builder::IRBuilder)</code></pre><p>Get the current debug location of the instruction builder, or <code>nothing</code> if no location is set.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L93-L98">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.debuglocation!" href="#LLVM.debuglocation!"><code>LLVM.debuglocation!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">debuglocation!(builder::IRBuilder)</code></pre><p>Clear the current debug location of the instruction builder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L104-L108">source</a></section><section><div><pre><code class="language-julia hljs">debuglocation!(builder::IRBuilder, loc)</code></pre><p>Set the current debug location of the instruction builder to <code>loc</code>, which can be a <code>Metadata</code> or <code>MetadataAsValue</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L112-L117">source</a></section><section><div><pre><code class="language-julia hljs">debuglocation!(builder::IRBuilder, inst::Instruction)</code></pre><p>Set the current debug location of the instruction builder to the location of the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/irbuilder.jl#L124-L129">source</a></section></article><h2 id="Comparison-instructions"><a class="docs-heading-anchor" href="#Comparison-instructions">Comparison instructions</a><a id="Comparison-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Comparison-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.predicate" href="#LLVM.predicate"><code>LLVM.predicate</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">predicate(inst::ICmpInst) +predicate(inst::FCmpInst)</code></pre><p>Get the comparison predicate of the given integer or floating-point comparison instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L110-L115">source</a></section></article><h2 id="Atomic-instructions"><a class="docs-heading-anchor" href="#Atomic-instructions">Atomic instructions</a><a id="Atomic-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Atomic-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.is_atomic" href="#LLVM.is_atomic"><code>LLVM.is_atomic</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">is_atomic(inst::Instruction)</code></pre><p>Check if the given instruction is atomic. This includes atomic operations such as <code>atomicrmw</code> or <code>fence</code>, but also loads and stores that have been made atomic by setting an atomic ordering.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L128-L134">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ordering" href="#LLVM.ordering"><code>LLVM.ordering</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ordering(atomic_inst::Instruction)</code></pre><p>Get the atomic ordering of the given atomic instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L137-L141">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ordering!" href="#LLVM.ordering!"><code>LLVM.ordering!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ordering!(inst::Instruction, ordering::LLVM.AtomicOrdering)</code></pre><p>Set the atomic ordering of the given instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L147-L151">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.SyncScope" href="#LLVM.SyncScope"><code>LLVM.SyncScope</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">SyncScope</code></pre><p>A synchronization scope for atomic operations.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L157-L161">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.syncscope" href="#LLVM.syncscope"><code>LLVM.syncscope</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">syncscope(inst::AtomicInst)</code></pre><p>Get the synchronization scope of the given atomic instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L192-L196">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.syncscope!" href="#LLVM.syncscope!"><code>LLVM.syncscope!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">syncscope!(inst::AtomicInst, scope::SyncScope)</code></pre><p>Set the synchronization scope of the given atomic instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L202-L206">source</a></section></article><h2 id="Call-instructions"><a class="docs-heading-anchor" href="#Call-instructions">Call instructions</a><a id="Call-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Call-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.callconv-Tuple{Union{LLVM.CallBrInst, LLVM.CallInst, LLVM.InvokeInst}}" href="#LLVM.callconv-Tuple{Union{LLVM.CallBrInst, LLVM.CallInst, LLVM.InvokeInst}}"><code>LLVM.callconv</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">callconv(call_inst::Instruction)</code></pre><p>Get the calling convention of the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L222-L226">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.callconv!-Tuple{Union{LLVM.CallBrInst, LLVM.CallInst, LLVM.InvokeInst}, Any}" href="#LLVM.callconv!-Tuple{Union{LLVM.CallBrInst, LLVM.CallInst, LLVM.InvokeInst}, Any}"><code>LLVM.callconv!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">callconv!(call_inst::Instruction, cc)</code></pre><p>Set the calling convention of the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L229-L233">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.istailcall" href="#LLVM.istailcall"><code>LLVM.istailcall</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">istailcall(call_inst::Instruction)</code></pre><p>Tests if this call site must be tail call optimized.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L237-L241">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.tailcall!" href="#LLVM.tailcall!"><code>LLVM.tailcall!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">tailcall!(call_inst::Instruction, is_tail::Bool)</code></pre><p>Sets whether this call site must be tail call optimized.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L244-L248">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.called_operand" href="#LLVM.called_operand"><code>LLVM.called_operand</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">called_operand(call_inst::Instruction)</code></pre><p>Get the operand of a callable instruction that represents the called function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L251-L255">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.arguments" href="#LLVM.arguments"><code>LLVM.arguments</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">arguments(call_inst::Instruction)</code></pre><p>Get the arguments of a callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L271-L275">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.called_type" href="#LLVM.called_type"><code>LLVM.called_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">called_type(call_inst::Instruction)</code></pre><p>Get the type of the function being called by the given callable instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L258-L262">source</a></section></article><h3 id="Operand-Bundles"><a class="docs-heading-anchor" href="#Operand-Bundles">Operand Bundles</a><a id="Operand-Bundles-1"></a><a class="docs-heading-anchor-permalink" href="#Operand-Bundles" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.OperandBundle" href="#LLVM.OperandBundle"><code>LLVM.OperandBundle</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">OperandBundle</code></pre><p>An operand bundle attached to a call site.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L288-L292">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.operand_bundles" href="#LLVM.operand_bundles"><code>LLVM.operand_bundles</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">operand_bundles(call_inst::Instruction)</code></pre><p>Get the operand bundles attached to the given call instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L315-L319">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.tag" href="#LLVM.tag"><code>LLVM.tag</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">tag(bundle::OperandBundle)</code></pre><p>Get the tag of the given operand bundle.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L334-L338">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.inputs" href="#LLVM.inputs"><code>LLVM.inputs</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">inputs(bundle::OperandBundle)</code></pre><p>Get an iterator over the inputs of the given operand bundle.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L349-L353">source</a></section></article><h2 id="Terminator-instructions"><a class="docs-heading-anchor" href="#Terminator-instructions">Terminator instructions</a><a id="Terminator-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Terminator-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isterminator" href="#LLVM.isterminator"><code>LLVM.isterminator</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isterminator(inst::Instruction)</code></pre><p>Check if the given instruction is a terminator instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L382-L386">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isconditional" href="#LLVM.isconditional"><code>LLVM.isconditional</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isconditional(br::BrInst)</code></pre><p>Check if the given branch instruction is conditional.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L389-L393">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.condition" href="#LLVM.condition"><code>LLVM.condition</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">condition(br::BrInst)</code></pre><p>Get the condition of the given branch instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L396-L400">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.condition!" href="#LLVM.condition!"><code>LLVM.condition!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">condition!(br::BrInst, cond::Value)</code></pre><p>Set the condition of the given branch instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L403-L407">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.default_dest" href="#LLVM.default_dest"><code>LLVM.default_dest</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">default_dest(switch::SwitchInst)</code></pre><p>Get the default destination of the given switch instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L410-L414">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.successors-Tuple{Instruction}" href="#LLVM.successors-Tuple{Instruction}"><code>LLVM.successors</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">successors(term::Instruction)</code></pre><p>Get an iterator over the successors of the given terminator instruction.</p><p>This is a mutable iterator, so you can modify the successors of the terminator by calling <code>setindex!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L425-L432">source</a></section></article><h2 id="Phi-instructions"><a class="docs-heading-anchor" href="#Phi-instructions">Phi instructions</a><a id="Phi-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Phi-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.incoming" href="#LLVM.incoming"><code>LLVM.incoming</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">incoming(phi::PhiInst)</code></pre><p>Get an iterator over the incoming values of the given phi node.</p><p>This is a mutable iterator, so you can modify the incoming values of the phi node by calling <code>push!</code> or <code>append!</code>, passing a tuple of the incoming value and the originating basic block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L458-L466">source</a></section></article><h2 id="Floating-Point-instructions"><a class="docs-heading-anchor" href="#Floating-Point-instructions">Floating Point instructions</a><a id="Floating-Point-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Floating-Point-instructions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.fast_math" href="#LLVM.fast_math"><code>LLVM.fast_math</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">fast_math(inst::Instruction)</code></pre><p>Get the fast math flags on an instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L491-L495">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.fast_math!" href="#LLVM.fast_math!"><code>LLVM.fast_math!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">fast_math!(inst::Instruction; [flag=...], [all=...])</code></pre><p>Set the fast math flags on an instruction. If <code>all</code> is <code>true</code>, then all flags are set.</p><p>The following flags are supported:</p><ul><li><code>nnan</code>: assume arguments and results are not NaN</li><li><code>ninf</code>: assume arguments and results are not Inf</li><li><code>nsz</code>: treat the sign of zero arguments and results as insignificant</li><li><code>arcp</code>: allow use of reciprocal rather than perform division</li><li><code>contract</code>: allow contraction of operations</li><li><code>afn</code>: allow substitution of approximate calculations for functions</li><li><code>reassoc</code>: allow reassociation of operations</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L512-L525">source</a></section></article><h2 id="Alignment"><a class="docs-heading-anchor" href="#Alignment">Alignment</a><a id="Alignment-1"></a><a class="docs-heading-anchor-permalink" href="#Alignment" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.alignment" href="#LLVM.alignment"><code>LLVM.alignment</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">alignment(val::LLVM.GlobalValue)</code></pre><p>Get the alignment of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L906-L910">source</a></section><section><div><pre><code class="language-julia hljs">alignment(val::Instruction)</code></pre><p>Get the alignment of the instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L551-L555">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.alignment!" href="#LLVM.alignment!"><code>LLVM.alignment!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">alignment!(val::LLVM.GlobalValue, bytes::Integer)</code></pre><p>Set the alignment of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L913-L917">source</a></section><section><div><pre><code class="language-julia hljs">alignment!(val::Instruction, bytes::Integer)</code></pre><p>Set the alignment of the instruction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/instructions.jl#L558-L562">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../blocks/">« Basic blocks</a><a class="docs-footer-nextpage" href="../metadata/">Metadata »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/interop/index.html b/dev/lib/interop/index.html index 8e30652d..b895d425 100644 --- a/dev/lib/interop/index.html +++ b/dev/lib/interop/index.html @@ -1,4 +1,4 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Julia integration · LLVM.jl</title><meta name="title" content="Julia integration · LLVM.jl"/><meta property="og:title" content="Julia integration · LLVM.jl"/><meta property="twitter:title" content="Julia integration · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li class="is-active"><a class="tocitem" href>Julia integration</a><ul class="internal"><li><a class="tocitem" href="#Essentials"><span>Essentials</span></a></li><li><a class="tocitem" href="#Calling-inline-assembly"><span>Calling inline assembly</span></a></li><li><a class="tocitem" href="#LLVM-pointer-support"><span>LLVM pointer support</span></a></li><li><a class="tocitem" href="#LLVM-intrinsics"><span>LLVM intrinsics</span></a></li></ul></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Julia integration</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Julia integration</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/interop.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Julia-integration"><a class="docs-heading-anchor" href="#Julia-integration">Julia integration</a><a id="Julia-integration-1"></a><a class="docs-heading-anchor-permalink" href="#Julia-integration" title="Permalink"></a></h1><h2 id="Essentials"><a class="docs-heading-anchor" href="#Essentials">Essentials</a><a id="Essentials-1"></a><a class="docs-heading-anchor-permalink" href="#Essentials" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.isboxed" href="#LLVM.Interop.isboxed"><code>LLVM.Interop.isboxed</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isboxed(typ::Type)</code></pre><p>Return if a type would be boxed when instantiated in the code generator.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/interop/base.jl#L44-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.isghosttype" href="#LLVM.Interop.isghosttype"><code>LLVM.Interop.isghosttype</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isghosttype(t::Type) -isghosttype(T::LLVMType)</code></pre><p>Check if a type is a ghost type, implying it would not be emitted by the Julia compiler. This only works for types created by the Julia compiler (living in its LLVM context).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/interop/base.jl#L83-L89">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.create_function" href="#LLVM.Interop.create_function"><code>LLVM.Interop.create_function</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">create_function(rettyp::LLVMType, argtyp::Vector{LLVMType}, [name::String])</code></pre><p>Create an LLVM function, given its return type <code>rettyp</code> and a vector of argument types <code>argtyp</code>. The function is marked for inlining, to be embedded in the caller's body. Returns both the newly created function, and its type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/interop/base.jl#L3-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.call_function" href="#LLVM.Interop.call_function"><code>LLVM.Interop.call_function</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">call_function(f::LLVM.Function, rettyp::Type, argtyp::Type, args...)</code></pre><p>Generate a call to an LLVM function <code>f</code>, given its return type <code>rettyp</code> and a tuple-type for the arguments. The arguments should be passed as a tuple expression containing the argument values (eg. <code>:((1,2))</code>), which will be splatted into the call to the function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/interop/base.jl#L23-L29">source</a></section></article><h2 id="Calling-inline-assembly"><a class="docs-heading-anchor" href="#Calling-inline-assembly">Calling inline assembly</a><a id="Calling-inline-assembly-1"></a><a class="docs-heading-anchor-permalink" href="#Calling-inline-assembly" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.@asmcall" href="#LLVM.Interop.@asmcall"><code>LLVM.Interop.@asmcall</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@asmcall asm::String [constraints::String] [side_effects::Bool=false] - rettyp=Nothing argtyp=Tuple{} args...</code></pre><p>Call some inline assembly <code>asm</code>, optionally constrained by <code>constraints</code> and denoting other side effects in <code>side_effects</code>, specifying the return type in <code>rettyp</code> and types of arguments as a tuple-type in <code>argtyp</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/interop/asmcall.jl#L31-L38">source</a></section></article><h2 id="LLVM-pointer-support"><a class="docs-heading-anchor" href="#LLVM-pointer-support">LLVM pointer support</a><a id="LLVM-pointer-support-1"></a><a class="docs-heading-anchor-permalink" href="#LLVM-pointer-support" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.@typed_ccall" href="#LLVM.Interop.@typed_ccall"><code>LLVM.Interop.@typed_ccall</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@typed_ccall(intrinsic, llvmcall, rettyp, (argtyps...), args...)</code></pre><p>Perform a <code>ccall</code> while more accurately preserving argument types like LLVM expects them:</p><ul><li><code>Bool</code>s are passed as <code>i1</code>, not <code>i8</code>;</li><li>Pointers (both <code>Ptr</code> and <code>Core.LLVMPtr</code>) are passed as typed pointers (instead of resp. <code>i8*</code> and <code>i64</code>);</li><li><code>Val</code>-typed arguments will be passed as constants, if supported.</li></ul><p>These features can be useful to call LLVM intrinsics, which may expect a specific set of argument types.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This macro is not needed anymore on Julia 1.12, where the <code>llvmcall</code> ABI has been extended to preserve argument types more accurately.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/interop/pointer.jl#L311-L328">source</a></section></article><h2 id="LLVM-intrinsics"><a class="docs-heading-anchor" href="#LLVM-intrinsics">LLVM intrinsics</a><a id="LLVM-intrinsics-1"></a><a class="docs-heading-anchor-permalink" href="#LLVM-intrinsics" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.trap" href="#LLVM.Interop.trap"><code>LLVM.Interop.trap</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">trap()</code></pre><p>Trap the program, causing it to abort.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/interop/intrinsics.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.assume" href="#LLVM.Interop.assume"><code>LLVM.Interop.assume</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">assume(cond::Bool)</code></pre><p>Assume that the condition <code>cond</code> is true. This is a hint to the compiler, possibly enabling it to optimize more aggressively.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/interop/intrinsics.jl#L10-L15">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../execution/">« Execution</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Julia integration · LLVM.jl</title><meta name="title" content="Julia integration · LLVM.jl"/><meta property="og:title" content="Julia integration · LLVM.jl"/><meta property="twitter:title" content="Julia integration · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li class="is-active"><a class="tocitem" href>Julia integration</a><ul class="internal"><li><a class="tocitem" href="#Essentials"><span>Essentials</span></a></li><li><a class="tocitem" href="#Calling-inline-assembly"><span>Calling inline assembly</span></a></li><li><a class="tocitem" href="#LLVM-pointer-support"><span>LLVM pointer support</span></a></li><li><a class="tocitem" href="#LLVM-intrinsics"><span>LLVM intrinsics</span></a></li></ul></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Julia integration</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Julia integration</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/interop.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Julia-integration"><a class="docs-heading-anchor" href="#Julia-integration">Julia integration</a><a id="Julia-integration-1"></a><a class="docs-heading-anchor-permalink" href="#Julia-integration" title="Permalink"></a></h1><h2 id="Essentials"><a class="docs-heading-anchor" href="#Essentials">Essentials</a><a id="Essentials-1"></a><a class="docs-heading-anchor-permalink" href="#Essentials" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.isboxed" href="#LLVM.Interop.isboxed"><code>LLVM.Interop.isboxed</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isboxed(typ::Type)</code></pre><p>Return if a type would be boxed when instantiated in the code generator.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/interop/base.jl#L44-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.isghosttype" href="#LLVM.Interop.isghosttype"><code>LLVM.Interop.isghosttype</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isghosttype(t::Type) +isghosttype(T::LLVMType)</code></pre><p>Check if a type is a ghost type, implying it would not be emitted by the Julia compiler. This only works for types created by the Julia compiler (living in its LLVM context).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/interop/base.jl#L83-L89">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.create_function" href="#LLVM.Interop.create_function"><code>LLVM.Interop.create_function</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">create_function(rettyp::LLVMType, argtyp::Vector{LLVMType}, [name::String])</code></pre><p>Create an LLVM function, given its return type <code>rettyp</code> and a vector of argument types <code>argtyp</code>. The function is marked for inlining, to be embedded in the caller's body. Returns both the newly created function, and its type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/interop/base.jl#L3-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.call_function" href="#LLVM.Interop.call_function"><code>LLVM.Interop.call_function</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">call_function(f::LLVM.Function, rettyp::Type, argtyp::Type, args...)</code></pre><p>Generate a call to an LLVM function <code>f</code>, given its return type <code>rettyp</code> and a tuple-type for the arguments. The arguments should be passed as a tuple expression containing the argument values (eg. <code>:((1,2))</code>), which will be splatted into the call to the function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/interop/base.jl#L23-L29">source</a></section></article><h2 id="Calling-inline-assembly"><a class="docs-heading-anchor" href="#Calling-inline-assembly">Calling inline assembly</a><a id="Calling-inline-assembly-1"></a><a class="docs-heading-anchor-permalink" href="#Calling-inline-assembly" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.@asmcall" href="#LLVM.Interop.@asmcall"><code>LLVM.Interop.@asmcall</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@asmcall asm::String [constraints::String] [side_effects::Bool=false] + rettyp=Nothing argtyp=Tuple{} args...</code></pre><p>Call some inline assembly <code>asm</code>, optionally constrained by <code>constraints</code> and denoting other side effects in <code>side_effects</code>, specifying the return type in <code>rettyp</code> and types of arguments as a tuple-type in <code>argtyp</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/interop/asmcall.jl#L31-L38">source</a></section></article><h2 id="LLVM-pointer-support"><a class="docs-heading-anchor" href="#LLVM-pointer-support">LLVM pointer support</a><a id="LLVM-pointer-support-1"></a><a class="docs-heading-anchor-permalink" href="#LLVM-pointer-support" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.@typed_ccall" href="#LLVM.Interop.@typed_ccall"><code>LLVM.Interop.@typed_ccall</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@typed_ccall(intrinsic, llvmcall, rettyp, (argtyps...), args...)</code></pre><p>Perform a <code>ccall</code> while more accurately preserving argument types like LLVM expects them:</p><ul><li><code>Bool</code>s are passed as <code>i1</code>, not <code>i8</code>;</li><li>Pointers (both <code>Ptr</code> and <code>Core.LLVMPtr</code>) are passed as typed pointers (instead of resp. <code>i8*</code> and <code>i64</code>);</li><li><code>Val</code>-typed arguments will be passed as constants, if supported.</li></ul><p>These features can be useful to call LLVM intrinsics, which may expect a specific set of argument types.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This macro is not needed anymore on Julia 1.12, where the <code>llvmcall</code> ABI has been extended to preserve argument types more accurately.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/interop/pointer.jl#L311-L328">source</a></section></article><h2 id="LLVM-intrinsics"><a class="docs-heading-anchor" href="#LLVM-intrinsics">LLVM intrinsics</a><a id="LLVM-intrinsics-1"></a><a class="docs-heading-anchor-permalink" href="#LLVM-intrinsics" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.trap" href="#LLVM.Interop.trap"><code>LLVM.Interop.trap</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">trap()</code></pre><p>Trap the program, causing it to abort.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/interop/intrinsics.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Interop.assume" href="#LLVM.Interop.assume"><code>LLVM.Interop.assume</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">assume(cond::Bool)</code></pre><p>Assume that the condition <code>cond</code> is true. This is a hint to the compiler, possibly enabling it to optimize more aggressively.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/interop/intrinsics.jl#L10-L15">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../execution/">« Execution</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/metadata/index.html b/dev/lib/metadata/index.html index 8b41a4a9..7c7b7ea5 100644 --- a/dev/lib/metadata/index.html +++ b/dev/lib/metadata/index.html @@ -1,3 +1,3 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Metadata · LLVM.jl</title><meta name="title" content="Metadata · LLVM.jl"/><meta property="og:title" content="Metadata · LLVM.jl"/><meta property="twitter:title" content="Metadata · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li class="is-active"><a class="tocitem" href>Metadata</a><ul class="internal"><li><a class="tocitem" href="#Metadata-Value"><span>Metadata <-> Value</span></a></li><li><a class="tocitem" href="#Inspecting-and-attaching"><span>Inspecting and attaching</span></a></li><li><a class="tocitem" href="#Debug-information"><span>Debug information</span></a></li></ul></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Metadata</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Metadata</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/metadata.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Metadata"><a class="docs-heading-anchor" href="#Metadata">Metadata</a><a id="Metadata-1"></a><a class="docs-heading-anchor-permalink" href="#Metadata" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Metadata" href="#LLVM.Metadata"><code>LLVM.Metadata</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Metadata</code></pre><p>Abstract supertype for all metadata types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L5-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDString" href="#LLVM.MDString"><code>LLVM.MDString</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDString</code></pre><p>A string metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L122-L126">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDString-Tuple{String}" href="#LLVM.MDString-Tuple{String}"><code>LLVM.MDString</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDString(val::String)</code></pre><p>Create a new string metadata node from the given Julia string.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L132-L136">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Tuple{Type{String}, MDString}" href="#Base.convert-Tuple{Type{String}, MDString}"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(String, md::MDString)</code></pre><p>Get the string value of the given string metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L140-L144">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDNode" href="#LLVM.MDNode"><code>LLVM.MDNode</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDNode</code></pre><p>Abstract supertype for metadata nodes that can have operands.</p><p>See also: <a href="#LLVM.MDTuple"><code>MDTuple</code></a> for a concrete subtype.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L156-L162">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.operands-Tuple{MDNode}" href="#LLVM.operands-Tuple{MDNode}"><code>LLVM.operands</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">operands(md::MDNode)</code></pre><p>Get the operands of the given metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L165-L169">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDTuple" href="#LLVM.MDTuple"><code>LLVM.MDTuple</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDTuple</code></pre><p>A tuple metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L187-L191">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDNode-Tuple{Vector}" href="#LLVM.MDNode-Tuple{Vector}"><code>LLVM.MDNode</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDNode(vals::Vector) -> MDTuple</code></pre><p>Create a new tuple metadata node from the given operands.</p><p>Passing <code>nothing</code> as a value will result in a null operand.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L197-L203">source</a></section></article><h2 id="Metadata-Value"><a class="docs-heading-anchor" href="#Metadata-Value">Metadata <-> Value</a><a id="Metadata-Value-1"></a><a class="docs-heading-anchor-permalink" href="#Metadata-Value" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ValueAsMetadata" href="#LLVM.ValueAsMetadata"><code>LLVM.ValueAsMetadata</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.ValueAsMetadata</code></pre><p>Abstract type for values wrapped as metadata, for use in APIs that expect a <code>LLVM.Metadata</code>.</p><p>See also: <a href="#LLVM.Metadata-Tuple{Value}"><code>Metadata(::Value)</code></a> to convert back to a metadata.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L85-L91">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Metadata-Tuple{Value}" href="#LLVM.Metadata-Tuple{Value}"><code>LLVM.Metadata</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Metadata(val::Value)</code></pre><p>Wrap the given value as metadata, for use in APIs that expect a <code>LLVM.Metadata</code>.</p><p>When the value is already metadata wrapped as a value, this will simply return the original metadata.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L104-L111">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MetadataAsValue" href="#LLVM.MetadataAsValue"><code>LLVM.MetadataAsValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.MetadataAsValue</code></pre><p>Metadata wrapped as a regular value, for use in APIs that expect a <code>LLVM.Value</code>.</p><p>See also: <a href="#LLVM.Value-Tuple{Metadata}"><code>Value(::Metadata)</code></a> to convert back to a value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Value-Tuple{Metadata}" href="#LLVM.Value-Tuple{Metadata}"><code>LLVM.Value</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Value(md::Metadata)</code></pre><p>Wrap the given metadata as a value, for use in APIs that expect a <code>LLVM.Value</code>.</p><p>When the metadata is already a value wrapped as metadata, this will simply return the original value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L67-L74">source</a></section></article><h2 id="Inspecting-and-attaching"><a class="docs-heading-anchor" href="#Inspecting-and-attaching">Inspecting and attaching</a><a id="Inspecting-and-attaching-1"></a><a class="docs-heading-anchor-permalink" href="#Inspecting-and-attaching" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.metadata-Tuple{Union{LLVM.GlobalObject, Instruction}}" href="#LLVM.metadata-Tuple{Union{LLVM.GlobalObject, Instruction}}"><code>LLVM.metadata</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">metadata(inst::Instruction) -metadata(inst::GlobalObject)</code></pre><p>Iterate over the metadata of the given instruction or global object.</p><p>These iterators are mutable, and implement <code>setindex!</code> and <code>delete!</code> to modify the metadata.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L221-L228">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NamedMDNode" href="#LLVM.NamedMDNode"><code>LLVM.NamedMDNode</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NamedMDNode</code></pre><p>A named metadata node, which is a collection of metadata nodes with a name.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L337-L341">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.metadata-Tuple{LLVM.Module}" href="#LLVM.metadata-Tuple{LLVM.Module}"><code>LLVM.metadata</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">metadata(mod)</code></pre><p>Fetch the module-level named metadata. This can be inspected using a Dict-like interface. Mutation is different: There is no <code>setindex!</code> method, as named metadata is append-only. Instead, fetch the named metadata node using <code>getindex</code>, and <code>push!</code> to it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L401-L407">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{NamedMDNode}" href="#LLVM.name-Tuple{NamedMDNode}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(node::NamedMDNode)</code></pre><p>Get the name of the given named metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L349-L353">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.operands-Tuple{NamedMDNode}" href="#LLVM.operands-Tuple{NamedMDNode}"><code>LLVM.operands</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">operands(node::NamedMDNode)</code></pre><p>Get the operands of the given named metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L370-L374">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.push!-Tuple{NamedMDNode, MDNode}" href="#Base.push!-Tuple{NamedMDNode, MDNode}"><code>Base.push!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">push!(node::NamedMDNode, val::MDNode)</code></pre><p>Add a metadata node to the given named metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/metadata.jl#L384-L388">source</a></section></article><h2 id="Debug-information"><a class="docs-heading-anchor" href="#Debug-information">Debug information</a><a id="Debug-information-1"></a><a class="docs-heading-anchor-permalink" href="#Debug-information" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DINode" href="#LLVM.DINode"><code>LLVM.DINode</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DINode</code></pre><p>a tagged DWARF-like metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L67-L71">source</a></section></article><h3 id="Location-information"><a class="docs-heading-anchor" href="#Location-information">Location information</a><a id="Location-information-1"></a><a class="docs-heading-anchor-permalink" href="#Location-information" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DILocation" href="#LLVM.DILocation"><code>LLVM.DILocation</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DILocation</code></pre><p>A location in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L5-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.line-Tuple{DILocation}" href="#LLVM.line-Tuple{DILocation}"><code>LLVM.line</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">line(location::DILocation)</code></pre><p>Get the line number of this debug location.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L28-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.column" href="#LLVM.column"><code>LLVM.column</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">column(location::DILocation)</code></pre><p>Get the column number of this debug location.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.scope-Tuple{DILocation}" href="#LLVM.scope-Tuple{DILocation}"><code>LLVM.scope</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">scope(location::DILocation)</code></pre><p>Get the local scope associated with this debug location.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L42-L46">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.inlined_at" href="#LLVM.inlined_at"><code>LLVM.inlined_at</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">inlined_at(location::DILocation)</code></pre><p>Get the "inline at" location associated with this debug location.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L52-L56">source</a></section></article><h3 id="Variables"><a class="docs-heading-anchor" href="#Variables">Variables</a><a id="Variables-1"></a><a class="docs-heading-anchor-permalink" href="#Variables" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIVariable" href="#LLVM.DIVariable"><code>LLVM.DIVariable</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIVariable</code></pre><p>Abstract supertype for all variable-like metadata nodes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L79-L83">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DILocalVariable" href="#LLVM.DILocalVariable"><code>LLVM.DILocalVariable</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DILocalVariable <: DIVariable</code></pre><p>A local variable in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L97-L101">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIGlobalVariable" href="#LLVM.DIGlobalVariable"><code>LLVM.DIGlobalVariable</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIGlobalVariable <: DIVariable</code></pre><p>A global variable in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L104-L108">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.file-Tuple{DIVariable}" href="#LLVM.file-Tuple{DIVariable}"><code>LLVM.file</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">file(var::DIVariable)</code></pre><p>Get the file of the given variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L111-L115">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.scope-Tuple{DIVariable}" href="#LLVM.scope-Tuple{DIVariable}"><code>LLVM.scope</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(var::DIVariable)</code></pre><p>Get the name of the given variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L121-L125">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.line-Tuple{DIVariable}" href="#LLVM.line-Tuple{DIVariable}"><code>LLVM.line</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">line(var::DIVariable)</code></pre><p>Get the line number of the given variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L131-L135">source</a></section></article><h3 id="Scopes"><a class="docs-heading-anchor" href="#Scopes">Scopes</a><a id="Scopes-1"></a><a class="docs-heading-anchor-permalink" href="#Scopes" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIScope" href="#LLVM.DIScope"><code>LLVM.DIScope</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIScope</code></pre><p>Abstract supertype for lexical scopes and types (which are also declaration contexts).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L143-L147">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.file-Tuple{DIScope}" href="#LLVM.file-Tuple{DIScope}"><code>LLVM.file</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">file(scope::DIScope)</code></pre><p>Get the metadata of the file associated with a given scope.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L150-L154">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{DIScope}" href="#LLVM.name-Tuple{DIScope}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(scope::DIScope)</code></pre><p>Get the name of the given scope.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L157-L161">source</a></section></article><h3 id="File"><a class="docs-heading-anchor" href="#File">File</a><a id="File-1"></a><a class="docs-heading-anchor-permalink" href="#File" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIFile" href="#LLVM.DIFile"><code>LLVM.DIFile</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIFile</code></pre><p>A file in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L176-L180">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.directory" href="#LLVM.directory"><code>LLVM.directory</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">directory(file::DIFile)</code></pre><p>Get the directory of a given file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L186-L190">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.filename" href="#LLVM.filename"><code>LLVM.filename</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">filename(file::DIFile)</code></pre><p>Get the filename of the given file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L198-L202">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.source" href="#LLVM.source"><code>LLVM.source</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">source(file::DIFile)</code></pre><p>Get the source of the given file, or <code>nothing</code> if the source is not available.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L210-L214">source</a></section></article><h3 id="Type"><a class="docs-heading-anchor" href="#Type">Type</a><a id="Type-1"></a><a class="docs-heading-anchor-permalink" href="#Type" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIType" href="#LLVM.DIType"><code>LLVM.DIType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIType</code></pre><p>Abstract supertype for all type-like metadata nodes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L227-L231">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{DIType}" href="#LLVM.name-Tuple{DIType}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(typ::DIType)</code></pre><p>Get the name of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L245-L249">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.sizeof-Tuple{DIType}" href="#Base.sizeof-Tuple{DIType}"><code>Base.sizeof</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sizeof(typ::DIType)</code></pre><p>Get the size in bits of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L257-L261">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.offset-Tuple{DIType}" href="#LLVM.offset-Tuple{DIType}"><code>LLVM.offset</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">offset(typ::DIType)</code></pre><p>Get the offset in bits of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L264-L268">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.line-Tuple{DIType}" href="#LLVM.line-Tuple{DIType}"><code>LLVM.line</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">line(typ::DIType)</code></pre><p>Get the line number of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L271-L275">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.flags-Tuple{DIType}" href="#LLVM.flags-Tuple{DIType}"><code>LLVM.flags</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">flags(typ::DIType)</code></pre><p>Get the flags of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L278-L282">source</a></section></article><h3 id="Subprogram"><a class="docs-heading-anchor" href="#Subprogram">Subprogram</a><a id="Subprogram-1"></a><a class="docs-heading-anchor-permalink" href="#Subprogram" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DISubProgram" href="#LLVM.DISubProgram"><code>LLVM.DISubProgram</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DISubProgram</code></pre><p>A subprogram in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L290-L294">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.line-Tuple{DISubProgram}" href="#LLVM.line-Tuple{DISubProgram}"><code>LLVM.line</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">line(subprogram::DISubProgram)</code></pre><p>Get the line number of the given subprogram.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L300-L304">source</a></section></article><h3 id="Compile-Unit"><a class="docs-heading-anchor" href="#Compile-Unit">Compile Unit</a><a id="Compile-Unit-1"></a><a class="docs-heading-anchor-permalink" href="#Compile-Unit" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DICompileUnit" href="#LLVM.DICompileUnit"><code>LLVM.DICompileUnit</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DICompileUnit</code></pre><p>A compilation unit in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L312-L316">source</a></section></article><h3 id="Other"><a class="docs-heading-anchor" href="#Other">Other</a><a id="Other-1"></a><a class="docs-heading-anchor-permalink" href="#Other" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DEBUG_METADATA_VERSION" href="#LLVM.DEBUG_METADATA_VERSION"><code>LLVM.DEBUG_METADATA_VERSION</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DEBUG_METADATA_VERSION()</code></pre><p>The current debug info version number, as supported by LLVM.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L327-L331">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.strip_debuginfo!" href="#LLVM.strip_debuginfo!"><code>LLVM.strip_debuginfo!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">strip_debuginfo!(mod::Module)</code></pre><p>Strip the debug information from the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L334-L338">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.subprogram-Tuple{LLVM.Function}" href="#LLVM.subprogram-Tuple{LLVM.Function}"><code>LLVM.subprogram</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">subprogram(func::Function) -> DISubProgram</code></pre><p>Get the subprogram of the given function, or <code>nothing</code> if the function has no subprogram.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L341-L345">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.subprogram!" href="#LLVM.subprogram!"><code>LLVM.subprogram!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">subprogram!(func::Function, sp::DISubProgram)</code></pre><p>Set the subprogram of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/debuginfo.jl#L351-L355">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../instructions/">« Instructions</a><a class="docs-footer-nextpage" href="../analyses/">Analyses »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Metadata · LLVM.jl</title><meta name="title" content="Metadata · LLVM.jl"/><meta property="og:title" content="Metadata · LLVM.jl"/><meta property="twitter:title" content="Metadata · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li class="is-active"><a class="tocitem" href>Metadata</a><ul class="internal"><li><a class="tocitem" href="#Metadata-Value"><span>Metadata <-> Value</span></a></li><li><a class="tocitem" href="#Inspecting-and-attaching"><span>Inspecting and attaching</span></a></li><li><a class="tocitem" href="#Debug-information"><span>Debug information</span></a></li></ul></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Metadata</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Metadata</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/metadata.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Metadata"><a class="docs-heading-anchor" href="#Metadata">Metadata</a><a id="Metadata-1"></a><a class="docs-heading-anchor-permalink" href="#Metadata" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Metadata" href="#LLVM.Metadata"><code>LLVM.Metadata</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Metadata</code></pre><p>Abstract supertype for all metadata types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L5-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDString" href="#LLVM.MDString"><code>LLVM.MDString</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDString</code></pre><p>A string metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L122-L126">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDString-Tuple{String}" href="#LLVM.MDString-Tuple{String}"><code>LLVM.MDString</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDString(val::String)</code></pre><p>Create a new string metadata node from the given Julia string.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L132-L136">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Tuple{Type{String}, MDString}" href="#Base.convert-Tuple{Type{String}, MDString}"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(String, md::MDString)</code></pre><p>Get the string value of the given string metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L140-L144">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDNode" href="#LLVM.MDNode"><code>LLVM.MDNode</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDNode</code></pre><p>Abstract supertype for metadata nodes that can have operands.</p><p>See also: <a href="#LLVM.MDTuple"><code>MDTuple</code></a> for a concrete subtype.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L156-L162">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.operands-Tuple{MDNode}" href="#LLVM.operands-Tuple{MDNode}"><code>LLVM.operands</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">operands(md::MDNode)</code></pre><p>Get the operands of the given metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L165-L169">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDTuple" href="#LLVM.MDTuple"><code>LLVM.MDTuple</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDTuple</code></pre><p>A tuple metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L187-L191">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MDNode-Tuple{Vector}" href="#LLVM.MDNode-Tuple{Vector}"><code>LLVM.MDNode</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MDNode(vals::Vector) -> MDTuple</code></pre><p>Create a new tuple metadata node from the given operands.</p><p>Passing <code>nothing</code> as a value will result in a null operand.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L197-L203">source</a></section></article><h2 id="Metadata-Value"><a class="docs-heading-anchor" href="#Metadata-Value">Metadata <-> Value</a><a id="Metadata-Value-1"></a><a class="docs-heading-anchor-permalink" href="#Metadata-Value" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ValueAsMetadata" href="#LLVM.ValueAsMetadata"><code>LLVM.ValueAsMetadata</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.ValueAsMetadata</code></pre><p>Abstract type for values wrapped as metadata, for use in APIs that expect a <code>LLVM.Metadata</code>.</p><p>See also: <a href="#LLVM.Metadata-Tuple{Value}"><code>Metadata(::Value)</code></a> to convert back to a metadata.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L85-L91">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Metadata-Tuple{Value}" href="#LLVM.Metadata-Tuple{Value}"><code>LLVM.Metadata</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Metadata(val::Value)</code></pre><p>Wrap the given value as metadata, for use in APIs that expect a <code>LLVM.Metadata</code>.</p><p>When the value is already metadata wrapped as a value, this will simply return the original metadata.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L104-L111">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MetadataAsValue" href="#LLVM.MetadataAsValue"><code>LLVM.MetadataAsValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.MetadataAsValue</code></pre><p>Metadata wrapped as a regular value, for use in APIs that expect a <code>LLVM.Value</code>.</p><p>See also: <a href="#LLVM.Value-Tuple{Metadata}"><code>Value(::Metadata)</code></a> to convert back to a value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L55-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Value-Tuple{Metadata}" href="#LLVM.Value-Tuple{Metadata}"><code>LLVM.Value</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Value(md::Metadata)</code></pre><p>Wrap the given metadata as a value, for use in APIs that expect a <code>LLVM.Value</code>.</p><p>When the metadata is already a value wrapped as metadata, this will simply return the original value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L67-L74">source</a></section></article><h2 id="Inspecting-and-attaching"><a class="docs-heading-anchor" href="#Inspecting-and-attaching">Inspecting and attaching</a><a id="Inspecting-and-attaching-1"></a><a class="docs-heading-anchor-permalink" href="#Inspecting-and-attaching" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.metadata-Tuple{Union{LLVM.GlobalObject, Instruction}}" href="#LLVM.metadata-Tuple{Union{LLVM.GlobalObject, Instruction}}"><code>LLVM.metadata</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">metadata(inst::Instruction) +metadata(inst::GlobalObject)</code></pre><p>Iterate over the metadata of the given instruction or global object.</p><p>These iterators are mutable, and implement <code>setindex!</code> and <code>delete!</code> to modify the metadata.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L221-L228">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NamedMDNode" href="#LLVM.NamedMDNode"><code>LLVM.NamedMDNode</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NamedMDNode</code></pre><p>A named metadata node, which is a collection of metadata nodes with a name.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L337-L341">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.metadata-Tuple{LLVM.Module}" href="#LLVM.metadata-Tuple{LLVM.Module}"><code>LLVM.metadata</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">metadata(mod)</code></pre><p>Fetch the module-level named metadata. This can be inspected using a Dict-like interface. Mutation is different: There is no <code>setindex!</code> method, as named metadata is append-only. Instead, fetch the named metadata node using <code>getindex</code>, and <code>push!</code> to it.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L401-L407">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{NamedMDNode}" href="#LLVM.name-Tuple{NamedMDNode}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(node::NamedMDNode)</code></pre><p>Get the name of the given named metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L349-L353">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.operands-Tuple{NamedMDNode}" href="#LLVM.operands-Tuple{NamedMDNode}"><code>LLVM.operands</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">operands(node::NamedMDNode)</code></pre><p>Get the operands of the given named metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L370-L374">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.push!-Tuple{NamedMDNode, MDNode}" href="#Base.push!-Tuple{NamedMDNode, MDNode}"><code>Base.push!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">push!(node::NamedMDNode, val::MDNode)</code></pre><p>Add a metadata node to the given named metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/metadata.jl#L384-L388">source</a></section></article><h2 id="Debug-information"><a class="docs-heading-anchor" href="#Debug-information">Debug information</a><a id="Debug-information-1"></a><a class="docs-heading-anchor-permalink" href="#Debug-information" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DINode" href="#LLVM.DINode"><code>LLVM.DINode</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DINode</code></pre><p>a tagged DWARF-like metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L67-L71">source</a></section></article><h3 id="Location-information"><a class="docs-heading-anchor" href="#Location-information">Location information</a><a id="Location-information-1"></a><a class="docs-heading-anchor-permalink" href="#Location-information" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DILocation" href="#LLVM.DILocation"><code>LLVM.DILocation</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DILocation</code></pre><p>A location in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L5-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.line-Tuple{DILocation}" href="#LLVM.line-Tuple{DILocation}"><code>LLVM.line</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">line(location::DILocation)</code></pre><p>Get the line number of this debug location.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L28-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.column" href="#LLVM.column"><code>LLVM.column</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">column(location::DILocation)</code></pre><p>Get the column number of this debug location.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.scope-Tuple{DILocation}" href="#LLVM.scope-Tuple{DILocation}"><code>LLVM.scope</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">scope(location::DILocation)</code></pre><p>Get the local scope associated with this debug location.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L42-L46">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.inlined_at" href="#LLVM.inlined_at"><code>LLVM.inlined_at</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">inlined_at(location::DILocation)</code></pre><p>Get the "inline at" location associated with this debug location.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L52-L56">source</a></section></article><h3 id="Variables"><a class="docs-heading-anchor" href="#Variables">Variables</a><a id="Variables-1"></a><a class="docs-heading-anchor-permalink" href="#Variables" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIVariable" href="#LLVM.DIVariable"><code>LLVM.DIVariable</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIVariable</code></pre><p>Abstract supertype for all variable-like metadata nodes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L79-L83">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DILocalVariable" href="#LLVM.DILocalVariable"><code>LLVM.DILocalVariable</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DILocalVariable <: DIVariable</code></pre><p>A local variable in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L97-L101">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIGlobalVariable" href="#LLVM.DIGlobalVariable"><code>LLVM.DIGlobalVariable</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIGlobalVariable <: DIVariable</code></pre><p>A global variable in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L104-L108">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.file-Tuple{DIVariable}" href="#LLVM.file-Tuple{DIVariable}"><code>LLVM.file</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">file(var::DIVariable)</code></pre><p>Get the file of the given variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L111-L115">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.scope-Tuple{DIVariable}" href="#LLVM.scope-Tuple{DIVariable}"><code>LLVM.scope</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(var::DIVariable)</code></pre><p>Get the name of the given variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L121-L125">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.line-Tuple{DIVariable}" href="#LLVM.line-Tuple{DIVariable}"><code>LLVM.line</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">line(var::DIVariable)</code></pre><p>Get the line number of the given variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L131-L135">source</a></section></article><h3 id="Scopes"><a class="docs-heading-anchor" href="#Scopes">Scopes</a><a id="Scopes-1"></a><a class="docs-heading-anchor-permalink" href="#Scopes" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIScope" href="#LLVM.DIScope"><code>LLVM.DIScope</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIScope</code></pre><p>Abstract supertype for lexical scopes and types (which are also declaration contexts).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L143-L147">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.file-Tuple{DIScope}" href="#LLVM.file-Tuple{DIScope}"><code>LLVM.file</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">file(scope::DIScope)</code></pre><p>Get the metadata of the file associated with a given scope.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L150-L154">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{DIScope}" href="#LLVM.name-Tuple{DIScope}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(scope::DIScope)</code></pre><p>Get the name of the given scope.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L157-L161">source</a></section></article><h3 id="File"><a class="docs-heading-anchor" href="#File">File</a><a id="File-1"></a><a class="docs-heading-anchor-permalink" href="#File" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIFile" href="#LLVM.DIFile"><code>LLVM.DIFile</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIFile</code></pre><p>A file in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L176-L180">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.directory" href="#LLVM.directory"><code>LLVM.directory</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">directory(file::DIFile)</code></pre><p>Get the directory of a given file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L186-L190">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.filename" href="#LLVM.filename"><code>LLVM.filename</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">filename(file::DIFile)</code></pre><p>Get the filename of the given file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L198-L202">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.source" href="#LLVM.source"><code>LLVM.source</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">source(file::DIFile)</code></pre><p>Get the source of the given file, or <code>nothing</code> if the source is not available.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L210-L214">source</a></section></article><h3 id="Type"><a class="docs-heading-anchor" href="#Type">Type</a><a id="Type-1"></a><a class="docs-heading-anchor-permalink" href="#Type" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DIType" href="#LLVM.DIType"><code>LLVM.DIType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DIType</code></pre><p>Abstract supertype for all type-like metadata nodes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L227-L231">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{DIType}" href="#LLVM.name-Tuple{DIType}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(typ::DIType)</code></pre><p>Get the name of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L245-L249">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.sizeof-Tuple{DIType}" href="#Base.sizeof-Tuple{DIType}"><code>Base.sizeof</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sizeof(typ::DIType)</code></pre><p>Get the size in bits of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L257-L261">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.offset-Tuple{DIType}" href="#LLVM.offset-Tuple{DIType}"><code>LLVM.offset</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">offset(typ::DIType)</code></pre><p>Get the offset in bits of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L264-L268">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.line-Tuple{DIType}" href="#LLVM.line-Tuple{DIType}"><code>LLVM.line</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">line(typ::DIType)</code></pre><p>Get the line number of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L271-L275">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.flags-Tuple{DIType}" href="#LLVM.flags-Tuple{DIType}"><code>LLVM.flags</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">flags(typ::DIType)</code></pre><p>Get the flags of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L278-L282">source</a></section></article><h3 id="Subprogram"><a class="docs-heading-anchor" href="#Subprogram">Subprogram</a><a id="Subprogram-1"></a><a class="docs-heading-anchor-permalink" href="#Subprogram" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DISubProgram" href="#LLVM.DISubProgram"><code>LLVM.DISubProgram</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DISubProgram</code></pre><p>A subprogram in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L290-L294">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.line-Tuple{DISubProgram}" href="#LLVM.line-Tuple{DISubProgram}"><code>LLVM.line</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">line(subprogram::DISubProgram)</code></pre><p>Get the line number of the given subprogram.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L300-L304">source</a></section></article><h3 id="Compile-Unit"><a class="docs-heading-anchor" href="#Compile-Unit">Compile Unit</a><a id="Compile-Unit-1"></a><a class="docs-heading-anchor-permalink" href="#Compile-Unit" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DICompileUnit" href="#LLVM.DICompileUnit"><code>LLVM.DICompileUnit</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DICompileUnit</code></pre><p>A compilation unit in the source code.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L312-L316">source</a></section></article><h3 id="Other"><a class="docs-heading-anchor" href="#Other">Other</a><a id="Other-1"></a><a class="docs-heading-anchor-permalink" href="#Other" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DEBUG_METADATA_VERSION" href="#LLVM.DEBUG_METADATA_VERSION"><code>LLVM.DEBUG_METADATA_VERSION</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DEBUG_METADATA_VERSION()</code></pre><p>The current debug info version number, as supported by LLVM.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L327-L331">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.strip_debuginfo!" href="#LLVM.strip_debuginfo!"><code>LLVM.strip_debuginfo!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">strip_debuginfo!(mod::Module)</code></pre><p>Strip the debug information from the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L334-L338">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.subprogram-Tuple{LLVM.Function}" href="#LLVM.subprogram-Tuple{LLVM.Function}"><code>LLVM.subprogram</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">subprogram(func::Function) -> DISubProgram</code></pre><p>Get the subprogram of the given function, or <code>nothing</code> if the function has no subprogram.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L341-L345">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.subprogram!" href="#LLVM.subprogram!"><code>LLVM.subprogram!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">subprogram!(func::Function, sp::DISubProgram)</code></pre><p>Set the subprogram of the given function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/debuginfo.jl#L351-L355">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../instructions/">« Instructions</a><a class="docs-footer-nextpage" href="../analyses/">Analyses »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/modules/index.html b/dev/lib/modules/index.html index f3f6cf59..460dcd78 100644 --- a/dev/lib/modules/index.html +++ b/dev/lib/modules/index.html @@ -1,2 +1,2 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Modules · LLVM.jl</title><meta name="title" content="Modules · LLVM.jl"/><meta property="og:title" content="Modules · LLVM.jl"/><meta property="twitter:title" content="Modules · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li class="is-active"><a class="tocitem" href>Modules</a><ul class="internal"><li><a class="tocitem" href="#Properties-and-operations"><span>Properties and operations</span></a></li><li><a class="tocitem" href="#Textual-representation"><span>Textual representation</span></a></li><li><a class="tocitem" href="#Binary-representation-("bitcode")"><span>Binary representation ("bitcode")</span></a></li><li><a class="tocitem" href="#Contents"><span>Contents</span></a></li><li><a class="tocitem" href="#Linking"><span>Linking</span></a></li></ul></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Modules</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Modules</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/modules.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Modules"><a class="docs-heading-anchor" href="#Modules">Modules</a><a id="Modules-1"></a><a class="docs-heading-anchor-permalink" href="#Modules" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Module" href="#LLVM.Module"><code>LLVM.Module</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Module</code></pre><p>Modules are the top level container of all other LLVM IR objects. Each module directly contains a list of globals variables, a list of functions, a list of libraries (or other modules) this module depends on, a symbol table, and various data about the target's characteristics.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L10-L17">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.copy-Tuple{LLVM.Module}" href="#Base.copy-Tuple{LLVM.Module}"><code>Base.copy</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">copy(mod::LLVM.Module)</code></pre><p>Clone the given module.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L43-L49">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{LLVM.Module}" href="#LLVM.dispose-Tuple{LLVM.Module}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(mod::LLVM.Module)</code></pre><p>Dispose of the given module, releasing all resources associated with it. The module should not be used after this operation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L52-L57">source</a></section></article><h2 id="Properties-and-operations"><a class="docs-heading-anchor" href="#Properties-and-operations">Properties and operations</a><a id="Properties-and-operations-1"></a><a class="docs-heading-anchor-permalink" href="#Properties-and-operations" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{LLVM.Module}" href="#LLVM.context-Tuple{LLVM.Module}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(mod::LLVM.Module)</code></pre><p>Get the context in which the given module was created.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L154-L158">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{LLVM.Module}" href="#LLVM.name-Tuple{LLVM.Module}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(mod::LLVM.Module)</code></pre><p>Get the name of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L78-L82">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name!-Tuple{LLVM.Module, String}" href="#LLVM.name!-Tuple{LLVM.Module, String}"><code>LLVM.name!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name!(mod::LLVM.Module, name::String)</code></pre><p>Set the name of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L89-L93">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.triple-Tuple{LLVM.Module}" href="#LLVM.triple-Tuple{LLVM.Module}"><code>LLVM.triple</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">triple(mod::LLVM.Module)</code></pre><p>Get the target triple of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L97-L101">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.triple!-Tuple{LLVM.Module, String}" href="#LLVM.triple!-Tuple{LLVM.Module, String}"><code>LLVM.triple!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">triple!(mod::LLVM.Module, triple::String)</code></pre><p>Set the target triple of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L104-L108">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.datalayout" href="#LLVM.datalayout"><code>LLVM.datalayout</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">datalayout(mod::LLVM.Module)</code></pre><p>Get the data layout of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L111-L115">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.datalayout!" href="#LLVM.datalayout!"><code>LLVM.datalayout!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">datalayout!(mod::LLVM.Module, layout)</code></pre><p>Set the data layout of the given module. The layout can be a string or a <code>DataLayout</code> object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L118-L123">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.inline_asm!" href="#LLVM.inline_asm!"><code>LLVM.inline_asm!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">inline_asm!(mod::LLVM.Module, asm::String; overwrite::Bool=false)</code></pre><p>Add module-level inline assembly to the given module. If <code>overwrite</code> is <code>true</code>, the existing inline assembly is replaced, otherwise the new assembly is appended.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L129-L134">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.inline_asm" href="#LLVM.inline_asm"><code>LLVM.inline_asm</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">inline_asm(mod::LLVM.Module) -> String</code></pre><p>Get the module-level inline assembly of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L143-L147">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.sdk_version" href="#LLVM.sdk_version"><code>LLVM.sdk_version</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sdk_version!(mod::LLVM.Module, version::VersionNumber)</code></pre><p>Set the SDK version of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L482-L486">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.sdk_version!" href="#LLVM.sdk_version!"><code>LLVM.sdk_version!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sdk_version(mod::LLVM.Module)</code></pre><p>Get the SDK version of the given module, if it has been set.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L461-L465">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.set_used!" href="#LLVM.set_used!"><code>LLVM.set_used!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">set_used!(mod::LLVM.Module, values::GlobalVariable...)</code></pre><p>Mark the given global variables as used in the given module by appending them to the <code>llvm.used</code> metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L161-L166">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.set_compiler_used!" href="#LLVM.set_compiler_used!"><code>LLVM.set_compiler_used!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">set_compiler_used!(mod::LLVM.Module, values::GlobalVariable...)</code></pre><p>Mark the given global variables as used by the compiler in the given module by appending them to the <code>llvm.compiler.used</code> metadata node. As opposed to <a href="#LLVM.set_used!"><code>set_used!</code></a>, this still allows the linker to remove the variable if it is not actually used.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L170-L176">source</a></section></article><h2 id="Textual-representation"><a class="docs-heading-anchor" href="#Textual-representation">Textual representation</a><a id="Textual-representation-1"></a><a class="docs-heading-anchor-permalink" href="#Textual-representation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.parse-Tuple{Type{LLVM.Module}, String}" href="#Base.parse-Tuple{Type{LLVM.Module}, String}"><code>Base.parse</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parse(::Type{Module}, ir::String)</code></pre><p>Parse the given LLVM IR string into a module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L183-L187">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.string-Tuple{LLVM.Module}" href="#Base.string-Tuple{LLVM.Module}"><code>Base.string</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">string(mod::Module)</code></pre><p>Convert the given module to a string.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L205-L209">source</a></section></article><h2 id="Binary-representation-("bitcode")"><a class="docs-heading-anchor" href="#Binary-representation-("bitcode")">Binary representation ("bitcode")</a><a id="Binary-representation-("bitcode")-1"></a><a class="docs-heading-anchor-permalink" href="#Binary-representation-("bitcode")" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.parse-Tuple{Type{LLVM.Module}, MemoryBuffer}" href="#Base.parse-Tuple{Type{LLVM.Module}, MemoryBuffer}"><code>Base.parse</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parse(::Type{Module}, membuf::MemoryBuffer)</code></pre><p>Parse bitcode from the given memory buffer into a module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L215-L219">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.parse-Tuple{Type{LLVM.Module}, Vector}" href="#Base.parse-Tuple{Type{LLVM.Module}, Vector}"><code>Base.parse</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parse(::Type{Module}, data::Vector)</code></pre><p>Parse bitcode from the given byte vector into a module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L229-L233">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Tuple{Type{MemoryBuffer}, LLVM.Module}" href="#Base.convert-Tuple{Type{MemoryBuffer}, LLVM.Module}"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{MemoryBuffer}, mod::Module)</code></pre><p>Convert the given module to a memory buffer containing its bitcode.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L240-L244">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{Vector{T}}, LLVM.Module}} where T<:Union{Int8, UInt8}" href="#Base.convert-Union{Tuple{T}, Tuple{Type{Vector{T}}, LLVM.Module}} where T<:Union{Int8, UInt8}"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{Vector}, mod::Module)</code></pre><p>Convert the given module to a byte vector containing its bitcode.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L248-L252">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.write-Tuple{IO, LLVM.Module}" href="#Base.write-Tuple{IO, LLVM.Module}"><code>Base.write</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">write(io::IO, mod::Module)</code></pre><p>Write bitcode of the given module to the given IO stream.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L260-L264">source</a></section></article><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.globals" href="#LLVM.globals"><code>LLVM.globals</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">globals(mod::LLVM.Module)</code></pre><p>Get an iterator over the global variables in the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L284-L288">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.prevglobal" href="#LLVM.prevglobal"><code>LLVM.prevglobal</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">prevglobal(gv::LLVM.GlobalVariable)</code></pre><p>Get the previous global variable in the module, or <code>nothing</code> if there is none.</p><p>See also: <a href="#LLVM.nextglobal"><code>nextglobal</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L313-L319">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.nextglobal" href="#LLVM.nextglobal"><code>LLVM.nextglobal</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">nextglobal(gv::LLVM.GlobalVariable)</code></pre><p>Get the next global variable in the module, or <code>nothing</code> if there is none.</p><p>See also: <a href="#LLVM.prevglobal"><code>prevglobal</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L326-L332">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.functions-Tuple{LLVM.Module}" href="#LLVM.functions-Tuple{LLVM.Module}"><code>LLVM.functions</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">functions(mod::LLVM.Module)</code></pre><p>Get an iterator over the functions in the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L360-L364">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.prevfun" href="#LLVM.prevfun"><code>LLVM.prevfun</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">prevfun(fun::LLVM.Function)</code></pre><p>Get the previous function in the module, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L389-L393">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.nextfun" href="#LLVM.nextfun"><code>LLVM.nextfun</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">nextfun(fun::LLVM.Function)</code></pre><p>Get the next function in the module, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L400-L404">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.flags-Tuple{LLVM.Module}" href="#LLVM.flags-Tuple{LLVM.Module}"><code>LLVM.flags</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">flags(mod::LLVM.Module)</code></pre><p>Get a dictionary-like object representing the module flags of the given module.</p><p>This object can be used to get and set module flags, by calling <code>getindex</code> and <code>setindex!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/module.jl#L433-L439">source</a></section></article><h2 id="Linking"><a class="docs-heading-anchor" href="#Linking">Linking</a><a id="Linking-1"></a><a class="docs-heading-anchor-permalink" href="#Linking" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.link!-Tuple{LLVM.Module, LLVM.Module}" href="#LLVM.link!-Tuple{LLVM.Module, LLVM.Module}"><code>LLVM.link!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">link!(dst::Module, src::Module)</code></pre><p>Link the source module <code>src</code> into the destination module <code>dst</code>. The source module is destroyed in the process.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/linker.jl#L3-L8">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../values/">« Values</a><a class="docs-footer-nextpage" href="../functions/">Functions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Modules · LLVM.jl</title><meta name="title" content="Modules · LLVM.jl"/><meta property="og:title" content="Modules · LLVM.jl"/><meta property="twitter:title" content="Modules · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../values/">Values</a></li><li class="is-active"><a class="tocitem" href>Modules</a><ul class="internal"><li><a class="tocitem" href="#Properties-and-operations"><span>Properties and operations</span></a></li><li><a class="tocitem" href="#Textual-representation"><span>Textual representation</span></a></li><li><a class="tocitem" href="#Binary-representation-("bitcode")"><span>Binary representation ("bitcode")</span></a></li><li><a class="tocitem" href="#Contents"><span>Contents</span></a></li><li><a class="tocitem" href="#Linking"><span>Linking</span></a></li></ul></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Modules</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Modules</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/modules.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Modules"><a class="docs-heading-anchor" href="#Modules">Modules</a><a id="Modules-1"></a><a class="docs-heading-anchor-permalink" href="#Modules" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Module" href="#LLVM.Module"><code>LLVM.Module</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Module</code></pre><p>Modules are the top level container of all other LLVM IR objects. Each module directly contains a list of globals variables, a list of functions, a list of libraries (or other modules) this module depends on, a symbol table, and various data about the target's characteristics.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L10-L17">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.copy-Tuple{LLVM.Module}" href="#Base.copy-Tuple{LLVM.Module}"><code>Base.copy</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">copy(mod::LLVM.Module)</code></pre><p>Clone the given module.</p><p>This object needs to be disposed of using <a href="../analyses/#LLVM.dispose-Tuple{DomTree}"><code>dispose</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L43-L49">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dispose-Tuple{LLVM.Module}" href="#LLVM.dispose-Tuple{LLVM.Module}"><code>LLVM.dispose</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dispose(mod::LLVM.Module)</code></pre><p>Dispose of the given module, releasing all resources associated with it. The module should not be used after this operation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L52-L57">source</a></section></article><h2 id="Properties-and-operations"><a class="docs-heading-anchor" href="#Properties-and-operations">Properties and operations</a><a id="Properties-and-operations-1"></a><a class="docs-heading-anchor-permalink" href="#Properties-and-operations" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{LLVM.Module}" href="#LLVM.context-Tuple{LLVM.Module}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(mod::LLVM.Module)</code></pre><p>Get the context in which the given module was created.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L154-L158">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{LLVM.Module}" href="#LLVM.name-Tuple{LLVM.Module}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(mod::LLVM.Module)</code></pre><p>Get the name of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L78-L82">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name!-Tuple{LLVM.Module, String}" href="#LLVM.name!-Tuple{LLVM.Module, String}"><code>LLVM.name!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name!(mod::LLVM.Module, name::String)</code></pre><p>Set the name of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L89-L93">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.triple-Tuple{LLVM.Module}" href="#LLVM.triple-Tuple{LLVM.Module}"><code>LLVM.triple</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">triple(mod::LLVM.Module)</code></pre><p>Get the target triple of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L97-L101">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.triple!-Tuple{LLVM.Module, String}" href="#LLVM.triple!-Tuple{LLVM.Module, String}"><code>LLVM.triple!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">triple!(mod::LLVM.Module, triple::String)</code></pre><p>Set the target triple of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L104-L108">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.datalayout" href="#LLVM.datalayout"><code>LLVM.datalayout</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">datalayout(mod::LLVM.Module)</code></pre><p>Get the data layout of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L111-L115">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.datalayout!" href="#LLVM.datalayout!"><code>LLVM.datalayout!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">datalayout!(mod::LLVM.Module, layout)</code></pre><p>Set the data layout of the given module. The layout can be a string or a <code>DataLayout</code> object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L118-L123">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.inline_asm!" href="#LLVM.inline_asm!"><code>LLVM.inline_asm!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">inline_asm!(mod::LLVM.Module, asm::String; overwrite::Bool=false)</code></pre><p>Add module-level inline assembly to the given module. If <code>overwrite</code> is <code>true</code>, the existing inline assembly is replaced, otherwise the new assembly is appended.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L129-L134">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.inline_asm" href="#LLVM.inline_asm"><code>LLVM.inline_asm</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">inline_asm(mod::LLVM.Module) -> String</code></pre><p>Get the module-level inline assembly of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L143-L147">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.sdk_version" href="#LLVM.sdk_version"><code>LLVM.sdk_version</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sdk_version!(mod::LLVM.Module, version::VersionNumber)</code></pre><p>Set the SDK version of the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L482-L486">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.sdk_version!" href="#LLVM.sdk_version!"><code>LLVM.sdk_version!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sdk_version(mod::LLVM.Module)</code></pre><p>Get the SDK version of the given module, if it has been set.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L461-L465">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.set_used!" href="#LLVM.set_used!"><code>LLVM.set_used!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">set_used!(mod::LLVM.Module, values::GlobalVariable...)</code></pre><p>Mark the given global variables as used in the given module by appending them to the <code>llvm.used</code> metadata node.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L161-L166">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.set_compiler_used!" href="#LLVM.set_compiler_used!"><code>LLVM.set_compiler_used!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">set_compiler_used!(mod::LLVM.Module, values::GlobalVariable...)</code></pre><p>Mark the given global variables as used by the compiler in the given module by appending them to the <code>llvm.compiler.used</code> metadata node. As opposed to <a href="#LLVM.set_used!"><code>set_used!</code></a>, this still allows the linker to remove the variable if it is not actually used.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L170-L176">source</a></section></article><h2 id="Textual-representation"><a class="docs-heading-anchor" href="#Textual-representation">Textual representation</a><a id="Textual-representation-1"></a><a class="docs-heading-anchor-permalink" href="#Textual-representation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.parse-Tuple{Type{LLVM.Module}, String}" href="#Base.parse-Tuple{Type{LLVM.Module}, String}"><code>Base.parse</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parse(::Type{Module}, ir::String)</code></pre><p>Parse the given LLVM IR string into a module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L183-L187">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.string-Tuple{LLVM.Module}" href="#Base.string-Tuple{LLVM.Module}"><code>Base.string</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">string(mod::Module)</code></pre><p>Convert the given module to a string.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L205-L209">source</a></section></article><h2 id="Binary-representation-("bitcode")"><a class="docs-heading-anchor" href="#Binary-representation-("bitcode")">Binary representation ("bitcode")</a><a id="Binary-representation-("bitcode")-1"></a><a class="docs-heading-anchor-permalink" href="#Binary-representation-("bitcode")" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.parse-Tuple{Type{LLVM.Module}, MemoryBuffer}" href="#Base.parse-Tuple{Type{LLVM.Module}, MemoryBuffer}"><code>Base.parse</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parse(::Type{Module}, membuf::MemoryBuffer)</code></pre><p>Parse bitcode from the given memory buffer into a module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L215-L219">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.parse-Tuple{Type{LLVM.Module}, Vector}" href="#Base.parse-Tuple{Type{LLVM.Module}, Vector}"><code>Base.parse</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parse(::Type{Module}, data::Vector)</code></pre><p>Parse bitcode from the given byte vector into a module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L229-L233">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Tuple{Type{MemoryBuffer}, LLVM.Module}" href="#Base.convert-Tuple{Type{MemoryBuffer}, LLVM.Module}"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{MemoryBuffer}, mod::Module)</code></pre><p>Convert the given module to a memory buffer containing its bitcode.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L240-L244">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{Vector{T}}, LLVM.Module}} where T<:Union{Int8, UInt8}" href="#Base.convert-Union{Tuple{T}, Tuple{Type{Vector{T}}, LLVM.Module}} where T<:Union{Int8, UInt8}"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{Vector}, mod::Module)</code></pre><p>Convert the given module to a byte vector containing its bitcode.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L248-L252">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.write-Tuple{IO, LLVM.Module}" href="#Base.write-Tuple{IO, LLVM.Module}"><code>Base.write</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">write(io::IO, mod::Module)</code></pre><p>Write bitcode of the given module to the given IO stream.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L260-L264">source</a></section></article><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.globals" href="#LLVM.globals"><code>LLVM.globals</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">globals(mod::LLVM.Module)</code></pre><p>Get an iterator over the global variables in the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L284-L288">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.prevglobal" href="#LLVM.prevglobal"><code>LLVM.prevglobal</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">prevglobal(gv::LLVM.GlobalVariable)</code></pre><p>Get the previous global variable in the module, or <code>nothing</code> if there is none.</p><p>See also: <a href="#LLVM.nextglobal"><code>nextglobal</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L313-L319">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.nextglobal" href="#LLVM.nextglobal"><code>LLVM.nextglobal</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">nextglobal(gv::LLVM.GlobalVariable)</code></pre><p>Get the next global variable in the module, or <code>nothing</code> if there is none.</p><p>See also: <a href="#LLVM.prevglobal"><code>prevglobal</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L326-L332">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.functions-Tuple{LLVM.Module}" href="#LLVM.functions-Tuple{LLVM.Module}"><code>LLVM.functions</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">functions(mod::LLVM.Module)</code></pre><p>Get an iterator over the functions in the given module.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L360-L364">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.prevfun" href="#LLVM.prevfun"><code>LLVM.prevfun</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">prevfun(fun::LLVM.Function)</code></pre><p>Get the previous function in the module, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L389-L393">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.nextfun" href="#LLVM.nextfun"><code>LLVM.nextfun</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">nextfun(fun::LLVM.Function)</code></pre><p>Get the next function in the module, or <code>nothing</code> if there is none.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L400-L404">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.flags-Tuple{LLVM.Module}" href="#LLVM.flags-Tuple{LLVM.Module}"><code>LLVM.flags</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">flags(mod::LLVM.Module)</code></pre><p>Get a dictionary-like object representing the module flags of the given module.</p><p>This object can be used to get and set module flags, by calling <code>getindex</code> and <code>setindex!</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/module.jl#L433-L439">source</a></section></article><h2 id="Linking"><a class="docs-heading-anchor" href="#Linking">Linking</a><a id="Linking-1"></a><a class="docs-heading-anchor-permalink" href="#Linking" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.link!-Tuple{LLVM.Module, LLVM.Module}" href="#LLVM.link!-Tuple{LLVM.Module, LLVM.Module}"><code>LLVM.link!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">link!(dst::Module, src::Module)</code></pre><p>Link the source module <code>src</code> into the destination module <code>dst</code>. The source module is destroyed in the process.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/linker.jl#L3-L8">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../values/">« Values</a><a class="docs-footer-nextpage" href="../functions/">Functions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/transforms/index.html b/dev/lib/transforms/index.html index 89eca2da..0b5321e2 100644 --- a/dev/lib/transforms/index.html +++ b/dev/lib/transforms/index.html @@ -6,16 +6,16 @@ add!(fpm, SomeFunctionPass()) end run!(pb, mod, tm) -end</code></pre><p>For quickly running a simple pass or pipeline, a shorthand <code>run!</code> method is provided that obviates the construction of a <code>NewPMPassBuilder</code>:</p><pre><code class="language-julia hljs">run!("some-pass", mod, tm; verify_each=true)</code></pre><p>See also: <a href="#LLVM.register!"><code>register!</code></a>, <a href="#LLVM.add!"><code>add!</code></a>, <a href="#LLVM.run!"><code>run!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L129-L174">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.run!" href="#LLVM.run!"><code>LLVM.run!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">run!(pb::NewPMPassBuilder, mod::Module, [tm::TargetMachine]) -run!(pipeline::String, mod::Module, [tm::TargetMachine])</code></pre><p>Run passes on a module. The passes are specified by a pass builder or a string that represents a pass pipeline. The target machine is used to optimize the passes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L242-L248">source</a></section></article><h2 id="Pass-managers"><a class="docs-heading-anchor" href="#Pass-managers">Pass managers</a><a id="Pass-managers-1"></a><a class="docs-heading-anchor-permalink" href="#Pass-managers" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMPassManager" href="#LLVM.NewPMPassManager"><code>LLVM.NewPMPassManager</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() +end</code></pre><p>For quickly running a simple pass or pipeline, a shorthand <code>run!</code> method is provided that obviates the construction of a <code>NewPMPassBuilder</code>:</p><pre><code class="language-julia hljs">run!("some-pass", mod, tm; verify_each=true)</code></pre><p>See also: <a href="#LLVM.register!"><code>register!</code></a>, <a href="#LLVM.add!"><code>add!</code></a>, <a href="#LLVM.run!"><code>run!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L129-L174">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.run!" href="#LLVM.run!"><code>LLVM.run!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">run!(pb::NewPMPassBuilder, mod::Module, [tm::TargetMachine]) +run!(pipeline::String, mod::Module, [tm::TargetMachine])</code></pre><p>Run passes on a module. The passes are specified by a pass builder or a string that represents a pass pipeline. The target machine is used to optimize the passes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L242-L248">source</a></section></article><h2 id="Pass-managers"><a class="docs-heading-anchor" href="#Pass-managers">Pass managers</a><a id="Pass-managers-1"></a><a class="docs-heading-anchor-permalink" href="#Pass-managers" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMPassManager" href="#LLVM.NewPMPassManager"><code>LLVM.NewPMPassManager</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePassManager() NewPMCGSCCPassManager() NewPMFunctionPassManager() NewPMLoopPassManager(; use_memory_ssa=false) NewPMAAManager()</code></pre><p>Create a new pass manager of the specified type. These objects can be used to construct pass pipelines, by <code>add!</code>ing passes to them, and finally <code>add!</code>ing them to a parent pass manager or pass builder.</p><p>Creating a pass manager and adding it to a parent manager or builder can be shortened using a single <code>add!</code>:</p><pre><code class="language-julia hljs">add!(parent, NewPMModulePassManager()) do mpm add!(mpm, SomeModulePass()) -end</code></pre><p>See also: <a href="#LLVM.add!"><code>add!</code></a>, <a href="#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.add!" href="#LLVM.add!"><code>LLVM.add!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">add!(pm::AbstractPassManager, pass)</code></pre><p>Adds a pass or pipeline to a pass builder or pass manager.</p><p>The pass or pipeline should be a string or string-convertible object known by LLVM. These can be constructed by using pass constructors, e.g., <code>InternalizePass()</code>, or by manually specifying names like <code>default<O3></code>.</p><p>When using custom passes, remember that they need to be registered with the pass builder before they can be used.</p><p>See also: <a href="#LLVM.register!"><code>register!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L11-L24">source</a></section></article><h2 id="Alias-analyses"><a class="docs-heading-anchor" href="#Alias-analyses">Alias analyses</a><a id="Alias-analyses-1"></a><a class="docs-heading-anchor-permalink" href="#Alias-analyses" title="Permalink"></a></h2><h2 id="Custom-passes"><a class="docs-heading-anchor" href="#Custom-passes">Custom passes</a><a id="Custom-passes-1"></a><a class="docs-heading-anchor-permalink" href="#Custom-passes" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMCustomPass" href="#LLVM.NewPMCustomPass"><code>LLVM.NewPMCustomPass</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePass(name, callback) -NewPMFunctionPass(name, callback)</code></pre><p>Create a new custom pass. The <code>name</code> is a string that will be used to identify the pass in the pass manager. The <code>callback</code> is a function that will be called when the pass is run. The function should take a single argument, the module or function to be processed, and return a boolean indicating whether the pass made any changes.</p><p>Before using a custom pass, it must be registered with a pass builder using <code>register!</code>.</p><p>See also: <a href="#LLVM.register!"><code>register!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L85-L97">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.register!" href="#LLVM.register!"><code>LLVM.register!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">register!(pb, custom_pass)</code></pre><p>Register a custom pass with the pass builder. This is necessary before the pass can be used in a pass pipeline.</p><p>See also: <a href="../hidden/#LLVM.NewPMModulePass"><code>NewPMModulePass</code></a>, <a href="../hidden/#LLVM.NewPMFunctionPass"><code>NewPMFunctionPass</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/newpm.jl#L230-L237">source</a></section></article><h2 id="IR-cloning"><a class="docs-heading-anchor" href="#IR-cloning">IR cloning</a><a id="IR-cloning-1"></a><a class="docs-heading-anchor-permalink" href="#IR-cloning" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.clone_into!" href="#LLVM.clone_into!"><code>LLVM.clone_into!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">clone_into!(new::LLVM.Function, old::LLVM.Function; [suffix::String], +end</code></pre><p>See also: <a href="#LLVM.add!"><code>add!</code></a>, <a href="#LLVM.NewPMPassBuilder"><code>NewPMPassBuilder</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L27-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.add!" href="#LLVM.add!"><code>LLVM.add!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">add!(pm::AbstractPassManager, pass)</code></pre><p>Adds a pass or pipeline to a pass builder or pass manager.</p><p>The pass or pipeline should be a string or string-convertible object known by LLVM. These can be constructed by using pass constructors, e.g., <code>InternalizePass()</code>, or by manually specifying names like <code>default<O3></code>.</p><p>When using custom passes, remember that they need to be registered with the pass builder before they can be used.</p><p>See also: <a href="#LLVM.register!"><code>register!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L11-L24">source</a></section></article><h2 id="Alias-analyses"><a class="docs-heading-anchor" href="#Alias-analyses">Alias analyses</a><a id="Alias-analyses-1"></a><a class="docs-heading-anchor-permalink" href="#Alias-analyses" title="Permalink"></a></h2><h2 id="Custom-passes"><a class="docs-heading-anchor" href="#Custom-passes">Custom passes</a><a id="Custom-passes-1"></a><a class="docs-heading-anchor-permalink" href="#Custom-passes" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.NewPMCustomPass" href="#LLVM.NewPMCustomPass"><code>LLVM.NewPMCustomPass</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">NewPMModulePass(name, callback) +NewPMFunctionPass(name, callback)</code></pre><p>Create a new custom pass. The <code>name</code> is a string that will be used to identify the pass in the pass manager. The <code>callback</code> is a function that will be called when the pass is run. The function should take a single argument, the module or function to be processed, and return a boolean indicating whether the pass made any changes.</p><p>Before using a custom pass, it must be registered with a pass builder using <code>register!</code>.</p><p>See also: <a href="#LLVM.register!"><code>register!</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L85-L97">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.register!" href="#LLVM.register!"><code>LLVM.register!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">register!(pb, custom_pass)</code></pre><p>Register a custom pass with the pass builder. This is necessary before the pass can be used in a pass pipeline.</p><p>See also: <a href="../hidden/#LLVM.NewPMModulePass"><code>NewPMModulePass</code></a>, <a href="../hidden/#LLVM.NewPMFunctionPass"><code>NewPMFunctionPass</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/newpm.jl#L230-L237">source</a></section></article><h2 id="IR-cloning"><a class="docs-heading-anchor" href="#IR-cloning">IR cloning</a><a id="IR-cloning-1"></a><a class="docs-heading-anchor-permalink" href="#IR-cloning" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.clone_into!" href="#LLVM.clone_into!"><code>LLVM.clone_into!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">clone_into!(new::LLVM.Function, old::LLVM.Function; [suffix::String], [value_map::Dict{<:Value,<:Value}], [changes::LLVM.LLVMCloneFunctionChangeType], [type_mapper::Function], - [materializer::Function])</code></pre><p>Clone the contents of a function <code>old</code> into a new function <code>new</code>. The <code>value_map</code> dictionary can be used to remap values from the old function to the new function, while <code>suffix</code> appends a suffix to all values cloned. The <code>type_mapper</code> and <code>materializer</code> functions can be used to respectively map types and materialize values on demand.</p><p>The <code>changes</code> argument determines how this function behaves; refer to the LLVM documentation of <code>CloneFunctionInto</code> for more details.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/utils.jl#L18-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.clone" href="#LLVM.clone"><code>LLVM.clone</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">clone(f::Function; [value_map::Dict{Value,Value}])</code></pre><p>Simpler version of <a href="#LLVM.clone_into!"><code>clone_into!</code></a> that clones a function <code>f</code> into a new function, optionally mapping values according to the <code>value_map</code> dictionary.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/utils.jl#L61-L66">source</a></section><section><div><pre><code class="language-julia hljs">clone(bb::BasicBlock]; dest=parent(bb), [suffix::String], [value_map::Dict{Value,Value}])</code></pre><p>Clone a basic block <code>bb</code> by copying all instructions. The new block is inserted at the end of the parent function; this can be altered by setting <code>dest</code> to a different function, or to <code>nothing</code> to create a detached block. The <code>suffix</code> is appended to the name of the cloned basic block.</p><div class="admonition is-category-warn"><header class="admonition-header">Warn</header><div class="admonition-body"><p>This function only remaps values that are defined in the cloned basic block. Values defined outside the basic block (e.g. function arguments) are not remapped by default. This means that the cloned basic block can generally only be used within the same function that it was cloned from, unless you manually remap other values. This can be done passing a <code>value_map</code> dictionary.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/utils.jl#L105-L120">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../analyses/">« Analyses</a><a class="docs-footer-nextpage" href="../codegen/">Code generation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> + [materializer::Function])</code></pre><p>Clone the contents of a function <code>old</code> into a new function <code>new</code>. The <code>value_map</code> dictionary can be used to remap values from the old function to the new function, while <code>suffix</code> appends a suffix to all values cloned. The <code>type_mapper</code> and <code>materializer</code> functions can be used to respectively map types and materialize values on demand.</p><p>The <code>changes</code> argument determines how this function behaves; refer to the LLVM documentation of <code>CloneFunctionInto</code> for more details.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/utils.jl#L18-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.clone" href="#LLVM.clone"><code>LLVM.clone</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">clone(f::Function; [value_map::Dict{Value,Value}])</code></pre><p>Simpler version of <a href="#LLVM.clone_into!"><code>clone_into!</code></a> that clones a function <code>f</code> into a new function, optionally mapping values according to the <code>value_map</code> dictionary.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/utils.jl#L61-L66">source</a></section><section><div><pre><code class="language-julia hljs">clone(bb::BasicBlock]; dest=parent(bb), [suffix::String], [value_map::Dict{Value,Value}])</code></pre><p>Clone a basic block <code>bb</code> by copying all instructions. The new block is inserted at the end of the parent function; this can be altered by setting <code>dest</code> to a different function, or to <code>nothing</code> to create a detached block. The <code>suffix</code> is appended to the name of the cloned basic block.</p><div class="admonition is-category-warn"><header class="admonition-header">Warn</header><div class="admonition-body"><p>This function only remaps values that are defined in the cloned basic block. Values defined outside the basic block (e.g. function arguments) are not remapped by default. This means that the cloned basic block can generally only be used within the same function that it was cloned from, unless you manually remap other values. This can be done passing a <code>value_map</code> dictionary.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/utils.jl#L105-L120">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../analyses/">« Analyses</a><a class="docs-footer-nextpage" href="../codegen/">Code generation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/types/index.html b/dev/lib/types/index.html index 3982e138..8d8304c0 100644 --- a/dev/lib/types/index.html +++ b/dev/lib/types/index.html @@ -1,2 +1,2 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Types · LLVM.jl</title><meta name="title" content="Types · LLVM.jl"/><meta property="og:title" content="Types · LLVM.jl"/><meta property="twitter:title" content="Types · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li class="is-active"><a class="tocitem" href>Types</a><ul class="internal"><li><a class="tocitem" href="#Integer-types"><span>Integer types</span></a></li><li><a class="tocitem" href="#Floating-point-types"><span>Floating-point types</span></a></li><li><a class="tocitem" href="#Function-types"><span>Function types</span></a></li><li><a class="tocitem" href="#Pointer-types"><span>Pointer types</span></a></li><li><a class="tocitem" href="#Array-types"><span>Array types</span></a></li><li><a class="tocitem" href="#Vector-types"><span>Vector types</span></a></li><li><a class="tocitem" href="#Structure-types"><span>Structure types</span></a></li><li><a class="tocitem" href="#Other-types"><span>Other types</span></a></li><li><a class="tocitem" href="#Type-iteration"><span>Type iteration</span></a></li></ul></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Types</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Types</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/types.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Types"><a class="docs-heading-anchor" href="#Types">Types</a><a id="Types-1"></a><a class="docs-heading-anchor-permalink" href="#Types" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.LLVMType" href="#LLVM.LLVMType"><code>LLVM.LLVMType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVMType</code></pre><p>Abstract supertype for all LLVM types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.issized" href="#LLVM.issized"><code>LLVM.issized</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">issized(typ::LLVMType)</code></pre><p>Return true if it makes sense to take the size of this type.</p><p>Note that this does not mean that it's possible to call <code>sizeof</code> on this type, as LLVM types sizes can only queried given a target data layout.</p><p>See also: <a href="../codegen/#Base.sizeof-Tuple{DataLayout, LLVMType}"><code>sizeof(::DataLayout, ::LLVMType)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L52-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{LLVMType}" href="#LLVM.context-Tuple{LLVMType}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(typ::LLVMType)</code></pre><p>Returns the context in which the given type was created.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L64-L68">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.eltype-Tuple{LLVMType}" href="#Base.eltype-Tuple{LLVMType}"><code>Base.eltype</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">eltype(typ::LLVMType)</code></pre><p>Get the element type of the given type, if supported.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L13-L17">source</a></section></article><h2 id="Integer-types"><a class="docs-heading-anchor" href="#Integer-types">Integer types</a><a id="Integer-types-1"></a><a class="docs-heading-anchor-permalink" href="#Integer-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.IntegerType" href="#LLVM.IntegerType"><code>LLVM.IntegerType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntegerType <: LLVMType</code></pre><p>Type representing arbitrary bit width integers.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L88-L92">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.IntType" href="#LLVM.IntType"><code>LLVM.IntType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.width" href="#LLVM.width"><code>LLVM.width</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">width(inttyp::LLVM.IntegerType)</code></pre><p>Get the bit width of the given integer type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L117-L121">source</a></section></article><h2 id="Floating-point-types"><a class="docs-heading-anchor" href="#Floating-point-types">Floating-point types</a><a id="Floating-point-types-1"></a><a class="docs-heading-anchor-permalink" href="#Floating-point-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.HalfType" href="#LLVM.HalfType"><code>LLVM.HalfType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.HalfType()</code></pre><p>Create a 16-bit floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L148-L152">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BFloatType" href="#LLVM.BFloatType"><code>LLVM.BFloatType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.BFloatType()</code></pre><p>Create a 16-bit “brain” floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L155-L159">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.FloatType" href="#LLVM.FloatType"><code>LLVM.FloatType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.FloatType()</code></pre><p>Create a 32-bit floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L162-L166">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DoubleType" href="#LLVM.DoubleType"><code>LLVM.DoubleType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.DoubleType()</code></pre><p>Create a 64-bit floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L169-L173">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.FP128Type" href="#LLVM.FP128Type"><code>LLVM.FP128Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.FP128Type()</code></pre><p>Create a 128-bit floating-point type, with a 113-bit significand.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L176-L180">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.X86FP80Type" href="#LLVM.X86FP80Type"><code>LLVM.X86FP80Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.X86FP80Type()</code></pre><p>Create a 80-bit, X87 floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L183-L187">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PPCFP128Type" href="#LLVM.PPCFP128Type"><code>LLVM.PPCFP128Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.PPCFP128Type()</code></pre><p>Create a 128-bit floating-point type, consisting of two 64-bits.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L190-L194">source</a></section></article><h2 id="Function-types"><a class="docs-heading-anchor" href="#Function-types">Function types</a><a id="Function-types-1"></a><a class="docs-heading-anchor-permalink" href="#Function-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.FunctionType" href="#LLVM.FunctionType"><code>LLVM.FunctionType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.FunctionType <: LLVMType</code></pre><p>A function type, representing a function signature.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L202-L206">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isvararg" href="#LLVM.isvararg"><code>LLVM.isvararg</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isvararg(ft::LLVM.FunctionType)</code></pre><p>Check whether the given function type is variadic.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L225-L229">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.return_type" href="#LLVM.return_type"><code>LLVM.return_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">return_type(ft::LLVM.FunctionType)</code></pre><p>Get the return type of the given function type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L232-L236">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parameters-Tuple{LLVM.FunctionType}" href="#LLVM.parameters-Tuple{LLVM.FunctionType}"><code>LLVM.parameters</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parameters(ft::LLVM.FunctionType)</code></pre><p>Get the parameter types of the given function type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L239-L243">source</a></section></article><h2 id="Pointer-types"><a class="docs-heading-anchor" href="#Pointer-types">Pointer types</a><a id="Pointer-types-1"></a><a class="docs-heading-anchor-permalink" href="#Pointer-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PointerType" href="#LLVM.PointerType"><code>LLVM.PointerType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.PointerType <: LLVMType</code></pre><p>A pointer type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L256-L260">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.addrspace" href="#LLVM.addrspace"><code>LLVM.addrspace</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">addrspace(ptrtyp::LLVM.PointerType)</code></pre><p>Get the address space of the given pointer type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L307-L311">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.is_opaque" href="#LLVM.is_opaque"><code>LLVM.is_opaque</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">is_opaque(ptrtyp::LLVM.PointerType)</code></pre><p>Check whether the given pointer type is opaque.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L300-L304">source</a></section></article><h2 id="Array-types"><a class="docs-heading-anchor" href="#Array-types">Array types</a><a id="Array-types-1"></a><a class="docs-heading-anchor-permalink" href="#Array-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ArrayType" href="#LLVM.ArrayType"><code>LLVM.ArrayType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.ArrayType <: LLVMType</code></pre><p>An array type, representing a fixed-size array of identically-typed elements.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L317-L321">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.length-Tuple{LLVM.ArrayType}" href="#Base.length-Tuple{LLVM.ArrayType}"><code>Base.length</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">length(arrtyp::LLVM.ArrayType)</code></pre><p>Get the length of the given array type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L338-L342">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.isempty-Tuple{LLVM.ArrayType}" href="#Base.isempty-Tuple{LLVM.ArrayType}"><code>Base.isempty</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isempty(arrtyp::LLVM.ArrayType)</code></pre><p>Check whether the given array type is empty.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L345-L349">source</a></section></article><h2 id="Vector-types"><a class="docs-heading-anchor" href="#Vector-types">Vector types</a><a id="Vector-types-1"></a><a class="docs-heading-anchor-permalink" href="#Vector-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.VectorType" href="#LLVM.VectorType"><code>LLVM.VectorType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.VectorType <: LLVMType</code></pre><p>A vector type, representing a fixed-size vector of identically-typed elements. Typically used for SIMD operations.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L355-L360">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.length-Tuple{LLVM.VectorType}" href="#Base.length-Tuple{LLVM.VectorType}"><code>Base.length</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">length(vectyp::LLVM.VectorType)</code></pre><p>Get the length of the given vector type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L377-L381">source</a></section></article><h2 id="Structure-types"><a class="docs-heading-anchor" href="#Structure-types">Structure types</a><a id="Structure-types-1"></a><a class="docs-heading-anchor-permalink" href="#Structure-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.StructType" href="#LLVM.StructType"><code>LLVM.StructType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.StructType <: LLVMType</code></pre><p>A structure type, representing a collection of named fields of potentially different types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L389-L393">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{LLVM.StructType}" href="#LLVM.name-Tuple{LLVM.StructType}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(structtyp::StructType)</code></pre><p>Get the name of the given structure type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L422-L426">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ispacked" href="#LLVM.ispacked"><code>LLVM.ispacked</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ispacked(structtyp::LLVM.StructType)</code></pre><p>Check whether the given structure type is packed.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L432-L436">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isopaque" href="#LLVM.isopaque"><code>LLVM.isopaque</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isopaque(structtyp::LLVM.StructType)</code></pre><p>Check whether the given structure type is opaque.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L439-L443">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.elements!" href="#LLVM.elements!"><code>LLVM.elements!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">elements!(structtyp::LLVM.StructType, elems::LLVMType[]; packed=false)</code></pre><p>Set the elements of the given structure type to <code>elems</code>. The <code>packed</code> argument indicates whether the structure should be packed, i.e., without padding between fields.</p><p>See also: <a href="#LLVM.elements"><code>elements</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L446-L453">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.elements" href="#LLVM.elements"><code>LLVM.elements</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">elements(structtyp::LLVM.StructType)</code></pre><p>Get the elements of the given structure type.</p><p>See also: <a href="#LLVM.elements!"><code>elements!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L468-L474">source</a></section></article><h2 id="Other-types"><a class="docs-heading-anchor" href="#Other-types">Other types</a><a id="Other-types-1"></a><a class="docs-heading-anchor-permalink" href="#Other-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.VoidType" href="#LLVM.VoidType"><code>LLVM.VoidType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.VoidType <: LLVMType</code></pre><p>A void type, representing the absence of a value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L502-L506">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.LabelType" href="#LLVM.LabelType"><code>LLVM.LabelType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.LabelType <: LLVMType</code></pre><p>A label type, representing a code label.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L519-L523">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MetadataType" href="#LLVM.MetadataType"><code>LLVM.MetadataType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.MetadataType <: LLVMType</code></pre><p>A metadata type, representing a metadata value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L536-L540">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.TokenType" href="#LLVM.TokenType"><code>LLVM.TokenType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.TokenType <: LLVMType</code></pre><p>A token type, representing a token value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L548-L552">source</a></section></article><h2 id="Type-iteration"><a class="docs-heading-anchor" href="#Type-iteration">Type iteration</a><a id="Type-iteration-1"></a><a class="docs-heading-anchor-permalink" href="#Type-iteration" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.types" href="#LLVM.types"><code>LLVM.types</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">types(ctx::LLVM.Context)</code></pre><p>Get a dictionary of all types in the given context.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/type.jl#L574-L578">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../essentials/">« Essentials</a><a class="docs-footer-nextpage" href="../values/">Values »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Types · LLVM.jl</title><meta name="title" content="Types · LLVM.jl"/><meta property="og:title" content="Types · LLVM.jl"/><meta property="twitter:title" content="Types · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li class="is-active"><a class="tocitem" href>Types</a><ul class="internal"><li><a class="tocitem" href="#Integer-types"><span>Integer types</span></a></li><li><a class="tocitem" href="#Floating-point-types"><span>Floating-point types</span></a></li><li><a class="tocitem" href="#Function-types"><span>Function types</span></a></li><li><a class="tocitem" href="#Pointer-types"><span>Pointer types</span></a></li><li><a class="tocitem" href="#Array-types"><span>Array types</span></a></li><li><a class="tocitem" href="#Vector-types"><span>Vector types</span></a></li><li><a class="tocitem" href="#Structure-types"><span>Structure types</span></a></li><li><a class="tocitem" href="#Other-types"><span>Other types</span></a></li><li><a class="tocitem" href="#Type-iteration"><span>Type iteration</span></a></li></ul></li><li><a class="tocitem" href="../values/">Values</a></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Types</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Types</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/types.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Types"><a class="docs-heading-anchor" href="#Types">Types</a><a id="Types-1"></a><a class="docs-heading-anchor-permalink" href="#Types" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.LLVMType" href="#LLVM.LLVMType"><code>LLVM.LLVMType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVMType</code></pre><p>Abstract supertype for all LLVM types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.issized" href="#LLVM.issized"><code>LLVM.issized</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">issized(typ::LLVMType)</code></pre><p>Return true if it makes sense to take the size of this type.</p><p>Note that this does not mean that it's possible to call <code>sizeof</code> on this type, as LLVM types sizes can only queried given a target data layout.</p><p>See also: <a href="../codegen/#Base.sizeof-Tuple{DataLayout, LLVMType}"><code>sizeof(::DataLayout, ::LLVMType)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L52-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{LLVMType}" href="#LLVM.context-Tuple{LLVMType}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(typ::LLVMType)</code></pre><p>Returns the context in which the given type was created.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L64-L68">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.eltype-Tuple{LLVMType}" href="#Base.eltype-Tuple{LLVMType}"><code>Base.eltype</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">eltype(typ::LLVMType)</code></pre><p>Get the element type of the given type, if supported.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L13-L17">source</a></section></article><h2 id="Integer-types"><a class="docs-heading-anchor" href="#Integer-types">Integer types</a><a id="Integer-types-1"></a><a class="docs-heading-anchor-permalink" href="#Integer-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.IntegerType" href="#LLVM.IntegerType"><code>LLVM.IntegerType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntegerType <: LLVMType</code></pre><p>Type representing arbitrary bit width integers.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L88-L92">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.IntType" href="#LLVM.IntType"><code>LLVM.IntType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.IntType(bits::Integer)</code></pre><p>Create an integer type with the given <code>bits</code> width.</p><p>Short-hand constructors are available for common widths: <code>LLVM.Int1Type</code>, <code>LLVM.Int8Type</code>, <code>LLVM.Int16Type</code>, <code>LLVM.Int32Type</code>, <code>LLVM.Int64Type</code>, and <code>LLVM.Int128Type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L98-L105">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.width" href="#LLVM.width"><code>LLVM.width</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">width(inttyp::LLVM.IntegerType)</code></pre><p>Get the bit width of the given integer type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L117-L121">source</a></section></article><h2 id="Floating-point-types"><a class="docs-heading-anchor" href="#Floating-point-types">Floating-point types</a><a id="Floating-point-types-1"></a><a class="docs-heading-anchor-permalink" href="#Floating-point-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.HalfType" href="#LLVM.HalfType"><code>LLVM.HalfType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.HalfType()</code></pre><p>Create a 16-bit floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L148-L152">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.BFloatType" href="#LLVM.BFloatType"><code>LLVM.BFloatType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.BFloatType()</code></pre><p>Create a 16-bit “brain” floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L155-L159">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.FloatType" href="#LLVM.FloatType"><code>LLVM.FloatType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.FloatType()</code></pre><p>Create a 32-bit floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L162-L166">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.DoubleType" href="#LLVM.DoubleType"><code>LLVM.DoubleType</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.DoubleType()</code></pre><p>Create a 64-bit floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L169-L173">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.FP128Type" href="#LLVM.FP128Type"><code>LLVM.FP128Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.FP128Type()</code></pre><p>Create a 128-bit floating-point type, with a 113-bit significand.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L176-L180">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.X86FP80Type" href="#LLVM.X86FP80Type"><code>LLVM.X86FP80Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.X86FP80Type()</code></pre><p>Create a 80-bit, X87 floating-point type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L183-L187">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PPCFP128Type" href="#LLVM.PPCFP128Type"><code>LLVM.PPCFP128Type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.PPCFP128Type()</code></pre><p>Create a 128-bit floating-point type, consisting of two 64-bits.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L190-L194">source</a></section></article><h2 id="Function-types"><a class="docs-heading-anchor" href="#Function-types">Function types</a><a id="Function-types-1"></a><a class="docs-heading-anchor-permalink" href="#Function-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.FunctionType" href="#LLVM.FunctionType"><code>LLVM.FunctionType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.FunctionType <: LLVMType</code></pre><p>A function type, representing a function signature.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L202-L206">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isvararg" href="#LLVM.isvararg"><code>LLVM.isvararg</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isvararg(ft::LLVM.FunctionType)</code></pre><p>Check whether the given function type is variadic.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L225-L229">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.return_type" href="#LLVM.return_type"><code>LLVM.return_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">return_type(ft::LLVM.FunctionType)</code></pre><p>Get the return type of the given function type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L232-L236">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parameters-Tuple{LLVM.FunctionType}" href="#LLVM.parameters-Tuple{LLVM.FunctionType}"><code>LLVM.parameters</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parameters(ft::LLVM.FunctionType)</code></pre><p>Get the parameter types of the given function type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L239-L243">source</a></section></article><h2 id="Pointer-types"><a class="docs-heading-anchor" href="#Pointer-types">Pointer types</a><a id="Pointer-types-1"></a><a class="docs-heading-anchor-permalink" href="#Pointer-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PointerType" href="#LLVM.PointerType"><code>LLVM.PointerType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.PointerType <: LLVMType</code></pre><p>A pointer type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L256-L260">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.addrspace" href="#LLVM.addrspace"><code>LLVM.addrspace</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">addrspace(ptrtyp::LLVM.PointerType)</code></pre><p>Get the address space of the given pointer type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L307-L311">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.is_opaque" href="#LLVM.is_opaque"><code>LLVM.is_opaque</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">is_opaque(ptrtyp::LLVM.PointerType)</code></pre><p>Check whether the given pointer type is opaque.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L300-L304">source</a></section></article><h2 id="Array-types"><a class="docs-heading-anchor" href="#Array-types">Array types</a><a id="Array-types-1"></a><a class="docs-heading-anchor-permalink" href="#Array-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ArrayType" href="#LLVM.ArrayType"><code>LLVM.ArrayType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.ArrayType <: LLVMType</code></pre><p>An array type, representing a fixed-size array of identically-typed elements.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L317-L321">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.length-Tuple{LLVM.ArrayType}" href="#Base.length-Tuple{LLVM.ArrayType}"><code>Base.length</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">length(arrtyp::LLVM.ArrayType)</code></pre><p>Get the length of the given array type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L338-L342">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.isempty-Tuple{LLVM.ArrayType}" href="#Base.isempty-Tuple{LLVM.ArrayType}"><code>Base.isempty</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isempty(arrtyp::LLVM.ArrayType)</code></pre><p>Check whether the given array type is empty.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L345-L349">source</a></section></article><h2 id="Vector-types"><a class="docs-heading-anchor" href="#Vector-types">Vector types</a><a id="Vector-types-1"></a><a class="docs-heading-anchor-permalink" href="#Vector-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.VectorType" href="#LLVM.VectorType"><code>LLVM.VectorType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.VectorType <: LLVMType</code></pre><p>A vector type, representing a fixed-size vector of identically-typed elements. Typically used for SIMD operations.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L355-L360">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.length-Tuple{LLVM.VectorType}" href="#Base.length-Tuple{LLVM.VectorType}"><code>Base.length</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">length(vectyp::LLVM.VectorType)</code></pre><p>Get the length of the given vector type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L377-L381">source</a></section></article><h2 id="Structure-types"><a class="docs-heading-anchor" href="#Structure-types">Structure types</a><a id="Structure-types-1"></a><a class="docs-heading-anchor-permalink" href="#Structure-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.StructType" href="#LLVM.StructType"><code>LLVM.StructType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.StructType <: LLVMType</code></pre><p>A structure type, representing a collection of named fields of potentially different types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L389-L393">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{LLVM.StructType}" href="#LLVM.name-Tuple{LLVM.StructType}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(structtyp::StructType)</code></pre><p>Get the name of the given structure type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L422-L426">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ispacked" href="#LLVM.ispacked"><code>LLVM.ispacked</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ispacked(structtyp::LLVM.StructType)</code></pre><p>Check whether the given structure type is packed.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L432-L436">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isopaque" href="#LLVM.isopaque"><code>LLVM.isopaque</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isopaque(structtyp::LLVM.StructType)</code></pre><p>Check whether the given structure type is opaque.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L439-L443">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.elements!" href="#LLVM.elements!"><code>LLVM.elements!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">elements!(structtyp::LLVM.StructType, elems::LLVMType[]; packed=false)</code></pre><p>Set the elements of the given structure type to <code>elems</code>. The <code>packed</code> argument indicates whether the structure should be packed, i.e., without padding between fields.</p><p>See also: <a href="#LLVM.elements"><code>elements</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L446-L453">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.elements" href="#LLVM.elements"><code>LLVM.elements</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">elements(structtyp::LLVM.StructType)</code></pre><p>Get the elements of the given structure type.</p><p>See also: <a href="#LLVM.elements!"><code>elements!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L468-L474">source</a></section></article><h2 id="Other-types"><a class="docs-heading-anchor" href="#Other-types">Other types</a><a id="Other-types-1"></a><a class="docs-heading-anchor-permalink" href="#Other-types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.VoidType" href="#LLVM.VoidType"><code>LLVM.VoidType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.VoidType <: LLVMType</code></pre><p>A void type, representing the absence of a value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L502-L506">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.LabelType" href="#LLVM.LabelType"><code>LLVM.LabelType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.LabelType <: LLVMType</code></pre><p>A label type, representing a code label.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L519-L523">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.MetadataType" href="#LLVM.MetadataType"><code>LLVM.MetadataType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.MetadataType <: LLVMType</code></pre><p>A metadata type, representing a metadata value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L536-L540">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.TokenType" href="#LLVM.TokenType"><code>LLVM.TokenType</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.TokenType <: LLVMType</code></pre><p>A token type, representing a token value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L548-L552">source</a></section></article><h2 id="Type-iteration"><a class="docs-heading-anchor" href="#Type-iteration">Type iteration</a><a id="Type-iteration-1"></a><a class="docs-heading-anchor-permalink" href="#Type-iteration" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.types" href="#LLVM.types"><code>LLVM.types</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">types(ctx::LLVM.Context)</code></pre><p>Get a dictionary of all types in the given context.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/type.jl#L574-L578">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../essentials/">« Essentials</a><a class="docs-footer-nextpage" href="../values/">Values »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/lib/values/index.html b/dev/lib/values/index.html index 70e354c8..bba2e0c7 100644 --- a/dev/lib/values/index.html +++ b/dev/lib/values/index.html @@ -1,2 +1,2 @@ <!DOCTYPE html> -<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Values · LLVM.jl</title><meta name="title" content="Values · LLVM.jl"/><meta property="og:title" content="Values · LLVM.jl"/><meta property="twitter:title" content="Values · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li class="is-active"><a class="tocitem" href>Values</a><ul class="internal"><li><a class="tocitem" href="#General-APIs"><span>General APIs</span></a></li><li><a class="tocitem" href="#User-values"><span>User values</span></a></li><li><a class="tocitem" href="#Constant-values"><span>Constant values</span></a></li><li><a class="tocitem" href="#Global-values"><span>Global values</span></a></li><li><a class="tocitem" href="#Uses"><span>Uses</span></a></li></ul></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Values</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Values</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/values.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Values"><a class="docs-heading-anchor" href="#Values">Values</a><a id="Values-1"></a><a class="docs-heading-anchor-permalink" href="#Values" title="Permalink"></a></h1><h2 id="General-APIs"><a class="docs-heading-anchor" href="#General-APIs">General APIs</a><a id="General-APIs-1"></a><a class="docs-heading-anchor-permalink" href="#General-APIs" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Value" href="#LLVM.Value"><code>LLVM.Value</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Value</code></pre><p>Abstract type representing an LLVM value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L6-L10">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.value_type" href="#LLVM.value_type"><code>LLVM.value_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">value_type(val::Value)</code></pre><p>Get the type of the given value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L49-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{Value}" href="#LLVM.context-Tuple{Value}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(val::LLVM.Value)</code></pre><p>Return the context in which the given value was created.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L110-L114">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{Value}" href="#LLVM.name-Tuple{Value}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(val::Value)</code></pre><p>Get the name of the given value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L59-L63">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name!-Tuple{Value, String}" href="#LLVM.name!-Tuple{Value, String}"><code>LLVM.name!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name!(val::Value, name::String)</code></pre><p>Set the name of the given value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L66-L70">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isconstant-Tuple{Value}" href="#LLVM.isconstant-Tuple{Value}"><code>LLVM.isconstant</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isconstant(val::LLVM.Value)</code></pre><p>Check if the given value is a constant value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L89-L93">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isundef" href="#LLVM.isundef"><code>LLVM.isundef</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isundef(val::LLVM.Value)</code></pre><p>Check if the given value is an undef value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L96-L100">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ispoison" href="#LLVM.ispoison"><code>LLVM.ispoison</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ispoison(val::LLVM.Value)</code></pre><p>Check if the given value is a poison value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L103-L107">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isnull" href="#LLVM.isnull"><code>LLVM.isnull</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isnull(val::LLVM.Value)</code></pre><p>Check if the given value is a null constant.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L35-L39">source</a></section></article><h2 id="User-values"><a class="docs-heading-anchor" href="#User-values">User values</a><a id="User-values-1"></a><a class="docs-heading-anchor-permalink" href="#User-values" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.User" href="#LLVM.User"><code>LLVM.User</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.User <: LLVM.Value</code></pre><p>A value that uses other values.</p><p>See also: <a href="../metadata/#LLVM.operands-Tuple{MDNode}"><code>operands</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/user.jl#L3-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.operands-Tuple{LLVM.User}" href="#LLVM.operands-Tuple{LLVM.User}"><code>LLVM.operands</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">operands(user::LLVM.User)</code></pre><p>Get an iterator over the operands of the given user.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/user.jl#L20-L24">source</a></section></article><h2 id="Constant-values"><a class="docs-heading-anchor" href="#Constant-values">Constant values</a><a id="Constant-values-1"></a><a class="docs-heading-anchor-permalink" href="#Constant-values" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Constant" href="#LLVM.Constant"><code>LLVM.Constant</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Constant <: LLVM.User</code></pre><p>Abstract supertype for all constant values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.null" href="#LLVM.null"><code>LLVM.null</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">null(typ::LLVMType)</code></pre><p>Create a null constant of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L21-L25">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.all_ones" href="#LLVM.all_ones"><code>LLVM.all_ones</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">all_ones(typ::LLVMType)</code></pre><p>Create a constant with all bits set to one of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L28-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PointerNull" href="#LLVM.PointerNull"><code>LLVM.PointerNull</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">PointerNull <: LLVM.ConstantData</code></pre><p>A null pointer constant.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L51-L55">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.UndefValue" href="#LLVM.UndefValue"><code>LLVM.UndefValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">UndefValue <: LLVM.ConstantData</code></pre><p>An undefined constant value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PoisonValue" href="#LLVM.PoisonValue"><code>LLVM.PoisonValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">PoisonValue <: LLVM.ConstantData</code></pre><p>A poison constant value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L87-L91">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantInt" href="#LLVM.ConstantInt"><code>LLVM.ConstantInt</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantInt <: LLVM.ConstantData</code></pre><p>A constant integer value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L105-L109">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Tuple{Type, ConstantInt}" href="#Base.convert-Tuple{Type, ConstantInt}"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{<:Integer}, val::ConstantInt)</code></pre><p>Convert a constant integer value back to a Julia integer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L157-L161">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantFP" href="#LLVM.ConstantFP"><code>LLVM.ConstantFP</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantFP <: LLVM.ConstantData</code></pre><p>A constant floating point value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L174-L178">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{T}, ConstantFP}} where T<:AbstractFloat" href="#Base.convert-Union{Tuple{T}, Tuple{Type{T}, ConstantFP}} where T<:AbstractFloat"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{<:AbstractFloat}, val::ConstantFP)</code></pre><p>Convert a constant floating point value back to a Julia floating point number.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L203-L207">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantStruct" href="#LLVM.ConstantStruct"><code>LLVM.ConstantStruct</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantStruct <: LLVM.ConstantAggregate</code></pre><p>A constant struct of values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L447-L451">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantDataArray" href="#LLVM.ConstantDataArray"><code>LLVM.ConstantDataArray</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantDataArray <: LLVM.ConstantDataSequential</code></pre><p>A constant array of simple data values, i.e., whose element type is a simple 1/2/4/8-byte integer or half/bfloat/float/double, and whose elements are just simple data values</p><p>See also: <a href="#LLVM.ConstantArray"><code>ConstantArray</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L248-L255">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantDataArray-Union{Tuple{T}, Tuple{LLVMType, AbstractVector{T}}} where T<:Union{AbstractFloat, Integer}" href="#LLVM.ConstantDataArray-Union{Tuple{T}, Tuple{LLVMType, AbstractVector{T}}} where T<:Union{AbstractFloat, Integer}"><code>LLVM.ConstantDataArray</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantDataArray(typ::LLVMType, data::AbstractVector)</code></pre><p>Create a constant array of simple data values of the given type and data.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The memory layout of the data array must match the expected layout of the LLVM type.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L261-L269">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantDataArray-Tuple{AbstractVector}" href="#LLVM.ConstantDataArray-Tuple{AbstractVector}"><code>LLVM.ConstantDataArray</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantDataArray(data::AbstractVector)</code></pre><p>Create a constant array of simple data values from a Julia vector.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L276-L280">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantDataVector" href="#LLVM.ConstantDataVector"><code>LLVM.ConstantDataVector</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantDataVector <: LLVM.ConstantDataSequential</code></pre><p>A constant vector of simple data values, i.e., whose element type is a simple 1/2/4/8-byte integer or half/bfloat/float/double, and whose elements are just simple data values</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L297-L302">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantArray" href="#LLVM.ConstantArray"><code>LLVM.ConstantArray</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantArray <: LLVM.ConstantAggregate</code></pre><p>A constant array of values.</p><p>This type implements the Julia array interface, so (to some extent) it can be used as a regular Julia array.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L338-L345">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantArray-Union{Tuple{N}, Tuple{LLVMType, AbstractArray{<:LLVM.Constant, N}}} where N" href="#LLVM.ConstantArray-Union{Tuple{N}, Tuple{LLVMType, AbstractArray{<:LLVM.Constant, N}}} where N"><code>LLVM.ConstantArray</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantArray(typ::LLVMType, data::AbstractArray)</code></pre><p>Create a constant array of values of the given type and data.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>When using simple data types, this constructor can also return a <a href="#LLVM.ConstantDataArray"><code>ConstantDataArray</code></a>.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L352-L361">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantArray-Tuple{AbstractArray}" href="#LLVM.ConstantArray-Tuple{AbstractArray}"><code>LLVM.ConstantArray</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantArray(data::AbstractArray)</code></pre><p>Create a constant array of values from a Julia array, using the appropriate constant type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L390-L394">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.collect-Tuple{ConstantArray}" href="#Base.collect-Tuple{ConstantArray}"><code>Base.collect</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">collect(ca::ConstantArray)</code></pre><p>Convert a constant array back to a Julia array.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L397-L401">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InlineAsm" href="#LLVM.InlineAsm"><code>LLVM.InlineAsm</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">InlineAsm <: LLVM.Constant</code></pre><p>A constant inline assembly block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L753-L757">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantExpr" href="#LLVM.ConstantExpr"><code>LLVM.ConstantExpr</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.ConstantExpr <: LLVM.Constant</code></pre><p>A constant value that is initialized with an expression using other constant values.</p><p>Constant expressions are created using <code>const_</code>-prefixed functions, which correspond to the LLVM IR instructions: <code>const_neg</code>, <code>const_not</code>, etc.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L536-L543">source</a></section></article><h2 id="Global-values"><a class="docs-heading-anchor" href="#Global-values">Global values</a><a id="Global-values-1"></a><a class="docs-heading-anchor-permalink" href="#Global-values" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GlobalValue" href="#LLVM.GlobalValue"><code>LLVM.GlobalValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.GlobalValue <: LLVM.Constant</code></pre><p>Abstract supertype for all global values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L779-L783">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.global_value_type" href="#LLVM.global_value_type"><code>LLVM.global_value_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">global_value_type(val::LLVM.GlobalValue)</code></pre><p>Get the type of the global value.</p><p>This differs from <a href="#LLVM.value_type"><code>value_type</code></a> in that it returns the type of the contained value, not the type of the global value itself which is always a pointer type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L802-L809">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parent-Tuple{GlobalValue}" href="#LLVM.parent-Tuple{GlobalValue}"><code>LLVM.parent</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parent(val::LLVM.GlobalValue)</code></pre><p>Get the parent module of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L795-L799">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isdeclaration" href="#LLVM.isdeclaration"><code>LLVM.isdeclaration</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isdeclaration(val::LLVM.GlobalValue)</code></pre><p>Check if the global value is a declaration, i.e. it does not have a definition.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L812-L816">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.linkage" href="#LLVM.linkage"><code>LLVM.linkage</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">linkage(val::LLVM.GlobalValue)</code></pre><p>Get the linkage of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L819-L823">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.linkage!" href="#LLVM.linkage!"><code>LLVM.linkage!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">linkage!(val::LLVM.GlobalValue, linkage::LLVM.LLVMLinkage)</code></pre><p>Set the linkage of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L826-L830">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.section" href="#LLVM.section"><code>LLVM.section</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">section(val::LLVM.GlobalValue)</code></pre><p>Get the section of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L834-L838">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.section!" href="#LLVM.section!"><code>LLVM.section!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">section!(val::LLVM.GlobalValue, sec::String)</code></pre><p>Set the section of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L855-L859">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.visibility" href="#LLVM.visibility"><code>LLVM.visibility</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">visibility(val::LLVM.GlobalValue)</code></pre><p>Get the visibility of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L862-L866">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.visibility!" href="#LLVM.visibility!"><code>LLVM.visibility!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">visibility!(val::LLVM.GlobalValue, viz::LLVM.LLVMVisibility)</code></pre><p>Set the visibility of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L869-L873">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dllstorage" href="#LLVM.dllstorage"><code>LLVM.dllstorage</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dllstorage(val::LLVM.GlobalValue)</code></pre><p>Get the DLL storage class of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L877-L881">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dllstorage!" href="#LLVM.dllstorage!"><code>LLVM.dllstorage!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dllstorage!(val::LLVM.GlobalValue, storage::LLVM.LLVMDLLStorageClass)</code></pre><p>Set the DLL storage class of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L884-L888">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.unnamed_addr" href="#LLVM.unnamed_addr"><code>LLVM.unnamed_addr</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">unnamed_addr(val::LLVM.GlobalValue)</code></pre><p>Check if the global value has the unnamed address flag set.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L892-L896">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.unnamed_addr!" href="#LLVM.unnamed_addr!"><code>LLVM.unnamed_addr!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">unnamed_addr!(val::LLVM.GlobalValue, flag::Bool)</code></pre><p>Set the unnamed address flag of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L899-L903">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.alignment-Tuple{GlobalValue}" href="#LLVM.alignment-Tuple{GlobalValue}"><code>LLVM.alignment</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">alignment(val::LLVM.GlobalValue)</code></pre><p>Get the alignment of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L906-L910">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.alignment!-Tuple{GlobalValue, Integer}" href="#LLVM.alignment!-Tuple{GlobalValue, Integer}"><code>LLVM.alignment!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">alignment!(val::LLVM.GlobalValue, bytes::Integer)</code></pre><p>Set the alignment of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L913-L917">source</a></section></article><h3 id="Global-variables"><a class="docs-heading-anchor" href="#Global-variables">Global variables</a><a id="Global-variables-1"></a><a class="docs-heading-anchor-permalink" href="#Global-variables" title="Permalink"></a></h3><p>Global variables are a specific kind of global values, and have additional APIs:</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GlobalVariable" href="#LLVM.GlobalVariable"><code>LLVM.GlobalVariable</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GlobalVariable <: LLVM.GlobalObject</code></pre><p>A global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L932-L936">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.erase!-Tuple{GlobalVariable}" href="#LLVM.erase!-Tuple{GlobalVariable}"><code>LLVM.erase!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">erase!(gv::GlobalVariable)</code></pre><p>Remove the global variable from its parent module and delete it.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is unsafe as it does not check if the global variable is still used elsewhere.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L952-L961">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.initializer" href="#LLVM.initializer"><code>LLVM.initializer</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">initializer(gv::GlobalVariable)</code></pre><p>Get the initializer of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L964-L968">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.initializer!" href="#LLVM.initializer!"><code>LLVM.initializer!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">initializer!(gv::GlobalVariable, val::Constant)</code></pre><p>Set the initializer of the global variable. Setting the value to <code>nothing</code> removes the current initializer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L974-L979">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isthreadlocal" href="#LLVM.isthreadlocal"><code>LLVM.isthreadlocal</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isthreadlocal(gv::GlobalVariable)</code></pre><p>Check if the global variable is thread-local.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L985-L989">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.threadlocal!" href="#LLVM.threadlocal!"><code>LLVM.threadlocal!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">threadlocal!(gv::GlobalVariable, flag::Bool)</code></pre><p>Set the thread-local flag of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L992-L996">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.threadlocalmode" href="#LLVM.threadlocalmode"><code>LLVM.threadlocalmode</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">threadlocalmode(gv::GlobalVariable)</code></pre><p>Get the thread-local mode of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L1015-L1019">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.threadlocalmode!" href="#LLVM.threadlocalmode!"><code>LLVM.threadlocalmode!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">threadlocalmode!(gv::GlobalVariable, mode::LLVM.LLVMThreadLocalMode)</code></pre><p>Set the thread-local mode of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L1022-L1026">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isconstant-Tuple{GlobalVariable}" href="#LLVM.isconstant-Tuple{GlobalVariable}"><code>LLVM.isconstant</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isconstant(gv::GlobalVariable)</code></pre><p>Check if the global variable is a global constant, i.e., its value is immutable throughout the runtime execution of the program.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L1000-L1005">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.constant!" href="#LLVM.constant!"><code>LLVM.constant!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">constant!(gv::GlobalVariable, flag::Bool)</code></pre><p>Set the constant flag of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L1008-L1012">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isextinit" href="#LLVM.isextinit"><code>LLVM.isextinit</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isextinit(gv::GlobalVariable)</code></pre><p>Check if the global variable is externally initialized.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L1029-L1033">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.extinit!" href="#LLVM.extinit!"><code>LLVM.extinit!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">extinit!(gv::GlobalVariable, flag::Bool)</code></pre><p>Set the externally initialized flag of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value/constant.jl#L1036-L1040">source</a></section></article><h2 id="Uses"><a class="docs-heading-anchor" href="#Uses">Uses</a><a id="Uses-1"></a><a class="docs-heading-anchor-permalink" href="#Uses" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.replace_uses!" href="#LLVM.replace_uses!"><code>LLVM.replace_uses!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">replace_uses!(old::LLVM.Value, new::LLVM.Value)</code></pre><p>Replace all uses of an <code>old</code> value in the IR with <code>new</code>.</p><p>This does not replace uses in metadata, which must be done separately with <a href="#LLVM.replace_metadata_uses!"><code>replace_metadata_uses!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L132-L139">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.replace_metadata_uses!" href="#LLVM.replace_metadata_uses!"><code>LLVM.replace_metadata_uses!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">replace_metadata_uses!(old::LLVM.Value, new::LLVM.Value)</code></pre><p>Replace all uses of an <code>old</code> value in metadata with <code>new</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L142-L146">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.uses" href="#LLVM.uses"><code>LLVM.uses</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">uses(val::LLVM.Value)</code></pre><p>Get an iterator over the uses of the given value.</p><p>See also: <a href="#LLVM.Use"><code>LLVM.Use</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L214-L220">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Use" href="#LLVM.Use"><code>LLVM.Use</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Use</code></pre><p>A use of a value in the IR. Knows both the user and the used value.</p><p>See also: <a href="#LLVM.user"><code>user</code></a>, <a href="#LLVM.value"><code>value</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L179-L185">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.user" href="#LLVM.user"><code>LLVM.user</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">user(use::LLVM.Use)</code></pre><p>Get the user of the given use.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L192-L196">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.value" href="#LLVM.value"><code>LLVM.value</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">value(use::LLVM.Use)</code></pre><p>Get the used value of the given use.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/b0e9f6806605a1583e7ccef4f3d2039431959a16/src/core/value.jl#L199-L203">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../types/">« Types</a><a class="docs-footer-nextpage" href="../modules/">Modules »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Values · LLVM.jl</title><meta name="title" content="Values · LLVM.jl"/><meta property="og:title" content="Values · LLVM.jl"/><meta property="twitter:title" content="Values · LLVM.jl"/><meta name="description" content="Documentation for LLVM.jl."/><meta property="og:description" content="Documentation for LLVM.jl."/><meta property="twitter:description" content="Documentation for LLVM.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">LLVM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../man/essentials/">Essentials</a></li><li><a class="tocitem" href="../../man/types/">Types</a></li><li><a class="tocitem" href="../../man/values/">Values</a></li><li><a class="tocitem" href="../../man/modules/">Modules</a></li><li><a class="tocitem" href="../../man/functions/">Functions</a></li><li><a class="tocitem" href="../../man/blocks/">Basic blocks</a></li><li><a class="tocitem" href="../../man/instructions/">Instructions</a></li><li><a class="tocitem" href="../../man/metadata/">Metadata</a></li><li><a class="tocitem" href="../../man/analyses/">Analyses</a></li><li><a class="tocitem" href="../../man/transforms/">Transforms</a></li><li><a class="tocitem" href="../../man/codegen/">Code generation</a></li><li><a class="tocitem" href="../../man/execution/">Execution</a></li><li><a class="tocitem" href="../../man/interop/">Julia integration</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../essentials/">Essentials</a></li><li><a class="tocitem" href="../types/">Types</a></li><li class="is-active"><a class="tocitem" href>Values</a><ul class="internal"><li><a class="tocitem" href="#General-APIs"><span>General APIs</span></a></li><li><a class="tocitem" href="#User-values"><span>User values</span></a></li><li><a class="tocitem" href="#Constant-values"><span>Constant values</span></a></li><li><a class="tocitem" href="#Global-values"><span>Global values</span></a></li><li><a class="tocitem" href="#Uses"><span>Uses</span></a></li></ul></li><li><a class="tocitem" href="../modules/">Modules</a></li><li><a class="tocitem" href="../functions/">Functions</a></li><li><a class="tocitem" href="../blocks/">Basic blocks</a></li><li><a class="tocitem" href="../instructions/">Instructions</a></li><li><a class="tocitem" href="../metadata/">Metadata</a></li><li><a class="tocitem" href="../analyses/">Analyses</a></li><li><a class="tocitem" href="../transforms/">Transforms</a></li><li><a class="tocitem" href="../codegen/">Code generation</a></li><li><a class="tocitem" href="../execution/">Execution</a></li><li><a class="tocitem" href="../interop/">Julia integration</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li class="is-active"><a href>Values</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Values</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/maleadt/LLVM.jl/blob/master/docs/src/lib/values.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Values"><a class="docs-heading-anchor" href="#Values">Values</a><a id="Values-1"></a><a class="docs-heading-anchor-permalink" href="#Values" title="Permalink"></a></h1><h2 id="General-APIs"><a class="docs-heading-anchor" href="#General-APIs">General APIs</a><a id="General-APIs-1"></a><a class="docs-heading-anchor-permalink" href="#General-APIs" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Value" href="#LLVM.Value"><code>LLVM.Value</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Value</code></pre><p>Abstract type representing an LLVM value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L6-L10">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.value_type" href="#LLVM.value_type"><code>LLVM.value_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">value_type(val::Value)</code></pre><p>Get the type of the given value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L49-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.context-Tuple{Value}" href="#LLVM.context-Tuple{Value}"><code>LLVM.context</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">context(val::LLVM.Value)</code></pre><p>Return the context in which the given value was created.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L110-L114">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name-Tuple{Value}" href="#LLVM.name-Tuple{Value}"><code>LLVM.name</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name(val::Value)</code></pre><p>Get the name of the given value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L59-L63">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.name!-Tuple{Value, String}" href="#LLVM.name!-Tuple{Value, String}"><code>LLVM.name!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">name!(val::Value, name::String)</code></pre><p>Set the name of the given value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L66-L70">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isconstant-Tuple{Value}" href="#LLVM.isconstant-Tuple{Value}"><code>LLVM.isconstant</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isconstant(val::LLVM.Value)</code></pre><p>Check if the given value is a constant value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L89-L93">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isundef" href="#LLVM.isundef"><code>LLVM.isundef</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isundef(val::LLVM.Value)</code></pre><p>Check if the given value is an undef value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L96-L100">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ispoison" href="#LLVM.ispoison"><code>LLVM.ispoison</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ispoison(val::LLVM.Value)</code></pre><p>Check if the given value is a poison value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L103-L107">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isnull" href="#LLVM.isnull"><code>LLVM.isnull</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isnull(val::LLVM.Value)</code></pre><p>Check if the given value is a null constant.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L35-L39">source</a></section></article><h2 id="User-values"><a class="docs-heading-anchor" href="#User-values">User values</a><a id="User-values-1"></a><a class="docs-heading-anchor-permalink" href="#User-values" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.User" href="#LLVM.User"><code>LLVM.User</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.User <: LLVM.Value</code></pre><p>A value that uses other values.</p><p>See also: <a href="../metadata/#LLVM.operands-Tuple{MDNode}"><code>operands</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/user.jl#L3-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.operands-Tuple{LLVM.User}" href="#LLVM.operands-Tuple{LLVM.User}"><code>LLVM.operands</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">operands(user::LLVM.User)</code></pre><p>Get an iterator over the operands of the given user.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/user.jl#L20-L24">source</a></section></article><h2 id="Constant-values"><a class="docs-heading-anchor" href="#Constant-values">Constant values</a><a id="Constant-values-1"></a><a class="docs-heading-anchor-permalink" href="#Constant-values" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Constant" href="#LLVM.Constant"><code>LLVM.Constant</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Constant <: LLVM.User</code></pre><p>Abstract supertype for all constant values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.null" href="#LLVM.null"><code>LLVM.null</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">null(typ::LLVMType)</code></pre><p>Create a null constant of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L21-L25">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.all_ones" href="#LLVM.all_ones"><code>LLVM.all_ones</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">all_ones(typ::LLVMType)</code></pre><p>Create a constant with all bits set to one of the given type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L28-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PointerNull" href="#LLVM.PointerNull"><code>LLVM.PointerNull</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">PointerNull <: LLVM.ConstantData</code></pre><p>A null pointer constant.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L51-L55">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.UndefValue" href="#LLVM.UndefValue"><code>LLVM.UndefValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">UndefValue <: LLVM.ConstantData</code></pre><p>An undefined constant value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.PoisonValue" href="#LLVM.PoisonValue"><code>LLVM.PoisonValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">PoisonValue <: LLVM.ConstantData</code></pre><p>A poison constant value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L87-L91">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantInt" href="#LLVM.ConstantInt"><code>LLVM.ConstantInt</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantInt <: LLVM.ConstantData</code></pre><p>A constant integer value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L105-L109">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Tuple{Type, ConstantInt}" href="#Base.convert-Tuple{Type, ConstantInt}"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{<:Integer}, val::ConstantInt)</code></pre><p>Convert a constant integer value back to a Julia integer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L157-L161">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantFP" href="#LLVM.ConstantFP"><code>LLVM.ConstantFP</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantFP <: LLVM.ConstantData</code></pre><p>A constant floating point value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L174-L178">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.convert-Union{Tuple{T}, Tuple{Type{T}, ConstantFP}} where T<:AbstractFloat" href="#Base.convert-Union{Tuple{T}, Tuple{Type{T}, ConstantFP}} where T<:AbstractFloat"><code>Base.convert</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert(::Type{<:AbstractFloat}, val::ConstantFP)</code></pre><p>Convert a constant floating point value back to a Julia floating point number.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L203-L207">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantStruct" href="#LLVM.ConstantStruct"><code>LLVM.ConstantStruct</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantStruct <: LLVM.ConstantAggregate</code></pre><p>A constant struct of values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L447-L451">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantDataArray" href="#LLVM.ConstantDataArray"><code>LLVM.ConstantDataArray</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantDataArray <: LLVM.ConstantDataSequential</code></pre><p>A constant array of simple data values, i.e., whose element type is a simple 1/2/4/8-byte integer or half/bfloat/float/double, and whose elements are just simple data values</p><p>See also: <a href="#LLVM.ConstantArray"><code>ConstantArray</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L248-L255">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantDataArray-Union{Tuple{T}, Tuple{LLVMType, AbstractVector{T}}} where T<:Union{AbstractFloat, Integer}" href="#LLVM.ConstantDataArray-Union{Tuple{T}, Tuple{LLVMType, AbstractVector{T}}} where T<:Union{AbstractFloat, Integer}"><code>LLVM.ConstantDataArray</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantDataArray(typ::LLVMType, data::AbstractVector)</code></pre><p>Create a constant array of simple data values of the given type and data.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The memory layout of the data array must match the expected layout of the LLVM type.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L261-L269">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantDataArray-Tuple{AbstractVector}" href="#LLVM.ConstantDataArray-Tuple{AbstractVector}"><code>LLVM.ConstantDataArray</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantDataArray(data::AbstractVector)</code></pre><p>Create a constant array of simple data values from a Julia vector.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L276-L280">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantDataVector" href="#LLVM.ConstantDataVector"><code>LLVM.ConstantDataVector</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantDataVector <: LLVM.ConstantDataSequential</code></pre><p>A constant vector of simple data values, i.e., whose element type is a simple 1/2/4/8-byte integer or half/bfloat/float/double, and whose elements are just simple data values</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L297-L302">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantArray" href="#LLVM.ConstantArray"><code>LLVM.ConstantArray</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantArray <: LLVM.ConstantAggregate</code></pre><p>A constant array of values.</p><p>This type implements the Julia array interface, so (to some extent) it can be used as a regular Julia array.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L338-L345">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantArray-Union{Tuple{N}, Tuple{LLVMType, AbstractArray{<:LLVM.Constant, N}}} where N" href="#LLVM.ConstantArray-Union{Tuple{N}, Tuple{LLVMType, AbstractArray{<:LLVM.Constant, N}}} where N"><code>LLVM.ConstantArray</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantArray(typ::LLVMType, data::AbstractArray)</code></pre><p>Create a constant array of values of the given type and data.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>When using simple data types, this constructor can also return a <a href="#LLVM.ConstantDataArray"><code>ConstantDataArray</code></a>.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L352-L361">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantArray-Tuple{AbstractArray}" href="#LLVM.ConstantArray-Tuple{AbstractArray}"><code>LLVM.ConstantArray</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ConstantArray(data::AbstractArray)</code></pre><p>Create a constant array of values from a Julia array, using the appropriate constant type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L390-L394">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.collect-Tuple{ConstantArray}" href="#Base.collect-Tuple{ConstantArray}"><code>Base.collect</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">collect(ca::ConstantArray)</code></pre><p>Convert a constant array back to a Julia array.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L397-L401">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.InlineAsm" href="#LLVM.InlineAsm"><code>LLVM.InlineAsm</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">InlineAsm <: LLVM.Constant</code></pre><p>A constant inline assembly block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L753-L757">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.ConstantExpr" href="#LLVM.ConstantExpr"><code>LLVM.ConstantExpr</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.ConstantExpr <: LLVM.Constant</code></pre><p>A constant value that is initialized with an expression using other constant values.</p><p>Constant expressions are created using <code>const_</code>-prefixed functions, which correspond to the LLVM IR instructions: <code>const_neg</code>, <code>const_not</code>, etc.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L536-L543">source</a></section></article><h2 id="Global-values"><a class="docs-heading-anchor" href="#Global-values">Global values</a><a id="Global-values-1"></a><a class="docs-heading-anchor-permalink" href="#Global-values" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GlobalValue" href="#LLVM.GlobalValue"><code>LLVM.GlobalValue</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.GlobalValue <: LLVM.Constant</code></pre><p>Abstract supertype for all global values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L779-L783">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.global_value_type" href="#LLVM.global_value_type"><code>LLVM.global_value_type</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">global_value_type(val::LLVM.GlobalValue)</code></pre><p>Get the type of the global value.</p><p>This differs from <a href="#LLVM.value_type"><code>value_type</code></a> in that it returns the type of the contained value, not the type of the global value itself which is always a pointer type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L802-L809">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.parent-Tuple{GlobalValue}" href="#LLVM.parent-Tuple{GlobalValue}"><code>LLVM.parent</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parent(val::LLVM.GlobalValue)</code></pre><p>Get the parent module of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L795-L799">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isdeclaration" href="#LLVM.isdeclaration"><code>LLVM.isdeclaration</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isdeclaration(val::LLVM.GlobalValue)</code></pre><p>Check if the global value is a declaration, i.e. it does not have a definition.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L812-L816">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.linkage" href="#LLVM.linkage"><code>LLVM.linkage</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">linkage(val::LLVM.GlobalValue)</code></pre><p>Get the linkage of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L819-L823">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.linkage!" href="#LLVM.linkage!"><code>LLVM.linkage!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">linkage!(val::LLVM.GlobalValue, linkage::LLVM.LLVMLinkage)</code></pre><p>Set the linkage of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L826-L830">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.section" href="#LLVM.section"><code>LLVM.section</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">section(val::LLVM.GlobalValue)</code></pre><p>Get the section of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L834-L838">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.section!" href="#LLVM.section!"><code>LLVM.section!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">section!(val::LLVM.GlobalValue, sec::String)</code></pre><p>Set the section of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L855-L859">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.visibility" href="#LLVM.visibility"><code>LLVM.visibility</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">visibility(val::LLVM.GlobalValue)</code></pre><p>Get the visibility of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L862-L866">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.visibility!" href="#LLVM.visibility!"><code>LLVM.visibility!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">visibility!(val::LLVM.GlobalValue, viz::LLVM.LLVMVisibility)</code></pre><p>Set the visibility of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L869-L873">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dllstorage" href="#LLVM.dllstorage"><code>LLVM.dllstorage</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dllstorage(val::LLVM.GlobalValue)</code></pre><p>Get the DLL storage class of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L877-L881">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.dllstorage!" href="#LLVM.dllstorage!"><code>LLVM.dllstorage!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dllstorage!(val::LLVM.GlobalValue, storage::LLVM.LLVMDLLStorageClass)</code></pre><p>Set the DLL storage class of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L884-L888">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.unnamed_addr" href="#LLVM.unnamed_addr"><code>LLVM.unnamed_addr</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">unnamed_addr(val::LLVM.GlobalValue)</code></pre><p>Check if the global value has the unnamed address flag set.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L892-L896">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.unnamed_addr!" href="#LLVM.unnamed_addr!"><code>LLVM.unnamed_addr!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">unnamed_addr!(val::LLVM.GlobalValue, flag::Bool)</code></pre><p>Set the unnamed address flag of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L899-L903">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.alignment-Tuple{GlobalValue}" href="#LLVM.alignment-Tuple{GlobalValue}"><code>LLVM.alignment</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">alignment(val::LLVM.GlobalValue)</code></pre><p>Get the alignment of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L906-L910">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.alignment!-Tuple{GlobalValue, Integer}" href="#LLVM.alignment!-Tuple{GlobalValue, Integer}"><code>LLVM.alignment!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">alignment!(val::LLVM.GlobalValue, bytes::Integer)</code></pre><p>Set the alignment of the global value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L913-L917">source</a></section></article><h3 id="Global-variables"><a class="docs-heading-anchor" href="#Global-variables">Global variables</a><a id="Global-variables-1"></a><a class="docs-heading-anchor-permalink" href="#Global-variables" title="Permalink"></a></h3><p>Global variables are a specific kind of global values, and have additional APIs:</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.GlobalVariable" href="#LLVM.GlobalVariable"><code>LLVM.GlobalVariable</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">GlobalVariable <: LLVM.GlobalObject</code></pre><p>A global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L932-L936">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.erase!-Tuple{GlobalVariable}" href="#LLVM.erase!-Tuple{GlobalVariable}"><code>LLVM.erase!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">erase!(gv::GlobalVariable)</code></pre><p>Remove the global variable from its parent module and delete it.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is unsafe as it does not check if the global variable is still used elsewhere.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L952-L961">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.initializer" href="#LLVM.initializer"><code>LLVM.initializer</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">initializer(gv::GlobalVariable)</code></pre><p>Get the initializer of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L964-L968">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.initializer!" href="#LLVM.initializer!"><code>LLVM.initializer!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">initializer!(gv::GlobalVariable, val::Constant)</code></pre><p>Set the initializer of the global variable. Setting the value to <code>nothing</code> removes the current initializer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L974-L979">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isthreadlocal" href="#LLVM.isthreadlocal"><code>LLVM.isthreadlocal</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isthreadlocal(gv::GlobalVariable)</code></pre><p>Check if the global variable is thread-local.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L985-L989">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.threadlocal!" href="#LLVM.threadlocal!"><code>LLVM.threadlocal!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">threadlocal!(gv::GlobalVariable, flag::Bool)</code></pre><p>Set the thread-local flag of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L992-L996">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.threadlocalmode" href="#LLVM.threadlocalmode"><code>LLVM.threadlocalmode</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">threadlocalmode(gv::GlobalVariable)</code></pre><p>Get the thread-local mode of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L1015-L1019">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.threadlocalmode!" href="#LLVM.threadlocalmode!"><code>LLVM.threadlocalmode!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">threadlocalmode!(gv::GlobalVariable, mode::LLVM.LLVMThreadLocalMode)</code></pre><p>Set the thread-local mode of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L1022-L1026">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isconstant-Tuple{GlobalVariable}" href="#LLVM.isconstant-Tuple{GlobalVariable}"><code>LLVM.isconstant</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isconstant(gv::GlobalVariable)</code></pre><p>Check if the global variable is a global constant, i.e., its value is immutable throughout the runtime execution of the program.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L1000-L1005">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.constant!" href="#LLVM.constant!"><code>LLVM.constant!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">constant!(gv::GlobalVariable, flag::Bool)</code></pre><p>Set the constant flag of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L1008-L1012">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.isextinit" href="#LLVM.isextinit"><code>LLVM.isextinit</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isextinit(gv::GlobalVariable)</code></pre><p>Check if the global variable is externally initialized.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L1029-L1033">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.extinit!" href="#LLVM.extinit!"><code>LLVM.extinit!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">extinit!(gv::GlobalVariable, flag::Bool)</code></pre><p>Set the externally initialized flag of the global variable.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value/constant.jl#L1036-L1040">source</a></section></article><h2 id="Uses"><a class="docs-heading-anchor" href="#Uses">Uses</a><a id="Uses-1"></a><a class="docs-heading-anchor-permalink" href="#Uses" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.replace_uses!" href="#LLVM.replace_uses!"><code>LLVM.replace_uses!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">replace_uses!(old::LLVM.Value, new::LLVM.Value)</code></pre><p>Replace all uses of an <code>old</code> value in the IR with <code>new</code>.</p><p>This does not replace uses in metadata, which must be done separately with <a href="#LLVM.replace_metadata_uses!"><code>replace_metadata_uses!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L132-L139">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.replace_metadata_uses!" href="#LLVM.replace_metadata_uses!"><code>LLVM.replace_metadata_uses!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">replace_metadata_uses!(old::LLVM.Value, new::LLVM.Value)</code></pre><p>Replace all uses of an <code>old</code> value in metadata with <code>new</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L142-L146">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.uses" href="#LLVM.uses"><code>LLVM.uses</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">uses(val::LLVM.Value)</code></pre><p>Get an iterator over the uses of the given value.</p><p>See also: <a href="#LLVM.Use"><code>LLVM.Use</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L214-L220">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.Use" href="#LLVM.Use"><code>LLVM.Use</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">LLVM.Use</code></pre><p>A use of a value in the IR. Knows both the user and the used value.</p><p>See also: <a href="#LLVM.user"><code>user</code></a>, <a href="#LLVM.value"><code>value</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L179-L185">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.user" href="#LLVM.user"><code>LLVM.user</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">user(use::LLVM.Use)</code></pre><p>Get the user of the given use.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L192-L196">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LLVM.value" href="#LLVM.value"><code>LLVM.value</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">value(use::LLVM.Use)</code></pre><p>Get the used value of the given use.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/maleadt/LLVM.jl/blob/a1c3b217c1c9e5db4223e4e0af1754aae53d113f/src/core/value.jl#L199-L203">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../types/">« Types</a><a class="docs-footer-nextpage" href="../modules/">Modules »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/analyses/index.html b/dev/man/analyses/index.html index 48c97e74..3d0edcc9 100644 --- a/dev/man/analyses/index.html +++ b/dev/man/analyses/index.html @@ -39,4 +39,4 @@ true julia> dominates(tree, first(instructions(foo)), first(instructions(entry))) -false</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../metadata/">« Metadata</a><a class="docs-footer-nextpage" href="../transforms/">Transforms »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +false</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../metadata/">« Metadata</a><a class="docs-footer-nextpage" href="../transforms/">Transforms »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/blocks/index.html b/dev/man/blocks/index.html index a000b81f..a97a9fdb 100644 --- a/dev/man/blocks/index.html +++ b/dev/man/blocks/index.html @@ -8,4 +8,4 @@ julia> collect(instructions(bb)) 2-element Vector{Instruction}: %2 = add i64 %1, %0 - ret i64 %2</code></pre><p>In addition to the iteration interface, it is possible to move from one instruction to the previous or next one using respectively the <code>previnst</code> and <code>nextinst</code> functions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../functions/">« Functions</a><a class="docs-footer-nextpage" href="../instructions/">Instructions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> + ret i64 %2</code></pre><p>In addition to the iteration interface, it is possible to move from one instruction to the previous or next one using respectively the <code>previnst</code> and <code>nextinst</code> functions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../functions/">« Functions</a><a class="docs-footer-nextpage" href="../instructions/">Instructions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/codegen/index.html b/dev/man/codegen/index.html index 97b7078a..f3a942b6 100644 --- a/dev/man/codegen/index.html +++ b/dev/man/codegen/index.html @@ -49,4 +49,4 @@ !llvm.module.flags = !{!0, !1} !0 = !{i32 1, !"wasm-feature-mutable-globals", i32 43} -!1 = !{i32 1, !"wasm-feature-sign-ext", i32 43}</code></pre><p>The data layout object can be used to query various properties that are relevant for generating IR:</p><ul><li><code>byteorder</code></li><li><code>pointersize</code></li><li><code>intptr</code></li><li><code>sizeof</code></li><li><code>storage_size</code></li><li><code>abi_alignment</code></li><li><code>frame_alignment</code></li><li><code>preferred_alignment</code></li><li><code>element_at</code></li><li><code>offsetof</code></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transforms/">« Transforms</a><a class="docs-footer-nextpage" href="../execution/">Execution »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +!1 = !{i32 1, !"wasm-feature-sign-ext", i32 43}</code></pre><p>The data layout object can be used to query various properties that are relevant for generating IR:</p><ul><li><code>byteorder</code></li><li><code>pointersize</code></li><li><code>intptr</code></li><li><code>sizeof</code></li><li><code>storage_size</code></li><li><code>abi_alignment</code></li><li><code>frame_alignment</code></li><li><code>preferred_alignment</code></li><li><code>element_at</code></li><li><code>offsetof</code></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transforms/">« Transforms</a><a class="docs-footer-nextpage" href="../execution/">Execution »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/essentials/index.html b/dev/man/essentials/index.html index fa362373..aec36463 100644 --- a/dev/man/essentials/index.html +++ b/dev/man/essentials/index.html @@ -40,4 +40,4 @@ WARNING: An unknown instance of MemoryBuffer is being disposed of.</code></pre><p>Finally, when not properly disposing of an object, LLVM.jl will warn about the leaked object when the process exits:</p><pre><code class="language-julia-repl hljs">julia> ctx = Context(); julia> exit() -WARNING: An instance of Context was not properly disposed of.</code></pre><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-1"><a class="tag is-link" href="#citeref-1">1</a>See <a href="https://github.com/maleadt/LLVM.jl/pull/309">this issue</a> for more details.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../types/">Types »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +WARNING: An instance of Context was not properly disposed of.</code></pre><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-1"><a class="tag is-link" href="#citeref-1">1</a>See <a href="https://github.com/maleadt/LLVM.jl/pull/309">this issue</a> for more details.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../types/">Types »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/execution/index.html b/dev/man/execution/index.html index 963d23a3..bf4298e7 100644 --- a/dev/man/execution/index.html +++ b/dev/man/execution/index.html @@ -37,4 +37,4 @@ julia> ts_mod() do mod string(mod) end -"; ModuleID = 'SomeModule'\nsource_filename = \"SomeModule\"\n"</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../codegen/">« Code generation</a><a class="docs-footer-nextpage" href="../interop/">Julia integration »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +"; ModuleID = 'SomeModule'\nsource_filename = \"SomeModule\"\n"</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../codegen/">« Code generation</a><a class="docs-footer-nextpage" href="../interop/">Julia integration »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/functions/index.html b/dev/man/functions/index.html index 1efa9350..7b44088b 100644 --- a/dev/man/functions/index.html +++ b/dev/man/functions/index.html @@ -58,4 +58,4 @@ entry(fun) top: %2 = add i64 %1, %0 - ret i64 %2</code></pre><p>In addition to the iteration interface, it is possible to move from one basic block to the previous or next one using respectively the <code>prevblock</code> and <code>nextblock</code> functions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../modules/">« Modules</a><a class="docs-footer-nextpage" href="../blocks/">Basic blocks »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> + ret i64 %2</code></pre><p>In addition to the iteration interface, it is possible to move from one basic block to the previous or next one using respectively the <code>prevblock</code> and <code>nextblock</code> functions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../modules/">« Modules</a><a class="docs-footer-nextpage" href="../blocks/">Basic blocks »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/instructions/index.html b/dev/man/instructions/index.html index 152418d8..2ab6a908 100644 --- a/dev/man/instructions/index.html +++ b/dev/man/instructions/index.html @@ -20,4 +20,4 @@ julia> fast_math!(inst; nnan=true) julia> inst -%1 = fadd nnan float %0, 1.000000e+00</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../blocks/">« Basic blocks</a><a class="docs-footer-nextpage" href="../metadata/">Metadata »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +%1 = fadd nnan float %0, 1.000000e+00</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../blocks/">« Basic blocks</a><a class="docs-footer-nextpage" href="../metadata/">Metadata »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/interop/index.html b/dev/man/interop/index.html index 0732341c..b42a57b0 100644 --- a/dev/man/interop/index.html +++ b/dev/man/interop/index.html @@ -90,4 +90,4 @@ %0 = icmp slt i64 %"b::Int64", %"a::Int64" call void @llvm.assume(i1 %0) ret i64 %"a::Int64" -}</code></pre><p>To abort execution, the <code>trap()</code> function can be used, generating a call to <code>@llvm.trap</code>.</p><h2 id="Optimization-passes"><a class="docs-heading-anchor" href="#Optimization-passes">Optimization passes</a><a id="Optimization-passes-1"></a><a class="docs-heading-anchor-permalink" href="#Optimization-passes" title="Permalink"></a></h2><p>Julia's LLVM passes are usable in the same way as LLVM's passes, and are automatically available to any <code>PassBuilder</code>. Similarly, the default Julia optimization pipeline can be used through the <code>JuliaPipeline</code> pipeline object.</p><pre><code class="language-julia-repl hljs">julia> run!(JuliaPipeline(), mod)</code></pre><p>This object supports many keyword arguments to configure the pipeline; refer to the API documentation for more information.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../execution/">« Execution</a><a class="docs-footer-nextpage" href="../../lib/essentials/">Essentials »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +}</code></pre><p>To abort execution, the <code>trap()</code> function can be used, generating a call to <code>@llvm.trap</code>.</p><h2 id="Optimization-passes"><a class="docs-heading-anchor" href="#Optimization-passes">Optimization passes</a><a id="Optimization-passes-1"></a><a class="docs-heading-anchor-permalink" href="#Optimization-passes" title="Permalink"></a></h2><p>Julia's LLVM passes are usable in the same way as LLVM's passes, and are automatically available to any <code>PassBuilder</code>. Similarly, the default Julia optimization pipeline can be used through the <code>JuliaPipeline</code> pipeline object.</p><pre><code class="language-julia-repl hljs">julia> run!(JuliaPipeline(), mod)</code></pre><p>This object supports many keyword arguments to configure the pipeline; refer to the API documentation for more information.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../execution/">« Execution</a><a class="docs-footer-nextpage" href="../../lib/essentials/">Essentials »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/metadata/index.html b/dev/man/metadata/index.html index 751f9ec9..f09872c2 100644 --- a/dev/man/metadata/index.html +++ b/dev/man/metadata/index.html @@ -49,4 +49,4 @@ julia> file(scope(dbg)) <0x6000000beb80> = !DIFile(filename: "int.jl", directory: ".")</code></pre><p>Debug info can also be attached to functions, which can be queried and modified using respectively <code>subprogram</code> and <code>subprogram!</code>:</p><pre><code class="language-julia-repl hljs">julia> sp = subprogram(add) -<0x600003edfad0> = distinct !DISubprogram(name: "+", linkageName: "julia_+", scope: null, file: <0x600003ba6fe0>, line: 87, type: <0x600003494c90>, scopeLine: 87, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: <0x6000021d8428>, retainedNodes: <0x6000010f09d0>)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../instructions/">« Instructions</a><a class="docs-footer-nextpage" href="../analyses/">Analyses »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +<0x600003edfad0> = distinct !DISubprogram(name: "+", linkageName: "julia_+", scope: null, file: <0x600003ba6fe0>, line: 87, type: <0x600003494c90>, scopeLine: 87, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: <0x6000021d8428>, retainedNodes: <0x6000010f09d0>)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../instructions/">« Instructions</a><a class="docs-footer-nextpage" href="../analyses/">Analyses »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/modules/index.html b/dev/man/modules/index.html index 3058677a..c710a997 100644 --- a/dev/man/modules/index.html +++ b/dev/man/modules/index.html @@ -67,4 +67,4 @@ define void @foo() { ret void -}</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../values/">« Values</a><a class="docs-footer-nextpage" href="../functions/">Functions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +}</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../values/">« Values</a><a class="docs-footer-nextpage" href="../functions/">Functions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/transforms/index.html b/dev/man/transforms/index.html index cb2ebb0b..e7b4afaa 100644 --- a/dev/man/transforms/index.html +++ b/dev/man/transforms/index.html @@ -96,4 +96,4 @@ top1: ; No predecessors! %3 = add i64 %1, 42 ret i64 %3 -}</code></pre><p>This of course isn't very useful by itself, but can be a useful starting point for more complex transformations.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../analyses/">« Analyses</a><a class="docs-footer-nextpage" href="../codegen/">Code generation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +}</code></pre><p>This of course isn't very useful by itself, but can be a useful starting point for more complex transformations.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../analyses/">« Analyses</a><a class="docs-footer-nextpage" href="../codegen/">Code generation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/types/index.html b/dev/man/types/index.html index 49cfb6fb..9ec73501 100644 --- a/dev/man/types/index.html +++ b/dev/man/types/index.html @@ -70,4 +70,4 @@ true julia> types(ctx)["Foo"] -%Foo = type opaque</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../essentials/">« Essentials</a><a class="docs-footer-nextpage" href="../values/">Values »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +%Foo = type opaque</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../essentials/">« Essentials</a><a class="docs-footer-nextpage" href="../values/">Values »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> diff --git a/dev/man/values/index.html b/dev/man/values/index.html index 8205573c..9018127f 100644 --- a/dev/man/values/index.html +++ b/dev/man/values/index.html @@ -80,4 +80,4 @@ julia> replace_uses!(inst1, ConstantInt(Int64(42))) julia> inst2 -ret i64 42</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../types/">« Types</a><a class="docs-footer-nextpage" href="../modules/">Modules »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 16:57">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> +ret i64 42</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../types/">« Types</a><a class="docs-footer-nextpage" href="../modules/">Modules »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 2 December 2024 13:49">Monday 2 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>