xref: /freebsd/contrib/llvm-project/llvm/include/llvm-c/Support.h (revision 349cc55c9796c4596a5b9904cd3281af295f878f)
10b57cec5SDimitry Andric /*===-- llvm-c/Support.h - Support C Interface --------------------*- C -*-===*\
20b57cec5SDimitry Andric |*                                                                            *|
30b57cec5SDimitry Andric |* Part of the LLVM Project, under the Apache License v2.0 with LLVM          *|
40b57cec5SDimitry Andric |* Exceptions.                                                                *|
50b57cec5SDimitry Andric |* See https://llvm.org/LICENSE.txt for license information.                  *|
60b57cec5SDimitry Andric |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception                    *|
70b57cec5SDimitry Andric |*                                                                            *|
80b57cec5SDimitry Andric |*===----------------------------------------------------------------------===*|
90b57cec5SDimitry Andric |*                                                                            *|
100b57cec5SDimitry Andric |* This file defines the C interface to the LLVM support library.             *|
110b57cec5SDimitry Andric |*                                                                            *|
120b57cec5SDimitry Andric \*===----------------------------------------------------------------------===*/
130b57cec5SDimitry Andric 
140b57cec5SDimitry Andric #ifndef LLVM_C_SUPPORT_H
150b57cec5SDimitry Andric #define LLVM_C_SUPPORT_H
160b57cec5SDimitry Andric 
170b57cec5SDimitry Andric #include "llvm-c/DataTypes.h"
18480093f4SDimitry Andric #include "llvm-c/ExternC.h"
190b57cec5SDimitry Andric #include "llvm-c/Types.h"
200b57cec5SDimitry Andric 
21480093f4SDimitry Andric LLVM_C_EXTERN_C_BEGIN
220b57cec5SDimitry Andric 
230b57cec5SDimitry Andric /**
24*349cc55cSDimitry Andric  * @addtogroup LLVMCCore
25*349cc55cSDimitry Andric  *
26*349cc55cSDimitry Andric  * @{
27*349cc55cSDimitry Andric  */
28*349cc55cSDimitry Andric 
29*349cc55cSDimitry Andric /**
300b57cec5SDimitry Andric  * This function permanently loads the dynamic library at the given path.
310b57cec5SDimitry Andric  * It is safe to call this function multiple times for the same library.
320b57cec5SDimitry Andric  *
330b57cec5SDimitry Andric  * @see sys::DynamicLibrary::LoadLibraryPermanently()
340b57cec5SDimitry Andric   */
350b57cec5SDimitry Andric LLVMBool LLVMLoadLibraryPermanently(const char* Filename);
360b57cec5SDimitry Andric 
370b57cec5SDimitry Andric /**
380b57cec5SDimitry Andric  * This function parses the given arguments using the LLVM command line parser.
390b57cec5SDimitry Andric  * Note that the only stable thing about this function is its signature; you
400b57cec5SDimitry Andric  * cannot rely on any particular set of command line arguments being interpreted
410b57cec5SDimitry Andric  * the same way across LLVM versions.
420b57cec5SDimitry Andric  *
430b57cec5SDimitry Andric  * @see llvm::cl::ParseCommandLineOptions()
440b57cec5SDimitry Andric  */
450b57cec5SDimitry Andric void LLVMParseCommandLineOptions(int argc, const char *const *argv,
460b57cec5SDimitry Andric                                  const char *Overview);
470b57cec5SDimitry Andric 
480b57cec5SDimitry Andric /**
490b57cec5SDimitry Andric  * This function will search through all previously loaded dynamic
500b57cec5SDimitry Andric  * libraries for the symbol \p symbolName. If it is found, the address of
510b57cec5SDimitry Andric  * that symbol is returned. If not, null is returned.
520b57cec5SDimitry Andric  *
530b57cec5SDimitry Andric  * @see sys::DynamicLibrary::SearchForAddressOfSymbol()
540b57cec5SDimitry Andric  */
550b57cec5SDimitry Andric void *LLVMSearchForAddressOfSymbol(const char *symbolName);
560b57cec5SDimitry Andric 
570b57cec5SDimitry Andric /**
580b57cec5SDimitry Andric  * This functions permanently adds the symbol \p symbolName with the
590b57cec5SDimitry Andric  * value \p symbolValue.  These symbols are searched before any
600b57cec5SDimitry Andric  * libraries.
610b57cec5SDimitry Andric  *
620b57cec5SDimitry Andric  * @see sys::DynamicLibrary::AddSymbol()
630b57cec5SDimitry Andric  */
640b57cec5SDimitry Andric void LLVMAddSymbol(const char *symbolName, void *symbolValue);
650b57cec5SDimitry Andric 
66*349cc55cSDimitry Andric /**
67*349cc55cSDimitry Andric  * @}
68*349cc55cSDimitry Andric  */
69*349cc55cSDimitry Andric 
70480093f4SDimitry Andric LLVM_C_EXTERN_C_END
710b57cec5SDimitry Andric 
720b57cec5SDimitry Andric #endif
73