1*43a90889SApple OSS Distributions /* 2*43a90889SApple OSS Distributions * Copyright (c) 2014 Apple Computer, 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 29*43a90889SApple OSS Distributions #ifndef _SYS_PGO_H_ 30*43a90889SApple OSS Distributions #define _SYS_PGO_H_ 31*43a90889SApple OSS Distributions 32*43a90889SApple OSS Distributions #include <sys/_types.h> 33*43a90889SApple OSS Distributions #include <sys/_types/_ssize_t.h> 34*43a90889SApple OSS Distributions #include <stdint.h> 35*43a90889SApple OSS Distributions #include <uuid/uuid.h> 36*43a90889SApple OSS Distributions 37*43a90889SApple OSS Distributions /* No longer supported. */ 38*43a90889SApple OSS Distributions #define PGO_HIB (1) 39*43a90889SApple OSS Distributions 40*43a90889SApple OSS Distributions #define PGO_WAIT_FOR_UNLOAD (2) 41*43a90889SApple OSS Distributions #define PGO_METADATA (4) 42*43a90889SApple OSS Distributions #define PGO_RESET_ALL (8) 43*43a90889SApple OSS Distributions 44*43a90889SApple OSS Distributions #define PGO_ALL_FLAGS (PGO_HIB | PGO_WAIT_FOR_UNLOAD | PGO_METADATA | PGO_RESET_ALL) 45*43a90889SApple OSS Distributions 46*43a90889SApple OSS Distributions /** 47*43a90889SApple OSS Distributions * This is a serialization format for metadata related to a profile data buffer. 48*43a90889SApple OSS Distributions * 49*43a90889SApple OSS Distributions * If metadata is present, this footer will appear at the end of the file, so 50*43a90889SApple OSS Distributions * the last four bytes of the file will be the ASCII string "meta". 51*43a90889SApple OSS Distributions * 52*43a90889SApple OSS Distributions * The metadata is stored in a environment-string style buffer. The buffer 53*43a90889SApple OSS Distributions * consists of key-value pairs, which are delimited by null bytes. Each 54*43a90889SApple OSS Distributions * key-value pair is a string of the form "FOO=bar". Everything before the 55*43a90889SApple OSS Distributions * first equal sign is the key, everything after is the value. 56*43a90889SApple OSS Distributions * 57*43a90889SApple OSS Distributions * All members are in network byte order. 58*43a90889SApple OSS Distributions */ 59*43a90889SApple OSS Distributions struct pgo_metadata_footer { 60*43a90889SApple OSS Distributions /** 61*43a90889SApple OSS Distributions * number of pairs. 62*43a90889SApple OSS Distributions * 63*43a90889SApple OSS Distributions * This should be htonl(n), where n is the number of key-value pairs in the 64*43a90889SApple OSS Distributions * metadata buffer 65*43a90889SApple OSS Distributions */ 66*43a90889SApple OSS Distributions uint32_t number_of_pairs; 67*43a90889SApple OSS Distributions 68*43a90889SApple OSS Distributions /** 69*43a90889SApple OSS Distributions * pointer to the metadata buffer 70*43a90889SApple OSS Distributions * 71*43a90889SApple OSS Distributions * This should be htonl(offset), where offset is the backwards offset from 72*43a90889SApple OSS Distributions * the end of the file to the metadata buffer. 73*43a90889SApple OSS Distributions */ 74*43a90889SApple OSS Distributions uint32_t offset_to_pairs; 75*43a90889SApple OSS Distributions 76*43a90889SApple OSS Distributions /** 77*43a90889SApple OSS Distributions * magic number 78*43a90889SApple OSS Distributions * 79*43a90889SApple OSS Distributions * This should be htonl(0x6d657461); 80*43a90889SApple OSS Distributions */ 81*43a90889SApple OSS Distributions uint32_t magic; 82*43a90889SApple OSS Distributions }; 83*43a90889SApple OSS Distributions 84*43a90889SApple OSS Distributions #ifndef KERNEL 85*43a90889SApple OSS Distributions 86*43a90889SApple OSS Distributions ssize_t grab_pgo_data( 87*43a90889SApple OSS Distributions uuid_t *uuid, 88*43a90889SApple OSS Distributions int flags, 89*43a90889SApple OSS Distributions unsigned char *buffer, 90*43a90889SApple OSS Distributions ssize_t size); 91*43a90889SApple OSS Distributions 92*43a90889SApple OSS Distributions #endif /* !defined(KERNEL) */ 93*43a90889SApple OSS Distributions 94*43a90889SApple OSS Distributions #ifdef XNU_KERNEL_PRIVATE 95*43a90889SApple OSS Distributions kern_return_t do_pgo_reset_counters(void); 96*43a90889SApple OSS Distributions #endif /* defined(XNU_KERNEL_PRIVATE) */ 97*43a90889SApple OSS Distributions 98*43a90889SApple OSS Distributions #endif /* !defined(XNU_KERNEL_PRIVATE) */ 99