intel/gmmlib

Purpose and consumers

GmmLib is a C/C++ graphics-memory management library, built as libigdgmm for Intel’s OpenCL Compute Runtime and VAAPI Media Driver. It supplies GPU-platform-specific resource layout, allocation metadata, cache policy, tiling/swizzle, and translation-table management; it is not a standalone application.

Build and public entry boundary

CMake is the primary build entry point; Android also has a Blueprint entry. The library’s installed/public API is separated from implementation headers.

• CMakeLists.txt

• Android.bp

• Source/GmmLib/CMakeLists.txt

• Source/GmmLib/inc/GmmLib.h

• Source/GmmLib/inc/External/Common/GmmResourceInfo.h

Linux is the currently supported runtime target, including Linux-specific resource wrappers and package metadata.

• Source/GmmLib/Linux.cmake

• Source/GmmLib/igdgmm.h.in

• Source/GmmLib/igdgmm.pc.in

Context and platform dispatch

Clients create/use a GMM client context and global information layer, which identifies platform/SKU characteristics and selects generation-specific behavior. This is the main control boundary between stable external API objects and internal hardware implementations.

• Source/GmmLib/GlobalInfo/GmmClientContext.cpp

• Source/GmmLib/GlobalInfo/GmmInfo.cpp

• Source/GmmLib/Platform/GmmPlatform.cpp

• Source/GmmLib/Platform/GmmPlatforms.h

Per-generation platform implementations cover Gen8 through Gen12 in this tree; newer Xe-family specialization is visible primarily in cache-policy and texture paths.

• Source/GmmLib/Platform/GmmGen8Platform.cpp

• Source/GmmLib/Platform/GmmGen12Platform.cpp

Resource-description and layout pipeline

The primary data flow starts with client resource descriptors/flags, then computes restrictions, size/alignment, pitch, offsets, tiling, and associated metadata. GmmResourceInfoCommon centralizes generic behavior while platform texture calculators provide hardware-specific layout rules.

• Source/GmmLib/Resource/GmmResourceInfo.cpp

• Source/GmmLib/Resource/GmmResourceInfoCommon.cpp

• Source/GmmLib/Resource/GmmRestrictions.cpp

• Source/GmmLib/Texture/GmmTexture.cpp

• Source/GmmLib/Texture/GmmTextureAlloc.cpp

Generation-specific texture calculation is the key hardware boundary for surfaces.

• Source/GmmLib/Texture/GmmGen12Texture.cpp

• Source/GmmLib/Texture/GmmXe_LPGTexture.cpp

• Source/GmmLib/inc/Internal/Common/Texture/GmmTextureCalc.h

Cache-policy resolution

Resource usage and platform capabilities are translated into cacheability/memory-object-control policy. Common policy code is extended by separate implementations for Intel generations and Xe variants, so changes here can affect all client resource programming.

• Source/GmmLib/CachePolicy/GmmCachePolicy.cpp

• Source/GmmLib/CachePolicy/GmmCachePolicyCommon.cpp

• Source/GmmLib/CachePolicy/GmmGen12CachePolicy.cpp

• Source/GmmLib/CachePolicy/GmmXe3P_XPCCachePolicy.cpp

Address translation and auxiliary metadata

Translation-table components manage GPU virtual-address mappings and auxiliary/compression-related tables. They sit downstream of resource creation and expose page-table/auxiliary-table integration points to user-mode consumers.

• Source/GmmLib/TranslationTable/GmmPageTableMgr.cpp

• Source/GmmLib/TranslationTable/GmmAuxTable.cpp

• Source/GmmLib/TranslationTable/GmmUmdTranslationTable.cpp

OS integration, diagnostics, and validation

Linux exposes a C wrapper around resource information; CPU swizzle blits support CPU-side access/layout conversion. Diagnostics include assertion tracing and bundled spdlog; neither is the stable client ABI.

• Source/GmmLib/Resource/Linux/GmmResourceInfoLinCWrapper.cpp

• Source/GmmLib/Utility/CpuSwizzleBlt/CpuSwizzleBlt.c

• Source/Common/AssertTracer/AssertTracer.cpp

• Source/GmmLib/Utility/GmmLog/GmmLog.cpp

Unit-level tests compile with the library and cover resource, cache-policy, and translation behavior using vendored GoogleTest.

• Source/GmmLib/ULT/CMakeLists.txt

• Source/GmmLib/ULT/GmmULT.cpp