---
name: "dwarf_get_relocation_info"
section: "3"
platform: "freebsd"
package: "base"
version: "16.0-CURRENT-20261027-61c70dc16a79"
release: "FreeBSD 16.0-CURRENT (2026-10-27)"
platforms: ["freebsd"]
url: "https://new.carta.tech/dwarf_get_relocation_info"
---

# dwarf\_get\_relocation\_info(3)

retrieve generated relocation arrays

## NAME

**dwarf\_get\_relocation\_info** – retrieve generated relocation arrays

## LIBRARY

library “libdwarf”

## SYNOPSIS

**#include \<libdwarf.h\>**

*int*\

**dwarf\_get\_relocation\_info**(*Dwarf\_P\_Debug dbg*, *Dwarf\_Signed \*elf\_section\_index*, *Dwarf\_Signed \*elf\_section\_link*, *Dwarf\_Unsigned \*reloc\_entry\_count*, *Dwarf\_Relocation\_Data \*reloc\_buf*, *Dwarf\_Error \*err*);

## DESCRIPTION

The function **dwarf\_get\_relocation\_info**() is used to retrieve the relocation arrays generated by a prior call to [dwarf\_transform\_to\_disk\_form(3)](/dwarf_transform_to_disk_form/3.md).

Each call to this function retrieves the next available relocation array. Application code should call this function repeatly to retrieve all the relocation arrays. The total number of generated relocation arrays retrievable by this function may be obtained by calling function [dwarf\_get\_relocation\_info\_count(3)](/dwarf_get_relocation_info_count/3.md).

Argument *dbg* should reference a DWARF producer instance allocated using [dwarf\_producer\_init(3)](/dwarf_producer_init/3.md) in sequence. or [dwarf\_producer\_init\_b(3)](/dwarf_producer_init_b/3.md). The DW\_DLC\_SYMBOLIC\_RELOCATIONS flag should have been set on the DWARF producer instance.

Argument *elf\_section\_index* should point to a location which will be set to the ELF section index of the relocation section to which the retrieved relocation array belongs.

Argument *elf\_section\_link* should point to a location which will be set to the section index of the ELF section to which the retrieved relocation array applies.

Argument *reloc\_entry\_count* should point to a location which will be set to the total number of relocation entries contained in the relocation array.

Argument *reloc\_buf* should point to a location which will be set to a pointer to the retrieved array of relocation entries.

If argument *err* is not NULL, it will be used to store error information in case of an error.

The retrieved relocation entries are described using structure *Dwarf\_Relocation\_Data\_s*, defined in the header file ⟨libdwarf.h⟩:

```
typedef struct Dwarf_Relocation_Data_s {
	unsigned char drd_type;
	unsigned char drd_length;
	Dwarf_Unsigned drd_offset;
	Dwarf_Unsigned drd_symbol_index;
} *Dwarf_Relocation_Data;
```

Struct *Dwarf\_Relocation\_Data\_s* consists of following fields:

- *drd\_type*

  The type code of the relocation entry. The *Dwarf\_Rel\_Type* enumeration defined in the header file ⟨libdwarf.h⟩ specifies legal values for this field.

- *drd\_length*

  The size in bytes of the field to be relocated.

- *drd\_offset*

  The section-relative offset of the field to be relocated.

- *drd\_symbol\_index*

  The symbol index associated with the relocation entry.

### Memory Management

The memory area used for the relocation arrays is managed by the library “libdwarf”. The function **dwarf\_producer\_finish**() may be used to release it, along with other resources associated with the producer instance.

## RETURN VALUES

On success, function **dwarf\_get\_relocation\_info**() returns DW\_DLV\_OK. It returns DW\_DLV\_NO\_ENTRY if there were no more relocation arrays to retrieve, or if the flag DW\_DLC\_SYMBOLIC\_RELOCATIONS was not set on the producer instance. In case of an error, function **dwarf\_get\_relocation\_info**() returns DW\_DLV\_ERROR and sets the argument *err*.

## EXAMPLES

To generate relocation entries and retrieve them, use:

```
Dwarf_P_Debug dbg;
Dwarf_Relocation_Data buf;
Dwarf_Signed count, index, link;
Dwarf_Unsigned reloc_cnt, entry_cnt;
Dwarf_Error de;
int version, i, j;
/*
 * Assume that dbg refers to a DWARF producer instance created
 * created with DW_DLC_SYMBOLIC_RELOCATIONS flag set and that
 * application code has added DWARF debugging information
 * to the producer instance.
 */
if ((count = dwarf_transform_to_disk_form(dbg, &de)) ==
    DW_DLV_NOCOUNT) {
	warnx("dwarf_transform_to_disk_form failed: %s",
	    dwarf_errmsg(-1));
	return;
}
/* ... process generated section byte streams ... */
if (dwarf_get_relocation_info_count(dbg, &reloc_cnt, &version, &de) !=
    DW_DLV_OK) {
	warnx("dwarf_get_relocation_info_count failed: %s",
	    dwarf_errmsg(-1));
	return;
}
for (i = 0; (Dwarf_Unsigned) i < reloc_cnt; i++) {
	if (dwarf_get_relocation_info(dbg, &index, &link, &entry_cnt,
	    &buf, &de) != DW_DLV_OK) {
		warnx("dwarf_get_relocation_info failed: %s",
		    dwarf_errmsg(-1));
		continue;
	}
	for (j = 0; (Dwarf_Unsigned) j < entry_cnt; j++) {
		/* ...use each reloc data in buf[j]... */
	}
}
dwarf_producer_finish(dbg, &de);
```

## ERRORS

Function **dwarf\_get\_relocation\_info**() can fail with:

- \[DW\_DLE\_ARGUMENT\]

  One of the arguments *dbg*, *elf\_section\_index*, *elf\_section\_link*, *reloc\_entry\_count* or *reloc\_buf* was NULL.

- \[DW\_DLE\_NO\_ENTRY\]

  There were no more ELF relocation arrays to retrieve.

- \[DW\_DLE\_NO\_ENTRY\]

  The flag DW\_DLC\_SYMBOLIC\_RELOCATIONS was not set on the producer instance.

- \[DW\_DLE\_NO\_ENTRY\]

  Function [dwarf\_transform\_to\_disk\_form(3)](/dwarf_transform_to_disk_form/3.md) was not called prior to calling function **dwarf\_get\_relocation\_info**().

## SEE ALSO

[dwarf(3)](/dwarf/3.md), [dwarf\_get\_relocation\_info\_count(3)](/dwarf_get_relocation_info_count/3.md), dwarf\_producer\_finish(3), [dwarf\_producer\_init(3)](/dwarf_producer_init/3.md), [dwarf\_producer\_init\_b(3)](/dwarf_producer_init_b/3.md), [dwarf\_reset\_section\_bytes(3)](/dwarf_reset_section_bytes/3.md), [dwarf\_transform\_to\_disk\_form(3)](/dwarf_transform_to_disk_form/3.md)