19 lines
39 KiB
HTML
19 lines
39 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>C Interface · The Julia Language</title><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
|
|
|
ga('create', 'UA-28835595-6', 'auto');
|
|
ga('send', 'pageview');
|
|
</script><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/><link href="../assets/julia-manual.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><a href="../index.html"><img class="logo" src="../assets/logo.png" alt="The Julia Language logo"/></a><h1>The Julia Language</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><span class="toctext">Manual</span><ul><li><a class="toctext" href="../manual/introduction.html">Introduction</a></li><li><a class="toctext" href="../manual/getting-started.html">Getting Started</a></li><li><a class="toctext" href="../manual/variables.html">Variables</a></li><li><a class="toctext" href="../manual/integers-and-floating-point-numbers.html">Integers and Floating-Point Numbers</a></li><li><a class="toctext" href="../manual/mathematical-operations.html">Mathematical Operations and Elementary Functions</a></li><li><a class="toctext" href="../manual/complex-and-rational-numbers.html">Complex and Rational Numbers</a></li><li><a class="toctext" href="../manual/strings.html">Strings</a></li><li><a class="toctext" href="../manual/functions.html">Functions</a></li><li><a class="toctext" href="../manual/control-flow.html">Control Flow</a></li><li><a class="toctext" href="../manual/variables-and-scoping.html">Scope of Variables</a></li><li><a class="toctext" href="../manual/types.html">Types</a></li><li><a class="toctext" href="../manual/methods.html">Methods</a></li><li><a class="toctext" href="../manual/constructors.html">Constructors</a></li><li><a class="toctext" href="../manual/conversion-and-promotion.html">Conversion and Promotion</a></li><li><a class="toctext" href="../manual/interfaces.html">Interfaces</a></li><li><a class="toctext" href="../manual/modules.html">Modules</a></li><li><a class="toctext" href="../manual/documentation.html">Documentation</a></li><li><a class="toctext" href="../manual/metaprogramming.html">Metaprogramming</a></li><li><a class="toctext" href="../manual/arrays.html">Multi-dimensional Arrays</a></li><li><a class="toctext" href="../manual/linear-algebra.html">Linear algebra</a></li><li><a class="toctext" href="../manual/networking-and-streams.html">Networking and Streams</a></li><li><a class="toctext" href="../manual/parallel-computing.html">Parallel Computing</a></li><li><a class="toctext" href="../manual/dates.html">Date and DateTime</a></li><li><a class="toctext" href="../manual/interacting-with-julia.html">Interacting With Julia</a></li><li><a class="toctext" href="../manual/running-external-programs.html">Running External Programs</a></li><li><a class="toctext" href="../manual/calling-c-and-fortran-code.html">Calling C and Fortran Code</a></li><li><a class="toctext" href="../manual/handling-operating-system-variation.html">Handling Operating System Variation</a></li><li><a class="toctext" href="../manual/environment-variables.html">Environment Variables</a></li><li><a class="toctext" href="../manual/embedding.html">Embedding Julia</a></li><li><a class="toctext" href="../manual/packages.html">Packages</a></li><li><a class="toctext" href="../manual/profile.html">Profiling</a></li><li><a class="toctext" href="../manual/stacktraces.html">Stack Traces</a></li><li><a class="toctext" href="../manual/performance-tips.html">Performance Tips</a></li><li><a class="toctext" href="../manual/workflow-tips.html">Workflow Tips</a></li><li><a class="toctext" href="../manual/style-guide.html">Style Guide</a></li><li><a class="toctext" href="../manual/faq.html">Frequently Asked Questions</a></li><li><a class="toctext" href="../manual/noteworthy-differences.html">Noteworthy Differences from other Languages</a></li><li><a class="toctext" href="../manual/unicode-input.html">Unicode Input</a></li></ul></li><li><span class="toctext">Standard Library</span><ul><li><a class="toctext" href="base.html">Essentials</a></li><li><a class="toctext" href="collections.html">Collections and Data Structures</a></li><li><a class="toctext" href="math.html">Mathematics</a></li><li><a class="toctext" href="numbers.html">Numbers</a></li><li><a class="toctext" href="strings.html">Strings</a></li><li><a class="toctext" href="arrays.html">Arrays</a></li><li><a class="toctext" href="parallel.html">Tasks and Parallel Computing</a></li><li><a class="toctext" href="linalg.html">Linear Algebra</a></li><li><a class="toctext" href="constants.html">Constants</a></li><li><a class="toctext" href="file.html">Filesystem</a></li><li><a class="toctext" href="io-network.html">I/O and Network</a></li><li><a class="toctext" href="punctuation.html">Punctuation</a></li><li><a class="toctext" href="sort.html">Sorting and Related Functions</a></li><li><a class="toctext" href="pkg.html">Package Manager Functions</a></li><li><a class="toctext" href="dates.html">Dates and Time</a></li><li><a class="toctext" href="iterators.html">Iteration utilities</a></li><li><a class="toctext" href="test.html">Unit Testing</a></li><li class="current"><a class="toctext" href="c.html">C Interface</a><ul class="internal"><li class="toplevel"><a class="toctext" href="#LLVM-Interface-1">LLVM Interface</a></li></ul></li><li><a class="toctext" href="libc.html">C Standard Library</a></li><li><a class="toctext" href="libdl.html">Dynamic Linker</a></li><li><a class="toctext" href="profile.html">Profiling</a></li><li><a class="toctext" href="stacktraces.html">StackTraces</a></li><li><a class="toctext" href="simd-types.html">SIMD Support</a></li></ul></li><li><span class="toctext">Developer Documentation</span><ul><li><a class="toctext" href="../devdocs/reflection.html">Reflection and introspection</a></li><li><span class="toctext">Documentation of Julia's Internals</span><ul><li><a class="toctext" href="../devdocs/init.html">Initialization of the Julia runtime</a></li><li><a class="toctext" href="../devdocs/ast.html">Julia ASTs</a></li><li><a class="toctext" href="../devdocs/types.html">More about types</a></li><li><a class="toctext" href="../devdocs/object.html">Memory layout of Julia Objects</a></li><li><a class="toctext" href="../devdocs/eval.html">Eval of Julia code</a></li><li><a class="toctext" href="../devdocs/callconv.html">Calling Conventions</a></li><li><a class="toctext" href="../devdocs/compiler.html">High-level Overview of the Native-Code Generation Process</a></li><li><a class="toctext" href="../devdocs/functions.html">Julia Functions</a></li><li><a class="toctext" href="../devdocs/cartesian.html">Base.Cartesian</a></li><li><a class="toctext" href="../devdocs/meta.html">Talking to the compiler (the <code>:meta</code> mechanism)</a></li><li><a class="toctext" href="../devdocs/subarrays.html">SubArrays</a></li><li><a class="toctext" href="../devdocs/sysimg.html">System Image Building</a></li><li><a class="toctext" href="../devdocs/llvm.html">Working with LLVM</a></li><li><a class="toctext" href="../devdocs/stdio.html">printf() and stdio in the Julia runtime</a></li><li><a class="toctext" href="../devdocs/boundscheck.html">Bounds checking</a></li><li><a class="toctext" href="../devdocs/locks.html">Proper maintenance and care of multi-threading locks</a></li><li><a class="toctext" href="../devdocs/offset-arrays.html">Arrays with custom indices</a></li><li><a class="toctext" href="../devdocs/libgit2.html">Base.LibGit2</a></li><li><a class="toctext" href="../devdocs/require.html">Module loading</a></li></ul></li><li><span class="toctext">Developing/debugging Julia's C code</span><ul><li><a class="toctext" href="../devdocs/backtraces.html">Reporting and analyzing crashes (segfaults)</a></li><li><a class="toctext" href="../devdocs/debuggingtips.html">gdb debugging tips</a></li><li><a class="toctext" href="../devdocs/valgrind.html">Using Valgrind with Julia</a></li><li><a class="toctext" href="../devdocs/sanitizers.html">Sanitizer support</a></li></ul></li></ul></li></ul></nav><article id="docs"><header><nav><ul><li>Standard Library</li><li><a href="c.html">C Interface</a></li></ul><a class="edit-page" href="https://github.com/JuliaLang/julia/blob/master/doc/src/stdlib/c.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>C Interface</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="C-Interface-1" href="#C-Interface-1">C Interface</a></h1><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="ccall" href="#ccall"><code>ccall</code></a> — <span class="docstring-category">Keyword</span>.</div><div><pre><code class="language-none">ccall((symbol, library) or function_pointer, ReturnType, (ArgumentType1, ...), ArgumentValue1, ...)</code></pre><p>Call function in C-exported shared library, specified by <code>(function name, library)</code> tuple, where each component is a string or symbol.</p><p>Note that the argument type tuple must be a literal tuple, and not a tuple-valued variable or expression. Alternatively, <code>ccall</code> may also be used to call a function pointer, such as one returned by <code>dlsym</code>.</p><p>Each <code>ArgumentValue</code> to the <code>ccall</code> will be converted to the corresponding <code>ArgumentType</code>, by automatic insertion of calls to <code>unsafe_convert(ArgumentType, cconvert(ArgumentType, ArgumentValue))</code>. (See also the documentation for each of these functions for further details.) In most cases, this simply results in a call to <code>convert(ArgumentType, ArgumentValue)</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/basedocs.jl#L557-L572">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Core.Intrinsics.cglobal" href="#Core.Intrinsics.cglobal"><code>Core.Intrinsics.cglobal</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">cglobal((symbol, library) [, type=Void])</code></pre><p>Obtain a pointer to a global variable in a C-exported shared library, specified exactly as in <a href="c.html#ccall"><code>ccall</code></a>. Returns a <code>Ptr{Type}</code>, defaulting to <code>Ptr{Void}</code> if no <code>Type</code> argument is supplied. The values can be read or written by <a href="c.html#Base.unsafe_load"><code>unsafe_load</code></a> or <a href="c.html#Base.unsafe_store!"><code>unsafe_store!</code></a>, respectively.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/helpdb/Base.jl#L1073-L1082">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.cfunction" href="#Base.cfunction"><code>Base.cfunction</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">cfunction(function::Function, ReturnType::Type, ArgumentTypes::Type)</code></pre><p>Generate C-callable function pointer from Julia function. Type annotation of the return value in the callback function is a must for situations where Julia cannot infer the return type automatically.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl">julia> function foo(x::Int, y::Int)
|
|
return x + y
|
|
end
|
|
|
|
julia> cfunction(foo, Int, Tuple{Int,Int})
|
|
Ptr{Void} @0x000000001b82fcd0</code></pre></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/c.jl#L7-L23">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.unsafe_convert" href="#Base.unsafe_convert"><code>Base.unsafe_convert</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">unsafe_convert(T,x)</code></pre><p>Convert <code>x</code> to a value of type <code>T</code></p><p>In cases where <a href="base.html#Base.convert"><code>convert</code></a> would need to take a Julia object and turn it into a <code>Ptr</code>, this function should be used to define and perform that conversion.</p><p>Be careful to ensure that a Julia reference to <code>x</code> exists as long as the result of this function will be used. Accordingly, the argument <code>x</code> to this function should never be an expression, only a variable name or field reference. For example, <code>x=a.b.c</code> is acceptable, but <code>x=[a,b,c]</code> is not.</p><p>The <code>unsafe</code> prefix on this function indicates that using the result of this function after the <code>x</code> argument to this function is no longer accessible to the program may cause undefined behavior, including program corruption or segfaults, at any later time.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/helpdb/Base.jl#L1037-L1054">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.cconvert" href="#Base.cconvert"><code>Base.cconvert</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">cconvert(T,x)</code></pre><p>Convert <code>x</code> to a value of type <code>T</code>, typically by calling <code>convert(T,x)</code></p><p>In cases where <code>x</code> cannot be safely converted to <code>T</code>, unlike <a href="base.html#Base.convert"><code>convert</code></a>, <code>cconvert</code> may return an object of a type different from <code>T</code>, which however is suitable for <a href="c.html#Base.unsafe_convert"><code>unsafe_convert</code></a> to handle.</p><p>Neither <code>convert</code> nor <code>cconvert</code> should take a Julia object and turn it into a <code>Ptr</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/helpdb/Base.jl#L169-L179">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.unsafe_load" href="#Base.unsafe_load"><code>Base.unsafe_load</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">unsafe_load(p::Ptr{T}, i::Integer=1)</code></pre><p>Load a value of type <code>T</code> from the address of the <code>i</code>th element (1-indexed) starting at <code>p</code>. This is equivalent to the C expression <code>p[i-1]</code>.</p><p>The <code>unsafe</code> prefix on this function indicates that no validation is performed on the pointer <code>p</code> to ensure that it is valid. Incorrect usage may segfault your program or return garbage answers, in the same manner as C.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/pointer.jl#L73-L82">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.unsafe_store!" href="#Base.unsafe_store!"><code>Base.unsafe_store!</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">unsafe_store!(p::Ptr{T}, x, i::Integer=1)</code></pre><p>Store a value of type <code>T</code> to the address of the <code>i</code>th element (1-indexed) starting at <code>p</code>. This is equivalent to the C expression <code>p[i-1] = x</code>.</p><p>The <code>unsafe</code> prefix on this function indicates that no validation is performed on the pointer <code>p</code> to ensure that it is valid. Incorrect usage may corrupt or segfault your program, in the same manner as C.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/pointer.jl#L85-L94">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.unsafe_copy!-Union{Tuple{Ptr{T},Ptr{T},Any}, Tuple{T}} where T" href="#Base.unsafe_copy!-Union{Tuple{Ptr{T},Ptr{T},Any}, Tuple{T}} where T"><code>Base.unsafe_copy!</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">unsafe_copy!(dest::Ptr{T}, src::Ptr{T}, N)</code></pre><p>Copy <code>N</code> elements from a source pointer to a destination, with no checking. The size of an element is determined by the type of the pointers.</p><p>The <code>unsafe</code> prefix on this function indicates that no validation is performed on the pointers <code>dest</code> and <code>src</code> to ensure that they are valid. Incorrect usage may corrupt or segfault your program, in the same manner as C.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/helpdb/Base.jl#L197-L206">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.unsafe_copy!-Tuple{Array,Any,Array,Any,Any}" href="#Base.unsafe_copy!-Tuple{Array,Any,Array,Any,Any}"><code>Base.unsafe_copy!</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">unsafe_copy!(dest::Array, do, src::Array, so, N)</code></pre><p>Copy <code>N</code> elements from a source array to a destination, starting at offset <code>so</code> in the source and <code>do</code> in the destination (1-indexed).</p><p>The <code>unsafe</code> prefix on this function indicates that no validation is performed to ensure that N is inbounds on either array. Incorrect usage may corrupt or segfault your program, in the same manner as C.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/helpdb/Base.jl#L209-L218">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.copy!-Tuple{Any,Any}" href="#Base.copy!-Tuple{Any,Any}"><code>Base.copy!</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">copy!(dest, src) -> dest</code></pre><p>Copy all elements from collection <code>src</code> to array <code>dest</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/multidimensional.jl#L848-L852">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.copy!-NTuple{5,Any}" href="#Base.copy!-NTuple{5,Any}"><code>Base.copy!</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">copy!(dest, do, src, so, N)</code></pre><p>Copy <code>N</code> elements from collection <code>src</code> starting at offset <code>so</code>, to array <code>dest</code> starting at offset <code>do</code>. Returns <code>dest</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/helpdb/Base.jl#L2273-L2278">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.pointer" href="#Base.pointer"><code>Base.pointer</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">pointer(array [, index])</code></pre><p>Get the native address of an array or string element. Be careful to ensure that a Julia reference to <code>a</code> exists as long as this pointer will be used. This function is "unsafe" like <code>unsafe_convert</code>.</p><p>Calling <code>Ref(array[, index])</code> is generally preferable to this function.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/helpdb/Base.jl#L47-L55">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.unsafe_wrap-Union{Tuple{N}, Tuple{T}, Tuple{Union{Type{Array{T,N} where N}, Type{Array{T,N}}, Type{Array}},Ptr{T},Tuple{Vararg{Int64,N}}}} where N where T" href="#Base.unsafe_wrap-Union{Tuple{N}, Tuple{T}, Tuple{Union{Type{Array{T,N} where N}, Type{Array{T,N}}, Type{Array}},Ptr{T},Tuple{Vararg{Int64,N}}}} where N where T"><code>Base.unsafe_wrap</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">unsafe_wrap(Array, pointer::Ptr{T}, dims, own=false)</code></pre><p>Wrap a Julia <code>Array</code> object around the data at the address given by <code>pointer</code>, without making a copy. The pointer element type <code>T</code> determines the array element type. <code>dims</code> is either an integer (for a 1d array) or a tuple of the array dimensions. <code>own</code> optionally specifies whether Julia should take ownership of the memory, calling <code>free</code> on the pointer when the array is no longer referenced.</p><p>This function is labelled "unsafe" because it will crash if <code>pointer</code> is not a valid memory address to data of the requested length.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/pointer.jl#L48-L59">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.pointer_from_objref" href="#Base.pointer_from_objref"><code>Base.pointer_from_objref</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">pointer_from_objref(x)</code></pre><p>Get the memory address of a Julia object as a <code>Ptr</code>. The existence of the resulting <code>Ptr</code> will not protect the object from garbage collection, so you must ensure that the object remains referenced for the whole time that the <code>Ptr</code> will be used.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/pointer.jl#L108-L114">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.unsafe_pointer_to_objref" href="#Base.unsafe_pointer_to_objref"><code>Base.unsafe_pointer_to_objref</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">unsafe_pointer_to_objref(p::Ptr)</code></pre><p>Convert a <code>Ptr</code> to an object reference. Assumes the pointer refers to a valid heap-allocated Julia object. If this is not the case, undefined behavior results, hence this function is considered "unsafe" and should be used with care.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/pointer.jl#L99-L105">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.disable_sigint" href="#Base.disable_sigint"><code>Base.disable_sigint</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">disable_sigint(f::Function)</code></pre><p>Disable Ctrl-C handler during execution of a function on the current task, for calling external code that may call julia code that is not interrupt safe. Intended to be called using <code>do</code> block syntax as follows:</p><pre><code class="language-none">disable_sigint() do
|
|
# interrupt-unsafe code
|
|
...
|
|
end</code></pre><p>This is not needed on worker threads (<code>Threads.threadid() != 1</code>) since the <code>InterruptException</code> will only be delivered to the master thread. External functions that do not call julia code or julia runtime automatically disable sigint during their execution.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/c.jl#L321-L337">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.reenable_sigint" href="#Base.reenable_sigint"><code>Base.reenable_sigint</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">reenable_sigint(f::Function)</code></pre><p>Re-enable Ctrl-C handler during execution of a function. Temporarily reverses the effect of <code>disable_sigint</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/c.jl#L346-L351">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.systemerror" href="#Base.systemerror"><code>Base.systemerror</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">systemerror(sysfunc, iftrue)</code></pre><p>Raises a <code>SystemError</code> for <code>errno</code> with the descriptive string <code>sysfunc</code> if <code>iftrue</code> is <code>true</code></p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/error.jl#L59-L63">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Core.Ptr" href="#Core.Ptr"><code>Core.Ptr</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Ptr{T}</code></pre><p>A memory address referring to data of type <code>T</code>. However, there is no guarantee that the memory is actually valid, or that it actually represents data of the specified type.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/pointer.jl#L3-L8">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Core.Ref" href="#Core.Ref"><code>Core.Ref</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Ref{T}</code></pre><p>An object that safely references data of type <code>T</code>. This type is guaranteed to point to valid, Julia-allocated memory of the correct type. The underlying data is protected from freeing by the garbage collector as long as the <code>Ref</code> itself is referenced.</p><p>When passed as a <code>ccall</code> argument (either as a <code>Ptr</code> or <code>Ref</code> type), a <code>Ref</code> object will be converted to a native pointer to the data it references.</p><p>There is no invalid (NULL) <code>Ref</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/refpointer.jl#L3-L14">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cchar" href="#Base.Cchar"><code>Base.Cchar</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cchar</code></pre><p>Equivalent to the native <code>char</code> c-type.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/c.jl#L31-L35">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cuchar" href="#Base.Cuchar"><code>Base.Cuchar</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cuchar</code></pre><p>Equivalent to the native <code>unsigned char</code> c-type (<a href="numbers.html#Core.UInt8"><code>UInt8</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L6-L10">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cshort" href="#Base.Cshort"><code>Base.Cshort</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cshort</code></pre><p>Equivalent to the native <code>signed short</code> c-type (<a href="numbers.html#Core.Int16"><code>Int16</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L14-L18">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cushort" href="#Base.Cushort"><code>Base.Cushort</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cushort</code></pre><p>Equivalent to the native <code>unsigned short</code> c-type (<a href="numbers.html#Core.UInt16"><code>UInt16</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L22-L26">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cint" href="#Base.Cint"><code>Base.Cint</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cint</code></pre><p>Equivalent to the native <code>signed int</code> c-type (<a href="numbers.html#Core.Int32"><code>Int32</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L30-L34">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cuint" href="#Base.Cuint"><code>Base.Cuint</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cuint</code></pre><p>Equivalent to the native <code>unsigned int</code> c-type (<a href="numbers.html#Core.UInt32"><code>UInt32</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L38-L42">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Clong" href="#Base.Clong"><code>Base.Clong</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Clong</code></pre><p>Equivalent to the native <code>signed long</code> c-type.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/c.jl#L48-L52">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Culong" href="#Base.Culong"><code>Base.Culong</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Culong</code></pre><p>Equivalent to the native <code>unsigned long</code> c-type.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/c.jl#L55-L59">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Clonglong" href="#Base.Clonglong"><code>Base.Clonglong</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Clonglong</code></pre><p>Equivalent to the native <code>signed long long</code> c-type (<a href="numbers.html#Core.Int64"><code>Int64</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L86-L90">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Culonglong" href="#Base.Culonglong"><code>Base.Culonglong</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Culonglong</code></pre><p>Equivalent to the native <code>unsigned long long</code> c-type (<a href="numbers.html#Core.UInt64"><code>UInt64</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L94-L98">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cintmax_t" href="#Base.Cintmax_t"><code>Base.Cintmax_t</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cintmax_t</code></pre><p>Equivalent to the native <code>intmax_t</code> c-type (<a href="numbers.html#Core.Int64"><code>Int64</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L70-L74">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cuintmax_t" href="#Base.Cuintmax_t"><code>Base.Cuintmax_t</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cuintmax_t</code></pre><p>Equivalent to the native <code>uintmax_t</code> c-type (<a href="numbers.html#Core.UInt64"><code>UInt64</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L78-L82">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Csize_t" href="#Base.Csize_t"><code>Base.Csize_t</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Csize_t</code></pre><p>Equivalent to the native <code>size_t</code> c-type (<code>UInt</code>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L54-L58">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cssize_t" href="#Base.Cssize_t"><code>Base.Cssize_t</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cssize_t</code></pre><p>Equivalent to the native <code>ssize_t</code> c-type.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L62-L66">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cptrdiff_t" href="#Base.Cptrdiff_t"><code>Base.Cptrdiff_t</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cptrdiff_t</code></pre><p>Equivalent to the native <code>ptrdiff_t</code> c-type (<code>Int</code>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L46-L50">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cwchar_t" href="#Base.Cwchar_t"><code>Base.Cwchar_t</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cwchar_t</code></pre><p>Equivalent to the native <code>wchar_t</code> c-type (<a href="numbers.html#Core.Int32"><code>Int32</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/c.jl#L62-L66">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cfloat" href="#Base.Cfloat"><code>Base.Cfloat</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cfloat</code></pre><p>Equivalent to the native <code>float</code> c-type (<a href="numbers.html#Core.Float32"><code>Float32</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L102-L106">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Cdouble" href="#Base.Cdouble"><code>Base.Cdouble</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Cdouble</code></pre><p>Equivalent to the native <code>double</code> c-type (<a href="numbers.html#Core.Float64"><code>Float64</code></a>).</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/ctypes.jl#L110-L114">source</a></section><h1><a class="nav-anchor" id="LLVM-Interface-1" href="#LLVM-Interface-1">LLVM Interface</a></h1><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Core.Intrinsics.llvmcall" href="#Core.Intrinsics.llvmcall"><code>Core.Intrinsics.llvmcall</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">llvmcall(IR::String, ReturnType, (ArgumentType1, ...), ArgumentValue1, ...)
|
|
llvmcall((declarations::String, IR::String), ReturnType, (ArgumentType1, ...), ArgumentValue1, ...)</code></pre><p>Call LLVM IR string in the first argument. Similar to an LLVM function <code>define</code> block, arguments are available as consecutive unnamed SSA variables (%0, %1, etc.).</p><p>The optional declarations string contains external functions declarations that are necessary for llvm to compile the IR string. Multiple declarations can be passed in by separating them with line breaks.</p><p>Note that the argument type tuple must be a literal tuple, and not a tuple-valued variable or expression.</p><p>Each <code>ArgumentValue</code> to <code>llvmcall</code> will be converted to the corresponding <code>ArgumentType</code>, by automatic insertion of calls to <code>unsafe_convert(ArgumentType, cconvert(ArgumentType, ArgumentValue))</code>. (see also the documentation for each of these functions for further details). In most cases, this simply results in a call to <code>convert(ArgumentType, ArgumentValue)</code>.</p><p>See <code>test/llvmcall.jl</code> for usage examples.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/docs/basedocs.jl#L575-L596">source</a></section><footer><hr/><a class="previous" href="test.html"><span class="direction">Previous</span><span class="title">Unit Testing</span></a><a class="next" href="libc.html"><span class="direction">Next</span><span class="title">C Standard Library</span></a></footer></article></body></html>
|