Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › pie › relocate Public Function relocate Doc Source Public Function std.pie.relocate
pub fn relocate (phdrs : []const elf .ElfN .Phdr ) void Params phdrs : []const elf .ElfN .Phdr File pie.zig: 317
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416 pub fn relocate (phdrs : []const elf .ElfN .Phdr ) void {
@setRuntimeSafety (false );
@disableInstrumentation ();
const dynv = getDynamicSymbol ();
// Recover the delta applied by the loader by comparing the effective and
// the theoretical load addresses for the `_DYNAMIC` symbol.
const base_addr = base : {
for (phdrs ) |*phdr | {
if (phdr .type != .DYNAMIC ) continue ;
break :base @intFromPtr (dynv ) - phdr .vaddr ;
}
// This is not supposed to happen for well-formed binaries.
@trap ();
};
var sorted_dynv : [elf .DT_NUM ]elf .Addr = undefined ;
// Zero-initialized this way to prevent the compiler from turning this into
// `memcpy` or `memset` calls (which can require relocations).
for (&sorted_dynv ) |*dyn | {
const pdyn : *volatile elf .Addr = @ptrCast (dyn );
pdyn .* = 0 ;
}
{
// `dynv` has no defined order. Fix that.
var i : usize = 0 ;
while (dynv [i ].d_tag != elf .DT_NULL ) : (i += 1 ) {
if (dynv [i ].d_tag < elf .DT_NUM ) sorted_dynv [@bitCast (dynv [i ].d_tag )] = dynv [i ].d_val ;
}
}
// Deal with the GOT relocations that MIPS uses first.
if (builtin .cpu .arch .isMIPS ()) {
const count : elf .Addr = blk : {
// This is an architecture-specific tag, so not part of `sorted_dynv`.
var i : usize = 0 ;
while (dynv [i ].d_tag != elf .DT_NULL ) : (i += 1 ) {
if (dynv [i ].d_tag == elf .DT_MIPS_LOCAL_GOTNO ) break :blk dynv [i ].d_val ;
}
break :blk 0 ;
};
const got : [*]usize = @ptrFromInt (base_addr + sorted_dynv [elf .DT_PLTGOT ]);
for (0 ..count ) |i | {
got [i ] += base_addr ;
}
}
// Apply normal relocations.
const rel = sorted_dynv [elf .DT_REL ];
if (rel != 0 ) {
const rels : []const elf .Rel = @ptrCast (@alignCast (
@as ([*]align (@alignOf (elf .Rel )) const u8 , @ptrFromInt (base_addr + rel ))[0 ..sorted_dynv [elf .DT_RELSZ ]],
));
for (rels ) |r | {
if (r .r_type () != R_RELATIVE ) continue ;
@as (*usize , @ptrFromInt (base_addr + r .r_offset )).* += base_addr ;
}
}
const rela = sorted_dynv [elf .DT_RELA ];
if (rela != 0 ) {
const relas : []const elf .Rela = @ptrCast (@alignCast (
@as ([*]align (@alignOf (elf .Rela )) const u8 , @ptrFromInt (base_addr + rela ))[0 ..sorted_dynv [elf .DT_RELASZ ]],
));
for (relas ) |r | {
if (r .r_type () != R_RELATIVE ) continue ;
@as (*usize , @ptrFromInt (base_addr + r .r_offset )).* = base_addr + @as (usize , @bitCast (r .r_addend ));
}
}
const relr = sorted_dynv [elf .DT_RELR ];
if (relr != 0 ) {
const relrs : []const elf .Relr = @ptrCast (
@as ([*]align (@alignOf (elf .Relr )) const u8 , @ptrFromInt (base_addr + relr ))[0 ..sorted_dynv [elf .DT_RELRSZ ]],
);
var current : [*]usize = undefined ;
for (relrs ) |r | {
if ((r & 1 ) == 0 ) {
current = @ptrFromInt (base_addr + r );
current [0 ] += base_addr ;
current += 1 ;
} else {
// Skip the first bit; there are 63 locations in the bitmap.
var i : if (@sizeOf (usize ) == 8 ) u6 else u5 = 1 ;
while (i < @bitSizeOf (elf .Relr )) : (i += 1 ) {
if (((r >> i ) & 1 ) != 0 ) current [i ] += base_addr ;
}
current += @bitSizeOf (elf .Relr ) - 1 ;
}
}
}
}