1 /* 2 * Copyright (c) 2025 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 31 #include "fibers.h" 32 33 /* 34 * The fibers data racer checker is a watchpoint-based checker inspired by DataCollider: https://www.usenix.org/legacy/event/osdi10/tech/full_papers/Erickson.pdf 35 * Unlike the original paper, here everything is implemented in software and called from the load/store instrumentation in mock_thread.c 36 * Check to SANCOV_LOAD_STORE_DATA_CHECKER macro to see how the checker API is used. 37 */ 38 39 enum access_type { 40 ACCESS_TYPE_LOAD = 0, 41 ACCESS_TYPE_STORE = 1 42 }; 43 44 // check for concurrent accesses on the same region and, if no data race is detected, install a watchpoint so that other fibers can perform the same check 45 extern bool check_and_set_watchpoint(void *pc, uintptr_t address, size_t size, enum access_type access_type); 46 // remove the watchpoint after the memory access is completed 47 extern void post_check_and_remove_watchpoint(uintptr_t address, size_t size, enum access_type access_type); 48 // report a data race 49 extern void report_value_race(uintptr_t current_addr, size_t current_size, enum access_type current_type); 50