/*
 * Copyright 2010, The Android Open Source Project
 *
 * 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.
 */

#ifndef BCC_CACHE_H
#define BCC_CACHE_H

#include <stdint.h>
#include <sys/types.h>

/* BCC Cache File Magic Word */
#define OBCC_MAGIC "\0bcc"

/* BCC Cache File Version, encoded in 4 bytes of ASCII */
#define OBCC_VERSION "001\0"

/* BCC Cache Header Structure */
struct OBCC_Header {
  /* magic and version */
  uint8_t magic[4];
  uint8_t version[4];

  /* machine-dependent integer type size */
  uint8_t endianness;
  uint8_t sizeof_off_t;
  uint8_t sizeof_size_t;
  uint8_t sizeof_ptr_t;

  /* string pool section */
  off_t str_pool_offset;
  size_t str_pool_size;

  /* dependancy table */
  off_t depend_tab_offset;
  size_t depend_tab_size;

  /* relocation table section */
  off_t reloc_tab_offset;
  size_t reloc_tab_size;

  /* export variable list section */
  off_t export_var_list_offset;
  size_t export_var_list_size;

  /* export function list section */
  off_t export_func_list_offset;
  size_t export_func_list_size;

  /* pragma list section */
  off_t pragma_list_offset;
  size_t pragma_list_size;

  /* function table */
  off_t func_table_offset;
  size_t func_table_size;

  /* function table */
  off_t object_slot_list_offset;
  size_t object_slot_list_size;

  /* context section */
  char *context_cached_addr;
  uint32_t context_parity_checksum;

  /* dirty hack for libRS */
  /* TODO: This should be removed in the future */
  uint32_t libRS_threadable;
};

struct OBCC_String {
  size_t length; /* String length, without ending '\0' */
  off_t offset; /* Note: Offset related to string_pool_offset. */
};

struct OBCC_StringPool {
  size_t count;
  struct OBCC_String list[];
};

enum OBCC_ResourceType {
  BCC_APK_RESOURCE = 0,
  BCC_FILE_RESOURCE = 1,
};

struct OBCC_Dependency {
  size_t res_name_strp_index;
  uint32_t res_type; /* BCC_APK_RESOURCE or BCC_FILE_RESOURCE */
  unsigned char sha1[20];
};

struct OBCC_DependencyTable {
  size_t count;
  struct OBCC_Dependency table[];
};

struct OBCC_RelocationTable {
/* TODO: Implement relocation table. */
};

struct OBCC_ExportVarList {
  size_t count;
  void *cached_addr_list[];
};

struct OBCC_ExportFuncList {
  size_t count;
  void *cached_addr_list[];
};

struct OBCC_Pragma {
  size_t key_strp_index;
  size_t value_strp_index;
};

struct OBCC_PragmaList {
  size_t count;
  struct OBCC_Pragma list[];
};

struct OBCC_ObjectSlotList {
  size_t count;
  uint32_t object_slot_list[];
};

struct OBCC_FuncInfo {
  size_t name_strp_index;
  void *cached_addr;
  size_t size;
};

struct OBCC_FuncTable {
  size_t count;
  struct OBCC_FuncInfo table[];
};

struct OBCC_String_Ptr {
  size_t count;
  size_t strp_indexs[];
};


#endif /* BCC_CACHE_H */