1 /* 2 * Copyright (c) 2000-2024 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 29 #pragma once 30 #include <stdbool.h> 31 #include "unit_test_utils.h" 32 33 // -- darwin-test proxy macros and support -- 34 // libdarwintest.a is linked only to the main executable of the test and not to the XNU .dylib or 35 // the mocks .dylib, otherwise there would create 3 instances of darwintest in the same process, each with different 36 // state. 37 // On some occasions some code in these .dylibs need to call darwin-test macros so that the output 38 // is visible to the user. An example for this is when XNU code calls panic or assert. 39 // To achieve this, the file dt_proxy.c is built into every test executable and it contains a constructor function 40 // which registers a set of proxy functions that call the darwin-test macros. 41 42 struct dt_proxy_callbacks { 43 void (*t_assert_true)(bool cond, const char *msg); 44 void (*t_assert_notnull)(void *ptr, const char *msg); 45 void (*t_assert_posix_zero)(int v, const char *msg); 46 void (*t_log)(const char *msg); 47 void (*t_log_fmtstr)(const char *fmt, const char *msg); 48 void (*t_fail)(const char *msg); 49 void (*t_quiet)(void); 50 }; 51 52 // register the proxies to the XNU .dylib 53 extern void set_dt_proxy_attached(struct dt_proxy_callbacks *p); 54 // register the proxies to the mocks .dylib 55 extern void set_dt_proxy_mock(struct dt_proxy_callbacks *p); 56 57 extern struct dt_proxy_callbacks *get_dt_proxy_attached(void); 58 extern struct dt_proxy_callbacks *get_dt_proxy_mock(void); 59 60 // A pointer of this name appears in the XNU .dylib and the mocks .dylib 61 extern struct dt_proxy_callbacks *dt_proxy; 62 63 #define PT_ASSERT_TRUE(cond, msg) do { if (dt_proxy) { dt_proxy->t_assert_true((cond), #cond msg); } } while(false) 64 #define PT_ASSERT_TRUE_S(cond, msg) do { if (dt_proxy) { dt_proxy->t_assert_true((cond), msg); } } while(false) 65 #define PT_ASSERT_NOTNULL(ptr, msg) do { if (dt_proxy) { dt_proxy->t_assert_notnull((ptr), msg); } } while(false) 66 #define PT_ASSERT_POSIX_ZERO(v, msg) do { if (dt_proxy) { dt_proxy->t_assert_posix_zero((v), msg); } } while(false) 67 #define PT_LOG(msg) do { if (dt_proxy) { dt_proxy->t_log(msg); } } while(false) 68 #define PT_LOG_FMTSTR(fmt, str) do { if (dt_proxy) { dt_proxy->t_log_fmtstr(fmt, str); } } while(false) 69 #define PT_LOG_OR_RAW_FMTSTR(fmt, str) do { \ 70 if (dt_proxy) { \ 71 dt_proxy->t_log_fmtstr(fmt, str); \ 72 } else { \ 73 raw_printf(fmt "\n", str); \ 74 } \ 75 } while(false) 76 #define PT_FAIL(msg) do { if (dt_proxy) { dt_proxy->t_fail(msg); } } while(false) 77 #define PT_QUIET do { if (dt_proxy) { dt_proxy->t_quiet(); } } while(false) 78