pspmoduleinfo.h

Go to the documentation of this file.

/*
 * PSP Software Development Kit - https://github.com/pspdev
 * -----------------------------------------------------------------------
 * Licensed under the BSD license, see LICENSE in PSPSDK root for details.
 *
 * pspmoduleinfo.h - Definitions for the .rodata.sceModuleInfo ELF section.
 *
 * Copyright (c) 2005 Marcus R. Brown <mrbrown@ocgnet.org>
 * Copyright (c) 2005 James Forshaw <tyranid@gmail.com>
 * Copyright (c) 2005 John Kelley <ps2dev@kelley.ca>
 *
 */
#ifndef PSPMODULEINFO_H
#define PSPMODULEINFO_H
 
/* Note: Some of the structures and definitions in this file were extrapolated from
   symbolic debugging information found in the Japanese version of Puzzle Bobble. */
 
/* Module info structure.  Used to declare a module (library or executable).  This structure
   is required in all PSP executables. */
typedef struct _scemoduleinfo {
        unsigned short          modattribute;
        unsigned char           modversion[2];
        char                    modname[27];
        char                    terminal;
        void *                  gp_value;
        void *                  ent_top;
        void *                  ent_end;
        void *                  stub_top;
        void *                  stub_end;
} _sceModuleInfo;
 
typedef const _sceModuleInfo SceModuleInfo;
 
extern char _gp[];
 
enum PspModuleInfoAttr
{
        PSP_MODULE_USER                 = 0,
        PSP_MODULE_NO_STOP              = 0x0001,
        PSP_MODULE_SINGLE_LOAD  = 0x0002,
        PSP_MODULE_SINGLE_START = 0x0004,
        PSP_MODULE_KERNEL               = 0x1000,
};
 
#ifdef __cplusplus
 
/* Declare a module.  This must be specified in the source of a library or executable. */
#define PSP_MODULE_INFO(name, attributes, major_version, minor_version) \
        extern char __lib_ent_top[], __lib_ent_bottom[];                \
        extern char __lib_stub_top[], __lib_stub_bottom[];              \
        extern SceModuleInfo module_info                                \
                __attribute__((section(".rodata.sceModuleInfo"),        \
                               aligned(16), unused)) = {                \
          attributes, { minor_version, major_version }, #name, 0, _gp,  \
          __lib_ent_top, __lib_ent_bottom,                              \
          __lib_stub_top, __lib_stub_bottom                             \
        }
#else
/* Declare a module.  This must be specified in the source of a library or executable. */
#define PSP_MODULE_INFO(name, attributes, major_version, minor_version) \
        extern char __lib_ent_top[], __lib_ent_bottom[];                \
        extern char __lib_stub_top[], __lib_stub_bottom[];              \
        SceModuleInfo module_info                                       \
                __attribute__((section(".rodata.sceModuleInfo"),        \
                               aligned(16), unused)) = {                \
          attributes, { minor_version, major_version }, name, 0, _gp,  \
          __lib_ent_top, __lib_ent_bottom,                              \
          __lib_stub_top, __lib_stub_bottom                             \
        }
#endif
 
/* Define the main thread's initial priority. */
#define PSP_MAIN_THREAD_PRIORITY(priority) \
        unsigned int sce_newlib_priority = (priority)
/* Define the main thread's stack size (in KB). */
#define PSP_MAIN_THREAD_STACK_SIZE_KB(size_kb) \
        unsigned int sce_newlib_stack_kb_size = (size_kb)
/* Define the main thread's attributes. */
#define PSP_MAIN_THREAD_ATTR(attr) \
        unsigned int sce_newlib_attribute = (attr)
#define PSP_MAIN_THREAD_ATTRIBUTE PSP_MAIN_THREAD_ATTR
 
/* Define all main thread parameters. */
#define PSP_MAIN_THREAD_PARAMS(priority, size_kb, attribute) \
        PSP_MAIN_THREAD_PRIORITY(priority); \
        PSP_MAIN_THREAD_STACK_SIZE_KB(size_kb); \
        PSP_MAIN_THREAD_ATTR(attribute)
 
/* If declared, the runtime code won't create a main thread for the program. */
#define PSP_NO_CREATE_MAIN_THREAD() \
        int sce_newlib_nocreate_thread_in_start = 1
 
/* Declare the size of the heap (in KB) that the program wants to allocate from. */
#define PSP_HEAP_SIZE_KB(size_kb) \
        int sce_newlib_heap_kb_size = (size_kb)
 
/* Declare the threshold of the heap (in KB) that the program wants to keep for external allocation. */
#define PSP_HEAP_THRESHOLD_SIZE_KB(size_kb) \
        int sce_newlib_heap_threshold_kb_size = (size_kb)
 
/* Declare the name of the main thread */
#define PSP_MAIN_THREAD_NAME(s) const char* sce_newlib_main_thread_name = (s)
 
/* Disable the use of newlib, getting a minimal binary. */
#define PSP_DISABLE_NEWLIB() \
        void __libcglue_init(int argc, char *argv[]) {} \
        void __libcglue_deinit() {}
 
/* Disable using pipe suuport from POSIX functions. */
#define PSP_DISABLE_NEWLIB_PIPE_SUPPORT() \
        static int __pipe_not_supported() { \
                errno = ENOSYS; \
                return -1; \
        } \
        int __pipe_close(int fd) { return __pipe_not_supported(); } \
        int __pipe_nonblocking_read(int fd, void *buf, size_t len) { return __pipe_not_supported(); } \
        int __pipe_read(int fd, void *buf, size_t len) { return __pipe_not_supported(); } \
        int __pipe_write(int fd, const void *buf, size_t len) { return __pipe_not_supported(); } \
        int __pipe_nonblocking_write(int fd, const void *buf, size_t len) { return __pipe_not_supported(); }
 
/* Disable using socket suuport from POSIX functions. */
#define PSP_DISABLE_NEWLIB_SOCKET_SUPPORT() \
        static int __socket_not_supported() { \
                errno = ENOSYS; \
                return -1; \
        } \
        int __socket_close(int sock) { return __socket_not_supported(); } \
        ssize_t recv(int s, void *buf, size_t len, int flags) { return __socket_not_supported(); } \
        ssize_t send(int s, const void *buf, size_t len, int flags) { return __socket_not_supported(); } \
        int     setsockopt(int s, int level, int optname, const void *optval, socklen_t optlen) { return __socket_not_supported(); } 
 
/* Disable the timezone support from newlib. */
#define PSP_DISABLE_NEWLIB_TIMEZONE_SUPPORT() \
        void __timezone_update() { }
 
/* Disable the CWD support from newlib. */
#define PSP_DISABLE_NEWLIB_CWD_SUPPORT() \
        void __init_cwd(char *argv_0) {}
 
/* Disable the auto start of pthread on init for reducing binary size if not used. */
#define PSP_DISABLE_AUTOSTART_PTHREAD() \
        void __libpthreadglue_init() {}
 
#endif /* PSPMODULEINFO_H */