1*f6217f89SApple OSS Distributions // 2*f6217f89SApple OSS Distributions // Index.h 3*f6217f89SApple OSS Distributions // CoreEntitlements 4*f6217f89SApple OSS Distributions // 5*f6217f89SApple OSS Distributions // 6*f6217f89SApple OSS Distributions 7*f6217f89SApple OSS Distributions #ifndef CORE_ENTITLEMENTS_INDEX_H 8*f6217f89SApple OSS Distributions #define CORE_ENTITLEMENTS_INDEX_H 9*f6217f89SApple OSS Distributions 10*f6217f89SApple OSS Distributions #ifndef _CE_INDIRECT 11*f6217f89SApple OSS Distributions #error "Please include <CoreEntitlements/CoreEntitlements.h> instead of this file" 12*f6217f89SApple OSS Distributions #endif 13*f6217f89SApple OSS Distributions 14*f6217f89SApple OSS Distributions #include <CoreEntitlements/Result.h> 15*f6217f89SApple OSS Distributions 16*f6217f89SApple OSS Distributions /* 17*f6217f89SApple OSS Distributions The kernel always supports acceleration 18*f6217f89SApple OSS Distributions */ 19*f6217f89SApple OSS Distributions #define CE_ACCELERATION_SUPPORTED 1 20*f6217f89SApple OSS Distributions 21*f6217f89SApple OSS Distributions 22*f6217f89SApple OSS Distributions /*! 23*f6217f89SApple OSS Distributions @typedef CEAccelerationElement_t 24*f6217f89SApple OSS Distributions 25*f6217f89SApple OSS Distributions A single element of the acceleration structure, the contents of this struct are an implementation detail 26*f6217f89SApple OSS Distributions and are subject to change. 27*f6217f89SApple OSS Distributions */ 28*f6217f89SApple OSS Distributions typedef struct CEAccelerationElement { 29*f6217f89SApple OSS Distributions uint32_t key_offset; 30*f6217f89SApple OSS Distributions uint32_t key_length; 31*f6217f89SApple OSS Distributions } CEAccelerationElement_t; 32*f6217f89SApple OSS Distributions 33*f6217f89SApple OSS Distributions /*! 34*f6217f89SApple OSS Distributions @struct CEAccelerationContext 35*f6217f89SApple OSS Distributions 36*f6217f89SApple OSS Distributions Contains data required to accelerate queries, the contents of this struct are an implementation detail 37*f6217f89SApple OSS Distributions and are subject to change. 38*f6217f89SApple OSS Distributions */ 39*f6217f89SApple OSS Distributions struct CEAccelerationContext { 40*f6217f89SApple OSS Distributions CEAccelerationElement_t * __counted_by(index_count) index; 41*f6217f89SApple OSS Distributions size_t index_count; 42*f6217f89SApple OSS Distributions }; 43*f6217f89SApple OSS Distributions 44*f6217f89SApple OSS Distributions /*! 45*f6217f89SApple OSS Distributions @function CEIndexSizeForContext 46*f6217f89SApple OSS Distributions Computes an upper bound of memory needed to construct an acceleration index for a particular query context. 47*f6217f89SApple OSS Distributions 48*f6217f89SApple OSS Distributions @param context 49*f6217f89SApple OSS Distributions The context for which the calculation should be made 50*f6217f89SApple OSS Distributions 51*f6217f89SApple OSS Distributions @param size 52*f6217f89SApple OSS Distributions Contains the required size, in bytes. 53*f6217f89SApple OSS Distributions 54*f6217f89SApple OSS Distributions @returns an error if the context cannot be accelerated, success otherwise 55*f6217f89SApple OSS Distributions */ 56*f6217f89SApple OSS Distributions CEError_t CEIndexSizeForContext(CEQueryContext_t context, size_t* size); 57*f6217f89SApple OSS Distributions 58*f6217f89SApple OSS Distributions /*! 59*f6217f89SApple OSS Distributions @function CEBuildIndexForContext 60*f6217f89SApple OSS Distributions Computes and stores and acceleration index into the passed in context. 61*f6217f89SApple OSS Distributions Building an index requires runtime support. 62*f6217f89SApple OSS Distributions 63*f6217f89SApple OSS Distributions @param context 64*f6217f89SApple OSS Distributions The context for which the index should be computed. 65*f6217f89SApple OSS Distributions */ 66*f6217f89SApple OSS Distributions CEError_t CEBuildIndexForContext(CEQueryContext_t context); 67*f6217f89SApple OSS Distributions 68*f6217f89SApple OSS Distributions /*! 69*f6217f89SApple OSS Distributions @function CEFreeIndexForContext 70*f6217f89SApple OSS Distributions Frees an index associated with a query context 71*f6217f89SApple OSS Distributions 72*f6217f89SApple OSS Distributions @param context 73*f6217f89SApple OSS Distributions The context for which the index should be freed. 74*f6217f89SApple OSS Distributions */ 75*f6217f89SApple OSS Distributions CEError_t CEFreeIndexForContext(CEQueryContext_t context); 76*f6217f89SApple OSS Distributions 77*f6217f89SApple OSS Distributions /*! 78*f6217f89SApple OSS Distributions @function CEContextIsAccelerated 79*f6217f89SApple OSS Distributions Checks if the passed in context supports query acceleration 80*f6217f89SApple OSS Distributions 81*f6217f89SApple OSS Distributions @param context 82*f6217f89SApple OSS Distributions The context to check. 83*f6217f89SApple OSS Distributions */ 84*f6217f89SApple OSS Distributions bool CEContextIsAccelerated(CEQueryContext_t context); 85*f6217f89SApple OSS Distributions 86*f6217f89SApple OSS Distributions #endif /* CORE_ENTITLEMENTS_INDEX_H */ 87