1*43a90889SApple OSS Distributions /* 2*43a90889SApple OSS Distributions * Copyright (c) 2017 Apple Inc. All rights reserved. 3*43a90889SApple OSS Distributions * 4*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*43a90889SApple OSS Distributions * 6*43a90889SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*43a90889SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*43a90889SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*43a90889SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*43a90889SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*43a90889SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*43a90889SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*43a90889SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*43a90889SApple OSS Distributions * 15*43a90889SApple OSS Distributions * Please obtain a copy of the License at 16*43a90889SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*43a90889SApple OSS Distributions * 18*43a90889SApple OSS Distributions * The Original Code and all software distributed under the License are 19*43a90889SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*43a90889SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*43a90889SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*43a90889SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*43a90889SApple OSS Distributions * Please see the License for the specific language governing rights and 24*43a90889SApple OSS Distributions * limitations under the License. 25*43a90889SApple OSS Distributions * 26*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*43a90889SApple OSS Distributions */ 28*43a90889SApple OSS Distributions #ifndef _COMMPAGE_H 29*43a90889SApple OSS Distributions #define _COMMPAGE_H 30*43a90889SApple OSS Distributions 31*43a90889SApple OSS Distributions #ifdef PRIVATE 32*43a90889SApple OSS Distributions 33*43a90889SApple OSS Distributions #include <stdint.h> 34*43a90889SApple OSS Distributions 35*43a90889SApple OSS Distributions #define _COMM_PAGE32_SIGNATURE_STRING "commpage 32-bit" 36*43a90889SApple OSS Distributions #define _COMM_PAGE64_SIGNATURE_STRING "commpage 64-bit" 37*43a90889SApple OSS Distributions 38*43a90889SApple OSS Distributions typedef volatile struct commpage_timeofday_data { 39*43a90889SApple OSS Distributions uint64_t TimeStamp_tick; 40*43a90889SApple OSS Distributions uint64_t TimeStamp_sec; 41*43a90889SApple OSS Distributions uint64_t TimeStamp_frac; 42*43a90889SApple OSS Distributions uint64_t Ticks_scale; 43*43a90889SApple OSS Distributions uint64_t Ticks_per_sec; 44*43a90889SApple OSS Distributions } new_commpage_timeofday_data_t; 45*43a90889SApple OSS Distributions 46*43a90889SApple OSS Distributions /*! 47*43a90889SApple OSS Distributions * @macro COMM_PAGE_SLOT_TYPE 48*43a90889SApple OSS Distributions * 49*43a90889SApple OSS Distributions * @brief 50*43a90889SApple OSS Distributions * Macro that expands to the proper type for a pointer to a commpage slot, 51*43a90889SApple OSS Distributions * to be used in a local variable declaration. 52*43a90889SApple OSS Distributions * 53*43a90889SApple OSS Distributions * @description 54*43a90889SApple OSS Distributions * Usage is something like: 55*43a90889SApple OSS Distributions * <code> 56*43a90889SApple OSS Distributions * COMM_PAGE_SLOT_TYPE(uint64_t) slot = COMM_PAGE_SLOT(uint64_t, FOO); 57*43a90889SApple OSS Distributions * </code> 58*43a90889SApple OSS Distributions * 59*43a90889SApple OSS Distributions * @param type The scalar base type for the slot. 60*43a90889SApple OSS Distributions */ 61*43a90889SApple OSS Distributions #if __has_feature(address_sanitizer) 62*43a90889SApple OSS Distributions #define COMM_PAGE_SLOT_TYPE(type_t) type_t __attribute__((address_space(1))) volatile * 63*43a90889SApple OSS Distributions #else 64*43a90889SApple OSS Distributions #define COMM_PAGE_SLOT_TYPE(type_t) type_t volatile * 65*43a90889SApple OSS Distributions #endif 66*43a90889SApple OSS Distributions 67*43a90889SApple OSS Distributions /*! 68*43a90889SApple OSS Distributions * @macro COMM_PAGE_SLOT 69*43a90889SApple OSS Distributions * 70*43a90889SApple OSS Distributions * @brief 71*43a90889SApple OSS Distributions * Macro that expands to the properly typed address for a commpage slot. 72*43a90889SApple OSS Distributions * 73*43a90889SApple OSS Distributions * @param type The scalar base type for the slot. 74*43a90889SApple OSS Distributions * @param name The slot name, without its @c _COMM_PAGE_ prefix. 75*43a90889SApple OSS Distributions */ 76*43a90889SApple OSS Distributions #define COMM_PAGE_SLOT(type_t, name) ((COMM_PAGE_SLOT_TYPE(type_t))_COMM_PAGE_##name) 77*43a90889SApple OSS Distributions 78*43a90889SApple OSS Distributions /*! 79*43a90889SApple OSS Distributions * @macro COMM_PAGE_READ 80*43a90889SApple OSS Distributions * 81*43a90889SApple OSS Distributions * @brief 82*43a90889SApple OSS Distributions * Performs a single read from the commpage in a way that doesn't trip 83*43a90889SApple OSS Distributions * address sanitizers. 84*43a90889SApple OSS Distributions * 85*43a90889SApple OSS Distributions * @description 86*43a90889SApple OSS Distributions * Typical use looks like this: 87*43a90889SApple OSS Distributions * <code> 88*43a90889SApple OSS Distributions * uint64_t foo_value = COMM_PAGE_READ(uint64_t, FOO); 89*43a90889SApple OSS Distributions * </code> 90*43a90889SApple OSS Distributions * 91*43a90889SApple OSS Distributions * @param type The scalar base type for the slot. 92*43a90889SApple OSS Distributions * @param name The slot name, without its @c _COMM_PAGE_ prefix. 93*43a90889SApple OSS Distributions */ 94*43a90889SApple OSS Distributions #define COMM_PAGE_READ(type_t, slot) (*(COMM_PAGE_SLOT(type_t, slot))) 95*43a90889SApple OSS Distributions 96*43a90889SApple OSS Distributions #endif 97*43a90889SApple OSS Distributions 98*43a90889SApple OSS Distributions #endif 99