GGUFData Struct Reference

Complete representation of a GGUF file's contents. More...

#include <gguf_structs.h>

Collaboration diagram for GGUFData:

Public Member Functions
	GGUFData ()
	~GGUFData ()
	GGUFData (const GGUFData &)=delete
GGUFData &	operator= (const GGUFData &)=delete
	GGUFData (GGUFData &&other) noexcept
GGUFData &	operator= (GGUFData &&other) noexcept

Public Attributes
GGUFHeader	header
std::map< std::string, GGUFMetadataValue >	metadata
std::vector< GGUFTensorInfo >	tensor_infos
std::map< std::string, GGUFTensorInfo >	tensor_infos_map
std::vector< std::string >	tokenizer_tokens
std::vector< float >	tokenizer_scores
std::vector< uint32_t >	tokenizer_token_types
std::vector< std::string >	tokenizer_merges
int	file_descriptor = -1
void *	mapped_tensor_data = nullptr
size_t	mapped_tensor_data_size = 0
uint64_t	data_alignment = 32
size_t	offset_diff_for_mmap = 0
std::vector< uint8_t >	tensor_data

Static Public Attributes
static const void *	MMapFailure = MAP_FAILED

Detailed Description

Complete representation of a GGUF file's contents.

This structure contains all the data from a GGUF file, including header information, metadata, tensor information, and the actual tensor data. It also includes tokenizer-specific data that may be present in the file.

Definition at line 80 of file gguf_structs.h.

Constructor & Destructor Documentation

GGUFData() [1/3]

GGUFData::GGUFData ( )

inline

Definition at line 111 of file gguf_structs.h.

: file_descriptor(-1), mapped_tensor_data(nullptr), mapped_tensor_data_size(0), data_alignment(32), offset_diff_for_mmap(0) {}

~GGUFData()

GGUFData::~GGUFData ( )

inline

Definition at line 117 of file gguf_structs.h.

              {
#ifndef _WIN32
    if (mapped_tensor_data != nullptr && mapped_tensor_data != MMapFailure) { // MMapFailure will expand to MAP_FAILED
      munmap(mapped_tensor_data, mapped_tensor_data_size);
    }
    if (file_descriptor != -1) {
      close(file_descriptor);
    }
    file_descriptor = -1; 
#else // _WIN32
    if (mapped_tensor_data != nullptr) { // On Windows, MapViewOfFile returns NULL on failure
      UnmapViewOfFile(mapped_tensor_data);
    }
    if (h_map_file != NULL) {
      CloseHandle(h_map_file);
    }
    if (h_file != INVALID_HANDLE_VALUE) {
      CloseHandle(h_file);
    }
    h_file = INVALID_HANDLE_VALUE;
    h_map_file = NULL;
#endif
    mapped_tensor_data = nullptr; // Common for both
    mapped_tensor_data_size = 0;  // Common for both
    offset_diff_for_mmap = 0;     // Common for both
  }

References file_descriptor, j, mapped_tensor_data, mapped_tensor_data_size, MMapFailure, and offset_diff_for_mmap.

GGUFData() [2/3]

GGUFData::GGUFData ( const GGUFData &  )

delete

GGUFData() [3/3]

GGUFData::GGUFData ( GGUFData &&  other )

inlinenoexcept

Definition at line 149 of file gguf_structs.h.

    : header(other.header)
    , metadata(std::move(other.metadata))
    , tensor_infos(std::move(other.tensor_infos))
    , tensor_infos_map(std::move(other.tensor_infos_map))
    , tokenizer_tokens(std::move(other.tokenizer_tokens))
    , tokenizer_scores(std::move(other.tokenizer_scores))
    , tokenizer_token_types(std::move(other.tokenizer_token_types))
    , tokenizer_merges(std::move(other.tokenizer_merges))
    // Platform-specific handles
#ifndef _WIN32
    , file_descriptor(other.file_descriptor)
#else
    , h_file(other.h_file)
    , h_map_file(other.h_map_file)
#endif
    , mapped_tensor_data(other.mapped_tensor_data)
    , mapped_tensor_data_size(other.mapped_tensor_data_size)
    , data_alignment(other.data_alignment)
    , offset_diff_for_mmap(other.offset_diff_for_mmap)
    , tensor_data(std::move(other.tensor_data))
  {
    // Leave other in a valid but safe state (resources transferred)
#ifndef _WIN32
    other.file_descriptor = -1;
#else
    other.h_file = INVALID_HANDLE_VALUE;
    other.h_map_file = NULL;
#endif
    other.mapped_tensor_data = nullptr;
    other.mapped_tensor_data_size = 0;
    other.offset_diff_for_mmap = 0;
  }

References j.

Member Function Documentation

operator=() [1/2]

GGUFData & GGUFData::operator= ( const GGUFData &  )

delete

operator=() [2/2]

GGUFData & GGUFData::operator= ( GGUFData &&  other )

inlinenoexcept

Definition at line 183 of file gguf_structs.h.

                                                 {
    if (this != &other) {
      // Clean up existing resources first (using this object's current platform state)
#ifndef _WIN32
      if (mapped_tensor_data != nullptr && mapped_tensor_data != MMapFailure) { // MMapFailure will expand to MAP_FAILED
        munmap(mapped_tensor_data, mapped_tensor_data_size);
      }
      if (file_descriptor != -1) {
        close(file_descriptor);
      }
#else // _WIN32
      if (mapped_tensor_data != nullptr) {
        UnmapViewOfFile(mapped_tensor_data);
      }
      if (h_map_file != NULL) {
        CloseHandle(h_map_file);
      }
      if (h_file != INVALID_HANDLE_VALUE) {
        CloseHandle(h_file);
      }
#endif
 
      // Move data members
      header = other.header;
      metadata = std::move(other.metadata);
      tensor_infos = std::move(other.tensor_infos);
      tensor_infos_map = std::move(other.tensor_infos_map);
      tokenizer_tokens = std::move(other.tokenizer_tokens);
      tokenizer_scores = std::move(other.tokenizer_scores);
      tokenizer_token_types = std::move(other.tokenizer_token_types);
      tokenizer_merges = std::move(other.tokenizer_merges);
      
      // Move platform-specific handles and mmap data
#ifndef _WIN32
      file_descriptor = other.file_descriptor;
#else
      h_file = other.h_file;
      h_map_file = other.h_map_file;
#endif
      mapped_tensor_data = other.mapped_tensor_data;
      mapped_tensor_data_size = other.mapped_tensor_data_size;
      data_alignment = other.data_alignment;
      offset_diff_for_mmap = other.offset_diff_for_mmap;
      tensor_data = std::move(other.tensor_data);
 
      // Leave other in a valid but safe state
#ifndef _WIN32
      other.file_descriptor = -1;
#else
      other.h_file = INVALID_HANDLE_VALUE;
      other.h_map_file = NULL;
#endif
      other.mapped_tensor_data = nullptr;
      other.mapped_tensor_data_size = 0;
      other.offset_diff_for_mmap = 0;
    }
    return *this;
  }

References data_alignment, file_descriptor, header, j, mapped_tensor_data, mapped_tensor_data_size, metadata, MMapFailure, offset_diff_for_mmap, tensor_data, tensor_infos, tensor_infos_map, tokenizer_merges, tokenizer_scores, tokenizer_token_types, and tokenizer_tokens.

Member Data Documentation

data_alignment

uint64_t GGUFData::data_alignment = 32

Alignment requirement for tensor data

Definition at line 103 of file gguf_structs.h.

Referenced by operator=().

file_descriptor

int GGUFData::file_descriptor = -1

File descriptor for POSIX mmap

Definition at line 94 of file gguf_structs.h.

Referenced by operator=(), and ~GGUFData().

header

GGUFHeader GGUFData::header

File header

Definition at line 81 of file gguf_structs.h.

Referenced by operator=().

mapped_tensor_data

void* GGUFData::mapped_tensor_data = nullptr

Pointer to memory-mapped tensor data block

Definition at line 101 of file gguf_structs.h.

Referenced by operator=(), and ~GGUFData().

mapped_tensor_data_size

size_t GGUFData::mapped_tensor_data_size = 0

Size of the mapped tensor data block in bytes

Definition at line 102 of file gguf_structs.h.

Referenced by operator=(), and ~GGUFData().

metadata

std::map<std::string, GGUFMetadataValue> GGUFData::metadata

Metadata key-value pairs

Definition at line 82 of file gguf_structs.h.

Referenced by operator=().

MMapFailure

const void * GGUFData::MMapFailure = MAP_FAILED

static

POSIX mmap failure indicator - DECLARED here, DEFINED in .cpp

Definition at line 95 of file gguf_structs.h.

Referenced by load_gguf_meta(), operator=(), and ~GGUFData().

offset_diff_for_mmap

size_t GGUFData::offset_diff_for_mmap = 0

Difference between aligned mmap offset and actual data start

Definition at line 104 of file gguf_structs.h.

Referenced by operator=(), and ~GGUFData().

tensor_data

std::vector<uint8_t> GGUFData::tensor_data

Tensor data loaded into memory (non-mmap mode)

Definition at line 107 of file gguf_structs.h.

Referenced by operator=().

tensor_infos

std::vector<GGUFTensorInfo> GGUFData::tensor_infos

List of tensor information

Definition at line 83 of file gguf_structs.h.

Referenced by operator=().

tensor_infos_map

std::map<std::string, GGUFTensorInfo> GGUFData::tensor_infos_map

Map of tensor names to information

Definition at line 84 of file gguf_structs.h.

Referenced by ember_ir::build_ir_from_gguf(), and operator=().

tokenizer_merges

std::vector<std::string> GGUFData::tokenizer_merges

BPE merge rules

Definition at line 90 of file gguf_structs.h.

Referenced by operator=().

tokenizer_scores

std::vector<float> GGUFData::tokenizer_scores

Token scores for BPE

Definition at line 88 of file gguf_structs.h.

Referenced by operator=().

tokenizer_token_types

std::vector<uint32_t> GGUFData::tokenizer_token_types

Token type information

Definition at line 89 of file gguf_structs.h.

Referenced by operator=().

tokenizer_tokens

std::vector<std::string> GGUFData::tokenizer_tokens

Vocabulary tokens

Definition at line 87 of file gguf_structs.h.

Referenced by ember_ir::build_ir_from_gguf(), tinyllama::TinyLlamaSession::gguf_tokens(), and operator=().

---

The documentation for this struct was generated from the following files:

• gguf_structs.h
• gguf_parser.cpp