1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/**
* @file klib.h
*
* @author Freya Murphy <freya@freyacat.org>
*
* Kernel libaray functions
*/
#ifndef _KLIB_H
#define _KLIB_H
#include <stddef.h>
/**
* converts single digit int to base 36
* @param i - int
* @returns c - base 36 char
*/
char itoc(int i);
/**
* converts single base 36 chat into int
* @param c - base 36 char
* @returns i - int, or -1 if the char was invalid
*/
int ctoi(char c);
/**
* Converts the initial portiion of the string pointed to by s to int.
* @param s - the string to convert
* @returns the number inside s or 0 on error
*/
int atoi(const char *s);
/**
* Converts the initial portiion of the string pointed to by s to long.
* @param s - the string to convert
* @returns the number inside s or 0 on error
*/
long int atol(const char *s);
/**
* Converts the initial portiion of the string pointed to by s to long long.
* @param s - the string to convert
* @returns the number inside s or 0 on error
*/
long long int atoll(const char *s);
/**
* Converts a integer to asci inside a string with a given radix (base).
* @param n - the number to convert
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *itoa(int n, char *buffer, int radix);
/**
* Converts a long to asci inside a string with a given radix (base).
* @param n - the number to convert
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *ltoa(long int n, char *buffer, int radix);
/**
* Converts a long long to asci inside a string with a given radix (base).
* @param n - the number to conver
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *lltoa(long long int n, char *buffer, int radix);
/**
* Converts a unsigned integer to asci inside a string with a given radix (base).
* @param n - the number to convert
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *utoa(unsigned int n, char *buffer, int radix);
/**
* Converts a unsigned long to asci inside a string with a given radix (base).
* @param n - the number to convert
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *ultoa(unsigned long int n, char *buffer, int radix);
/**
* Converts a unsigned long long to asci inside a string with a given radix (base).
* @param n - the number to conver
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *ulltoa(unsigned long long int n, char *buffer, int radix);
/**
* Converts the string in str to an int value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
int strtoi(const char *str, char **endptr, int base);
/**
* Converts the string in str to a long value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
long int strtol(const char *str, char **endptr, int base);
/**
* Converts the string in str to a long long value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
long long int strtoll(const char *str, char **endptr, int base);
/**
* Converts the string in str to an unsigned int value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
unsigned int strtoui(const char *str, char **endptr, int base);
/**
* Converts the string in str to an unsigned long value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
unsigned long int strtoul(const char *str, char **endptr, int base);
/**
* Converts the string in str to an unsigned long long value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
unsigned long long int strtoull(const char *str, char **endptr, int base);
/**
* Converts a byte count to a human readable file size of at most four characters
* using binary suffixes.
*
* The following rules are applied:
* - If the byte count is less than 1024, the count is written in decimal
* and no suffix is applied
* - Otherwise, repeatedly divide by 1024 until the value is under 1000.
* - If the value has two or three decimal digits, print it followed by the
* approprate suffix.
* - If the value has one decimal digit, print it along with a single fractional
* digit. This also applies if the value is zero.
*
* @param bytes - the bytes to convert
* @param buf - a pointer to the buffer to store it in (which must be at least five
* bytes long)
* @returns - buf
*/
char *btoa(size_t bytes, char *buf);
/**
* This function confines an argument within specified bounds.
*
* @param min - lower bound
* @param value - value to be constrained
* @param max - upper bound
*
* @returns the constrained value
*/
unsigned int bound(unsigned int min, unsigned int value, unsigned int max);
#define __PANIC_STR(x) __PANIC_STR2(x)
#define __PANIC_STR2(x) #x
#define panic(...) __panic(__PANIC_STR(__LINE__), __FILE__, __VA_ARGS__)
#define assert(val, ...) \
do { \
if (!(val)) { \
panic(__VA_ARGS__); \
} \
} while (0)
/**
* Abort the kernel with a given message.
*
* @param format - the format string
* @param ... - variable args for the format
*/
__attribute__((noreturn, format(printf, 3, 4))) void
__panic(const char *line, const char *file, const char *format, ...);
/**
* Fill dst with a stack trace consisting of return addresses in order
* from top to bottom
*
* @returns number of backtraces (at most len)
*/
size_t backtrace(void **dst, size_t len);
/**
* Fill dst with a stack trace consisting of return addresses in order
* from top to bottom, starting at a provided ip/bp
*
* @returns number of backtraces (at most len)
*/
size_t backtrace_ex(void **dst, size_t len, void *ip, void *bp);
/**
* Log a backtrace to output
*/
void log_backtrace(void);
/**
* Log a backtrace to output starting at a provided ip/bp
*/
void log_backtrace_ex(void *ip, void *bp);
/**
* Allocates size_t bytes in memory
*
* @param size - the amount of bytes to allocate
* @returns the address allocated or NULL on failure
*/
void *kalloc(size_t size);
/**
* Rellocates a given allocated ptr to a new size of bytes in memory.
* If ptr is NULL it will allocate new memory.
*
* @param ptr - the pointer to reallocate
* @param size - the amount of bytes to reallocate to
* @returns the address allocated or NULL on failure
*/
void *krealloc(void *ptr, size_t size);
/**
* Frees an allocated pointer in memory
*
* @param ptr - the pointer to free
*/
void kfree(void *ptr);
#endif /* klib.h */
|
