//  Copyright (c) Meta Platforms, Inc. and affiliates.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//
#pragma once
// This exposes the raw data for constants that are
// compiled into the final .so. When a ModelContainer is created,
// it copies this data into some owned GPU memory.

#include <array>
#include <cstdint>
#include <utility>

namespace ait {

struct ConstantInfo {
  // Unowned pointer w/ static lifetime
  const char* name;
  // Offset into _binary_constants_bin_start
  size_t data_offset;
  // Offset into owned GPU slab.
  size_t internal_offset;
  // How big is this tensor in bytes?
  size_t num_bytes;
};

} // namespace ait

// At codegen time, we write out a binary file called constants.bin.
// We then turn the raw binary to an object file that exposes this
// symbol and link it into the final .so.
// For information on the binary format, see `man objcopy`, under
// the "binary-architecture" flag:
// https://man7.org/linux/man-pages/man1/objcopy.1.html
// todo: use #embed in C++ 23 once available
extern const uint8_t _binary_constants_bin_start[];
extern const uint8_t _binary_constants_bin_end[];