blob: de263712e247c2b8c47f450f3d1b7eb387f1e073 [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>
Ky Srinivasan245ba562010-12-16 18:54:16 -070030
Vitaly Kuznetsov3647a832015-04-11 18:07:39 -070031#include "hyperv_vmbus.h"
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -070032#include "hv_utils_transport.h"
Ky Srinivasan245ba562010-12-16 18:54:16 -070033
K. Y. Srinivasan67413352013-07-02 10:31:30 -070034/*
35 * Pre win8 version numbers used in ws2008 and ws 2008 r2 (win7)
36 */
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070037#define WS2008_SRV_MAJOR 1
38#define WS2008_SRV_MINOR 0
39#define WS2008_SRV_VERSION (WS2008_SRV_MAJOR << 16 | WS2008_SRV_MINOR)
40
K. Y. Srinivasan67413352013-07-02 10:31:30 -070041#define WIN7_SRV_MAJOR 3
42#define WIN7_SRV_MINOR 0
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070043#define WIN7_SRV_VERSION (WIN7_SRV_MAJOR << 16 | WIN7_SRV_MINOR)
K. Y. Srinivasan67413352013-07-02 10:31:30 -070044
45#define WIN8_SRV_MAJOR 4
46#define WIN8_SRV_MINOR 0
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070047#define WIN8_SRV_VERSION (WIN8_SRV_MAJOR << 16 | WIN8_SRV_MINOR)
Ky Srinivasan245ba562010-12-16 18:54:16 -070048
Alex Nga1656452017-01-28 12:37:17 -070049#define KVP_VER_COUNT 3
50static const int kvp_versions[] = {
51 WIN8_SRV_VERSION,
52 WIN7_SRV_VERSION,
53 WS2008_SRV_VERSION
54};
55
56#define FW_VER_COUNT 2
57static const int fw_versions[] = {
58 UTIL_FW_VERSION,
59 UTIL_WS2K8_FW_VERSION
60};
61
Ky Srinivasan245ba562010-12-16 18:54:16 -070062/*
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070063 * Global state maintained for transaction that is being processed. For a class
64 * of integration services, including the "KVP service", the specified protocol
65 * is a "request/response" protocol which means that there can only be single
66 * outstanding transaction from the host at any given point in time. We use
67 * this to simplify memory management in this driver - we cache and process
68 * only one message at a time.
Ky Srinivasan245ba562010-12-16 18:54:16 -070069 *
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070070 * While the request/response protocol is guaranteed by the host, we further
71 * ensure this by serializing packet processing in this driver - we do not
72 * read additional packets from the VMBUs until the current packet is fully
73 * handled.
Ky Srinivasan245ba562010-12-16 18:54:16 -070074 */
75
76static struct {
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070077 int state; /* hvutil_device_state */
Ky Srinivasan245ba562010-12-16 18:54:16 -070078 int recv_len; /* number of bytes received. */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -070079 struct hv_kvp_msg *kvp_msg; /* current message */
Ky Srinivasan245ba562010-12-16 18:54:16 -070080 struct vmbus_channel *recv_channel; /* chn we got the request */
81 u64 recv_req_id; /* request ID. */
82} kvp_transaction;
83
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070084/*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070085 * This state maintains the version number registered by the daemon.
86 */
87static int dm_reg_value;
88
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070089static void kvp_send_key(struct work_struct *dummy);
Ky Srinivasan245ba562010-12-16 18:54:16 -070090
K. Y. Srinivasan76e5f812011-10-04 14:00:02 -070091
K. Y. Srinivasan03db7722012-08-16 18:32:12 -070092static void kvp_respond_to_host(struct hv_kvp_msg *msg, int error);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070093static void kvp_timeout_func(struct work_struct *dummy);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -070094static void kvp_host_handshake_func(struct work_struct *dummy);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070095static void kvp_register(int);
Ky Srinivasan245ba562010-12-16 18:54:16 -070096
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070097static DECLARE_DELAYED_WORK(kvp_timeout_work, kvp_timeout_func);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -070098static DECLARE_DELAYED_WORK(kvp_host_handshake_work, kvp_host_handshake_func);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070099static DECLARE_WORK(kvp_sendkey_work, kvp_send_key);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700100
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700101static const char kvp_devname[] = "vmbus/hv_kvp";
Ky Srinivasan245ba562010-12-16 18:54:16 -0700102static u8 *recv_buffer;
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700103static struct hvutil_transport *hvt;
K. Y. Srinivasan5a66fec2016-12-22 16:54:01 -0800104static struct completion release_event;
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;
116 hv_kvp_onchannelcallback(channel);
117}
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{
163 hv_poll_channel(kvp_transaction.recv_channel, hv_kvp_onchannelcallback);
164}
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,
308 MAX_IP_ADDR_SIZE);
309 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
357 default:
358 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
359 MAX_ADAPTER_ID_SIZE,
360 UTF16_LITTLE_ENDIAN,
361 (__u8 *)out->body.kvp_ip_val.adapter_id,
362 MAX_ADAPTER_ID_SIZE);
363
364 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
365 }
366}
367
368
369
370
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700371static void
372kvp_send_key(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700373{
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800374 struct hv_kvp_msg *message;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700375 struct hv_kvp_msg *in_msg;
376 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
377 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
378 __u32 val32;
379 __u64 val64;
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100380 int rc;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700381
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700382 /* The transaction state is wrong. */
383 if (kvp_transaction.state != HVUTIL_HOSTMSG_RECEIVED)
384 return;
385
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700386 message = kzalloc(sizeof(*message), GFP_KERNEL);
Vitaly Kuznetsovb36fda332015-08-01 16:08:11 -0700387 if (!message)
388 return;
389
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700390 message->kvp_hdr.operation = operation;
391 message->kvp_hdr.pool = pool;
392 in_msg = kvp_transaction.kvp_msg;
393
394 /*
395 * The key/value strings sent from the host are encoded in
396 * in utf16; convert it to utf8 strings.
397 * The host assures us that the utf16 strings will not exceed
398 * the max lengths specified. We will however, reserve room
399 * for the string terminating character - in the utf16s_utf8s()
400 * function we limit the size of the buffer where the converted
401 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
402 * that the strings can be properly terminated!
403 */
404
405 switch (message->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700406 case KVP_OP_SET_IP_INFO:
407 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
408 break;
409 case KVP_OP_GET_IP_INFO:
410 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
411 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700412 case KVP_OP_SET:
413 switch (in_msg->body.kvp_set.data.value_type) {
414 case REG_SZ:
415 /*
416 * The value is a string - utf16 encoding.
417 */
418 message->body.kvp_set.data.value_size =
419 utf16s_to_utf8s(
420 (wchar_t *)in_msg->body.kvp_set.data.value,
421 in_msg->body.kvp_set.data.value_size,
422 UTF16_LITTLE_ENDIAN,
423 message->body.kvp_set.data.value,
424 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
425 break;
426
427 case REG_U32:
428 /*
429 * The value is a 32 bit scalar.
430 * We save this as a utf8 string.
431 */
432 val32 = in_msg->body.kvp_set.data.value_u32;
433 message->body.kvp_set.data.value_size =
434 sprintf(message->body.kvp_set.data.value,
435 "%d", val32) + 1;
436 break;
437
438 case REG_U64:
439 /*
440 * The value is a 64 bit scalar.
441 * We save this as a utf8 string.
442 */
443 val64 = in_msg->body.kvp_set.data.value_u64;
444 message->body.kvp_set.data.value_size =
445 sprintf(message->body.kvp_set.data.value,
446 "%llu", val64) + 1;
447 break;
448
449 }
450 case KVP_OP_GET:
451 message->body.kvp_set.data.key_size =
452 utf16s_to_utf8s(
453 (wchar_t *)in_msg->body.kvp_set.data.key,
454 in_msg->body.kvp_set.data.key_size,
455 UTF16_LITTLE_ENDIAN,
456 message->body.kvp_set.data.key,
457 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
458 break;
459
460 case KVP_OP_DELETE:
461 message->body.kvp_delete.key_size =
462 utf16s_to_utf8s(
463 (wchar_t *)in_msg->body.kvp_delete.key,
464 in_msg->body.kvp_delete.key_size,
465 UTF16_LITTLE_ENDIAN,
466 message->body.kvp_delete.key,
467 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
468 break;
469
470 case KVP_OP_ENUMERATE:
471 message->body.kvp_enum_data.index =
472 in_msg->body.kvp_enum_data.index;
473 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700474 }
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700475
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700476 kvp_transaction.state = HVUTIL_USERSPACE_REQ;
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700477 rc = hvutil_transport_send(hvt, message, sizeof(*message), NULL);
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100478 if (rc) {
479 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700480 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100481 kvp_respond_to_host(message, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700482 kvp_transaction.state = HVUTIL_READY;
483 }
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100484 }
485
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700486 kfree(message);
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700487
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700488 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700489}
490
491/*
492 * Send a response back to the host.
493 */
494
495static void
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700496kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700497{
498 struct hv_kvp_msg *kvp_msg;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700499 struct hv_kvp_exchg_msg_value *kvp_data;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700500 char *key_name;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700501 char *value;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700502 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700503 int keylen = 0;
504 int valuelen = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700505 u32 buf_len;
506 struct vmbus_channel *channel;
507 u64 req_id;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700508 int ret;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700509
510 /*
Ky Srinivasan245ba562010-12-16 18:54:16 -0700511 * Copy the global state for completing the transaction. Note that
512 * only one transaction can be active at a time.
513 */
514
515 buf_len = kvp_transaction.recv_len;
516 channel = kvp_transaction.recv_channel;
517 req_id = kvp_transaction.recv_req_id;
518
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700519 icmsghdrp = (struct icmsg_hdr *)
520 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
521
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700522 if (channel->onchannel_callback == NULL)
523 /*
524 * We have raced with util driver being unloaded;
525 * silently return.
526 */
527 return;
528
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700529 icmsghdrp->status = error;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700530
531 /*
K. Y. Srinivasanadc80ae2012-03-16 08:02:27 -0700532 * If the error parameter is set, terminate the host's enumeration
533 * on this pool.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700534 */
535 if (error) {
536 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700537 * Something failed or we have timedout;
538 * terminate the current host-side iteration.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700539 */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700540 goto response_done;
541 }
542
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700543 kvp_msg = (struct hv_kvp_msg *)
544 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
545 sizeof(struct icmsg_hdr)];
546
547 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700548 case KVP_OP_GET_IP_INFO:
549 ret = process_ob_ipinfo(msg_to_host,
550 (struct hv_kvp_ip_msg *)kvp_msg,
551 KVP_OP_GET_IP_INFO);
552 if (ret < 0)
553 icmsghdrp->status = HV_E_FAIL;
554
555 goto response_done;
556 case KVP_OP_SET_IP_INFO:
557 goto response_done;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700558 case KVP_OP_GET:
559 kvp_data = &kvp_msg->body.kvp_get.data;
560 goto copy_value;
561
562 case KVP_OP_SET:
563 case KVP_OP_DELETE:
564 goto response_done;
565
566 default:
567 break;
568 }
569
570 kvp_data = &kvp_msg->body.kvp_enum_data.data;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700571 key_name = msg_to_host->body.kvp_enum_data.data.key;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700572
Ky Srinivasan245ba562010-12-16 18:54:16 -0700573 /*
574 * The windows host expects the key/value pair to be encoded
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700575 * in utf16. Ensure that the key/value size reported to the host
576 * will be less than or equal to the MAX size (including the
577 * terminating character).
Ky Srinivasan245ba562010-12-16 18:54:16 -0700578 */
Alan Stern0720a062011-11-17 16:42:19 -0500579 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700580 (wchar_t *) kvp_data->key,
581 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
582 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700583
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700584copy_value:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700585 value = msg_to_host->body.kvp_enum_data.data.value;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700586 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
587 (wchar_t *) kvp_data->value,
588 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
589 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
590
591 /*
592 * If the utf8s to utf16s conversion failed; notify host
593 * of the error.
594 */
595 if ((keylen < 0) || (valuelen < 0))
596 icmsghdrp->status = HV_E_FAIL;
597
598 kvp_data->value_type = REG_SZ; /* all our values are strings */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700599
600response_done:
601 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
602
603 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800604 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700605}
606
607/*
608 * This callback is invoked when we get a KVP message from the host.
609 * The host ensures that only one KVP transaction can be active at a time.
610 * KVP implementation in Linux needs to forward the key to a user-mde
611 * component to retrive the corresponding value. Consequently, we cannot
612 * respond to the host in the conext of this callback. Since the host
613 * guarantees that at most only one transaction can be active at a time,
614 * we stash away the transaction state in a set of global variables.
615 */
616
617void hv_kvp_onchannelcallback(void *context)
618{
619 struct vmbus_channel *channel = context;
620 u32 recvlen;
621 u64 requestid;
622
623 struct hv_kvp_msg *kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700624
625 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700626 int kvp_srv_version;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700627 static enum {NEGO_NOT_STARTED,
628 NEGO_IN_PROGRESS,
629 NEGO_FINISHED} host_negotiatied = NEGO_NOT_STARTED;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700630
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700631 if (host_negotiatied == NEGO_NOT_STARTED &&
632 kvp_transaction.state < HVUTIL_READY) {
633 /*
634 * If userspace daemon is not connected and host is asking
635 * us to negotiate we need to delay to not lose messages.
636 * This is important for Failover IP setting.
637 */
638 host_negotiatied = NEGO_IN_PROGRESS;
639 schedule_delayed_work(&kvp_host_handshake_work,
640 HV_UTIL_NEGO_TIMEOUT * HZ);
641 return;
642 }
Olaf Hering3cace4a2015-12-14 16:01:33 -0800643 if (kvp_transaction.state > HVUTIL_READY)
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700644 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700645
K. Y. Srinivasan9bd2d0d2014-07-07 16:34:25 -0700646 vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 4, &recvlen,
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700647 &requestid);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700648
649 if (recvlen > 0) {
Ky Srinivasan245ba562010-12-16 18:54:16 -0700650 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
651 sizeof(struct vmbuspipe_hdr)];
652
653 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
Alex Ng1274a692017-01-28 12:37:18 -0700654 if (vmbus_prep_negotiate_resp(icmsghdrp,
Alex Nga1656452017-01-28 12:37:17 -0700655 recv_buffer, fw_versions, FW_VER_COUNT,
656 kvp_versions, KVP_VER_COUNT,
Alex Ng1274a692017-01-28 12:37:18 -0700657 NULL, &kvp_srv_version)) {
658 pr_info("KVP IC version %d.%d\n",
659 kvp_srv_version >> 16,
660 kvp_srv_version & 0xFFFF);
661 }
Ky Srinivasan245ba562010-12-16 18:54:16 -0700662 } else {
663 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
664 sizeof(struct vmbuspipe_hdr) +
665 sizeof(struct icmsg_hdr)];
666
Ky Srinivasan245ba562010-12-16 18:54:16 -0700667 /*
668 * Stash away this global state for completing the
669 * transaction; note transactions are serialized.
670 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700671
Ky Srinivasan245ba562010-12-16 18:54:16 -0700672 kvp_transaction.recv_len = recvlen;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700673 kvp_transaction.recv_req_id = requestid;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700674 kvp_transaction.kvp_msg = kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700675
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700676 if (kvp_transaction.state < HVUTIL_READY) {
677 /* Userspace is not registered yet */
678 kvp_respond_to_host(NULL, HV_E_FAIL);
679 return;
680 }
681 kvp_transaction.state = HVUTIL_HOSTMSG_RECEIVED;
682
Ky Srinivasan245ba562010-12-16 18:54:16 -0700683 /*
684 * Get the information from the
685 * user-mode component.
686 * component. This transaction will be
687 * completed when we get the value from
688 * the user-mode component.
689 * Set a timeout to deal with
690 * user-mode not responding.
691 */
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700692 schedule_work(&kvp_sendkey_work);
K. Y. Srinivasanc0b200c2015-12-14 16:01:32 -0800693 schedule_delayed_work(&kvp_timeout_work,
694 HV_UTIL_TIMEOUT * HZ);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700695
696 return;
697
698 }
699
Ky Srinivasan245ba562010-12-16 18:54:16 -0700700 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
701 | ICMSGHDRFLAG_RESPONSE;
702
703 vmbus_sendpacket(channel, recv_buffer,
704 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800705 VM_PKT_DATA_INBAND, 0);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700706
707 host_negotiatied = NEGO_FINISHED;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700708 }
709
710}
711
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700712static void kvp_on_reset(void)
713{
714 if (cancel_delayed_work_sync(&kvp_timeout_work))
715 kvp_respond_to_host(NULL, HV_E_FAIL);
716 kvp_transaction.state = HVUTIL_DEVICE_INIT;
K. Y. Srinivasan5a66fec2016-12-22 16:54:01 -0800717 complete(&release_event);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700718}
719
Ky Srinivasan245ba562010-12-16 18:54:16 -0700720int
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700721hv_kvp_init(struct hv_util_service *srv)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700722{
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700723 recv_buffer = srv->recv_buffer;
K. Y. Srinivasanb9830d12016-02-26 15:13:19 -0800724 kvp_transaction.recv_channel = srv->channel;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700725
K. Y. Srinivasan5a66fec2016-12-22 16:54:01 -0800726 init_completion(&release_event);
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700727 /*
728 * When this driver loads, the user level daemon that
729 * processes the host requests may not yet be running.
730 * Defer processing channel callbacks until the daemon
731 * has registered.
732 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700733 kvp_transaction.state = HVUTIL_DEVICE_INIT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700734
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700735 hvt = hvutil_transport_init(kvp_devname, CN_KVP_IDX, CN_KVP_VAL,
736 kvp_on_msg, kvp_on_reset);
737 if (!hvt)
738 return -EFAULT;
739
Ky Srinivasan245ba562010-12-16 18:54:16 -0700740 return 0;
741}
742
743void hv_kvp_deinit(void)
744{
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700745 kvp_transaction.state = HVUTIL_DEVICE_DYING;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700746 cancel_delayed_work_sync(&kvp_host_handshake_work);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700747 cancel_delayed_work_sync(&kvp_timeout_work);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700748 cancel_work_sync(&kvp_sendkey_work);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700749 hvutil_transport_destroy(hvt);
K. Y. Srinivasan5a66fec2016-12-22 16:54:01 -0800750 wait_for_completion(&release_event);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700751}