├── source
    ├── version.h
    ├── dynload
    │   ├── dynload.h
    │   ├── dynload_function_replacements.h
    │   ├── dynload.cpp
    │   ├── loader_defines.h
    │   └── dynload_function_replacements.cpp
    ├── sdrefcount
    │   ├── refcount.h
    │   ├── sd_function_replacements.h
    │   ├── refcount.cpp
    │   └── sd_function_replacements.cpp
    ├── symbolnamepatcher
    │   ├── symbolname.h
    │   ├── sym_function_replacements.h
    │   ├── symbolname.cpp
    │   └── sym_function_replacements.cpp
    ├── functionpatcher.def
    ├── applicationendshook
    │   ├── applicationendhook.h
    │   ├── applicationends_function_replacements.h
    │   ├── applicationendhook.cpp
    │   └── applicationends_function_replacements.cpp
    ├── patches
    │   ├── patches.h
    │   ├── patches_replacements.h
    │   ├── patches.cpp
    │   └── patches_replacements.cpp
    ├── globals.h
    ├── globals.cpp
    ├── logger.c
    ├── main.cpp
    └── logger.h
├── .gitignore
├── .github
    ├── dependabot.yml
    └── workflows
    │   ├── pr.yml
    │   └── ci.yml
├── Dockerfile
├── README.md
├── .clang-format
├── Makefile
└── LICENSE


/source/version.h:
--------------------------------------------------------------------------------
1 | #pragma once
2 | #define VERSION_EXTRA ""


--------------------------------------------------------------------------------
/source/dynload/dynload.h:
--------------------------------------------------------------------------------
1 | #pragma once
2 | 
3 | void initDynload();


--------------------------------------------------------------------------------
/source/sdrefcount/refcount.h:
--------------------------------------------------------------------------------
1 | #pragma once
2 | 
3 | void initSDRefCount();


--------------------------------------------------------------------------------
/source/symbolnamepatcher/symbolname.h:
--------------------------------------------------------------------------------
1 | #pragma once
2 | 
3 | void initSymbolNamePatcher();


--------------------------------------------------------------------------------
/source/functionpatcher.def:
--------------------------------------------------------------------------------
1 | :NAME homebrew_functionpatcher
2 | 
3 | :TEXT
4 | FPAddFunctionPatch


--------------------------------------------------------------------------------
/source/applicationendshook/applicationendhook.h:
--------------------------------------------------------------------------------
1 | #pragma once
2 | 
3 | void initApplicationEndsHook();


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | *.cbp
 2 | *.elf
 3 | *.layout
 4 | *.rpx
 5 | build/
 6 | *.save-failed
 7 | .idea/
 8 | cmake-build-debug/
 9 | CMakeLists.txt
10 | *.wms
11 | *.zip
12 | 


--------------------------------------------------------------------------------
/source/patches/patches.h:
--------------------------------------------------------------------------------
1 | #pragma once
2 | 
3 | #include <stdint.h>
4 | 
5 | extern uint32_t gHeapMask;
6 | extern uint32_t gNonHomebrewFSClientCount;
7 | 
8 | void initCommonPatches();
9 | void commonPatchesStart();


--------------------------------------------------------------------------------
/source/dynload/dynload_function_replacements.h:
--------------------------------------------------------------------------------
1 | #pragma once
2 | 
3 | #include <cstdint>
4 | #include <function_patcher/function_patching.h>
5 | 
6 | extern function_replacement_data_t dynload_function_replacements[];
7 | extern uint32_t dynload_function_replacements_size;


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | updates:
 3 |   - package-ecosystem: "docker"
 4 |     directory: "/"
 5 |     schedule:
 6 |       interval: "daily"
 7 |   - package-ecosystem: "github-actions"
 8 |     directory: "/"
 9 |     schedule:
10 |       interval: "daily"
11 | 


--------------------------------------------------------------------------------
/source/globals.h:
--------------------------------------------------------------------------------
1 | #include "dynload/loader_defines.h"
2 | #include <function_patcher/fpatching_defines.h>
3 | #include <wums.h>
4 | 
5 | extern module_information_t *gModuleData;
6 | extern int32_t gSDMountRefCount;
7 | extern LOADED_RPL *gLoadedRPLData;
8 | extern RPL_DATA *gRPLData;


--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM ghcr.io/wiiu-env/devkitppc:20241128
2 | 
3 | COPY --from=ghcr.io/wiiu-env/libfunctionpatcher:20230621 /artifacts $DEVKITPRO
4 | COPY --from=ghcr.io/wiiu-env/wiiumodulesystem:20250208 /artifacts $DEVKITPRO
5 | COPY --from=ghcr.io/wiiu-env/libkernel:20230621 /artifacts $DEVKITPRO
6 | 
7 | WORKDIR project
8 | 


--------------------------------------------------------------------------------
/source/globals.cpp:
--------------------------------------------------------------------------------
1 | #include "globals.h"
2 | 
3 | module_information_t *gModuleData __attribute__((section(".data"))) = NULL;
4 | int32_t gSDMountRefCount __attribute__((section(".data")))          = 0;
5 | LOADED_RPL *gLoadedRPLData __attribute__((section(".data")))        = nullptr;
6 | RPL_DATA *gRPLData __attribute__((section(".data")))                = nullptr;


--------------------------------------------------------------------------------
/source/patches/patches_replacements.h:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <cstdint>
 4 | #include <function_patcher/function_patching.h>
 5 | 
 6 | #ifdef __cplusplus
 7 | extern "C" {
 8 | #endif
 9 | 
10 | extern function_replacement_data_t patches_function_replacements[];
11 | 
12 | #ifdef __cplusplus
13 | }
14 | #endif
15 | 
16 | extern uint32_t patches_function_replacements_size;


--------------------------------------------------------------------------------
/source/sdrefcount/sd_function_replacements.h:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <cstdint>
 4 | #include <function_patcher/function_patching.h>
 5 | 
 6 | #ifdef __cplusplus
 7 | extern "C" {
 8 | #endif
 9 | 
10 | extern function_replacement_data_t sdrefcount_function_replacements[];
11 | 
12 | #ifdef __cplusplus
13 | }
14 | #endif
15 | 
16 | extern uint32_t sdrefcount_function_replacements_size;


--------------------------------------------------------------------------------
/source/symbolnamepatcher/sym_function_replacements.h:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <cstdint>
 4 | #include <function_patcher/function_patching.h>
 5 | 
 6 | #ifdef __cplusplus
 7 | extern "C" {
 8 | #endif
 9 | 
10 | extern function_replacement_data_t symbolname_function_replacements[];
11 | 
12 | #ifdef __cplusplus
13 | }
14 | #endif
15 | 
16 | extern uint32_t symbolname_function_replacements_size;


--------------------------------------------------------------------------------
/source/applicationendshook/applicationends_function_replacements.h:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <cstdint>
 4 | #include <function_patcher/function_patching.h>
 5 | #include <wums/hooks.h>
 6 | 
 7 | #ifdef __cplusplus
 8 | extern "C" {
 9 | #endif
10 | 
11 | void CallHook(wums_hook_type_t type);
12 | 
13 | extern function_replacement_data_t applicationendshook_function_replacements[];
14 | 
15 | 
16 | #ifdef __cplusplus
17 | }
18 | #endif
19 | 
20 | 
21 | extern uint32_t applicationendshook_function_replacements_size;


--------------------------------------------------------------------------------
/source/symbolnamepatcher/symbolname.cpp:
--------------------------------------------------------------------------------
 1 | #include "globals.h"
 2 | #include "logger.h"
 3 | #include "sym_function_replacements.h"
 4 | 
 5 | void initSymbolNamePatcher() {
 6 |     DEBUG_FUNCTION_LINE("Patch SymbolNamePatcher functions");
 7 |     for (uint32_t i = 0; i < symbolname_function_replacements_size; i++) {
 8 |         bool wasPatched = false;
 9 |         if (FunctionPatcher_AddFunctionPatch(&symbolname_function_replacements[i], nullptr, &wasPatched) != FUNCTION_PATCHER_RESULT_SUCCESS || !wasPatched) {
10 |             OSFatal("AromaBaseModule: Failed to patch SymbolNamePatcher function");
11 |         }
12 |     }
13 |     DEBUG_FUNCTION_LINE("Patch SymbolNamePatcher functions finished");
14 | }


--------------------------------------------------------------------------------
/source/applicationendshook/applicationendhook.cpp:
--------------------------------------------------------------------------------
 1 | #include "applicationendhook.h"
 2 | #include "applicationends_function_replacements.h"
 3 | #include "logger.h"
 4 | 
 5 | 
 6 | void initApplicationEndsHook() {
 7 |     DEBUG_FUNCTION_LINE("Patch ApplicationEndsHook functions");
 8 |     for (uint32_t i = 0; i < applicationendshook_function_replacements_size; i++) {
 9 |         bool wasPatched = false;
10 |         if (FunctionPatcher_AddFunctionPatch(&applicationendshook_function_replacements[i], nullptr, &wasPatched) != FUNCTION_PATCHER_RESULT_SUCCESS || !wasPatched) {
11 |             OSFatal("AromaBaseModule: Failed to patch ApplicationEndsHook function");
12 |         }
13 |     }
14 |     DEBUG_FUNCTION_LINE("Patch ApplicationEndsHook functions finished");
15 | }
16 | 


--------------------------------------------------------------------------------
/source/logger.c:
--------------------------------------------------------------------------------
 1 | #ifdef DEBUG
 2 | #include <stdint.h>
 3 | #include <whb/log_cafe.h>
 4 | #include <whb/log_module.h>
 5 | #include <whb/log_udp.h>
 6 | 
 7 | uint32_t moduleLogInit = false;
 8 | uint32_t cafeLogInit   = false;
 9 | uint32_t udpLogInit    = false;
10 | #endif // DEBUG
11 | 
12 | void initLogging() {
13 | #ifdef DEBUG
14 |     if (!(moduleLogInit = WHBLogModuleInit())) {
15 |         cafeLogInit = WHBLogCafeInit();
16 |         udpLogInit  = WHBLogUdpInit();
17 |     }
18 | #endif // DEBUG
19 | }
20 | 
21 | void deinitLogging() {
22 | #ifdef DEBUG
23 |     if (moduleLogInit) {
24 |         WHBLogModuleDeinit();
25 |         moduleLogInit = false;
26 |     }
27 |     if (cafeLogInit) {
28 |         WHBLogCafeDeinit();
29 |         cafeLogInit = false;
30 |     }
31 |     if (udpLogInit) {
32 |         WHBLogUdpDeinit();
33 |         udpLogInit = false;
34 |     }
35 | #endif // DEBUG
36 | }


--------------------------------------------------------------------------------
/source/sdrefcount/refcount.cpp:
--------------------------------------------------------------------------------
 1 | #include "globals.h"
 2 | #include "logger.h"
 3 | #include "sd_function_replacements.h"
 4 | #include <coreinit/filesystem_fsa.h>
 5 | 
 6 | void initSDRefCount() {
 7 |     FSAInit();
 8 |     auto client      = FSAAddClient(nullptr);
 9 |     gSDMountRefCount = 0;
10 |     if (client > 0) {
11 |         auto res = FSAMount(client, "/dev/sdcard01", "/vol/external01", (FSAMountFlags) 0, nullptr, 0);
12 |         if (res == FS_ERROR_ALREADY_EXISTS) {
13 |             DEBUG_FUNCTION_LINE("SDCard is already mounted, set ref counter to 16");
14 |             gSDMountRefCount = 16;
15 |         } else {
16 |             DEBUG_FUNCTION_LINE("Set ref counter to 0");
17 |             FSAUnmount(client, "/vol/external01", FSA_UNMOUNT_FLAG_BIND_MOUNT);
18 |         }
19 |         FSADelClient(res);
20 |     }
21 | 
22 |     DEBUG_FUNCTION_LINE("Patch SDRefCount functions");
23 |     for (uint32_t i = 0; i < sdrefcount_function_replacements_size; i++) {
24 |         bool wasPatched = false;
25 |         if (FunctionPatcher_AddFunctionPatch(&sdrefcount_function_replacements[i], nullptr, &wasPatched) != FUNCTION_PATCHER_RESULT_SUCCESS || !wasPatched) {
26 |             OSFatal("AromaBaseModule: Failed to patch function for sd ref counting");
27 |         }
28 |     }
29 |     DEBUG_FUNCTION_LINE("Patch SDRefCount functions finished");
30 | }


--------------------------------------------------------------------------------
/.github/workflows/pr.yml:
--------------------------------------------------------------------------------
 1 | name: CI-PR
 2 | 
 3 | on: [pull_request]
 4 | 
 5 | jobs:
 6 |   clang-format:
 7 |     runs-on: ubuntu-22.04
 8 |     steps:
 9 |     - uses: actions/checkout@v4
10 |     - name: clang-format
11 |       run: |
12 |         docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source
13 |   check-build-with-logging:
14 |     runs-on: ubuntu-22.04
15 |     needs: clang-format
16 |     steps:
17 |       - uses: actions/checkout@v4
18 |       - name: build binary with logging
19 |         run: |
20 |           docker build . -t builder
21 |           docker run --rm -v ${PWD}:/project builder make DEBUG=VERBOSE
22 |           docker run --rm -v ${PWD}:/project builder make clean
23 |           docker run --rm -v ${PWD}:/project builder make DEBUG=1
24 |   build-binary:
25 |     runs-on: ubuntu-22.04
26 |     needs: clang-format
27 |     steps:
28 |     - uses: actions/checkout@v4
29 |     - name: create version.h
30 |       run: |
31 |         git_hash=$(git rev-parse --short "${{ github.event.pull_request.head.sha }}")
32 |         cat <<EOF > ./source/version.h
33 |         #pragma once
34 |         #define VERSION_EXTRA " (nightly-$git_hash)"
35 |         EOF
36 |     - name: build binary
37 |       run: |
38 |         docker build . -t builder
39 |         docker run --rm -v ${PWD}:/project builder make
40 |     - uses: actions/upload-artifact@master
41 |       with:
42 |        name: binary
43 |        path: "*.wms"


--------------------------------------------------------------------------------
/source/dynload/dynload.cpp:
--------------------------------------------------------------------------------
 1 | #include "dynload.h"
 2 | #include "../globals.h"
 3 | #include "dynload_function_replacements.h"
 4 | #include "logger.h"
 5 | #include <malloc.h>
 6 | 
 7 | extern "C" FunctionPatcherStatus FPAddFunctionPatch(function_replacement_data_t *function_data, PatchedFunctionHandle *outHandle, bool *outHasBeenPatched);
 8 | 
 9 | void initDynload() {
10 |     gLoadedRPLData = (LOADED_RPL *) malloc(sizeof(LOADED_RPL) * gModuleData->number_modules);
11 |     if (!gLoadedRPLData) {
12 |         DEBUG_FUNCTION_LINE_ERR("Failed to allocate gLoadedRPLData");
13 |         OSFatal("AromaBaseModule: Failed to allocate gLoadedRPLData");
14 |     }
15 |     gRPLData = (RPL_DATA *) malloc(sizeof(RPL_DATA) * gModuleData->number_modules);
16 |     if (!gRPLData) {
17 |         DEBUG_FUNCTION_LINE_ERR("Failed to allocate gRPLData");
18 |         OSFatal("AromaBaseModule: Failed to allocate gRPLData");
19 |     }
20 | 
21 |     DEBUG_FUNCTION_LINE("Patch functions for dynload patches");
22 |     for (uint32_t i = 0; i < dynload_function_replacements_size; i++) {
23 |         bool wasPatched = false;
24 |         // We need to use FPAddFunctionPatch because we can't use libfunctionpatcher yet. This patch enables it though.
25 |         if (FPAddFunctionPatch(&dynload_function_replacements[i], nullptr, &wasPatched) != FUNCTION_PATCHER_RESULT_SUCCESS || !wasPatched) {
26 |             OSFatal("AromaBaseModule: Failed to patch function for dynload patches");
27 |         }
28 |     }
29 |     DEBUG_FUNCTION_LINE("Patch functions finished for dynload patches");
30 | }


--------------------------------------------------------------------------------
/source/dynload/loader_defines.h:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <cstdint>
 4 | #include <wut.h>
 5 | 
 6 | // see https://github.com/decaf-emu/decaf-emu/tree/43366a34e7b55ab9d19b2444aeb0ccd46ac77dea/src/libdecaf/src/cafe/loader
 7 | struct LiImportTracking {
 8 |     uint32_t numExports;
 9 |     struct Export *exports;
10 |     uint32_t tlsModuleIndex;
11 |     struct LOADED_RPL *rpl;
12 | };
13 | 
14 | struct Export {
15 |     uint32_t value;
16 |     uint32_t name;
17 | };
18 | 
19 | struct RPLFileInfo_v4_2 {
20 |     char field_0x0[88];
21 |     uint16_t tlsModuleIndex;
22 |     char field_0x5a[6];
23 | };
24 | 
25 | struct LOADED_RPL {
26 |     char u1[88];
27 |     struct RPLFileInfo_v4_2 *fileInfoBuffer;
28 |     char u2[20];
29 |     uint32_t loadStateFlags;
30 |     uint32_t entrypoint;
31 |     char u3[132];
32 |     uint32_t numFuncExports;
33 |     Export *funcExports;
34 |     uint32_t numDataExports;
35 |     Export *dataExports;
36 |     char u4[12];
37 | };
38 | 
39 | // https://github.com/decaf-emu/decaf-emu/blob/6feb1be1db3938e6da2d4a65fc0a7a8599fc8dd6/src/libdecaf/src/cafe/libraries/coreinit/coreinit_dynload.cpp#L40
40 | struct RPL_DATA {
41 |     uint32_t handle;
42 |     WUT_UNKNOWN_BYTES(0x94 - 0x4);
43 | };
44 | WUT_CHECK_SIZE(RPL_DATA, 0x94);
45 | 
46 | 
47 | #define EXPORT_MASK           0xFFFF0000
48 | #define EXPORT_MAGIC_MASK     0x0000FFFF
49 | #define FUNCTION_EXPORT_MAGIC 0x88660000
50 | #define DATA_EXPORT_MAGIC     0x88550000
51 | 
52 | #define MODULE_MAGIC_MASK     0xFFFF0000
53 | #define MODULE_ID_MASK        0x0000FFFF
54 | #define MODULE_MAGIC          0x87650000


--------------------------------------------------------------------------------
/source/main.cpp:
--------------------------------------------------------------------------------
 1 | #include "applicationendshook/applicationendhook.h"
 2 | #include "dynload/dynload.h"
 3 | #include "globals.h"
 4 | #include "logger.h"
 5 | #include "patches/patches.h"
 6 | #include "sdrefcount/refcount.h"
 7 | #include "symbolnamepatcher/symbolname.h"
 8 | #include "version.h"
 9 | #include <function_patcher/function_patching.h>
10 | #include <wums.h>
11 | 
12 | WUMS_MODULE_EXPORT_NAME("homebrew_basemodule");
13 | WUMS_MODULE_SKIP_INIT_FINI();
14 | WUMS_DEPENDS_ON(homebrew_functionpatcher);
15 | 
16 | #define VERSION "v0.2.6"
17 | 
18 | WUMS_INITIALIZE(args) {
19 |     initLogging();
20 |     gModuleData = args.module_information;
21 |     if (gModuleData == nullptr) {
22 |         OSFatal("AromaBaseModule: Failed to get gModuleData pointer.");
23 |     }
24 |     if (gModuleData->version != MODULE_INFORMATION_VERSION) {
25 |         OSFatal("AromaBaseModule: The module information struct version does not match.");
26 |     }
27 | 
28 |     // First init Dynload to have proper OSDynLoad support!
29 |     initDynload();
30 | 
31 |     // Now init the library so we can use it for the other patches.
32 |     if (FunctionPatcher_InitLibrary() != FUNCTION_PATCHER_RESULT_SUCCESS) {
33 |         OSFatal("homebrew_basemodule: FunctionPatcher_InitLibrary failed");
34 |     }
35 | 
36 |     initApplicationEndsHook();
37 |     initSDRefCount();
38 |     initSymbolNamePatcher();
39 | 
40 |     initCommonPatches();
41 | 
42 |     deinitLogging();
43 | }
44 | 
45 | WUMS_APPLICATION_STARTS() {
46 |     OSReport("Running AromaBaseModule " VERSION VERSION_EXTRA "\n");
47 | 
48 |     commonPatchesStart();
49 | }
50 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![CI-Release](https://github.com/wiiu-env/AromaBaseModule/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/AromaBaseModule/actions/workflows/ci.yml)
 2 | 
 3 | ## Usage
 4 | (`[ENVIRONMENT]` is a placeholder for the actual environment name.)
 5 | 
 6 | 1. Copy the file `AromaBaseModule.wms` into `sd:/wiiu/environments/[ENVIRONMENT]/modules`.  
 7 | 2. Requires the [WUMSLoader](https://github.com/wiiu-env/WUMSLoader) in `sd:/wiiu/environments/[ENVIRONMENT]/modules/setup`.
 8 | 
 9 | ## Buildflags
10 | 
11 | ### Logging
12 | Building via `make` only logs errors (via OSReport). To enable logging via the [LoggingModule](https://github.com/wiiu-env/LoggingModule) set `DEBUG` to `1` or `VERBOSE`.
13 | 
14 | `make` Logs errors only (via OSReport).  
15 | `make DEBUG=1` Enables information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).  
16 | `make DEBUG=VERBOSE` Enables verbose information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).
17 | 
18 | If the [LoggingModule](https://github.com/wiiu-env/LoggingModule) is not present, it'll fallback to UDP (Port 4405) and [CafeOS](https://github.com/wiiu-env/USBSerialLoggingModule) logging.
19 | 
20 | ## Building using the Dockerfile
21 | 
22 | It's possible to use a docker image for building. This way you don't need anything installed on your host system.
23 | 
24 | ```
25 | # Build docker image (only needed once)
26 | docker build . -t aromabasemodule-builder
27 | 
28 | # make 
29 | docker run -it --rm -v ${PWD}:/project aromabasemodule-builder make
30 | 
31 | # make clean
32 | docker run -it --rm -v ${PWD}:/project aromabasemodule-builder make clean
33 | ```
34 | 
35 | ## Format the code via docker
36 | 
37 | `docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source -i`


--------------------------------------------------------------------------------
/source/patches/patches.cpp:
--------------------------------------------------------------------------------
 1 | #include "globals.h"
 2 | #include "logger.h"
 3 | #include "patches_replacements.h"
 4 | #include <coreinit/cache.h>
 5 | #include <cstdlib>
 6 | #include <kernel/kernel.h>
 7 | 
 8 | // init is not called for this module. We need to make sure to init these values in initCommonPatches()
 9 | uint32_t gHeapMask;
10 | uint32_t gNonHomebrewFSClientCount;
11 | 
12 | void initCommonPatches() {
13 |     // Determine which region the memory mapping is using. We need this to count the
14 |     // number of FSClients which are stored in that region.
15 |     auto dummy = malloc(0x4);
16 |     if (!dummy) {
17 |         gHeapMask = 0x80000000;
18 |     } else {
19 |         gHeapMask = (uint32_t) dummy & 0xF0000000;
20 |         free(dummy);
21 |     }
22 |     gNonHomebrewFSClientCount = 0;
23 | 
24 |     DEBUG_FUNCTION_LINE("Do common patches");
25 |     for (uint32_t i = 0; i < patches_function_replacements_size; i++) {
26 |         bool wasPatched = false;
27 |         if (FunctionPatcher_AddFunctionPatch(&patches_function_replacements[i], nullptr, &wasPatched) != FUNCTION_PATCHER_RESULT_SUCCESS || !wasPatched) {
28 |             OSFatal("AromaBaseModule: Failed apply common patches");
29 |         }
30 |     }
31 |     DEBUG_FUNCTION_LINE("Common patches finished");
32 | 
33 |     // Patch loader.elf to spit out less warnings when loading .rpx built with wut
34 |     KernelNOPAtPhysicalAddress(0x0100b770 - 0x01000000 + 0x32000000);
35 |     KernelNOPAtPhysicalAddress(0x0100b800 - 0x01000000 + 0x32000000);
36 |     KernelNOPAtPhysicalAddress(0x0100b7b8 - 0x01000000 + 0x32000000);
37 |     ICInvalidateRange(reinterpret_cast<void *>(0x0100b770), 0x04);
38 |     ICInvalidateRange(reinterpret_cast<void *>(0x0100b800), 0x04);
39 |     ICInvalidateRange(reinterpret_cast<void *>(0x0100b7b8), 0x04);
40 | }
41 | 
42 | void commonPatchesStart() {
43 |     gNonHomebrewFSClientCount = 0;
44 | }


--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
 1 | name: CI-Release
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 |     
 8 | jobs:
 9 |   clang-format:
10 |     runs-on: ubuntu-22.04
11 |     steps:
12 |     - uses: actions/checkout@v4
13 |     - name: clang-format
14 |       run: |
15 |         docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source
16 |   build-binary:
17 |     runs-on: ubuntu-22.04
18 |     needs: clang-format
19 |     steps:
20 |     - uses: actions/checkout@v4
21 |     - name: create version.h
22 |       run: |
23 |         git_hash=$(git rev-parse --short "$GITHUB_SHA")
24 |         cat <<EOF > ./source/version.h
25 |         #pragma once
26 |         #define VERSION_EXTRA " (nightly-$git_hash)"
27 |         EOF
28 |     - name: build binary
29 |       run: |
30 |         docker build . -t builder
31 |         docker run --rm -v ${PWD}:/project builder make
32 |     - uses: actions/upload-artifact@master
33 |       with:
34 |        name: binary
35 |        path: "*.wms"
36 |   deploy-binary:
37 |     needs: build-binary
38 |     runs-on: ubuntu-22.04
39 |     steps:   
40 |     - name: Get environment variables
41 |       id: get_repository_name
42 |       run: |
43 |         echo REPOSITORY_NAME=$(echo "$GITHUB_REPOSITORY" | awk -F / '{print $2}' | sed -e "s/:refs//") >> $GITHUB_ENV
44 |         echo DATETIME=$(echo $(date '+%Y%m%d-%H%M%S')) >> $GITHUB_ENV
45 |     - uses: actions/download-artifact@master
46 |       with:
47 |         name: binary
48 |     - name: zip artifact
49 |       run: zip -r ${{ env.REPOSITORY_NAME }}_${{ env.DATETIME }}.zip *.wms
50 |     - name: Create Release
51 |       uses: "softprops/action-gh-release@v2"
52 |       with:
53 |         tag_name: ${{ env.REPOSITORY_NAME }}-${{ env.DATETIME }}
54 |         draft: false
55 |         prerelease: true
56 |         generate_release_notes: true
57 |         name: Nightly-${{ env.REPOSITORY_NAME }}-${{ env.DATETIME }}
58 |         files: |
59 |           ./${{ env.REPOSITORY_NAME }}_${{ env.DATETIME }}.zip


--------------------------------------------------------------------------------
/.clang-format:
--------------------------------------------------------------------------------
 1 | # Generated from CLion C/C++ Code Style settings
 2 | BasedOnStyle: LLVM
 3 | AccessModifierOffset: -4
 4 | AlignAfterOpenBracket: Align
 5 | AlignConsecutiveAssignments: Consecutive
 6 | AlignConsecutiveMacros: AcrossEmptyLinesAndComments
 7 | AlignOperands: Align
 8 | AllowAllArgumentsOnNextLine: false
 9 | AllowAllConstructorInitializersOnNextLine: false
10 | AllowAllParametersOfDeclarationOnNextLine: false
11 | AllowShortBlocksOnASingleLine: Always
12 | AllowShortCaseLabelsOnASingleLine: false
13 | AllowShortFunctionsOnASingleLine: All
14 | AllowShortIfStatementsOnASingleLine: Always
15 | AllowShortLambdasOnASingleLine: All
16 | AllowShortLoopsOnASingleLine: true
17 | AlwaysBreakAfterReturnType: None
18 | AlwaysBreakTemplateDeclarations: Yes
19 | BreakBeforeBraces: Custom
20 | BraceWrapping:
21 |   AfterCaseLabel: false
22 |   AfterClass: false
23 |   AfterControlStatement: Never
24 |   AfterEnum: false
25 |   AfterFunction: false
26 |   AfterNamespace: false
27 |   AfterUnion: false
28 |   BeforeCatch: false
29 |   BeforeElse: false
30 |   IndentBraces: false
31 |   SplitEmptyFunction: false
32 |   SplitEmptyRecord: true
33 | BreakBeforeBinaryOperators: None
34 | BreakBeforeTernaryOperators: true
35 | BreakConstructorInitializers: BeforeColon
36 | BreakInheritanceList: BeforeColon
37 | ColumnLimit: 0
38 | CompactNamespaces: false
39 | ContinuationIndentWidth: 8
40 | IndentCaseLabels: true
41 | IndentPPDirectives: None
42 | IndentWidth: 4
43 | KeepEmptyLinesAtTheStartOfBlocks: true
44 | MaxEmptyLinesToKeep: 2
45 | NamespaceIndentation: All
46 | ObjCSpaceAfterProperty: false
47 | ObjCSpaceBeforeProtocolList: true
48 | PointerAlignment: Right
49 | ReflowComments: false
50 | SpaceAfterCStyleCast: true
51 | SpaceAfterLogicalNot: false
52 | SpaceAfterTemplateKeyword: false
53 | SpaceBeforeAssignmentOperators: true
54 | SpaceBeforeCpp11BracedList: false
55 | SpaceBeforeCtorInitializerColon: true
56 | SpaceBeforeInheritanceColon: true
57 | SpaceBeforeParens: ControlStatements
58 | SpaceBeforeRangeBasedForLoopColon: true
59 | SpaceInEmptyParentheses: false
60 | SpacesBeforeTrailingComments: 1
61 | SpacesInAngles: false
62 | SpacesInCStyleCastParentheses: false
63 | SpacesInContainerLiterals: false
64 | SpacesInParentheses: false
65 | SpacesInSquareBrackets: false
66 | TabWidth: 4
67 | UseTab: Never
68 | 


--------------------------------------------------------------------------------
/source/applicationendshook/applicationends_function_replacements.cpp:
--------------------------------------------------------------------------------
 1 | #include "applicationends_function_replacements.h"
 2 | #include "globals.h"
 3 | #include <coreinit/dynload.h>
 4 | #include <coreinit/interrupts.h>
 5 | #include <coreinit/messagequeue.h>
 6 | #include <coreinit/scheduler.h>
 7 | #include <coreinit/title.h>
 8 | #include <wums.h>
 9 | 
10 | static uint32_t lastData0 = 0;
11 | 
12 | void CallHook(wums_hook_type_t type) {
13 |     for (uint32_t i = 0; i < gModuleData->number_modules; i++) {
14 |         auto *curModule = &gModuleData->modules[i];
15 |         for (uint32_t j = 0; j < curModule->number_hook_entries; j++) {
16 |             auto hook_entry = &curModule->hook_entries[j];
17 |             auto hook_type  = (wums_hook_type_t) hook_entry->type;
18 |             if (hook_type == type) {
19 |                 if ((type == WUMS_HOOK_INIT_WRAPPER || type == WUMS_HOOK_FINI_WRAPPER) && curModule->skipInitFini) {
20 |                     continue;
21 |                 }
22 |                 const void *target = (const void *) hook_entry->target;
23 |                 ((void (*)())((uint32_t *) target))();
24 |             }
25 |         }
26 |     }
27 | }
28 | void ZombiUFix() {
29 |     /*
30 |      * ZombiU doesn't exit properly. It just calls exit(0) after receiving the
31 |      * request to exit. If exiting takes too long, other threads will run again
32 |      * and crash for some reason. The (hacky) solution is to set the priority
33 |      * of (some) ZombiU threads to something very high (=> low priority).
34 |      */
35 |     if (OSGetTitleID() == 0x000500001010EF00 || // ZombiU EUR
36 |         OSGetTitleID() == 0x000500001011A700 || // ZombiU EUR
37 |         OSGetTitleID() == 0x000500001010DD00 || // ZombiU USA
38 |         OSGetTitleID() == 0x0005000010112300    // ZombiU JPN
39 |     ) {
40 |         auto *curThread = OSGetCurrentThread();
41 |         __OSLockScheduler(curThread);
42 |         int state   = OSDisableInterrupts();
43 |         OSThread *t = *((OSThread **) 0x100567F8);
44 |         while (t) {
45 |             if ((uint32_t) t > (uint32_t) curThread && (uint32_t) t < 0x20000000) {
46 |                 t->priority = 0x80;
47 |                 OSReport("Set priority to %d for thread %08X (%s) to prevent it from running/crashing\n", t->priority, t, t->name);
48 |             }
49 |             t = t->activeLink.next;
50 |         }
51 | 
52 |         OSRestoreInterrupts(state);
53 |         __OSUnlockScheduler(curThread);
54 |     }
55 | }
56 | 
57 | DECL_FUNCTION(uint32_t, OSReceiveMessage, OSMessageQueue *queue, OSMessage *message, uint32_t flags) {
58 |     uint32_t res = real_OSReceiveMessage(queue, message, flags);
59 |     if (queue == OSGetSystemMessageQueue()) {
60 |         if (message != nullptr && res) {
61 |             if (lastData0 != message->args[0]) {
62 |                 if (message->args[0] == 0xD1E0D1E0) {
63 |                     ZombiUFix();
64 |                     CallHook(WUMS_HOOK_APPLICATION_REQUESTS_EXIT);
65 |                     CallHook(WUMS_HOOK_ALL_APPLICATION_REQUESTS_EXIT_DONE);
66 |                 }
67 |             }
68 |             lastData0 = message->args[0];
69 |         }
70 |     }
71 |     return res;
72 | }
73 | 
74 | function_replacement_data_t applicationendshook_function_replacements[] = {
75 |         REPLACE_FUNCTION(OSReceiveMessage, LIBRARY_COREINIT, OSReceiveMessage),
76 | };
77 | 
78 | uint32_t applicationendshook_function_replacements_size = sizeof(applicationendshook_function_replacements) / sizeof(function_replacement_data_t);


--------------------------------------------------------------------------------
/source/patches/patches_replacements.cpp:
--------------------------------------------------------------------------------
 1 | #include "patches_replacements.h"
 2 | #include "globals.h"
 3 | #include "logger.h"
 4 | #include "patches.h"
 5 | #include <coreinit/filesystem_fsa.h>
 6 | #include <coreinit/title.h>
 7 | #include <sysapp/launch.h>
 8 | 
 9 | static inline bool IsInHardcodedHomebrewMemoryRegion(void *addr) {
10 |     if ((uint32_t) addr >= 0x00800000 && (uint32_t) addr < 0x01000000) {
11 |         return true;
12 |     }
13 |     return false;
14 | }
15 | 
16 | DECL_FUNCTION(FSStatus, FSAddClient, FSClient *client, FSErrorFlag errorMask) {
17 |     auto res = real_FSAddClient(client, errorMask);
18 |     if (res == FS_STATUS_OK) {
19 |         if (((uint32_t) client & 0xF0000000) != gHeapMask && !IsInHardcodedHomebrewMemoryRegion(client)) {
20 |             gNonHomebrewFSClientCount++;
21 |         }
22 |     }
23 |     return res;
24 | }
25 | 
26 | DECL_FUNCTION(FSStatus, FSDelClient, FSClient *client, FSErrorFlag errorMask) {
27 |     auto res = real_FSDelClient(client, errorMask);
28 |     if (res == FS_STATUS_OK) {
29 |         if (((uint32_t) client & 0xF0000000) != gHeapMask && !IsInHardcodedHomebrewMemoryRegion(client)) {
30 |             gNonHomebrewFSClientCount--;
31 |         }
32 |     }
33 |     return res;
34 | }
35 | 
36 | DECL_FUNCTION(uint32_t, FSGetClientNum) {
37 |     auto titleID = OSGetTitleID();
38 |     // Some games rely on the "correct" FSGetClientNum count and only init their
39 |     // FS system if FSGetClientNum returns 0. Whitelisting games for this hack seems
40 |     // better than breaking other games by accident...
41 |     if (titleID == 0x0005000010129000 || // DuckTales: Remastered USA
42 |         titleID == 0x0005000010129200 || // DuckTales: Remastered EUR
43 |         titleID == 0x00050000101DB200 || // Shantae: Half-Genie Hero USA
44 |         titleID == 0x0005000010203200 || // Shantae: Half-Genie Hero EUR
45 |         titleID == 0x00050000101A6100 || // Shantae: Risky's Revenge Director's Cut USA
46 |         titleID == 0x00050000101A9600 || // Shantae: Risky's Revenge Director's Cut EUR
47 |         titleID == 0x00050000101F7300 || // Shantae: Risky's Revenge Director's Cut JPN
48 |         titleID == 0x000500001014E100 || // Adventure Time: Explore the Dungeon Because I Don't Know! EUR
49 |         titleID == 0x0005000010144000 || // Adventure Time: Explore the Dungeon Because I Don't Know! USA
50 |         titleID == 0x0005000010115D00 || // The Smurfs™ 2 EUR
51 |         titleID == 0x0005000010113300    // The Smurfs™ 2 USA
52 |     ) {
53 |         DEBUG_FUNCTION_LINE_INFO("Fake FSGetClientNum num to %d instead of %d", gNonHomebrewFSClientCount, real_FSGetClientNum());
54 |         return gNonHomebrewFSClientCount;
55 |     }
56 |     return real_FSGetClientNum();
57 | }
58 | 
59 | DECL_FUNCTION(uint32_t, SYSReturnToCaller, void *args) {
60 |     // Fix jumping back to the System Settings when exiting the System Transfer
61 |     auto curTitleID = OSGetTitleID();
62 |     if (curTitleID == 0x0005001010062000L || curTitleID == 0x0005001010062100L || curTitleID == 0x0005001010062200L) {
63 |         SysAppSettingsArgs set_args{};
64 |         // Jump directly to the Transfer Menu
65 |         set_args.jumpTo = SYS_SETTINGS_JUMP_TO_SOFTWARE_TRANSFER;
66 |         _SYSLaunchSettings(&set_args);
67 |         return 0;
68 |     }
69 | 
70 |     return real_SYSReturnToCaller(args);
71 | }
72 | 
73 | function_replacement_data_t patches_function_replacements[] = {
74 |         REPLACE_FUNCTION(FSAddClient, LIBRARY_COREINIT, FSAddClient),
75 |         REPLACE_FUNCTION(FSDelClient, LIBRARY_COREINIT, FSDelClient),
76 |         REPLACE_FUNCTION(FSGetClientNum, LIBRARY_COREINIT, FSGetClientNum),
77 |         REPLACE_FUNCTION(SYSReturnToCaller, LIBRARY_SYSAPP, SYSReturnToCaller),
78 | };
79 | 
80 | uint32_t patches_function_replacements_size = sizeof(patches_function_replacements) / sizeof(function_replacement_data_t);


--------------------------------------------------------------------------------
/source/symbolnamepatcher/sym_function_replacements.cpp:
--------------------------------------------------------------------------------
 1 | #include "sym_function_replacements.h"
 2 | #include "globals.h"
 3 | #include <cstring>
 4 | 
 5 | #pragma GCC push_options
 6 | #pragma GCC optimize("O0")
 7 | 
 8 | DECL_FUNCTION(uint32_t, SC17_FindClosestSymbol,
 9 |               uint32_t addr,
10 |               uint32_t *outDistance,
11 |               char *symbolNameBuffer,
12 |               uint32_t symbolNameBufferLength,
13 |               char *moduleNameBuffer,
14 |               uint32_t moduleNameBufferLength) {
15 |     for (uint32_t i = 0; i < gModuleData->number_modules; i++) {
16 |         auto *module = &gModuleData->modules[i];
17 |         if (addr < module->startAddress || addr >= module->endAddress) {
18 |             continue;
19 |         }
20 | 
21 |         strncpy(moduleNameBuffer, module->module_export_name, moduleNameBufferLength);
22 | 
23 |         if (module->function_symbol_entries != nullptr && module->number_function_symbols > 1) {
24 |             for (uint32_t j = 0; j < module->number_function_symbols - 1; j++) {
25 |                 auto symbolData     = &module->function_symbol_entries[j];
26 |                 auto symbolDataNext = &module->function_symbol_entries[j + 1];
27 |                 if (j == module->number_function_symbols - 2 || (addr >= (uint32_t) symbolData->address && addr < (uint32_t) symbolDataNext->address)) {
28 |                     strncpy(symbolNameBuffer, symbolData->name, moduleNameBufferLength);
29 |                     if (outDistance) {
30 |                         *outDistance = addr - (uint32_t) symbolData->address;
31 |                     }
32 |                     return 0;
33 |                 }
34 |             }
35 |         }
36 | 
37 |         strncpy(symbolNameBuffer, ".text", symbolNameBufferLength);
38 | 
39 |         if (outDistance) {
40 |             *outDistance = addr - (uint32_t) module->startAddress;
41 |         }
42 | 
43 |         return 0;
44 |     }
45 |     return real_SC17_FindClosestSymbol(addr, outDistance, symbolNameBuffer, symbolNameBufferLength, moduleNameBuffer, moduleNameBufferLength);
46 | }
47 | 
48 | DECL_FUNCTION(uint32_t, KiGetAppSymbolName, uint32_t addr, char *buffer, int32_t bufSize) {
49 |     for (uint32_t i = 0; i < gModuleData->number_modules; i++) {
50 |         auto *module = &gModuleData->modules[i];
51 |         if (addr < module->startAddress || addr >= module->endAddress) {
52 |             continue;
53 |         }
54 | 
55 |         auto moduleNameLen        = strlen(module->module_export_name);
56 |         int32_t spaceLeftInBuffer = (int32_t) bufSize - (int32_t) moduleNameLen - 1;
57 |         if (spaceLeftInBuffer < 0) {
58 |             spaceLeftInBuffer = 0;
59 |         }
60 |         strncpy(buffer, module->module_export_name, bufSize);
61 | 
62 |         if (module->function_symbol_entries != nullptr && module->number_function_symbols > 1) {
63 |             for (uint32_t j = 0; j < module->number_function_symbols - 1; j++) {
64 |                 auto symbolData     = &module->function_symbol_entries[j];
65 |                 auto symbolDataNext = &module->function_symbol_entries[j + 1];
66 |                 if (j == module->number_function_symbols - 2 || (addr >= (uint32_t) symbolData->address && addr < (uint32_t) symbolDataNext->address)) {
67 |                     if (spaceLeftInBuffer > 2) {
68 |                         buffer[moduleNameLen]     = '|';
69 |                         buffer[moduleNameLen + 1] = '\0';
70 |                         strncpy(buffer + moduleNameLen + 1, symbolData->name, spaceLeftInBuffer - 1);
71 |                     }
72 |                     return (uint32_t) symbolData->address;
73 |                 }
74 |             }
75 |         }
76 |         return addr;
77 |     }
78 | 
79 |     return real_KiGetAppSymbolName(addr, buffer, bufSize);
80 | }
81 | #pragma GCC pop_options
82 | 
83 | function_replacement_data_t symbolname_function_replacements[] = {
84 |         REPLACE_FUNCTION_VIA_ADDRESS(SC17_FindClosestSymbol, 0xfff10218, 0xfff10218),
85 |         REPLACE_FUNCTION_VIA_ADDRESS(KiGetAppSymbolName, 0xfff0e3a0, 0xfff0e3a0),
86 | };
87 | 
88 | uint32_t symbolname_function_replacements_size = sizeof(symbolname_function_replacements) / sizeof(function_replacement_data_t);


--------------------------------------------------------------------------------
/source/logger.h:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <coreinit/debug.h>
 4 | #include <string.h>
 5 | #include <whb/log.h>
 6 | 
 7 | #ifdef __cplusplus
 8 | extern "C" {
 9 | #endif
10 | 
11 | #define LOG_APP_TYPE                                                "M"
12 | #define LOG_APP_NAME                                                "base_module"
13 | 
14 | #define __FILENAME_X__                                              (strrchr(__FILE__, '\\') ? strrchr(__FILE__, '\\') + 1 : __FILE__)
15 | #define __FILENAME__                                                (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILENAME_X__)
16 | 
17 | #define LOG(LOG_FUNC, FMT, ARGS...)                                 LOG_EX_DEFAULT(LOG_FUNC, "", "", FMT, ##ARGS)
18 | 
19 | #define LOG_EX_DEFAULT(LOG_FUNC, LOG_LEVEL, LINE_END, FMT, ARGS...) LOG_EX(__FILENAME__, __FUNCTION__, __LINE__, LOG_FUNC, LOG_LEVEL, LINE_END, FMT, ##ARGS)
20 | 
21 | #define LOG_EX(FILENAME, FUNCTION, LINE, LOG_FUNC, LOG_LEVEL, LINE_END, FMT, ARGS...)                                                        \
22 |     do {                                                                                                                                     \
23 |         LOG_FUNC("[(%s)%18s][%23s]%30s@L%04d: " LOG_LEVEL "" FMT "" LINE_END, LOG_APP_TYPE, LOG_APP_NAME, FILENAME, FUNCTION, LINE, ##ARGS); \
24 |     } while (0)
25 | 
26 | #ifdef DEBUG
27 | 
28 | #ifdef VERBOSE_DEBUG
29 | #define DEBUG_FUNCTION_LINE_VERBOSE(FMT, ARGS...)                              LOG(WHBLogPrintf, FMT, ##ARGS)
30 | #define DEBUG_FUNCTION_LINE_VERBOSE_EX(FILENAME, FUNCTION, LINE, FMT, ARGS...) LOG_EX(FILENAME, FUNCTION, LINE, WHBLogPrintf, "", "", FMT, ##ARGS);
31 | #define DEBUG_FUNCTION_LINE_LOADER_VERBOSE(FMT, ARGS...)                       LOG_EX_DEFAULT(((void (*)(const char *, ...))((uint32_t *) 0x010028d0)), "", "\n", FMT, ##ARGS)
32 | #else
33 | #define DEBUG_FUNCTION_LINE_VERBOSE(FMT, ARGS...)        while (0)
34 | #define DEBUG_FUNCTION_LINE_VERBOSE_EX(FMT, ARGS...)     while (0)
35 | #define DEBUG_FUNCTION_LINE_LOADER_VERBOSE(FMT, ARGS...) while (0)
36 | #endif
37 | 
38 | #define DEBUG_FUNCTION_LINE(FMT, ARGS...)                                      LOG(WHBLogPrintf, FMT, ##ARGS)
39 | 
40 | #define DEBUG_FUNCTION_LINE_WRITE(FMT, ARGS...)                                LOG(WHBLogWritef, FMT, ##ARGS)
41 | 
42 | #define DEBUG_FUNCTION_LINE_WARN(FMT, ARGS...)                                 LOG_EX_DEFAULT(WHBLogPrintf, "## WARN## ", "", FMT, ##ARGS)
43 | #define DEBUG_FUNCTION_LINE_ERR(FMT, ARGS...)                                  LOG_EX_DEFAULT(WHBLogPrintf, "##ERROR## ", "", FMT, ##ARGS)
44 | #define DEBUG_FUNCTION_LINE_INFO(FMT, ARGS...)                                 LOG_EX_DEFAULT(WHBLogPrintf, "## INFO## ", "", FMT, ##ARGS)
45 | 
46 | #define DEBUG_FUNCTION_LINE_ERR_LAMBDA(FILENAME, FUNCTION, LINE, FMT, ARGS...) LOG_EX(FILENAME, FUNCTION, LINE, WHBLogPrintf, "##ERROR## ", "", FMT, ##ARGS);
47 | 
48 | #else
49 | 
50 | #define DEBUG_FUNCTION_LINE_VERBOSE_EX(FMT, ARGS...)                           while (0)
51 | 
52 | #define DEBUG_FUNCTION_LINE_VERBOSE(FMT, ARGS...)                              while (0)
53 | 
54 | #define DEBUG_FUNCTION_LINE_LOADER_VERBOSE(FMT, ARGS...)                       while (0)
55 | 
56 | #define DEBUG_FUNCTION_LINE(FMT, ARGS...)                                      while (0)
57 | 
58 | #define DEBUG_FUNCTION_LINE_WRITE(FMT, ARGS...)                                while (0)
59 | 
60 | #define DEBUG_FUNCTION_LINE_WARN(FMT, ARGS...)                                 LOG_EX_DEFAULT(OSReport, "## WARN## ", "\n", FMT, ##ARGS)
61 | #define DEBUG_FUNCTION_LINE_ERR(FMT, ARGS...)                                  LOG_EX_DEFAULT(OSReport, "##ERROR## ", "\n", FMT, ##ARGS)
62 | #define DEBUG_FUNCTION_LINE_INFO(FMT, ARGS...)                                 LOG_EX_DEFAULT(OSReport, "## INFO## ", "\n", FMT, ##ARGS)
63 | 
64 | #define DEBUG_FUNCTION_LINE_ERR_LAMBDA(FILENAME, FUNCTION, LINE, FMT, ARGS...) LOG_EX(FILENAME, FUNCTION, LINE, OSReport, "##ERROR## ", "\n", FMT, ##ARGS);
65 | 
66 | #endif
67 | 
68 | #define DEBUG_FUNCTION_LINE_LOADER_ERR(FMT, ARGS...) LOG_EX_DEFAULT(((void (*)(const char *, ...))((uint32_t *) 0x010028d0)), "##ERROR## ", "\n", FMT, ##ARGS)
69 | 
70 | void initLogging();
71 | 
72 | void deinitLogging();
73 | 
74 | #ifdef __cplusplus
75 | }
76 | #endif
77 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
  1 | #-------------------------------------------------------------------------------
  2 | .SUFFIXES:
  3 | #-------------------------------------------------------------------------------
  4 | 
  5 | ifeq ($(strip $(DEVKITPRO)),)
  6 | $(error "Please set DEVKITPRO in your environment. export DEVKITPRO=<path to>/devkitpro")
  7 | endif
  8 | 
  9 | TOPDIR ?= $(CURDIR)
 10 | 
 11 | include $(DEVKITPRO)/wums/share/wums_rules
 12 | 
 13 | WUMS_ROOT := $(DEVKITPRO)/wums
 14 | WUT_ROOT := $(DEVKITPRO)/wut
 15 | #-------------------------------------------------------------------------------
 16 | # TARGET is the name of the output
 17 | # BUILD is the directory where object files & intermediate files will be placed
 18 | # SOURCES is a list of directories containing source code
 19 | # DATA is a list of directories containing data files
 20 | # INCLUDES is a list of directories containing header files
 21 | #-------------------------------------------------------------------------------
 22 | TARGET		:=	AromaBaseModule
 23 | BUILD		:=	build
 24 | SOURCES		:=	source \
 25 | 				source/applicationendshook \
 26 | 				source/dynload \
 27 | 				source/sdrefcount \
 28 | 				source/symbolnamepatcher \
 29 | 				source/patches
 30 | DATA		:=	data
 31 | INCLUDES	:=	source
 32 | 
 33 | #-------------------------------------------------------------------------------
 34 | # options for code generation
 35 | #-------------------------------------------------------------------------------
 36 | CFLAGS	:=	-Wall -Wextra -O3 -ffunction-sections\
 37 | 			$(MACHDEP)
 38 | 
 39 | CFLAGS	+=	$(INCLUDE) -D__WIIU__ -D__WUT__
 40 | 
 41 | CXXFLAGS	:= $(CFLAGS) -std=c++20
 42 | 
 43 | ASFLAGS	:=	-g $(ARCH)
 44 | LDFLAGS	=	-g $(ARCH) $(RPXSPECS) -Wl,-Map,$(notdir $*.map) -Tfunctionpatcher.ld -T$(WUMS_ROOT)/share/libkernel.ld $(WUMSSPECS)
 45 | 
 46 | ifeq ($(DEBUG),1)
 47 | CXXFLAGS += -DDEBUG -g
 48 | CFLAGS += -DDEBUG -g
 49 | endif
 50 | 
 51 | ifeq ($(DEBUG),VERBOSE)
 52 | CXXFLAGS += -DDEBUG -DVERBOSE_DEBUG -g
 53 | CFLAGS += -DDEBUG -DVERBOSE_DEBUG -g
 54 | endif
 55 | 
 56 | LIBS	:= -lwums -lwut -lfunctionpatcher -lkernel
 57 | 
 58 | #-------------------------------------------------------------------------------
 59 | # list of directories containing libraries, this must be the top level
 60 | # containing include and lib
 61 | #-------------------------------------------------------------------------------
 62 | LIBDIRS	:= $(PORTLIBS) $(WUT_ROOT) $(WUMS_ROOT)
 63 | 
 64 | #-------------------------------------------------------------------------------
 65 | # no real need to edit anything past this point unless you need to add additional
 66 | # rules for different file extensions
 67 | #-------------------------------------------------------------------------------
 68 | ifneq ($(BUILD),$(notdir $(CURDIR)))
 69 | #-------------------------------------------------------------------------------
 70 | 
 71 | export OUTPUT	:=	$(CURDIR)/$(TARGET)
 72 | export TOPDIR	:=	$(CURDIR)
 73 | 
 74 | export VPATH	:=	$(foreach dir,$(SOURCES),$(CURDIR)/$(dir)) \
 75 | 			$(foreach dir,$(DATA),$(CURDIR)/$(dir))
 76 | 
 77 | export DEPSDIR	:=	$(CURDIR)/$(BUILD)
 78 | 
 79 | CFILES		:=	$(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.c)))
 80 | CPPFILES	:=	$(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.cpp)))
 81 | SFILES		:=	$(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.s)))
 82 | DEFFILES	:=	$(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.def)))
 83 | BINFILES	:=	$(foreach dir,$(DATA),$(notdir $(wildcard $(dir)/*.*)))
 84 | 
 85 | #-------------------------------------------------------------------------------
 86 | # use CXX for linking C++ projects, CC for standard C
 87 | #-------------------------------------------------------------------------------
 88 | ifeq ($(strip $(CPPFILES)),)
 89 | #-------------------------------------------------------------------------------
 90 | 	export LD	:=	$(CC)
 91 | #-------------------------------------------------------------------------------
 92 | else
 93 | #-------------------------------------------------------------------------------
 94 | 	export LD	:=	$(CXX)
 95 | #-------------------------------------------------------------------------------
 96 | endif
 97 | #-------------------------------------------------------------------------------
 98 | 
 99 | export OFILES_BIN	:=	$(addsuffix .o,$(BINFILES))
100 | export OFILES_SRC	:=	$(DEFFILES:.def=.o) $(CPPFILES:.cpp=.o) $(CFILES:.c=.o) $(SFILES:.s=.o)
101 | export OFILES 	:=	$(OFILES_BIN) $(OFILES_SRC)
102 | export HFILES_BIN	:=	$(addsuffix .h,$(subst .,_,$(BINFILES)))
103 | 
104 | export INCLUDE	:=	$(foreach dir,$(INCLUDES),-I$(CURDIR)/$(dir)) \
105 | 			$(foreach dir,$(LIBDIRS),-I$(dir)/include) \
106 | 			-I$(CURDIR)/$(BUILD)
107 | 
108 | export LIBPATHS	:=	$(foreach dir,$(LIBDIRS),-L$(dir)/lib)
109 | 
110 | .PHONY: $(BUILD) clean all
111 | 
112 | #-------------------------------------------------------------------------------
113 | all: $(BUILD)
114 | 
115 | #-------------------------------------------------------------------------------
116 | 
117 | $(BUILD):
118 | 	@$(shell [ ! -d $(BUILD) ] && mkdir -p $(BUILD))
119 | 	@$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile
120 | 
121 | #-------------------------------------------------------------------------------
122 | clean:
123 | 	@echo clean ...
124 | 	@rm -fr $(BUILD) $(TARGET).wms $(TARGET).elf
125 | 
126 | #-------------------------------------------------------------------------------
127 | else
128 | .PHONY:	all
129 | 
130 | DEPENDS	:=	$(OFILES:.o=.d)
131 | 
132 | #-------------------------------------------------------------------------------
133 | # main targets
134 | #-------------------------------------------------------------------------------
135 | all	:	 $(OUTPUT).wms
136 | 
137 | $(OUTPUT).wms	:	$(OUTPUT).elf
138 | $(OUTPUT).elf	:   $(OFILES)
139 | 
140 | $(OFILES_SRC)	: $(HFILES_BIN)
141 | 
142 | #-------------------------------------------------------------------------------
143 | # you need a rule like this for each extension you use as binary data
144 | #-------------------------------------------------------------------------------
145 | %.bin.o	%_bin.h :	%.bin
146 | #-------------------------------------------------------------------------------
147 | 	@echo $(notdir $<)
148 | 	@$(bin2o)
149 | #---------------------------------------------------------------------------------
150 | %.o: %.def
151 | 	$(SILENTMSG) $(notdir $<)
152 | 	$(SILENTCMD)rplimportgen $< $*.s $*.ld $(ERROR_FILTER)
153 | 	$(SILENTCMD)$(CC) -x assembler-with-cpp $(ASFLAGS) -c $*.s -o $@ $(ERROR_FILTER)
154 | 
155 | -include $(DEPENDS)
156 | 
157 | #-------------------------------------------------------------------------------
158 | endif
159 | #-------------------------------------------------------------------------------
160 | 


--------------------------------------------------------------------------------
/source/dynload/dynload_function_replacements.cpp:
--------------------------------------------------------------------------------
  1 | #include "dynload_function_replacements.h"
  2 | #include "globals.h"
  3 | #include "loader_defines.h"
  4 | #include "logger.h"
  5 | #include <coreinit/dynload.h>
  6 | #include <coreinit/title.h>
  7 | #include <cstdio>
  8 | #include <cstring>
  9 | #include <wums.h>
 10 | 
 11 | DECL_FUNCTION(void, OSDynLoad_Release, OSDynLoad_Module module) {
 12 |     if (((uint32_t) module & MODULE_MAGIC_MASK) == MODULE_MAGIC) {
 13 |         uint32_t moduleHandle = ((uint32_t) module) & MODULE_ID_MASK;
 14 |         if (moduleHandle >= gModuleData->number_modules) {
 15 |             DEBUG_FUNCTION_LINE_WARN("Invalid module handle was encoded in OSDynLoad_Module %d (%08X)", moduleHandle, module);
 16 |         } else {
 17 |             return;
 18 |         }
 19 |     }
 20 |     real_OSDynLoad_Release(module);
 21 | }
 22 | 
 23 | DECL_FUNCTION(OSDynLoad_Error, OSDynLoad_Acquire, char const *name, OSDynLoad_Module *outModule) {
 24 |     DEBUG_FUNCTION_LINE_VERBOSE("Looking for module %s", name);
 25 |     for (uint32_t i = 0; i < gModuleData->number_modules; i++) {
 26 |         if (strcmp(name, gModuleData->modules[i].module_export_name) == 0) {
 27 |             *outModule = (OSDynLoad_Module) (MODULE_MAGIC | i);
 28 |             return OS_DYNLOAD_OK;
 29 |         }
 30 |     }
 31 | 
 32 |     if (name != nullptr && name[0] == '~') {
 33 |         char cpy[64] = {};
 34 |         snprintf(cpy, sizeof(cpy), "%s", name);
 35 |         char *curPtr = &cpy[1];
 36 |         while (*curPtr != '\0') {
 37 |             if (*curPtr == '/') {
 38 |                 *curPtr = '|';
 39 |             }
 40 |             curPtr++;
 41 |         }
 42 |         return real_OSDynLoad_Acquire(cpy, outModule);
 43 |     }
 44 | 
 45 |     OSDynLoad_Error result = real_OSDynLoad_Acquire(name, outModule);
 46 | 
 47 |     return result;
 48 | }
 49 | 
 50 | DECL_FUNCTION(OSDynLoad_Error, OSDynLoad_FindExport, OSDynLoad_Module module, BOOL isData, char const *name, void **outAddr) {
 51 |     OSDynLoad_Error result = real_OSDynLoad_FindExport(module, isData, name, outAddr);
 52 |     if (result == OS_DYNLOAD_OK) {
 53 |         return OS_DYNLOAD_OK;
 54 |     }
 55 | 
 56 |     if (((uint32_t) module & MODULE_MAGIC_MASK) == MODULE_MAGIC) {
 57 |         uint32_t moduleHandle = ((uint32_t) module) & MODULE_ID_MASK;
 58 |         if (moduleHandle >= gModuleData->number_modules) {
 59 |             DEBUG_FUNCTION_LINE_ERR("Invalid module handle was encoded in OSDynLoad_Module %d (%08X)", moduleHandle, module);
 60 |             return result;
 61 |         }
 62 | 
 63 |         auto *curModule = &gModuleData->modules[moduleHandle];
 64 |         DEBUG_FUNCTION_LINE_VERBOSE("Try to find export %s in module %s", name, curModule->module_export_name);
 65 |         for (uint32_t i = 0; i < curModule->number_export_entries; i++) {
 66 |             auto *curExport = &curModule->export_entries[i];
 67 |             if (strcmp(name, curExport->name) == 0) {
 68 |                 if (isData && curExport->type == WUMS_FUNCTION_EXPORT) {
 69 |                     DEBUG_FUNCTION_LINE_ERR("Requested data Export but only found a function export");
 70 |                     return OS_DYNLOAD_INVALID_MODULE_NAME;
 71 |                 }
 72 |                 *outAddr = (void *) curExport->address;
 73 |                 DEBUG_FUNCTION_LINE_VERBOSE("SUCCESS! Set outAddr to %08X. It's from module %s function %s",
 74 |                                             curExport->address,
 75 |                                             curModule->module_export_name,
 76 |                                             curExport->name);
 77 |                 return OS_DYNLOAD_OK;
 78 |             }
 79 |         }
 80 |     }
 81 |     return result;
 82 | }
 83 | 
 84 | RPLFileInfo_v4_2 fileInfoBuffer;
 85 | 
 86 | DECL_FUNCTION(LOADED_RPL *, LiFindRPLByName, char *name) {
 87 |     for (uint32_t i = 0; i < gModuleData->number_modules; i++) {
 88 |         auto *curModule = &gModuleData->modules[i];
 89 |         if (strcmp(name, curModule->module_export_name) == 0) {
 90 |             fileInfoBuffer.tlsModuleIndex    = 0;
 91 |             gLoadedRPLData[i].fileInfoBuffer = &fileInfoBuffer; // will be copied to the LiImportTracking array
 92 |             gLoadedRPLData[i].loadStateFlags = 0x0;
 93 |             gLoadedRPLData[i].entrypoint     = 0x1; //needs to be != 0;
 94 |             gLoadedRPLData[i].funcExports    = (Export *) (FUNCTION_EXPORT_MAGIC + i);
 95 |             gLoadedRPLData[i].numFuncExports = 1;
 96 |             gLoadedRPLData[i].dataExports    = (Export *) (DATA_EXPORT_MAGIC + i);
 97 |             gLoadedRPLData[i].numDataExports = 1;
 98 |             return &gLoadedRPLData[i];
 99 |         }
100 |     }
101 |     return real_LiFindRPLByName(name);
102 | }
103 | 
104 | DECL_FUNCTION(uint32_t, __OSDynLoad_InternalAcquire, char *name, RPL_DATA **out, uint32_t u1, uint32_t u2, uint32_t u3) {
105 |     for (uint32_t i = 0; i < gModuleData->number_modules; i++) {
106 |         auto *curModule = &gModuleData->modules[i];
107 |         if (strcmp(name, curModule->module_export_name) == 0) {
108 |             // OSDynLoad_IsModuleLoaded uses __OSDynLoad_InternalAcquire and expects out have a valid value.
109 |             // It uses the "handle", so don't need to fill the whole struct.
110 |             gRPLData[i].handle = MODULE_MAGIC | i;
111 |             *out               = &gRPLData[i];
112 |             return 0;
113 |         }
114 |     }
115 |     return real___OSDynLoad_InternalAcquire(name, out, u1, u2, u3);
116 | }
117 | 
118 | Export ourExportThing;
119 | 
120 | DECL_FUNCTION(Export *, LiBinSearchExport, Export *exports, int numExports, char *name) {
121 |     auto isFunc = (((uint32_t) exports) & EXPORT_MASK) == FUNCTION_EXPORT_MAGIC;
122 |     auto isData = (((uint32_t) exports) & EXPORT_MASK) == DATA_EXPORT_MAGIC;
123 |     if (isFunc || isData) {
124 |         uint32_t moduleHandle = ((uint32_t) exports) & EXPORT_MAGIC_MASK;
125 |         if (moduleHandle > gModuleData->number_modules) {
126 |             DEBUG_FUNCTION_LINE_LOADER_ERR("Invalid module handle was encoded in Export %d (%08X)", moduleHandle, exports);
127 |             return nullptr;
128 |         }
129 | 
130 |         auto *curModule = &gModuleData->modules[moduleHandle];
131 |         DEBUG_FUNCTION_LINE_LOADER_VERBOSE("Try to find export %s in module %s", name, curModule->module_export_name);
132 |         for (uint32_t i = 0; i < curModule->number_export_entries; i++) {
133 |             auto *curExport = &curModule->export_entries[i];
134 |             if (strcmp(name, curExport->name) == 0) {
135 |                 if ((isFunc && curExport->type == WUMS_FUNCTION_EXPORT) || (isData && curExport->type == WUMS_DATA_EXPORT)) {
136 |                     ourExportThing.value = curExport->address;
137 |                     ourExportThing.name  = 0;
138 |                     return &ourExportThing;
139 |                 }
140 |             }
141 |         }
142 |         return nullptr;
143 |     }
144 |     return real_LiBinSearchExport(exports, numExports, name);
145 | }
146 | 
147 | DECL_FUNCTION(int32_t, LiFixupRelocOneRPL, LOADED_RPL *rpl, void *imports, uint32_t unknown) {
148 |     auto rplAddress = (uint32_t) rpl;
149 |     if (rplAddress >= (uint32_t) &gLoadedRPLData[0] && rplAddress < (uint32_t) &gLoadedRPLData[gModuleData->number_modules]) {
150 |         // Skip if this is our fake RPL
151 |         return 0;
152 |     }
153 |     return real_LiFixupRelocOneRPL(rpl, imports, unknown);
154 | }
155 | 
156 | DECL_FUNCTION(int32_t, sCheckOne, LOADED_RPL *rpl) {
157 |     auto rplAddress = (uint32_t) rpl;
158 |     if (rplAddress >= (uint32_t) &gLoadedRPLData[0] && rplAddress < (uint32_t) &gLoadedRPLData[gModuleData->number_modules]) {
159 |         // Skip if this is our fake RPL
160 |         return 0;
161 |     }
162 |     return real_sCheckOne(rpl);
163 | }
164 | 
165 | DECL_FUNCTION(void, sACPLoadOnDone, void) {
166 |     if (OSGetTitleID() == 0x0005000010140900L) { // オセロ (Othello)
167 |         DEBUG_FUNCTION_LINE_INFO("Skip sACPLoadOnDone for オセロ (Othello) as it might slow down exiting.");
168 |         // For some unknown reason unloading the nn_acp.rpl after playing Othello
169 |         // takes 30-100 seconds when many plugins are loaded... We take the very hacky and lazy route
170 |         // and just stop calling it and pray this won't break anything.
171 |         return;
172 |     }
173 | 
174 |     return real_sACPLoadOnDone();
175 | }
176 | 
177 | function_replacement_data_t dynload_function_replacements[] = {
178 |         REPLACE_FUNCTION_VIA_ADDRESS(sACPLoadOnDone, 0x3201C400 + 0x29de0, 0x101C400 + 0x29de0),
179 |         REPLACE_FUNCTION_VIA_ADDRESS(__OSDynLoad_InternalAcquire, 0x3201C400 + 0x0cc54, 0x101C400 + 0x0cc54),
180 |         REPLACE_FUNCTION_VIA_ADDRESS(LiFindRPLByName, 0x32004BC4, 0x01004bc4),
181 |         REPLACE_FUNCTION_VIA_ADDRESS(LiBinSearchExport, 0x320002f8, 0x010002f8),
182 |         REPLACE_FUNCTION_VIA_ADDRESS(sCheckOne, 0x32007294, 0x01007294),
183 |         REPLACE_FUNCTION_VIA_ADDRESS(LiFixupRelocOneRPL, 0x320059f0, 0x010059f0),
184 |         REPLACE_FUNCTION(OSDynLoad_Acquire, LIBRARY_COREINIT, OSDynLoad_Acquire),
185 |         REPLACE_FUNCTION(OSDynLoad_FindExport, LIBRARY_COREINIT, OSDynLoad_FindExport),
186 |         REPLACE_FUNCTION(OSDynLoad_Release, LIBRARY_COREINIT, OSDynLoad_Release),
187 | };
188 | 
189 | uint32_t dynload_function_replacements_size = sizeof(dynload_function_replacements) / sizeof(function_replacement_data_t);


--------------------------------------------------------------------------------
/source/sdrefcount/sd_function_replacements.cpp:
--------------------------------------------------------------------------------
  1 | #include "sd_function_replacements.h"
  2 | #include "applicationendshook/applicationends_function_replacements.h"
  3 | #include "globals.h"
  4 | #include "logger.h"
  5 | #include <coreinit/dynload.h>
  6 | #include <coreinit/filesystem_fsa.h>
  7 | #include <coreinit/interrupts.h>
  8 | #include <coreinit/scheduler.h>
  9 | #include <coreinit/title.h>
 10 | #include <string_view>
 11 | 
 12 | uint64_t NWFPatchTitleList[] = {
 13 |         0x0005000010102900L, // Demaecan JPN
 14 |         0x0005000010102A00L, // YNN JPN
 15 |         0x0005000010102D00L, // Hulu USA
 16 |         0x0005000010102E00L, // Amazon Instant Video USA
 17 |         0x0005000010102F00L, // Amazon / LOVEFiLM EUR
 18 |         0x0005000010104C00L, // Hulu JPN
 19 |         0x0005000010105700L, // YouTube ALL
 20 |         0x000500001012D300L, // Wii Street U powered by Google JPN
 21 |         0x0005000010132000L, // Wii Street U powered by Google USA
 22 |         0x0005000010132100L, // Wii Street U powered by Google EUR
 23 |         0x0005000010136100L, // BANDAI CHANNEL JPN
 24 |         0x0005000010149300L, // Mario vs. Donkey Kong Tipping Stars USA
 25 |         0x0005000010154500L, // Togabito JPN
 26 |         0x0005000010154800L, // BBC iPlayer EUR
 27 |         0x0005000010157D00L, // GAIABREAKER JPN
 28 |         0x000500001016E200L, // XType Plus EUR
 29 |         0x000500001016E500L, // BLOK DROP U USA
 30 |         0x000500001016E600L, // ZaciSa's Last Stand USA
 31 |         0x0005000010170400L, // XType Plus USA
 32 |         0x0005000010172A00L, // Crunchyroll USA
 33 |         0x0005000010172B00L, // Crunchyroll EUR
 34 |         0x0005000010173000L, // Nintendo Game Seminar 2013 Student Works JPN
 35 |         0x0005000010173100L, // I've Got to Run! USA
 36 |         0x0005000010175700L, // BLOK DROP U EUR
 37 |         0x0005000010175F00L, // Death Match Love Comedy JPN
 38 |         0x0005000010176400L, // Pixel Paint USA
 39 |         0x0005000010178E00L, // Mario vs. Donkey Kong Tipping Stars EUR
 40 |         0x0005000010179200L, // Mario vs. Donkey Kong Tipping Stars JPN
 41 |         0x0005000010179300L, // Internal Invasion USA
 42 |         0x0005000010179500L, // Plenty of Fishies USA
 43 |         0x000500001017A800L, // GAIABREAKER USA
 44 |         0x000500001017A900L, // SUPER ROBO MOUSE USA
 45 |         0x000500001017AB00L, // GAIABREAKER EUR
 46 |         0x000500001017DB00L, // Dolphin Up USA
 47 |         0x000500001017E200L, // 3Souls EUR
 48 |         0x000500001017E700L, // 3Souls USA
 49 |         0x000500001017EB00L, // SDK Paint USA
 50 |         0x000500001017EC00L, // Guac' a Mole EUR
 51 |         0x0005000010182E00L, // GetClose USA
 52 |         0x0005000010183100L, // Snake Den USA
 53 |         0x0005000010183400L, // U Host USA
 54 |         0x0005000010185000L, // ブタメダル JPN
 55 |         0x0005000010185900L, // GolT Stadium EUR
 56 |         0x000500001018A400L, // POKER DICE SOLITAIRE FUTURE USA
 57 |         0x000500001018D700L, // SHUT THE BOX USA
 58 |         0x000500001018EE00L, // Don't Touch Anything Red USA
 59 |         0x000500001018F900L, // TOSS N GO USA
 60 |         0x000500001018FE00L, // Sense by Play.me EUR
 61 |         0x0005000010190400L, // Red Riding Hood USA
 62 |         0x0005000010193900L, // Flapp & Zegeta USA
 63 |         0x0005000010193D00L, // Tiny Galaxy USA
 64 |         0x0005000010193E00L, // Twisted Fusion USA
 65 |         0x0005000010195F00L, // Arrow Time U USA
 66 |         0x0005000010198700L, // Watchup USA
 67 |         0x000500001019A100L, // Shapes of Gray USA
 68 |         0x000500001019A300L, // SPIKEY WALLS USA
 69 |         0x000500001019A700L, // BLOK DROP X TWISTED FUSION USA
 70 |         0x000500001019A800L, // Citadale The Legends Trilogy USA
 71 |         0x000500001019AD00L, // Elliot Quest USA
 72 |         0x000500001019B900L, // SUPER ROBO MOUSE EUR
 73 |         0x000500001019BA00L, // BLOK DROP X TWISTED FUSION EUR
 74 |         0x00050000101A2400L, // Tested with robots ! EUR
 75 |         0x00050000101A2E00L, // XType+ JPN
 76 |         0x00050000101A3E00L, // Defense Dome USA
 77 |         0x00050000101A4400L, // Toon Tanks USA
 78 |         0x00050000101A9100L, // Rakuten TV JPN
 79 |         0x00050000101A9F00L, // Dot Arcade USA
 80 |         0x00050000101AA300L, // SDK Spriter USA
 81 |         0x00050000101AAC00L, // Red Riding Hood EUR
 82 |         0x00050000101ABB00L, // COLOR BOMBS USA
 83 |         0x00050000101ACB00L, // psyscrolr USA
 84 |         0x00050000101AEB00L, // SDK Paint EUR
 85 |         0x00050000101AEF00L, // Midnight USA
 86 |         0x00050000101AF400L, // PixlCross USA
 87 |         0x00050000101B4F00L, // Asteroid Quarry USA
 88 |         0x00050000101B5000L, // Drop It: Block Paradise! USA
 89 |         0x00050000101B5E00L, // SPLASHY DUCK EUR
 90 |         0x00050000101B5F00L, // TABLETOP GALLERY EUR
 91 |         0x00050000101B8400L, // Mortar Melon USA
 92 |         0x00050000101B9600L, // Super Destronaut USA
 93 |         0x00050000101B9700L, // SDK Spriter EUR
 94 |         0x00050000101BA100L, // Best way to motivate kids ManabiGet! JPN
 95 |         0x00050000101BA700L, // PENTAPUZZLE USA
 96 |         0x00050000101BB300L, // ZaciSa: Defense of the Crayon Dimension! EUR
 97 |         0x00050000101BB800L, // Elliot Quest EUR
 98 |         0x00050000101BC000L, // ドットペイント JPN
 99 |         0x00050000101BC400L, // Plenty of Fishies EUR
100 |         0x00050000101BC500L, // Mortar Melon EUR
101 |         0x00050000101BCA00L, // Napster EUR
102 |         0x00050000101BCB00L, // Rhapsody USA
103 |         0x00050000101BCF00L, // Word Search by POWGI USA
104 |         0x00050000101C3900L, // Word Search by POWGI EUR
105 |         0x00050000101C3C00L, // PictoParty EUR
106 |         0x00050000101C4A00L, // Word Party EUR
107 |         0x00050000101C5500L, // Word Party USA
108 |         0x00050000101C5900L, // サイコロの森 3-in-1L, // JPN
109 |         0x00050000101C6100L, // Mini Mario & Friends amiibo Challenge JPN
110 |         0x00050000101C6200L, // Mini Mario & Friends amiibo Challenge USA
111 |         0x00050000101C6300L, // Mini Mario & Friends amiibo Challenge EUR
112 |         0x00050000101C6900L, // TABLETOP GALLERY USA
113 |         0x00050000101C6B00L, // PEG SOLITAIRE USA
114 |         0x00050000101C7200L, // Placards USA
115 |         0x00050000101C7300L, // The Stonecutter USA
116 |         0x00050000101C8E00L, // Drop It: Block Paradise! EUR
117 |         0x00050000101CA300L, // Neon Battle USA
118 |         0x00050000101CF900L, // Word Puzzles by POWGI EUR
119 |         0x00050000101CFA00L, // Word Puzzles by POWGI USA
120 |         0x00050000101CFD00L, // Near Earth Objects USA
121 |         0x00050000101CFF00L, // Job the Leprechaun USA
122 |         0x00050000101D1700L, // Booty Diver USA
123 |         0x00050000101D1A00L, // Aenigma Os USA
124 |         0x00050000101D2800L, // DON'T CRASH USA
125 |         0x00050000101D2900L, // PIXEL SLIME U USA
126 |         0x00050000101D2A00L, // Land it Rocket USA
127 |         0x00050000101D6200L, // Test Your Mind USA
128 |         0x00050000101D6700L, // Star Sky EUR
129 |         0x00050000101D7300L, // Molly Maggot USA
130 |         0x00050000101D7700L, // Explody Bomb USA
131 |         0x00050000101D7800L, // Hold Your Fire USA
132 |         0x00050000101D8A00L, // Star Sky USA
133 |         0x00050000101D8B00L, // ヒラメキパズル テトグラム JPN
134 |         0x00050000101D8C00L, // ブルームーン JPN
135 |         0x00050000101D9C00L, // Funky Physics USA
136 |         0x00050000101D9F00L, // Job the Leprechaun EUR
137 |         0x00050000101DB100L, // PictoParty USA
138 |         0x00050000101DD500L, // Elliot Quest JPN
139 |         0x00050000101DEE00L, // AVOIDER USA
140 |         0x00050000101DFA00L, // Draw 2 Survive USA
141 |         0x00050000101DFD00L, // Snowball USA
142 |         0x00050000101E2E00L, // Christmas Adventure of Rocket P. USA
143 |         0x00050000101E3200L, // Jewel Quest USA
144 |         0x00050000101E3300L, // Olympia Rising EUR
145 |         0x00050000101E3400L, // Olympia Rising USA
146 |         0x00050000101E5500L, // Escape From Flare Industries USA
147 |         0x00050000101E7800L, // SKEASY USA
148 |         0x00050000101E7900L, // SPLASHY DUCK USA
149 |         0x00050000101E7C00L, // TAP TAP ARCADE EUR
150 |         0x00050000101E7D00L, // TAP TAP ARCADE USA
151 |         0x00050000101E7E00L, // TOUCH SELECTIONS EUR
152 |         0x00050000101E7F00L, // TOUCH SELECTIONS USA
153 |         0x00050000101E8800L, // COLOR BOMBS EUR
154 |         0x00050000101E9700L, // U Host EUR
155 |         0x00050000101EA900L, // Armored ACORNs Action Squirrel Squad USA
156 |         0x00050000101EC600L, // Defense Dome EUR
157 |         0x00050000101EF400L, // Demonic Karma Summoner USA
158 |         0x00050000101F2700L, // Star Sky 2 EUR
159 |         0x00050000101F3E00L, // Star Sky 2 USA
160 |         0x00050000101F5900L, // PENTAPUZZLE EUR
161 |         0x00050000101F5F00L, // Hot Rod Racer USA
162 |         0x00050000101F6200L, // Adventure Party Cats and Caverns USA
163 |         0x00050000101F6600L, // Gravity+ USA
164 |         0x00050000101F6A00L, // Jewel Quest EUR
165 |         0x00050000101F6B00L, // PIXEL SLIME U EUR
166 |         0x00050000101F7400L, // Hot Rod Racer EUR
167 |         0x00050000101F7500L, // Midnight 2 USA
168 |         0x00050000101F7C00L, // TAP TAP ARCADE 2 USA
169 |         0x00050000101F8100L, // Gravity+ EUR
170 |         0x00050000101F8400L, // JACKPOT 777 EUR
171 |         0x00050000101F8D00L, // TAP TAP ARCADE 2 EUR
172 |         0x00050000101F9000L, // Citadale USA
173 |         0x00050000101F9200L, // JACKPOT 777 USA
174 |         0x00050000101F9400L, // SD2: Go Duck Yourself USA
175 |         0x00050000101F9900L, // Aenigma Os EUR
176 |         0x00050000101F9A00L, // Citadale EUR
177 |         0x00050000101FAB00L, // Collateral Thinking USA
178 |         0x00050000101FAC00L, // INVANOID USA
179 |         0x00050000101FAD00L, // SHOOTY SPACE USA
180 |         0x00050000101FAF00L, // Midnight 2 EUR
181 |         0x00050000101FB000L, // SD2: Go Duck Yourself EUR
182 |         0x00050000101FB400L, // Shadow Archer USA
183 |         0x00050000101FC000L, // BLOC USA
184 |         0x00050000101FCE00L, // Word Logic by POWGI USA
185 |         0x00050000101FD200L, // SUPER ROBO MOUSE JPN
186 |         0x00050000101FD300L, // BLOK DROP U JPN
187 |         0x00050000101FE600L, // Amazon Video JPN
188 |         0x00050000101FEC00L, // Toon Tanks EUR
189 |         0x00050000101FF900L, // Test Your Mind EUR
190 |         0x00050000101FFA00L, // Word Logic by POWGI EUR
191 |         0x0005000010200200L, // Collateral Thinking EUR
192 |         0x0005000010200700L, // Twisted Fusion EUR
193 |         0x0005000010200E00L, // PANDA LOVE USA
194 |         0x0005000010200F00L, // PANDA LOVE EUR
195 |         0x0005000010201500L, // TITANS TOWER USA
196 |         0x0005000010201600L, // TITANS TOWER EUR
197 |         0x0005000010201800L, // SHOOTY SPACE EUR
198 |         0x0005000010202100L, // Overworld Defender Remix USA
199 |         0x0005000010202500L, // Alice in Wonderland USA
200 |         0x0005000010202600L, // Laser Blaster USA
201 |         0x0005000010202700L, // Rorrim USA
202 |         0x0005000010202900L, // Amazon Video BETA JPN
203 |         0x0005000010202A00L, // Amazon Video USA
204 |         0x0005000010202B00L, // Laser Blaster EUR
205 |         0x0005000010203600L, // Rorrim EUR
206 |         0x0005000010203900L, // Alice in Wonderland EUR
207 |         0x0005000010203D00L, // Space Hunted: The Lost Levels USA
208 |         0x0005000010207600L, // Space Hunted USA
209 |         0x0005000010207700L, // Y.A.S.G USA
210 |         0x0005000010207B00L, // Shadow Archer EUR
211 |         0x0005000010207C00L, // A.C.E. - Alien Cleanup Elite USA
212 |         0x0005000010208E00L, // A.C.E. EUR
213 |         0x0005000010209D00L, // Sudoku Party EUR
214 |         0x0005000010209E00L, // Sudoku Party USA
215 |         0x000500001020A100L, // Star Sky 2 JPN
216 |         0x000500001020B800L, // Scribble EUR
217 |         0x000500001020BB00L, // Scribble USA
218 |         0x000500001020C700L, // BLOC EUR
219 |         0x000500001020D100L, // Pic-a-Pix Colour EUR
220 |         0x000500001020D700L, // Pic-a-Pix Color USA
221 |         0x000500001020F500L, // Absolutely Unstoppable MineRun EUR
222 |         0x000500001020FD00L, // Absolutely Unstoppable MineRun USA
223 |         0x0005000010210300L, // Citadale The Legends Trilogy EUR
224 |         0x0005000010210400L, // Space Hunted EUR
225 |         0x0005000010210500L, // Y.A.S.G EUR
226 |         0x0005000010210700L, // The Stonecutter EUR
227 |         0x0005000010211000L, // Coqui The Game USA
228 |         0x0005000010211400L, // Daikon Set USA
229 |         0x0005000010211E00L, // A Drawing's Journey EUR
230 |         0x0005000010212500L, // Armored ACORNs Action Squirrel Squad EUR
231 |         0x0005000010213500L, // Super Ultra Star Shooter EUR
232 |         0x0005000010213B00L, // Cubeshift USA
233 |         0x0005000010213C00L, // Super Ultra Star Shooter USA
234 |         0x0005000010215F00L, // Spellcaster's Assistant EUR
235 |         0x0005000010216100L, // Spellcaster's Assistant USA
236 |         0x0005000010216D00L, // Shadow Archery USA
237 |         0x0005000010216E00L, // Shadow Archery EUR
238 |         0x0005000010217C00L, // Sinister Assistant EUR
239 |         0x0005000010217F00L, // Sinister Assistant USA
240 |         0x0005000010219C00L, // Space Hunted: The Lost Levels EUR
241 |         0x000500001021B200L, // Captain U USA
242 |         0x000500001021C000L, // Seasonal Assistant USA
243 |         0x000500001021C100L, // Seasonal Assistant EUR
244 |         0x000500001021C600L, // Captain U EUR
245 |         0x000500001021C900L, // Reversi 32 EUR
246 |         0x000500021016E601L, // ZaciSa's Last Stand Demo USA
247 |         0x000500021017E201L, // 3Souls (Demo) EUR
248 |         0x000500021017E701L, // 3Souls (Demo) USA
249 |         0x000500021017EB01L, // SDK Paint Demo USA
250 |         0x00050002101A2E01L, // XType+ (体験版） JPN
251 |         0x00050002101AA301L, // SDK Spriter DEMO USA
252 |         0x00050002101AEB01L, // SDK Paint Demo EUR
253 |         0x00050002101B9701L, // SDK Spriter DEMO EUR
254 |         0x00050002101BB301L, // ZaciSa: Defense of the Crayon Dimension! Demo EUR
255 |         0x00050002101BCF01L, // Word Search by POWGI (Demo) USA
256 |         0x00050002101C3901L, // Word Search by POWGI (Demo) EUR
257 |         0x00050002101C4A01L, // Word Party (Demo) EUR
258 |         0x00050002101C5501L, // Word Party (Demo) USA
259 |         0x00050002101C5901L, // サイコロの森 3-in-1（体験版） JPN
260 |         0x00050002101CF901L, // Word Puzzles by POWGI (Demo) EUR
261 |         0x00050002101CFA01L, // Word Puzzles by POWGI (Demo) USA
262 |         0x00050002101D8B01L, // ヒラメキパズル テトグラム（体験版) JPN
263 |         0x00050002101FCE01L, // Word Logic by POWGI (Demo) USA
264 |         0x00050002101FFA01L, // Word Logic by POWGI (Demo) EUR
265 |         0x000500021020D101L, // Pic-a-Pix Colour (Demo) EUR
266 |         0x000500021020D701L, // Pic-a-Pix Color (Demo) USA
267 | };
268 | 
269 | void NWF_Fix() {
270 |     auto titleID = OSGetTitleID();
271 |     bool found   = false;
272 |     for (auto &tid : NWFPatchTitleList) {
273 |         if (tid == titleID) {
274 |             DEBUG_FUNCTION_LINE_WARN("Title using \"LibPlatform::Input::GetInstance()\" detected!");
275 |             found = true;
276 |             break;
277 |         }
278 |     }
279 |     if (!found) {
280 |         return;
281 |     }
282 |     // Some games using the NWF (like Dot Arcade) keep a thread called "PlatformInputAppStateListenerThread" running,
283 |     // which will cause a DSI exception if the title is not closing fast enough.
284 |     auto *curThread = OSGetCurrentThread();
285 |     __OSLockScheduler(curThread);
286 |     int state   = OSDisableInterrupts();
287 |     OSThread *t = *((OSThread **) 0x100567F8);
288 |     while (t) {
289 |         if (t->name != nullptr && std::string_view(t->name) == "PlatformInputAppStateListenerThread") {
290 |             t->priority = 0x80;
291 |             OSReport("Set priority to %d for thread \"%s\" (%08X) to prevent it from running/crashing\n", t->priority, t->name, t);
292 |         }
293 |         t = t->activeLink.next;
294 |     }
295 |     OSRestoreInterrupts(state);
296 |     __OSUnlockScheduler(curThread);
297 | }
298 | 
299 | DECL_FUNCTION(void, __PPCExit, uint32_t u1) {
300 |     NWF_Fix();
301 | 
302 |     CallHook(WUMS_HOOK_APPLICATION_ENDS);
303 |     CallHook(WUMS_HOOK_ALL_APPLICATION_ENDS_DONE);
304 |     CallHook(WUMS_HOOK_FINI_WUT_SOCKETS);
305 |     CallHook(WUMS_HOOK_FINI_WUT_DEVOPTAB);
306 |     if (gSDMountRefCount > 0) {
307 |         FSAInit();
308 |         auto client = FSAAddClient(nullptr);
309 |         if (client) {
310 |             FSAUnmount(client, "/vol/external01/", FSA_UNMOUNT_FLAG_BIND_MOUNT);
311 |         }
312 |         gSDMountRefCount = 0;
313 |     }
314 | 
315 |     if (gModuleData->number_acquired_rpls > 0) {
316 |         DEBUG_FUNCTION_LINE_VERBOSE("Release RPLs acquired by modules");
317 |         for (uint32_t i = 0; i < gModuleData->number_acquired_rpls; i++) {
318 |             DEBUG_FUNCTION_LINE_VERBOSE("OSDynLoad_Release(0x%08X)", gModuleData->acquired_rpls[i]);
319 |             OSDynLoad_Release((void *) gModuleData->acquired_rpls[i]);
320 |         }
321 |     }
322 |     real___PPCExit(u1);
323 | }
324 | 
325 | DECL_FUNCTION(FSStatus, FSMount, FSClient *client, FSCmdBlock *cmd, FSMountSource *source, char *target, uint32_t bytes, FSErrorFlag errorMask) {
326 |     if (std::string_view(target) == "/vol/external01") {
327 |         if (gSDMountRefCount > 0) {
328 |             gSDMountRefCount++;
329 |             return FS_STATUS_OK;
330 |         }
331 |         auto res = real_FSMount(client, cmd, source, target, bytes, errorMask);
332 |         if (res == FS_STATUS_OK) {
333 |             gSDMountRefCount++;
334 |         }
335 |         return res;
336 |     }
337 | 
338 | 
339 |     return real_FSMount(client, cmd, source, target, bytes, errorMask);
340 | }
341 | 
342 | DECL_FUNCTION(FSStatus, FSUnmount, FSClient *client, FSCmdBlock *cmd, const char *target, FSErrorFlag errorMask) {
343 |     if (std::string_view(target) == "/vol/external01") {
344 |         gSDMountRefCount--;
345 |         if (gSDMountRefCount <= 0) {
346 |             gSDMountRefCount = 0;
347 |             return real_FSUnmount(client, cmd, target, errorMask);
348 |         }
349 |         return FS_STATUS_OK;
350 |     }
351 |     return real_FSUnmount(client, cmd, target, errorMask);
352 | }
353 | 
354 | DECL_FUNCTION(FSError, FSAMount, FSAClientHandle client, const char *source, const char *target, FSAMountFlags flags, void *arg_buf, uint32_t arg_len) {
355 |     if (std::string_view(target) == "/vol/external01") {
356 |         if (gSDMountRefCount > 0) {
357 |             gSDMountRefCount++;
358 |             return FS_ERROR_OK;
359 |         }
360 |         auto res = real_FSAMount(client, source, target, flags, arg_buf, arg_len);
361 |         if (res == FS_ERROR_OK || res == FS_ERROR_ALREADY_EXISTS) {
362 |             gSDMountRefCount++;
363 |         }
364 |         return res;
365 |     }
366 | 
367 |     return real_FSAMount(client, source, target, flags, arg_buf, arg_len);
368 | }
369 | 
370 | DECL_FUNCTION(FSError, FSAUnmount, FSAClientHandle client, const char *mountedTarget, FSAUnmountFlags flags) {
371 |     if (std::string_view(mountedTarget) == "/vol/external01") {
372 |         gSDMountRefCount--;
373 |         if (gSDMountRefCount <= 0) {
374 |             auto res         = real_FSAUnmount(client, mountedTarget, flags);
375 |             gSDMountRefCount = 0;
376 |             return res;
377 |         }
378 |         return FS_ERROR_OK;
379 |     }
380 | 
381 |     return real_FSAUnmount(client, mountedTarget, flags);
382 | }
383 | 
384 | function_replacement_data_t sdrefcount_function_replacements[] = {
385 |         REPLACE_FUNCTION(__PPCExit, LIBRARY_COREINIT, __PPCExit),
386 |         REPLACE_FUNCTION(FSMount, LIBRARY_COREINIT, FSMount),
387 |         REPLACE_FUNCTION(FSUnmount, LIBRARY_COREINIT, FSUnmount),
388 |         REPLACE_FUNCTION(FSAMount, LIBRARY_COREINIT, FSAMount),
389 |         REPLACE_FUNCTION(FSAUnmount, LIBRARY_COREINIT, FSAUnmount)};
390 | 
391 | uint32_t sdrefcount_function_replacements_size = sizeof(sdrefcount_function_replacements) / sizeof(function_replacement_data_t);


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     {one line to give the program's name and a brief idea of what it does.}
635 |     Copyright (C) {year}  {name of author}
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     {project}  Copyright (C) {year}  {fullname}
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------