2 Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 VM Power Management Application
32 ===============================
37 Applications running in Virtual Environments have an abstract view of
38 the underlying hardware on the Host, in particular applications cannot see
39 the binding of virtual to physical hardware.
40 When looking at CPU resourcing, the pinning of Virtual CPUs(vCPUs) to
41 Host Physical CPUs(pCPUS) is not apparent to an application
42 and this pinning may change over time.
43 Furthermore, Operating Systems on virtual machines do not have the ability
44 to govern their own power policy; the Machine Specific Registers (MSRs)
45 for enabling P-State transitions are not exposed to Operating Systems
46 running on Virtual Machines(VMs).
48 The Virtual Machine Power Management solution shows an example of
49 how a DPDK application can indicate its processing requirements using VM local
50 only information(vCPU/lcore) to a Host based Monitor which is responsible
51 for accepting requests for frequency changes for a vCPU, translating the vCPU
52 to a pCPU via libvirt and affecting the change in frequency.
54 The solution is comprised of two high-level components:
56 #. Example Host Application
58 Using a Command Line Interface(CLI) for VM->Host communication channel management
59 allows adding channels to the Monitor, setting and querying the vCPU to pCPU pinning,
60 inspecting and manually changing the frequency for each CPU.
61 The CLI runs on a single lcore while the thread responsible for managing
62 VM requests runs on a second lcore.
64 VM requests arriving on a channel for frequency changes are passed
65 to the librte_power ACPI cpufreq sysfs based library.
66 The Host Application relies on both qemu-kvm and libvirt to function.
68 #. librte_power for Virtual Machines
70 Using an alternate implementation for the librte_power API, requests for
71 frequency changes are forwarded to the host monitor rather than
72 the APCI cpufreq sysfs interface used on the host.
74 The l3fwd-power application will use this implementation when deployed on a VM
75 (see :doc:`l3_forward_power_man`).
77 .. _figure_vm_power_mgr_highlevel:
79 .. figure:: img/vm_power_mgr_highlevel.*
87 VM Power Management employs qemu-kvm to provide communications channels
88 between the host and VMs in the form of Virtio-Serial which appears as
89 a paravirtualized serial device on a VM and can be configured to use
90 various backends on the host. For this example each Virtio-Serial endpoint
91 on the host is configured as AF_UNIX file socket, supporting poll/select
92 and epoll for event notification.
93 In this example each channel endpoint on the host is monitored via
94 epoll for EPOLLIN events.
95 Each channel is specified as qemu-kvm arguments or as libvirt XML for each VM,
96 where each VM can have a number of channels up to a maximum of 64 per VM,
97 in this example each DPDK lcore on a VM has exclusive access to a channel.
99 To enable frequency changes from within a VM, a request via the librte_power interface
100 is forwarded via Virtio-Serial to the host, each request contains the vCPU
101 and power command(scale up/down/min/max).
102 The API for host and guest librte_power is consistent across environments,
103 with the selection of VM or Host Implementation determined at automatically
104 at runtime based on the environment.
106 Upon receiving a request, the host translates the vCPU to a pCPU via
107 the libvirt API before forwarding to the host librte_power.
109 .. _figure_vm_power_mgr_vm_request_seq:
111 .. figure:: img/vm_power_mgr_vm_request_seq.*
113 VM request to scale frequency
116 Performance Considerations
117 ~~~~~~~~~~~~~~~~~~~~~~~~~~
119 While Haswell Microarchitecture allows for independent power control for each core,
120 earlier Microarchtectures do not offer such fine grained control.
121 When deployed on pre-Haswell platforms greater care must be taken in selecting
122 which cores are assigned to a VM, for instance a core will not scale down
123 until its sibling is similarly scaled.
131 Enhanced Intel SpeedStepĀ® Technology must be enabled in the platform BIOS
132 if the power management feature of DPDK is to be used.
133 Otherwise, the sys file folder /sys/devices/system/cpu/cpu0/cpufreq will not exist,
134 and the CPU frequency-based power management cannot be used.
135 Consult the relevant BIOS documentation to determine how these settings
138 Host Operating System
139 ~~~~~~~~~~~~~~~~~~~~~
141 The Host OS must also have the *apci_cpufreq* module installed, in some cases
142 the *intel_pstate* driver may be the default Power Management environment.
143 To enable *acpi_cpufreq* and disable *intel_pstate*, add the following
144 to the grub Linux command line:
146 .. code-block:: console
150 Upon rebooting, load the *acpi_cpufreq* module:
152 .. code-block:: console
154 modprobe acpi_cpufreq
156 Hypervisor Channel Configuration
157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159 Virtio-Serial channels are configured via libvirt XML:
164 <name>{vm_name}</name>
165 <controller type='virtio-serial' index='0'>
166 <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
168 <channel type='unix'>
169 <source mode='bind' path='/tmp/powermonitor/{vm_name}.{channel_num}'/>
170 <target type='virtio' name='virtio.serial.port.poweragent.{vm_channel_num}'/>
171 <address type='virtio-serial' controller='0' bus='0' port='{N}'/>
175 Where a single controller of type *virtio-serial* is created and up to 32 channels
176 can be associated with a single controller and multiple controllers can be specified.
177 The convention is to use the name of the VM in the host path *{vm_name}* and
178 to increment *{channel_num}* for each channel, likewise the port value *{N}*
179 must be incremented for each channel.
181 Each channel on the host will appear in *path*, the directory */tmp/powermonitor/*
182 must first be created and given qemu permissions
184 .. code-block:: console
186 mkdir /tmp/powermonitor/
187 chown qemu:qemu /tmp/powermonitor
189 Note that files and directories within /tmp are generally removed upon
190 rebooting the host and the above steps may need to be carried out after each reboot.
192 The serial device as it appears on a VM is configured with the *target* element attribute *name*
193 and must be in the form of *virtio.serial.port.poweragent.{vm_channel_num}*,
194 where *vm_channel_num* is typically the lcore channel to be used in DPDK VM applications.
196 Each channel on a VM will be present at */dev/virtio-ports/virtio.serial.port.poweragent.{vm_channel_num}*
198 Compiling and Running the Host Application
199 ------------------------------------------
204 Compiling the Application
205 -------------------------
207 To compile the sample application see :doc:`compiling`.
209 The application is located in the ``vm_power_manager`` sub-directory.
214 The application does not have any specific command line options other than *EAL*:
216 .. code-block:: console
218 ./build/vm_power_mgr [EAL options]
220 The application requires exactly two cores to run, one core is dedicated to the CLI,
221 while the other is dedicated to the channel endpoint monitor, for example to run
222 on cores 0 & 1 on a system with 4 memory channels:
224 .. code-block:: console
226 ./build/vm_power_mgr -l 0-1 -n 4
228 After successful initialization the user is presented with VM Power Manager CLI:
230 .. code-block:: console
234 Virtual Machines can now be added to the VM Power Manager:
236 .. code-block:: console
238 vm_power> add_vm {vm_name}
240 When a {vm_name} is specified with the *add_vm* command a lookup is performed
241 with libvirt to ensure that the VM exists, {vm_name} is used as an unique identifier
242 to associate channels with a particular VM and for executing operations on a VM within the CLI.
243 VMs do not have to be running in order to add them.
245 A number of commands can be issued via the CLI in relation to VMs:
247 Remove a Virtual Machine identified by {vm_name} from the VM Power Manager.
249 .. code-block:: console
253 Add communication channels for the specified VM, the virtio channels must be enabled
254 in the VM configuration(qemu/libvirt) and the associated VM must be active.
255 {list} is a comma-separated list of channel numbers to add, using the keyword 'all'
256 will attempt to add all channels for the VM:
258 .. code-block:: console
260 add_channels {vm_name} {list}|all
262 Enable or disable the communication channels in {list}(comma-separated)
263 for the specified VM, alternatively list can be replaced with keyword 'all'.
264 Disabled channels will still receive packets on the host, however the commands
265 they specify will be ignored. Set status to 'enabled' to begin processing requests again:
267 .. code-block:: console
269 set_channel_status {vm_name} {list}|all enabled|disabled
271 Print to the CLI the information on the specified VM, the information
272 lists the number of vCPUS, the pinning to pCPU(s) as a bit mask, along with
273 any communication channels associated with each VM, along with the status of each channel:
275 .. code-block:: console
279 Set the binding of Virtual CPU on VM with name {vm_name} to the Physical CPU mask:
281 .. code-block:: console
283 set_pcpu_mask {vm_name} {vcpu} {pcpu}
285 Set the binding of Virtual CPU on VM to the Physical CPU:
287 .. code-block:: console
289 set_pcpu {vm_name} {vcpu} {pcpu}
291 Manual control and inspection can also be carried in relation CPU frequency scaling:
293 Get the current frequency for each core specified in the mask:
295 .. code-block:: console
297 show_cpu_freq_mask {mask}
299 Set the current frequency for the cores specified in {core_mask} by scaling each up/down/min/max:
301 .. code-block:: console
303 set_cpu_freq {core_mask} up|down|min|max
305 Get the current frequency for the specified core:
307 .. code-block:: console
309 show_cpu_freq {core_num}
311 Set the current frequency for the specified core by scaling up/down/min/max:
313 .. code-block:: console
315 set_cpu_freq {core_num} up|down|min|max
317 Compiling and Running the Guest Applications
318 --------------------------------------------
320 For compiling and running l3fwd-power, see :doc:`l3_forward_power_man`.
322 A guest CLI is also provided for validating the setup.
324 For both l3fwd-power and guest CLI, the channels for the VM must be monitored by the
325 host application using the *add_channels* command on the host.
330 #. export RTE_SDK=/path/to/rte_sdk
331 #. cd ${RTE_SDK}/examples/vm_power_manager/guest_cli
337 The application does not have any specific command line options other than *EAL*:
339 .. code-block:: console
341 ./build/vm_power_mgr [EAL options]
343 The application for example purposes uses a channel for each lcore enabled,
344 for example to run on cores 0,1,2,3 on a system with 4 memory channels:
346 .. code-block:: console
348 ./build/guest_vm_power_mgr -l 0-3 -n 4
351 After successful initialization the user is presented with VM Power Manager Guest CLI:
353 .. code-block:: console
357 To change the frequency of a lcore, use the set_cpu_freq command.
358 Where {core_num} is the lcore and channel to change frequency by scaling up/down/min/max.
360 .. code-block:: console
362 set_cpu_freq {core_num} up|down|min|max