blob: cb1a9160aab15064d95f710755ba4acdcad2eb69 [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);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -070081static void kvp_host_handshake_func(struct work_struct *dummy);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070082static void kvp_register(int);
Ky Srinivasan245ba562010-12-16 18:54:16 -070083
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070084static DECLARE_DELAYED_WORK(kvp_timeout_work, kvp_timeout_func);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -070085static DECLARE_DELAYED_WORK(kvp_host_handshake_work, kvp_host_handshake_func);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070086static DECLARE_WORK(kvp_sendkey_work, kvp_send_key);
Ky Srinivasan245ba562010-12-16 18:54:16 -070087
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -070088static const char kvp_devname[] = "vmbus/hv_kvp";
Ky Srinivasan245ba562010-12-16 18:54:16 -070089static u8 *recv_buffer;
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -070090static struct hvutil_transport *hvt;
Ky Srinivasan245ba562010-12-16 18:54:16 -070091/*
92 * Register the kernel component with the user-level daemon.
93 * As part of this registration, pass the LIC version number.
Olaf Heringcfc25992013-05-29 11:29:07 +020094 * This number has no meaning, it satisfies the registration protocol.
Ky Srinivasan245ba562010-12-16 18:54:16 -070095 */
Olaf Heringcfc25992013-05-29 11:29:07 +020096#define HV_DRV_VERSION "3.1"
Ky Srinivasan245ba562010-12-16 18:54:16 -070097
Olaf Hering3cace4a2015-12-14 16:01:33 -080098static void kvp_poll_wrapper(void *channel)
99{
100 /* Transaction is finished, reset the state here to avoid races. */
101 kvp_transaction.state = HVUTIL_READY;
102 hv_kvp_onchannelcallback(channel);
103}
104
Ky Srinivasan245ba562010-12-16 18:54:16 -0700105static void
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700106kvp_register(int reg_value)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700107{
108
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800109 struct hv_kvp_msg *kvp_msg;
110 char *version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700111
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700112 kvp_msg = kzalloc(sizeof(*kvp_msg), GFP_KERNEL);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700113
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700114 if (kvp_msg) {
K. Y. Srinivasane485ceac2012-03-10 15:32:08 -0800115 version = kvp_msg->body.kvp_register.version;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700116 kvp_msg->kvp_hdr.operation = reg_value;
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800117 strcpy(version, HV_DRV_VERSION);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700118
119 hvutil_transport_send(hvt, kvp_msg, sizeof(*kvp_msg));
120 kfree(kvp_msg);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700121 }
122}
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700123
124static void kvp_timeout_func(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700125{
126 /*
127 * If the timer fires, the user-mode component has not responded;
128 * process the pending transaction.
129 */
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700130 kvp_respond_to_host(NULL, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700131
Olaf Hering3cace4a2015-12-14 16:01:33 -0800132 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700133}
134
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700135static void kvp_host_handshake_func(struct work_struct *dummy)
136{
137 hv_poll_channel(kvp_transaction.recv_channel, hv_kvp_onchannelcallback);
138}
139
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700140static int kvp_handle_handshake(struct hv_kvp_msg *msg)
141{
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700142 switch (msg->kvp_hdr.operation) {
143 case KVP_OP_REGISTER:
144 dm_reg_value = KVP_OP_REGISTER;
145 pr_info("KVP: IP injection functionality not available\n");
146 pr_info("KVP: Upgrade the KVP daemon\n");
147 break;
148 case KVP_OP_REGISTER1:
149 dm_reg_value = KVP_OP_REGISTER1;
150 break;
151 default:
152 pr_info("KVP: incompatible daemon\n");
153 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
154 KVP_OP_REGISTER1, msg->kvp_hdr.operation);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700155 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700156 }
157
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700158 /*
159 * We have a compatible daemon; complete the handshake.
160 */
Vitaly Kuznetsov7c959122015-04-11 18:07:59 -0700161 pr_debug("KVP: userspace daemon ver. %d registered\n",
162 KVP_OP_REGISTER);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700163 kvp_register(dm_reg_value);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700164
165 /*
166 * If we're still negotiating with the host cancel the timeout
167 * work to not poll the channel twice.
168 */
169 cancel_delayed_work_sync(&kvp_host_handshake_work);
K. Y. Srinivasan2d0c3b52015-12-14 16:01:57 -0800170 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700171
172 return 0;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700173}
174
175
Ky Srinivasan245ba562010-12-16 18:54:16 -0700176/*
177 * Callback when data is received from user mode.
178 */
179
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700180static int kvp_on_msg(void *msg, int len)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700181{
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700182 struct hv_kvp_msg *message = (struct hv_kvp_msg *)msg;
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800183 struct hv_kvp_msg_enumerate *data;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700184 int error = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700185
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700186 if (len < sizeof(*message))
187 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700188
189 /*
190 * If we are negotiating the version information
191 * with the daemon; handle that first.
192 */
193
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700194 if (kvp_transaction.state < HVUTIL_READY) {
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700195 return kvp_handle_handshake(message);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700196 }
197
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700198 /* We didn't send anything to userspace so the reply is spurious */
199 if (kvp_transaction.state < HVUTIL_USERSPACE_REQ)
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700200 return -EINVAL;
201
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700202 kvp_transaction.state = HVUTIL_USERSPACE_RECV;
203
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700204 /*
205 * Based on the version of the daemon, we propagate errors from the
206 * daemon differently.
207 */
208
209 data = &message->body.kvp_enum_data;
210
211 switch (dm_reg_value) {
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700212 case KVP_OP_REGISTER:
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700213 /*
214 * Null string is used to pass back error condition.
215 */
216 if (data->data.key[0] == 0)
217 error = HV_S_CONT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700218 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700219
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700220 case KVP_OP_REGISTER1:
Ky Srinivasan245ba562010-12-16 18:54:16 -0700221 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700222 * We use the message header information from
223 * the user level daemon to transmit errors.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700224 */
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700225 error = message->error;
226 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700227 }
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700228
229 /*
230 * Complete the transaction by forwarding the key value
231 * to the host. But first, cancel the timeout.
232 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700233 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700234 kvp_respond_to_host(message, error);
Olaf Hering3cace4a2015-12-14 16:01:33 -0800235 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700236 }
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700237
238 return 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700239}
240
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700241
242static int process_ob_ipinfo(void *in_msg, void *out_msg, int op)
243{
244 struct hv_kvp_msg *in = in_msg;
245 struct hv_kvp_ip_msg *out = out_msg;
246 int len;
247
248 switch (op) {
249 case KVP_OP_GET_IP_INFO:
250 /*
251 * Transform all parameters into utf16 encoding.
252 */
253 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.ip_addr,
254 strlen((char *)in->body.kvp_ip_val.ip_addr),
255 UTF16_HOST_ENDIAN,
256 (wchar_t *)out->kvp_ip_val.ip_addr,
257 MAX_IP_ADDR_SIZE);
258 if (len < 0)
259 return len;
260
261 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.sub_net,
262 strlen((char *)in->body.kvp_ip_val.sub_net),
263 UTF16_HOST_ENDIAN,
264 (wchar_t *)out->kvp_ip_val.sub_net,
265 MAX_IP_ADDR_SIZE);
266 if (len < 0)
267 return len;
268
269 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.gate_way,
270 strlen((char *)in->body.kvp_ip_val.gate_way),
271 UTF16_HOST_ENDIAN,
272 (wchar_t *)out->kvp_ip_val.gate_way,
273 MAX_GATEWAY_SIZE);
274 if (len < 0)
275 return len;
276
277 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.dns_addr,
278 strlen((char *)in->body.kvp_ip_val.dns_addr),
279 UTF16_HOST_ENDIAN,
280 (wchar_t *)out->kvp_ip_val.dns_addr,
281 MAX_IP_ADDR_SIZE);
282 if (len < 0)
283 return len;
284
285 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.adapter_id,
286 strlen((char *)in->body.kvp_ip_val.adapter_id),
287 UTF16_HOST_ENDIAN,
288 (wchar_t *)out->kvp_ip_val.adapter_id,
289 MAX_IP_ADDR_SIZE);
290 if (len < 0)
291 return len;
292
293 out->kvp_ip_val.dhcp_enabled =
294 in->body.kvp_ip_val.dhcp_enabled;
K. Y. Srinivasana500e0e2012-09-04 17:54:13 -0700295 out->kvp_ip_val.addr_family =
296 in->body.kvp_ip_val.addr_family;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700297 }
298
299 return 0;
300}
301
302static void process_ib_ipinfo(void *in_msg, void *out_msg, int op)
303{
304 struct hv_kvp_ip_msg *in = in_msg;
305 struct hv_kvp_msg *out = out_msg;
306
307 switch (op) {
308 case KVP_OP_SET_IP_INFO:
309 /*
310 * Transform all parameters into utf8 encoding.
311 */
312 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.ip_addr,
313 MAX_IP_ADDR_SIZE,
314 UTF16_LITTLE_ENDIAN,
315 (__u8 *)out->body.kvp_ip_val.ip_addr,
316 MAX_IP_ADDR_SIZE);
317
318 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.sub_net,
319 MAX_IP_ADDR_SIZE,
320 UTF16_LITTLE_ENDIAN,
321 (__u8 *)out->body.kvp_ip_val.sub_net,
322 MAX_IP_ADDR_SIZE);
323
324 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.gate_way,
325 MAX_GATEWAY_SIZE,
326 UTF16_LITTLE_ENDIAN,
327 (__u8 *)out->body.kvp_ip_val.gate_way,
328 MAX_GATEWAY_SIZE);
329
330 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.dns_addr,
331 MAX_IP_ADDR_SIZE,
332 UTF16_LITTLE_ENDIAN,
333 (__u8 *)out->body.kvp_ip_val.dns_addr,
334 MAX_IP_ADDR_SIZE);
335
336 out->body.kvp_ip_val.dhcp_enabled = in->kvp_ip_val.dhcp_enabled;
337
338 default:
339 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
340 MAX_ADAPTER_ID_SIZE,
341 UTF16_LITTLE_ENDIAN,
342 (__u8 *)out->body.kvp_ip_val.adapter_id,
343 MAX_ADAPTER_ID_SIZE);
344
345 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
346 }
347}
348
349
350
351
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700352static void
353kvp_send_key(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700354{
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800355 struct hv_kvp_msg *message;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700356 struct hv_kvp_msg *in_msg;
357 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
358 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
359 __u32 val32;
360 __u64 val64;
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100361 int rc;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700362
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700363 /* The transaction state is wrong. */
364 if (kvp_transaction.state != HVUTIL_HOSTMSG_RECEIVED)
365 return;
366
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700367 message = kzalloc(sizeof(*message), GFP_KERNEL);
Vitaly Kuznetsovb36fda32015-08-01 16:08:11 -0700368 if (!message)
369 return;
370
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700371 message->kvp_hdr.operation = operation;
372 message->kvp_hdr.pool = pool;
373 in_msg = kvp_transaction.kvp_msg;
374
375 /*
376 * The key/value strings sent from the host are encoded in
377 * in utf16; convert it to utf8 strings.
378 * The host assures us that the utf16 strings will not exceed
379 * the max lengths specified. We will however, reserve room
380 * for the string terminating character - in the utf16s_utf8s()
381 * function we limit the size of the buffer where the converted
382 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
383 * that the strings can be properly terminated!
384 */
385
386 switch (message->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700387 case KVP_OP_SET_IP_INFO:
388 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
389 break;
390 case KVP_OP_GET_IP_INFO:
391 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
392 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700393 case KVP_OP_SET:
394 switch (in_msg->body.kvp_set.data.value_type) {
395 case REG_SZ:
396 /*
397 * The value is a string - utf16 encoding.
398 */
399 message->body.kvp_set.data.value_size =
400 utf16s_to_utf8s(
401 (wchar_t *)in_msg->body.kvp_set.data.value,
402 in_msg->body.kvp_set.data.value_size,
403 UTF16_LITTLE_ENDIAN,
404 message->body.kvp_set.data.value,
405 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
406 break;
407
408 case REG_U32:
409 /*
410 * The value is a 32 bit scalar.
411 * We save this as a utf8 string.
412 */
413 val32 = in_msg->body.kvp_set.data.value_u32;
414 message->body.kvp_set.data.value_size =
415 sprintf(message->body.kvp_set.data.value,
416 "%d", val32) + 1;
417 break;
418
419 case REG_U64:
420 /*
421 * The value is a 64 bit scalar.
422 * We save this as a utf8 string.
423 */
424 val64 = in_msg->body.kvp_set.data.value_u64;
425 message->body.kvp_set.data.value_size =
426 sprintf(message->body.kvp_set.data.value,
427 "%llu", val64) + 1;
428 break;
429
430 }
431 case KVP_OP_GET:
432 message->body.kvp_set.data.key_size =
433 utf16s_to_utf8s(
434 (wchar_t *)in_msg->body.kvp_set.data.key,
435 in_msg->body.kvp_set.data.key_size,
436 UTF16_LITTLE_ENDIAN,
437 message->body.kvp_set.data.key,
438 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
439 break;
440
441 case KVP_OP_DELETE:
442 message->body.kvp_delete.key_size =
443 utf16s_to_utf8s(
444 (wchar_t *)in_msg->body.kvp_delete.key,
445 in_msg->body.kvp_delete.key_size,
446 UTF16_LITTLE_ENDIAN,
447 message->body.kvp_delete.key,
448 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
449 break;
450
451 case KVP_OP_ENUMERATE:
452 message->body.kvp_enum_data.index =
453 in_msg->body.kvp_enum_data.index;
454 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700455 }
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700456
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700457 kvp_transaction.state = HVUTIL_USERSPACE_REQ;
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700458 rc = hvutil_transport_send(hvt, message, sizeof(*message));
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100459 if (rc) {
460 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700461 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100462 kvp_respond_to_host(message, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700463 kvp_transaction.state = HVUTIL_READY;
464 }
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100465 }
466
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700467 kfree(message);
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700468
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700469 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700470}
471
472/*
473 * Send a response back to the host.
474 */
475
476static void
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700477kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700478{
479 struct hv_kvp_msg *kvp_msg;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700480 struct hv_kvp_exchg_msg_value *kvp_data;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700481 char *key_name;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700482 char *value;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700483 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700484 int keylen = 0;
485 int valuelen = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700486 u32 buf_len;
487 struct vmbus_channel *channel;
488 u64 req_id;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700489 int ret;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700490
491 /*
Ky Srinivasan245ba562010-12-16 18:54:16 -0700492 * Copy the global state for completing the transaction. Note that
493 * only one transaction can be active at a time.
494 */
495
496 buf_len = kvp_transaction.recv_len;
497 channel = kvp_transaction.recv_channel;
498 req_id = kvp_transaction.recv_req_id;
499
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700500 icmsghdrp = (struct icmsg_hdr *)
501 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
502
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700503 if (channel->onchannel_callback == NULL)
504 /*
505 * We have raced with util driver being unloaded;
506 * silently return.
507 */
508 return;
509
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700510 icmsghdrp->status = error;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700511
512 /*
K. Y. Srinivasanadc80ae2012-03-16 08:02:27 -0700513 * If the error parameter is set, terminate the host's enumeration
514 * on this pool.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700515 */
516 if (error) {
517 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700518 * Something failed or we have timedout;
519 * terminate the current host-side iteration.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700520 */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700521 goto response_done;
522 }
523
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700524 kvp_msg = (struct hv_kvp_msg *)
525 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
526 sizeof(struct icmsg_hdr)];
527
528 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700529 case KVP_OP_GET_IP_INFO:
530 ret = process_ob_ipinfo(msg_to_host,
531 (struct hv_kvp_ip_msg *)kvp_msg,
532 KVP_OP_GET_IP_INFO);
533 if (ret < 0)
534 icmsghdrp->status = HV_E_FAIL;
535
536 goto response_done;
537 case KVP_OP_SET_IP_INFO:
538 goto response_done;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700539 case KVP_OP_GET:
540 kvp_data = &kvp_msg->body.kvp_get.data;
541 goto copy_value;
542
543 case KVP_OP_SET:
544 case KVP_OP_DELETE:
545 goto response_done;
546
547 default:
548 break;
549 }
550
551 kvp_data = &kvp_msg->body.kvp_enum_data.data;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700552 key_name = msg_to_host->body.kvp_enum_data.data.key;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700553
Ky Srinivasan245ba562010-12-16 18:54:16 -0700554 /*
555 * The windows host expects the key/value pair to be encoded
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700556 * in utf16. Ensure that the key/value size reported to the host
557 * will be less than or equal to the MAX size (including the
558 * terminating character).
Ky Srinivasan245ba562010-12-16 18:54:16 -0700559 */
Alan Stern0720a062011-11-17 16:42:19 -0500560 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700561 (wchar_t *) kvp_data->key,
562 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
563 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700564
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700565copy_value:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700566 value = msg_to_host->body.kvp_enum_data.data.value;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700567 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
568 (wchar_t *) kvp_data->value,
569 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
570 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
571
572 /*
573 * If the utf8s to utf16s conversion failed; notify host
574 * of the error.
575 */
576 if ((keylen < 0) || (valuelen < 0))
577 icmsghdrp->status = HV_E_FAIL;
578
579 kvp_data->value_type = REG_SZ; /* all our values are strings */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700580
581response_done:
582 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
583
584 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800585 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700586}
587
588/*
589 * This callback is invoked when we get a KVP message from the host.
590 * The host ensures that only one KVP transaction can be active at a time.
591 * KVP implementation in Linux needs to forward the key to a user-mde
592 * component to retrive the corresponding value. Consequently, we cannot
593 * respond to the host in the conext of this callback. Since the host
594 * guarantees that at most only one transaction can be active at a time,
595 * we stash away the transaction state in a set of global variables.
596 */
597
598void hv_kvp_onchannelcallback(void *context)
599{
600 struct vmbus_channel *channel = context;
601 u32 recvlen;
602 u64 requestid;
603
604 struct hv_kvp_msg *kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700605
606 struct icmsg_hdr *icmsghdrp;
607 struct icmsg_negotiate *negop = NULL;
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700608 int util_fw_version;
609 int kvp_srv_version;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700610 static enum {NEGO_NOT_STARTED,
611 NEGO_IN_PROGRESS,
612 NEGO_FINISHED} host_negotiatied = NEGO_NOT_STARTED;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700613
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700614 if (host_negotiatied == NEGO_NOT_STARTED &&
615 kvp_transaction.state < HVUTIL_READY) {
616 /*
617 * If userspace daemon is not connected and host is asking
618 * us to negotiate we need to delay to not lose messages.
619 * This is important for Failover IP setting.
620 */
621 host_negotiatied = NEGO_IN_PROGRESS;
622 schedule_delayed_work(&kvp_host_handshake_work,
623 HV_UTIL_NEGO_TIMEOUT * HZ);
624 return;
625 }
Olaf Hering3cace4a2015-12-14 16:01:33 -0800626 if (kvp_transaction.state > HVUTIL_READY)
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700627 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700628
K. Y. Srinivasan9bd2d0d2014-07-07 16:34:25 -0700629 vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 4, &recvlen,
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700630 &requestid);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700631
632 if (recvlen > 0) {
Ky Srinivasan245ba562010-12-16 18:54:16 -0700633 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
634 sizeof(struct vmbuspipe_hdr)];
635
636 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700637 /*
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700638 * Based on the host, select appropriate
639 * framework and service versions we will
640 * negotiate.
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700641 */
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700642 switch (vmbus_proto_version) {
643 case (VERSION_WS2008):
644 util_fw_version = UTIL_WS2K8_FW_VERSION;
645 kvp_srv_version = WS2008_SRV_VERSION;
646 break;
647 case (VERSION_WIN7):
648 util_fw_version = UTIL_FW_VERSION;
649 kvp_srv_version = WIN7_SRV_VERSION;
650 break;
651 default:
652 util_fw_version = UTIL_FW_VERSION;
653 kvp_srv_version = WIN8_SRV_VERSION;
654 }
K. Y. Srinivasanc836d0a2012-05-12 13:44:58 -0700655 vmbus_prep_negotiate_resp(icmsghdrp, negop,
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700656 recv_buffer, util_fw_version,
657 kvp_srv_version);
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700658
Ky Srinivasan245ba562010-12-16 18:54:16 -0700659 } else {
660 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
661 sizeof(struct vmbuspipe_hdr) +
662 sizeof(struct icmsg_hdr)];
663
Ky Srinivasan245ba562010-12-16 18:54:16 -0700664 /*
665 * Stash away this global state for completing the
666 * transaction; note transactions are serialized.
667 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700668
Ky Srinivasan245ba562010-12-16 18:54:16 -0700669 kvp_transaction.recv_len = recvlen;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700670 kvp_transaction.recv_req_id = requestid;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700671 kvp_transaction.kvp_msg = kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700672
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700673 if (kvp_transaction.state < HVUTIL_READY) {
674 /* Userspace is not registered yet */
675 kvp_respond_to_host(NULL, HV_E_FAIL);
676 return;
677 }
678 kvp_transaction.state = HVUTIL_HOSTMSG_RECEIVED;
679
Ky Srinivasan245ba562010-12-16 18:54:16 -0700680 /*
681 * Get the information from the
682 * user-mode component.
683 * component. This transaction will be
684 * completed when we get the value from
685 * the user-mode component.
686 * Set a timeout to deal with
687 * user-mode not responding.
688 */
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700689 schedule_work(&kvp_sendkey_work);
K. Y. Srinivasanc0b200c2015-12-14 16:01:32 -0800690 schedule_delayed_work(&kvp_timeout_work,
691 HV_UTIL_TIMEOUT * HZ);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700692
693 return;
694
695 }
696
Ky Srinivasan245ba562010-12-16 18:54:16 -0700697 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
698 | ICMSGHDRFLAG_RESPONSE;
699
700 vmbus_sendpacket(channel, recv_buffer,
701 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800702 VM_PKT_DATA_INBAND, 0);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700703
704 host_negotiatied = NEGO_FINISHED;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700705 }
706
707}
708
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700709static void kvp_on_reset(void)
710{
711 if (cancel_delayed_work_sync(&kvp_timeout_work))
712 kvp_respond_to_host(NULL, HV_E_FAIL);
713 kvp_transaction.state = HVUTIL_DEVICE_INIT;
714}
715
Ky Srinivasan245ba562010-12-16 18:54:16 -0700716int
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700717hv_kvp_init(struct hv_util_service *srv)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700718{
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700719 recv_buffer = srv->recv_buffer;
K. Y. Srinivasanb9830d12016-02-26 15:13:19 -0800720 kvp_transaction.recv_channel = srv->channel;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700721
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700722 /*
723 * When this driver loads, the user level daemon that
724 * processes the host requests may not yet be running.
725 * Defer processing channel callbacks until the daemon
726 * has registered.
727 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700728 kvp_transaction.state = HVUTIL_DEVICE_INIT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700729
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700730 hvt = hvutil_transport_init(kvp_devname, CN_KVP_IDX, CN_KVP_VAL,
731 kvp_on_msg, kvp_on_reset);
732 if (!hvt)
733 return -EFAULT;
734
Ky Srinivasan245ba562010-12-16 18:54:16 -0700735 return 0;
736}
737
738void hv_kvp_deinit(void)
739{
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700740 kvp_transaction.state = HVUTIL_DEVICE_DYING;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700741 cancel_delayed_work_sync(&kvp_host_handshake_work);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700742 cancel_delayed_work_sync(&kvp_timeout_work);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700743 cancel_work_sync(&kvp_sendkey_work);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700744 hvutil_transport_destroy(hvt);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700745}