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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
|
/* $Id: kTypes.h 95 2016-09-26 07:23:08Z bird $ */
/** @file
* kTypes - Typedefs And Related Constants And Macros.
*/
/*
* Copyright (c) 2006-2009 Knut St. Osmundsen <bird-kStuff-spamix@anduin.net>
*
* 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.
*/
#ifndef ___k_kTypes_h___
#define ___k_kTypes_h___
#include <k/kDefs.h>
/** @defgroup grp_kTypes kTypes - Typedefs And Related Constants And Macros
* @{
*/
/** @typedef KI64
* 64-bit signed integer. */
/** @typedef KU64
* 64-bit unsigned integer. */
/** @def KI64_C
* 64-bit signed integer constant.
* @param c The constant value. */
/** @def KU64_C
* 64-bit unsigned integer constant.
* @param c The constant value. */
/** @def KI64_PRI
* 64-bit signed integer printf format. */
/** @def KU64_PRI
* 64-bit unsigned integer printf format. */
/** @def KX64_PRI
* 64-bit signed and unsigned integer hexadecimal printf format. */
/** @typedef KI32
* 32-bit signed integer. */
/** @typedef KU32
* 32-bit unsigned integer. */
/** @def KI32_C
* 32-bit signed integer constant.
* @param c The constant value. */
/** @def KU32_C
* 32-bit unsigned integer constant.
* @param c The constant value. */
/** @def KI32_PRI
* 32-bit signed integer printf format. */
/** @def KU32_PRI
* 32-bit unsigned integer printf format. */
/** @def KX32_PRI
* 32-bit signed and unsigned integer hexadecimal printf format. */
/** @typedef KI16
* 16-bit signed integer. */
/** @typedef KU16
* 16-bit unsigned integer. */
/** @def KI16_C
* 16-bit signed integer constant.
* @param c The value. */
/** @def KU16_C
* 16-bit unsigned integer constant.
* @param c The value. */
/** @def KI16_PRI
* 16-bit signed integer printf format. */
/** @def KU16_PRI
* 16-bit unsigned integer printf format. */
/** @def KX16_PRI
* 16-bit signed and unsigned integer hexadecimal printf format. */
/** @typedef KI8
* 8-bit signed integer. */
/** @typedef KU8
* 8-bit unsigned integer. */
/** @def KI8_C
* 8-bit signed integer constant.
* @param c The constant value. */
/** @def KU8_C
* 8-bit unsigned integer constant.
* @param c The constant value. */
/** @def KI8_PRI
* 8-bit signed integer printf format. */
/** @def KU8_PRI
* 8-bit unsigned integer printf format. */
/** @def KX8_PRI
* 8-bit signed and unsigned integer hexadecimal printf format. */
/** @typedef KSIZE
* Memory size type; unsigned integer. */
/** @typedef KSSIZE
* Memory size type; signed integer. */
/** @def KSIZE_C
* Memory size constant.
* @param c The constant value. */
/** @def KSSIZE_C
* Memory size constant.
* @param c The constant value. */
/** @def KSIZE_MAX
* Memory size max constant.*/
/** @def KSSIZE_MAX
* Memory size max constant.*/
/** @def KSSIZE_MIN
* Memory size min constant.*/
/** @def KSIZE_PRI
* Memory size default printf format (hex). */
/** @def KSIZE_PRI_U
* Memory size unsigned decimal printf format. */
/** @def KSIZE_PRI_I
* Memory size signed decimal printf format. */
/** @def KSIZE_PRI_X
* Memory size hexadecimal printf format. */
/** @def KSSIZE_PRI
* Memory size default printf format (hex). */
/** @def KSSIZE_PRI_U
* Memory size unsigned decimal printf format. */
/** @def KSSIZE_PRI_I
* Memory size signed decimal printf format. */
/** @def KSSIZE_PRI_X
* Memory size hexadecimal printf format. */
/** @typedef KIPTR
* Signed integer type capable of containing a pointer value. */
/** @typedef KUPTR
* Unsigned integer type capable of containing a pointer value. */
/** @def KIPTR_C
* Signed pointer constant.
* @param c The constant value. */
/** @def KUPTR_C
* Unsigned pointer constant.
* @param c The constant value. */
/** @def KIPTR_MAX
* Signed pointer max constant.*/
/** @def KIPTR_MIN
* Signed pointer min constant.*/
/** @def KUPTR_MAX
* Unsigned pointer max constant.*/
/** @def KIPTR_PRI
* Signed pointer printf format. */
/** @def KUPTR_PRI
* Unsigned pointer printf format. */
#if K_ARCH_BITS == 32
/* ASSUMES int == long == 32-bit, short == 16-bit, char == 8-bit. */
# ifdef _MSC_VER
typedef signed __int64 KI64;
typedef unsigned __int64 KU64;
#define KI64_PRI "I64d"
#define KU64_PRI "I64u"
#define KX64_PRI "I64x"
# else
typedef signed long long int KI64;
typedef unsigned long long int KU64;
#define KI64_PRI "lld"
#define KU64_PRI "llu"
#define KX64_PRI "llx"
# endif
typedef signed int KI32;
typedef unsigned int KU32;
typedef signed short int KI16;
typedef unsigned short int KU16;
typedef signed char KI8;
typedef unsigned char KU8;
#define KI64_C(c) (c ## LL)
#define KU64_C(c) (c ## ULL)
#define KI32_C(c) (c)
#define KU32_C(c) (c ## U)
#define KI16_C(c) (c)
#define KU16_C(c) (c)
#define KI8_C(c) (c)
#define KU8_C(c) (c)
#define KI32_PRI "d"
#define KU32_PRI "u"
#define KX32_PRI "x"
#define KI16_PRI "d"
#define KU16_PRI "u"
#define KX16_PRI "x"
#define KI8_PRI "d"
#define KU8_PRI "u"
#define KX8_PRI "x"
typedef KI32 KSSIZE;
#define KSSIZE(c) KI32_C(c)
#define KSSIZE_MAX KI32_MAX
#define KSSIZE_MIN KI32_MIN
#define KSSIZE_PRI KX32_PRI
typedef KU32 KSIZE;
#define KSIZE_C(c) KU32_C(c)
#define KSIZE_MAX KU32_MAX
#define KSIZE_PRI KX32_PRI
#define KSIZE_PRI_U KU32_PRI
#define KSIZE_PRI_I KI32_PRI
#define KSIZE_PRI_X KX32_PRI
#define KIPTR_C(c) KI32_C(c)
typedef KI32 KIPTR;
#define KIPTR_MAX KI32_MAX
#define KIPTR_MIN KI32_MIN
#define KIPTR_PRI KX32_PRI
typedef KU32 KUPTR;
#define KUPTR_C(c) KU32_C(c)
#define KUPTR_MAX KU32_MAX
#define KUPTR_PRI KX32_PRI
#elif K_ARCH_BITS == 64
# if K_OS == K_OS_WINDOWS
# if _MSC_VER
typedef signed __int64 KI64;
typedef unsigned __int64 KU64;
# define KI64_PRI "I64d"
# define KU64_PRI "I64u"
# define KX64_PRI "I64x"
# else
typedef signed long long int KI64;
typedef unsigned long long int KU64;
# define KI64_PRI "lld"
# define KU64_PRI "llu"
# define KX64_PRI "llx"
# endif
# define KI64_C(c) (c ## LL)
# define KU64_C(c) (c ## ULL)
# else
typedef signed long int KI64;
typedef unsigned long int KU64;
# define KI64_C(c) (c ## L)
# define KU64_C(c) (c ## UL)
# define KI64_PRI "ld"
# define KU64_PRI "lu"
# define KX64_PRI "lx"
# endif
typedef signed int KI32;
typedef unsigned int KU32;
typedef signed short KI16;
typedef unsigned short KU16;
typedef signed char KI8;
typedef unsigned char KU8;
#define KI32_C(c) (c)
#define KU32_C(c) (c ## U)
#define KI16_C(c) (c)
#define KU16_C(c) (c)
#define KI8_C(c) (c)
#define KU8_C(c) (c)
#define KI32_PRI "d"
#define KU32_PRI "u"
#define KX32_PRI "x"
#define KI16_PRI "d"
#define KU16_PRI "u"
#define KX16_PRI "x"
#define KI8_PRI "d"
#define KU8_PRI "u"
#define KX8_PRI "x"
typedef KI64 KSSIZE;
#define KSSIZE(c) KI64_C(c)
#define KSSIZE_MAX KI64_MAX
#define KSSIZE_MIN KI64_MIN
#define KSSIZE_PRI KX64_PRI
#define KSSIZE_PRI_U KU64_PRI
#define KSSIZE_PRI_I KI64_PRI
#define KSSIZE_PRI_X KX64_PRI
typedef KU64 KSIZE;
#define KSIZE_C(c) KU64_C(c)
#define KSIZE_MAX KU64_MAX
#define KSIZE_PRI_U KU64_PRI
#define KSIZE_PRI_I KI64_PRI
#define KSIZE_PRI_X KX64_PRI
#define KSIZE_PRI KX64_PRI
typedef KI64 KIPTR;
#define KIPTR_C(c) KI64_C(c)
#define KIPTR_MAX KI64_MAX
#define KIPTR_MIN KI64_MIN
#define KIPTR_PRI KX64_PRI
typedef KU64 KUPTR;
#define KUPTR_C(c) KU64_C(c)
#define KUPTR_MAX KU64_MAX
#define KUPTR_PRI KX64_PRI
#else
# error "Port Me"
#endif
/** Min KI8 value. */
#define KI8_MIN (KI8_C(-0x7f) - 1)
/** Min KI16 value. */
#define KI16_MIN (KI16_C(-0x7fff) - 1)
/** Min KI32 value. */
#define KI32_MIN (KI32_C(-0x7fffffff) - 1)
/** Min KI64 value. */
#define KI64_MIN (KI64_C(-0x7fffffffffffffff) - 1)
/** Max KI8 value. */
#define KI8_MAX KI8_C(0x7f)
/** Max KI16 value. */
#define KI16_MAX KI16_C(0x7fff)
/** Max KI32 value. */
#define KI32_MAX KI32_C(0x7fffffff)
/** Max KI64 value. */
#define KI64_MAX KI64_C(0x7fffffffffffffff)
/** Max KU8 value. */
#define KU8_MAX KU8_C(0xff)
/** Max KU16 value. */
#define KU16_MAX KU16_C(0xffff)
/** Max KU32 value. */
#define KU32_MAX KU32_C(0xffffffff)
/** Max KU64 value. */
#define KU64_MAX KU64_C(0xffffffffffffffff)
/** File offset. */
typedef KI64 KFOFF;
/** Pointer a file offset. */
typedef KFOFF *PFOFF;
/** Pointer a const file offset. */
typedef KFOFF *PCFOFF;
/** The min value for the KFOFF type. */
#define KFOFF_MIN KI64_MIN
/** The max value for the KFOFF type. */
#define KFOFF_MAX KI64_MAX
/** File offset contstant.
* @param c The constant value. */
#define KFOFF_C(c) KI64_C(c)
/** File offset printf format. */
#define KFOFF_PRI KI64_PRI
/**
* Memory Protection.
*/
typedef enum KPROT
{
/** The usual invalid 0. */
KPROT_INVALID = 0,
/** No access (page not present). */
KPROT_NOACCESS,
/** Read only. */
KPROT_READONLY,
/** Read & write. */
KPROT_READWRITE,
/** Read & copy on write. */
KPROT_WRITECOPY,
/** Execute only. */
KPROT_EXECUTE,
/** Execute & read. */
KPROT_EXECUTE_READ,
/** Execute, read & write. */
KPROT_EXECUTE_READWRITE,
/** Execute, read & copy on write. */
KPROT_EXECUTE_WRITECOPY,
/** The usual end value. (exclusive) */
KPROT_END,
/** Blow the type up to 32-bits. */
KPROT_32BIT_HACK = 0x7fffffff
} KPROT;
/** Pointer to a memory protection enum. */
typedef KPROT *PKPROT;
/** Pointer to a const memory protection enum. */
typedef KPROT const *PCKPROT;
/** Boolean.
* This can be used as a tri-state type, but then you *must* do == checks. */
typedef KI8 KBOOL;
/** Pointer to a boolean value. */
typedef KBOOL *PKBOOL;
/** Pointer to a const boolean value. */
typedef KBOOL const *PCKBOOL;
/** Maxium value the KBOOL type can hold (officially). */
#define KBOOL_MIN KI8_C(-1)
/** Maxium value the KBOOL type can hold (officially). */
#define KBOOL_MAX KI8_C(1)
/** The KBOOL printf format. */
#define KBOOL_PRI KU8_PRI
/** Boolean true constant. */
#define K_TRUE KI8_C(1)
/** Boolean false constant. */
#define K_FALSE KI8_C(0)
/** Boolean unknown constant (the third state). */
#define K_UNKNOWN KI8_C(-1)
/**
* Integer union.
*/
typedef union KUINT
{
KFOFF iBig; /**< The biggest member. */
KBOOL fBool; /**< Boolean. */
KU8 b; /**< unsigned 8-bit. */
KU8 u8; /**< unsigned 8-bit. */
KI8 i8; /**< signed 8-bit. */
KU16 u16; /**< unsigned 16-bit. */
KI16 i16; /**< signed 16-bit. */
KU32 u32; /**< unsigned 32-bit. */
KI32 i32; /**< signed 32-bit. */
KU64 u64; /**< unsigned 64-bit. */
KI64 i64; /**< signed 64-bit. */
KSIZE cbUnsign; /**< unsigned size. */
KSSIZE cbSign; /**< signed size. */
KFOFF offFile; /**< file offset. */
KUPTR uPtr; /**< unsigned pointer. */
KIPTR iPtr; /**< signed pointer. */
void *pv; /**< void pointer. */
char ch; /**< char. */
unsigned char uch; /**< unsigned char. */
signed char chSigned; /**< signed char. */
unsigned short uShort; /**< Unsigned short. */
signed short iShort; /**< Signed short. */
unsigned int uInt; /**< Unsigned int. */
signed int iInt; /**< Signed int. */
unsigned long uLong; /**< Unsigned long. */
signed long iLong; /**< Signed long. */
} KUINT;
/**
* Integer pointer union.
*/
typedef union KPUINT
{
KFOFF *piBig; /**< The biggest member. */
KBOOL *pfBool; /**< Boolean. */
KU8 *pb; /**< unsigned 8-bit. */
KU8 *pu8; /**< unsigned 8-bit. */
KI8 *pi8; /**< signed 8-bit. */
KU16 *pu16; /**< unsigned 16-bit. */
KI16 *pi16; /**< signed 16-bit. */
KU32 *pu32; /**< unsigned 32-bit. */
KI32 *pi32; /**< signed 32-bit. */
KU64 *pu64; /**< unsigned 64-bit. */
KI64 *pi64; /**< signed 64-bit. */
KSIZE *pcbUnsign; /**< unsigned size. */
KSSIZE *pcbSign; /**< signed size. */
KFOFF *poffFile; /**< file offset. */
KUPTR *puPtr; /**< unsigned pointer. */
KIPTR *piPtr; /**< signed pointer. */
void **ppv; /**< void pointer pointer. */
void *pv; /**< void pointer. */
char *pch; /**< char. */
char *psz; /**< zero terminated string. */
unsigned char *puch; /**< unsigned char. */
signed char *pchSigned; /**< signed char. */
unsigned short *puShort; /**< Unsigned short. */
signed short *piShort; /**< Signed short. */
unsigned int *puInt; /**< Unsigned int. */
signed int *piInt; /**< Signed int. */
unsigned long *puLong; /**< Unsigned long. */
signed long *piLong; /**< Signed long. */
} KPUINT;
/**
* Integer const pointer union.
*/
typedef union KPCUINT
{
KFOFF const *piBig; /**< The biggest member. */
KBOOL const *pfBool; /**< Boolean. */
KU8 const *pb; /**< byte. */
KU8 const *pu8; /**< unsigned 8-bit. */
KI8 const *pi8; /**< signed 8-bit. */
KU16 const *pu16; /**< unsigned 16-bit. */
KI16 const *pi16; /**< signed 16-bit. */
KU32 const *pu32; /**< unsigned 32-bit. */
KI32 const *pi32; /**< signed 32-bit. */
KU64 const *pu64; /**< unsigned 64-bit. */
KI64 const *pi64; /**< signed 64-bit. */
KSIZE const *pcbUnsign; /**< unsigned size. */
KSSIZE const *pcbSign; /**< signed size. */
KFOFF const *poffFile; /**< file offset. */
KUPTR const *puPtr; /**< unsigned pointer. */
KIPTR const *piPtr; /**< signed pointer. */
void const **ppv; /**< void pointer pointer. */
void const *pv; /**< void pointer. */
char const *pch; /**< char. */
char const *psz; /**< zero terminated string. */
unsigned char const *puch; /**< unsigned char. */
signed char const *pchSigned; /**< signed char. */
unsigned short const *puShort; /**< Unsigned short. */
signed short const *piShort; /**< Signed short. */
unsigned int const *puInt; /**< Unsigned int. */
signed int const *piInt; /**< Signed int. */
unsigned long const *puLong; /**< Unsigned long. */
signed long const *piLong; /**< Signed long. */
} KPCUINT;
/** @name Forward Declarations / Handle Types.
* @{ */
/** Pointer to a file provider instance. */
typedef struct KRDR *PKRDR;
/** Pointer to a file provider instance pointer. */
typedef struct KRDR **PPKRDR;
/** Pointer to a loader segment. */
typedef struct KLDRSEG *PKLDRSEG;
/** Pointer to a loader segment. */
typedef const struct KLDRSEG *PCKLDRSEG;
/** @} */
/** @} */
#endif
|
