mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-14 03:58:23 +00:00
24 lines
6.4 KiB
HTML
24 lines
6.4 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Create an MCJIT execution engine for a module, with the given options."><title>LLVMCreateMCJITCompilerForModule in llvm_sys::execution_engine - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="llvm_sys" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../llvm_sys/index.html">llvm_sys</a><span class="version">180.0.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In llvm_sys::execution_engine</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../llvm_sys/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">llvm_sys</a>::<wbr><a href="index.html">execution_engine</a>::<wbr><a class="fn" href="#">LLVMCreateMCJITCompilerForModule</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/llvm_sys/execution_engine.rs.html#122-128">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub unsafe extern "C" fn LLVMCreateMCJITCompilerForModule(
|
||
OutJIT: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.pointer.html">*mut </a><a class="type" href="type.LLVMExecutionEngineRef.html" title="type llvm_sys::execution_engine::LLVMExecutionEngineRef">LLVMExecutionEngineRef</a>,
|
||
M: <a class="type" href="../prelude/type.LLVMModuleRef.html" title="type llvm_sys::prelude::LLVMModuleRef">LLVMModuleRef</a>,
|
||
Options: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.pointer.html">*mut </a><a class="struct" href="struct.LLVMMCJITCompilerOptions.html" title="struct llvm_sys::execution_engine::LLVMMCJITCompilerOptions">LLVMMCJITCompilerOptions</a>,
|
||
SizeOfOptions: <a class="type" href="../../libc/unix/type.size_t.html" title="type libc::unix::size_t">size_t</a>,
|
||
OutError: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.pointer.html">*mut </a><a class="type" href="../../libc/unix/linux_like/linux/gnu/b64/x86_64/type.c_char.html" title="type libc::unix::linux_like::linux::gnu::b64::x86_64::c_char">c_char</a>
|
||
) -> <a class="type" href="../prelude/type.LLVMBool.html" title="type llvm_sys::prelude::LLVMBool">LLVMBool</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create an MCJIT execution engine for a module, with the given options.</p>
|
||
<p>It is
|
||
the responsibility of the caller to ensure that all fields in Options up to
|
||
the given SizeOfOptions are initialized. It is correct to pass a smaller
|
||
value of SizeOfOptions that omits some fields. The canonical way of using
|
||
this is:</p>
|
||
<div class="example-wrap"><pre class="language-c++"><code>LLVMMCJITCompilerOptions options;
|
||
LLVMInitializeMCJITCompilerOptions(&options, sizeof(options));
|
||
// ... fill in those options you care about
|
||
LLVMCreateMCJITCompilerForModule(&jit, mod, &options, sizeof(options),
|
||
&error);
|
||
</code></pre></div>
|
||
<p>Note that this is also correct, though possibly suboptimal:</p>
|
||
<div class="example-wrap"><pre class="language-c++"><code>LLVMCreateMCJITCompilerForModule(&jit, mod, 0, 0, &error);
|
||
</code></pre></div>
|
||
<p>0 is returned on success, or 1 on failure.</p>
|
||
</div></details></section></div></main></body></html> |