xref: /dpdk/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c (revision 04a8cb8ee95f82b22f18bb9de83b740b5b943a59)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation
3  */
4 
5 
6 #include <stdint.h>
7 #include <string.h>
8 #include <stdio.h>
9 #include <termios.h>
10 
11 #include <cmdline_rdline.h>
12 #include <cmdline_parse.h>
13 #include <cmdline_parse_string.h>
14 #include <cmdline_parse_num.h>
15 #include <cmdline_socket.h>
16 #include <cmdline.h>
17 #include <rte_log.h>
18 #include <rte_lcore.h>
19 #include <rte_ethdev.h>
20 
21 #include <rte_power.h>
22 #include <guest_channel.h>
23 
24 #include "vm_power_cli_guest.h"
25 
26 
27 #define CHANNEL_PATH "/dev/virtio-ports/virtio.serial.port.poweragent"
28 
29 
30 #define RTE_LOGTYPE_GUEST_CLI RTE_LOGTYPE_USER1
31 
32 struct cmd_quit_result {
33 	cmdline_fixed_string_t quit;
34 };
35 
36 union PFID {
37 	struct rte_ether_addr addr;
38 	uint64_t pfid;
39 };
40 
41 static struct channel_packet policy;
42 
43 struct channel_packet *
44 get_policy(void)
45 {
46 	return &policy;
47 }
48 
49 int
50 set_policy_mac(int port, int idx)
51 {
52 	struct channel_packet *policy;
53 	union PFID pfid;
54 	int ret;
55 
56 	/* Use port MAC address as the vfid */
57 	ret = rte_eth_macaddr_get(port, &pfid.addr);
58 	if (ret != 0) {
59 		printf("Failed to get device (port %u) MAC address: %s\n",
60 				port, rte_strerror(-ret));
61 		return ret;
62 	}
63 
64 	printf("Port %u MAC: %02" PRIx8 ":%02" PRIx8 ":%02" PRIx8 ":"
65 			"%02" PRIx8 ":%02" PRIx8 ":%02" PRIx8 "\n",
66 			port,
67 			pfid.addr.addr_bytes[0], pfid.addr.addr_bytes[1],
68 			pfid.addr.addr_bytes[2], pfid.addr.addr_bytes[3],
69 			pfid.addr.addr_bytes[4], pfid.addr.addr_bytes[5]);
70 	policy = get_policy();
71 	policy->vfid[idx] = pfid.pfid;
72 	return 0;
73 }
74 
75 int
76 set_policy_defaults(struct channel_packet *pkt)
77 {
78 	int ret;
79 
80 	ret = set_policy_mac(0, 0);
81 	if (ret != 0)
82 		return ret;
83 
84 	pkt->nb_mac_to_monitor = 1;
85 
86 	pkt->t_boost_status.tbEnabled = false;
87 
88 	pkt->vcpu_to_control[0] = 0;
89 	pkt->vcpu_to_control[1] = 1;
90 	pkt->num_vcpu = 2;
91 	/* Dummy Population. */
92 	pkt->traffic_policy.min_packet_thresh = 96000;
93 	pkt->traffic_policy.avg_max_packet_thresh = 1800000;
94 	pkt->traffic_policy.max_max_packet_thresh = 2000000;
95 
96 	pkt->timer_policy.busy_hours[0] = 3;
97 	pkt->timer_policy.busy_hours[1] = 4;
98 	pkt->timer_policy.busy_hours[2] = 5;
99 	pkt->timer_policy.quiet_hours[0] = 11;
100 	pkt->timer_policy.quiet_hours[1] = 12;
101 	pkt->timer_policy.quiet_hours[2] = 13;
102 
103 	pkt->timer_policy.hours_to_use_traffic_profile[0] = 8;
104 	pkt->timer_policy.hours_to_use_traffic_profile[1] = 10;
105 
106 	pkt->core_type = CORE_TYPE_VIRTUAL;
107 	pkt->workload = LOW;
108 	pkt->policy_to_use = TIME;
109 	pkt->command = PKT_POLICY;
110 	strcpy(pkt->vm_name, "ubuntu2");
111 
112 	return 0;
113 }
114 
115 static void cmd_quit_parsed(__attribute__((unused)) void *parsed_result,
116 				__attribute__((unused)) struct cmdline *cl,
117 			    __attribute__((unused)) void *data)
118 {
119 	unsigned lcore_id;
120 
121 	RTE_LCORE_FOREACH(lcore_id) {
122 		rte_power_exit(lcore_id);
123 	}
124 	cmdline_quit(cl);
125 }
126 
127 cmdline_parse_token_string_t cmd_quit_quit =
128 	TOKEN_STRING_INITIALIZER(struct cmd_quit_result, quit, "quit");
129 
130 cmdline_parse_inst_t cmd_quit = {
131 	.f = cmd_quit_parsed,  /* function to call */
132 	.data = NULL,      /* 2nd arg of func */
133 	.help_str = "close the application",
134 	.tokens = {        /* token list, NULL terminated */
135 		(void *)&cmd_quit_quit,
136 		NULL,
137 	},
138 };
139 
140 /* *** VM operations *** */
141 
142 struct cmd_set_cpu_freq_result {
143 	cmdline_fixed_string_t set_cpu_freq;
144 	uint8_t lcore_id;
145 	cmdline_fixed_string_t cmd;
146 };
147 
148 static int
149 check_response_cmd(unsigned int lcore_id, int *result)
150 {
151 	struct channel_packet pkt;
152 	int ret;
153 
154 	ret = rte_power_guest_channel_receive_msg(&pkt, sizeof pkt, lcore_id);
155 	if (ret < 0)
156 		return -1;
157 
158 	switch (pkt.command) {
159 	case(CPU_POWER_CMD_ACK):
160 		*result = 1;
161 		break;
162 	case(CPU_POWER_CMD_NACK):
163 		*result = 0;
164 		break;
165 	default:
166 		RTE_LOG(ERR, GUEST_CLI,
167 				"Received invalid response from host, expecting ACK/NACK.\n");
168 		return -1;
169 	}
170 
171 	return 0;
172 }
173 
174 static void
175 cmd_set_cpu_freq_parsed(void *parsed_result, struct cmdline *cl,
176 		       __attribute__((unused)) void *data)
177 {
178 	int ret = -1;
179 	struct cmd_set_cpu_freq_result *res = parsed_result;
180 
181 	if (!strcmp(res->cmd, "up"))
182 		ret = rte_power_freq_up(res->lcore_id);
183 	else if (!strcmp(res->cmd, "down"))
184 		ret = rte_power_freq_down(res->lcore_id);
185 	else if (!strcmp(res->cmd, "min"))
186 		ret = rte_power_freq_min(res->lcore_id);
187 	else if (!strcmp(res->cmd, "max"))
188 		ret = rte_power_freq_max(res->lcore_id);
189 	else if (!strcmp(res->cmd, "enable_turbo"))
190 		ret = rte_power_freq_enable_turbo(res->lcore_id);
191 	else if (!strcmp(res->cmd, "disable_turbo"))
192 		ret = rte_power_freq_disable_turbo(res->lcore_id);
193 
194 	if (ret != 1) {
195 		cmdline_printf(cl, "Error sending message: %s\n", strerror(ret));
196 		return;
197 	}
198 	int result;
199 	ret = check_response_cmd(res->lcore_id, &result);
200 	if (ret < 0) {
201 		RTE_LOG(ERR, GUEST_CLI, "No confirmation for sent message received\n");
202 	} else {
203 		cmdline_printf(cl, "%s received for message sent to host.\n",
204 				result == 1 ? "ACK" : "NACK");
205 	}
206 }
207 
208 cmdline_parse_token_string_t cmd_set_cpu_freq =
209 	TOKEN_STRING_INITIALIZER(struct cmd_set_cpu_freq_result,
210 			set_cpu_freq, "set_cpu_freq");
211 cmdline_parse_token_num_t cmd_set_cpu_freq_core_num =
212 	TOKEN_NUM_INITIALIZER(struct cmd_set_cpu_freq_result,
213 			lcore_id, UINT8);
214 cmdline_parse_token_string_t cmd_set_cpu_freq_cmd_cmd =
215 	TOKEN_STRING_INITIALIZER(struct cmd_set_cpu_freq_result,
216 			cmd, "up#down#min#max#enable_turbo#disable_turbo");
217 
218 cmdline_parse_inst_t cmd_set_cpu_freq_set = {
219 	.f = cmd_set_cpu_freq_parsed,
220 	.data = NULL,
221 	.help_str = "set_cpu_freq <core_num> "
222 			"<up|down|min|max|enable_turbo|disable_turbo>, "
223 			"adjust the frequency for the specified core.",
224 	.tokens = {
225 		(void *)&cmd_set_cpu_freq,
226 		(void *)&cmd_set_cpu_freq_core_num,
227 		(void *)&cmd_set_cpu_freq_cmd_cmd,
228 		NULL,
229 	},
230 };
231 
232 struct cmd_send_policy_result {
233 	cmdline_fixed_string_t send_policy;
234 	cmdline_fixed_string_t cmd;
235 };
236 
237 static inline int
238 send_policy(struct channel_packet *pkt, struct cmdline *cl)
239 {
240 	int ret;
241 
242 	ret = rte_power_guest_channel_send_msg(pkt, 1);
243 	if (ret < 0) {
244 		RTE_LOG(ERR, GUEST_CLI, "Error sending message: %s\n",
245 				ret > 0 ? strerror(ret) : "channel not connected");
246 		return -1;
247 	}
248 
249 	int result;
250 	ret = check_response_cmd(1, &result);
251 	if (ret < 0) {
252 		RTE_LOG(ERR, GUEST_CLI, "No confirmation for sent policy received\n");
253 	} else {
254 		cmdline_printf(cl, "%s for sent policy received.\n",
255 				result == 1 ? "ACK" : "NACK");
256 	}
257 	return 1;
258 }
259 
260 static void
261 cmd_send_policy_parsed(void *parsed_result, struct cmdline *cl,
262 		       __attribute__((unused)) void *data)
263 {
264 	int ret = -1;
265 	struct cmd_send_policy_result *res = parsed_result;
266 
267 	if (!strcmp(res->cmd, "now")) {
268 		printf("Sending Policy down now!\n");
269 		ret = send_policy(&policy, cl);
270 	}
271 	if (ret != 1)
272 		cmdline_printf(cl, "Error sending message: %s\n",
273 				strerror(ret));
274 }
275 
276 cmdline_parse_token_string_t cmd_send_policy =
277 	TOKEN_STRING_INITIALIZER(struct cmd_send_policy_result,
278 			send_policy, "send_policy");
279 cmdline_parse_token_string_t cmd_send_policy_cmd_cmd =
280 	TOKEN_STRING_INITIALIZER(struct cmd_send_policy_result,
281 			cmd, "now");
282 
283 cmdline_parse_inst_t cmd_send_policy_set = {
284 	.f = cmd_send_policy_parsed,
285 	.data = NULL,
286 	.help_str = "send_policy now",
287 	.tokens = {
288 		(void *)&cmd_send_policy,
289 		(void *)&cmd_send_policy_cmd_cmd,
290 		NULL,
291 	},
292 };
293 
294 cmdline_parse_ctx_t main_ctx[] = {
295 		(cmdline_parse_inst_t *)&cmd_quit,
296 		(cmdline_parse_inst_t *)&cmd_send_policy_set,
297 		(cmdline_parse_inst_t *)&cmd_set_cpu_freq_set,
298 		NULL,
299 };
300 
301 void
302 run_cli(__attribute__((unused)) void *arg)
303 {
304 	struct cmdline *cl;
305 
306 	cl = cmdline_stdin_new(main_ctx, "vmpower(guest)> ");
307 	if (cl == NULL)
308 		return;
309 
310 	cmdline_interact(cl);
311 	cmdline_stdin_exit(cl);
312 }
313