1
0
Fork 0
mirror of https://github.com/tailix/libkernaux.git synced 2024-10-30 11:54:01 -04:00
libkernaux/README.md

126 lines
3.6 KiB
Markdown
Raw Normal View History

2020-11-27 04:28:13 -05:00
libkernaux
==========
2020-11-29 22:31:43 -05:00
[![Build Status](https://travis-ci.org/kernelmq/libkernaux.svg?branch=master)](https://travis-ci.org/kernelmq/libkernaux)
2020-11-27 04:28:13 -05:00
Auxiliary library for kernel development.
2020-11-27 08:38:58 -05:00
2020-11-28 18:52:51 -05:00
Table of contents
-----------------
* [Overview](#libkernaux)
* [Table of contents](#table-of-contents)
2020-11-29 20:21:22 -05:00
* [API](#api)
2020-11-28 18:52:51 -05:00
* [Tips](#tips)
2020-11-29 11:11:26 -05:00
* [Discussion](#discussion)
2020-11-28 18:52:51 -05:00
2020-11-29 20:21:22 -05:00
API
---
2020-12-01 14:55:16 -05:00
* [Simple command line parser](/include/kernaux/cmdline.h) *(work in progress)*
2020-11-29 20:27:55 -05:00
* [Multiboot 2 (GRUB 2) information parser](/include/kernaux/multiboot2.h)
2020-12-05 21:42:56 -05:00
* [Serial console](/include/kernaux/console.h) *(work in progress)*
2020-11-29 20:27:55 -05:00
* [Page Frame Allocator](/include/kernaux/pfa.h) *(work in progress)*
2020-11-29 23:46:01 -05:00
* ELF utils *(planned)*
2020-11-29 20:21:22 -05:00
* [Architecture-specific helpers](/include/kernaux/arch/)
2020-11-29 20:23:53 -05:00
* [stdlib replacement](/include/kernaux/stdlib.h) (with prefix):
2020-11-29 20:21:22 -05:00
* `memset`
* `strlen`
* `strncpy`
2020-11-29 20:26:21 -05:00
* `itoa` *(incomplete)*
2020-11-29 20:21:22 -05:00
2020-11-27 08:38:58 -05:00
Tips
----
2020-11-29 10:49:12 -05:00
Create configuration script with `./autogen.sh`.
2020-11-27 08:38:58 -05:00
Configure with cross-compiler in `$PATH` to make without it in `$PATH`:
```
./configure \
2020-11-30 05:46:35 -05:00
--host=x86-elf \
AR="$(which x86-elf-ar)" \
CC="$(which x86-elf-gcc)" \
RANLIB="$(which x86-elf-ranlib)" \
2020-12-06 05:16:15 -05:00
CFLAGS='-ffreestanding -nostdlib -fno-builtin -fno-stack-protector'
2020-11-27 08:38:58 -05:00
```
2020-12-06 05:27:55 -05:00
When configuring with cross-compiler you can see the following messages. It's
a bug in **autoconf**, just ignore it.
```
checking for _Bool... no
checking stddef.h usability... no
checking stddef.h presence... yes
configure: WARNING: stddef.h: present but cannot be compiled
configure: WARNING: stddef.h: check for missing prerequisite headers?
configure: WARNING: stddef.h: see the Autoconf documentation
configure: WARNING: stddef.h: section "Present But Cannot Be Compiled"
configure: WARNING: stddef.h: proceeding with the compiler's result
configure: WARNING: ## ------------------------------------------------------------ ##
configure: WARNING: ## Report this to https://github.com/kernelmq/libkernaux/issues ##
configure: WARNING: ## ------------------------------------------------------------ ##
```
2020-11-27 09:27:59 -05:00
To install into specific directory use full path:
`DESTDIR="$(pwd)/dest" make install` instead of `DESTDIR=dest make install`.
When configured with cross-compiler, library can't be build and installed with
2020-11-29 11:41:24 -05:00
just `make && sudo make install`. Instead use the following commands:
* `make libkernaux.a`
2020-11-29 23:08:08 -05:00
* `sudo make install-exec`
* `sudo make install-data`
2020-11-30 05:46:35 -05:00
Check if compilation targets x86: `objdump -d src/arch/x86.o`. It should
2020-11-28 18:57:59 -05:00
output something like this:
2020-11-27 08:38:58 -05:00
```
2020-11-30 05:46:35 -05:00
src/arch/x86.o: file format elf32-i386
2020-11-27 08:38:58 -05:00
Disassembly of section .text:
2020-11-30 05:46:35 -05:00
00000000 <kernaux_arch_x86_hang>:
2020-11-28 18:56:33 -05:00
0: fa cli
1: f4 hlt
2020-11-30 05:46:35 -05:00
2: eb fc jmp 0 <kernaux_arch_x86_hang>
2020-11-27 08:38:58 -05:00
2020-11-30 05:46:35 -05:00
00000004 <kernaux_arch_x86_read_cr0>:
2020-11-28 18:56:33 -05:00
4: 0f 20 c0 mov %cr0,%eax
2020-11-27 08:38:58 -05:00
7: c3 ret
2020-11-30 05:46:35 -05:00
00000008 <kernaux_arch_x86_read_cr4>:
2020-11-28 18:56:33 -05:00
8: 0f 20 e0 mov %cr4,%eax
b: c3 ret
2020-11-27 08:38:58 -05:00
2020-11-30 05:46:35 -05:00
0000000c <kernaux_arch_x86_write_cr0>:
2020-11-28 18:56:33 -05:00
c: 8b 44 24 04 mov 0x4(%esp),%eax
10: 0f 22 c0 mov %eax,%cr0
13: c3 ret
2020-11-27 08:38:58 -05:00
2020-11-30 05:46:35 -05:00
00000014 <kernaux_arch_x86_write_cr3>:
2020-11-28 18:56:33 -05:00
14: 8b 44 24 04 mov 0x4(%esp),%eax
18: 0f 22 d8 mov %eax,%cr3
1b: c3 ret
2020-11-30 05:46:35 -05:00
0000001c <kernaux_arch_x86_write_cr4>:
2020-11-28 18:56:33 -05:00
1c: 8b 44 24 04 mov 0x4(%esp),%eax
20: 0f 22 e0 mov %eax,%cr4
23: c3 ret
2020-11-27 08:38:58 -05:00
```
2020-11-29 11:11:26 -05:00
Discussion
----------
* [Topic on OSDev.org forum](https://forum.osdev.org/viewtopic.php?f=1&t=37958)
2020-11-30 08:33:34 -05:00
* [Thread on r/osdev](https://www.reddit.com/r/osdev/comments/k3ueeu/libkernaux_auxiliary_library_for_kernel/)