4 Locality Group APIs

This chapter describes the APIs that the applications use to interact with the locality groups. This chapter contains the following topics:

• Locality Groups Overview describes the locality group abstraction.

• Verifying the Locality Group Interface Version describes the functions that give information about the interface.

• Initializing the Locality Group Interface describes the function calls that initialize and shut down the portion of the interface that is used to traverse the locality group hierarchy and to discover the contents of a locality group.

• Locality Group Hierarchy describes the function calls that navigate the locality group hierarchy and functions that get characteristics of the locality group hierarchy.

• Locality Group Contents describes the function calls that retrieve information about the contents of a locality group.

• Locality Group Characteristics describes the function calls that retrieve information about the characteristics of a locality group.

• Locality Groups and Thread and Memory Placement describes how to affect the locality group placement of a thread and its memory.

• Using the Locality Group API contains code that performs example tasks by using the APIs that are described in this chapter.