Skip to content

[llvm-c] Add LLVMConstDataArray and LLVMGetRawDataValues #129440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions llvm/docs/ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,10 @@ Changes to the C API
* `LLVMConstNUWMul`
* `LLVMConstNSWMul`

* Added `LLVMConstDataArray` and `LLVMGetRawDataValues` to allow creating and
reading `ConstantDataArray` values without needing extra `LLVMValueRef`s for
individual elements.

Changes to the CodeGen infrastructure
-------------------------------------

Expand Down
23 changes: 23 additions & 0 deletions llvm/include/llvm-c/Core.h
Original file line number Diff line number Diff line change
Expand Up @@ -2350,6 +2350,16 @@ LLVMBool LLVMIsConstantString(LLVMValueRef c);
*/
const char *LLVMGetAsString(LLVMValueRef c, size_t *Length);

/**
* Get the raw, underlying bytes of the given constant data sequential.
*
* This is the same as LLVMGetAsString except it works for all constant data
* sequentials, not just i8 arrays.
*
* @see ConstantDataSequential::getRawDataValues()
*/
const char *LLVMGetRawDataValues(LLVMValueRef c, size_t *SizeInBytes);

/**
* Create an anonymous ConstantStruct with the specified values.
*
Expand Down Expand Up @@ -2388,6 +2398,19 @@ LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
LLVMValueRef LLVMConstArray2(LLVMTypeRef ElementTy, LLVMValueRef *ConstantVals,
uint64_t Length);

/**
* Create a ConstantDataArray from raw values.
*
* ElementTy must be one of i8, i16, i32, i64, half, bfloat, float, or double.
* Data points to a contiguous buffer of raw values with the appropriate
* endianness. The element count is inferred from the element type and the data
* size in bytes.
*
* @see llvm::ConstantDataArray::getRaw()
*/
LLVMValueRef LLVMConstDataArray(LLVMTypeRef ElementTy, const char *Data,
size_t SizeInBytes);

/**
* Create a non-anonymous ConstantStruct from values.
*
Expand Down
13 changes: 13 additions & 0 deletions llvm/lib/IR/Core.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1643,6 +1643,12 @@ const char *LLVMGetAsString(LLVMValueRef C, size_t *Length) {
return Str.data();
}

const char *LLVMGetRawDataValues(LLVMValueRef C, size_t *SizeInBytes) {
StringRef Str = unwrap<ConstantDataSequential>(C)->getRawDataValues();
*SizeInBytes = Str.size();
return Str.data();
}

LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy,
LLVMValueRef *ConstantVals, unsigned Length) {
ArrayRef<Constant*> V(unwrap<Constant>(ConstantVals, Length), Length);
Expand All @@ -1655,6 +1661,13 @@ LLVMValueRef LLVMConstArray2(LLVMTypeRef ElementTy, LLVMValueRef *ConstantVals,
return wrap(ConstantArray::get(ArrayType::get(unwrap(ElementTy), Length), V));
}

LLVMValueRef LLVMConstDataArray(LLVMTypeRef ElementTy, const char *Data,
size_t SizeInBytes) {
Type *Ty = unwrap(ElementTy);
size_t Len = SizeInBytes / (Ty->getPrimitiveSizeInBits() / 8);
return wrap(ConstantDataArray::getRaw(StringRef(Data, SizeInBytes), Len, Ty));
}

LLVMValueRef LLVMConstStructInContext(LLVMContextRef C,
LLVMValueRef *ConstantVals,
unsigned Count, LLVMBool Packed) {
Expand Down
1 change: 1 addition & 0 deletions llvm/test/Bindings/llvm-c/echo.ll
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ module asm "classical GAS"
@arr = linkonce_odr global [5 x i8] [ i8 2, i8 3, i8 5, i8 7, i8 11 ]
@str = private unnamed_addr constant [13 x i8] c"hello world\0A\00"
@locStr = private local_unnamed_addr constant [13 x i8] c"hello world\0A\00"
@caLarge = private constant [2 x i128] [ i128 12345, i128 67890 ]
@hidden = hidden global i32 7
@protected = protected global i32 23
@section = global i32 27, section ".custom"
Expand Down
17 changes: 12 additions & 5 deletions llvm/tools/llvm-c-test/echo.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -317,11 +317,18 @@ static LLVMValueRef clone_constant_impl(LLVMValueRef Cst, LLVMModuleRef M) {
return LLVMConstNull(TypeCloner(M).Clone(Cst));
}

// Try constant array or constant data array
if (LLVMIsAConstantArray(Cst) || LLVMIsAConstantDataArray(Cst)) {
check_value_kind(Cst, LLVMIsAConstantArray(Cst)
? LLVMConstantArrayValueKind
: LLVMConstantDataArrayValueKind);
// Try constant data array
if (LLVMIsAConstantDataArray(Cst)) {
check_value_kind(Cst, LLVMConstantDataArrayValueKind);
LLVMTypeRef Ty = TypeCloner(M).Clone(Cst);
size_t SizeInBytes;
const char *Data = LLVMGetRawDataValues(Cst, &SizeInBytes);
return LLVMConstDataArray(LLVMGetElementType(Ty), Data, SizeInBytes);
}

// Try constant array
if (LLVMIsAConstantArray(Cst)) {
check_value_kind(Cst, LLVMConstantArrayValueKind);
LLVMTypeRef Ty = TypeCloner(M).Clone(Cst);
uint64_t EltCount = LLVMGetArrayLength2(Ty);
SmallVector<LLVMValueRef, 8> Elts;
Expand Down
Loading