HvParkLogicalProcessors function

The HvParkLogicalProcessors function informs the hypervisor about the set of logical processors that the root partition has decided to park (that is, refrain from using).

Syntax


HV_STATUS  HvParkLogicalProcessors(
  _In_  HV_INPUT_PARK_LOGICAL_PROCESSORS ProcessorMask
);

Parameters

ProcessorMask [in]

An HV_INPUT_PARK_LOGICAL_PROCESSORS value that identifies the logical processors that the root partition has decided to park. HV_INPUT_PARK_LOGICAL_PROCESSORS is defined as an unsigned 64-bit (UINT64) value.

Return value

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

Return codeDescription
HV_STATUS_SUCCESS

HvParkLogicalProcessors successfully identified the logical processors.

HV_STATUS_ACCESS_DENIED

The caller's partition privilege flag CpuManagement is cleared.

 

Remarks

The root partition calls HvParkLogicalProcessors to inform the hypervisor about the set of logical processors that the root partition has decided to park. A processor that is parked can be placed into a low power processor idle sleep state. This scheduling hint allows the hypervisor to not schedule threads on parked logical processors, which increases energy efficiency.

HvParkLogicalProcessors has the following restriction:

  • The caller's partition must possess the CPUManagement privilege.

Native Interface

HvParkLogicalProcessors

Call Code = 0x0009

Input Parameters

0

ProcessorMask (4 bytes) Padding (4 bytes)

 

Requirements

Version

HvParkLogicalProcessors is available in version 2.0 and later versions of the hypervisor.

Header

Hvgdk.h (include Hvgdk.h)

IRQL

Any level

 

 

Send comments about this topic to Microsoft

Build date: 11/16/2013

Show:
© 2014 Microsoft. All rights reserved.