blob: 09988b2896226552e4be5cd69d5f09ba3f842d11 [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
Ky Srinivasan245ba562010-12-16 18:54:16 -070031
K. Y. Srinivasan67413352013-07-02 10:31:30 -070032/*
33 * Pre win8 version numbers used in ws2008 and ws 2008 r2 (win7)
34 */
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070035#define WS2008_SRV_MAJOR 1
36#define WS2008_SRV_MINOR 0
37#define WS2008_SRV_VERSION (WS2008_SRV_MAJOR << 16 | WS2008_SRV_MINOR)
38
K. Y. Srinivasan67413352013-07-02 10:31:30 -070039#define WIN7_SRV_MAJOR 3
40#define WIN7_SRV_MINOR 0
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070041#define WIN7_SRV_VERSION (WIN7_SRV_MAJOR << 16 | WIN7_SRV_MINOR)
K. Y. Srinivasan67413352013-07-02 10:31:30 -070042
43#define WIN8_SRV_MAJOR 4
44#define WIN8_SRV_MINOR 0
K. Y. Srinivasan3a491602013-09-06 11:49:56 -070045#define WIN8_SRV_VERSION (WIN8_SRV_MAJOR << 16 | WIN8_SRV_MINOR)
Ky Srinivasan245ba562010-12-16 18:54:16 -070046
47/*
48 * Global state maintained for transaction that is being processed.
49 * Note that only one transaction can be active at any point in time.
50 *
51 * This state is set when we receive a request from the host; we
52 * cleanup this state when the transaction is completed - when we respond
53 * to the host with the key value.
54 */
55
56static struct {
57 bool active; /* transaction status - active or not */
58 int recv_len; /* number of bytes received. */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -070059 struct hv_kvp_msg *kvp_msg; /* current message */
Ky Srinivasan245ba562010-12-16 18:54:16 -070060 struct vmbus_channel *recv_channel; /* chn we got the request */
61 u64 recv_req_id; /* request ID. */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -070062 void *kvp_context; /* for the channel callback */
Ky Srinivasan245ba562010-12-16 18:54:16 -070063} kvp_transaction;
64
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070065/*
66 * Before we can accept KVP messages from the host, we need
67 * to handshake with the user level daemon. This state tracks
68 * if we are in the handshake phase.
69 */
70static bool in_hand_shake = true;
71
72/*
73 * This state maintains the version number registered by the daemon.
74 */
75static int dm_reg_value;
76
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070077static void kvp_send_key(struct work_struct *dummy);
Ky Srinivasan245ba562010-12-16 18:54:16 -070078
K. Y. Srinivasan76e5f812011-10-04 14:00:02 -070079
K. Y. Srinivasan03db7722012-08-16 18:32:12 -070080static void kvp_respond_to_host(struct hv_kvp_msg *msg, int error);
Ky Srinivasan245ba562010-12-16 18:54:16 -070081static void kvp_work_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
84static DECLARE_DELAYED_WORK(kvp_work, kvp_work_func);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -070085static DECLARE_WORK(kvp_sendkey_work, kvp_send_key);
Ky Srinivasan245ba562010-12-16 18:54:16 -070086
87static struct cb_id kvp_id = { CN_KVP_IDX, CN_KVP_VAL };
88static const char kvp_name[] = "kvp_kernel_module";
Ky Srinivasan245ba562010-12-16 18:54:16 -070089static u8 *recv_buffer;
90/*
91 * Register the kernel component with the user-level daemon.
92 * As part of this registration, pass the LIC version number.
Olaf Heringcfc25992013-05-29 11:29:07 +020093 * This number has no meaning, it satisfies the registration protocol.
Ky Srinivasan245ba562010-12-16 18:54:16 -070094 */
Olaf Heringcfc25992013-05-29 11:29:07 +020095#define HV_DRV_VERSION "3.1"
Ky Srinivasan245ba562010-12-16 18:54:16 -070096
97static void
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -070098kvp_register(int reg_value)
Ky Srinivasan245ba562010-12-16 18:54:16 -070099{
100
101 struct cn_msg *msg;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800102 struct hv_kvp_msg *kvp_msg;
103 char *version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700104
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800105 msg = kzalloc(sizeof(*msg) + sizeof(struct hv_kvp_msg), GFP_ATOMIC);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700106
107 if (msg) {
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800108 kvp_msg = (struct hv_kvp_msg *)msg->data;
K. Y. Srinivasane485ceac2012-03-10 15:32:08 -0800109 version = kvp_msg->body.kvp_register.version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700110 msg->id.idx = CN_KVP_IDX;
111 msg->id.val = CN_KVP_VAL;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800112
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700113 kvp_msg->kvp_hdr.operation = reg_value;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800114 strcpy(version, HV_DRV_VERSION);
115 msg->len = sizeof(struct hv_kvp_msg);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700116 cn_netlink_send(msg, 0, GFP_ATOMIC);
117 kfree(msg);
118 }
119}
120static void
121kvp_work_func(struct work_struct *dummy)
122{
123 /*
124 * If the timer fires, the user-mode component has not responded;
125 * process the pending transaction.
126 */
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700127 kvp_respond_to_host(NULL, HV_E_FAIL);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700128}
129
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700130static int kvp_handle_handshake(struct hv_kvp_msg *msg)
131{
132 int ret = 1;
133
134 switch (msg->kvp_hdr.operation) {
135 case KVP_OP_REGISTER:
136 dm_reg_value = KVP_OP_REGISTER;
137 pr_info("KVP: IP injection functionality not available\n");
138 pr_info("KVP: Upgrade the KVP daemon\n");
139 break;
140 case KVP_OP_REGISTER1:
141 dm_reg_value = KVP_OP_REGISTER1;
142 break;
143 default:
144 pr_info("KVP: incompatible daemon\n");
145 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
146 KVP_OP_REGISTER1, msg->kvp_hdr.operation);
147 ret = 0;
148 }
149
150 if (ret) {
151 /*
152 * We have a compatible daemon; complete the handshake.
153 */
154 pr_info("KVP: user-mode registering done.\n");
155 kvp_register(dm_reg_value);
156 kvp_transaction.active = false;
157 if (kvp_transaction.kvp_context)
158 hv_kvp_onchannelcallback(kvp_transaction.kvp_context);
159 }
160 return ret;
161}
162
163
Ky Srinivasan245ba562010-12-16 18:54:16 -0700164/*
165 * Callback when data is received from user mode.
166 */
167
168static void
169kvp_cn_callback(struct cn_msg *msg, struct netlink_skb_parms *nsp)
170{
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800171 struct hv_kvp_msg *message;
172 struct hv_kvp_msg_enumerate *data;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700173 int error = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700174
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800175 message = (struct hv_kvp_msg *)msg->data;
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700176
177 /*
178 * If we are negotiating the version information
179 * with the daemon; handle that first.
180 */
181
182 if (in_hand_shake) {
183 if (kvp_handle_handshake(message))
184 in_hand_shake = false;
185 return;
186 }
187
188 /*
189 * Based on the version of the daemon, we propagate errors from the
190 * daemon differently.
191 */
192
193 data = &message->body.kvp_enum_data;
194
195 switch (dm_reg_value) {
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700196 case KVP_OP_REGISTER:
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700197 /*
198 * Null string is used to pass back error condition.
199 */
200 if (data->data.key[0] == 0)
201 error = HV_S_CONT;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700202 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700203
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700204 case KVP_OP_REGISTER1:
Ky Srinivasan245ba562010-12-16 18:54:16 -0700205 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700206 * We use the message header information from
207 * the user level daemon to transmit errors.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700208 */
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700209 error = message->error;
210 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700211 }
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700212
213 /*
214 * Complete the transaction by forwarding the key value
215 * to the host. But first, cancel the timeout.
216 */
217 if (cancel_delayed_work_sync(&kvp_work))
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700218 kvp_respond_to_host(message, error);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700219}
220
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700221
222static int process_ob_ipinfo(void *in_msg, void *out_msg, int op)
223{
224 struct hv_kvp_msg *in = in_msg;
225 struct hv_kvp_ip_msg *out = out_msg;
226 int len;
227
228 switch (op) {
229 case KVP_OP_GET_IP_INFO:
230 /*
231 * Transform all parameters into utf16 encoding.
232 */
233 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.ip_addr,
234 strlen((char *)in->body.kvp_ip_val.ip_addr),
235 UTF16_HOST_ENDIAN,
236 (wchar_t *)out->kvp_ip_val.ip_addr,
237 MAX_IP_ADDR_SIZE);
238 if (len < 0)
239 return len;
240
241 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.sub_net,
242 strlen((char *)in->body.kvp_ip_val.sub_net),
243 UTF16_HOST_ENDIAN,
244 (wchar_t *)out->kvp_ip_val.sub_net,
245 MAX_IP_ADDR_SIZE);
246 if (len < 0)
247 return len;
248
249 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.gate_way,
250 strlen((char *)in->body.kvp_ip_val.gate_way),
251 UTF16_HOST_ENDIAN,
252 (wchar_t *)out->kvp_ip_val.gate_way,
253 MAX_GATEWAY_SIZE);
254 if (len < 0)
255 return len;
256
257 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.dns_addr,
258 strlen((char *)in->body.kvp_ip_val.dns_addr),
259 UTF16_HOST_ENDIAN,
260 (wchar_t *)out->kvp_ip_val.dns_addr,
261 MAX_IP_ADDR_SIZE);
262 if (len < 0)
263 return len;
264
265 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.adapter_id,
266 strlen((char *)in->body.kvp_ip_val.adapter_id),
267 UTF16_HOST_ENDIAN,
268 (wchar_t *)out->kvp_ip_val.adapter_id,
269 MAX_IP_ADDR_SIZE);
270 if (len < 0)
271 return len;
272
273 out->kvp_ip_val.dhcp_enabled =
274 in->body.kvp_ip_val.dhcp_enabled;
K. Y. Srinivasana500e0e2012-09-04 17:54:13 -0700275 out->kvp_ip_val.addr_family =
276 in->body.kvp_ip_val.addr_family;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700277 }
278
279 return 0;
280}
281
282static void process_ib_ipinfo(void *in_msg, void *out_msg, int op)
283{
284 struct hv_kvp_ip_msg *in = in_msg;
285 struct hv_kvp_msg *out = out_msg;
286
287 switch (op) {
288 case KVP_OP_SET_IP_INFO:
289 /*
290 * Transform all parameters into utf8 encoding.
291 */
292 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.ip_addr,
293 MAX_IP_ADDR_SIZE,
294 UTF16_LITTLE_ENDIAN,
295 (__u8 *)out->body.kvp_ip_val.ip_addr,
296 MAX_IP_ADDR_SIZE);
297
298 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.sub_net,
299 MAX_IP_ADDR_SIZE,
300 UTF16_LITTLE_ENDIAN,
301 (__u8 *)out->body.kvp_ip_val.sub_net,
302 MAX_IP_ADDR_SIZE);
303
304 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.gate_way,
305 MAX_GATEWAY_SIZE,
306 UTF16_LITTLE_ENDIAN,
307 (__u8 *)out->body.kvp_ip_val.gate_way,
308 MAX_GATEWAY_SIZE);
309
310 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.dns_addr,
311 MAX_IP_ADDR_SIZE,
312 UTF16_LITTLE_ENDIAN,
313 (__u8 *)out->body.kvp_ip_val.dns_addr,
314 MAX_IP_ADDR_SIZE);
315
316 out->body.kvp_ip_val.dhcp_enabled = in->kvp_ip_val.dhcp_enabled;
317
318 default:
319 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
320 MAX_ADAPTER_ID_SIZE,
321 UTF16_LITTLE_ENDIAN,
322 (__u8 *)out->body.kvp_ip_val.adapter_id,
323 MAX_ADAPTER_ID_SIZE);
324
325 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
326 }
327}
328
329
330
331
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700332static void
333kvp_send_key(struct work_struct *dummy)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700334{
335 struct cn_msg *msg;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800336 struct hv_kvp_msg *message;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700337 struct hv_kvp_msg *in_msg;
338 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
339 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
340 __u32 val32;
341 __u64 val64;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700342
343 msg = kzalloc(sizeof(*msg) + sizeof(struct hv_kvp_msg) , GFP_ATOMIC);
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700344 if (!msg)
345 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700346
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700347 msg->id.idx = CN_KVP_IDX;
348 msg->id.val = CN_KVP_VAL;
K. Y. Srinivasan26403352012-02-02 16:56:50 -0800349
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700350 message = (struct hv_kvp_msg *)msg->data;
351 message->kvp_hdr.operation = operation;
352 message->kvp_hdr.pool = pool;
353 in_msg = kvp_transaction.kvp_msg;
354
355 /*
356 * The key/value strings sent from the host are encoded in
357 * in utf16; convert it to utf8 strings.
358 * The host assures us that the utf16 strings will not exceed
359 * the max lengths specified. We will however, reserve room
360 * for the string terminating character - in the utf16s_utf8s()
361 * function we limit the size of the buffer where the converted
362 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
363 * that the strings can be properly terminated!
364 */
365
366 switch (message->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700367 case KVP_OP_SET_IP_INFO:
368 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
369 break;
370 case KVP_OP_GET_IP_INFO:
371 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
372 break;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700373 case KVP_OP_SET:
374 switch (in_msg->body.kvp_set.data.value_type) {
375 case REG_SZ:
376 /*
377 * The value is a string - utf16 encoding.
378 */
379 message->body.kvp_set.data.value_size =
380 utf16s_to_utf8s(
381 (wchar_t *)in_msg->body.kvp_set.data.value,
382 in_msg->body.kvp_set.data.value_size,
383 UTF16_LITTLE_ENDIAN,
384 message->body.kvp_set.data.value,
385 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
386 break;
387
388 case REG_U32:
389 /*
390 * The value is a 32 bit scalar.
391 * We save this as a utf8 string.
392 */
393 val32 = in_msg->body.kvp_set.data.value_u32;
394 message->body.kvp_set.data.value_size =
395 sprintf(message->body.kvp_set.data.value,
396 "%d", val32) + 1;
397 break;
398
399 case REG_U64:
400 /*
401 * The value is a 64 bit scalar.
402 * We save this as a utf8 string.
403 */
404 val64 = in_msg->body.kvp_set.data.value_u64;
405 message->body.kvp_set.data.value_size =
406 sprintf(message->body.kvp_set.data.value,
407 "%llu", val64) + 1;
408 break;
409
410 }
411 case KVP_OP_GET:
412 message->body.kvp_set.data.key_size =
413 utf16s_to_utf8s(
414 (wchar_t *)in_msg->body.kvp_set.data.key,
415 in_msg->body.kvp_set.data.key_size,
416 UTF16_LITTLE_ENDIAN,
417 message->body.kvp_set.data.key,
418 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
419 break;
420
421 case KVP_OP_DELETE:
422 message->body.kvp_delete.key_size =
423 utf16s_to_utf8s(
424 (wchar_t *)in_msg->body.kvp_delete.key,
425 in_msg->body.kvp_delete.key_size,
426 UTF16_LITTLE_ENDIAN,
427 message->body.kvp_delete.key,
428 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
429 break;
430
431 case KVP_OP_ENUMERATE:
432 message->body.kvp_enum_data.index =
433 in_msg->body.kvp_enum_data.index;
434 break;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700435 }
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700436
437 msg->len = sizeof(struct hv_kvp_msg);
438 cn_netlink_send(msg, 0, GFP_ATOMIC);
439 kfree(msg);
440
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700441 return;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700442}
443
444/*
445 * Send a response back to the host.
446 */
447
448static void
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700449kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700450{
451 struct hv_kvp_msg *kvp_msg;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700452 struct hv_kvp_exchg_msg_value *kvp_data;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700453 char *key_name;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700454 char *value;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700455 struct icmsg_hdr *icmsghdrp;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700456 int keylen = 0;
457 int valuelen = 0;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700458 u32 buf_len;
459 struct vmbus_channel *channel;
460 u64 req_id;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700461 int ret;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700462
463 /*
464 * If a transaction is not active; log and return.
465 */
466
467 if (!kvp_transaction.active) {
468 /*
469 * This is a spurious call!
470 */
Hank Janssenaf7a5b62011-03-29 13:58:49 -0700471 pr_warn("KVP: Transaction not active\n");
Ky Srinivasan245ba562010-12-16 18:54:16 -0700472 return;
473 }
474 /*
475 * Copy the global state for completing the transaction. Note that
476 * only one transaction can be active at a time.
477 */
478
479 buf_len = kvp_transaction.recv_len;
480 channel = kvp_transaction.recv_channel;
481 req_id = kvp_transaction.recv_req_id;
482
K. Y. Srinivasan76e5f812011-10-04 14:00:02 -0700483 kvp_transaction.active = false;
484
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700485 icmsghdrp = (struct icmsg_hdr *)
486 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
487
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700488 if (channel->onchannel_callback == NULL)
489 /*
490 * We have raced with util driver being unloaded;
491 * silently return.
492 */
493 return;
494
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700495 icmsghdrp->status = error;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700496
497 /*
K. Y. Srinivasanadc80ae2012-03-16 08:02:27 -0700498 * If the error parameter is set, terminate the host's enumeration
499 * on this pool.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700500 */
501 if (error) {
502 /*
K. Y. Srinivasanb47a81d2012-08-13 10:06:52 -0700503 * Something failed or we have timedout;
504 * terminate the current host-side iteration.
Ky Srinivasan245ba562010-12-16 18:54:16 -0700505 */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700506 goto response_done;
507 }
508
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700509 kvp_msg = (struct hv_kvp_msg *)
510 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
511 sizeof(struct icmsg_hdr)];
512
513 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700514 case KVP_OP_GET_IP_INFO:
515 ret = process_ob_ipinfo(msg_to_host,
516 (struct hv_kvp_ip_msg *)kvp_msg,
517 KVP_OP_GET_IP_INFO);
518 if (ret < 0)
519 icmsghdrp->status = HV_E_FAIL;
520
521 goto response_done;
522 case KVP_OP_SET_IP_INFO:
523 goto response_done;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700524 case KVP_OP_GET:
525 kvp_data = &kvp_msg->body.kvp_get.data;
526 goto copy_value;
527
528 case KVP_OP_SET:
529 case KVP_OP_DELETE:
530 goto response_done;
531
532 default:
533 break;
534 }
535
536 kvp_data = &kvp_msg->body.kvp_enum_data.data;
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700537 key_name = msg_to_host->body.kvp_enum_data.data.key;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700538
Ky Srinivasan245ba562010-12-16 18:54:16 -0700539 /*
540 * The windows host expects the key/value pair to be encoded
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700541 * in utf16. Ensure that the key/value size reported to the host
542 * will be less than or equal to the MAX size (including the
543 * terminating character).
Ky Srinivasan245ba562010-12-16 18:54:16 -0700544 */
Alan Stern0720a062011-11-17 16:42:19 -0500545 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700546 (wchar_t *) kvp_data->key,
547 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
548 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700549
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700550copy_value:
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700551 value = msg_to_host->body.kvp_enum_data.data.value;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700552 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
553 (wchar_t *) kvp_data->value,
554 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
555 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
556
557 /*
558 * If the utf8s to utf16s conversion failed; notify host
559 * of the error.
560 */
561 if ((keylen < 0) || (valuelen < 0))
562 icmsghdrp->status = HV_E_FAIL;
563
564 kvp_data->value_type = REG_SZ; /* all our values are strings */
Ky Srinivasan245ba562010-12-16 18:54:16 -0700565
566response_done:
567 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
568
569 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800570 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700571
Ky Srinivasan245ba562010-12-16 18:54:16 -0700572}
573
574/*
575 * This callback is invoked when we get a KVP message from the host.
576 * The host ensures that only one KVP transaction can be active at a time.
577 * KVP implementation in Linux needs to forward the key to a user-mde
578 * component to retrive the corresponding value. Consequently, we cannot
579 * respond to the host in the conext of this callback. Since the host
580 * guarantees that at most only one transaction can be active at a time,
581 * we stash away the transaction state in a set of global variables.
582 */
583
584void hv_kvp_onchannelcallback(void *context)
585{
586 struct vmbus_channel *channel = context;
587 u32 recvlen;
588 u64 requestid;
589
590 struct hv_kvp_msg *kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700591
592 struct icmsg_hdr *icmsghdrp;
593 struct icmsg_negotiate *negop = NULL;
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700594 int util_fw_version;
595 int kvp_srv_version;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700596
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700597 if (kvp_transaction.active) {
598 /*
599 * We will defer processing this callback once
600 * the current transaction is complete.
601 */
602 kvp_transaction.kvp_context = context;
603 return;
604 }
Ky Srinivasan245ba562010-12-16 18:54:16 -0700605
K. Y. Srinivasan03db7722012-08-16 18:32:12 -0700606 vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 2, &recvlen,
607 &requestid);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700608
609 if (recvlen > 0) {
Ky Srinivasan245ba562010-12-16 18:54:16 -0700610 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
611 sizeof(struct vmbuspipe_hdr)];
612
613 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700614 /*
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700615 * Based on the host, select appropriate
616 * framework and service versions we will
617 * negotiate.
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700618 */
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700619 switch (vmbus_proto_version) {
620 case (VERSION_WS2008):
621 util_fw_version = UTIL_WS2K8_FW_VERSION;
622 kvp_srv_version = WS2008_SRV_VERSION;
623 break;
624 case (VERSION_WIN7):
625 util_fw_version = UTIL_FW_VERSION;
626 kvp_srv_version = WIN7_SRV_VERSION;
627 break;
628 default:
629 util_fw_version = UTIL_FW_VERSION;
630 kvp_srv_version = WIN8_SRV_VERSION;
631 }
K. Y. Srinivasanc836d0a2012-05-12 13:44:58 -0700632 vmbus_prep_negotiate_resp(icmsghdrp, negop,
K. Y. Srinivasan3a491602013-09-06 11:49:56 -0700633 recv_buffer, util_fw_version,
634 kvp_srv_version);
K. Y. Srinivasan67413352013-07-02 10:31:30 -0700635
Ky Srinivasan245ba562010-12-16 18:54:16 -0700636 } else {
637 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
638 sizeof(struct vmbuspipe_hdr) +
639 sizeof(struct icmsg_hdr)];
640
Ky Srinivasan245ba562010-12-16 18:54:16 -0700641 /*
642 * Stash away this global state for completing the
643 * transaction; note transactions are serialized.
644 */
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700645
Ky Srinivasan245ba562010-12-16 18:54:16 -0700646 kvp_transaction.recv_len = recvlen;
647 kvp_transaction.recv_channel = channel;
648 kvp_transaction.recv_req_id = requestid;
649 kvp_transaction.active = true;
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700650 kvp_transaction.kvp_msg = kvp_msg;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700651
652 /*
653 * Get the information from the
654 * user-mode component.
655 * component. This transaction will be
656 * completed when we get the value from
657 * the user-mode component.
658 * Set a timeout to deal with
659 * user-mode not responding.
660 */
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700661 schedule_work(&kvp_sendkey_work);
662 schedule_delayed_work(&kvp_work, 5*HZ);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700663
664 return;
665
666 }
667
Ky Srinivasan245ba562010-12-16 18:54:16 -0700668 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
669 | ICMSGHDRFLAG_RESPONSE;
670
671 vmbus_sendpacket(channel, recv_buffer,
672 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800673 VM_PKT_DATA_INBAND, 0);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700674 }
675
676}
677
678int
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700679hv_kvp_init(struct hv_util_service *srv)
Ky Srinivasan245ba562010-12-16 18:54:16 -0700680{
681 int err;
682
683 err = cn_add_callback(&kvp_id, kvp_name, kvp_cn_callback);
684 if (err)
685 return err;
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700686 recv_buffer = srv->recv_buffer;
Ky Srinivasan245ba562010-12-16 18:54:16 -0700687
K. Y. Srinivasanfa3d5b82012-03-16 08:02:25 -0700688 /*
689 * When this driver loads, the user level daemon that
690 * processes the host requests may not yet be running.
691 * Defer processing channel callbacks until the daemon
692 * has registered.
693 */
694 kvp_transaction.active = true;
695
Ky Srinivasan245ba562010-12-16 18:54:16 -0700696 return 0;
697}
698
699void hv_kvp_deinit(void)
700{
701 cn_del_callback(&kvp_id);
702 cancel_delayed_work_sync(&kvp_work);
K. Y. Srinivasane2bb6532011-10-09 19:42:28 -0700703 cancel_work_sync(&kvp_sendkey_work);
Ky Srinivasan245ba562010-12-16 18:54:16 -0700704}