Assembly Programming Example Startup File Function Call Conventions

RISC-V Assembly Programming

Muhammad Tahir

Lecture 6

Electrical Engineering Department

University of Engineering and Technology Lahore
Assembly Programming Example Startup File Function Call Conventions

Contents

1 Assembly Programming

2 Example Startup File

3 Function Call Conventions

2/32
Assembly Programming Example Startup File Function Call Conventions

Data Processing Instructions

• Example data processing instructions and their descriptions

add x3 , x4 , x5 // x3 = x4 + x5
addi x3 , x4 , 9 // x3 = x4 + 9
xor x1 , x2 , x3 // x1 = x2 ^ x3
slt x2 , x4 , x6 // x2 = ( x4 < x6 ) ? 1:0

// load upper immediate ( lui ) used to build 32 - bit constants

lui x3 , imm // x3 = imm << 12 (20 - bit ` imm ' value )

// add upper immediate to PC ( auipc )

auipc x4 , imm // x4 = PC + ( imm < < 12)

3/32
Assembly Programming Example Startup File Function Call Conventions

Data Processing Instructions Cont’d

• Generating 32-bit constants

// Assume x6 = y
// Generating 32 - bit constant
lui x6 , 0 x12345
y = 0 x12345678 ;
addi x6 , x6 , 0 x678

4/32
Assembly Programming Example Startup File Function Call Conventions

Data Processing Instructions Cont’d

• Generating 32-bit constants

// Assume x6 = y
// Generating 32 - bit constant
lui x6 , 0 x12345
y = 0 x12345678 ;
addi x6 , x6 , 0 x678

// Assume x6 = y
// Generating 32 - bit constant
lui x6 , 0 x12346
y = 0 x12345A78 ;
addi x6 , x6 , 0 xFFFFFA78

4/32
Assembly Programming Example Startup File Function Call Conventions

Data Transfer Instructions

• Example data transfer instructions and their descriptions

lw x3 , 0 x23 ( x5 ) // x3 = Mem [ x5 + 0 x23 ][31:0]

// loads byte / halfword and sign extends it

lb x2 , 0 x34 ( x4 ) // x2 = Mem [ x4 + 0 x34 ][7:0]
lh x2 , 0 x34 ( x4 ) // x2 = Mem [ x4 + 0 x34 ][15:0]

// loads halfword and zero extends it

lhu x2 , 0 x34 ( x4 ) // x2 = Mem [ x4 + 0 x34 ][15:0]

sh x8 , 0 x45 ( x7 ) // Mem [ x7 + 0 x45 ][15:0] = x8 [15:0]

5/32
Assembly Programming Example Startup File Function Call Conventions

Data Transfer Instructions

• Example data transfer instructions and their descriptions

lw x3 , 0 x23 ( x5 ) // x3 = Mem [ x5 + 0 x23 ][31:0]

// loads byte / halfword and sign extends it

lb x2 , 0 x34 ( x4 ) // x2 = Mem [ x4 + 0 x34 ][7:0]
lh x2 , 0 x34 ( x4 ) // x2 = Mem [ x4 + 0 x34 ][15:0]

// loads halfword and zero extends it

lhu x2 , 0 x34 ( x4 ) // x2 = Mem [ x4 + 0 x34 ][15:0]

sh x8 , 0 x45 ( x7 ) // Mem [ x7 + 0 x45 ][15:0] = x8 [15:0]

• Loading a global variable (beyond 12-bit offset range)

auipc x7 , 23456 // rd = mem [ PC + 0 x23456789 ]
lw x9 , 789( x7 )

5/32
Assembly Programming Example Startup File Function Call Conventions

Flow Control Instructions

• Unconditional (jump) and conditional (branch) instructions

and their descriptions
beq rs1 , rs2 , Label // if ( rs1 == rs2 ) { PC = PC + imm }
blt rs1 , rs2 , Label // if ( rs1 < rs2 ) { PC = PC + imm }

// if x10 >= x11 or x10 < 0 , then goto OutOfBound

bgeu x10 , x11 , OutOfBound

jal x1 , Label // x1 = PC + 4; PC = PC + imm

jalr x1 , imm ( rs1 ) // x1 = PC + 4; PC = rs1 + imm

ecall // Transfer control to OS

ebreak // Transfer control to debugger

6/32
Assembly Programming Example Startup File Function Call Conventions

Flow Control Instructions Cont’d

• Calling a nearby (within 12-bit offset range) function

jal ra , Label // ra = PC + 4; PC = PC + imm = Label

7/32
Assembly Programming Example Startup File Function Call Conventions

Flow Control Instructions Cont’d

• Calling a nearby (within 12-bit offset range) function

jal ra , Label // ra = PC + 4; PC = PC + imm = Label

• Calling a far away (beyond 12-bit offset range) function

• call is the corresponding pseudo-assembly instruction
auipc ra , 0 x12345 // offset = Label - PC = 0 x12345678
jalr ra , 0 x678 ( ra ) // ra = PC + 4; PC = ra + 0 x678

7/32
Assembly Programming Example Startup File Function Call Conventions

Assembly Programming: if-else Construct

• if-else in C and assembly
• Assume f ∼ x10, g ∼ x11, h ∼ x12, i ∼ x13, j ∼ x14

if (i == j )
f = g + h;
else
f = g - h;

Listing 1: C code.

bne x13 , x14 , label # if (i == j)

add x10 , x11 , x12 # f = g + h;
j exit

label :
sub x10 , x11 , x12 # f = g - h;
exit :

Listing 2: Assembly code for if-else.

8/32
Assembly Programming Example Startup File Function Call Conventions

Assembly Programming: while Loop

• GCD algorithm in C and assembly
• Assume a ∼ x8 and b ∼ x9

addi x8 , x0 , 12
// GCD implementation based on
addi x9 , x0 , 9
Euclid algorithm
int gcd ( int a , int b)
gcd :
{
beq x8 , x9 , stop
while (a != b)
blt x8 , x9 , less
{
sub x8 , x8 , x9
if (a > b )
j gcd
a = a - b;
less :
else
sub x9 , x9 , x8
b = b - a;
j gcd
}
return a ;
stop :
}
j stop
Listing 3: C code for GCD. Listing 4: GCD assembly code.

9/32
Assembly Programming Example Startup File Function Call Conventions

Pseudo Assembly Instructions

Table 1: Selected pseudo assembly instructions.

Pseudo Instruction Base Instruction Description
nop addi x0, x0, 0 No operation
neg rd, rs sub rd, x0, 0 Two’s complement
j offset jal x0, offset Jump
mv rd, rs addi rd, rs, 0 Copy register
not rd, rs xori rd, rs,-1 One’s complement
li rd, imm lui rd, imm Load immediate uses
addi rd, rs1, imm lui and addi
ret jalr x0, ra, 0 return from function

10/32
Assembly Programming Example Startup File Function Call Conventions

Example Startup File

.equ CSR_MSTATUS , 0 x300
.equ MSTATUS_MIE , 0 x00000008
.equ CSR_MTVEC , 0 x305

# Main interrupt vector table entries

.global vtable
.type vtable , % object
.section .text . vector_table ," a " ,% progbits

# this entry is to align reset_handler at address 0 x04

.word 0 x00000013
j reset_handler
. align 2
vtable :
j default_interrupt_handler
.word 0
.word 0
j msip_handler
.word 0
.word 0

11/32
Assembly Programming Example Startup File Function Call Conventions

Example Startup File Cont’d

.word 0
j mtip_handler
.word 0
.word 0
.word 0
.word 0
.word 0
.word 0
.word 0
.word 0
j user_handler
.word 0
.word 0

12/32
Assembly Programming Example Startup File Function Call Conventions

Example Startup File Cont’d

# Weak aliases to point each exception handler to the
# ' default_interrupt_handler ', unless the application defines
# a function with the same name to override the reference .

.weak msip_handler
.set msip_handler , default_interrupt_handler
.weak mtip_handler
.set mtip_handler , default_interrupt_handler
.weak user_handler
.set user_handler , default_interrupt_handler

# Assembly ' reset handler ' function to initialize core CPU registers
.
.section .text . default_interrupt_handler ," ax " ,% progbits

.global reset_handler
.type reset_handler , @function

reset_handler :
# Set mstatus bit MIE = 1 ( enable M mode interrupts )
li t0 , 8
csrrs zero , CSR_MSTATUS , t0

13/32
Assembly Programming Example Startup File Function Call Conventions

Example Startup File Cont’d

# Load the initial stack pointer value .

la sp , _sp

# Set the vector table 's base address .

la a0 , vtable
addi a0 , a0 , 1
csrw CSR_MTVEC , a0

# Call user ' main (0 ,0) ' (. data /. bss sections initialized there )
li a0 , 0
li a1 , 0
call main

# A ' default ' handler , in case an interrupt triggers without its

handler defined
default_interrupt_handler :
j default_interrupt_handler

14/32
Assembly Programming Example Startup File Function Call Conventions

Example Interrupt Service Routine

# RISC -V Interrupt Service Routines ( ISRs )

# ALL supported ISRs should be put here

.section .text . isr

# User interrupt handler

. globl user_handler
user_handler :
nop
# you can call user ISR here and then return using 'mret '
mret

15/32
Assembly Programming Example Startup File Function Call Conventions

Function Call Conventions

• Function parameters and return values conventions

• Put parameters in a place where the function being called
(callee) can access them
• Transfer control to the callee
• Acquire (local) resources required by the callee
• Perform desired task of the callee
• Put result(s) in a place where caller (point of origin) can
access it
• Return control to caller

16/32
Assembly Programming Example Startup File Function Call Conventions

Function Call Conventions Cont’d

• Registers for parameter passing
• Registers are faster than memory, use them for parameter
passing and return values
• a0–a7 (x10-x17): eight registers for passing parameters
• a0–a1 (x10-x11): two registers for return values
• ra (x1): return address register to return to point of origin

17/32
Assembly Programming Example Startup File Function Call Conventions

Function Call Conventions Cont’d

• Registers for parameter passing
• Registers are faster than memory, use them for parameter
passing and return values
• a0–a7 (x10-x17): eight registers for passing parameters
• a0–a1 (x10-x11): two registers for return values
• ra (x1): return address register to return to point of origin
• Registers preserved across function calls
• sp, gp, tp, s0- s11 (saved registers, s0 is also frame pointer
(fp))

17/32
Assembly Programming Example Startup File Function Call Conventions

Function Call Conventions Cont’d

• Registers for parameter passing
• Registers are faster than memory, use them for parameter
passing and return values
• a0–a7 (x10-x17): eight registers for passing parameters
• a0–a1 (x10-x11): two registers for return values
• ra (x1): return address register to return to point of origin
• Registers preserved across function calls
• sp, gp, tp, s0- s11 (saved registers, s0 is also frame pointer
(fp))
• Registers that are not preserved across function calls
• a0-a7 (argument and return registers), ra, t0-t6 (temporary
registers)

17/32
Assembly Programming Example Startup File Function Call Conventions

Function Call Conventions Cont’d

Table 2: Assembler mnemonics and register conventions for RV32I.

Register ABI Name Description Saver
x0 zero Hardwired to 0 —
x1 ra Return address for subroutine calls Caller
x2 sp Stack pointer Callee
x3 gp Global Pointer —
x4 tp Thread pointer —
x5-x7 t0-t2 Memory temporary registers Caller
x8 s0/fp Frame pointer Callee
x9 s1 Saved register Callee
x10-x11 a0-a1 Arguments to subroutines/return values Caller
x12-x17 a2-a7 Arguments to subroutines Caller
x18-x27 s2-s11 Saved registers Callee
x28-x31 t3-t6 Temporary registers Caller

18/32
Assembly Programming Example Startup File Function Call Conventions

Memory Allocation

• An example memory allocation for program and data

0xBFFF FFF0
fp Stack
sp

Dynamic Data

Static Data
(global &static variables)
gp 0x1000 0000
Text
(code segment)
pc 0x0001 0000

Vector Table
0x0000 0000

19/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example

int add ( int x , int y) {

return x +y;
}

int main ( void ) {

// declare some variables
int x = 123 , y = 987 , z = 0;

// call the user function

z = add (x ,y) ;

// endless loop
while (1) {}
}

20/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

1 - Stack pointer is adjusted

21/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

2 - Save old frame pointer
(fp/s0)

22/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

3 - Frame pointer (fp/s0) points to
the start of stack frame

23/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

4 - Save the function arguments

24/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

5 - Make a local copy of the function
arguments

25/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

6 - Perform actual operation

26/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

7 - Return the result

27/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

8 - Revert the frame pointer (s0)
and stack pointer (sp)

28/32
Assembly Programming Example Startup File Function Call Conventions

Caller-Callee Working Example Cont’d

9 - Return from the function
(jalr x0, ra, 0)

29/32
Assembly Programming Example Startup File Function Call Conventions

Suggested Reading

• Read Chapter 2 of [Patterson and Hennessy, 2021].

• Read User Manual for the instruction set and its architecture
[Waterman et al., 2016b].

30/32
Assembly Programming Example Startup File Function Call Conventions

Acknowledgment

• Preparation of this material was partly supported by Lampro

Mellon Pakistan.

31/32
Assembly Programming Example Startup File Function Call Conventions

References

Patterson, D. and Hennessy, J. (2021).

Computer Organization and Design RISC-V Edition: The Hardware
Software Interface, 2nd Edition.
Morgan Kaufmann.

Waterman, A., Lee, Y., Avizienis, R., Patterson, D. A., and Asanovic, K.
(2016a).
The risc-v instruction set manual volume ii: Privileged architecture version
1.9.
EECS Department, University of California, Berkeley, Tech. Rep.
UCB/EECS-2016-129.

Waterman, A., Lee, Y., Patterson, D. A., and Asanović, K. (2016b).

The risc-v instruction set manual, volume i: User-level isa, version 2.1.
EECS Department, University of California, Berkeley, Tech. Rep.
UCB/EECS-2016-129.

32/32