blob: 2fd0f119a67b159711d2779d9370d1b35fa68405 [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
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700105static void kvp_register_done(void)
106{
107 /*
108 * If we're still negotiating with the host cancel the timeout
109 * work to not poll the channel twice.
110 */
111 pr_debug("KVP: userspace daemon registered\n");
112 cancel_delayed_work_sync(&kvp_host_handshake_work);
113 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
114}
115
Ky Srinivasan245ba562010-12-16 18:54:16 -0700116static void
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700117kvp_register(int reg_value)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700118{
119
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800120 struct hv_kvp_msg *kvp_msg;
121 char *version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700122
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700123 kvp_msg = kzalloc(sizeof(*kvp_msg), GFP_KERNEL);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700124
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700125 if (kvp_msg) {
K. Y. Srinivasane485ceac2012-03-10 15:32:08 -0800126 version = kvp_msg->body.kvp_register.version;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700127 kvp_msg->kvp_hdr.operation = reg_value;
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800128 strcpy(version, HV_DRV_VERSION);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700129
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700130 hvutil_transport_send(hvt, kvp_msg, sizeof(*kvp_msg),
131 kvp_register_done);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700132 kfree(kvp_msg);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700133 }
134}
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700135
136static void kvp_timeout_func(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700137{
138 /*
139 * If the timer fires, the user-mode component has not responded;
140 * process the pending transaction.
141 */
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700142 kvp_respond_to_host(NULL, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700143
Olaf Hering3cace4a2015-12-14 16:01:33 -0800144 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700145}
146
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700147static void kvp_host_handshake_func(struct work_struct *dummy)
148{
149 hv_poll_channel(kvp_transaction.recv_channel, hv_kvp_onchannelcallback);
150}
151
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700152static int kvp_handle_handshake(struct hv_kvp_msg *msg)
153{
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700154 switch (msg->kvp_hdr.operation) {
155 case KVP_OP_REGISTER:
156 dm_reg_value = KVP_OP_REGISTER;
157 pr_info("KVP: IP injection functionality not available\n");
158 pr_info("KVP: Upgrade the KVP daemon\n");
159 break;
160 case KVP_OP_REGISTER1:
161 dm_reg_value = KVP_OP_REGISTER1;
162 break;
163 default:
164 pr_info("KVP: incompatible daemon\n");
165 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
166 KVP_OP_REGISTER1, msg->kvp_hdr.operation);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700167 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700168 }
169
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700170 /*
171 * We have a compatible daemon; complete the handshake.
172 */
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700173 pr_debug("KVP: userspace daemon ver. %d connected\n",
174 msg->kvp_hdr.operation);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700175 kvp_register(dm_reg_value);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700176
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700177 return 0;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700178}
179
180
Ky Srinivasan245ba562010-12-16 18:54:16 -0700181/*
182 * Callback when data is received from user mode.
183 */
184
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700185static int kvp_on_msg(void *msg, int len)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700186{
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700187 struct hv_kvp_msg *message = (struct hv_kvp_msg *)msg;
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800188 struct hv_kvp_msg_enumerate *data;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700189 int error = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700190
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700191 if (len < sizeof(*message))
192 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700193
194 /*
195 * If we are negotiating the version information
196 * with the daemon; handle that first.
197 */
198
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700199 if (kvp_transaction.state < HVUTIL_READY) {
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700200 return kvp_handle_handshake(message);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700201 }
202
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700203 /* We didn't send anything to userspace so the reply is spurious */
204 if (kvp_transaction.state < HVUTIL_USERSPACE_REQ)
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700205 return -EINVAL;
206
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700207 kvp_transaction.state = HVUTIL_USERSPACE_RECV;
208
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700209 /*
210 * Based on the version of the daemon, we propagate errors from the
211 * daemon differently.
212 */
213
214 data = &message->body.kvp_enum_data;
215
216 switch (dm_reg_value) {
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700217 case KVP_OP_REGISTER:
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700218 /*
219 * Null string is used to pass back error condition.
220 */
221 if (data->data.key[0] == 0)
222 error = HV_S_CONT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700223 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700224
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700225 case KVP_OP_REGISTER1:
Ky Srinivasan245ba562010-12-16 18:54:16 -0700226 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700227 * We use the message header information from
228 * the user level daemon to transmit errors.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700229 */
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700230 error = message->error;
231 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700232 }
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700233
234 /*
235 * Complete the transaction by forwarding the key value
236 * to the host. But first, cancel the timeout.
237 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700238 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700239 kvp_respond_to_host(message, error);
Olaf Hering3cace4a2015-12-14 16:01:33 -0800240 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700241 }
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700242
243 return 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700244}
245
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700246
247static int process_ob_ipinfo(void *in_msg, void *out_msg, int op)
248{
249 struct hv_kvp_msg *in = in_msg;
250 struct hv_kvp_ip_msg *out = out_msg;
251 int len;
252
253 switch (op) {
254 case KVP_OP_GET_IP_INFO:
255 /*
256 * Transform all parameters into utf16 encoding.
257 */
258 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.ip_addr,
259 strlen((char *)in->body.kvp_ip_val.ip_addr),
260 UTF16_HOST_ENDIAN,
261 (wchar_t *)out->kvp_ip_val.ip_addr,
262 MAX_IP_ADDR_SIZE);
263 if (len < 0)
264 return len;
265
266 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.sub_net,
267 strlen((char *)in->body.kvp_ip_val.sub_net),
268 UTF16_HOST_ENDIAN,
269 (wchar_t *)out->kvp_ip_val.sub_net,
270 MAX_IP_ADDR_SIZE);
271 if (len < 0)
272 return len;
273
274 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.gate_way,
275 strlen((char *)in->body.kvp_ip_val.gate_way),
276 UTF16_HOST_ENDIAN,
277 (wchar_t *)out->kvp_ip_val.gate_way,
278 MAX_GATEWAY_SIZE);
279 if (len < 0)
280 return len;
281
282 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.dns_addr,
283 strlen((char *)in->body.kvp_ip_val.dns_addr),
284 UTF16_HOST_ENDIAN,
285 (wchar_t *)out->kvp_ip_val.dns_addr,
286 MAX_IP_ADDR_SIZE);
287 if (len < 0)
288 return len;
289
290 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.adapter_id,
291 strlen((char *)in->body.kvp_ip_val.adapter_id),
292 UTF16_HOST_ENDIAN,
293 (wchar_t *)out->kvp_ip_val.adapter_id,
294 MAX_IP_ADDR_SIZE);
295 if (len < 0)
296 return len;
297
298 out->kvp_ip_val.dhcp_enabled =
299 in->body.kvp_ip_val.dhcp_enabled;
K. Y. Srinivasana500e0e2012-09-04 17:54:13 -0700300 out->kvp_ip_val.addr_family =
301 in->body.kvp_ip_val.addr_family;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700302 }
303
304 return 0;
305}
306
307static void process_ib_ipinfo(void *in_msg, void *out_msg, int op)
308{
309 struct hv_kvp_ip_msg *in = in_msg;
310 struct hv_kvp_msg *out = out_msg;
311
312 switch (op) {
313 case KVP_OP_SET_IP_INFO:
314 /*
315 * Transform all parameters into utf8 encoding.
316 */
317 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.ip_addr,
318 MAX_IP_ADDR_SIZE,
319 UTF16_LITTLE_ENDIAN,
320 (__u8 *)out->body.kvp_ip_val.ip_addr,
321 MAX_IP_ADDR_SIZE);
322
323 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.sub_net,
324 MAX_IP_ADDR_SIZE,
325 UTF16_LITTLE_ENDIAN,
326 (__u8 *)out->body.kvp_ip_val.sub_net,
327 MAX_IP_ADDR_SIZE);
328
329 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.gate_way,
330 MAX_GATEWAY_SIZE,
331 UTF16_LITTLE_ENDIAN,
332 (__u8 *)out->body.kvp_ip_val.gate_way,
333 MAX_GATEWAY_SIZE);
334
335 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.dns_addr,
336 MAX_IP_ADDR_SIZE,
337 UTF16_LITTLE_ENDIAN,
338 (__u8 *)out->body.kvp_ip_val.dns_addr,
339 MAX_IP_ADDR_SIZE);
340
341 out->body.kvp_ip_val.dhcp_enabled = in->kvp_ip_val.dhcp_enabled;
342
343 default:
344 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
345 MAX_ADAPTER_ID_SIZE,
346 UTF16_LITTLE_ENDIAN,
347 (__u8 *)out->body.kvp_ip_val.adapter_id,
348 MAX_ADAPTER_ID_SIZE);
349
350 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
351 }
352}
353
354
355
356
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700357static void
358kvp_send_key(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700359{
K. Y. Srinivasan2640335432012-02-02 16:56:50 -0800360 struct hv_kvp_msg *message;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700361 struct hv_kvp_msg *in_msg;
362 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
363 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
364 __u32 val32;
365 __u64 val64;
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100366 int rc;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700367
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700368 /* The transaction state is wrong. */
369 if (kvp_transaction.state != HVUTIL_HOSTMSG_RECEIVED)
370 return;
371
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700372 message = kzalloc(sizeof(*message), GFP_KERNEL);
Vitaly Kuznetsovb36fda32015-08-01 16:08:11 -0700373 if (!message)
374 return;
375
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700376 message->kvp_hdr.operation = operation;
377 message->kvp_hdr.pool = pool;
378 in_msg = kvp_transaction.kvp_msg;
379
380 /*
381 * The key/value strings sent from the host are encoded in
382 * in utf16; convert it to utf8 strings.
383 * The host assures us that the utf16 strings will not exceed
384 * the max lengths specified. We will however, reserve room
385 * for the string terminating character - in the utf16s_utf8s()
386 * function we limit the size of the buffer where the converted
387 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
388 * that the strings can be properly terminated!
389 */
390
391 switch (message->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700392 case KVP_OP_SET_IP_INFO:
393 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
394 break;
395 case KVP_OP_GET_IP_INFO:
396 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
397 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700398 case KVP_OP_SET:
399 switch (in_msg->body.kvp_set.data.value_type) {
400 case REG_SZ:
401 /*
402 * The value is a string - utf16 encoding.
403 */
404 message->body.kvp_set.data.value_size =
405 utf16s_to_utf8s(
406 (wchar_t *)in_msg->body.kvp_set.data.value,
407 in_msg->body.kvp_set.data.value_size,
408 UTF16_LITTLE_ENDIAN,
409 message->body.kvp_set.data.value,
410 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
411 break;
412
413 case REG_U32:
414 /*
415 * The value is a 32 bit scalar.
416 * We save this as a utf8 string.
417 */
418 val32 = in_msg->body.kvp_set.data.value_u32;
419 message->body.kvp_set.data.value_size =
420 sprintf(message->body.kvp_set.data.value,
421 "%d", val32) + 1;
422 break;
423
424 case REG_U64:
425 /*
426 * The value is a 64 bit scalar.
427 * We save this as a utf8 string.
428 */
429 val64 = in_msg->body.kvp_set.data.value_u64;
430 message->body.kvp_set.data.value_size =
431 sprintf(message->body.kvp_set.data.value,
432 "%llu", val64) + 1;
433 break;
434
435 }
436 case KVP_OP_GET:
437 message->body.kvp_set.data.key_size =
438 utf16s_to_utf8s(
439 (wchar_t *)in_msg->body.kvp_set.data.key,
440 in_msg->body.kvp_set.data.key_size,
441 UTF16_LITTLE_ENDIAN,
442 message->body.kvp_set.data.key,
443 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
444 break;
445
446 case KVP_OP_DELETE:
447 message->body.kvp_delete.key_size =
448 utf16s_to_utf8s(
449 (wchar_t *)in_msg->body.kvp_delete.key,
450 in_msg->body.kvp_delete.key_size,
451 UTF16_LITTLE_ENDIAN,
452 message->body.kvp_delete.key,
453 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
454 break;
455
456 case KVP_OP_ENUMERATE:
457 message->body.kvp_enum_data.index =
458 in_msg->body.kvp_enum_data.index;
459 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700460 }
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700461
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700462 kvp_transaction.state = HVUTIL_USERSPACE_REQ;
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700463 rc = hvutil_transport_send(hvt, message, sizeof(*message), NULL);
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100464 if (rc) {
465 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700466 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100467 kvp_respond_to_host(message, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700468 kvp_transaction.state = HVUTIL_READY;
469 }
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100470 }
471
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700472 kfree(message);
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700473
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700474 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700475}
476
477/*
478 * Send a response back to the host.
479 */
480
481static void
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700482kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700483{
484 struct hv_kvp_msg *kvp_msg;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700485 struct hv_kvp_exchg_msg_value *kvp_data;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700486 char *key_name;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700487 char *value;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700488 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700489 int keylen = 0;
490 int valuelen = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700491 u32 buf_len;
492 struct vmbus_channel *channel;
493 u64 req_id;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700494 int ret;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700495
496 /*
Ky Srinivasan245ba562010-12-16 18:54:16 -0700497 * Copy the global state for completing the transaction. Note that
498 * only one transaction can be active at a time.
499 */
500
501 buf_len = kvp_transaction.recv_len;
502 channel = kvp_transaction.recv_channel;
503 req_id = kvp_transaction.recv_req_id;
504
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700505 icmsghdrp = (struct icmsg_hdr *)
506 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
507
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700508 if (channel->onchannel_callback == NULL)
509 /*
510 * We have raced with util driver being unloaded;
511 * silently return.
512 */
513 return;
514
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700515 icmsghdrp->status = error;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700516
517 /*
K. Y. Srinivasanadc80ae2012-03-16 08:02:27 -0700518 * If the error parameter is set, terminate the host's enumeration
519 * on this pool.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700520 */
521 if (error) {
522 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700523 * Something failed or we have timedout;
524 * terminate the current host-side iteration.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700525 */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700526 goto response_done;
527 }
528
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700529 kvp_msg = (struct hv_kvp_msg *)
530 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
531 sizeof(struct icmsg_hdr)];
532
533 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700534 case KVP_OP_GET_IP_INFO:
535 ret = process_ob_ipinfo(msg_to_host,
536 (struct hv_kvp_ip_msg *)kvp_msg,
537 KVP_OP_GET_IP_INFO);
538 if (ret < 0)
539 icmsghdrp->status = HV_E_FAIL;
540
541 goto response_done;
542 case KVP_OP_SET_IP_INFO:
543 goto response_done;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700544 case KVP_OP_GET:
545 kvp_data = &kvp_msg->body.kvp_get.data;
546 goto copy_value;
547
548 case KVP_OP_SET:
549 case KVP_OP_DELETE:
550 goto response_done;
551
552 default:
553 break;
554 }
555
556 kvp_data = &kvp_msg->body.kvp_enum_data.data;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700557 key_name = msg_to_host->body.kvp_enum_data.data.key;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700558
Ky Srinivasan245ba562010-12-16 18:54:16 -0700559 /*
560 * The windows host expects the key/value pair to be encoded
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700561 * in utf16. Ensure that the key/value size reported to the host
562 * will be less than or equal to the MAX size (including the
563 * terminating character).
Ky Srinivasan245ba562010-12-16 18:54:16 -0700564 */
Alan Stern0720a062011-11-17 16:42:19 -0500565 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700566 (wchar_t *) kvp_data->key,
567 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
568 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700569
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700570copy_value:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700571 value = msg_to_host->body.kvp_enum_data.data.value;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700572 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
573 (wchar_t *) kvp_data->value,
574 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
575 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
576
577 /*
578 * If the utf8s to utf16s conversion failed; notify host
579 * of the error.
580 */
581 if ((keylen < 0) || (valuelen < 0))
582 icmsghdrp->status = HV_E_FAIL;
583
584 kvp_data->value_type = REG_SZ; /* all our values are strings */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700585
586response_done:
587 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
588
589 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800590 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700591}
592
593/*
594 * This callback is invoked when we get a KVP message from the host.
595 * The host ensures that only one KVP transaction can be active at a time.
596 * KVP implementation in Linux needs to forward the key to a user-mde
597 * component to retrive the corresponding value. Consequently, we cannot
598 * respond to the host in the conext of this callback. Since the host
599 * guarantees that at most only one transaction can be active at a time,
600 * we stash away the transaction state in a set of global variables.
601 */
602
603void hv_kvp_onchannelcallback(void *context)
604{
605 struct vmbus_channel *channel = context;
606 u32 recvlen;
607 u64 requestid;
608
609 struct hv_kvp_msg *kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700610
611 struct icmsg_hdr *icmsghdrp;
612 struct icmsg_negotiate *negop = NULL;
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700613 int util_fw_version;
614 int kvp_srv_version;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700615 static enum {NEGO_NOT_STARTED,
616 NEGO_IN_PROGRESS,
617 NEGO_FINISHED} host_negotiatied = NEGO_NOT_STARTED;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700618
Long Li68747bc2017-04-30 16:21:19 -0700619 if (kvp_transaction.state < HVUTIL_READY) {
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700620 /*
621 * If userspace daemon is not connected and host is asking
622 * us to negotiate we need to delay to not lose messages.
623 * This is important for Failover IP setting.
624 */
Long Li68747bc2017-04-30 16:21:19 -0700625 if (host_negotiatied == NEGO_NOT_STARTED) {
626 host_negotiatied = NEGO_IN_PROGRESS;
627 schedule_delayed_work(&kvp_host_handshake_work,
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700628 HV_UTIL_NEGO_TIMEOUT * HZ);
Long Li68747bc2017-04-30 16:21:19 -0700629 }
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700630 return;
631 }
Olaf Hering3cace4a2015-12-14 16:01:33 -0800632 if (kvp_transaction.state > HVUTIL_READY)
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700633 return;
Long Li68747bc2017-04-30 16:21:19 -0700634recheck:
K. Y. Srinivasan9bd2d0d2014-07-07 16:34:25 -0700635 vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 4, &recvlen,
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700636 &requestid);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700637
638 if (recvlen > 0) {
Ky Srinivasan245ba562010-12-16 18:54:16 -0700639 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
640 sizeof(struct vmbuspipe_hdr)];
641
642 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700643 /*
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700644 * Based on the host, select appropriate
645 * framework and service versions we will
646 * negotiate.
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700647 */
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700648 switch (vmbus_proto_version) {
649 case (VERSION_WS2008):
650 util_fw_version = UTIL_WS2K8_FW_VERSION;
651 kvp_srv_version = WS2008_SRV_VERSION;
652 break;
653 case (VERSION_WIN7):
654 util_fw_version = UTIL_FW_VERSION;
655 kvp_srv_version = WIN7_SRV_VERSION;
656 break;
657 default:
658 util_fw_version = UTIL_FW_VERSION;
659 kvp_srv_version = WIN8_SRV_VERSION;
660 }
K. Y. Srinivasanc836d0a2012-05-12 13:44:58 -0700661 vmbus_prep_negotiate_resp(icmsghdrp, negop,
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700662 recv_buffer, util_fw_version,
663 kvp_srv_version);
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700664
Ky Srinivasan245ba562010-12-16 18:54:16 -0700665 } else {
666 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
667 sizeof(struct vmbuspipe_hdr) +
668 sizeof(struct icmsg_hdr)];
669
Ky Srinivasan245ba562010-12-16 18:54:16 -0700670 /*
671 * Stash away this global state for completing the
672 * transaction; note transactions are serialized.
673 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700674
Ky Srinivasan245ba562010-12-16 18:54:16 -0700675 kvp_transaction.recv_len = recvlen;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700676 kvp_transaction.recv_req_id = requestid;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700677 kvp_transaction.kvp_msg = kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700678
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700679 if (kvp_transaction.state < HVUTIL_READY) {
680 /* Userspace is not registered yet */
681 kvp_respond_to_host(NULL, HV_E_FAIL);
682 return;
683 }
684 kvp_transaction.state = HVUTIL_HOSTMSG_RECEIVED;
685
Ky Srinivasan245ba562010-12-16 18:54:16 -0700686 /*
687 * Get the information from the
688 * user-mode component.
689 * component. This transaction will be
690 * completed when we get the value from
691 * the user-mode component.
692 * Set a timeout to deal with
693 * user-mode not responding.
694 */
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700695 schedule_work(&kvp_sendkey_work);
K. Y. Srinivasanc0b200c2015-12-14 16:01:32 -0800696 schedule_delayed_work(&kvp_timeout_work,
697 HV_UTIL_TIMEOUT * HZ);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700698
699 return;
700
701 }
702
Ky Srinivasan245ba562010-12-16 18:54:16 -0700703 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
704 | ICMSGHDRFLAG_RESPONSE;
705
706 vmbus_sendpacket(channel, recv_buffer,
707 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800708 VM_PKT_DATA_INBAND, 0);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700709
710 host_negotiatied = NEGO_FINISHED;
Long Li68747bc2017-04-30 16:21:19 -0700711
712 goto recheck;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700713 }
714
715}
716
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700717static void kvp_on_reset(void)
718{
719 if (cancel_delayed_work_sync(&kvp_timeout_work))
720 kvp_respond_to_host(NULL, HV_E_FAIL);
721 kvp_transaction.state = HVUTIL_DEVICE_INIT;
722}
723
Ky Srinivasan245ba562010-12-16 18:54:16 -0700724int
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700725hv_kvp_init(struct hv_util_service *srv)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700726{
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700727 recv_buffer = srv->recv_buffer;
K. Y. Srinivasanb9830d12016-02-26 15:13:19 -0800728 kvp_transaction.recv_channel = srv->channel;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700729
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700730 /*
731 * When this driver loads, the user level daemon that
732 * processes the host requests may not yet be running.
733 * Defer processing channel callbacks until the daemon
734 * has registered.
735 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700736 kvp_transaction.state = HVUTIL_DEVICE_INIT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700737
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700738 hvt = hvutil_transport_init(kvp_devname, CN_KVP_IDX, CN_KVP_VAL,
739 kvp_on_msg, kvp_on_reset);
740 if (!hvt)
741 return -EFAULT;
742
Ky Srinivasan245ba562010-12-16 18:54:16 -0700743 return 0;
744}
745
746void hv_kvp_deinit(void)
747{
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700748 kvp_transaction.state = HVUTIL_DEVICE_DYING;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700749 cancel_delayed_work_sync(&kvp_host_handshake_work);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700750 cancel_delayed_work_sync(&kvp_timeout_work);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700751 cancel_work_sync(&kvp_sendkey_work);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700752 hvutil_transport_destroy(hvt);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700753}