This file defines the GGMA context management API. More...

#include "ggma_types.h"

Typedefs
typedef struct ggma_context	ggma_context
	Opaque handle to a GGMA inference context.

Functions
GGMA_STATUS	ggma_create_context (ggma_context *context, const char package_path)
	Creates a context from a package path.

GGMA_STATUS	ggma_free_context (ggma_context *context)
	Closes a GGMA context and releases its resources.

Detailed Description

This file defines the GGMA context management API.

Definition in file ggma_context.h.

Typedef Documentation

◆ ggma_context

typedef struct ggma_context ggma_context

Opaque handle to a GGMA inference context.

A GGMA context represents the environment for inference. It includes model, computation graph, KV caches, and other resources for token generation.

Definition at line 36 of file ggma_context.h.

Function Documentation

◆ ggma_create_context()

GGMA_STATUS ggma_create_context	(	ggma_context **	context,
		const char *	package_path
	)

Creates a context from a package path.

This function initializes a context for inference from the specified package path. Once the context is no longer needed, it must be destroyed by calling ggma_free_context.

Parameters

[out]	context	A pointer to the variable that will receive the new context handle.
[in]	package_path	The path to the GGMA package directory.

Returns: GGMA_STATUS_NO_ERROR on success, or an appropriate error code on failure.

Definition at line 23 of file ggma_context.cc.

{
  if (context == nullptr)
    return GGMA_STATUS_UNEXPECTED_NULL;
  try
  {
    *context = reinterpret_cast<ggma_context *>(new ggma::Context(package_path));
  }
  catch (const std::bad_alloc &e)
  {
    std::cerr << "Error during context creation" << std::endl;
    *context = nullptr;
    return GGMA_STATUS_OUT_OF_MEMORY;
  }
  catch (const std::exception &e)
  {
    std::cerr << "Error during context initialization : " << e.what() << std::endl;
    *context = nullptr;
    return GGMA_STATUS_ERROR;
  }
  return GGMA_STATUS_NO_ERROR;
}

References GGMA_STATUS_ERROR, GGMA_STATUS_NO_ERROR, GGMA_STATUS_OUT_OF_MEMORY, and GGMA_STATUS_UNEXPECTED_NULL.

◆ ggma_free_context()

GGMA_STATUS ggma_free_context ( ggma_context * context )

Closes a GGMA context and releases its resources.

This function deallocates all resources associated with the context, including the GGMA package it was created with. After this function returns, the context handle is invalid and must not be used.

Parameters

[in] context The context to close.

Returns: GGMA_STATUS_NO_ERROR on success, or an appropriate error code on failure.

Definition at line 46 of file ggma_context.cc.

{
  delete reinterpret_cast<ggma::Context *>(context);
  return GGMA_STATUS_NO_ERROR;
}

References GGMA_STATUS_NO_ERROR.