LLVM 20.0.0git
BitReader.h
Go to the documentation of this file.
1/*===-- llvm-c/BitReader.h - BitReader Library C Interface ------*- C++ -*-===*\
2|* *|
3|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
4|* Exceptions. *|
5|* See https://llvm.org/LICENSE.txt for license information. *|
6|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
7|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
10|* This header declares the C interface to libLLVMBitReader.a, which *|
11|* implements input of the LLVM bitcode format. *|
12|* *|
13|* Many exotic languages can interoperate with C code but have a harder time *|
14|* with C++ due to name mangling. So in addition to C, this interface enables *|
15|* tools written in such languages. *|
16|* *|
17\*===----------------------------------------------------------------------===*/
18
19#ifndef LLVM_C_BITREADER_H
20#define LLVM_C_BITREADER_H
21
22#include "llvm-c/ExternC.h"
23#include "llvm-c/Types.h"
24
26
27/**
28 * @defgroup LLVMCBitReader Bit Reader
29 * @ingroup LLVMC
30 *
31 * @{
32 */
33
34/* Builds a module from the bitcode in the specified memory buffer, returning a
35 reference to the module via the OutModule parameter. Returns 0 on success.
36 Optionally returns a human-readable error message via OutMessage.
37
38 This is deprecated. Use LLVMParseBitcode2. */
40 char **OutMessage);
41
42/* Builds a module from the bitcode in the specified memory buffer, returning a
43 reference to the module via the OutModule parameter. Returns 0 on success. */
45 LLVMModuleRef *OutModule);
46
47/* This is deprecated. Use LLVMParseBitcodeInContext2. */
50 LLVMModuleRef *OutModule, char **OutMessage);
51
54 LLVMModuleRef *OutModule);
55
56/** Reads a module from the specified path, returning via the OutMP parameter
57 a module provider which performs lazy deserialization. Returns 0 on success.
58 Optionally returns a human-readable error message via OutMessage.
59 This is deprecated. Use LLVMGetBitcodeModuleInContext2. */
62 LLVMModuleRef *OutM, char **OutMessage);
63
64/** Reads a module from the given memory buffer, returning via the OutMP
65 * parameter a module provider which performs lazy deserialization.
66 *
67 * Returns 0 on success.
68 *
69 * Takes ownership of \p MemBuf if (and only if) the module was read
70 * successfully. */
73 LLVMModuleRef *OutM);
74
75/* This is deprecated. Use LLVMGetBitcodeModule2. */
77 char **OutMessage);
78
80
81/**
82 * @}
83 */
84
86
87#endif
#define LLVM_C_EXTERN_C_BEGIN
Definition: ExternC.h:35
#define LLVM_C_EXTERN_C_END
Definition: ExternC.h:36
LLVMBool LLVMParseBitcode2(LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutModule)
Definition: BitReader.cpp:29
LLVMBool LLVMGetBitcodeModuleInContext2(LLVMContextRef ContextRef, LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM)
Reads a module from the given memory buffer, returning via the OutMP parameter a module provider whic...
Definition: BitReader.cpp:104
LLVMBool LLVMParseBitcode(LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutModule, char **OutMessage)
Definition: BitReader.cpp:23
LLVMBool LLVMParseBitcodeInContext2(LLVMContextRef ContextRef, LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutModule)
Definition: BitReader.cpp:57
LLVMBool LLVMParseBitcodeInContext(LLVMContextRef ContextRef, LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutModule, char **OutMessage)
Definition: BitReader.cpp:34
LLVMBool LLVMGetBitcodeModule2(LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM)
Definition: BitReader.cpp:129
LLVMBool LLVMGetBitcodeModule(LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM, char **OutMessage)
Definition: BitReader.cpp:123
LLVMBool LLVMGetBitcodeModuleInContext(LLVMContextRef ContextRef, LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM, char **OutMessage)
Reads a module from the specified path, returning via the OutMP parameter a module provider which per...
Definition: BitReader.cpp:77
int LLVMBool
Definition: Types.h:28
struct LLVMOpaqueMemoryBuffer * LLVMMemoryBufferRef
LLVM uses a polymorphic type hierarchy which C cannot represent, therefore parameters must be passed ...
Definition: Types.h:48
struct LLVMOpaqueContext * LLVMContextRef
The top-level container for all LLVM global data.
Definition: Types.h:53
struct LLVMOpaqueModule * LLVMModuleRef
The top-level container for all other LLVM Intermediate Representation (IR) objects.
Definition: Types.h:61