blob: 5054d1105236e15b3ec3912026fd08ae3bc99044 [file] [log] [blame]
Ky Srinivasan245ba562010-12-16 18:54:16 -07001/*
2 * An implementation of key value pair (KVP) functionality for Linux.
3 *
4 *
5 * Copyright (C) 2010, Novell, Inc.
6 * Author : K. Y. Srinivasan <ksrinivasan@novell.com>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published
10 * by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
15 * NON INFRINGEMENT. See the GNU General Public License for more
16 * details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 */
Hank Janssenaf7a5b62011-03-29 13:58:49 -070023#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
Ky Srinivasan245ba562010-12-16 18:54:16 -070024
25#include <linux/net.h>
26#include <linux/nls.h>
27#include <linux/connector.h>
28#include <linux/workqueue.h>
Greg Kroah-Hartman46a97192011-10-04 12:29:52 -070029#include <linux/hyperv.h>
Ky Srinivasan245ba562010-12-16 18:54:16 -070030
Vitaly Kuznetsov3647a832015-04-11 18:07:39 -070031#include "hyperv_vmbus.h"
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -070032#include "hv_utils_transport.h"
Ky Srinivasan245ba562010-12-16 18:54:16 -070033
K. Y. Srinivasan67413352013-07-02 10:31:30 -070034/*
35 * Pre win8 version numbers used in ws2008 and ws 2008 r2 (win7)
36 */
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070037#define WS2008_SRV_MAJOR 1
38#define WS2008_SRV_MINOR 0
39#define WS2008_SRV_VERSION (WS2008_SRV_MAJOR << 16 | WS2008_SRV_MINOR)
40
K. Y. Srinivasan67413352013-07-02 10:31:30 -070041#define WIN7_SRV_MAJOR 3
42#define WIN7_SRV_MINOR 0
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070043#define WIN7_SRV_VERSION (WIN7_SRV_MAJOR << 16 | WIN7_SRV_MINOR)
K. Y. Srinivasan67413352013-07-02 10:31:30 -070044
45#define WIN8_SRV_MAJOR 4
46#define WIN8_SRV_MINOR 0
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070047#define WIN8_SRV_VERSION (WIN8_SRV_MAJOR << 16 | WIN8_SRV_MINOR)
Ky Srinivasan245ba562010-12-16 18:54:16 -070048
Alex Nga1656452017-01-28 12:37:17 -070049#define KVP_VER_COUNT 3
50static const int kvp_versions[] = {
51 WIN8_SRV_VERSION,
52 WIN7_SRV_VERSION,
53 WS2008_SRV_VERSION
54};
55
56#define FW_VER_COUNT 2
57static const int fw_versions[] = {
58 UTIL_FW_VERSION,
59 UTIL_WS2K8_FW_VERSION
60};
61
Ky Srinivasan245ba562010-12-16 18:54:16 -070062/*
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070063 * Global state maintained for transaction that is being processed. For a class
64 * of integration services, including the "KVP service", the specified protocol
65 * is a "request/response" protocol which means that there can only be single
66 * outstanding transaction from the host at any given point in time. We use
67 * this to simplify memory management in this driver - we cache and process
68 * only one message at a time.
Ky Srinivasan245ba562010-12-16 18:54:16 -070069 *
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070070 * While the request/response protocol is guaranteed by the host, we further
71 * ensure this by serializing packet processing in this driver - we do not
Stephen Hemmingerbdc1dd42017-03-04 18:27:14 -070072 * read additional packets from the VMBUS until the current packet is fully
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070073 * handled.
Ky Srinivasan245ba562010-12-16 18:54:16 -070074 */
75
76static struct {
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -070077 int state; /* hvutil_device_state */
Ky Srinivasan245ba562010-12-16 18:54:16 -070078 int recv_len; /* number of bytes received. */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -070079 struct hv_kvp_msg *kvp_msg; /* current message */
Ky Srinivasan245ba562010-12-16 18:54:16 -070080 struct vmbus_channel *recv_channel; /* chn we got the request */
81 u64 recv_req_id; /* request ID. */
82} kvp_transaction;
83
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070084/*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070085 * This state maintains the version number registered by the daemon.
86 */
87static int dm_reg_value;
88
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070089static void kvp_send_key(struct work_struct *dummy);
Ky Srinivasan245ba562010-12-16 18:54:16 -070090
K. Y. Srinivasan76e5f812011-10-04 14:00:02 -070091
K. Y. Srinivasan03db7722012-08-16 18:32:12 -070092static void kvp_respond_to_host(struct hv_kvp_msg *msg, int error);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070093static void kvp_timeout_func(struct work_struct *dummy);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -070094static void kvp_host_handshake_func(struct work_struct *dummy);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070095static void kvp_register(int);
Ky Srinivasan245ba562010-12-16 18:54:16 -070096
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -070097static DECLARE_DELAYED_WORK(kvp_timeout_work, kvp_timeout_func);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -070098static DECLARE_DELAYED_WORK(kvp_host_handshake_work, kvp_host_handshake_func);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070099static DECLARE_WORK(kvp_sendkey_work, kvp_send_key);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700100
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700101static const char kvp_devname[] = "vmbus/hv_kvp";
Ky Srinivasan245ba562010-12-16 18:54:16 -0700102static u8 *recv_buffer;
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700103static struct hvutil_transport *hvt;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700104/*
105 * Register the kernel component with the user-level daemon.
106 * As part of this registration, pass the LIC version number.
Olaf Heringcfc25992013-05-29 11:29:07 +0200107 * This number has no meaning, it satisfies the registration protocol.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700108 */
Olaf Heringcfc25992013-05-29 11:29:07 +0200109#define HV_DRV_VERSION "3.1"
Ky Srinivasan245ba562010-12-16 18:54:16 -0700110
Olaf Hering3cace4a2015-12-14 16:01:33 -0800111static void kvp_poll_wrapper(void *channel)
112{
113 /* Transaction is finished, reset the state here to avoid races. */
114 kvp_transaction.state = HVUTIL_READY;
Long Lia3ade8c2017-04-30 16:21:19 -0700115 tasklet_schedule(&((struct vmbus_channel *)channel)->callback_event);
Olaf Hering3cace4a2015-12-14 16:01:33 -0800116}
117
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700118static void kvp_register_done(void)
119{
120 /*
121 * If we're still negotiating with the host cancel the timeout
122 * work to not poll the channel twice.
123 */
124 pr_debug("KVP: userspace daemon registered\n");
125 cancel_delayed_work_sync(&kvp_host_handshake_work);
126 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
127}
128
Ky Srinivasan245ba562010-12-16 18:54:16 -0700129static void
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700130kvp_register(int reg_value)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700131{
132
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800133 struct hv_kvp_msg *kvp_msg;
134 char *version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700135
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700136 kvp_msg = kzalloc(sizeof(*kvp_msg), GFP_KERNEL);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700137
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700138 if (kvp_msg) {
K. Y. Srinivasane485ceac2012-03-10 15:32:08 -0800139 version = kvp_msg->body.kvp_register.version;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700140 kvp_msg->kvp_hdr.operation = reg_value;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800141 strcpy(version, HV_DRV_VERSION);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700142
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700143 hvutil_transport_send(hvt, kvp_msg, sizeof(*kvp_msg),
144 kvp_register_done);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700145 kfree(kvp_msg);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700146 }
147}
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700148
149static void kvp_timeout_func(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700150{
151 /*
152 * If the timer fires, the user-mode component has not responded;
153 * process the pending transaction.
154 */
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700155 kvp_respond_to_host(NULL, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700156
Olaf Hering3cace4a2015-12-14 16:01:33 -0800157 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700158}
159
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700160static void kvp_host_handshake_func(struct work_struct *dummy)
161{
Long Lia3ade8c2017-04-30 16:21:19 -0700162 tasklet_schedule(&kvp_transaction.recv_channel->callback_event);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700163}
164
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700165static int kvp_handle_handshake(struct hv_kvp_msg *msg)
166{
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700167 switch (msg->kvp_hdr.operation) {
168 case KVP_OP_REGISTER:
169 dm_reg_value = KVP_OP_REGISTER;
170 pr_info("KVP: IP injection functionality not available\n");
171 pr_info("KVP: Upgrade the KVP daemon\n");
172 break;
173 case KVP_OP_REGISTER1:
174 dm_reg_value = KVP_OP_REGISTER1;
175 break;
176 default:
177 pr_info("KVP: incompatible daemon\n");
178 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
179 KVP_OP_REGISTER1, msg->kvp_hdr.operation);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700180 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700181 }
182
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700183 /*
184 * We have a compatible daemon; complete the handshake.
185 */
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700186 pr_debug("KVP: userspace daemon ver. %d connected\n",
187 msg->kvp_hdr.operation);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700188 kvp_register(dm_reg_value);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700189
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700190 return 0;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700191}
192
193
Ky Srinivasan245ba562010-12-16 18:54:16 -0700194/*
195 * Callback when data is received from user mode.
196 */
197
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700198static int kvp_on_msg(void *msg, int len)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700199{
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700200 struct hv_kvp_msg *message = (struct hv_kvp_msg *)msg;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800201 struct hv_kvp_msg_enumerate *data;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700202 int error = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700203
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700204 if (len < sizeof(*message))
205 return -EINVAL;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700206
207 /*
208 * If we are negotiating the version information
209 * with the daemon; handle that first.
210 */
211
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700212 if (kvp_transaction.state < HVUTIL_READY) {
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700213 return kvp_handle_handshake(message);
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700214 }
215
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700216 /* We didn't send anything to userspace so the reply is spurious */
217 if (kvp_transaction.state < HVUTIL_USERSPACE_REQ)
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700218 return -EINVAL;
219
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700220 kvp_transaction.state = HVUTIL_USERSPACE_RECV;
221
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700222 /*
223 * Based on the version of the daemon, we propagate errors from the
224 * daemon differently.
225 */
226
227 data = &message->body.kvp_enum_data;
228
229 switch (dm_reg_value) {
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700230 case KVP_OP_REGISTER:
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700231 /*
232 * Null string is used to pass back error condition.
233 */
234 if (data->data.key[0] == 0)
235 error = HV_S_CONT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700236 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700237
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700238 case KVP_OP_REGISTER1:
Ky Srinivasan245ba562010-12-16 18:54:16 -0700239 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700240 * We use the message header information from
241 * the user level daemon to transmit errors.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700242 */
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700243 error = message->error;
244 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700245 }
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700246
247 /*
248 * Complete the transaction by forwarding the key value
249 * to the host. But first, cancel the timeout.
250 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700251 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700252 kvp_respond_to_host(message, error);
Olaf Hering3cace4a2015-12-14 16:01:33 -0800253 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700254 }
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700255
256 return 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700257}
258
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700259
260static int process_ob_ipinfo(void *in_msg, void *out_msg, int op)
261{
262 struct hv_kvp_msg *in = in_msg;
263 struct hv_kvp_ip_msg *out = out_msg;
264 int len;
265
266 switch (op) {
267 case KVP_OP_GET_IP_INFO:
268 /*
269 * Transform all parameters into utf16 encoding.
270 */
271 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.ip_addr,
272 strlen((char *)in->body.kvp_ip_val.ip_addr),
273 UTF16_HOST_ENDIAN,
274 (wchar_t *)out->kvp_ip_val.ip_addr,
275 MAX_IP_ADDR_SIZE);
276 if (len < 0)
277 return len;
278
279 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.sub_net,
280 strlen((char *)in->body.kvp_ip_val.sub_net),
281 UTF16_HOST_ENDIAN,
282 (wchar_t *)out->kvp_ip_val.sub_net,
283 MAX_IP_ADDR_SIZE);
284 if (len < 0)
285 return len;
286
287 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.gate_way,
288 strlen((char *)in->body.kvp_ip_val.gate_way),
289 UTF16_HOST_ENDIAN,
290 (wchar_t *)out->kvp_ip_val.gate_way,
291 MAX_GATEWAY_SIZE);
292 if (len < 0)
293 return len;
294
295 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.dns_addr,
296 strlen((char *)in->body.kvp_ip_val.dns_addr),
297 UTF16_HOST_ENDIAN,
298 (wchar_t *)out->kvp_ip_val.dns_addr,
299 MAX_IP_ADDR_SIZE);
300 if (len < 0)
301 return len;
302
303 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.adapter_id,
304 strlen((char *)in->body.kvp_ip_val.adapter_id),
305 UTF16_HOST_ENDIAN,
306 (wchar_t *)out->kvp_ip_val.adapter_id,
Alex Ngddce54b2017-08-06 13:12:56 -0700307 MAX_ADAPTER_ID_SIZE);
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700308 if (len < 0)
309 return len;
310
311 out->kvp_ip_val.dhcp_enabled =
312 in->body.kvp_ip_val.dhcp_enabled;
K. Y. Srinivasana500e0e2012-09-04 17:54:13 -0700313 out->kvp_ip_val.addr_family =
314 in->body.kvp_ip_val.addr_family;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700315 }
316
317 return 0;
318}
319
320static void process_ib_ipinfo(void *in_msg, void *out_msg, int op)
321{
322 struct hv_kvp_ip_msg *in = in_msg;
323 struct hv_kvp_msg *out = out_msg;
324
325 switch (op) {
326 case KVP_OP_SET_IP_INFO:
327 /*
328 * Transform all parameters into utf8 encoding.
329 */
330 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.ip_addr,
331 MAX_IP_ADDR_SIZE,
332 UTF16_LITTLE_ENDIAN,
333 (__u8 *)out->body.kvp_ip_val.ip_addr,
334 MAX_IP_ADDR_SIZE);
335
336 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.sub_net,
337 MAX_IP_ADDR_SIZE,
338 UTF16_LITTLE_ENDIAN,
339 (__u8 *)out->body.kvp_ip_val.sub_net,
340 MAX_IP_ADDR_SIZE);
341
342 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.gate_way,
343 MAX_GATEWAY_SIZE,
344 UTF16_LITTLE_ENDIAN,
345 (__u8 *)out->body.kvp_ip_val.gate_way,
346 MAX_GATEWAY_SIZE);
347
348 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.dns_addr,
349 MAX_IP_ADDR_SIZE,
350 UTF16_LITTLE_ENDIAN,
351 (__u8 *)out->body.kvp_ip_val.dns_addr,
352 MAX_IP_ADDR_SIZE);
353
354 out->body.kvp_ip_val.dhcp_enabled = in->kvp_ip_val.dhcp_enabled;
355
Dexuan Cuie670de52018-10-18 05:09:30 +0000356 /* fallthrough */
357
358 case KVP_OP_GET_IP_INFO:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700359 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
360 MAX_ADAPTER_ID_SIZE,
361 UTF16_LITTLE_ENDIAN,
362 (__u8 *)out->body.kvp_ip_val.adapter_id,
363 MAX_ADAPTER_ID_SIZE);
364
365 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
366 }
367}
368
369
370
371
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700372static void
373kvp_send_key(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700374{
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800375 struct hv_kvp_msg *message;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700376 struct hv_kvp_msg *in_msg;
377 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
378 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
379 __u32 val32;
380 __u64 val64;
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100381 int rc;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700382
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700383 /* The transaction state is wrong. */
384 if (kvp_transaction.state != HVUTIL_HOSTMSG_RECEIVED)
385 return;
386
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700387 message = kzalloc(sizeof(*message), GFP_KERNEL);
Vitaly Kuznetsovb36fda332015-08-01 16:08:11 -0700388 if (!message)
389 return;
390
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700391 message->kvp_hdr.operation = operation;
392 message->kvp_hdr.pool = pool;
393 in_msg = kvp_transaction.kvp_msg;
394
395 /*
396 * The key/value strings sent from the host are encoded in
397 * in utf16; convert it to utf8 strings.
398 * The host assures us that the utf16 strings will not exceed
399 * the max lengths specified. We will however, reserve room
400 * for the string terminating character - in the utf16s_utf8s()
401 * function we limit the size of the buffer where the converted
Stephen Hemmingerbdc1dd42017-03-04 18:27:14 -0700402 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to guarantee
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700403 * that the strings can be properly terminated!
404 */
405
406 switch (message->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700407 case KVP_OP_SET_IP_INFO:
408 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
409 break;
410 case KVP_OP_GET_IP_INFO:
Dexuan Cuie670de52018-10-18 05:09:30 +0000411 /*
412 * We only need to pass on the info of operation, adapter_id
413 * and addr_family to the userland kvp daemon.
414 */
415 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700416 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700417 case KVP_OP_SET:
418 switch (in_msg->body.kvp_set.data.value_type) {
419 case REG_SZ:
420 /*
421 * The value is a string - utf16 encoding.
422 */
423 message->body.kvp_set.data.value_size =
424 utf16s_to_utf8s(
425 (wchar_t *)in_msg->body.kvp_set.data.value,
426 in_msg->body.kvp_set.data.value_size,
427 UTF16_LITTLE_ENDIAN,
428 message->body.kvp_set.data.value,
429 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
Dexuan Cuid544c222018-09-23 21:10:42 +0000430 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700431
432 case REG_U32:
433 /*
434 * The value is a 32 bit scalar.
435 * We save this as a utf8 string.
436 */
437 val32 = in_msg->body.kvp_set.data.value_u32;
438 message->body.kvp_set.data.value_size =
439 sprintf(message->body.kvp_set.data.value,
Dexuan Cui16d13422018-10-18 05:09:31 +0000440 "%u", val32) + 1;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700441 break;
442
443 case REG_U64:
444 /*
445 * The value is a 64 bit scalar.
446 * We save this as a utf8 string.
447 */
448 val64 = in_msg->body.kvp_set.data.value_u64;
449 message->body.kvp_set.data.value_size =
450 sprintf(message->body.kvp_set.data.value,
451 "%llu", val64) + 1;
452 break;
453
454 }
Dexuan Cuifc62c3b2018-09-23 21:10:43 +0000455
Dexuan Cuie670de52018-10-18 05:09:30 +0000456 /*
457 * The key is always a string - utf16 encoding.
458 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700459 message->body.kvp_set.data.key_size =
460 utf16s_to_utf8s(
461 (wchar_t *)in_msg->body.kvp_set.data.key,
462 in_msg->body.kvp_set.data.key_size,
463 UTF16_LITTLE_ENDIAN,
464 message->body.kvp_set.data.key,
465 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
Dexuan Cuie670de52018-10-18 05:09:30 +0000466
467 break;
468
469 case KVP_OP_GET:
470 message->body.kvp_get.data.key_size =
471 utf16s_to_utf8s(
472 (wchar_t *)in_msg->body.kvp_get.data.key,
473 in_msg->body.kvp_get.data.key_size,
474 UTF16_LITTLE_ENDIAN,
475 message->body.kvp_get.data.key,
476 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
Dexuan Cuid544c222018-09-23 21:10:42 +0000477 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700478
479 case KVP_OP_DELETE:
480 message->body.kvp_delete.key_size =
481 utf16s_to_utf8s(
482 (wchar_t *)in_msg->body.kvp_delete.key,
483 in_msg->body.kvp_delete.key_size,
484 UTF16_LITTLE_ENDIAN,
485 message->body.kvp_delete.key,
486 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
Dexuan Cuid544c222018-09-23 21:10:42 +0000487 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700488
489 case KVP_OP_ENUMERATE:
490 message->body.kvp_enum_data.index =
491 in_msg->body.kvp_enum_data.index;
Dexuan Cuid544c222018-09-23 21:10:42 +0000492 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700493 }
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700494
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700495 kvp_transaction.state = HVUTIL_USERSPACE_REQ;
Vitaly Kuznetsove0fa3e52016-06-09 17:08:57 -0700496 rc = hvutil_transport_send(hvt, message, sizeof(*message), NULL);
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100497 if (rc) {
498 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700499 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100500 kvp_respond_to_host(message, HV_E_FAIL);
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700501 kvp_transaction.state = HVUTIL_READY;
502 }
Vitaly Kuznetsov8d9560e2014-11-06 18:21:25 +0100503 }
504
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700505 kfree(message);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700506}
507
508/*
509 * Send a response back to the host.
510 */
511
512static void
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700513kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700514{
515 struct hv_kvp_msg *kvp_msg;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700516 struct hv_kvp_exchg_msg_value *kvp_data;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700517 char *key_name;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700518 char *value;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700519 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700520 int keylen = 0;
521 int valuelen = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700522 u32 buf_len;
523 struct vmbus_channel *channel;
524 u64 req_id;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700525 int ret;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700526
527 /*
Ky Srinivasan245ba562010-12-16 18:54:16 -0700528 * Copy the global state for completing the transaction. Note that
529 * only one transaction can be active at a time.
530 */
531
532 buf_len = kvp_transaction.recv_len;
533 channel = kvp_transaction.recv_channel;
534 req_id = kvp_transaction.recv_req_id;
535
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700536 icmsghdrp = (struct icmsg_hdr *)
537 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
538
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700539 if (channel->onchannel_callback == NULL)
540 /*
541 * We have raced with util driver being unloaded;
542 * silently return.
543 */
544 return;
545
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700546 icmsghdrp->status = error;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700547
548 /*
K. Y. Srinivasanadc80ae2012-03-16 08:02:27 -0700549 * If the error parameter is set, terminate the host's enumeration
550 * on this pool.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700551 */
552 if (error) {
553 /*
Stephen Hemmingerbdc1dd42017-03-04 18:27:14 -0700554 * Something failed or we have timed out;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700555 * terminate the current host-side iteration.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700556 */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700557 goto response_done;
558 }
559
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700560 kvp_msg = (struct hv_kvp_msg *)
561 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
562 sizeof(struct icmsg_hdr)];
563
564 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700565 case KVP_OP_GET_IP_INFO:
566 ret = process_ob_ipinfo(msg_to_host,
567 (struct hv_kvp_ip_msg *)kvp_msg,
568 KVP_OP_GET_IP_INFO);
569 if (ret < 0)
570 icmsghdrp->status = HV_E_FAIL;
571
572 goto response_done;
573 case KVP_OP_SET_IP_INFO:
574 goto response_done;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700575 case KVP_OP_GET:
576 kvp_data = &kvp_msg->body.kvp_get.data;
577 goto copy_value;
578
579 case KVP_OP_SET:
580 case KVP_OP_DELETE:
581 goto response_done;
582
583 default:
584 break;
585 }
586
587 kvp_data = &kvp_msg->body.kvp_enum_data.data;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700588 key_name = msg_to_host->body.kvp_enum_data.data.key;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700589
Ky Srinivasan245ba562010-12-16 18:54:16 -0700590 /*
591 * The windows host expects the key/value pair to be encoded
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700592 * in utf16. Ensure that the key/value size reported to the host
593 * will be less than or equal to the MAX size (including the
594 * terminating character).
Ky Srinivasan245ba562010-12-16 18:54:16 -0700595 */
Alan Stern0720a062011-11-17 16:42:19 -0500596 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700597 (wchar_t *) kvp_data->key,
598 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
599 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700600
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700601copy_value:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700602 value = msg_to_host->body.kvp_enum_data.data.value;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700603 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
604 (wchar_t *) kvp_data->value,
605 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
606 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
607
608 /*
609 * If the utf8s to utf16s conversion failed; notify host
610 * of the error.
611 */
612 if ((keylen < 0) || (valuelen < 0))
613 icmsghdrp->status = HV_E_FAIL;
614
615 kvp_data->value_type = REG_SZ; /* all our values are strings */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700616
617response_done:
618 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
619
620 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800621 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700622}
623
624/*
625 * This callback is invoked when we get a KVP message from the host.
626 * The host ensures that only one KVP transaction can be active at a time.
627 * KVP implementation in Linux needs to forward the key to a user-mde
Stephen Hemmingerbdc1dd42017-03-04 18:27:14 -0700628 * component to retrieve the corresponding value. Consequently, we cannot
629 * respond to the host in the context of this callback. Since the host
Ky Srinivasan245ba562010-12-16 18:54:16 -0700630 * guarantees that at most only one transaction can be active at a time,
631 * we stash away the transaction state in a set of global variables.
632 */
633
634void hv_kvp_onchannelcallback(void *context)
635{
636 struct vmbus_channel *channel = context;
637 u32 recvlen;
638 u64 requestid;
639
640 struct hv_kvp_msg *kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700641
642 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700643 int kvp_srv_version;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700644 static enum {NEGO_NOT_STARTED,
645 NEGO_IN_PROGRESS,
646 NEGO_FINISHED} host_negotiatied = NEGO_NOT_STARTED;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700647
Long Lia3ade8c2017-04-30 16:21:19 -0700648 if (kvp_transaction.state < HVUTIL_READY) {
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700649 /*
650 * If userspace daemon is not connected and host is asking
651 * us to negotiate we need to delay to not lose messages.
652 * This is important for Failover IP setting.
653 */
Long Lia3ade8c2017-04-30 16:21:19 -0700654 if (host_negotiatied == NEGO_NOT_STARTED) {
655 host_negotiatied = NEGO_IN_PROGRESS;
656 schedule_delayed_work(&kvp_host_handshake_work,
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700657 HV_UTIL_NEGO_TIMEOUT * HZ);
Long Lia3ade8c2017-04-30 16:21:19 -0700658 }
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700659 return;
660 }
Olaf Hering3cace4a2015-12-14 16:01:33 -0800661 if (kvp_transaction.state > HVUTIL_READY)
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700662 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700663
K. Y. Srinivasan9bd2d0d2014-07-07 16:34:25 -0700664 vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 4, &recvlen,
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700665 &requestid);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700666
667 if (recvlen > 0) {
Ky Srinivasan245ba562010-12-16 18:54:16 -0700668 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
669 sizeof(struct vmbuspipe_hdr)];
670
671 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
Alex Ng1274a692017-01-28 12:37:18 -0700672 if (vmbus_prep_negotiate_resp(icmsghdrp,
Alex Nga1656452017-01-28 12:37:17 -0700673 recv_buffer, fw_versions, FW_VER_COUNT,
674 kvp_versions, KVP_VER_COUNT,
Alex Ng1274a692017-01-28 12:37:18 -0700675 NULL, &kvp_srv_version)) {
676 pr_info("KVP IC version %d.%d\n",
677 kvp_srv_version >> 16,
678 kvp_srv_version & 0xFFFF);
679 }
Ky Srinivasan245ba562010-12-16 18:54:16 -0700680 } else {
681 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
682 sizeof(struct vmbuspipe_hdr) +
683 sizeof(struct icmsg_hdr)];
684
Ky Srinivasan245ba562010-12-16 18:54:16 -0700685 /*
686 * Stash away this global state for completing the
687 * transaction; note transactions are serialized.
688 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700689
Ky Srinivasan245ba562010-12-16 18:54:16 -0700690 kvp_transaction.recv_len = recvlen;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700691 kvp_transaction.recv_req_id = requestid;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700692 kvp_transaction.kvp_msg = kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700693
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700694 if (kvp_transaction.state < HVUTIL_READY) {
695 /* Userspace is not registered yet */
696 kvp_respond_to_host(NULL, HV_E_FAIL);
697 return;
698 }
699 kvp_transaction.state = HVUTIL_HOSTMSG_RECEIVED;
700
Ky Srinivasan245ba562010-12-16 18:54:16 -0700701 /*
702 * Get the information from the
703 * user-mode component.
704 * component. This transaction will be
705 * completed when we get the value from
706 * the user-mode component.
707 * Set a timeout to deal with
708 * user-mode not responding.
709 */
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700710 schedule_work(&kvp_sendkey_work);
K. Y. Srinivasanc0b200c2015-12-14 16:01:32 -0800711 schedule_delayed_work(&kvp_timeout_work,
712 HV_UTIL_TIMEOUT * HZ);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700713
714 return;
715
716 }
717
Ky Srinivasan245ba562010-12-16 18:54:16 -0700718 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
719 | ICMSGHDRFLAG_RESPONSE;
720
721 vmbus_sendpacket(channel, recv_buffer,
722 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800723 VM_PKT_DATA_INBAND, 0);
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700724
725 host_negotiatied = NEGO_FINISHED;
Long Lia3ade8c2017-04-30 16:21:19 -0700726 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700727 }
728
729}
730
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700731static void kvp_on_reset(void)
732{
733 if (cancel_delayed_work_sync(&kvp_timeout_work))
734 kvp_respond_to_host(NULL, HV_E_FAIL);
735 kvp_transaction.state = HVUTIL_DEVICE_INIT;
736}
737
Ky Srinivasan245ba562010-12-16 18:54:16 -0700738int
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700739hv_kvp_init(struct hv_util_service *srv)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700740{
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700741 recv_buffer = srv->recv_buffer;
K. Y. Srinivasanb9830d12016-02-26 15:13:19 -0800742 kvp_transaction.recv_channel = srv->channel;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700743
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700744 /*
745 * When this driver loads, the user level daemon that
746 * processes the host requests may not yet be running.
747 * Defer processing channel callbacks until the daemon
748 * has registered.
749 */
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700750 kvp_transaction.state = HVUTIL_DEVICE_INIT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700751
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700752 hvt = hvutil_transport_init(kvp_devname, CN_KVP_IDX, CN_KVP_VAL,
753 kvp_on_msg, kvp_on_reset);
754 if (!hvt)
755 return -EFAULT;
756
Ky Srinivasan245ba562010-12-16 18:54:16 -0700757 return 0;
758}
759
760void hv_kvp_deinit(void)
761{
Vitaly Kuznetsov97bf16c2015-04-11 18:07:47 -0700762 kvp_transaction.state = HVUTIL_DEVICE_DYING;
Vitaly Kuznetsov4dbfc2e2016-04-30 19:21:33 -0700763 cancel_delayed_work_sync(&kvp_host_handshake_work);
Vitaly Kuznetsov68c8b392015-04-11 18:07:44 -0700764 cancel_delayed_work_sync(&kvp_timeout_work);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700765 cancel_work_sync(&kvp_sendkey_work);
Vitaly Kuznetsov11bc3a52015-04-11 18:07:54 -0700766 hvutil_transport_destroy(hvt);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700767}