blob: e74b144b8f3d40be819f59b0d13bc1181d8bdcb5 [file] [log] [blame]
Ky Srinivasan245ba562010-12-16 18:54:16 -07001/*
2 * An implementation of key value pair (KVP) functionality for Linux.
3 *
4 *
5 * Copyright (C) 2010, Novell, Inc.
6 * Author : K. Y. Srinivasan <ksrinivasan@novell.com>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published
10 * by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
15 * NON INFRINGEMENT. See the GNU General Public License for more
16 * details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 */
Hank Janssenaf7a5b62011-03-29 13:58:49 -070023#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
Ky Srinivasan245ba562010-12-16 18:54:16 -070024
25#include <linux/net.h>
26#include <linux/nls.h>
27#include <linux/connector.h>
28#include <linux/workqueue.h>
Greg Kroah-Hartman46a97192011-10-04 12:29:52 -070029#include <linux/hyperv.h>
Himadri Pandyab14d7492019-07-25 05:03:14 +000030#include <asm/hyperv-tlfs.h>
Ky Srinivasan245ba562010-12-16 18:54:16 -070031
Vitaly Kuznetsov3647a832015-04-11 18:07:39 -070032#include "hyperv_vmbus.h"
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -070033#include "hv_utils_transport.h"
Ky Srinivasan245ba562010-12-16 18:54:16 -070034
K. Y. Srinivasan67413352013-07-02 10:31:30 -070035/*
36 * Pre win8 version numbers used in ws2008 and ws 2008 r2 (win7)
37 */
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070038#define WS2008_SRV_MAJOR 1
39#define WS2008_SRV_MINOR 0
40#define WS2008_SRV_VERSION (WS2008_SRV_MAJOR << 16 | WS2008_SRV_MINOR)
41
K. Y. Srinivasan67413352013-07-02 10:31:30 -070042#define WIN7_SRV_MAJOR 3
43#define WIN7_SRV_MINOR 0
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070044#define WIN7_SRV_VERSION (WIN7_SRV_MAJOR << 16 | WIN7_SRV_MINOR)
K. Y. Srinivasan67413352013-07-02 10:31:30 -070045
46#define WIN8_SRV_MAJOR 4
47#define WIN8_SRV_MINOR 0
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070048#define WIN8_SRV_VERSION (WIN8_SRV_MAJOR << 16 | WIN8_SRV_MINOR)
Ky Srinivasan245ba562010-12-16 18:54:16 -070049
Alex Nga1656452017-01-28 12:37:17 -070050#define KVP_VER_COUNT 3
51static const int kvp_versions[] = {
52 WIN8_SRV_VERSION,
53 WIN7_SRV_VERSION,
54 WS2008_SRV_VERSION
55};
56
57#define FW_VER_COUNT 2
58static const int fw_versions[] = {
59 UTIL_FW_VERSION,
60 UTIL_WS2K8_FW_VERSION
61};
62
Ky Srinivasan245ba562010-12-16 18:54:16 -070063/*
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070064 * Global state maintained for transaction that is being processed. For a class
65 * of integration services, including the "KVP service", the specified protocol
66 * is a "request/response" protocol which means that there can only be single
67 * outstanding transaction from the host at any given point in time. We use
68 * this to simplify memory management in this driver - we cache and process
69 * only one message at a time.
Ky Srinivasan245ba562010-12-16 18:54:16 -070070 *
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070071 * While the request/response protocol is guaranteed by the host, we further
72 * ensure this by serializing packet processing in this driver - we do not
Stephen Hemmingerbdc1dd42017-03-04 18:27:14 -070073 * read additional packets from the VMBUS until the current packet is fully
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070074 * handled.
Ky Srinivasan245ba562010-12-16 18:54:16 -070075 */
76
77static struct {
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070078 int state; /* hvutil_device_state */
Ky Srinivasan245ba562010-12-16 18:54:16 -070079 int recv_len; /* number of bytes received. */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -070080 struct hv_kvp_msg *kvp_msg; /* current message */
Ky Srinivasan245ba562010-12-16 18:54:16 -070081 struct vmbus_channel *recv_channel; /* chn we got the request */
82 u64 recv_req_id; /* request ID. */
83} kvp_transaction;
84
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070085/*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070086 * This state maintains the version number registered by the daemon.
87 */
88static int dm_reg_value;
89
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070090static void kvp_send_key(struct work_struct *dummy);
Ky Srinivasan245ba562010-12-16 18:54:16 -070091
K. Y. Srinivasan76e5f812011-10-04 14:00:02 -070092
K. Y. Srinivasan03db7722012-08-16 18:32:12 -070093static void kvp_respond_to_host(struct hv_kvp_msg *msg, int error);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070094static void kvp_timeout_func(struct work_struct *dummy);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -070095static void kvp_host_handshake_func(struct work_struct *dummy);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070096static void kvp_register(int);
Ky Srinivasan245ba562010-12-16 18:54:16 -070097
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070098static DECLARE_DELAYED_WORK(kvp_timeout_work, kvp_timeout_func);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -070099static DECLARE_DELAYED_WORK(kvp_host_handshake_work, kvp_host_handshake_func);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700100static DECLARE_WORK(kvp_sendkey_work, kvp_send_key);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700101
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700102static const char kvp_devname[] = "vmbus/hv_kvp";
Ky Srinivasan245ba562010-12-16 18:54:16 -0700103static u8 *recv_buffer;
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700104static struct hvutil_transport *hvt;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700105/*
106 * Register the kernel component with the user-level daemon.
107 * As part of this registration, pass the LIC version number.
Olaf Heringcfc25992013-05-29 11:29:07 +0200108 * This number has no meaning, it satisfies the registration protocol.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700109 */
Olaf Heringcfc25992013-05-29 11:29:07 +0200110#define HV_DRV_VERSION "3.1"
Ky Srinivasan245ba562010-12-16 18:54:16 -0700111
Olaf Hering3cace4a2015-12-14 16:01:33 -0800112static void kvp_poll_wrapper(void *channel)
113{
114 /* Transaction is finished, reset the state here to avoid races. */
115 kvp_transaction.state = HVUTIL_READY;
Long Lia3ade8c2017-04-30 16:21:19 -0700116 tasklet_schedule(&((struct vmbus_channel *)channel)->callback_event);
Olaf Hering3cace4a2015-12-14 16:01:33 -0800117}
118
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700119static void kvp_register_done(void)
120{
121 /*
122 * If we're still negotiating with the host cancel the timeout
123 * work to not poll the channel twice.
124 */
125 pr_debug("KVP: userspace daemon registered\n");
126 cancel_delayed_work_sync(&kvp_host_handshake_work);
127 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
128}
129
Ky Srinivasan245ba562010-12-16 18:54:16 -0700130static void
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700131kvp_register(int reg_value)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700132{
133
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800134 struct hv_kvp_msg *kvp_msg;
135 char *version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700136
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700137 kvp_msg = kzalloc(sizeof(*kvp_msg), GFP_KERNEL);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700138
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700139 if (kvp_msg) {
K. Y. Srinivasane485ceac2012-03-10 15:32:08 -0800140 version = kvp_msg->body.kvp_register.version;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700141 kvp_msg->kvp_hdr.operation = reg_value;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800142 strcpy(version, HV_DRV_VERSION);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700143
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700144 hvutil_transport_send(hvt, kvp_msg, sizeof(*kvp_msg),
145 kvp_register_done);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700146 kfree(kvp_msg);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700147 }
148}
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700149
150static void kvp_timeout_func(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700151{
152 /*
153 * If the timer fires, the user-mode component has not responded;
154 * process the pending transaction.
155 */
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700156 kvp_respond_to_host(NULL, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700157
Olaf Hering3cace4a2015-12-14 16:01:33 -0800158 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700159}
160
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700161static void kvp_host_handshake_func(struct work_struct *dummy)
162{
Long Lia3ade8c2017-04-30 16:21:19 -0700163 tasklet_schedule(&kvp_transaction.recv_channel->callback_event);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700164}
165
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700166static int kvp_handle_handshake(struct hv_kvp_msg *msg)
167{
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700168 switch (msg->kvp_hdr.operation) {
169 case KVP_OP_REGISTER:
170 dm_reg_value = KVP_OP_REGISTER;
171 pr_info("KVP: IP injection functionality not available\n");
172 pr_info("KVP: Upgrade the KVP daemon\n");
173 break;
174 case KVP_OP_REGISTER1:
175 dm_reg_value = KVP_OP_REGISTER1;
176 break;
177 default:
178 pr_info("KVP: incompatible daemon\n");
179 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
180 KVP_OP_REGISTER1, msg->kvp_hdr.operation);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700181 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700182 }
183
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700184 /*
185 * We have a compatible daemon; complete the handshake.
186 */
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700187 pr_debug("KVP: userspace daemon ver. %d connected\n",
188 msg->kvp_hdr.operation);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700189 kvp_register(dm_reg_value);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700190
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700191 return 0;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700192}
193
194
Ky Srinivasan245ba562010-12-16 18:54:16 -0700195/*
196 * Callback when data is received from user mode.
197 */
198
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700199static int kvp_on_msg(void *msg, int len)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700200{
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700201 struct hv_kvp_msg *message = (struct hv_kvp_msg *)msg;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800202 struct hv_kvp_msg_enumerate *data;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700203 int error = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700204
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700205 if (len < sizeof(*message))
206 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700207
208 /*
209 * If we are negotiating the version information
210 * with the daemon; handle that first.
211 */
212
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700213 if (kvp_transaction.state < HVUTIL_READY) {
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700214 return kvp_handle_handshake(message);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700215 }
216
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700217 /* We didn't send anything to userspace so the reply is spurious */
218 if (kvp_transaction.state < HVUTIL_USERSPACE_REQ)
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700219 return -EINVAL;
220
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700221 kvp_transaction.state = HVUTIL_USERSPACE_RECV;
222
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700223 /*
224 * Based on the version of the daemon, we propagate errors from the
225 * daemon differently.
226 */
227
228 data = &message->body.kvp_enum_data;
229
230 switch (dm_reg_value) {
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700231 case KVP_OP_REGISTER:
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700232 /*
233 * Null string is used to pass back error condition.
234 */
235 if (data->data.key[0] == 0)
236 error = HV_S_CONT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700237 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700238
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700239 case KVP_OP_REGISTER1:
Ky Srinivasan245ba562010-12-16 18:54:16 -0700240 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700241 * We use the message header information from
242 * the user level daemon to transmit errors.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700243 */
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700244 error = message->error;
245 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700246 }
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700247
248 /*
249 * Complete the transaction by forwarding the key value
250 * to the host. But first, cancel the timeout.
251 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700252 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700253 kvp_respond_to_host(message, error);
Olaf Hering3cace4a2015-12-14 16:01:33 -0800254 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700255 }
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700256
257 return 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700258}
259
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700260
261static int process_ob_ipinfo(void *in_msg, void *out_msg, int op)
262{
263 struct hv_kvp_msg *in = in_msg;
264 struct hv_kvp_ip_msg *out = out_msg;
265 int len;
266
267 switch (op) {
268 case KVP_OP_GET_IP_INFO:
269 /*
270 * Transform all parameters into utf16 encoding.
271 */
272 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.ip_addr,
273 strlen((char *)in->body.kvp_ip_val.ip_addr),
274 UTF16_HOST_ENDIAN,
275 (wchar_t *)out->kvp_ip_val.ip_addr,
276 MAX_IP_ADDR_SIZE);
277 if (len < 0)
278 return len;
279
280 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.sub_net,
281 strlen((char *)in->body.kvp_ip_val.sub_net),
282 UTF16_HOST_ENDIAN,
283 (wchar_t *)out->kvp_ip_val.sub_net,
284 MAX_IP_ADDR_SIZE);
285 if (len < 0)
286 return len;
287
288 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.gate_way,
289 strlen((char *)in->body.kvp_ip_val.gate_way),
290 UTF16_HOST_ENDIAN,
291 (wchar_t *)out->kvp_ip_val.gate_way,
292 MAX_GATEWAY_SIZE);
293 if (len < 0)
294 return len;
295
296 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.dns_addr,
297 strlen((char *)in->body.kvp_ip_val.dns_addr),
298 UTF16_HOST_ENDIAN,
299 (wchar_t *)out->kvp_ip_val.dns_addr,
300 MAX_IP_ADDR_SIZE);
301 if (len < 0)
302 return len;
303
304 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.adapter_id,
305 strlen((char *)in->body.kvp_ip_val.adapter_id),
306 UTF16_HOST_ENDIAN,
307 (wchar_t *)out->kvp_ip_val.adapter_id,
Alex Ngddce54b2017-08-06 13:12:56 -0700308 MAX_ADAPTER_ID_SIZE);
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700309 if (len < 0)
310 return len;
311
312 out->kvp_ip_val.dhcp_enabled =
313 in->body.kvp_ip_val.dhcp_enabled;
K. Y. Srinivasana500e0e2012-09-04 17:54:13 -0700314 out->kvp_ip_val.addr_family =
315 in->body.kvp_ip_val.addr_family;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700316 }
317
318 return 0;
319}
320
321static void process_ib_ipinfo(void *in_msg, void *out_msg, int op)
322{
323 struct hv_kvp_ip_msg *in = in_msg;
324 struct hv_kvp_msg *out = out_msg;
325
326 switch (op) {
327 case KVP_OP_SET_IP_INFO:
328 /*
329 * Transform all parameters into utf8 encoding.
330 */
331 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.ip_addr,
332 MAX_IP_ADDR_SIZE,
333 UTF16_LITTLE_ENDIAN,
334 (__u8 *)out->body.kvp_ip_val.ip_addr,
335 MAX_IP_ADDR_SIZE);
336
337 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.sub_net,
338 MAX_IP_ADDR_SIZE,
339 UTF16_LITTLE_ENDIAN,
340 (__u8 *)out->body.kvp_ip_val.sub_net,
341 MAX_IP_ADDR_SIZE);
342
343 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.gate_way,
344 MAX_GATEWAY_SIZE,
345 UTF16_LITTLE_ENDIAN,
346 (__u8 *)out->body.kvp_ip_val.gate_way,
347 MAX_GATEWAY_SIZE);
348
349 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.dns_addr,
350 MAX_IP_ADDR_SIZE,
351 UTF16_LITTLE_ENDIAN,
352 (__u8 *)out->body.kvp_ip_val.dns_addr,
353 MAX_IP_ADDR_SIZE);
354
355 out->body.kvp_ip_val.dhcp_enabled = in->kvp_ip_val.dhcp_enabled;
356
Dexuan Cuie670de52018-10-18 05:09:30 +0000357 /* fallthrough */
358
359 case KVP_OP_GET_IP_INFO:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700360 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
361 MAX_ADAPTER_ID_SIZE,
362 UTF16_LITTLE_ENDIAN,
363 (__u8 *)out->body.kvp_ip_val.adapter_id,
364 MAX_ADAPTER_ID_SIZE);
365
366 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
367 }
368}
369
370
371
372
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700373static void
374kvp_send_key(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700375{
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800376 struct hv_kvp_msg *message;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700377 struct hv_kvp_msg *in_msg;
378 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
379 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
380 __u32 val32;
381 __u64 val64;
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100382 int rc;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700383
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700384 /* The transaction state is wrong. */
385 if (kvp_transaction.state != HVUTIL_HOSTMSG_RECEIVED)
386 return;
387
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700388 message = kzalloc(sizeof(*message), GFP_KERNEL);
Vitaly Kuznetsovb36fda332015-08-01 16:08:11 -0700389 if (!message)
390 return;
391
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700392 message->kvp_hdr.operation = operation;
393 message->kvp_hdr.pool = pool;
394 in_msg = kvp_transaction.kvp_msg;
395
396 /*
397 * The key/value strings sent from the host are encoded in
398 * in utf16; convert it to utf8 strings.
399 * The host assures us that the utf16 strings will not exceed
400 * the max lengths specified. We will however, reserve room
401 * for the string terminating character - in the utf16s_utf8s()
402 * function we limit the size of the buffer where the converted
Stephen Hemmingerbdc1dd42017-03-04 18:27:14 -0700403 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to guarantee
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700404 * that the strings can be properly terminated!
405 */
406
407 switch (message->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700408 case KVP_OP_SET_IP_INFO:
409 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
410 break;
411 case KVP_OP_GET_IP_INFO:
Dexuan Cuie670de52018-10-18 05:09:30 +0000412 /*
413 * We only need to pass on the info of operation, adapter_id
414 * and addr_family to the userland kvp daemon.
415 */
416 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700417 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700418 case KVP_OP_SET:
419 switch (in_msg->body.kvp_set.data.value_type) {
420 case REG_SZ:
421 /*
422 * The value is a string - utf16 encoding.
423 */
424 message->body.kvp_set.data.value_size =
425 utf16s_to_utf8s(
426 (wchar_t *)in_msg->body.kvp_set.data.value,
427 in_msg->body.kvp_set.data.value_size,
428 UTF16_LITTLE_ENDIAN,
429 message->body.kvp_set.data.value,
430 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
Dexuan Cuid544c222018-09-23 21:10:42 +0000431 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700432
433 case REG_U32:
434 /*
435 * The value is a 32 bit scalar.
436 * We save this as a utf8 string.
437 */
438 val32 = in_msg->body.kvp_set.data.value_u32;
439 message->body.kvp_set.data.value_size =
440 sprintf(message->body.kvp_set.data.value,
Dexuan Cui16d13422018-10-18 05:09:31 +0000441 "%u", val32) + 1;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700442 break;
443
444 case REG_U64:
445 /*
446 * The value is a 64 bit scalar.
447 * We save this as a utf8 string.
448 */
449 val64 = in_msg->body.kvp_set.data.value_u64;
450 message->body.kvp_set.data.value_size =
451 sprintf(message->body.kvp_set.data.value,
452 "%llu", val64) + 1;
453 break;
454
455 }
Dexuan Cuifc62c3b2018-09-23 21:10:43 +0000456
Dexuan Cuie670de52018-10-18 05:09:30 +0000457 /*
458 * The key is always a string - utf16 encoding.
459 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700460 message->body.kvp_set.data.key_size =
461 utf16s_to_utf8s(
462 (wchar_t *)in_msg->body.kvp_set.data.key,
463 in_msg->body.kvp_set.data.key_size,
464 UTF16_LITTLE_ENDIAN,
465 message->body.kvp_set.data.key,
466 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
Dexuan Cuie670de52018-10-18 05:09:30 +0000467
468 break;
469
470 case KVP_OP_GET:
471 message->body.kvp_get.data.key_size =
472 utf16s_to_utf8s(
473 (wchar_t *)in_msg->body.kvp_get.data.key,
474 in_msg->body.kvp_get.data.key_size,
475 UTF16_LITTLE_ENDIAN,
476 message->body.kvp_get.data.key,
477 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
Dexuan Cuid544c222018-09-23 21:10:42 +0000478 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700479
480 case KVP_OP_DELETE:
481 message->body.kvp_delete.key_size =
482 utf16s_to_utf8s(
483 (wchar_t *)in_msg->body.kvp_delete.key,
484 in_msg->body.kvp_delete.key_size,
485 UTF16_LITTLE_ENDIAN,
486 message->body.kvp_delete.key,
487 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
Dexuan Cuid544c222018-09-23 21:10:42 +0000488 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700489
490 case KVP_OP_ENUMERATE:
491 message->body.kvp_enum_data.index =
492 in_msg->body.kvp_enum_data.index;
Dexuan Cuid544c222018-09-23 21:10:42 +0000493 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700494 }
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700495
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700496 kvp_transaction.state = HVUTIL_USERSPACE_REQ;
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700497 rc = hvutil_transport_send(hvt, message, sizeof(*message), NULL);
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100498 if (rc) {
499 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700500 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100501 kvp_respond_to_host(message, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700502 kvp_transaction.state = HVUTIL_READY;
503 }
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100504 }
505
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700506 kfree(message);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700507}
508
509/*
510 * Send a response back to the host.
511 */
512
513static void
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700514kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700515{
516 struct hv_kvp_msg *kvp_msg;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700517 struct hv_kvp_exchg_msg_value *kvp_data;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700518 char *key_name;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700519 char *value;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700520 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700521 int keylen = 0;
522 int valuelen = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700523 u32 buf_len;
524 struct vmbus_channel *channel;
525 u64 req_id;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700526 int ret;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700527
528 /*
Ky Srinivasan245ba562010-12-16 18:54:16 -0700529 * Copy the global state for completing the transaction. Note that
530 * only one transaction can be active at a time.
531 */
532
533 buf_len = kvp_transaction.recv_len;
534 channel = kvp_transaction.recv_channel;
535 req_id = kvp_transaction.recv_req_id;
536
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700537 icmsghdrp = (struct icmsg_hdr *)
538 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
539
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700540 if (channel->onchannel_callback == NULL)
541 /*
542 * We have raced with util driver being unloaded;
543 * silently return.
544 */
545 return;
546
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700547 icmsghdrp->status = error;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700548
549 /*
K. Y. Srinivasanadc80ae2012-03-16 08:02:27 -0700550 * If the error parameter is set, terminate the host's enumeration
551 * on this pool.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700552 */
553 if (error) {
554 /*
Stephen Hemmingerbdc1dd42017-03-04 18:27:14 -0700555 * Something failed or we have timed out;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700556 * terminate the current host-side iteration.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700557 */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700558 goto response_done;
559 }
560
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700561 kvp_msg = (struct hv_kvp_msg *)
562 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
563 sizeof(struct icmsg_hdr)];
564
565 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700566 case KVP_OP_GET_IP_INFO:
567 ret = process_ob_ipinfo(msg_to_host,
568 (struct hv_kvp_ip_msg *)kvp_msg,
569 KVP_OP_GET_IP_INFO);
570 if (ret < 0)
571 icmsghdrp->status = HV_E_FAIL;
572
573 goto response_done;
574 case KVP_OP_SET_IP_INFO:
575 goto response_done;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700576 case KVP_OP_GET:
577 kvp_data = &kvp_msg->body.kvp_get.data;
578 goto copy_value;
579
580 case KVP_OP_SET:
581 case KVP_OP_DELETE:
582 goto response_done;
583
584 default:
585 break;
586 }
587
588 kvp_data = &kvp_msg->body.kvp_enum_data.data;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700589 key_name = msg_to_host->body.kvp_enum_data.data.key;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700590
Ky Srinivasan245ba562010-12-16 18:54:16 -0700591 /*
592 * The windows host expects the key/value pair to be encoded
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700593 * in utf16. Ensure that the key/value size reported to the host
594 * will be less than or equal to the MAX size (including the
595 * terminating character).
Ky Srinivasan245ba562010-12-16 18:54:16 -0700596 */
Alan Stern0720a062011-11-17 16:42:19 -0500597 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700598 (wchar_t *) kvp_data->key,
599 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
600 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700601
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700602copy_value:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700603 value = msg_to_host->body.kvp_enum_data.data.value;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700604 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
605 (wchar_t *) kvp_data->value,
606 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
607 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
608
609 /*
610 * If the utf8s to utf16s conversion failed; notify host
611 * of the error.
612 */
613 if ((keylen < 0) || (valuelen < 0))
614 icmsghdrp->status = HV_E_FAIL;
615
616 kvp_data->value_type = REG_SZ; /* all our values are strings */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700617
618response_done:
619 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
620
621 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800622 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700623}
624
625/*
626 * This callback is invoked when we get a KVP message from the host.
627 * The host ensures that only one KVP transaction can be active at a time.
628 * KVP implementation in Linux needs to forward the key to a user-mde
Stephen Hemmingerbdc1dd42017-03-04 18:27:14 -0700629 * component to retrieve the corresponding value. Consequently, we cannot
630 * respond to the host in the context of this callback. Since the host
Ky Srinivasan245ba562010-12-16 18:54:16 -0700631 * guarantees that at most only one transaction can be active at a time,
632 * we stash away the transaction state in a set of global variables.
633 */
634
635void hv_kvp_onchannelcallback(void *context)
636{
637 struct vmbus_channel *channel = context;
638 u32 recvlen;
639 u64 requestid;
640
641 struct hv_kvp_msg *kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700642
643 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700644 int kvp_srv_version;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700645 static enum {NEGO_NOT_STARTED,
646 NEGO_IN_PROGRESS,
647 NEGO_FINISHED} host_negotiatied = NEGO_NOT_STARTED;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700648
Long Lia3ade8c2017-04-30 16:21:19 -0700649 if (kvp_transaction.state < HVUTIL_READY) {
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700650 /*
651 * If userspace daemon is not connected and host is asking
652 * us to negotiate we need to delay to not lose messages.
653 * This is important for Failover IP setting.
654 */
Long Lia3ade8c2017-04-30 16:21:19 -0700655 if (host_negotiatied == NEGO_NOT_STARTED) {
656 host_negotiatied = NEGO_IN_PROGRESS;
657 schedule_delayed_work(&kvp_host_handshake_work,
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700658 HV_UTIL_NEGO_TIMEOUT * HZ);
Long Lia3ade8c2017-04-30 16:21:19 -0700659 }
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700660 return;
661 }
Olaf Hering3cace4a2015-12-14 16:01:33 -0800662 if (kvp_transaction.state > HVUTIL_READY)
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700663 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700664
Himadri Pandyab14d7492019-07-25 05:03:14 +0000665 vmbus_recvpacket(channel, recv_buffer, HV_HYP_PAGE_SIZE * 4, &recvlen,
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700666 &requestid);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700667
668 if (recvlen > 0) {
Ky Srinivasan245ba562010-12-16 18:54:16 -0700669 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
670 sizeof(struct vmbuspipe_hdr)];
671
672 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
Alex Ng1274a692017-01-28 12:37:18 -0700673 if (vmbus_prep_negotiate_resp(icmsghdrp,
Alex Nga1656452017-01-28 12:37:17 -0700674 recv_buffer, fw_versions, FW_VER_COUNT,
675 kvp_versions, KVP_VER_COUNT,
Alex Ng1274a692017-01-28 12:37:18 -0700676 NULL, &kvp_srv_version)) {
677 pr_info("KVP IC version %d.%d\n",
678 kvp_srv_version >> 16,
679 kvp_srv_version & 0xFFFF);
680 }
Ky Srinivasan245ba562010-12-16 18:54:16 -0700681 } else {
682 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
683 sizeof(struct vmbuspipe_hdr) +
684 sizeof(struct icmsg_hdr)];
685
Ky Srinivasan245ba562010-12-16 18:54:16 -0700686 /*
687 * Stash away this global state for completing the
688 * transaction; note transactions are serialized.
689 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700690
Ky Srinivasan245ba562010-12-16 18:54:16 -0700691 kvp_transaction.recv_len = recvlen;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700692 kvp_transaction.recv_req_id = requestid;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700693 kvp_transaction.kvp_msg = kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700694
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700695 if (kvp_transaction.state < HVUTIL_READY) {
696 /* Userspace is not registered yet */
697 kvp_respond_to_host(NULL, HV_E_FAIL);
698 return;
699 }
700 kvp_transaction.state = HVUTIL_HOSTMSG_RECEIVED;
701
Ky Srinivasan245ba562010-12-16 18:54:16 -0700702 /*
703 * Get the information from the
704 * user-mode component.
705 * component. This transaction will be
706 * completed when we get the value from
707 * the user-mode component.
708 * Set a timeout to deal with
709 * user-mode not responding.
710 */
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700711 schedule_work(&kvp_sendkey_work);
K. Y. Srinivasanc0b200c2015-12-14 16:01:32 -0800712 schedule_delayed_work(&kvp_timeout_work,
713 HV_UTIL_TIMEOUT * HZ);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700714
715 return;
716
717 }
718
Ky Srinivasan245ba562010-12-16 18:54:16 -0700719 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
720 | ICMSGHDRFLAG_RESPONSE;
721
722 vmbus_sendpacket(channel, recv_buffer,
723 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800724 VM_PKT_DATA_INBAND, 0);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700725
726 host_negotiatied = NEGO_FINISHED;
Long Lia3ade8c2017-04-30 16:21:19 -0700727 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700728 }
729
730}
731
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700732static void kvp_on_reset(void)
733{
734 if (cancel_delayed_work_sync(&kvp_timeout_work))
735 kvp_respond_to_host(NULL, HV_E_FAIL);
736 kvp_transaction.state = HVUTIL_DEVICE_INIT;
737}
738
Ky Srinivasan245ba562010-12-16 18:54:16 -0700739int
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700740hv_kvp_init(struct hv_util_service *srv)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700741{
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700742 recv_buffer = srv->recv_buffer;
K. Y. Srinivasanb9830d12016-02-26 15:13:19 -0800743 kvp_transaction.recv_channel = srv->channel;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700744
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700745 /*
746 * When this driver loads, the user level daemon that
747 * processes the host requests may not yet be running.
748 * Defer processing channel callbacks until the daemon
749 * has registered.
750 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700751 kvp_transaction.state = HVUTIL_DEVICE_INIT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700752
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700753 hvt = hvutil_transport_init(kvp_devname, CN_KVP_IDX, CN_KVP_VAL,
754 kvp_on_msg, kvp_on_reset);
755 if (!hvt)
756 return -EFAULT;
757
Ky Srinivasan245ba562010-12-16 18:54:16 -0700758 return 0;
759}
760
Dexuan Cui54e19d32020-01-25 21:49:44 -0800761static void hv_kvp_cancel_work(void)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700762{
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700763 cancel_delayed_work_sync(&kvp_host_handshake_work);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700764 cancel_delayed_work_sync(&kvp_timeout_work);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700765 cancel_work_sync(&kvp_sendkey_work);
Dexuan Cui54e19d32020-01-25 21:49:44 -0800766}
767
768int hv_kvp_pre_suspend(void)
769{
770 struct vmbus_channel *channel = kvp_transaction.recv_channel;
771
772 tasklet_disable(&channel->callback_event);
773
774 /*
775 * If there is a pending transtion, it's unnecessary to tell the host
776 * that the transaction will fail, because that is implied when
777 * util_suspend() calls vmbus_close() later.
778 */
779 hv_kvp_cancel_work();
780
781 /*
782 * Forece the state to READY to handle the ICMSGTYPE_NEGOTIATE message
783 * later. The user space daemon may go out of order and its write()
784 * may fail with EINVAL: this doesn't matter since the daemon will
785 * reset the device by closing and re-opening it.
786 */
787 kvp_transaction.state = HVUTIL_READY;
788 return 0;
789}
790
791int hv_kvp_pre_resume(void)
792{
793 struct vmbus_channel *channel = kvp_transaction.recv_channel;
794
795 tasklet_enable(&channel->callback_event);
796
797 return 0;
798}
799
800void hv_kvp_deinit(void)
801{
802 kvp_transaction.state = HVUTIL_DEVICE_DYING;
803
804 hv_kvp_cancel_work();
805
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700806 hvutil_transport_destroy(hvt);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700807}