runtime/src/iree/hal/drivers/null/executable_cache.c

// Copyright 2024 The IREE Authors
//
// Licensed under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

#include "iree/hal/drivers/null/executable_cache.h"

#include "iree/hal/drivers/null/executable.h"

typedef struct iree_hal_null_executable_cache_t {
  iree_hal_resource_t resource;
  iree_allocator_t host_allocator;
} iree_hal_null_executable_cache_t;

static const iree_hal_executable_cache_vtable_t
    iree_hal_null_executable_cache_vtable;

static iree_hal_null_executable_cache_t* iree_hal_null_executable_cache_cast(
    iree_hal_executable_cache_t* base_value) {
  IREE_HAL_ASSERT_TYPE(base_value, &iree_hal_null_executable_cache_vtable);
  return (iree_hal_null_executable_cache_t*)base_value;
}

iree_status_t iree_hal_null_executable_cache_create(
    iree_string_view_t identifier, iree_allocator_t host_allocator,
    iree_hal_executable_cache_t** out_executable_cache) {
  IREE_ASSERT_ARGUMENT(out_executable_cache);
  *out_executable_cache = NULL;
  IREE_TRACE_ZONE_BEGIN(z0);

  iree_hal_null_executable_cache_t* executable_cache = NULL;
  IREE_RETURN_AND_END_ZONE_IF_ERROR(
      z0, iree_allocator_malloc(host_allocator, sizeof(*executable_cache),
                                (void**)&executable_cache));
  iree_hal_resource_initialize(&iree_hal_null_executable_cache_vtable,
                               &executable_cache->resource);
  executable_cache->host_allocator = host_allocator;

  // TODO(null): this default implementation is a no-op; if the implementation
  // supports caching or has prohibitively expensive executable load times it is
  // worth implementing this. Here any shared resources (compiler/JIT handles,
  // device symbols, etc) can be retained and passed to all executables created
  // from the cache.
  iree_status_t status = iree_ok_status();

  if (iree_status_is_ok(status)) {
    *out_executable_cache = (iree_hal_executable_cache_t*)executable_cache;
  } else {
    iree_hal_executable_cache_release(
        (iree_hal_executable_cache_t*)executable_cache);
  }
  IREE_TRACE_ZONE_END(z0);
  return status;
}

static void iree_hal_null_executable_cache_destroy(
    iree_hal_executable_cache_t* base_executable_cache) {
  iree_hal_null_executable_cache_t* executable_cache =
      iree_hal_null_executable_cache_cast(base_executable_cache);
  iree_allocator_t host_allocator = executable_cache->host_allocator;
  IREE_TRACE_ZONE_BEGIN(z0);

  iree_allocator_free(host_allocator, executable_cache);

  IREE_TRACE_ZONE_END(z0);
}

static bool iree_hal_null_executable_cache_can_prepare_format(
    iree_hal_executable_cache_t* base_executable_cache,
    iree_hal_executable_caching_mode_t caching_mode,
    iree_string_view_t executable_format) {
  // TODO(null): this query may be used with multiple executable_format args in
  // cases where support is conditional (versions of a format) or multiple
  // formats are handled. This matches the `IREE::HAL::ExecutableTargetAttr`
  // format field as set in the compiler.
  return iree_string_view_equal(executable_format,
                                iree_make_cstring_view("{null-executable}"));
}

static iree_status_t iree_hal_null_executable_cache_prepare_executable(
    iree_hal_executable_cache_t* base_executable_cache,
    const iree_hal_executable_params_t* executable_params,
    iree_hal_executable_t** out_executable) {
  iree_hal_null_executable_cache_t* executable_cache =
      iree_hal_null_executable_cache_cast(base_executable_cache);

  // TODO(null): add any extra args required. Usually this will be device
  // symbols or handles that can be retained by the cache and passed to all
  // executables created from it.

  return iree_hal_null_executable_create(
      executable_params, executable_cache->host_allocator, out_executable);
}

static const iree_hal_executable_cache_vtable_t
    iree_hal_null_executable_cache_vtable = {
        .destroy = iree_hal_null_executable_cache_destroy,
        .can_prepare_format = iree_hal_null_executable_cache_can_prepare_format,
        .prepare_executable = iree_hal_null_executable_cache_prepare_executable,
};