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 › debug › cpu_context › Hexagon Private Struct Hexagon Doc Source Private Struct std.debug.cpu_context.Hexagon
const Hexagon = extern struct Fields r : [32 ]Gpr The numbered general-purpose registers r0 - r31.
pc : Gpr Values Functions File debug/cpu_context.zig: 563
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636 const Hexagon = extern struct {
/// The numbered general-purpose registers r0 - r31.
r : [32 ]Gpr ,
pc : Gpr ,
pub const Gpr = u32 ;
pub inline fn current () Hexagon {
var ctx : Hexagon = undefined ;
asm volatile (
\\ memw(r0 + #0) = r0
\\ memw(r0 + #4) = r1
\\ memw(r0 + #8) = r2
\\ memw(r0 + #12) = r3
\\ memw(r0 + #16) = r4
\\ memw(r0 + #20) = r5
\\ memw(r0 + #24) = r6
\\ memw(r0 + #28) = r7
\\ memw(r0 + #32) = r8
\\ memw(r0 + #36) = r9
\\ memw(r0 + #40) = r10
\\ memw(r0 + #44) = r11
\\ memw(r0 + #48) = r12
\\ memw(r0 + #52) = r13
\\ memw(r0 + #56) = r14
\\ memw(r0 + #60) = r15
\\ memw(r0 + #64) = r16
\\ memw(r0 + #68) = r17
\\ memw(r0 + #72) = r18
\\ memw(r0 + #76) = r19
\\ memw(r0 + #80) = r20
\\ memw(r0 + #84) = r21
\\ memw(r0 + #88) = r22
\\ memw(r0 + #92) = r23
\\ memw(r0 + #96) = r24
\\ memw(r0 + #100) = r25
\\ memw(r0 + #104) = r26
\\ memw(r0 + #108) = r27
\\ memw(r0 + #112) = r28
\\ memw(r0 + #116) = r29
\\ memw(r0 + #120) = r30
\\ memw(r0 + #124) = r31
\\ r1 = pc
\\ memw(r0 + #128) = r1
:
: [ctx ] "{r0}" (&ctx ),
: .{ .r1 = true , .memory = true });
return ctx ;
}
pub fn getFp (ctx : *const Hexagon ) usize {
return ctx .r [30 ];
}
pub fn getPc (ctx : *const Hexagon ) usize {
return ctx .pc ;
}
pub fn dwarfRegisterBytes (ctx : *Hexagon , register_num : u16 ) DwarfRegisterError ![]u8 {
// Sourced from LLVM's HexagonRegisterInfo.td, which disagrees with LLDB...
switch (register_num ) {
0 ...31 => return @ptrCast (&ctx .r [register_num ]),
76 => return @ptrCast (&ctx .pc ),
// This is probably covering some numbers that aren't actually mapped, but seriously,
// look at that file. I really can't be bothered to make it more precise.
32 ...75 => return error .UnsupportedRegister ,
77 ...259 => return error .UnsupportedRegister ,
// 999999...1000030 => return error.UnsupportedRegister,
// 9999999...10000030 => return error.UnsupportedRegister,
else => return error .InvalidRegister ,
}
}
}
This is an
extern structso that inline assembly incurrentcan use field offsets.