Skip to content

Commit e1c8a47

Browse files
Meatball132Meatball132
authored
Refactor k_stdlib to separate hooks from 'sdk' headers (#48)
1 parent 8c6c5b3 commit e1c8a47

11 files changed

Lines changed: 122 additions & 116 deletions

File tree

‎examples/1-nsmbw-osreport.cpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#include <kamek.h>
2+
#include <kamek_sdk.h>
23

34
// NOTE: bss _must_ be init'ed to zero!
45
// todo: modify the Riiv patcher to take this into account!

‎k_stdlib/base/hooks.h‎

Lines changed: 0 additions & 85 deletions
This file was deleted.

k_stdlib/base/c_stdlib.h renamed to k_stdlib/k_sdk/c_stdlib.h

File renamed without changes.

k_stdlib/egg.h renamed to k_stdlib/k_sdk/egg.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#ifndef __KAMEK_EGG_H
22
#define __KAMEK_EGG_H
33

4-
#include "kamek.h"
4+
#include "../kamek.h"
55
#include "nw4r.h"
66

77
namespace EGG {

k_stdlib/nw4r.h renamed to k_stdlib/k_sdk/nw4r.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#ifndef __KAMEK_NW4R_H
22
#define __KAMEK_NW4R_H
33

4-
#include "kamek.h"
4+
#include "../kamek.h"
55

66
namespace nw4r {
77
namespace ut {

k_stdlib/base/rvl_sdk.h renamed to k_stdlib/k_sdk/rvl_sdk.h

File renamed without changes.

‎k_stdlib/k_sdk/types.h‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#ifndef __KAMEK_TYPES_H
2+
#define __KAMEK_TYPES_H
3+
4+
#define NULL 0
5+
6+
typedef unsigned char u8;
7+
typedef unsigned short u16;
8+
typedef unsigned int u32;
9+
typedef unsigned long long u64;
10+
typedef signed char s8;
11+
typedef signed short s16;
12+
typedef signed int s32;
13+
typedef signed long long s64;
14+
typedef float f32;
15+
typedef double f64;
16+
typedef volatile s64 vs64;
17+
typedef volatile s32 vs32;
18+
typedef volatile s16 vs16;
19+
typedef volatile s8 vs8;
20+
typedef volatile u64 vu64;
21+
typedef volatile u32 vu32;
22+
typedef volatile u16 vu16;
23+
typedef volatile u8 vu8;
24+
typedef volatile f64 vf64;
25+
typedef volatile f32 vf32;
26+
27+
typedef unsigned long size_t;
28+
29+
#endif

‎k_stdlib/kamek.h‎

Lines changed: 80 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,85 @@
1111
#error "Kamek requires the CodeWarrior compiler!"
1212
#endif
1313

14-
#define NULL 0
15-
16-
typedef unsigned char u8;
17-
typedef unsigned short u16;
18-
typedef unsigned int u32;
19-
typedef unsigned long long u64;
20-
typedef signed char s8;
21-
typedef signed short s16;
22-
typedef signed int s32;
23-
typedef signed long long s64;
24-
typedef float f32;
25-
typedef double f64;
26-
typedef volatile s64 vs64;
27-
typedef volatile s32 vs32;
28-
typedef volatile s16 vs16;
29-
typedef volatile s8 vs8;
30-
typedef volatile u64 vu64;
31-
typedef volatile u32 vu32;
32-
typedef volatile u16 vu16;
33-
typedef volatile u8 vu8;
34-
typedef volatile f64 vf64;
35-
typedef volatile f32 vf32;
36-
37-
typedef unsigned long size_t;
38-
39-
#include "base/hooks.h"
40-
#include "base/c_stdlib.h"
41-
#include "base/rvl_sdk.h"
14+
// allow Kamek hooks to be defined from C++ source files
15+
#pragma section ".kamek"
4216

43-
#endif
17+
// hook type IDs _must_ match what's in the Kamek source!
18+
#define kctWrite 1
19+
#define kctConditionalWrite 2
20+
#define kctInjectBranch 3
21+
#define kctInjectCall 4
22+
#define kctPatchExit 5
23+
24+
25+
#define kmIdentifier(key, counter) \
26+
_k##key##counter
27+
#define kmHookInt(counter) \
28+
__declspec (section ".kamek") static const unsigned int kmIdentifier(Hook, counter)
29+
30+
// general hook definition macros
31+
// TODO: debugging data (file, line, ...) for diagnostic use by Kamek maybe? :3
32+
#define kmHook0(type) \
33+
kmHookInt(__COUNTER__)[2] = { 0, (type) }
34+
#define kmHook1(type, arg0) \
35+
kmHookInt(__COUNTER__)[3] = { 1, (type), (unsigned int)(arg0) }
36+
#define kmHook2(type, arg0, arg1) \
37+
kmHookInt(__COUNTER__)[4] = { 2, (type), (unsigned int)(arg0), (unsigned int)(arg1) }
38+
#define kmHook3(type, arg0, arg1, arg2) \
39+
kmHookInt(__COUNTER__)[5] = { 3, (type), (unsigned int)(arg0), (unsigned int)(arg1), (unsigned int)(arg2) }
40+
#define kmHook4(type, arg0, arg1, arg2, arg3) \
41+
kmHookInt(__COUNTER__)[6] = { 4, (type), (unsigned int)(arg0), (unsigned int)(arg1), (unsigned int)(arg2), (unsigned int)(arg3) }
42+
43+
// kmCondWrite
44+
// Write value to address, conditionally
45+
#define kmCondWritePointer(addr, original, value) kmHook4(kctConditionalWrite, 1, (addr), (value), (original))
46+
#define kmCondWrite32(addr, original, value) kmHook4(kctConditionalWrite, 2, (addr), (value), (original))
47+
#define kmCondWrite16(addr, original, value) kmHook4(kctConditionalWrite, 3, (addr), (value), (original))
48+
#define kmCondWrite8(addr, original, value) kmHook4(kctConditionalWrite, 4, (addr), (value), (original))
49+
50+
// kmWrite
51+
// Write value to address
52+
#define kmWritePointer(addr, ptr) kmHook3(kctWrite, 1, (addr), (ptr))
53+
#define kmWrite32(addr, value) kmHook3(kctWrite, 2, (addr), (value))
54+
#define kmWrite16(addr, value) kmHook3(kctWrite, 3, (addr), (value))
55+
#define kmWrite8(addr, value) kmHook3(kctWrite, 4, (addr), (value))
56+
57+
// kmPatchExitPoint
58+
// Force the end of a Kamek function to always jump to a specific address
59+
// (if the address is 0, the end remains as-is (i.e. blr))
60+
#define kmPatchExitPoint(funcStart, dest) kmHook2(kctPatchExit, (funcStart), (dest))
4461

62+
// kmBranch, kmCall
63+
// Set up a branch from a specific instruction to a specific address
64+
#define kmBranch(addr, ptr) kmHook2(kctInjectBranch, (addr), (ptr))
65+
#define kmCall(addr, ptr) kmHook2(kctInjectCall, (addr), (ptr))
66+
67+
// kmBranchDefCpp, kmBranchDefAsm
68+
// Set up a branch (b) from a specific instruction to a function defined
69+
// directly underneath. If exitPoint is not NULL, the function will
70+
// branch to exitPoint when done; otherwise, it executes blr as normal
71+
#define kmBranchDefInt(counter, addr, exitPoint, returnType, ...) \
72+
static returnType kmIdentifier(UserFunc, counter) (__VA_ARGS__); \
73+
kmBranch(addr, kmIdentifier(UserFunc, counter)); \
74+
kmPatchExitPoint(kmIdentifier(UserFunc, counter), exitPoint); \
75+
static returnType kmIdentifier(UserFunc, counter) (__VA_ARGS__)
76+
77+
#define kmBranchDefCpp(addr, exitPoint, returnType, ...) \
78+
kmBranchDefInt(__COUNTER__, addr, exitPoint, returnType, __VA_ARGS__)
79+
#define kmBranchDefAsm(addr, exitPoint) \
80+
kmBranchDefInt(__COUNTER__, addr, exitPoint, asm void, )
81+
82+
// kmCallDefCpp, kmCallDefAsm
83+
// Set up a branch with link (bl) from a specific instruction to a function
84+
// defined directly underneath.
85+
#define kmCallDefInt(counter, addr, returnType, ...) \
86+
static returnType kmIdentifier(UserFunc, counter) (__VA_ARGS__); \
87+
kmCall(addr, kmIdentifier(UserFunc, counter)); \
88+
static returnType kmIdentifier(UserFunc, counter) (__VA_ARGS__)
89+
90+
#define kmCallDefCpp(addr, returnType, ...) \
91+
kmCallDefInt(__COUNTER__, addr, returnType, __VA_ARGS__)
92+
#define kmCallDefAsm(addr) \
93+
kmCallDefInt(__COUNTER__, addr, asm void, )
94+
95+
#endif

‎k_stdlib/kamek_sdk.h‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#ifndef __KAMEK_SDK_H
2+
#define __KAMEK_SDK_H
3+
4+
#include "k_sdk/types.h"
5+
#include "k_sdk/c_stdlib.h"
6+
#include "k_sdk/rvl_sdk.h"
7+
8+
#endif

‎loader/kamekLoader.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#include <kamek.h>
2+
#include <kamek_sdk.h>
23

34
struct DVDHandle
45
{

0 commit comments

Comments
 (0)