xref: /xnu-11417.121.6/libsyscall/wrappers/_libkernel_init.h (revision a1e26a70f38d1d7daa7b49b258e2f8538ad81650)

/*
 * Copyright (c) 2010-2014 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifndef __LIBKERNEL_INIT_H
#define __LIBKERNEL_INIT_H

#include <ptrauth.h>
#include <stdbool.h>
#include <sys/types.h>
#include <mach/mach.h>
#include <mach/message.h>
#include <mach/mach_types.h>

#ifndef __OS_VOUCHER_PRIVATE__
// We cannot include the actual os/voucher_private.h definition of voucher_t
// here, as that also marks the voucher_XXX functions as exported, which causes
// a compile error when we attempt to mark them hidden in the .c file.
//
// The Libsystem init.c file does include os/voucher_private.h though, as well
// as this file, and this typedef causes an error if it is unguarded.
struct voucher_s;
typedef struct voucher_s *voucher_t;
#endif

typedef unsigned long long malloc_type_id_t;

#if __PTRAUTH_INTRINSICS__ && __has_builtin(__builtin_ptrauth_string_discriminator)
#define LIBKERNEL_FUNCTION_PTRAUTH(f) \
	__ptrauth(ptrauth_key_function_pointer,1, \
	        __builtin_ptrauth_string_discriminator("libkernel_functions_" # f) \
	) f
#else
#define LIBKERNEL_FUNCTION_PTRAUTH(f) f
#endif

typedef const struct _libkernel_functions {
	/* The following functions are included in version 1 of this structure */
	unsigned long version;
	void* (*LIBKERNEL_FUNCTION_PTRAUTH(dlsym))(void*, const char*);
	void* (*LIBKERNEL_FUNCTION_PTRAUTH(malloc))(size_t);
	void(*LIBKERNEL_FUNCTION_PTRAUTH(free))(void*);
	void* (*LIBKERNEL_FUNCTION_PTRAUTH(realloc))(void*, size_t);
	void(*LIBKERNEL_FUNCTION_PTRAUTH(_pthread_exit_if_canceled))(int);

	/* The following functions are included in version 2 of this structure */
	void *reserved1;
	void *reserved2;
	void *reserved3;
	void *reserved4;
	void *reserved5;

	/* The following functions are included in version 3 of this structure */
	void(*LIBKERNEL_FUNCTION_PTRAUTH(pthread_clear_qos_tsd))(mach_port_t);

	/* The following functions are included in version 4 of this structure */
	int(*LIBKERNEL_FUNCTION_PTRAUTH(pthread_current_stack_contains_np))(const void *, size_t);

	/* The following functions are included in version 5 of this structure */
	void* (*LIBKERNEL_FUNCTION_PTRAUTH(malloc_type_malloc))(size_t, malloc_type_id_t);
	void(*LIBKERNEL_FUNCTION_PTRAUTH(malloc_type_free))(void *, malloc_type_id_t);
	void* (*LIBKERNEL_FUNCTION_PTRAUTH(malloc_type_realloc))(void *, size_t, malloc_type_id_t);

	/* Subsequent versions must only add pointers! */
} *_libkernel_functions_t;

typedef const struct _libkernel_string_functions {
	/* The following functions are included in version 1 of this structure */
	unsigned long version;
	void (*bzero)(void *s, size_t n);
	void * (*memchr)(const void *s, int c, size_t n);
	int (*memcmp)(const void *s1, const void *s2, size_t n);
	void * (*memmove)(void *dst, const void *src, size_t n);
	void * (*memccpy)(void *__restrict dst, const void *__restrict src, int c, size_t n);
	void * (*memset)(void *b, int c, size_t len);
	char * (*strchr)(const char *s, int c);
	int (*strcmp)(const char *s1, const char *s2);
	char * (*strcpy)(char * restrict dst, const char * restrict src);
	size_t (*strlcat)(char * restrict dst, const char * restrict src, size_t maxlen);
	size_t (*strlcpy)(char * restrict dst, const char * restrict src, size_t maxlen);
	size_t (*strlen)(const char *str);
	int (*strncmp)(const char *s1, const char *s2, size_t n);
	char * (*strncpy)(char * restrict dst, const char * restrict src, size_t maxlen);
	size_t (*strnlen)(const char *s, size_t maxlen);
	char * (*strstr)(const char *s, const char *find);
	/* Subsequent versions must only add pointers! */
} *_libkernel_string_functions_t;

typedef const struct _libkernel_voucher_functions {
	/* The following functions are included in version 1 of this structure */
	unsigned long version;
	boolean_t (*voucher_mach_msg_set)(mach_msg_header_t*);
	void (*voucher_mach_msg_clear)(mach_msg_header_t*);
	voucher_mach_msg_state_t (*voucher_mach_msg_adopt)(mach_msg_header_t*);
	void (*voucher_mach_msg_revert)(voucher_mach_msg_state_t);

	/* version 2 is skipped */

	/* The following functions are included in version 3 of this structure */
	mach_msg_size_t (*voucher_mach_msg_fill_aux)(mach_msg_aux_header_t*, mach_msg_size_t);

	/* Subsequent versions must only add pointers! */
} *_libkernel_voucher_functions_t;

typedef struct _libkernel_late_init_config {
	unsigned long version;

	/* Version 1 fields */
	bool enable_system_version_compat;

	/* Version 2 fields */
	bool enable_ios_version_compat;

	/* Version 3 fields */
	bool enable_posix_spawn_filtering;
} *_libkernel_late_init_config_t;

struct ProgramVars; /* forward reference */

void __libkernel_init(_libkernel_functions_t fns, const char *envp[],
    const char *apple[], const struct ProgramVars *vars);

kern_return_t __libkernel_platform_init(_libkernel_string_functions_t fns);

kern_return_t __libkernel_voucher_init(_libkernel_voucher_functions_t fns);

void __libkernel_init_late(_libkernel_late_init_config_t config);

typedef struct _libkernel_init_after_boot_tasks_config {
	unsigned long version;

	/* Version 1 fields */
	bool enable_posix_spawn_filtering;
} *_libkernel_init_after_boot_tasks_config_t;

void __libkernel_init_after_boot_tasks(
	_libkernel_init_after_boot_tasks_config_t config);

#endif // __LIBKERNEL_INIT_H