add llvm build flow from .c file
This commit is contained in:
parent
be63e84a1d
commit
6567357739
|
|
@ -26,6 +26,7 @@ endif
|
||||||
LINK = $(TESTDIR)/link.ld
|
LINK = $(TESTDIR)/link.ld
|
||||||
|
|
||||||
OFILES = $(TEST).o
|
OFILES = $(TEST).o
|
||||||
|
OUTFILES = $(TEST).out
|
||||||
|
|
||||||
VPATH = $(BUILD_DIR) $(TESTDIR)
|
VPATH = $(BUILD_DIR) $(TESTDIR)
|
||||||
TESTFILES = $(TESTDIR)/tb_top.sv $(TESTDIR)/ahb_sif.sv
|
TESTFILES = $(TESTDIR)/tb_top.sv $(TESTDIR)/ahb_sif.sv
|
||||||
|
|
@ -44,9 +45,6 @@ all: clean verilator
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -rf build obj_dir
|
rm -rf build obj_dir
|
||||||
# *.log *.hex *.dis *.tbl simv* *.map snapshots \
|
|
||||||
# verilator* *.exe obj* *.o hello_world.cpp.s ucli.key vc_hdrs.h csrc *.csv \
|
|
||||||
# work dataset.asdb library.cfg hello_world.o
|
|
||||||
|
|
||||||
# If define files do not exist, then run swerv.config.
|
# If define files do not exist, then run swerv.config.
|
||||||
${BUILD_DIR}/defines.h :
|
${BUILD_DIR}/defines.h :
|
||||||
|
|
@ -72,22 +70,32 @@ verilator: program.hex verilator-build
|
||||||
|
|
||||||
##################### Test Build #####################################
|
##################### Test Build #####################################
|
||||||
|
|
||||||
program.hex: $(OFILES) $(LINK)
|
# program.hex: $(OFILES) $(LINK)
|
||||||
@echo Building $(TEST)
|
# @echo Building $(TEST)
|
||||||
$(GCC_PREFIX)-gcc $(ABI) -Wl,-Map=$(BUILD_DIR)/$(TEST).map -lgcc -T$(LINK) -o $(BUILD_DIR)/$(TEST).exe $(BUILD_DIR)/$(OFILES) -nostartfiles $(TEST_LIBS)
|
# $(GCC_PREFIX)-gcc $(ABI) -Wl,-Map=$(BUILD_DIR)/$(TEST).map -lgcc -T$(LINK) -o $(BUILD_DIR)/$(TEST).bin $(BUILD_DIR)/$(OFILES) -nostartfiles $(TEST_LIBS)
|
||||||
$(GCC_PREFIX)-objcopy -O verilog $(BUILD_DIR)/$(TEST).exe $(BUILD_DIR)/program.hex
|
# $(GCC_PREFIX)-objcopy -O verilog $(BUILD_DIR)/$(TEST).bin $(BUILD_DIR)/program.hex
|
||||||
$(GCC_PREFIX)-objdump -S $(BUILD_DIR)/$(TEST).exe > $(BUILD_DIR)/$(TEST).dis
|
# $(GCC_PREFIX)-objdump -S $(BUILD_DIR)/$(TEST).bin > $(BUILD_DIR)/$(TEST).dis
|
||||||
@echo Completed building $(TEST)
|
# @echo Completed building $(TEST)
|
||||||
|
|
||||||
%.o : %.s ${BUILD_DIR}/defines.h
|
# %.o : %.s ${BUILD_DIR}/defines.h
|
||||||
$(GCC_PREFIX)-cpp -I${BUILD_DIR} $< > $(BUILD_DIR)/$*.cpp.s
|
# $(GCC_PREFIX)-cpp -I${BUILD_DIR} $< > $(BUILD_DIR)/$*.cpp.s
|
||||||
$(GCC_PREFIX)-as $(ABI) $(BUILD_DIR)/$*.cpp.s -o $(BUILD_DIR)/$@
|
# $(GCC_PREFIX)-as $(ABI) $(BUILD_DIR)/$*.cpp.s -o $(BUILD_DIR)/$@
|
||||||
|
|
||||||
|
program.hex: $(OUTFILES)
|
||||||
|
@echo Building $(TEST)
|
||||||
|
$(GCC_PREFIX)-objcopy -O verilog $(BUILD_DIR)/$(TEST).out $(BUILD_DIR)/program.hex
|
||||||
|
$(GCC_PREFIX)-objdump -S $(BUILD_DIR)/$(TEST).out > $(BUILD_DIR)/$(TEST).dis
|
||||||
|
|
||||||
##################### llvm hex Build #####################################
|
##################### llvm hex Build #####################################
|
||||||
|
|
||||||
%.o : %.c ${BUILD_DIR}/defines.h
|
build: $(OUTFILES)
|
||||||
|
@echo Completed building $(TEST)
|
||||||
|
|
||||||
|
%.out : %.c ${BUILD_DIR}/defines.h
|
||||||
|
$(LLVMINSTALL)/bin/clang --target=riscv32 -march=rv32gc $*.c -S -o $(BUILD_DIR)/$*.s -mno-relax
|
||||||
$(LLVMINSTALL)/bin/clang --target=riscv32 -march=rv32gc $*.c -c -o $(BUILD_DIR)/$*.o -mno-relax
|
$(LLVMINSTALL)/bin/clang --target=riscv32 -march=rv32gc $*.c -c -o $(BUILD_DIR)/$*.o -mno-relax
|
||||||
$(LLVMINSTALL)/bin/ld.lld $(BUILD_DIR)/$*.o -o $(BUILD_DIR)/$*
|
$(LLVMINSTALL)/bin/ld.lld $(BUILD_DIR)/$*.o -Map=$(BUILD_DIR)/$(TEST).map -T$(LINK) -o $(BUILD_DIR)/$*.out
|
||||||
|
@echo Completed building $(TEST)
|
||||||
|
|
||||||
help:
|
help:
|
||||||
@echo Possible targets: verilator help clean all verilator-build program.hex
|
@echo Possible targets: verilator help clean all verilator-build program.hex
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,171 @@
|
||||||
|
# hello_world binay build flow
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
In some development environments, a full featured ELF or COFF executable file cannot be accepted as an input by tools such as a flash programmer or boot loader. These tools require a simpler form of the executable that is called a binary file. This article explains these binary files.
|
||||||
|
|
||||||
|
The term binary file is misleading. Please do not confuse it with the general term for any file that contains more than plain text. As used in this article, the term binary file refers to a particular variant of binary files that are not plain text files.
|
||||||
|
|
||||||
|
## Binary Files Defined
|
||||||
|
One of the older ways to create a binary file is with the Unix utility objcopy. Here is the description of the format from the objcopy man page ...
|
||||||
|
|
||||||
|
When objcopy generates a raw binary file, it will essentially produce a memory dump of the contents of the input object file. All symbols and relocation information will be discarded. The memory dump will start at the load address of the lowest section copied into the output file.
|
||||||
|
The rest of this article elaborates on this description, and discusses related issues.
|
||||||
|
|
||||||
|
## Diagram Explanation
|
||||||
|
The left side represents a full featured ELF or COFF file named file.out. The right side represents the corresponding binary file named file.bin.
|
||||||
|
|
||||||
|
Regarding file.out ... This contrived file has three sections. The first two are initialized sections named secA and secB. The last one is an uninitialized section named .stack. For each section, a few key properties are shown. This includes the name, address, and length. For the initialized sections, the full contents of the raw data are shown. An uninitalized section like .stack reserves space in system memory, but has no contents.
|
||||||
|
|
||||||
|
Regarding file.bin ... This diagram shows the full contents of file.bin. It only contains the raw data from file.out. This raw data appears in address order. Thus secB, which is at the lowest address 0x100, appears first. There is a gap between the end of secB and the start of secA. In the simple format of a binary file, the only way to represent such a hole is to fill it.
|
||||||
|
Unintialized sections, which have no raw data, are ignored.
|
||||||
|
|
||||||
|
## Addresses in a Binary File
|
||||||
|
Compare the address with the file offset in the binary file. They are related, but they do not match. Here is one way to represent the relationship.
|
||||||
|
|
||||||
|
target address = lowest initialized address + file offset
|
||||||
|
|
||||||
|
The term lowest initalized address is the starting address of the initialized section with the lowest address. In this diagram, that is secB at address 0x100.
|
||||||
|
|
||||||
|
A binary file does not record the starting address. That detail is maintained in some other manner.
|
||||||
|
|
||||||
|
If an initialized section has different load and run addresses, the load address is used, and the run address is ignored.
|
||||||
|
|
||||||
|
## Holes in a Binary File
|
||||||
|
The format of a binary file is very simple. There is no compact way to represent a hole. The only possible way to represent a hole is to fill it.
|
||||||
|
|
||||||
|
The value zero is usually used to fill holes. If the binary file is created with a variant of an objcopy utility, see if that utilty supports an option named --gap-fill. If so, it can be used to fill a hole with a value other than zero.
|
||||||
|
|
||||||
|
## Avoiding Holes
|
||||||
|
The best way to avoid holes is to carefully control the placement of the initialized sections in the executable. Put them as close together as possible. In an ideal configuration, they are all adjacent to each other.
|
||||||
|
|
||||||
|
Sometimes holes cannot be avoided. If that is the case, see if one of these two alternatives is practical.
|
||||||
|
|
||||||
|
One alternative is to create separate bin files. If there are two clusters of initialized sections, then create one bin file for each cluster. This approach is not always practical. The utility that creates the bin file may not support it. Or, the utility that reads the bin file as input may accept only one file.
|
||||||
|
|
||||||
|
The second alternative relies on two presumptions. One, all of the initialized sections are close together accept one. Two, there is room in memory near the main cluster of initialized sections. In that case, arrange for that remaining initialized section to have different load and run addresses. It loads at an address near the main cluster of initialized sections. As part of system startup, it is copied to a different run address.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
This example matches the diagram. Therefore, it is not a realistic program. Instead, it is much smaller and easier to understand. It introduces several utilities. A good way to learn about such utilities is with small examples. Make changes in the input files, or how the utilities are used, and observe how the results change.
|
||||||
|
|
||||||
|
The TI ARM Clang compiler tools are used to build and inspect these files.
|
||||||
|
|
||||||
|
Here is the assembly source code file.s ...
|
||||||
|
|
||||||
|
```
|
||||||
|
@ file.s
|
||||||
|
|
||||||
|
.section secA,"a",%progbits
|
||||||
|
.skip 8,0xAA
|
||||||
|
|
||||||
|
.section secB,"a",%progbits
|
||||||
|
.skip 16,0xBB
|
||||||
|
|
||||||
|
.section .stack,"aw",%nobits
|
||||||
|
.zero 0x800
|
||||||
|
```
|
||||||
|
|
||||||
|
Here is the linker command file file.cmd ...
|
||||||
|
|
||||||
|
```
|
||||||
|
/* file.cmd */
|
||||||
|
|
||||||
|
/* Do NOT use this setting in a production build. It is used in this */
|
||||||
|
/* contrived example to prevent the linker from removing sections which are */
|
||||||
|
/* not used by the program. */
|
||||||
|
--unused_section_elimination=off
|
||||||
|
|
||||||
|
SECTIONS
|
||||||
|
{
|
||||||
|
secB > 0x100
|
||||||
|
secA > 0x120
|
||||||
|
.stack > 0x200
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
These commands:
|
||||||
|
|
||||||
|
1. Build file.s to create the object file file.o
|
||||||
|
2. Link file.o to create the final executable file.out. The linker map file file.map is also created.
|
||||||
|
|
||||||
|
```
|
||||||
|
% tiarmclang -c file.s
|
||||||
|
% tiarmclang file.o -o file.out -Wl,file.cmd -Wl,-m=file.map
|
||||||
|
warning: no suitable entry-point found; setting to 0
|
||||||
|
```
|
||||||
|
|
||||||
|
Ignore the warning. This example is not a real program, so there isn't an entry point.
|
||||||
|
|
||||||
|
There are few different ways to see the sections that have been created.
|
||||||
|
|
||||||
|
These are the keys lines from the linker map file file.map ...
|
||||||
|
|
||||||
|
```
|
||||||
|
secB 0 00000100 00000010
|
||||||
|
00000100 00000010 file.o (secB)
|
||||||
|
|
||||||
|
secA 0 00000120 00000008
|
||||||
|
00000120 00000008 file.o (secA)
|
||||||
|
|
||||||
|
.stack 0 00000200 00000800 UNINITIALIZED
|
||||||
|
00000200 00000800 file.o (.stack)
|
||||||
|
```
|
||||||
|
|
||||||
|
The object file display utility could be used. Here is the command and a few key lines from the output ...
|
||||||
|
|
||||||
|
```
|
||||||
|
% tiarmofd file.out
|
||||||
|
...
|
||||||
|
Section Information
|
||||||
|
|
||||||
|
id name load addr run addr size align alloc
|
||||||
|
-- ---- --------- -------- ---- ----- -----
|
||||||
|
0 (no name) 0x00000000 0x00000000 0x0 0 N
|
||||||
|
1 secB 0x00000100 0x00000100 0x10 1 Y
|
||||||
|
2 secA 0x00000120 0x00000120 0x8 1 Y
|
||||||
|
3 .stack 0x00000200 0x00000200 0x800 8 Y
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Another way to see this information is with the readelf utility ...
|
||||||
|
|
||||||
|
```
|
||||||
|
% tiarmreadelf -S file.out
|
||||||
|
...
|
||||||
|
Section Headers:
|
||||||
|
[Nr] Name Type Address Off Size ES Flg Lk Inf Al
|
||||||
|
[ 0] NULL 00000000 000000 000000 00 0 0 0
|
||||||
|
[ 1] secB PROGBITS 00000100 000034 000010 00 A 0 0 1
|
||||||
|
[ 2] secA PROGBITS 00000120 000044 000008 00 A 0 0 1
|
||||||
|
[ 3] .stack NOBITS 00000200 000050 000800 00 WA 0 0 8
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Use the the objcopy command to create the binary file file.bin.
|
||||||
|
|
||||||
|
Select text
|
||||||
|
|
||||||
|
`% tiarmobjcopy -O binary file.out file.bin`
|
||||||
|
|
||||||
|
One way to inspect a binary file is with a binary file editor. Another way is to use a utility to dump it out. Here is an example that uses a utility from Unix named od ...
|
||||||
|
|
||||||
|
Select text
|
||||||
|
% od -Ax -t x1 -w4 -v file.bin
|
||||||
|
```
|
||||||
|
000000 bb bb bb bb
|
||||||
|
000004 bb bb bb bb
|
||||||
|
000008 bb bb bb bb
|
||||||
|
00000c bb bb bb bb
|
||||||
|
000010 00 00 00 00
|
||||||
|
000014 00 00 00 00
|
||||||
|
000018 00 00 00 00
|
||||||
|
00001c 00 00 00 00
|
||||||
|
000020 aa aa aa aa
|
||||||
|
000024 aa aa aa aa
|
||||||
|
000028
|
||||||
|
```
|
||||||
|
The command line arguments to od are not standardized. Here is what they mean in this particular case.
|
||||||
|
|
||||||
|
* -Ax : Use hexadecimal for the file offset
|
||||||
|
* -t x1 : Format each byte as a separate 8-bit hex value
|
||||||
|
* -w4 : Show 4 bytes per line
|
||||||
|
* -v : Output all the lines, even if they are duplicates
|
||||||
|
|
@ -1,11 +1,166 @@
|
||||||
|
int STACK = 0x8000;
|
||||||
|
#define STDOUT 0xd0580000
|
||||||
|
|
||||||
|
__asm(".section .text_init, \"ax\"");
|
||||||
|
__asm(".global _start");
|
||||||
|
__asm("_start:");
|
||||||
|
|
||||||
|
// Enable Caches in MRAC
|
||||||
|
__asm("li t0, 0x5f555555");
|
||||||
|
__asm("csrw 0x7c0, t0");
|
||||||
|
|
||||||
|
// Set stack pointer.
|
||||||
|
__asm("la sp, STACK");
|
||||||
|
|
||||||
|
__asm("call main");
|
||||||
|
|
||||||
|
// Write 0xff to STDOUT for TB to termiate test.
|
||||||
|
__asm(".global _finish");
|
||||||
|
__asm("_finish:");
|
||||||
|
__asm("li t0, 0xd0580000");
|
||||||
|
__asm("addi t1, zero, 0xff");
|
||||||
|
__asm("sb t1, 0(t0)");
|
||||||
|
__asm("beq x0, x0, _finish");
|
||||||
|
__asm(".rept 10");
|
||||||
|
__asm("nop");
|
||||||
|
__asm(".endr");
|
||||||
|
__asm(".section .text");
|
||||||
|
|
||||||
|
#include <stdarg.h>
|
||||||
|
|
||||||
|
static int whisperPutc(char c) {
|
||||||
|
*(volatile char*)(STDOUT) = c;
|
||||||
|
return c;
|
||||||
|
}
|
||||||
|
|
||||||
|
static int whisperPuts(const char* s) {
|
||||||
|
while (*s) whisperPutc(*s++);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
static int whisperPrintDecimal(int value) {
|
||||||
|
char buffer[20];
|
||||||
|
int charCount = 0;
|
||||||
|
unsigned neg = value < 0;
|
||||||
|
if (neg) {
|
||||||
|
value = -value;
|
||||||
|
whisperPutc('-');
|
||||||
|
}
|
||||||
|
do {
|
||||||
|
char c = '0' + (value % 10);
|
||||||
|
value = value / 10;
|
||||||
|
buffer[charCount++] = c;
|
||||||
|
} while (value);
|
||||||
|
char* p = buffer + charCount - 1;
|
||||||
|
for (unsigned i = 0; i < charCount; ++i) whisperPutc(*p--);
|
||||||
|
if (neg) charCount++;
|
||||||
|
return charCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
static int whisperPrintInt(int value, int base) {
|
||||||
|
if (base == 10) return whisperPrintDecimal(value);
|
||||||
|
char buffer[20];
|
||||||
|
int charCount = 0;
|
||||||
|
unsigned uu = value;
|
||||||
|
if (base == 8) {
|
||||||
|
do {
|
||||||
|
char c = '0' + (uu & 7);
|
||||||
|
buffer[charCount++] = c;
|
||||||
|
uu >>= 3;
|
||||||
|
} while (uu);
|
||||||
|
} else if (base == 16) {
|
||||||
|
do {
|
||||||
|
int digit = uu & 0xf;
|
||||||
|
char c = digit < 10 ? '0' + digit : 'a' + digit - 10;
|
||||||
|
buffer[charCount++] = c;
|
||||||
|
uu >>= 4;
|
||||||
|
} while (uu);
|
||||||
|
} else
|
||||||
|
return -1;
|
||||||
|
char* p = buffer + charCount - 1;
|
||||||
|
for (unsigned i = 0; i < charCount; ++i) whisperPutc(*p--);
|
||||||
|
return charCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
int whisperPrintfImpl(const char* format, va_list ap) {
|
||||||
|
int count = 0; // Printed character count
|
||||||
|
for (const char* fp = format; *fp; fp++) {
|
||||||
|
if (*fp != '%') {
|
||||||
|
whisperPutc(*fp);
|
||||||
|
++count;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
++fp; // Skip %
|
||||||
|
if (*fp == 0) break;
|
||||||
|
if (*fp == '%') {
|
||||||
|
whisperPutc('%');
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (*fp == '-') {
|
||||||
|
fp++; // Pad right not yet implemented.
|
||||||
|
}
|
||||||
|
while (*fp == '0') {
|
||||||
|
fp++; // Pad zero not yet implented.
|
||||||
|
}
|
||||||
|
if (*fp == '*') {
|
||||||
|
int width = va_arg(ap, int);
|
||||||
|
fp++; // Width not yet implemented.
|
||||||
|
} else {
|
||||||
|
while (*fp >= '0' && *fp <= '9') ++fp; // Width not yet implemented.
|
||||||
|
}
|
||||||
|
switch (*fp) {
|
||||||
|
case 'd':
|
||||||
|
count += whisperPrintDecimal(va_arg(ap, int));
|
||||||
|
break;
|
||||||
|
case 'u':
|
||||||
|
count += whisperPrintDecimal((unsigned)va_arg(ap, unsigned));
|
||||||
|
break;
|
||||||
|
case 'x':
|
||||||
|
case 'X':
|
||||||
|
count += whisperPrintInt(va_arg(ap, int), 16);
|
||||||
|
break;
|
||||||
|
case 'o':
|
||||||
|
count += whisperPrintInt(va_arg(ap, int), 8);
|
||||||
|
break;
|
||||||
|
case 'c':
|
||||||
|
whisperPutc(va_arg(ap, int));
|
||||||
|
++count;
|
||||||
|
break;
|
||||||
|
case 's':
|
||||||
|
count += whisperPuts(va_arg(ap, char*));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return count;
|
||||||
|
}
|
||||||
|
|
||||||
|
int whisperPrintf(const char* format, ...) {
|
||||||
|
va_list ap;
|
||||||
|
va_start(ap, format);
|
||||||
|
int code = whisperPrintfImpl(format, ap);
|
||||||
|
va_end(ap);
|
||||||
|
return code;
|
||||||
|
}
|
||||||
|
|
||||||
|
int printf(const char* format, ...) {
|
||||||
|
va_list ap;
|
||||||
|
va_start(ap, format);
|
||||||
|
int code = whisperPrintfImpl(format, ap);
|
||||||
|
va_end(ap);
|
||||||
|
return code;
|
||||||
|
}
|
||||||
|
|
||||||
// #include <stdio.h>
|
// #include <stdio.h>
|
||||||
|
|
||||||
int add (int a,int b){
|
// int add (int a,int b){
|
||||||
return a+b;
|
// return (a+b)*(a-b);
|
||||||
}
|
// }
|
||||||
|
|
||||||
int main() {
|
int main() {
|
||||||
//printf("Hello RISCV!\n");
|
printf("Hello RISCV!\n");
|
||||||
int a = add(1,23);
|
// whisperPrintDecimal(321);
|
||||||
return a;
|
// int a = add(1,23);
|
||||||
|
// return a;
|
||||||
|
int a = 3;
|
||||||
|
return a * a;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,7 @@ ENTRY(_start)
|
||||||
SECTIONS
|
SECTIONS
|
||||||
{
|
{
|
||||||
. = 0;
|
. = 0;
|
||||||
|
.text_init : { *(.text_init*) }
|
||||||
.text : { *(.text*) }
|
.text : { *(.text*) }
|
||||||
_end = .;
|
_end = .;
|
||||||
. = 0x10000;
|
. = 0x10000;
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue