Nikita Popov ec1ea0a4ca
[llvm-c] Deprecate functions working on the global context (#163979)
One of the most common mistakes when working with the LLVM C API is to
mix functions that work on the global context and those that work on an
explicit context. This often results in seemingly nonsensical errors
because types from different contexts are mixed.

We have considered the APIs working on the global context to be obsolete
for a long time already, and do not add any new APIs using the global
context. However, the fact that these still exist (and have shorter
names) continues to cause issues.

This PR proposes to deprecate these APIs, with intent to remove them at
some point in the future.

RFC:
https://discourse.llvm.org/t/rfc-deprecate-c-api-functions-using-the-global-context/88639
2025-12-08 08:29:48 +00:00

144 lines
4.1 KiB
C

/*===-- module.c - tool for testing libLLVM and llvm-c API ----------------===*\
|* *|
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
|* Exceptions. *|
|* See https://llvm.org/LICENSE.txt for license information. *|
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
|* *|
|*===----------------------------------------------------------------------===*|
|* *|
|* This file implements the --module-dump, --module-list-functions and *|
|* --module-list-globals commands in llvm-c-test. *|
|* *|
\*===----------------------------------------------------------------------===*/
#include "llvm-c-test.h"
#include "llvm-c/BitReader.h"
#include <stdio.h>
#include <stdlib.h>
static void diagnosticHandler(LLVMDiagnosticInfoRef DI, void *C) {
char *CErr = LLVMGetDiagInfoDescription(DI);
fprintf(stderr, "Error with new bitcode parser: %s\n", CErr);
LLVMDisposeMessage(CErr);
exit(1);
}
LLVMModuleRef llvm_load_module(LLVMContextRef C, bool Lazy, bool New) {
LLVMMemoryBufferRef MB;
LLVMModuleRef M;
char *msg = NULL;
if (LLVMCreateMemoryBufferWithSTDIN(&MB, &msg)) {
fprintf(stderr, "Error reading file: %s\n", msg);
exit(1);
}
LLVMBool Ret;
if (New) {
LLVMContextSetDiagnosticHandler(C, diagnosticHandler, NULL);
if (Lazy)
Ret = LLVMGetBitcodeModuleInContext2(C, MB, &M);
else
Ret = LLVMParseBitcodeInContext2(C, MB, &M);
} else {
if (Lazy)
Ret = LLVMGetBitcodeModuleInContext(C, MB, &M, &msg);
else
Ret = LLVMParseBitcodeInContext(C, MB, &M, &msg);
}
if (Ret) {
fprintf(stderr, "Error parsing bitcode: %s\n", msg);
LLVMDisposeMemoryBuffer(MB);
exit(1);
}
if (!Lazy)
LLVMDisposeMemoryBuffer(MB);
return M;
}
int llvm_module_dump(bool Lazy, bool New) {
LLVMContextRef C = LLVMContextCreate();
LLVMModuleRef M = llvm_load_module(C, Lazy, New);
char *irstr = LLVMPrintModuleToString(M);
puts(irstr);
LLVMDisposeMessage(irstr);
LLVMDisposeModule(M);
LLVMContextDispose(C);
return 0;
}
int llvm_module_list_functions(void) {
LLVMContextRef C = LLVMContextCreate();
LLVMModuleRef M = llvm_load_module(C, false, false);
LLVMValueRef f;
f = LLVMGetFirstFunction(M);
while (f) {
if (LLVMIsDeclaration(f)) {
printf("FunctionDeclaration: %s\n", LLVMGetValueName(f));
} else {
LLVMBasicBlockRef bb;
LLVMValueRef isn;
unsigned nisn = 0;
unsigned nbb = 0;
printf("FunctionDefinition: %s [#bb=%u]\n", LLVMGetValueName(f),
LLVMCountBasicBlocks(f));
for (bb = LLVMGetFirstBasicBlock(f); bb;
bb = LLVMGetNextBasicBlock(bb)) {
nbb++;
for (isn = LLVMGetFirstInstruction(bb); isn;
isn = LLVMGetNextInstruction(isn)) {
nisn++;
if (LLVMIsACallInst(isn)) {
LLVMValueRef callee =
LLVMGetOperand(isn, LLVMGetNumOperands(isn) - 1);
printf(" calls: %s\n", LLVMGetValueName(callee));
}
}
}
printf(" #isn: %u\n", nisn);
printf(" #bb: %u\n\n", nbb);
}
f = LLVMGetNextFunction(f);
}
LLVMDisposeModule(M);
LLVMContextDispose(C);
return 0;
}
int llvm_module_list_globals(void) {
LLVMContextRef C = LLVMContextCreate();
LLVMModuleRef M = llvm_load_module(C, false, false);
LLVMValueRef g;
g = LLVMGetFirstGlobal(M);
while (g) {
LLVMTypeRef T = LLVMTypeOf(g);
char *s = LLVMPrintTypeToString(T);
printf("Global%s: %s %s\n",
LLVMIsDeclaration(g) ? "Declaration" : "Definition",
LLVMGetValueName(g), s);
LLVMDisposeMessage(s);
g = LLVMGetNextGlobal(g);
}
LLVMDisposeModule(M);
LLVMContextDispose(C);
return 0;
}