1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
..
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# kcore
**kcore** is the foundation for the rest of libk. it defines types and structs that are needed by every program, and provides the stub that launches a program's "entry" function.
## entry
when using libk, your program's entry point will not be the `int main(int,char**)` function that libc opens into. libk will call the function `stat entry(kenv)` instead. like libc, the value returned by `entry` will be returned to the host platform.
## types
kcore contains fixed-width integer types. note that the available of each depends on your platform; compilation will fail if e.g. you try to use a u64 or a u128 on a 32-bit platform, so where exact lengths are not required, you may wish to use the built-in C types instead.
* `u8` - an unsigned 8-bit integer
* `s8` - a signed 8-bit integer
* `u16` - an unsigned 16-bit integer
* `s16` - a signed 16-bit integer
* `u32` - an unsigned 32-bit integer
* `s32` - a signed 32-bit integer
................................................................................
* `sword` - a signed integer of platform word-length (e.g. 32 bits on x86.32; 64 on x86.64)
* `stat` - the type of process return values expected by the platform (usually u8 on linux)
### struct kenv
`kenv` is a struct that encompasses the environment the program was launched in.
* `kiochan std` - a stereo IO channel for reading and writing to and from stdout.
* `kiochan err` - a mono IO channel for writing to stderr.
* `kvar* env` - a pointer into the program's environment
### struct kvar
`kvar` is a struct that abstracts over platform environment variables.
* `kstr name` - the name of an environment variable
* `kstr val` - the value of an environment variable
* `char* platform` - a pointer into the platform's underlying representation
|
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
..
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# kcore
**kcore** is the foundation for the rest of libk. it defines types and structs that are needed by every program, and provides the stub that launches a program's "entry" function.
## entry
when using libk, your program's entry point will not be the `int main(int,char**)` function that libc opens into. libk will call the function `stat entry(kenv)` instead. like libc, the value returned by `entry` will be returned to the host platform.
## types
kcore contains fixed-width integer types (in <k/type.h>). note that the availability of each depends on your platform; compilation will fail if e.g. you try to use a u64 or a u128 on a 32-bit platform, so where exact lengths are not required, you may wish to use the built-in C types instead.
* `u8` - an unsigned 8-bit integer
* `s8` - a signed 8-bit integer
* `u16` - an unsigned 16-bit integer
* `s16` - a signed 16-bit integer
* `u32` - an unsigned 32-bit integer
* `s32` - a signed 32-bit integer
................................................................................
* `sword` - a signed integer of platform word-length (e.g. 32 bits on x86.32; 64 on x86.64)
* `stat` - the type of process return values expected by the platform (usually u8 on linux)
### struct kenv
`kenv` is a struct that encompasses the environment the program was launched in.
* `kiochan std` - a stereo IO channel for reading and writing to and from stdout.
* `kiochan err` - a mono IO channel for writing to stderr.
* `kvar* vars` - a pointer into the program's environment
### struct kvar
`kvar` is a struct that abstracts over platform environment variables.
* `kstr name` - the name of an environment variable
* `kstr val` - the value of an environment variable
* `char* platform` - a pointer into the platform's underlying representation
|