blob: 9b9b370fe22a8b4295fd217e745bd9bde15c1f9e [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
49/*
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070050 * Global state maintained for transaction that is being processed. For a class
51 * of integration services, including the "KVP service", the specified protocol
52 * is a "request/response" protocol which means that there can only be single
53 * outstanding transaction from the host at any given point in time. We use
54 * this to simplify memory management in this driver - we cache and process
55 * only one message at a time.
Ky Srinivasan245ba562010-12-16 18:54:16 -070056 *
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070057 * While the request/response protocol is guaranteed by the host, we further
58 * ensure this by serializing packet processing in this driver - we do not
59 * read additional packets from the VMBUs until the current packet is fully
60 * handled.
Ky Srinivasan245ba562010-12-16 18:54:16 -070061 */
62
63static struct {
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070064 int state; /* hvutil_device_state */
Ky Srinivasan245ba562010-12-16 18:54:16 -070065 int recv_len; /* number of bytes received. */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -070066 struct hv_kvp_msg *kvp_msg; /* current message */
Ky Srinivasan245ba562010-12-16 18:54:16 -070067 struct vmbus_channel *recv_channel; /* chn we got the request */
68 u64 recv_req_id; /* request ID. */
69} kvp_transaction;
70
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070071/*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070072 * This state maintains the version number registered by the daemon.
73 */
74static int dm_reg_value;
75
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070076static void kvp_send_key(struct work_struct *dummy);
Ky Srinivasan245ba562010-12-16 18:54:16 -070077
K. Y. Srinivasan76e5f812011-10-04 14:00:02 -070078
K. Y. Srinivasan03db7722012-08-16 18:32:12 -070079static void kvp_respond_to_host(struct hv_kvp_msg *msg, int error);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070080static void kvp_timeout_func(struct work_struct *dummy);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070081static void kvp_register(int);
Ky Srinivasan245ba562010-12-16 18:54:16 -070082
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070083static DECLARE_DELAYED_WORK(kvp_timeout_work, kvp_timeout_func);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070084static DECLARE_WORK(kvp_sendkey_work, kvp_send_key);
Ky Srinivasan245ba562010-12-16 18:54:16 -070085
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -070086static const char kvp_devname[] = "vmbus/hv_kvp";
Ky Srinivasan245ba562010-12-16 18:54:16 -070087static u8 *recv_buffer;
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -070088static struct hvutil_transport *hvt;
Ky Srinivasan245ba562010-12-16 18:54:16 -070089/*
90 * Register the kernel component with the user-level daemon.
91 * As part of this registration, pass the LIC version number.
Olaf Heringcfc25992013-05-29 11:29:07 +020092 * This number has no meaning, it satisfies the registration protocol.
Ky Srinivasan245ba562010-12-16 18:54:16 -070093 */
Olaf Heringcfc25992013-05-29 11:29:07 +020094#define HV_DRV_VERSION "3.1"
Ky Srinivasan245ba562010-12-16 18:54:16 -070095
Olaf Hering3cace4a2015-12-14 16:01:33 -080096static void kvp_poll_wrapper(void *channel)
97{
98 /* Transaction is finished, reset the state here to avoid races. */
99 kvp_transaction.state = HVUTIL_READY;
100 hv_kvp_onchannelcallback(channel);
101}
102
Ky Srinivasan245ba562010-12-16 18:54:16 -0700103static void
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700104kvp_register(int reg_value)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700105{
106
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800107 struct hv_kvp_msg *kvp_msg;
108 char *version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700109
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700110 kvp_msg = kzalloc(sizeof(*kvp_msg), GFP_KERNEL);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700111
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700112 if (kvp_msg) {
K. Y. Srinivasane485ceac2012-03-10 15:32:08 -0800113 version = kvp_msg->body.kvp_register.version;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700114 kvp_msg->kvp_hdr.operation = reg_value;
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800115 strcpy(version, HV_DRV_VERSION);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700116
117 hvutil_transport_send(hvt, kvp_msg, sizeof(*kvp_msg));
118 kfree(kvp_msg);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700119 }
120}
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700121
122static void kvp_timeout_func(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700123{
124 /*
125 * If the timer fires, the user-mode component has not responded;
126 * process the pending transaction.
127 */
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700128 kvp_respond_to_host(NULL, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700129
Olaf Hering3cace4a2015-12-14 16:01:33 -0800130 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700131}
132
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700133static int kvp_handle_handshake(struct hv_kvp_msg *msg)
134{
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700135 switch (msg->kvp_hdr.operation) {
136 case KVP_OP_REGISTER:
137 dm_reg_value = KVP_OP_REGISTER;
138 pr_info("KVP: IP injection functionality not available\n");
139 pr_info("KVP: Upgrade the KVP daemon\n");
140 break;
141 case KVP_OP_REGISTER1:
142 dm_reg_value = KVP_OP_REGISTER1;
143 break;
144 default:
145 pr_info("KVP: incompatible daemon\n");
146 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
147 KVP_OP_REGISTER1, msg->kvp_hdr.operation);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700148 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700149 }
150
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700151 /*
152 * We have a compatible daemon; complete the handshake.
153 */
Vitaly Kuznetsov7c959122015-04-11 18:07:59 -0700154 pr_debug("KVP: userspace daemon ver. %d registered\n",
155 KVP_OP_REGISTER);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700156 kvp_register(dm_reg_value);
K. Y. Srinivasan2d0c3b52015-12-14 16:01:57 -0800157 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700158
159 return 0;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700160}
161
162
Ky Srinivasan245ba562010-12-16 18:54:16 -0700163/*
164 * Callback when data is received from user mode.
165 */
166
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700167static int kvp_on_msg(void *msg, int len)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700168{
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700169 struct hv_kvp_msg *message = (struct hv_kvp_msg *)msg;
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800170 struct hv_kvp_msg_enumerate *data;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700171 int error = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700172
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700173 if (len < sizeof(*message))
174 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700175
176 /*
177 * If we are negotiating the version information
178 * with the daemon; handle that first.
179 */
180
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700181 if (kvp_transaction.state < HVUTIL_READY) {
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700182 return kvp_handle_handshake(message);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700183 }
184
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700185 /* We didn't send anything to userspace so the reply is spurious */
186 if (kvp_transaction.state < HVUTIL_USERSPACE_REQ)
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700187 return -EINVAL;
188
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700189 kvp_transaction.state = HVUTIL_USERSPACE_RECV;
190
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700191 /*
192 * Based on the version of the daemon, we propagate errors from the
193 * daemon differently.
194 */
195
196 data = &message->body.kvp_enum_data;
197
198 switch (dm_reg_value) {
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700199 case KVP_OP_REGISTER:
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700200 /*
201 * Null string is used to pass back error condition.
202 */
203 if (data->data.key[0] == 0)
204 error = HV_S_CONT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700205 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700206
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700207 case KVP_OP_REGISTER1:
Ky Srinivasan245ba562010-12-16 18:54:16 -0700208 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700209 * We use the message header information from
210 * the user level daemon to transmit errors.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700211 */
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700212 error = message->error;
213 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700214 }
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700215
216 /*
217 * Complete the transaction by forwarding the key value
218 * to the host. But first, cancel the timeout.
219 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700220 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700221 kvp_respond_to_host(message, error);
Olaf Hering3cace4a2015-12-14 16:01:33 -0800222 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700223 }
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700224
225 return 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700226}
227
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700228
229static int process_ob_ipinfo(void *in_msg, void *out_msg, int op)
230{
231 struct hv_kvp_msg *in = in_msg;
232 struct hv_kvp_ip_msg *out = out_msg;
233 int len;
234
235 switch (op) {
236 case KVP_OP_GET_IP_INFO:
237 /*
238 * Transform all parameters into utf16 encoding.
239 */
240 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.ip_addr,
241 strlen((char *)in->body.kvp_ip_val.ip_addr),
242 UTF16_HOST_ENDIAN,
243 (wchar_t *)out->kvp_ip_val.ip_addr,
244 MAX_IP_ADDR_SIZE);
245 if (len < 0)
246 return len;
247
248 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.sub_net,
249 strlen((char *)in->body.kvp_ip_val.sub_net),
250 UTF16_HOST_ENDIAN,
251 (wchar_t *)out->kvp_ip_val.sub_net,
252 MAX_IP_ADDR_SIZE);
253 if (len < 0)
254 return len;
255
256 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.gate_way,
257 strlen((char *)in->body.kvp_ip_val.gate_way),
258 UTF16_HOST_ENDIAN,
259 (wchar_t *)out->kvp_ip_val.gate_way,
260 MAX_GATEWAY_SIZE);
261 if (len < 0)
262 return len;
263
264 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.dns_addr,
265 strlen((char *)in->body.kvp_ip_val.dns_addr),
266 UTF16_HOST_ENDIAN,
267 (wchar_t *)out->kvp_ip_val.dns_addr,
268 MAX_IP_ADDR_SIZE);
269 if (len < 0)
270 return len;
271
272 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.adapter_id,
273 strlen((char *)in->body.kvp_ip_val.adapter_id),
274 UTF16_HOST_ENDIAN,
275 (wchar_t *)out->kvp_ip_val.adapter_id,
276 MAX_IP_ADDR_SIZE);
277 if (len < 0)
278 return len;
279
280 out->kvp_ip_val.dhcp_enabled =
281 in->body.kvp_ip_val.dhcp_enabled;
K. Y. Srinivasana500e0e2012-09-04 17:54:13 -0700282 out->kvp_ip_val.addr_family =
283 in->body.kvp_ip_val.addr_family;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700284 }
285
286 return 0;
287}
288
289static void process_ib_ipinfo(void *in_msg, void *out_msg, int op)
290{
291 struct hv_kvp_ip_msg *in = in_msg;
292 struct hv_kvp_msg *out = out_msg;
293
294 switch (op) {
295 case KVP_OP_SET_IP_INFO:
296 /*
297 * Transform all parameters into utf8 encoding.
298 */
299 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.ip_addr,
300 MAX_IP_ADDR_SIZE,
301 UTF16_LITTLE_ENDIAN,
302 (__u8 *)out->body.kvp_ip_val.ip_addr,
303 MAX_IP_ADDR_SIZE);
304
305 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.sub_net,
306 MAX_IP_ADDR_SIZE,
307 UTF16_LITTLE_ENDIAN,
308 (__u8 *)out->body.kvp_ip_val.sub_net,
309 MAX_IP_ADDR_SIZE);
310
311 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.gate_way,
312 MAX_GATEWAY_SIZE,
313 UTF16_LITTLE_ENDIAN,
314 (__u8 *)out->body.kvp_ip_val.gate_way,
315 MAX_GATEWAY_SIZE);
316
317 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.dns_addr,
318 MAX_IP_ADDR_SIZE,
319 UTF16_LITTLE_ENDIAN,
320 (__u8 *)out->body.kvp_ip_val.dns_addr,
321 MAX_IP_ADDR_SIZE);
322
323 out->body.kvp_ip_val.dhcp_enabled = in->kvp_ip_val.dhcp_enabled;
324
325 default:
326 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
327 MAX_ADAPTER_ID_SIZE,
328 UTF16_LITTLE_ENDIAN,
329 (__u8 *)out->body.kvp_ip_val.adapter_id,
330 MAX_ADAPTER_ID_SIZE);
331
332 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
333 }
334}
335
336
337
338
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700339static void
340kvp_send_key(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700341{
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800342 struct hv_kvp_msg *message;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700343 struct hv_kvp_msg *in_msg;
344 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
345 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
346 __u32 val32;
347 __u64 val64;
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100348 int rc;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700349
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700350 /* The transaction state is wrong. */
351 if (kvp_transaction.state != HVUTIL_HOSTMSG_RECEIVED)
352 return;
353
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700354 message = kzalloc(sizeof(*message), GFP_KERNEL);
Vitaly Kuznetsovb36fda32015-08-01 16:08:11 -0700355 if (!message)
356 return;
357
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700358 message->kvp_hdr.operation = operation;
359 message->kvp_hdr.pool = pool;
360 in_msg = kvp_transaction.kvp_msg;
361
362 /*
363 * The key/value strings sent from the host are encoded in
364 * in utf16; convert it to utf8 strings.
365 * The host assures us that the utf16 strings will not exceed
366 * the max lengths specified. We will however, reserve room
367 * for the string terminating character - in the utf16s_utf8s()
368 * function we limit the size of the buffer where the converted
369 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
370 * that the strings can be properly terminated!
371 */
372
373 switch (message->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700374 case KVP_OP_SET_IP_INFO:
375 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
376 break;
377 case KVP_OP_GET_IP_INFO:
378 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
379 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700380 case KVP_OP_SET:
381 switch (in_msg->body.kvp_set.data.value_type) {
382 case REG_SZ:
383 /*
384 * The value is a string - utf16 encoding.
385 */
386 message->body.kvp_set.data.value_size =
387 utf16s_to_utf8s(
388 (wchar_t *)in_msg->body.kvp_set.data.value,
389 in_msg->body.kvp_set.data.value_size,
390 UTF16_LITTLE_ENDIAN,
391 message->body.kvp_set.data.value,
392 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
393 break;
394
395 case REG_U32:
396 /*
397 * The value is a 32 bit scalar.
398 * We save this as a utf8 string.
399 */
400 val32 = in_msg->body.kvp_set.data.value_u32;
401 message->body.kvp_set.data.value_size =
402 sprintf(message->body.kvp_set.data.value,
403 "%d", val32) + 1;
404 break;
405
406 case REG_U64:
407 /*
408 * The value is a 64 bit scalar.
409 * We save this as a utf8 string.
410 */
411 val64 = in_msg->body.kvp_set.data.value_u64;
412 message->body.kvp_set.data.value_size =
413 sprintf(message->body.kvp_set.data.value,
414 "%llu", val64) + 1;
415 break;
416
417 }
418 case KVP_OP_GET:
419 message->body.kvp_set.data.key_size =
420 utf16s_to_utf8s(
421 (wchar_t *)in_msg->body.kvp_set.data.key,
422 in_msg->body.kvp_set.data.key_size,
423 UTF16_LITTLE_ENDIAN,
424 message->body.kvp_set.data.key,
425 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
426 break;
427
428 case KVP_OP_DELETE:
429 message->body.kvp_delete.key_size =
430 utf16s_to_utf8s(
431 (wchar_t *)in_msg->body.kvp_delete.key,
432 in_msg->body.kvp_delete.key_size,
433 UTF16_LITTLE_ENDIAN,
434 message->body.kvp_delete.key,
435 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
436 break;
437
438 case KVP_OP_ENUMERATE:
439 message->body.kvp_enum_data.index =
440 in_msg->body.kvp_enum_data.index;
441 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700442 }
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700443
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700444 kvp_transaction.state = HVUTIL_USERSPACE_REQ;
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700445 rc = hvutil_transport_send(hvt, message, sizeof(*message));
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100446 if (rc) {
447 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700448 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100449 kvp_respond_to_host(message, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700450 kvp_transaction.state = HVUTIL_READY;
451 }
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100452 }
453
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700454 kfree(message);
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700455
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700456 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700457}
458
459/*
460 * Send a response back to the host.
461 */
462
463static void
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700464kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700465{
466 struct hv_kvp_msg *kvp_msg;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700467 struct hv_kvp_exchg_msg_value *kvp_data;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700468 char *key_name;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700469 char *value;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700470 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700471 int keylen = 0;
472 int valuelen = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700473 u32 buf_len;
474 struct vmbus_channel *channel;
475 u64 req_id;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700476 int ret;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700477
478 /*
Ky Srinivasan245ba562010-12-16 18:54:16 -0700479 * Copy the global state for completing the transaction. Note that
480 * only one transaction can be active at a time.
481 */
482
483 buf_len = kvp_transaction.recv_len;
484 channel = kvp_transaction.recv_channel;
485 req_id = kvp_transaction.recv_req_id;
486
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700487 icmsghdrp = (struct icmsg_hdr *)
488 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
489
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700490 if (channel->onchannel_callback == NULL)
491 /*
492 * We have raced with util driver being unloaded;
493 * silently return.
494 */
495 return;
496
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700497 icmsghdrp->status = error;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700498
499 /*
K. Y. Srinivasanadc80ae2012-03-16 08:02:27 -0700500 * If the error parameter is set, terminate the host's enumeration
501 * on this pool.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700502 */
503 if (error) {
504 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700505 * Something failed or we have timedout;
506 * terminate the current host-side iteration.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700507 */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700508 goto response_done;
509 }
510
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700511 kvp_msg = (struct hv_kvp_msg *)
512 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
513 sizeof(struct icmsg_hdr)];
514
515 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700516 case KVP_OP_GET_IP_INFO:
517 ret = process_ob_ipinfo(msg_to_host,
518 (struct hv_kvp_ip_msg *)kvp_msg,
519 KVP_OP_GET_IP_INFO);
520 if (ret < 0)
521 icmsghdrp->status = HV_E_FAIL;
522
523 goto response_done;
524 case KVP_OP_SET_IP_INFO:
525 goto response_done;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700526 case KVP_OP_GET:
527 kvp_data = &kvp_msg->body.kvp_get.data;
528 goto copy_value;
529
530 case KVP_OP_SET:
531 case KVP_OP_DELETE:
532 goto response_done;
533
534 default:
535 break;
536 }
537
538 kvp_data = &kvp_msg->body.kvp_enum_data.data;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700539 key_name = msg_to_host->body.kvp_enum_data.data.key;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700540
Ky Srinivasan245ba562010-12-16 18:54:16 -0700541 /*
542 * The windows host expects the key/value pair to be encoded
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700543 * in utf16. Ensure that the key/value size reported to the host
544 * will be less than or equal to the MAX size (including the
545 * terminating character).
Ky Srinivasan245ba562010-12-16 18:54:16 -0700546 */
Alan Stern0720a062011-11-17 16:42:19 -0500547 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700548 (wchar_t *) kvp_data->key,
549 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
550 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700551
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700552copy_value:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700553 value = msg_to_host->body.kvp_enum_data.data.value;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700554 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
555 (wchar_t *) kvp_data->value,
556 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
557 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
558
559 /*
560 * If the utf8s to utf16s conversion failed; notify host
561 * of the error.
562 */
563 if ((keylen < 0) || (valuelen < 0))
564 icmsghdrp->status = HV_E_FAIL;
565
566 kvp_data->value_type = REG_SZ; /* all our values are strings */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700567
568response_done:
569 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
570
571 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800572 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700573}
574
575/*
576 * This callback is invoked when we get a KVP message from the host.
577 * The host ensures that only one KVP transaction can be active at a time.
578 * KVP implementation in Linux needs to forward the key to a user-mde
579 * component to retrive the corresponding value. Consequently, we cannot
580 * respond to the host in the conext of this callback. Since the host
581 * guarantees that at most only one transaction can be active at a time,
582 * we stash away the transaction state in a set of global variables.
583 */
584
585void hv_kvp_onchannelcallback(void *context)
586{
587 struct vmbus_channel *channel = context;
588 u32 recvlen;
589 u64 requestid;
590
591 struct hv_kvp_msg *kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700592
593 struct icmsg_hdr *icmsghdrp;
594 struct icmsg_negotiate *negop = NULL;
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700595 int util_fw_version;
596 int kvp_srv_version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700597
Olaf Hering3cace4a2015-12-14 16:01:33 -0800598 if (kvp_transaction.state > HVUTIL_READY)
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700599 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700600
K. Y. Srinivasan9bd2d0d2014-07-07 16:34:25 -0700601 vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 4, &recvlen,
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700602 &requestid);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700603
604 if (recvlen > 0) {
Ky Srinivasan245ba562010-12-16 18:54:16 -0700605 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
606 sizeof(struct vmbuspipe_hdr)];
607
608 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700609 /*
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700610 * Based on the host, select appropriate
611 * framework and service versions we will
612 * negotiate.
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700613 */
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700614 switch (vmbus_proto_version) {
615 case (VERSION_WS2008):
616 util_fw_version = UTIL_WS2K8_FW_VERSION;
617 kvp_srv_version = WS2008_SRV_VERSION;
618 break;
619 case (VERSION_WIN7):
620 util_fw_version = UTIL_FW_VERSION;
621 kvp_srv_version = WIN7_SRV_VERSION;
622 break;
623 default:
624 util_fw_version = UTIL_FW_VERSION;
625 kvp_srv_version = WIN8_SRV_VERSION;
626 }
K. Y. Srinivasanc836d0a2012-05-12 13:44:58 -0700627 vmbus_prep_negotiate_resp(icmsghdrp, negop,
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700628 recv_buffer, util_fw_version,
629 kvp_srv_version);
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700630
Ky Srinivasan245ba562010-12-16 18:54:16 -0700631 } else {
632 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
633 sizeof(struct vmbuspipe_hdr) +
634 sizeof(struct icmsg_hdr)];
635
Ky Srinivasan245ba562010-12-16 18:54:16 -0700636 /*
637 * Stash away this global state for completing the
638 * transaction; note transactions are serialized.
639 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700640
Ky Srinivasan245ba562010-12-16 18:54:16 -0700641 kvp_transaction.recv_len = recvlen;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700642 kvp_transaction.recv_req_id = requestid;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700643 kvp_transaction.kvp_msg = kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700644
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700645 if (kvp_transaction.state < HVUTIL_READY) {
646 /* Userspace is not registered yet */
647 kvp_respond_to_host(NULL, HV_E_FAIL);
648 return;
649 }
650 kvp_transaction.state = HVUTIL_HOSTMSG_RECEIVED;
651
Ky Srinivasan245ba562010-12-16 18:54:16 -0700652 /*
653 * Get the information from the
654 * user-mode component.
655 * component. This transaction will be
656 * completed when we get the value from
657 * the user-mode component.
658 * Set a timeout to deal with
659 * user-mode not responding.
660 */
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700661 schedule_work(&kvp_sendkey_work);
K. Y. Srinivasanc0b200c2015-12-14 16:01:32 -0800662 schedule_delayed_work(&kvp_timeout_work,
663 HV_UTIL_TIMEOUT * HZ);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700664
665 return;
666
667 }
668
Ky Srinivasan245ba562010-12-16 18:54:16 -0700669 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
670 | ICMSGHDRFLAG_RESPONSE;
671
672 vmbus_sendpacket(channel, recv_buffer,
673 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800674 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700675 }
676
677}
678
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700679static void kvp_on_reset(void)
680{
681 if (cancel_delayed_work_sync(&kvp_timeout_work))
682 kvp_respond_to_host(NULL, HV_E_FAIL);
683 kvp_transaction.state = HVUTIL_DEVICE_INIT;
684}
685
Ky Srinivasan245ba562010-12-16 18:54:16 -0700686int
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700687hv_kvp_init(struct hv_util_service *srv)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700688{
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700689 recv_buffer = srv->recv_buffer;
K. Y. Srinivasanb9830d12016-02-26 15:13:19 -0800690 kvp_transaction.recv_channel = srv->channel;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700691
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700692 /*
693 * When this driver loads, the user level daemon that
694 * processes the host requests may not yet be running.
695 * Defer processing channel callbacks until the daemon
696 * has registered.
697 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700698 kvp_transaction.state = HVUTIL_DEVICE_INIT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700699
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700700 hvt = hvutil_transport_init(kvp_devname, CN_KVP_IDX, CN_KVP_VAL,
701 kvp_on_msg, kvp_on_reset);
702 if (!hvt)
703 return -EFAULT;
704
Ky Srinivasan245ba562010-12-16 18:54:16 -0700705 return 0;
706}
707
708void hv_kvp_deinit(void)
709{
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700710 kvp_transaction.state = HVUTIL_DEVICE_DYING;
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700711 cancel_delayed_work_sync(&kvp_timeout_work);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700712 cancel_work_sync(&kvp_sendkey_work);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700713 hvutil_transport_destroy(hvt);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700714}