|
| 1 | +// Copyright 2025 Google LLC |
| 2 | +// |
| 3 | +// This source code is licensed under the BSD-style license found in the |
| 4 | +// LICENSE file in the root directory of this source tree. |
| 5 | + |
| 6 | +#include "src/operators/fingerprint_cache.h" |
| 7 | + |
| 8 | +#include <assert.h> |
| 9 | +#include <stddef.h> |
| 10 | +#include <stdint.h> |
| 11 | +#include <stdlib.h> |
| 12 | + |
| 13 | +#include "include/experimental.h" |
| 14 | +#include "include/xnnpack.h" |
| 15 | +#include "src/operators/fingerprint_id.h" |
| 16 | +#include "src/xnnpack/cache.h" |
| 17 | +#include "src/xnnpack/init-once.h" |
| 18 | +#include "src/xnnpack/mutex.h" |
| 19 | +#include "src/xnnpack/operator-type.h" |
| 20 | + |
| 21 | +#define XNN_FINGERPRINT_MAX_COUNT 256 |
| 22 | +static struct xnn_fingerprint fingerprint_vector[XNN_FINGERPRINT_MAX_COUNT]; |
| 23 | +static uint32_t fingerprint_vector_size = 0; |
| 24 | + |
| 25 | +static struct xnn_mutex mutex; |
| 26 | +XNN_INIT_ONCE_GUARD(mutex); |
| 27 | + |
| 28 | +static void init_mutex_config() { xnn_mutex_init(&mutex); } |
| 29 | + |
| 30 | +const struct xnn_fingerprint* xnn_get_fingerprint( |
| 31 | + const enum xnn_fingerprint_id id) { |
| 32 | + XNN_INIT_ONCE(mutex); |
| 33 | + uint32_t i = 0; |
| 34 | + xnn_mutex_lock(&mutex); |
| 35 | + for (; i < fingerprint_vector_size; ++i) { |
| 36 | + if (fingerprint_vector[i].id == id) { |
| 37 | + break; |
| 38 | + } |
| 39 | + } |
| 40 | + xnn_mutex_unlock(&mutex); |
| 41 | + return i < fingerprint_vector_size ? fingerprint_vector + i : NULL; |
| 42 | +} |
| 43 | + |
| 44 | +void xnn_set_fingerprint(const struct xnn_fingerprint fingerprint) { |
| 45 | + XNN_INIT_ONCE(mutex); |
| 46 | + uint32_t i = 0; |
| 47 | + xnn_mutex_lock(&mutex); |
| 48 | + for (; i < fingerprint_vector_size; ++i) { |
| 49 | + if (fingerprint_vector[i].id == fingerprint.id) { |
| 50 | + fingerprint_vector[i] = fingerprint; |
| 51 | + } |
| 52 | + } |
| 53 | + xnn_mutex_unlock(&mutex); |
| 54 | + if (i < fingerprint_vector_size) { |
| 55 | + return; |
| 56 | + } |
| 57 | + assert(fingerprint_vector_size < XNN_FINGERPRINT_MAX_COUNT); |
| 58 | + fingerprint_vector[fingerprint_vector_size++] = fingerprint; |
| 59 | +} |
| 60 | + |
| 61 | +void xnn_clear_fingerprints() { |
| 62 | + XNN_INIT_ONCE(mutex); |
| 63 | + xnn_mutex_lock(&mutex); |
| 64 | + fingerprint_vector_size = 0; |
| 65 | + xnn_mutex_unlock(&mutex); |
| 66 | +} |
| 67 | + |
| 68 | +#define XNNPACK_OP_TYPE_TO_FINGERPRINT(name) \ |
| 69 | + case xnn_operator_type_##name: \ |
| 70 | + return xnn_fingerprint_id_##name; |
| 71 | + |
| 72 | +enum xnn_fingerprint_id fingerprint_id_from_operator_type( |
| 73 | + const enum xnn_operator_type operator_type) { |
| 74 | + // LINT.IfChange(operator_to_fingerprint_id) |
| 75 | + switch (operator_type) { |
| 76 | + default: |
| 77 | + return xnn_fingerprint_id_unknown; |
| 78 | + } |
| 79 | + // LINT.ThenChange(fingerprint_id.h:fingerprint_id) |
| 80 | +} |
| 81 | + |
| 82 | +#undef XNNPACK_OP_TYPE_TO_FINGERPRINT |
| 83 | + |
| 84 | +// The context for an XNNPack weight cache provider that we pass to operator |
| 85 | +// `create` functions when we want to fingerprint them. |
| 86 | +struct fingerprint_cache_context { |
| 87 | + void* buffer; |
| 88 | + size_t bytes; |
| 89 | + uint32_t hash; |
| 90 | +}; |
| 91 | + |
| 92 | +static size_t fingerprint_cache_look_up( |
| 93 | + void* context, const struct xnn_weights_cache_look_up_key* cache_key) { |
| 94 | + return XNN_CACHE_NOT_FOUND; |
| 95 | +} |
| 96 | + |
| 97 | +static void* fingerprint_cache_reserve_space(void* const context, size_t n) { |
| 98 | + struct fingerprint_cache_context* const ctx = context; |
| 99 | + void* buffer = realloc(ctx->buffer, n); |
| 100 | + if (!buffer) { |
| 101 | + return NULL; |
| 102 | + } |
| 103 | + ctx->buffer = buffer; |
| 104 | + ctx->bytes = n; |
| 105 | + return ctx->buffer; |
| 106 | +} |
| 107 | + |
| 108 | +static size_t fingerprint_cache_look_up_or_insert( |
| 109 | + void* context, const struct xnn_weights_cache_look_up_key* cache_key, |
| 110 | + void* ptr, size_t size) { |
| 111 | + assert(context); |
| 112 | + struct fingerprint_cache_context* const ctx = context; |
| 113 | + ctx->hash = murmur_hash3(ptr, size, /*seed=*/ctx->hash); |
| 114 | + return 0; |
| 115 | +} |
| 116 | + |
| 117 | +static bool fingerprint_cache_is_finalized(void* context) { return false; } |
| 118 | + |
| 119 | +static void* fingerprint_cache_offset_to_addr(void* context, size_t offset) { |
| 120 | + assert(context); |
| 121 | + struct fingerprint_cache_context* const ctx = context; |
| 122 | + return ctx->buffer; |
| 123 | +} |
| 124 | + |
| 125 | +static enum xnn_status fingerprint_cache_delete_cache(void* context) { |
| 126 | + struct fingerprint_cache_context* const ctx = context; |
| 127 | + if (ctx) { |
| 128 | + if (ctx->buffer) { |
| 129 | + free(ctx->buffer); |
| 130 | + } |
| 131 | + *ctx = (struct fingerprint_cache_context){0}; |
| 132 | + } |
| 133 | + return xnn_status_success; |
| 134 | +} |
| 135 | + |
| 136 | +struct fingerprint_context create_fingerprint_context_for_op( |
| 137 | + const enum xnn_operator_type operator_type) { |
| 138 | + return create_fingerprint_context( |
| 139 | + fingerprint_id_from_operator_type(operator_type)); |
| 140 | +} |
| 141 | + |
| 142 | +struct fingerprint_context create_fingerprint_context( |
| 143 | + const enum xnn_fingerprint_id fingerprint_id) { |
| 144 | + struct fingerprint_context context = { |
| 145 | + .status = xnn_status_uninitialized, |
| 146 | + .fingerprint_id = fingerprint_id, |
| 147 | + .cache = |
| 148 | + (struct xnn_weights_cache_provider){ |
| 149 | + .context = NULL, |
| 150 | + .look_up = fingerprint_cache_look_up, |
| 151 | + .reserve_space = fingerprint_cache_reserve_space, |
| 152 | + .look_up_or_insert = fingerprint_cache_look_up_or_insert, |
| 153 | + .is_finalized = fingerprint_cache_is_finalized, |
| 154 | + .offset_to_addr = fingerprint_cache_offset_to_addr, |
| 155 | + .delete_cache = fingerprint_cache_delete_cache}, |
| 156 | + .op = NULL, |
| 157 | + }; |
| 158 | + if (context.fingerprint_id == xnn_fingerprint_id_unknown) { |
| 159 | + context.status = xnn_status_unsupported_parameter; |
| 160 | + } else if (xnn_get_fingerprint(context.fingerprint_id)) { |
| 161 | + context.status = xnn_status_success; |
| 162 | + } else { |
| 163 | + // Do this after the checks to avoid a memory allocation when unnecessary. |
| 164 | + context.cache.context = calloc(1, sizeof(struct fingerprint_cache_context)); |
| 165 | + } |
| 166 | + return context; |
| 167 | +} |
| 168 | + |
| 169 | +static void free_fingerprint_cache_provider( |
| 170 | + struct xnn_weights_cache_provider* const provider) { |
| 171 | + if (provider) { |
| 172 | + provider->delete_cache(provider->context); |
| 173 | + if (provider->context) { |
| 174 | + free(provider->context); |
| 175 | + } |
| 176 | + } |
| 177 | +} |
| 178 | + |
| 179 | +void finalize_fingerprint_context(struct fingerprint_context* const context) { |
| 180 | + assert(context); |
| 181 | + if (context->status == xnn_status_uninitialized) { |
| 182 | + xnn_set_fingerprint((struct xnn_fingerprint){ |
| 183 | + .id = context->fingerprint_id, |
| 184 | + .value = fingerprint_cache_get_fingerprint(&context->cache)}); |
| 185 | + } |
| 186 | + free_fingerprint_cache_provider(&context->cache); |
| 187 | + if (context->op) { |
| 188 | + xnn_delete_operator(context->op); |
| 189 | + } |
| 190 | +} |
| 191 | + |
| 192 | +uint32_t fingerprint_cache_get_fingerprint( |
| 193 | + const struct xnn_weights_cache_provider* const provider) { |
| 194 | + assert(provider); |
| 195 | + assert(provider->context); |
| 196 | + return ((struct fingerprint_cache_context*)provider->context)->hash; |
| 197 | +} |
0 commit comments