HvUnmapStatsPage function

The HvUnmapStatsPage function unmaps the specified statistics page from the caller's guest physical address (GPA) space.

Syntax

C++


HV_STATUS  HvUnmapStatsPage(
  _In_  HV_STATS_OBJECT_TYPE StatsType,
  _In_  HV_STATS_OBJECT_IDENTITY ObjectIdentity
);

Parameters

StatsType [in]: An HV_STATS_OBJECT_TYPE value that specifies the statistics object type.
ObjectIdentity [in]: An HV_STATS_OBJECT_IDENTITY union that specifies the statistics object's identity. The members of this union depend on the statistics object type that the StatsType parameter specifies. Reserved members in this union must be set to zero.

Return value

HvUnmapStatsPage returns one of the following values. In addition to these values, HvUnmapStatsPage can also return one of the values that are specified in Common Hypercall Status Codes.

Return code	Description
HV_STATUS_SUCCESS	HvUnmapStatsPage successfully unmapped the specified statistics page from the caller's GPA space.
HV_STATUS_ACCESS_DENIED	One of the following conditions exists: For global statistics types, the caller is not the root partition. For local statistics types, the caller is not the parent of the specified partition. The caller's partition privilege flag AccessStats is cleared.
HV_STATUS_INVALID_PARTITION_ID	The specified partition identifier is invalid (which is used only for partition and virtual processor (VP) statistics).
HV_STATUS_INVALID_VP_INDEX	The specified VP index does not reference a virtual processor within the specified partition (which is used only for VP statistics).
HV_STATUS_INVALID_PARAMETER	One of the following conditions exists: The specified logical processor index is invalid (which is used only for logical processor statistics). Reserved fields within the ObjectIdentity parameter are not set to zero.
HV_STATUS_INVALID_PARTITION_STATE	The specified partition is not in the active state.
HV_STATUS_OPERATION_DENIED	The specified page is not initialized or mapped.

Remarks

Only the root partition can unmap global statistics pages. Local statistics pages can be unmapped only by the partition's parent. In addition, the partition must have the AccessStats privilege.

HvUnmapStatsPage has the following restrictions:

The caller must possess the AccessStats privilege.
For global statistics types, the caller must be the root partition.
For local statistics types, the caller must be the parent of the partition that is specified by PartitionId.
The partition that is specified by PartitionId must be in the active state.

Native Interface

HvUnmapStatsPage
	Call Code = 0x006D
Input Parameters
0	StatsType (4 bytes) Padding (4 bytes)
8	ObjectIdentity (16 bytes)
16

Requirements