1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2010-2014 Intel Corporation.
4 Virtual Machine Power Management Application
5 ============================================
7 Applications running in virtual environments have an abstract view of
8 the underlying hardware on the host. Specifically, applications cannot
9 see the binding of virtual components to physical hardware. When looking
10 at CPU resourcing, the pinning of Virtual CPUs (vCPUs) to Physical CPUs
11 (pCPUs) on the host is not apparent to an application and this pinning
12 may change over time. In addition, operating systems on Virtual Machines
13 (VMs) do not have the ability to govern their own power policy. The
14 Machine Specific Registers (MSRs) for enabling P-state transitions are
15 not exposed to the operating systems running on the VMs.
17 The solution demonstrated in this sample application shows an example of
18 how a DPDK application can indicate its processing requirements using
19 VM-local only information (vCPU/lcore, and so on) to a host resident VM
20 Power Manager. The VM Power Manager is responsible for:
22 - **Accepting requests for frequency changes for a vCPU**
23 - **Translating the vCPU to a pCPU using libvirt**
24 - **Performing the change in frequency**
26 This application demonstrates the following features:
28 - **The handling of VM application requests to change frequency.**
29 VM applications can request frequency changes for a vCPU. The VM
30 Power Management Application uses libvirt to translate that
31 virtual CPU (vCPU) request to a physical CPU (pCPU) request and
32 performs the frequency change.
34 - **The acceptance of power management policies from VM applications.**
35 A VM application can send a policy to the host application. The
36 policy contains rules that define the power management behaviour
37 of the VM. The host application then applies the rules of the
38 policy independent of the VM application. For example, the
39 policy can contain time-of-day information for busy/quiet
40 periods, and the host application can scale up/down the relevant
41 cores when required. See :ref:`sending_policy` for information on
42 setting policy values.
44 - **Out-of-band monitoring of workloads using core hardware event counters.**
45 The host application can manage power for an application by looking
46 at the event counters of the cores and taking action based on the
47 branch miss/hit ratio. See :ref:`enabling_out_of_band`.
49 **Note**: This functionality also applies in non-virtualised environments.
51 In addition to the ``librte_power`` library used on the host, the
52 application uses a special version of ``librte_power`` on each VM, which
53 directs frequency changes and policies to the host monitor rather than
54 the APCI ``cpufreq`` ``sysfs`` interface used on the host in non-virtualised
57 .. _figure_vm_power_mgr_highlevel:
59 .. figure:: img/vm_power_mgr_highlevel.*
63 In the above diagram, the DPDK Applications are shown running in
64 virtual machines, and the VM Power Monitor application is shown running
67 **DPDK VM Application**
69 - Reuse ``librte_power`` interface, but uses an implementation that
70 forwards frequency requests to the host using a ``virtio-serial`` channel
71 - Each lcore has exclusive access to a single channel
72 - Sample application reuses ``l3fwd_power``
73 - A CLI for changing frequency from within a VM is also included
77 - Accepts VM commands over ``virtio-serial`` endpoints, monitored
79 - Commands include the virtual core to be modified, using ``libvirt`` to get
80 the physical core mapping
81 - Uses ``librte_power`` to affect frequency changes using Linux userspace
82 power governor (``acpi_cpufreq`` OR ``intel_pstate`` driver)
83 - CLI: For adding VM channels to monitor, inspecting and changing channel
84 state, manually altering CPU frequency. Also allows for the changings
85 of vCPU to pCPU pinning
87 Sample Application Architecture Overview
88 ----------------------------------------
90 The VM power management solution employs ``qemu-kvm`` to provide
91 communications channels between the host and VMs in the form of a
92 ``virtio-serial`` connection that appears as a para-virtualised serial
93 device on a VM and can be configured to use various backends on the
94 host. For this example, the configuration of each ``virtio-serial`` endpoint
95 on the host as an ``AF_UNIX`` file socket, supporting poll/select and
96 ``epoll`` for event notification. In this example, each channel endpoint on
97 the host is monitored for ``EPOLLIN`` events using ``epoll``. Each channel
98 is specified as ``qemu-kvm`` arguments or as ``libvirt`` XML for each VM,
99 where each VM can have several channels up to a maximum of 64 per VM. In this
100 example, each DPDK lcore on a VM has exclusive access to a channel.
102 To enable frequency changes from within a VM, the VM forwards a
103 ``librte_power`` request over the ``virtio-serial`` channel to the host. Each
104 request contains the vCPU and power command (scale up/down/min/max). The
105 API for the host ``librte_power`` and guest ``librte_power`` is consistent
106 across environments, with the selection of VM or host implementation
107 determined automatically at runtime based on the environment. On
108 receiving a request, the host translates the vCPU to a pCPU using the
109 libvirt API before forwarding it to the host ``librte_power``.
112 .. _figure_vm_power_mgr_vm_request_seq:
114 .. figure:: img/vm_power_mgr_vm_request_seq.*
116 In addition to the ability to send power management requests to the
117 host, a VM can send a power management policy to the host. In some
118 cases, using a power management policy is a preferred option because it
119 can eliminate possible latency issues that can occur when sending power
120 management requests. Once the VM sends the policy to the host, the VM no
121 longer needs to worry about power management, because the host now
122 manages the power for the VM based on the policy. The policy can specify
123 power behavior that is based on incoming traffic rates or time-of-day
124 power adjustment (busy/quiet hour power adjustment for example). See
125 :ref:`sending_policy` for more information.
127 One method of power management is to sense how busy a core is when
128 processing packets and adjusting power accordingly. One technique for
129 doing this is to monitor the ratio of the branch miss to branch hits
130 counters and scale the core power accordingly. This technique is based
131 on the premise that when a core is not processing packets, the ratio of
132 branch misses to branch hits is very low, but when the core is
133 processing packets, it is measurably higher. The implementation of this
134 capability is as a policy of type ``BRANCH_RATIO``.
135 See :ref:`sending_policy` for more information on using the
136 BRANCH_RATIO policy option.
138 A JSON interface enables the specification of power management requests
139 and policies in JSON format. The JSON interfaces provide a more
140 convenient and more easily interpreted interface for the specification
141 of requests and policies. See :ref:`power_man_requests` for more information.
143 Performance Considerations
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~
146 While the Haswell microarchitecture allows for independent power control
147 for each core, earlier microarchitectures do not offer such fine-grained
148 control. When deploying on pre-Haswell platforms, greater care must be
149 taken when selecting which cores are assigned to a VM, for example, a
150 core does not scale down in frequency until all of its siblings are
151 similarly scaled down.
159 To use the power management features of the DPDK, you must enable
160 Enhanced Intel SpeedStep® Technology in the platform BIOS. Otherwise,
161 the ``sys`` file folder ``/sys/devices/system/cpu/cpu0/cpufreq`` does not
162 exist, and you cannot use CPU frequency-based power management. Refer to the
163 relevant BIOS documentation to determine how to access these settings.
165 Host Operating System
166 ~~~~~~~~~~~~~~~~~~~~~
168 The DPDK Power Management library can use either the ``acpi_cpufreq`` or
169 the ``intel_pstate`` kernel driver for the management of core frequencies. In
170 many cases, the ``intel_pstate`` driver is the default power management
173 Should the ``acpi-cpufreq driver`` be required, the ``intel_pstate``
174 module must be disabled, and the ``acpi-cpufreq`` module loaded in its place.
176 To disable the ``intel_pstate`` driver, add the following to the ``grub``
179 ``intel_pstate=disable``
181 On reboot, load the ``acpi_cpufreq`` module:
183 ``modprobe acpi_cpufreq``
185 Hypervisor Channel Configuration
186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
188 Configure ``virtio-serial`` channels using ``libvirt`` XML.
189 The XML structure is as follows:
193 <name>{vm_name}</name>
194 <controller type='virtio-serial' index='0'>
195 <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
197 <channel type='unix'>
198 <source mode='bind' path='/tmp/powermonitor/{vm_name}.{channel_num}'/>
199 <target type='virtio' name='virtio.serial.port.poweragent.{vm_channel_num}'/>
200 <address type='virtio-serial' controller='0' bus='0' port='{N}'/>
203 Where a single controller of type ``virtio-serial`` is created, up to 32
204 channels can be associated with a single controller, and multiple
205 controllers can be specified. The convention is to use the name of the
206 VM in the host path ``{vm_name}`` and to increment ``{channel_num}`` for each
207 channel. Likewise, the port value ``{N}`` must be incremented for each
210 On the host, for each channel to appear in the path, ensure the creation
211 of the ``/tmp/powermonitor/`` directory and the assignment of ``qemu``
214 .. code-block:: console
216 mkdir /tmp/powermonitor/
217 chown qemu:qemu /tmp/powermonitor
219 Note that files and directories in ``/tmp`` are generally removed when
220 rebooting the host and you may need to perform the previous steps after
223 The serial device as it appears on a VM is configured with the target
224 element attribute name and must be in the form:
225 ``virtio.serial.port.poweragent.{vm_channel_num}``, where
226 ``vm_channel_num`` is typically the lcore channel to be used in
227 DPDK VM applications.
229 Each channel on a VM is present at:
231 ``/dev/virtio-ports/virtio.serial.port.poweragent.{vm_channel_num}``
233 Compiling and Running the Host Application
234 ------------------------------------------
236 Compiling the Host Application
237 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
239 For information on compiling the DPDK and sample applications, see
240 see :doc:`compiling`.
242 The application is located in the ``vm_power_manager`` subdirectory.
244 To build just the ``vm_power_manager`` application using ``make``:
246 .. code-block:: console
248 export RTE_SDK=/path/to/rte_sdk
249 export RTE_TARGET=build
250 cd ${RTE_SDK}/examples/vm_power_manager/
253 The resulting binary is ``${RTE_SDK}/build/examples/vm_power_manager``.
255 To build just the ``vm_power_manager`` application using ``meson``/``ninja``:
257 .. code-block:: console
259 export RTE_SDK=/path/to/rte_sdk
264 meson configure -Dexamples=vm_power_manager
267 The resulting binary is ``${RTE_SDK}/build/examples/dpdk-vm_power_manager``.
269 Running the Host Application
270 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272 The application does not have any specific command line options other
273 than the EAL options:
275 .. code-block:: console
277 ./build/vm_power_mgr [EAL options]
279 The application requires exactly two cores to run. One core for the CLI
280 and the other for the channel endpoint monitor. For example, to run on
281 cores 0 and 1 on a system with four memory channels, issue the command:
283 .. code-block:: console
285 ./build/vm_power_mgr -l 0-1 -n 4
287 After successful initialization, the VM Power Manager CLI prompt appears:
289 .. code-block:: console
293 Now, it is possible to add virtual machines to the VM Power Manager:
295 .. code-block:: console
297 vm_power> add_vm {vm_name}
299 When a ``{vm_name}`` is specified with the ``add_vm`` command, a lookup is
300 performed with ``libvirt`` to ensure that the VM exists. ``{vm_name}`` is a
301 unique identifier to associate channels with a particular VM and for
302 executing operations on a VM within the CLI. VMs do not have to be
305 It is possible to issue several commands from the CLI to manage VMs.
307 Remove the virtual machine identified by ``{vm_name}`` from the VM Power
308 Manager using the command:
310 .. code-block:: console
314 Add communication channels for the specified VM using the following
315 command. The ``virtio`` channels must be enabled in the VM configuration
316 (``qemu/libvirt``) and the associated VM must be active. ``{list}`` is a
317 comma-separated list of channel numbers to add. Specifying the keyword
318 ``all`` attempts to add all channels for the VM:
320 .. code-block:: console
322 set_pcpu {vm_name} {vcpu} {pcpu}
324 Enable query of physical core information from a VM:
326 .. code-block:: console
328 set_query {vm_name} enable|disable
330 Manual control and inspection can also be carried in relation CPU frequency scaling:
332 Get the current frequency for each core specified in the mask:
334 .. code-block:: console
336 show_cpu_freq_mask {mask}
338 Set the current frequency for the cores specified in {core_mask} by scaling each up/down/min/max:
340 .. code-block:: console
342 add_channels {vm_name} {list}|all
344 Enable or disable the communication channels in ``{list}`` (comma-separated)
345 for the specified VM. Alternatively, replace ``list`` with the keyword
346 ``all``. Disabled channels receive packets on the host. However, the commands
347 they specify are ignored. Set the status to enabled to begin processing
350 .. code-block:: console
352 set_channel_status {vm_name} {list}|all enabled|disabled
354 Print to the CLI information on the specified VM. The information lists
355 the number of vCPUs, the pinning to pCPU(s) as a bit mask, along with
356 any communication channels associated with each VM, and the status of
359 .. code-block:: console
363 Set the binding of a virtual CPU on a VM with name ``{vm_name}`` to the
366 .. code-block:: console
368 set_pcpu_mask {vm_name} {vcpu} {pcpu}
370 Set the binding of the virtual CPU on the VM to the physical CPU:
372 .. code-block:: console
374 set_pcpu {vm_name} {vcpu} {pcpu}
376 It is also possible to perform manual control and inspection in relation
377 to CPU frequency scaling.
379 Get the current frequency for each core specified in the mask:
381 .. code-block:: console
383 show_cpu_freq_mask {mask}
385 Set the current frequency for the cores specified in ``{core_mask}`` by
386 scaling each up/down/min/max:
388 .. code-block:: console
390 set_cpu_freq {core_mask} up|down|min|max
392 Get the current frequency for the specified core:
394 .. code-block:: console
396 show_cpu_freq {core_num}
398 Set the current frequency for the specified core by scaling up/down/min/max:
400 .. code-block:: console
402 set_cpu_freq {core_num} up|down|min|max
404 .. _enabling_out_of_band:
406 Command Line Options for Enabling Out-of-band Branch Ratio Monitoring
407 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
409 There are a couple of command line parameters for enabling the out-of-band
410 monitoring of branch ratios on cores doing busy polling using PMDs as
413 ``--core-list {list of cores}``
414 Specify the list of cores to monitor the ratio of branch misses
415 to branch hits. A tightly-polling PMD thread has a very low
416 branch ratio, therefore the core frequency scales down to the
417 minimum allowed value. On receiving packets, the code path changes,
418 causing the branch ratio to increase. When the ratio goes above
419 the ratio threshold, the core frequency scales up to the maximum
422 ``--branch-ratio {ratio}``
423 Specify a floating-point number that identifies the threshold at which
424 to scale up or down for the given workload. The default branch ratio
425 is 0.01 and needs adjustment for different workloads.
428 Compiling and Running the Guest Applications
429 --------------------------------------------
431 It is possible to use the ``l3fwd-power`` application (for example) with the
432 ``vm_power_manager``.
434 The distribution also provides a guest CLI for validating the setup.
436 For both ``l3fwd-power`` and the guest CLI, the host application must use
437 the ``add_channels`` command to monitor the channels for the VM. To do this,
438 issue the following commands in the host application:
440 .. code-block:: console
442 vm_power> add_vm vmname
443 vm_power> add_channels vmname all
444 vm_power> set_channel_status vmname all enabled
445 vm_power> show_vm vmname
447 Compiling the Guest Application
448 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
450 For information on compiling DPDK and the sample applications in general,
451 see :doc:`compiling`.
453 For compiling and running the ``l3fwd-power`` sample application, see
454 :doc:`l3_forward_power_man`.
456 The application is in the ``guest_cli`` subdirectory under ``vm_power_manager``.
458 To build just the ``guest_vm_power_manager`` application using ``make``, issue
459 the following commands:
461 .. code-block:: console
463 export RTE_SDK=/path/to/rte_sdk
464 export RTE_TARGET=build
465 cd ${RTE_SDK}/examples/vm_power_manager/guest_cli/
468 The resulting binary is ``${RTE_SDK}/build/examples/guest_cli``.
470 **Note**: This sample application conditionally links in the Jansson JSON
471 library. Consequently, if you are using a multilib or cross-compile
472 environment, you may need to set the ``PKG_CONFIG_LIBDIR`` environmental
473 variable to point to the relevant ``pkgconfig`` folder so that the correct
474 library is linked in.
476 For example, if you are building for a 32-bit target, you could find the
477 correct directory using the following find command:
479 .. code-block:: console
481 # find /usr -type d -name pkgconfig
482 /usr/lib/i386-linux-gnu/pkgconfig
483 /usr/lib/x86_64-linux-gnu/pkgconfig
487 .. code-block:: console
489 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig
491 You then use the ``make`` command as normal, which should find the 32-bit
492 version of the library, if it installed. If not, the application builds
493 without the JSON interface functionality.
495 To build just the ``vm_power_manager`` application using ``meson``/``ninja``:
497 .. code-block:: console
499 export RTE_SDK=/path/to/rte_sdk
504 meson configure -Dexamples=vm_power_manager/guest_cli
507 The resulting binary is ``${RTE_SDK}/build/examples/guest_cli``.
509 Running the Guest Application
510 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
512 The standard EAL command line parameters are necessary:
514 .. code-block:: console
516 ./build/vm_power_mgr [EAL options] -- [guest options]
518 The guest example uses a channel for each lcore enabled. For example, to
519 run on cores 0, 1, 2 and 3:
521 .. code-block:: console
523 ./build/guest_vm_power_mgr -l 0-3
527 Command Line Options Available When Sending a Policy to the Host
528 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
530 Optionally, there are several command line options for a user who needs
531 to send a power policy to the host application:
533 ``--vm-name {name of guest vm}``
534 Allows the user to change the virtual machine name
535 passed down to the host application using the power policy.
536 The default is ubuntu2.
538 ``--vcpu-list {list vm cores}``
539 A comma-separated list of cores in the VM that the user
540 wants the host application to monitor.
541 The list of cores in any VM starts at zero,
542 and the host application maps these to the physical cores
543 once the policy passes down to the host.
544 Valid syntax includes individual cores 2,3,4,
545 a range of cores 2-4, or a combination of both 1,3,5-7.
547 ``--busy-hours {list of busy hours}``
548 A comma-separated list of hours in which to set the core
549 frequency to the maximum.
550 Valid syntax includes individual hours 2,3,4,
551 a range of hours 2-4, or a combination of both 1,3,5-7.
552 Valid hour values are 0 to 23.
554 ``--quiet-hours {list of quiet hours}``
555 A comma-separated list of hours in which to set the core frequency
556 to minimum. Valid syntax includes individual hours 2,3,4,
557 a range of hours 2-4, or a combination of both 1,3,5-7.
558 Valid hour values are 0 to 23.
560 ``--policy {policy type}``
561 The type of policy. This can be one of the following values:
563 - TRAFFIC - Based on incoming traffic rates on the NIC.
564 - TIME - Uses a busy/quiet hours policy.
565 - BRANCH_RATIO - Uses branch ratio counters to determine core busyness.
566 - WORKLOAD - Sets the frequency to low, medium or high
567 based on the received policy setting.
569 **Note**: Not all policy types need all parameters.
570 For example, BRANCH_RATIO only needs the vcpu-list parameter.
572 After successful initialization, the VM Power Manager Guest CLI prompt
575 .. code-block:: console
579 To change the frequency of an lcore, use a ``set_cpu_freq`` command similar
582 .. code-block:: console
584 set_cpu_freq {core_num} up|down|min|max
586 where, ``{core_num}`` is the lcore and channel to change frequency by
587 scaling up/down/min/max.
589 To start an application, configure the power policy, and send it to the
590 host, use a command like the following:
592 .. code-block:: console
594 ./build/guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4
596 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command
597 will send the policy to the host:
599 .. code-block:: console
603 Once the policy is sent to the host, the host application takes over the power monitoring
604 of the specified cores in the policy.
606 .. _power_man_requests:
608 JSON Interface for Power Management Requests and Policies
609 ---------------------------------------------------------
611 In addition to the command line interface for the host command, and a
612 ``virtio-serial`` interface for VM power policies, there is also a JSON
613 interface through which power commands and policies can be sent.
615 **Note**: This functionality adds a dependency on the Jansson library.
616 Install the Jansson development package on the system to avail of the
617 JSON parsing functionality in the app. Issue the ``apt-get install
618 libjansson-dev`` command to install the development package. The command
619 and package name may be different depending on your operating system. It
620 is worth noting that the app builds successfully if this package is not
621 present, but a warning displays during compilation, and the JSON parsing
622 functionality is not present in the app.
624 Send a request or policy to the VM Power Manager by simply opening a
625 fifo file at ``/tmp/powermonitor/fifo``, writing a JSON string to that file,
626 and closing the file.
628 The JSON string can be a power management request or a policy, and takes
629 the following format:
631 .. code-block:: javascript
638 The ``packet_type`` header can contain one of two values, depending on
639 whether a power management request or policy is being sent. The two
640 possible values are ``instruction`` and ``policy`` and the expected name-value
641 pairs are different depending on which type is sent.
643 The pairs are in the format of standard JSON name-value pairs. The value
644 type varies between the different name-value pairs, and may be integers,
645 strings, arrays, and so on. See :ref:`json_interface_ex`
646 for examples of policies and instructions and
647 :ref:`json_name_value_pair` for the supported names and value types.
649 .. _json_interface_ex:
651 JSON Interface Examples
652 ~~~~~~~~~~~~~~~~~~~~~~~
654 The following is an example JSON string that creates a time-profile
662 "policy_type": "TIME",
663 "busy_hours":[ 17, 18, 19, 20, 21, 22, 23 ],
664 "quiet_hours":[ 2, 3, 4, 5, 6 ],
668 The following is an example JSON string that removes the named policy.
674 "command": "destroy",
677 The following is an example JSON string for a power management request.
688 To query the available frequences of an lcore, use the query_cpu_freq command.
689 Where {core_num} is the lcore to query.
690 Before using this command, please enable responses via the set_query command on the host.
692 .. code-block:: console
694 query_cpu_freq {core_num}|all
696 To query the capabilities of an lcore, use the query_cpu_caps command.
697 Where {core_num} is the lcore to query.
698 Before using this command, please enable responses via the set_query command on the host.
700 .. code-block:: console
702 query_cpu_caps {core_num}|all
704 To start the application and configure the power policy, and send it to the host:
706 .. code-block:: console
708 ./build/guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4
710 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command
711 will send the policy to the host:
713 .. code-block:: console
717 Once the policy is sent to the host, the host application takes over the power monitoring
718 of the specified cores in the policy.
720 .. _json_name_value_pair:
722 JSON Name-value Pairs
723 ~~~~~~~~~~~~~~~~~~~~~
725 The following are the name-value pairs supported by the JSON interface:
727 - `avg_packet_thresh`_
732 - `max_packet_thresh`_
744 The threshold below which the frequency is set to the minimum value
745 for the TRAFFIC policy.
746 If the traffic rate is above this value and below the maximum value,
747 the frequency is set to medium.
751 The number of packets below which the TRAFFIC policy applies
752 the minimum frequency, or the medium frequency
753 if between the average and maximum thresholds.
757 ``"avg_packet_thresh": 100000``
763 The hours of the day in which we scale up the cores for busy times.
767 An array with a list of hour values (0-23).
769 For the TIME policy only.
771 ``"busy_hours":[ 17, 18, 19, 20, 21, 22, 23 ]``
777 The type of packet to send to the VM Power Manager.
778 It is possible to create or destroy a policy or send a direct command
779 to adjust the frequency of a core,
780 as is possible on the command line interface.
785 - CREATE: Create a new policy.
786 - DESTROY: Remove an existing policy.
787 - POWER: Send an immediate command, max, min, and so on.
791 ``"command": "CREATE"``
797 The cores to which to apply a policy.
801 An array with a list of virtual CPUs.
803 For CREATE/DESTROY policy requests only.
805 ``"core_list":[ 10, 11 ]``
811 When the policy is of type TRAFFIC,
812 it is necessary to specify the MAC addresses that the host must monitor.
816 An array with a list of MAC address strings.
818 For TRAFFIC policy types only.
820 ``"mac_list":[ "de:ad:be:ef:01:01","de:ad:be:ef:01:02" ]``
826 In a policy of type TRAFFIC,
827 the threshold value above which the frequency is set to a maximum.
831 The number of packets per interval above which
832 the TRAFFIC policy applies the maximum frequency.
834 For the TRAFFIC policy only.
836 ``"max_packet_thresh": 500000``
842 The name of the VM or host.
843 Allows the parser to associate the policy with the relevant VM or host OS.
851 ``"name": "ubuntu2"``
857 The type of policy to apply.
858 See the ``--policy`` option description for more information.
864 - TIME: Time-of-day policy.
865 Scale the frequencies of the relevant cores up/down
866 depending on busy and quiet hours.
867 - TRAFFIC: Use statistics from the NIC and scale up and down accordingly.
868 - WORKLOAD: Determine how heavily loaded the cores are
869 and scale up and down accordingly.
870 - BRANCH_RATIO: An out-of-band policy that looks at the ratio
871 between branch hits and misses on a core
872 and uses that information to determine how much packet processing
876 For ``CREATE`` and ``DESTROY`` policy requests only.
878 ``"policy_type": "TIME"``
884 The hours of the day to scale down the cores for quiet times.
888 An array with a list of hour numbers with values in the range 0 to 23.
890 For the TIME policy only.
892 ``"quiet_hours":[ 2, 3, 4, 5, 6 ]``
898 The core to which to apply a power command.
902 A valid core ID for the VM or host OS.
904 For the ``POWER`` instruction only.
906 ``"resource_id": 10``
912 The type of power operation to apply in the command.
916 - SCALE_MAX: Scale the frequency of this core to the maximum.
917 - SCALE_MIN: Scale the frequency of this core to the minimum.
918 - SCALE_UP: Scale up the frequency of this core.
919 - SCALE_DOWN: Scale down the frequency of this core.
920 - ENABLE_TURBO: Enable Intel® Turbo Boost Technology for this core.
921 - DISABLE_TURBO: Disable Intel® Turbo Boost Technology for this core.
923 For the ``POWER`` instruction only.
925 ``"unit": "SCALE_MAX"``
931 In a policy of type WORKLOAD,
932 it is necessary to specify how heavy the workload is.
936 - HIGH: Scale the frequency of this core to maximum.
937 - MEDIUM: Scale the frequency of this core to minimum.
938 - LOW: Scale up the frequency of this core.
940 For the ``WORKLOAD`` policy only.
942 ``"workload": "MEDIUM"``