From 1627cc77331fb9a347ff80512e801b8d71552918 Mon Sep 17 00:00:00 2001 From: Stephen Marz Date: Sat, 25 Apr 2020 21:23:00 -0400 Subject: [PATCH] Read and start a process...Added userspace library...will switch this to newlib later. --- risc_v/src/assembly.rs | 3 +- risc_v/src/cpu.rs | 10 +- risc_v/src/process.rs | 46 +- risc_v/src/syscall.rs | 9 +- risc_v/src/test.rs | 89 +- risc_v/src/userspace/.gitignore | 6 + risc_v/src/userspace/Makefile | 23 + risc_v/src/userspace/helloworld.cpp | 8 + risc_v/src/userspace/shell.cpp | 10 + risc_v/src/userspace/sleepy.cpp | 11 + risc_v/src/userspace/startlib/.gitignore | 2 + risc_v/src/userspace/startlib/Makefile | 25 + risc_v/src/userspace/startlib/linker.lds | 49 + risc_v/src/userspace/startlib/printf.cpp | 1042 ++++++++++++++++++++++ risc_v/src/userspace/startlib/printf.h | 113 +++ risc_v/src/userspace/startlib/start.S | 10 + risc_v/src/userspace/startlib/syscall.S | 14 + risc_v/src/userspace/startlib/syscall.h | 14 + 18 files changed, 1453 insertions(+), 31 deletions(-) create mode 100644 risc_v/src/userspace/.gitignore create mode 100644 risc_v/src/userspace/Makefile create mode 100644 risc_v/src/userspace/helloworld.cpp create mode 100644 risc_v/src/userspace/shell.cpp create mode 100644 risc_v/src/userspace/sleepy.cpp create mode 100644 risc_v/src/userspace/startlib/.gitignore create mode 100644 risc_v/src/userspace/startlib/Makefile create mode 100644 risc_v/src/userspace/startlib/linker.lds create mode 100644 risc_v/src/userspace/startlib/printf.cpp create mode 100644 risc_v/src/userspace/startlib/printf.h create mode 100644 risc_v/src/userspace/startlib/start.S create mode 100644 risc_v/src/userspace/startlib/syscall.S create mode 100644 risc_v/src/userspace/startlib/syscall.h diff --git a/risc_v/src/assembly.rs b/risc_v/src/assembly.rs index 53f1256..a6196bb 100644 --- a/risc_v/src/assembly.rs +++ b/risc_v/src/assembly.rs @@ -8,4 +8,5 @@ // import a full assembly file, which is what I want here. global_asm!(include_str!("asm/boot.S")); global_asm!(include_str!("asm/mem.S")); -global_asm!(include_str!("asm/trap.S")); \ No newline at end of file +global_asm!(include_str!("asm/trap.S")); + diff --git a/risc_v/src/cpu.rs b/risc_v/src/cpu.rs index fb15f7f..9c63dd2 100755 --- a/risc_v/src/cpu.rs +++ b/risc_v/src/cpu.rs @@ -242,19 +242,21 @@ pub fn get_mtime() -> usize { /// Copy one data from one memory location to another. pub unsafe fn memcpy(dest: *mut u8, src: *const u8, bytes: usize) { let bytes_as_8 = bytes / 8; - let bytes_as_1 = bytes % 8; let dest_as_8 = dest as *mut u64; let src_as_8 = src as *const u64; for i in 0..bytes_as_8 { *(dest_as_8.add(i)) = *(src_as_8.add(i)); } - let bytes_remaining = bytes_as_8 * 8; - for i in bytes_remaining..bytes_remaining + bytes_as_1 { + let bytes_completed = bytes_as_8 * 8; + let bytes_remaining = bytes - bytes_completed; + for i in bytes_completed..bytes_remaining { *(dest.add(i)) = *(src.add(i)); } } +/// Dumps the registers of a given trap frame. This is NOT the +/// current CPU registers! pub fn dump_registers(frame: *const TrapFrame) { print!(" "); for i in 1..32 { @@ -262,7 +264,7 @@ pub fn dump_registers(frame: *const TrapFrame) { println!(); print!(" "); } - print!("{:2}:{:08x} ", i, unsafe { (*frame).regs[i] }); + print!("x{:2}:{:08x} ", i, unsafe { (*frame).regs[i] }); } println!(); } diff --git a/risc_v/src/process.rs b/risc_v/src/process.rs index 721193d..c39bcc1 100644 --- a/risc_v/src/process.rs +++ b/risc_v/src/process.rs @@ -23,13 +23,13 @@ use core::ptr::null_mut; // How many pages are we going to give a process for their // stack? -const STACK_PAGES: usize = 5; +pub const STACK_PAGES: usize = 5; // We want to adjust the stack to be at the bottom of the memory allocation // regardless of where it is on the kernel heap. -const STACK_ADDR: usize = 0x1_0000_0000; +pub const STACK_ADDR: usize = 0x1_0000_0000; // All processes will have a defined starting point in virtual memory. // We will use this later when we load processes from disk. -// const PROCESS_STARTING_ADDR: usize = 0x2000_0000; +pub const PROCESS_STARTING_ADDR: usize = 0x2000_0000; // Here, we store a process list. It uses the global allocator // that we made before and its job is to store all processes. @@ -43,7 +43,7 @@ const STACK_ADDR: usize = 0x1_0000_0000; pub static mut PROCESS_LIST: Option> = None; // We can search through the process list to get a new PID, but // it's probably easier and faster just to increase the pid: -static mut NEXT_PID: u16 = 1; +pub static mut NEXT_PID: u16 = 1; // The following set_* and get_by_pid functions are C-style functions // They probably need to be re-written in a more Rusty style, but for @@ -170,12 +170,13 @@ pub unsafe fn get_by_pid(pid: u16) -> *mut Process { fn init_process() { // We can't do much here until we have system calls because // we're running in User space. + println!("Init process started..."); loop { // Alright, I forgot. We cannot put init to sleep since the // scheduler will loop until it finds a process to run. Since // the scheduler is called in an interrupt context, nothing else // can happen until a process becomes available. - println!("Init is still here :), alright, back to sleep."); + // println!("Init is still here :), alright, back to sleep."); // 500 wfi's should take 500 context switches before we print // Init is still here. Depending on our context switch time, // this might be around 3 seconds. @@ -246,7 +247,9 @@ pub fn add_kernel_process(func: fn()) -> u16 { root: zalloc(1) as *mut Table, state: ProcessState::Running, data: ProcessData::zero(), - sleep_until: 0, }; + sleep_until: 0, + program: null_mut() + }; unsafe { NEXT_PID += 1; } @@ -325,7 +328,9 @@ pub fn add_kernel_process_args(func: fn(args_ptr: usize), args: usize) -> u16 { root: zalloc(1) as *mut Table, state: ProcessState::Running, data: ProcessData::zero(), - sleep_until: 0, }; + sleep_until: 0, + program: null_mut(), + }; unsafe { NEXT_PID += 1; } @@ -406,13 +411,14 @@ pub enum ProcessState { } pub struct Process { - frame: *mut TrapFrame, - stack: *mut u8, - pid: u16, - root: *mut Table, - state: ProcessState, - data: ProcessData, - sleep_until: usize, + pub frame: *mut TrapFrame, + pub stack: *mut u8, + pub pid: u16, + pub root: *mut Table, + pub state: ProcessState, + pub data: ProcessData, + pub sleep_until: usize, + pub program: *mut u8, } // Most of this operating system runs more of a C-style, where @@ -423,6 +429,7 @@ pub struct Process { // the first parameter (the *this parameter in C++) is a reference // to ourself. We can write static functions as a member of this // structure by omitting a self. +// 25-Apr-2020: (SM) Alright, I made everything public...... impl Process { pub fn get_frame_address(&self) -> usize { self.frame as usize @@ -440,6 +447,10 @@ impl Process { unsafe { (*self.frame).pc } } + pub fn get_program_address_mut(&mut self) -> *mut u8 { + self.program + } + pub fn get_table_address(&self) -> usize { self.root as usize } @@ -478,7 +489,9 @@ impl Process { root: zalloc(1) as *mut Table, state: ProcessState::Running, data: ProcessData::zero(), - sleep_until: 0, }; + sleep_until: 0, + program: null_mut() + }; unsafe { satp_fence_asid(NEXT_PID as usize); NEXT_PID += 1; @@ -557,6 +570,9 @@ impl Drop for Process { } dealloc(self.root as *mut u8); dealloc(self.frame as *mut u8); + if !self.program.is_null() { + dealloc(self.program); + } } } diff --git a/risc_v/src/syscall.rs b/risc_v/src/syscall.rs index 7fbaec5..88903ee 100755 --- a/risc_v/src/syscall.rs +++ b/risc_v/src/syscall.rs @@ -27,11 +27,16 @@ pub unsafe fn do_syscall(mepc: usize, frame: *mut TrapFrame) -> usize { delete_process((*frame).pid as u16); 0 }, - 1 => { + 2 => { + // Easy putchar + print!("{}", (*frame).regs[10] as u8 as char); + mepc + 4 + }, + 8 => { dump_registers(frame); mepc + 4 }, - 2 => { + 10 => { // Sleep set_sleeping((*frame).pid as u16, (*frame).regs[10]); 0 diff --git a/risc_v/src/test.rs b/risc_v/src/test.rs index 84bbceb..1b3e92c 100644 --- a/risc_v/src/test.rs +++ b/risc_v/src/test.rs @@ -1,22 +1,93 @@ // test.rs use crate::{kmem::{kfree, kmalloc}, - syscall::syscall_fs_read}; + process::{Process, + NEXT_PID, + PROCESS_LIST, + PROCESS_STARTING_ADDR, + STACK_ADDR, + STACK_PAGES, ProcessState, ProcessData}, + syscall::syscall_fs_read}; +use crate::page::{zalloc, Table, map, EntryBits}; +use crate::cpu::{memcpy, TrapFrame, CpuMode, satp_fence_asid, SatpMode, build_satp}; pub fn test_block() { // Let's test the block driver! let bytes_to_read = 1024 * 50; let buffer = kmalloc(bytes_to_read); - unsafe { - let bytes_read = - syscall_fs_read(8, 5, buffer, bytes_to_read as u32, 0); - println!("FS Read returned {} bytes", bytes_read); - for i in 0..16 * 4 { - print!("{:02x} ", buffer.add(i).read()); - if (i + 1) % 16 == 0 { - println!(); + let bytes_read = syscall_fs_read(8, 8, buffer, bytes_to_read as u32, 0); + if bytes_read != 12288 { + println!( + "Unable to load program at inode 8, which should be \ + 12,288 bytes, got {}", + bytes_read + ); + } + else { + // Let's get this program running! + let program_pages = (bytes_read / 4096) + 1; + let my_pid = unsafe { NEXT_PID + 1 }; + unsafe { + NEXT_PID += 1; + } + let mut my_proc= + Process { frame: zalloc(1) as *mut TrapFrame, + stack: zalloc(STACK_PAGES), + pid: my_pid, + root: zalloc(1) as *mut Table, + state: ProcessState::Running, + data: ProcessData::zero(), + sleep_until: 0, + program: zalloc(program_pages) + }; + // Map the program in the MMU. + let ptr = my_proc.program; + unsafe { + memcpy(ptr, buffer, bytes_read); + } + let table = unsafe { my_proc.root.as_mut().unwrap() }; + for i in 0..program_pages { + let vaddr = PROCESS_STARTING_ADDR + (i << 12); + let paddr = ptr as usize + (i << 12); + map(table, vaddr, paddr, EntryBits::UserReadWriteExecute.val(), 0); + } + // Map the stack + let ptr = my_proc.stack as *mut u8; + for i in 0..STACK_PAGES { + let vaddr = STACK_ADDR + (i << 12); + let paddr = ptr as usize + (i << 12); + map(table, vaddr, paddr, EntryBits::UserReadWrite.val(), 0); + } + // Set everything up in the trap frame + unsafe { + (*my_proc.frame).pc = PROCESS_STARTING_ADDR; + // Stack pointer + (*my_proc.frame).regs[2] = + STACK_ADDR as usize + STACK_PAGES * 4096; + (*my_proc.frame).mode = CpuMode::User as usize; + (*my_proc.frame).pid = my_proc.pid as usize; + } + unsafe { + (*my_proc.frame).satp = + build_satp( + SatpMode::Sv39, + my_proc.pid as usize, + my_proc.root as usize, + ); + } + if let Some(mut pl) = unsafe { PROCESS_LIST.take() } { + pl.push_back(my_proc); + unsafe { + PROCESS_LIST.replace(pl); } } + else { + println!("Unable to spawn process."); + // Since my_proc couldn't enter the process list, it will + // be dropped and all of the associated allocations will + // be deallocated. + + } } println!(); kfree(buffer); diff --git a/risc_v/src/userspace/.gitignore b/risc_v/src/userspace/.gitignore new file mode 100644 index 0000000..3f634e2 --- /dev/null +++ b/risc_v/src/userspace/.gitignore @@ -0,0 +1,6 @@ +helloworld +helloworld.elf +sleepy +sleepy.elf +shell +shell.elf diff --git a/risc_v/src/userspace/Makefile b/risc_v/src/userspace/Makefile new file mode 100644 index 0000000..abcaf71 --- /dev/null +++ b/risc_v/src/userspace/Makefile @@ -0,0 +1,23 @@ +CROSS=riscv64-unknown-elf- +CXX=g++ +OBJCOPY=objcopy +CXXFLAGS=-Wall -O0 -ffreestanding -nostartfiles -nostdlib -static -march=rv64g -mabi=lp64d +LINKER_SCRIPT=-T./startlib/linker.lds +INCLUDES=-I./startlib +LIBS=-L./startlib +LIB=-lstart +SOURCES=$(wildcard *.cpp) +OUT=$(patsubst %.cpp,%.elf,$(SOURCES)) +PROGS=$(patsubst %.cpp,%,$(SOURCES)) + +all: $(OUT) + +%.elf:%.cpp Makefile + $(CROSS)$(CXX) $(CXXFLAGS) $(LINKER_SCRIPT) $(INCLUDES) $(LIBS) -o $@ $< $(LIB) + $(CROSS)$(OBJCOPY) -O binary $@ $@.bin + mv $@.bin $(basename $@) + +clean: + rm -f $(OUT) + rm -f *.bin *.elf + rm -f $(PROGS) diff --git a/risc_v/src/userspace/helloworld.cpp b/risc_v/src/userspace/helloworld.cpp new file mode 100644 index 0000000..1f69ddb --- /dev/null +++ b/risc_v/src/userspace/helloworld.cpp @@ -0,0 +1,8 @@ +#include +#include + +int main() +{ + printf("Hello World\n"); + return 0; +} diff --git a/risc_v/src/userspace/shell.cpp b/risc_v/src/userspace/shell.cpp new file mode 100644 index 0000000..f9f23d7 --- /dev/null +++ b/risc_v/src/userspace/shell.cpp @@ -0,0 +1,10 @@ +#include +#include + +int main() +{ + unsigned long a; + asm volatile("mv %0, sp\n" : "=r"(a)); + printf("Stack is at %p\n", a); + return 0; +} diff --git a/risc_v/src/userspace/sleepy.cpp b/risc_v/src/userspace/sleepy.cpp new file mode 100644 index 0000000..9f8cfde --- /dev/null +++ b/risc_v/src/userspace/sleepy.cpp @@ -0,0 +1,11 @@ +#include +#include + +int main() +{ + printf("I'm going to bed.\nYou can watch me sleep for 100 switches using 'top'\n"); + for (int i = 0;i < 100;i++) { + syscall_sleep(1000000); + } + return 0; +} diff --git a/risc_v/src/userspace/startlib/.gitignore b/risc_v/src/userspace/startlib/.gitignore new file mode 100644 index 0000000..9eca6c8 --- /dev/null +++ b/risc_v/src/userspace/startlib/.gitignore @@ -0,0 +1,2 @@ +*.a +*.o diff --git a/risc_v/src/userspace/startlib/Makefile b/risc_v/src/userspace/startlib/Makefile new file mode 100644 index 0000000..7824518 --- /dev/null +++ b/risc_v/src/userspace/startlib/Makefile @@ -0,0 +1,25 @@ +CROSS=riscv64-unknown-elf- +CXX=g++ +OBJCOPY=objcopy +AR=ar +CXXFLAGS=-Wall -O0 -ffreestanding -nostartfiles -nostdlib -I. -march=rv64g -mabi=lp64d +OUT=libstart.a +SOURCES_S=$(wildcard *.S) +SOURCES_CPP=$(wildcard *.cpp) +OBJS=$(patsubst %.S,%.o,$(SOURCES_S)) $(patsubst %.cpp,%.o,$(SOURCES_CPP)) +all: $(OUT) + +$(OUT): $(OBJS) Makefile + rm -f $(OUT) + $(AR) rcv $(OUT) $(OBJS) + +%.o: %.S + $(CROSS)$(CXX) $(CXXFLAGS) -c $< -o $@ + +%.o: %.cpp + $(CROSS)$(CXX) $(CXXFLAGS) -c $< -o $@ + +.PHONY: clean + +clean: + rm -f $(OUT) $(OBJS) diff --git a/risc_v/src/userspace/startlib/linker.lds b/risc_v/src/userspace/startlib/linker.lds new file mode 100644 index 0000000..85333ca --- /dev/null +++ b/risc_v/src/userspace/startlib/linker.lds @@ -0,0 +1,49 @@ +OUTPUT_ARCH( "riscv" ) + +ENTRY( _start ) + +MEMORY +{ + ram (wxa!ri) : ORIGIN = 0x20000000, LENGTH = 128M +} + +PHDRS +{ + text PT_LOAD; + data PT_LOAD; + bss PT_LOAD; +} + +SECTIONS +{ + .text : { + PROVIDE(_text_start = .); + *(.text.init) *(.text .text.*) + PROVIDE(_text_end = .); + } >ram AT>ram :text + PROVIDE(_global_pointer = .); + .rodata : { + PROVIDE(_rodata_start = .); + *(.rodata .rodata.*) + PROVIDE(_rodata_end = .); + } >ram AT>ram :text + + .data : { + . = ALIGN(4096); + PROVIDE(_data_start = .); + *(.sdata .sdata.*) *(.data .data.*) + PROVIDE(_data_end = .); + } >ram AT>ram :data + + .bss :{ + PROVIDE(_bss_start = .); + *(.sbss .sbss.*) *(.bss .bss.*) + PROVIDE(_bss_end = .); + } >ram AT>ram :bss + + PROVIDE(_memory_start = ORIGIN(ram)); + PROVIDE(_stack = _bss_end + 0x80000); + PROVIDE(_memory_end = ORIGIN(ram) + LENGTH(ram)); + PROVIDE(_heap_start = _stack); + PROVIDE(_heap_size = _memory_end - _stack); +} diff --git a/risc_v/src/userspace/startlib/printf.cpp b/risc_v/src/userspace/startlib/printf.cpp new file mode 100644 index 0000000..4dac6db --- /dev/null +++ b/risc_v/src/userspace/startlib/printf.cpp @@ -0,0 +1,1042 @@ +/////////////////////////////////////////////////////////////////////////////// +// \author (c) Marco Paland (info@paland.com) +// 2014-2019, PALANDesign Hannover, Germany +// +// \license The MIT License (MIT) +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +// THE SOFTWARE. +// +// \brief Tiny printf, sprintf and (v)snprintf implementation, optimized for speed on +// embedded systems with a very limited resources. These routines are thread +// safe and reentrant! +// Use this instead of the bloated standard/newlib printf cause these use +// malloc for printf (and may not be thread safe). +// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include + +// #define USE_DIRECT_UART +// +// 'ntoa' conversion buffer size, this must be big enough to hold one converted +// numeric number including padded zeros (dynamically created on stack) +// default: 32 byte +#ifndef PRINTF_NTOA_BUFFER_SIZE +#define PRINTF_NTOA_BUFFER_SIZE 32U +#endif + +// 'ftoa' conversion buffer size, this must be big enough to hold one converted +// float number including padded zeros (dynamically created on stack) +// default: 32 byte +#ifndef PRINTF_FTOA_BUFFER_SIZE +#define PRINTF_FTOA_BUFFER_SIZE 32U +#endif + +// support for the floating point type (%f) +// default: activated +//#ifndef PRINTF_DISABLE_SUPPORT_FLOAT +#define PRINTF_SUPPORT_FLOAT +//#endif + +// support for exponential floating point notation (%e/%g) +// default: activated +//#ifndef PRINTF_DISABLE_SUPPORT_EXPONENTIAL +#define PRINTF_SUPPORT_EXPONENTIAL +//#endif + +// define the default floating point precision +// default: 6 digits +#ifndef PRINTF_DEFAULT_FLOAT_PRECISION +#define PRINTF_DEFAULT_FLOAT_PRECISION 6U +#endif + +// define the largest float suitable to print with %f +// default: 1e9 +#ifndef PRINTF_MAX_FLOAT +#define PRINTF_MAX_FLOAT 1e9 +#endif + +// support for the long long types (%llu or %p) +// default: activated +// #ifndef PRINTF_DISABLE_SUPPORT_LONG_LONG +#define PRINTF_SUPPORT_LONG_LONG +// #endif + +// support for the ptrdiff_t type (%t) +// ptrdiff_t is normally defined in as long or long long type +// default: activated +// #ifndef PRINTF_DISABLE_SUPPORT_PTRDIFF_T +#define PRINTF_SUPPORT_PTRDIFF_T +// #endif + +/////////////////////////////////////////////////////////////////////////////// + +// internal flag definitions +#define FLAGS_ZEROPAD (1U << 0U) +#define FLAGS_LEFT (1U << 1U) +#define FLAGS_PLUS (1U << 2U) +#define FLAGS_SPACE (1U << 3U) +#define FLAGS_HASH (1U << 4U) +#define FLAGS_UPPERCASE (1U << 5U) +#define FLAGS_CHAR (1U << 6U) +#define FLAGS_SHORT (1U << 7U) +#define FLAGS_LONG (1U << 8U) +#define FLAGS_LONG_LONG (1U << 9U) +#define FLAGS_PRECISION (1U << 10U) +#define FLAGS_ADAPT_EXP (1U << 11U) + +// import float.h for DBL_MAX +#if defined(PRINTF_SUPPORT_FLOAT) +#include +#endif + +#include + +// output function type +typedef void (*out_fct_type)(char character, void *buffer, size_t idx, size_t maxlen); + +// wrapper (used as buffer) for output function type +typedef struct +{ + void (*fct)(char character, void *arg); + void *arg; +} out_fct_wrap_type; + +// internal buffer output +static inline void _out_buffer(char character, void *buffer, size_t idx, size_t maxlen) +{ + if (idx < maxlen) + { + ((char *)buffer)[idx] = character; + } +} + +void _putchar(char c) +{ + syscall_put_char(c); +} + +// internal null output +static inline void _out_null(char character, void *buffer, size_t idx, size_t maxlen) +{ + (void)character; + (void)buffer; + (void)idx; + (void)maxlen; +} + +// internal _putchar wrapper +static inline void _out_char(char character, void *buffer, size_t idx, size_t maxlen) +{ + (void)buffer; + (void)idx; + (void)maxlen; + if (character) + { + _putchar(character); + } +} + +// internal output function wrapper +static inline void _out_fct(char character, void *buffer, size_t idx, size_t maxlen) +{ + (void)idx; + (void)maxlen; + if (character) + { + // buffer is the output fct pointer + ((out_fct_wrap_type *)buffer)->fct(character, ((out_fct_wrap_type *)buffer)->arg); + } +} + +// internal secure strlen +// \return The length of the string (excluding the terminating 0) limited by 'maxsize' +static inline unsigned int _strnlen_s(const char *str, size_t maxsize) +{ + const char *s; + for (s = str; *s && maxsize--; ++s) + ; + return (unsigned int)(s - str); +} + +// internal test if char is a digit (0-9) +// \return true if char is a digit +static inline bool _is_digit(char ch) +{ + return (ch >= '0') && (ch <= '9'); +} + +// internal ASCII string to unsigned int conversion +static unsigned int _atoi(const char **str) +{ + unsigned int i = 0U; + while (_is_digit(**str)) + { + i = i * 10U + (unsigned int)(*((*str)++) - '0'); + } + return i; +} + +// output the specified string in reverse, taking care of any zero-padding +static size_t _out_rev(out_fct_type out, char *buffer, size_t idx, size_t maxlen, const char *buf, size_t len, unsigned int width, unsigned int flags) +{ + const size_t start_idx = idx; + + // pad spaces up to given width + if (!(flags & FLAGS_LEFT) && !(flags & FLAGS_ZEROPAD)) + { + for (size_t i = len; i < width; i++) + { + out(' ', buffer, idx++, maxlen); + } + } + + // reverse string + while (len) + { + out(buf[--len], buffer, idx++, maxlen); + } + + // append pad spaces up to given width + if (flags & FLAGS_LEFT) + { + while (idx - start_idx < width) + { + out(' ', buffer, idx++, maxlen); + } + } + + return idx; +} + +// internal itoa format +static size_t _ntoa_format(out_fct_type out, char *buffer, size_t idx, size_t maxlen, char *buf, size_t len, bool negative, unsigned int base, unsigned int prec, unsigned int width, unsigned int flags) +{ + // pad leading zeros + if (!(flags & FLAGS_LEFT)) + { + if (width && (flags & FLAGS_ZEROPAD) && (negative || (flags & (FLAGS_PLUS | FLAGS_SPACE)))) + { + width--; + } + while ((len < prec) && (len < PRINTF_NTOA_BUFFER_SIZE)) + { + buf[len++] = '0'; + } + while ((flags & FLAGS_ZEROPAD) && (len < width) && (len < PRINTF_NTOA_BUFFER_SIZE)) + { + buf[len++] = '0'; + } + } + + // handle hash + if (flags & FLAGS_HASH) + { + if (!(flags & FLAGS_PRECISION) && len && ((len == prec) || (len == width))) + { + len--; + if (len && (base == 16U)) + { + len--; + } + } + if ((base == 16U) && !(flags & FLAGS_UPPERCASE) && (len < PRINTF_NTOA_BUFFER_SIZE)) + { + buf[len++] = 'x'; + } + else if ((base == 16U) && (flags & FLAGS_UPPERCASE) && (len < PRINTF_NTOA_BUFFER_SIZE)) + { + buf[len++] = 'X'; + } + else if ((base == 2U) && (len < PRINTF_NTOA_BUFFER_SIZE)) + { + buf[len++] = 'b'; + } + if (len < PRINTF_NTOA_BUFFER_SIZE) + { + buf[len++] = '0'; + } + } + + if (len < PRINTF_NTOA_BUFFER_SIZE) + { + if (negative) + { + buf[len++] = '-'; + } + else if (flags & FLAGS_PLUS) + { + buf[len++] = '+'; // ignore the space if the '+' exists + } + else if (flags & FLAGS_SPACE) + { + buf[len++] = ' '; + } + } + + return _out_rev(out, buffer, idx, maxlen, buf, len, width, flags); +} + +// internal itoa for 'long' type +static size_t _ntoa_long(out_fct_type out, char *buffer, size_t idx, size_t maxlen, unsigned long value, bool negative, unsigned long base, unsigned int prec, unsigned int width, unsigned int flags) +{ + char buf[PRINTF_NTOA_BUFFER_SIZE]; + size_t len = 0U; + + // no hash for 0 values + if (!value) + { + flags &= ~FLAGS_HASH; + } + + // write if precision != 0 and value is != 0 + if (!(flags & FLAGS_PRECISION) || value) + { + do + { + const char digit = (char)(value % base); + buf[len++] = digit < 10 ? '0' + digit : (flags & FLAGS_UPPERCASE ? 'A' : 'a') + digit - 10; + value /= base; + } while (value && (len < PRINTF_NTOA_BUFFER_SIZE)); + } + + return _ntoa_format(out, buffer, idx, maxlen, buf, len, negative, (unsigned int)base, prec, width, flags); +} + +// internal itoa for 'long long' type +#if defined(PRINTF_SUPPORT_LONG_LONG) +static size_t _ntoa_long_long(out_fct_type out, char *buffer, size_t idx, size_t maxlen, unsigned long long value, bool negative, unsigned long long base, unsigned int prec, unsigned int width, unsigned int flags) +{ + char buf[PRINTF_NTOA_BUFFER_SIZE]; + size_t len = 0U; + + // no hash for 0 values + if (!value) + { + flags &= ~FLAGS_HASH; + } + + // write if precision != 0 and value is != 0 + if (!(flags & FLAGS_PRECISION) || value) + { + do + { + const char digit = (char)(value % base); + buf[len++] = digit < 10 ? '0' + digit : (flags & FLAGS_UPPERCASE ? 'A' : 'a') + digit - 10; + value /= base; + } while (value && (len < PRINTF_NTOA_BUFFER_SIZE)); + } + + return _ntoa_format(out, buffer, idx, maxlen, buf, len, negative, (unsigned int)base, prec, width, flags); +} +#endif // PRINTF_SUPPORT_LONG_LONG + +#if defined(PRINTF_SUPPORT_FLOAT) + +#if defined(PRINTF_SUPPORT_EXPONENTIAL) +// forward declaration so that _ftoa can switch to exp notation for values > PRINTF_MAX_FLOAT +static size_t _etoa(out_fct_type out, char *buffer, size_t idx, size_t maxlen, double value, unsigned int prec, unsigned int width, unsigned int flags); +#endif + +// internal ftoa for fixed decimal floating point +static size_t _ftoa(out_fct_type out, char *buffer, size_t idx, size_t maxlen, double value, unsigned int prec, unsigned int width, unsigned int flags) +{ + char buf[PRINTF_FTOA_BUFFER_SIZE]; + size_t len = 0U; + double diff = 0.0; + + // powers of 10 + static const double pow10[] = {1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000, 1000000000}; + + // test for special values + if (value != value) + return _out_rev(out, buffer, idx, maxlen, "nan", 3, width, flags); + if (value < -DBL_MAX) + return _out_rev(out, buffer, idx, maxlen, "fni-", 4, width, flags); + if (value > DBL_MAX) + return _out_rev(out, buffer, idx, maxlen, (flags & FLAGS_PLUS) ? "fni+" : "fni", (flags & FLAGS_PLUS) ? 4U : 3U, width, flags); + + // test for very large values + // standard printf behavior is to print EVERY whole number digit -- which could be 100s of characters overflowing your buffers == bad + if ((value > PRINTF_MAX_FLOAT) || (value < -PRINTF_MAX_FLOAT)) + { +#if defined(PRINTF_SUPPORT_EXPONENTIAL) + return _etoa(out, buffer, idx, maxlen, value, prec, width, flags); +#else + return 0U; +#endif + } + + // test for negative + bool negative = false; + if (value < 0) + { + negative = true; + value = 0 - value; + } + + // set default precision, if not set explicitly + if (!(flags & FLAGS_PRECISION)) + { + prec = PRINTF_DEFAULT_FLOAT_PRECISION; + } + // limit precision to 9, cause a prec >= 10 can lead to overflow errors + while ((len < PRINTF_FTOA_BUFFER_SIZE) && (prec > 9U)) + { + buf[len++] = '0'; + prec--; + } + + int whole = (int)value; + double tmp = (value - whole) * pow10[prec]; + unsigned long frac = (unsigned long)tmp; + diff = tmp - frac; + + if (diff > 0.5) + { + ++frac; + // handle rollover, e.g. case 0.99 with prec 1 is 1.0 + if (frac >= pow10[prec]) + { + frac = 0; + ++whole; + } + } + else if (diff < 0.5) + { + } + else if ((frac == 0U) || (frac & 1U)) + { + // if halfway, round up if odd OR if last digit is 0 + ++frac; + } + + if (prec == 0U) + { + diff = value - (double)whole; + if ((!(diff < 0.5) || (diff > 0.5)) && (whole & 1)) + { + // exactly 0.5 and ODD, then round up + // 1.5 -> 2, but 2.5 -> 2 + ++whole; + } + } + else + { + unsigned int count = prec; + // now do fractional part, as an unsigned number + while (len < PRINTF_FTOA_BUFFER_SIZE) + { + --count; + buf[len++] = (char)(48U + (frac % 10U)); + if (!(frac /= 10U)) + { + break; + } + } + // add extra 0s + while ((len < PRINTF_FTOA_BUFFER_SIZE) && (count-- > 0U)) + { + buf[len++] = '0'; + } + if (len < PRINTF_FTOA_BUFFER_SIZE) + { + // add decimal + buf[len++] = '.'; + } + } + + // do whole part, number is reversed + while (len < PRINTF_FTOA_BUFFER_SIZE) + { + buf[len++] = (char)(48 + (whole % 10)); + if (!(whole /= 10)) + { + break; + } + } + + // pad leading zeros + if (!(flags & FLAGS_LEFT) && (flags & FLAGS_ZEROPAD)) + { + if (width && (negative || (flags & (FLAGS_PLUS | FLAGS_SPACE)))) + { + width--; + } + while ((len < width) && (len < PRINTF_FTOA_BUFFER_SIZE)) + { + buf[len++] = '0'; + } + } + + if (len < PRINTF_FTOA_BUFFER_SIZE) + { + if (negative) + { + buf[len++] = '-'; + } + else if (flags & FLAGS_PLUS) + { + buf[len++] = '+'; // ignore the space if the '+' exists + } + else if (flags & FLAGS_SPACE) + { + buf[len++] = ' '; + } + } + + return _out_rev(out, buffer, idx, maxlen, buf, len, width, flags); +} + +#if defined(PRINTF_SUPPORT_EXPONENTIAL) +// internal ftoa variant for exponential floating-point type, contributed by Martijn Jasperse +static size_t _etoa(out_fct_type out, char *buffer, size_t idx, size_t maxlen, double value, unsigned int prec, unsigned int width, unsigned int flags) +{ + // check for NaN and special values + if ((value != value) || (value > DBL_MAX) || (value < -DBL_MAX)) + { + return _ftoa(out, buffer, idx, maxlen, value, prec, width, flags); + } + + // determine the sign + const bool negative = value < 0; + if (negative) + { + value = -value; + } + + // default precision + if (!(flags & FLAGS_PRECISION)) + { + prec = PRINTF_DEFAULT_FLOAT_PRECISION; + } + + // determine the decimal exponent + // based on the algorithm by David Gay (https://www.ampl.com/netlib/fp/dtoa.c) + union { + uint64_t U; + double F; + } conv; + + conv.F = value; + int exp2 = (int)((conv.U >> 52U) & 0x07FFU) - 1023; // effectively log2 + conv.U = (conv.U & ((1ULL << 52U) - 1U)) | (1023ULL << 52U); // drop the exponent so conv.F is now in [1,2) + // now approximate log10 from the log2 integer part and an expansion of ln around 1.5 + int expval = (int)(0.1760912590558 + exp2 * 0.301029995663981 + (conv.F - 1.5) * 0.289529654602168); + // now we want to compute 10^expval but we want to be sure it won't overflow + exp2 = (int)(expval * 3.321928094887362 + 0.5); + const double z = expval * 2.302585092994046 - exp2 * 0.6931471805599453; + const double z2 = z * z; + conv.U = (uint64_t)(exp2 + 1023) << 52U; + // compute exp(z) using continued fractions, see https://en.wikipedia.org/wiki/Exponential_function#Continued_fractions_for_ex + conv.F *= 1 + 2 * z / (2 - z + (z2 / (6 + (z2 / (10 + z2 / 14))))); + // correct for rounding errors + if (value < conv.F) + { + expval--; + conv.F /= 10; + } + + // the exponent format is "%+03d" and largest value is "307", so set aside 4-5 characters + unsigned int minwidth = ((expval < 100) && (expval > -100)) ? 4U : 5U; + + // in "%g" mode, "prec" is the number of *significant figures* not decimals + if (flags & FLAGS_ADAPT_EXP) + { + // do we want to fall-back to "%f" mode? + if ((value >= 1e-4) && (value < 1e6)) + { + if ((int)prec > expval) + { + prec = (unsigned)((int)prec - expval - 1); + } + else + { + prec = 0; + } + flags |= FLAGS_PRECISION; // make sure _ftoa respects precision + // no characters in exponent + minwidth = 0U; + expval = 0; + } + else + { + // we use one sigfig for the whole part + if ((prec > 0) && (flags & FLAGS_PRECISION)) + { + --prec; + } + } + } + + // will everything fit? + unsigned int fwidth = width; + if (width > minwidth) + { + // we didn't fall-back so subtract the characters required for the exponent + fwidth -= minwidth; + } + else + { + // not enough characters, so go back to default sizing + fwidth = 0U; + } + if ((flags & FLAGS_LEFT) && minwidth) + { + // if we're padding on the right, DON'T pad the floating part + fwidth = 0U; + } + + // rescale the float value + if (expval) + { + value /= conv.F; + } + + // output the floating part + const size_t start_idx = idx; + idx = _ftoa(out, buffer, idx, maxlen, negative ? -value : value, prec, fwidth, flags & ~FLAGS_ADAPT_EXP); + + // output the exponent part + if (minwidth) + { + // output the exponential symbol + out((flags & FLAGS_UPPERCASE) ? 'E' : 'e', buffer, idx++, maxlen); + // output the exponent value + idx = _ntoa_long(out, buffer, idx, maxlen, (expval < 0) ? -expval : expval, expval < 0, 10, 0, minwidth - 1, FLAGS_ZEROPAD | FLAGS_PLUS); + // might need to right-pad spaces + if (flags & FLAGS_LEFT) + { + while (idx - start_idx < width) + out(' ', buffer, idx++, maxlen); + } + } + return idx; +} +#endif // PRINTF_SUPPORT_EXPONENTIAL +#endif // PRINTF_SUPPORT_FLOAT + +// internal vsnprintf +static int _vsnprintf(out_fct_type out, char *buffer, const size_t maxlen, const char *format, va_list va) +{ + unsigned int flags, width, precision, n; + size_t idx = 0U; + + if (!buffer) + { + // use null output function + out = _out_null; + } + + while (*format) + { + // format specifier? %[flags][width][.precision][length] + if (*format != '%') + { + // no + out(*format, buffer, idx++, maxlen); + format++; + continue; + } + else + { + // yes, evaluate it + format++; + } + + // evaluate flags + flags = 0U; + do + { + switch (*format) + { + case '0': + flags |= FLAGS_ZEROPAD; + format++; + n = 1U; + break; + case '-': + flags |= FLAGS_LEFT; + format++; + n = 1U; + break; + case '+': + flags |= FLAGS_PLUS; + format++; + n = 1U; + break; + case ' ': + flags |= FLAGS_SPACE; + format++; + n = 1U; + break; + case '#': + flags |= FLAGS_HASH; + format++; + n = 1U; + break; + default: + n = 0U; + break; + } + } while (n); + + // evaluate width field + width = 0U; + if (_is_digit(*format)) + { + width = _atoi(&format); + } + else if (*format == '*') + { + const int w = va_arg(va, int); + if (w < 0) + { + flags |= FLAGS_LEFT; // reverse padding + width = (unsigned int)-w; + } + else + { + width = (unsigned int)w; + } + format++; + } + + // evaluate precision field + precision = 0U; + if (*format == '.') + { + flags |= FLAGS_PRECISION; + format++; + if (_is_digit(*format)) + { + precision = _atoi(&format); + } + else if (*format == '*') + { + const int prec = (int)va_arg(va, int); + precision = prec > 0 ? (unsigned int)prec : 0U; + format++; + } + } + + // evaluate length field + switch (*format) + { + case 'l': + flags |= FLAGS_LONG; + format++; + if (*format == 'l') + { + flags |= FLAGS_LONG_LONG; + format++; + } + break; + case 'h': + flags |= FLAGS_SHORT; + format++; + if (*format == 'h') + { + flags |= FLAGS_CHAR; + format++; + } + break; +#if defined(PRINTF_SUPPORT_PTRDIFF_T) + case 't': + flags |= (sizeof(ptrdiff_t) == sizeof(long) ? FLAGS_LONG : FLAGS_LONG_LONG); + format++; + break; +#endif + case 'j': + flags |= (sizeof(intmax_t) == sizeof(long) ? FLAGS_LONG : FLAGS_LONG_LONG); + format++; + break; + case 'z': + flags |= (sizeof(size_t) == sizeof(long) ? FLAGS_LONG : FLAGS_LONG_LONG); + format++; + break; + default: + break; + } + + // evaluate specifier + switch (*format) + { + case 'd': + case 'i': + case 'u': + case 'x': + case 'X': + case 'o': + case 'b': + { + // set the base + unsigned int base; + if (*format == 'x' || *format == 'X') + { + base = 16U; + } + else if (*format == 'o') + { + base = 8U; + } + else if (*format == 'b') + { + base = 2U; + } + else + { + base = 10U; + flags &= ~FLAGS_HASH; // no hash for dec format + } + // uppercase + if (*format == 'X') + { + flags |= FLAGS_UPPERCASE; + } + + // no plus or space flag for u, x, X, o, b + if ((*format != 'i') && (*format != 'd')) + { + flags &= ~(FLAGS_PLUS | FLAGS_SPACE); + } + + // ignore '0' flag when precision is given + if (flags & FLAGS_PRECISION) + { + flags &= ~FLAGS_ZEROPAD; + } + + // convert the integer + if ((*format == 'i') || (*format == 'd')) + { + // signed + if (flags & FLAGS_LONG_LONG) + { +#if defined(PRINTF_SUPPORT_LONG_LONG) + const long long value = va_arg(va, long long); + idx = _ntoa_long_long(out, buffer, idx, maxlen, (unsigned long long)(value > 0 ? value : 0 - value), value < 0, base, precision, width, flags); +#endif + } + else if (flags & FLAGS_LONG) + { + const long value = va_arg(va, long); + idx = _ntoa_long(out, buffer, idx, maxlen, (unsigned long)(value > 0 ? value : 0 - value), value < 0, base, precision, width, flags); + } + else + { + const int value = (flags & FLAGS_CHAR) ? (char)va_arg(va, int) : (flags & FLAGS_SHORT) ? (short int)va_arg(va, int) : va_arg(va, int); + idx = _ntoa_long(out, buffer, idx, maxlen, (unsigned int)(value > 0 ? value : 0 - value), value < 0, base, precision, width, flags); + } + } + else + { + // unsigned + if (flags & FLAGS_LONG_LONG) + { +#if defined(PRINTF_SUPPORT_LONG_LONG) + idx = _ntoa_long_long(out, buffer, idx, maxlen, va_arg(va, unsigned long long), false, base, precision, width, flags); +#endif + } + else if (flags & FLAGS_LONG) + { + idx = _ntoa_long(out, buffer, idx, maxlen, va_arg(va, unsigned long), false, base, precision, width, flags); + } + else + { + const unsigned int value = (flags & FLAGS_CHAR) ? (unsigned char)va_arg(va, unsigned int) : (flags & FLAGS_SHORT) ? (unsigned short int)va_arg(va, unsigned int) : va_arg(va, unsigned int); + idx = _ntoa_long(out, buffer, idx, maxlen, value, false, base, precision, width, flags); + } + } + format++; + break; + } +#if defined(PRINTF_SUPPORT_FLOAT) + case 'f': + case 'F': + if (*format == 'F') + flags |= FLAGS_UPPERCASE; + idx = _ftoa(out, buffer, idx, maxlen, va_arg(va, double), precision, width, flags); + format++; + break; +#if defined(PRINTF_SUPPORT_EXPONENTIAL) + case 'e': + case 'E': + case 'g': + case 'G': + if ((*format == 'g') || (*format == 'G')) + flags |= FLAGS_ADAPT_EXP; + if ((*format == 'E') || (*format == 'G')) + flags |= FLAGS_UPPERCASE; + idx = _etoa(out, buffer, idx, maxlen, va_arg(va, double), precision, width, flags); + format++; + break; +#endif // PRINTF_SUPPORT_EXPONENTIAL +#endif // PRINTF_SUPPORT_FLOAT + case 'c': + { + unsigned int l = 1U; + // pre padding + if (!(flags & FLAGS_LEFT)) + { + while (l++ < width) + { + out(' ', buffer, idx++, maxlen); + } + } + // char output + out((char)va_arg(va, int), buffer, idx++, maxlen); + // post padding + if (flags & FLAGS_LEFT) + { + while (l++ < width) + { + out(' ', buffer, idx++, maxlen); + } + } + format++; + break; + } + + case 's': + { + const char *p = va_arg(va, char *); + unsigned int l = _strnlen_s(p, precision ? precision : (size_t)-1); + // pre padding + if (flags & FLAGS_PRECISION) + { + l = (l < precision ? l : precision); + } + if (!(flags & FLAGS_LEFT)) + { + while (l++ < width) + { + out(' ', buffer, idx++, maxlen); + } + } + // string output + while ((*p != 0) && (!(flags & FLAGS_PRECISION) || precision--)) + { + out(*(p++), buffer, idx++, maxlen); + } + // post padding + if (flags & FLAGS_LEFT) + { + while (l++ < width) + { + out(' ', buffer, idx++, maxlen); + } + } + format++; + break; + } + + case 'p': + { + width = sizeof(void *) * 2U; + flags |= FLAGS_ZEROPAD | FLAGS_UPPERCASE; +#if defined(PRINTF_SUPPORT_LONG_LONG) + const bool is_ll = sizeof(uintptr_t) == sizeof(long long); + if (is_ll) + { + idx = _ntoa_long_long(out, buffer, idx, maxlen, (uintptr_t)va_arg(va, void *), false, 16U, precision, width, flags); + } + else + { +#endif + idx = _ntoa_long(out, buffer, idx, maxlen, (unsigned long)((uintptr_t)va_arg(va, void *)), false, 16U, precision, width, flags); +#if defined(PRINTF_SUPPORT_LONG_LONG) + } +#endif + format++; + break; + } + + case '%': + out('%', buffer, idx++, maxlen); + format++; + break; + + default: + out(*format, buffer, idx++, maxlen); + format++; + break; + } + } + + // termination + out((char)0, buffer, idx < maxlen ? idx : maxlen - 1U, maxlen); + + // return written chars without terminating \0 + return (int)idx; +} + +/////////////////////////////////////////////////////////////////////////////// + +int printf(const char *format, ...) +{ + va_list va; + va_start(va, format); + char buffer[1]; + const int ret = _vsnprintf(_out_char, buffer, (size_t)-1, format, va); + va_end(va); + return ret; +} + +int sprintf(char *buffer, const char *format, ...) +{ + va_list va; + va_start(va, format); + const int ret = _vsnprintf(_out_buffer, buffer, (size_t)-1, format, va); + va_end(va); + return ret; +} + +int snprintf(char *buffer, size_t count, const char *format, ...) +{ + va_list va; + va_start(va, format); + const int ret = _vsnprintf(_out_buffer, buffer, count, format, va); + va_end(va); + return ret; +} + +int vprintf_(const char *format, va_list va) +{ + char buffer[1]; + return _vsnprintf(_out_char, buffer, (size_t)-1, format, va); +} + +int vsnprintf_(char *buffer, size_t count, const char *format, va_list va) +{ + return _vsnprintf(_out_buffer, buffer, count, format, va); +} + +int fctprintf(void (*out)(char character, void *arg), void *arg, const char *format, ...) +{ + va_list va; + va_start(va, format); + const out_fct_wrap_type out_fct_wrap = {out, arg}; + const int ret = _vsnprintf(_out_fct, (char *)(uintptr_t)&out_fct_wrap, (size_t)-1, format, va); + va_end(va); + return ret; +} diff --git a/risc_v/src/userspace/startlib/printf.h b/risc_v/src/userspace/startlib/printf.h new file mode 100644 index 0000000..5ccd7c6 --- /dev/null +++ b/risc_v/src/userspace/startlib/printf.h @@ -0,0 +1,113 @@ +/////////////////////////////////////////////////////////////////////////////// +// \author (c) Marco Paland (info@paland.com) +// 2014-2019, PALANDesign Hannover, Germany +// +// \license The MIT License (MIT) +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +// THE SOFTWARE. +// +// \brief Tiny printf, sprintf and snprintf implementation, optimized for speed on +// embedded systems with a very limited resources. +// Use this instead of bloated standard/newlib printf. +// These routines are thread safe and reentrant. +// +/////////////////////////////////////////////////////////////////////////////// +#pragma once +#ifndef _PRINTF_H_ +#define _PRINTF_H_ + +#include +#include + + +#ifdef __cplusplus +extern "C" { +#endif + + +/** + * Output a character to a custom device like UART, used by the printf() function + * This function is declared here only. You have to write your custom implementation somewhere + * \param character Character to output + */ +void _putchar(char character); + + +/** + * Tiny printf implementation + * You have to implement _putchar if you use printf() + * To avoid conflicts with the regular printf() API it is overridden by macro defines + * and internal underscore-appended functions like printf_() are used + * \param format A string that specifies the format of the output + * \return The number of characters that are written into the array, not counting the terminating null character + */ +//int cosc361_printf(const char* format, ...); +int printf(const char *format, ...); + +/** + * Tiny sprintf implementation + * Due to security reasons (buffer overflow) YOU SHOULD CONSIDER USING (V)SNPRINTF INSTEAD! + * \param buffer A pointer to the buffer where to store the formatted string. MUST be big enough to store the output! + * \param format A string that specifies the format of the output + * \return The number of characters that are WRITTEN into the buffer, not counting the terminating null character + */ +int sprintf(char* buffer, const char* format, ...); + + +/** + * Tiny snprintf/vsnprintf implementation + * \param buffer A pointer to the buffer where to store the formatted string + * \param count The maximum number of characters to store in the buffer, including a terminating null character + * \param format A string that specifies the format of the output + * \param va A value identifying a variable arguments list + * \return The number of characters that COULD have been written into the buffer, not counting the terminating + * null character. A value equal or larger than count indicates truncation. Only when the returned value + * is non-negative and less than count, the string has been completely written. + */ +int snprintf(char* buffer, size_t count, const char* format, ...); +int vsnprintf(char* buffer, size_t count, const char* format, va_list va); + + +/** + * Tiny vprintf implementation + * \param format A string that specifies the format of the output + * \param va A value identifying a variable arguments list + * \return The number of characters that are WRITTEN into the buffer, not counting the terminating null character + */ +#define vprintf vprintf_ +int vprintf_(const char* format, va_list va); + + +/** + * printf with output function + * You may use this as dynamic alternative to printf() with its fixed _putchar() output + * \param out An output function which takes one character and an argument pointer + * \param arg An argument pointer for user data passed to output function + * \param format A string that specifies the format of the output + * \return The number of characters that are sent to the output function, not counting the terminating null character + */ +int fctprintf(void (*out)(char character, void* arg), void* arg, const char* format, ...); + + +#ifdef __cplusplus +} +#endif + + +#endif // _PRINTF_H_ diff --git a/risc_v/src/userspace/startlib/start.S b/risc_v/src/userspace/startlib/start.S new file mode 100644 index 0000000..3d0ce6f --- /dev/null +++ b/risc_v/src/userspace/startlib/start.S @@ -0,0 +1,10 @@ + +.section .text.init +.global _start +_start: + call main + # Exit system call after main + li a0, 93 + j make_syscall +.type _start, function +.size _start, .-_start diff --git a/risc_v/src/userspace/startlib/syscall.S b/risc_v/src/userspace/startlib/syscall.S new file mode 100644 index 0000000..382ace8 --- /dev/null +++ b/risc_v/src/userspace/startlib/syscall.S @@ -0,0 +1,14 @@ +.section .text +.global make_syscall +make_syscall: + mv a7, a0 + mv a0, a1 + mv a1, a2 + mv a2, a3 + mv a3, a4 + mv a4, a5 + mv a5, a6 + ecall + ret +.type make_syscall, function +.size make_syscall, .-make_syscall diff --git a/risc_v/src/userspace/startlib/syscall.h b/risc_v/src/userspace/startlib/syscall.h new file mode 100644 index 0000000..25b8e3f --- /dev/null +++ b/risc_v/src/userspace/startlib/syscall.h @@ -0,0 +1,14 @@ +#pragma once + +extern "C" +{ + unsigned long make_syscall(unsigned long sysno, + unsigned long a1=0, + unsigned long a2=0, + unsigned long a3=0); +} +#define syscall_exit() make_syscall(93) +#define syscall_get_char() make_syscall(1) +#define syscall_put_char(x) make_syscall(2, (unsigned long)x) +#define syscall_yield() make_syscall(9) +#define syscall_sleep(x) make_syscall(10, (unsigned long)x)