2 * An implementation of key value pair (KVP) functionality for Linux.
5 * Copyright (C) 2010, Novell, Inc.
6 * Author : K. Y. Srinivasan <ksrinivasan@novell.com>
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.
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
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.
23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25 #include <linux/net.h>
26 #include <linux/nls.h>
27 #include <linux/connector.h>
28 #include <linux/workqueue.h>
29 #include <linux/hyperv.h>
31 #include "hyperv_vmbus.h"
32 #include "hv_utils_transport.h"
35 * Pre win8 version numbers used in ws2008 and ws 2008 r2 (win7)
37 #define WS2008_SRV_MAJOR 1
38 #define WS2008_SRV_MINOR 0
39 #define WS2008_SRV_VERSION (WS2008_SRV_MAJOR << 16 | WS2008_SRV_MINOR)
41 #define WIN7_SRV_MAJOR 3
42 #define WIN7_SRV_MINOR 0
43 #define WIN7_SRV_VERSION (WIN7_SRV_MAJOR << 16 | WIN7_SRV_MINOR)
45 #define WIN8_SRV_MAJOR 4
46 #define WIN8_SRV_MINOR 0
47 #define WIN8_SRV_VERSION (WIN8_SRV_MAJOR << 16 | WIN8_SRV_MINOR)
50 * 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.
57 * 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
64 int state; /* hvutil_device_state */
65 int recv_len; /* number of bytes received. */
66 struct hv_kvp_msg *kvp_msg; /* current message */
67 struct vmbus_channel *recv_channel; /* chn we got the request */
68 u64 recv_req_id; /* request ID. */
72 * This state maintains the version number registered by the daemon.
74 static int dm_reg_value;
76 static void kvp_send_key(struct work_struct *dummy);
79 static void kvp_respond_to_host(struct hv_kvp_msg *msg, int error);
80 static void kvp_timeout_func(struct work_struct *dummy);
81 static void kvp_register(int);
83 static DECLARE_DELAYED_WORK(kvp_timeout_work, kvp_timeout_func);
84 static DECLARE_WORK(kvp_sendkey_work, kvp_send_key);
86 static const char kvp_devname[] = "vmbus/hv_kvp";
87 static u8 *recv_buffer;
88 static struct hvutil_transport *hvt;
89 static struct completion release_event;
91 * Register the kernel component with the user-level daemon.
92 * As part of this registration, pass the LIC version number.
93 * This number has no meaning, it satisfies the registration protocol.
95 #define HV_DRV_VERSION "3.1"
97 static void kvp_poll_wrapper(void *channel)
99 /* Transaction is finished, reset the state here to avoid races. */
100 kvp_transaction.state = HVUTIL_READY;
101 hv_kvp_onchannelcallback(channel);
105 kvp_register(int reg_value)
108 struct hv_kvp_msg *kvp_msg;
111 kvp_msg = kzalloc(sizeof(*kvp_msg), GFP_KERNEL);
114 version = kvp_msg->body.kvp_register.version;
115 kvp_msg->kvp_hdr.operation = reg_value;
116 strcpy(version, HV_DRV_VERSION);
118 hvutil_transport_send(hvt, kvp_msg, sizeof(*kvp_msg));
123 static void kvp_timeout_func(struct work_struct *dummy)
126 * If the timer fires, the user-mode component has not responded;
127 * process the pending transaction.
129 kvp_respond_to_host(NULL, HV_E_FAIL);
131 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
134 static int kvp_handle_handshake(struct hv_kvp_msg *msg)
136 switch (msg->kvp_hdr.operation) {
137 case KVP_OP_REGISTER:
138 dm_reg_value = KVP_OP_REGISTER;
139 pr_info("KVP: IP injection functionality not available\n");
140 pr_info("KVP: Upgrade the KVP daemon\n");
142 case KVP_OP_REGISTER1:
143 dm_reg_value = KVP_OP_REGISTER1;
146 pr_info("KVP: incompatible daemon\n");
147 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
148 KVP_OP_REGISTER1, msg->kvp_hdr.operation);
153 * We have a compatible daemon; complete the handshake.
155 pr_debug("KVP: userspace daemon ver. %d registered\n",
157 kvp_register(dm_reg_value);
158 kvp_transaction.state = HVUTIL_READY;
165 * Callback when data is received from user mode.
168 static int kvp_on_msg(void *msg, int len)
170 struct hv_kvp_msg *message = (struct hv_kvp_msg *)msg;
171 struct hv_kvp_msg_enumerate *data;
174 if (len < sizeof(*message))
178 * If we are negotiating the version information
179 * with the daemon; handle that first.
182 if (kvp_transaction.state < HVUTIL_READY) {
183 return kvp_handle_handshake(message);
186 /* We didn't send anything to userspace so the reply is spurious */
187 if (kvp_transaction.state < HVUTIL_USERSPACE_REQ)
190 kvp_transaction.state = HVUTIL_USERSPACE_RECV;
193 * Based on the version of the daemon, we propagate errors from the
194 * daemon differently.
197 data = &message->body.kvp_enum_data;
199 switch (dm_reg_value) {
200 case KVP_OP_REGISTER:
202 * Null string is used to pass back error condition.
204 if (data->data.key[0] == 0)
208 case KVP_OP_REGISTER1:
210 * We use the message header information from
211 * the user level daemon to transmit errors.
213 error = message->error;
218 * Complete the transaction by forwarding the key value
219 * to the host. But first, cancel the timeout.
221 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
222 kvp_respond_to_host(message, error);
223 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
230 static int process_ob_ipinfo(void *in_msg, void *out_msg, int op)
232 struct hv_kvp_msg *in = in_msg;
233 struct hv_kvp_ip_msg *out = out_msg;
237 case KVP_OP_GET_IP_INFO:
239 * Transform all parameters into utf16 encoding.
241 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.ip_addr,
242 strlen((char *)in->body.kvp_ip_val.ip_addr),
244 (wchar_t *)out->kvp_ip_val.ip_addr,
249 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.sub_net,
250 strlen((char *)in->body.kvp_ip_val.sub_net),
252 (wchar_t *)out->kvp_ip_val.sub_net,
257 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.gate_way,
258 strlen((char *)in->body.kvp_ip_val.gate_way),
260 (wchar_t *)out->kvp_ip_val.gate_way,
265 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.dns_addr,
266 strlen((char *)in->body.kvp_ip_val.dns_addr),
268 (wchar_t *)out->kvp_ip_val.dns_addr,
273 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.adapter_id,
274 strlen((char *)in->body.kvp_ip_val.adapter_id),
276 (wchar_t *)out->kvp_ip_val.adapter_id,
281 out->kvp_ip_val.dhcp_enabled =
282 in->body.kvp_ip_val.dhcp_enabled;
283 out->kvp_ip_val.addr_family =
284 in->body.kvp_ip_val.addr_family;
290 static void process_ib_ipinfo(void *in_msg, void *out_msg, int op)
292 struct hv_kvp_ip_msg *in = in_msg;
293 struct hv_kvp_msg *out = out_msg;
296 case KVP_OP_SET_IP_INFO:
298 * Transform all parameters into utf8 encoding.
300 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.ip_addr,
303 (__u8 *)out->body.kvp_ip_val.ip_addr,
306 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.sub_net,
309 (__u8 *)out->body.kvp_ip_val.sub_net,
312 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.gate_way,
315 (__u8 *)out->body.kvp_ip_val.gate_way,
318 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.dns_addr,
321 (__u8 *)out->body.kvp_ip_val.dns_addr,
324 out->body.kvp_ip_val.dhcp_enabled = in->kvp_ip_val.dhcp_enabled;
327 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
330 (__u8 *)out->body.kvp_ip_val.adapter_id,
331 MAX_ADAPTER_ID_SIZE);
333 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
341 kvp_send_key(struct work_struct *dummy)
343 struct hv_kvp_msg *message;
344 struct hv_kvp_msg *in_msg;
345 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
346 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
351 /* The transaction state is wrong. */
352 if (kvp_transaction.state != HVUTIL_HOSTMSG_RECEIVED)
355 message = kzalloc(sizeof(*message), GFP_KERNEL);
359 message->kvp_hdr.operation = operation;
360 message->kvp_hdr.pool = pool;
361 in_msg = kvp_transaction.kvp_msg;
364 * The key/value strings sent from the host are encoded in
365 * in utf16; convert it to utf8 strings.
366 * The host assures us that the utf16 strings will not exceed
367 * the max lengths specified. We will however, reserve room
368 * for the string terminating character - in the utf16s_utf8s()
369 * function we limit the size of the buffer where the converted
370 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
371 * that the strings can be properly terminated!
374 switch (message->kvp_hdr.operation) {
375 case KVP_OP_SET_IP_INFO:
376 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
378 case KVP_OP_GET_IP_INFO:
379 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
382 switch (in_msg->body.kvp_set.data.value_type) {
385 * The value is a string - utf16 encoding.
387 message->body.kvp_set.data.value_size =
389 (wchar_t *)in_msg->body.kvp_set.data.value,
390 in_msg->body.kvp_set.data.value_size,
392 message->body.kvp_set.data.value,
393 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
398 * The value is a 32 bit scalar.
399 * We save this as a utf8 string.
401 val32 = in_msg->body.kvp_set.data.value_u32;
402 message->body.kvp_set.data.value_size =
403 sprintf(message->body.kvp_set.data.value,
409 * The value is a 64 bit scalar.
410 * We save this as a utf8 string.
412 val64 = in_msg->body.kvp_set.data.value_u64;
413 message->body.kvp_set.data.value_size =
414 sprintf(message->body.kvp_set.data.value,
420 message->body.kvp_set.data.key_size =
422 (wchar_t *)in_msg->body.kvp_set.data.key,
423 in_msg->body.kvp_set.data.key_size,
425 message->body.kvp_set.data.key,
426 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
430 message->body.kvp_delete.key_size =
432 (wchar_t *)in_msg->body.kvp_delete.key,
433 in_msg->body.kvp_delete.key_size,
435 message->body.kvp_delete.key,
436 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
439 case KVP_OP_ENUMERATE:
440 message->body.kvp_enum_data.index =
441 in_msg->body.kvp_enum_data.index;
445 kvp_transaction.state = HVUTIL_USERSPACE_REQ;
446 rc = hvutil_transport_send(hvt, message, sizeof(*message));
448 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc);
449 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
450 kvp_respond_to_host(message, HV_E_FAIL);
451 kvp_transaction.state = HVUTIL_READY;
461 * Send a response back to the host.
465 kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
467 struct hv_kvp_msg *kvp_msg;
468 struct hv_kvp_exchg_msg_value *kvp_data;
471 struct icmsg_hdr *icmsghdrp;
475 struct vmbus_channel *channel;
480 * Copy the global state for completing the transaction. Note that
481 * only one transaction can be active at a time.
484 buf_len = kvp_transaction.recv_len;
485 channel = kvp_transaction.recv_channel;
486 req_id = kvp_transaction.recv_req_id;
488 icmsghdrp = (struct icmsg_hdr *)
489 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
491 if (channel->onchannel_callback == NULL)
493 * We have raced with util driver being unloaded;
498 icmsghdrp->status = error;
501 * If the error parameter is set, terminate the host's enumeration
506 * Something failed or we have timedout;
507 * terminate the current host-side iteration.
512 kvp_msg = (struct hv_kvp_msg *)
513 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
514 sizeof(struct icmsg_hdr)];
516 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
517 case KVP_OP_GET_IP_INFO:
518 ret = process_ob_ipinfo(msg_to_host,
519 (struct hv_kvp_ip_msg *)kvp_msg,
522 icmsghdrp->status = HV_E_FAIL;
525 case KVP_OP_SET_IP_INFO:
528 kvp_data = &kvp_msg->body.kvp_get.data;
539 kvp_data = &kvp_msg->body.kvp_enum_data.data;
540 key_name = msg_to_host->body.kvp_enum_data.data.key;
543 * The windows host expects the key/value pair to be encoded
544 * in utf16. Ensure that the key/value size reported to the host
545 * will be less than or equal to the MAX size (including the
546 * terminating character).
548 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
549 (wchar_t *) kvp_data->key,
550 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
551 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
554 value = msg_to_host->body.kvp_enum_data.data.value;
555 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
556 (wchar_t *) kvp_data->value,
557 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
558 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
561 * If the utf8s to utf16s conversion failed; notify host
564 if ((keylen < 0) || (valuelen < 0))
565 icmsghdrp->status = HV_E_FAIL;
567 kvp_data->value_type = REG_SZ; /* all our values are strings */
570 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
572 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
573 VM_PKT_DATA_INBAND, 0);
577 * This callback is invoked when we get a KVP message from the host.
578 * The host ensures that only one KVP transaction can be active at a time.
579 * KVP implementation in Linux needs to forward the key to a user-mde
580 * component to retrive the corresponding value. Consequently, we cannot
581 * respond to the host in the conext of this callback. Since the host
582 * guarantees that at most only one transaction can be active at a time,
583 * we stash away the transaction state in a set of global variables.
586 void hv_kvp_onchannelcallback(void *context)
588 struct vmbus_channel *channel = context;
592 struct hv_kvp_msg *kvp_msg;
594 struct icmsg_hdr *icmsghdrp;
595 struct icmsg_negotiate *negop = NULL;
599 if (kvp_transaction.state > HVUTIL_READY)
602 vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 4, &recvlen,
606 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
607 sizeof(struct vmbuspipe_hdr)];
609 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
611 * Based on the host, select appropriate
612 * framework and service versions we will
615 switch (vmbus_proto_version) {
616 case (VERSION_WS2008):
617 util_fw_version = UTIL_WS2K8_FW_VERSION;
618 kvp_srv_version = WS2008_SRV_VERSION;
621 util_fw_version = UTIL_FW_VERSION;
622 kvp_srv_version = WIN7_SRV_VERSION;
625 util_fw_version = UTIL_FW_VERSION;
626 kvp_srv_version = WIN8_SRV_VERSION;
628 vmbus_prep_negotiate_resp(icmsghdrp, negop,
629 recv_buffer, util_fw_version,
633 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
634 sizeof(struct vmbuspipe_hdr) +
635 sizeof(struct icmsg_hdr)];
638 * Stash away this global state for completing the
639 * transaction; note transactions are serialized.
642 kvp_transaction.recv_len = recvlen;
643 kvp_transaction.recv_channel = channel;
644 kvp_transaction.recv_req_id = requestid;
645 kvp_transaction.kvp_msg = kvp_msg;
647 if (kvp_transaction.state < HVUTIL_READY) {
648 /* Userspace is not registered yet */
649 kvp_respond_to_host(NULL, HV_E_FAIL);
652 kvp_transaction.state = HVUTIL_HOSTMSG_RECEIVED;
655 * Get the information from the
656 * user-mode component.
657 * component. This transaction will be
658 * completed when we get the value from
659 * the user-mode component.
660 * Set a timeout to deal with
661 * user-mode not responding.
663 schedule_work(&kvp_sendkey_work);
664 schedule_delayed_work(&kvp_timeout_work,
665 HV_UTIL_TIMEOUT * HZ);
671 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
672 | ICMSGHDRFLAG_RESPONSE;
674 vmbus_sendpacket(channel, recv_buffer,
676 VM_PKT_DATA_INBAND, 0);
681 static void kvp_on_reset(void)
683 if (cancel_delayed_work_sync(&kvp_timeout_work))
684 kvp_respond_to_host(NULL, HV_E_FAIL);
685 kvp_transaction.state = HVUTIL_DEVICE_INIT;
686 complete(&release_event);
690 hv_kvp_init(struct hv_util_service *srv)
692 recv_buffer = srv->recv_buffer;
694 init_completion(&release_event);
696 * When this driver loads, the user level daemon that
697 * processes the host requests may not yet be running.
698 * Defer processing channel callbacks until the daemon
701 kvp_transaction.state = HVUTIL_DEVICE_INIT;
703 hvt = hvutil_transport_init(kvp_devname, CN_KVP_IDX, CN_KVP_VAL,
704 kvp_on_msg, kvp_on_reset);
711 void hv_kvp_deinit(void)
713 kvp_transaction.state = HVUTIL_DEVICE_DYING;
714 cancel_delayed_work_sync(&kvp_timeout_work);
715 cancel_work_sync(&kvp_sendkey_work);
716 hvutil_transport_destroy(hvt);
717 wait_for_completion(&release_event);