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)
49 #define KVP_VER_COUNT 3
50 static const int kvp_versions[] = {
56 #define FW_VER_COUNT 2
57 static const int fw_versions[] = {
63 * 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.
70 * 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
72 * read additional packets from the VMBUS until the current packet is fully
77 int state; /* hvutil_device_state */
78 int recv_len; /* number of bytes received. */
79 struct hv_kvp_msg *kvp_msg; /* current message */
80 struct vmbus_channel *recv_channel; /* chn we got the request */
81 u64 recv_req_id; /* request ID. */
85 * This state maintains the version number registered by the daemon.
87 static int dm_reg_value;
89 static void kvp_send_key(struct work_struct *dummy);
92 static void kvp_respond_to_host(struct hv_kvp_msg *msg, int error);
93 static void kvp_timeout_func(struct work_struct *dummy);
94 static void kvp_host_handshake_func(struct work_struct *dummy);
95 static void kvp_register(int);
97 static DECLARE_DELAYED_WORK(kvp_timeout_work, kvp_timeout_func);
98 static DECLARE_DELAYED_WORK(kvp_host_handshake_work, kvp_host_handshake_func);
99 static DECLARE_WORK(kvp_sendkey_work, kvp_send_key);
101 static const char kvp_devname[] = "vmbus/hv_kvp";
102 static u8 *recv_buffer;
103 static struct hvutil_transport *hvt;
105 * Register the kernel component with the user-level daemon.
106 * As part of this registration, pass the LIC version number.
107 * This number has no meaning, it satisfies the registration protocol.
109 #define HV_DRV_VERSION "3.1"
111 static void kvp_poll_wrapper(void *channel)
113 /* Transaction is finished, reset the state here to avoid races. */
114 kvp_transaction.state = HVUTIL_READY;
115 tasklet_schedule(&((struct vmbus_channel *)channel)->callback_event);
118 static void kvp_register_done(void)
121 * If we're still negotiating with the host cancel the timeout
122 * work to not poll the channel twice.
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);
130 kvp_register(int reg_value)
133 struct hv_kvp_msg *kvp_msg;
136 kvp_msg = kzalloc(sizeof(*kvp_msg), GFP_KERNEL);
139 version = kvp_msg->body.kvp_register.version;
140 kvp_msg->kvp_hdr.operation = reg_value;
141 strcpy(version, HV_DRV_VERSION);
143 hvutil_transport_send(hvt, kvp_msg, sizeof(*kvp_msg),
149 static void kvp_timeout_func(struct work_struct *dummy)
152 * If the timer fires, the user-mode component has not responded;
153 * process the pending transaction.
155 kvp_respond_to_host(NULL, HV_E_FAIL);
157 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
160 static void kvp_host_handshake_func(struct work_struct *dummy)
162 tasklet_schedule(&kvp_transaction.recv_channel->callback_event);
165 static int kvp_handle_handshake(struct hv_kvp_msg *msg)
167 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");
173 case KVP_OP_REGISTER1:
174 dm_reg_value = KVP_OP_REGISTER1;
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);
184 * We have a compatible daemon; complete the handshake.
186 pr_debug("KVP: userspace daemon ver. %d connected\n",
187 msg->kvp_hdr.operation);
188 kvp_register(dm_reg_value);
195 * Callback when data is received from user mode.
198 static int kvp_on_msg(void *msg, int len)
200 struct hv_kvp_msg *message = (struct hv_kvp_msg *)msg;
201 struct hv_kvp_msg_enumerate *data;
204 if (len < sizeof(*message))
208 * If we are negotiating the version information
209 * with the daemon; handle that first.
212 if (kvp_transaction.state < HVUTIL_READY) {
213 return kvp_handle_handshake(message);
216 /* We didn't send anything to userspace so the reply is spurious */
217 if (kvp_transaction.state < HVUTIL_USERSPACE_REQ)
220 kvp_transaction.state = HVUTIL_USERSPACE_RECV;
223 * Based on the version of the daemon, we propagate errors from the
224 * daemon differently.
227 data = &message->body.kvp_enum_data;
229 switch (dm_reg_value) {
230 case KVP_OP_REGISTER:
232 * Null string is used to pass back error condition.
234 if (data->data.key[0] == 0)
238 case KVP_OP_REGISTER1:
240 * We use the message header information from
241 * the user level daemon to transmit errors.
243 error = message->error;
248 * Complete the transaction by forwarding the key value
249 * to the host. But first, cancel the timeout.
251 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
252 kvp_respond_to_host(message, error);
253 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
260 static int process_ob_ipinfo(void *in_msg, void *out_msg, int op)
262 struct hv_kvp_msg *in = in_msg;
263 struct hv_kvp_ip_msg *out = out_msg;
267 case KVP_OP_GET_IP_INFO:
269 * Transform all parameters into utf16 encoding.
271 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.ip_addr,
272 strlen((char *)in->body.kvp_ip_val.ip_addr),
274 (wchar_t *)out->kvp_ip_val.ip_addr,
279 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.sub_net,
280 strlen((char *)in->body.kvp_ip_val.sub_net),
282 (wchar_t *)out->kvp_ip_val.sub_net,
287 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.gate_way,
288 strlen((char *)in->body.kvp_ip_val.gate_way),
290 (wchar_t *)out->kvp_ip_val.gate_way,
295 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.dns_addr,
296 strlen((char *)in->body.kvp_ip_val.dns_addr),
298 (wchar_t *)out->kvp_ip_val.dns_addr,
303 len = utf8s_to_utf16s((char *)in->body.kvp_ip_val.adapter_id,
304 strlen((char *)in->body.kvp_ip_val.adapter_id),
306 (wchar_t *)out->kvp_ip_val.adapter_id,
307 MAX_ADAPTER_ID_SIZE);
311 out->kvp_ip_val.dhcp_enabled =
312 in->body.kvp_ip_val.dhcp_enabled;
313 out->kvp_ip_val.addr_family =
314 in->body.kvp_ip_val.addr_family;
320 static void process_ib_ipinfo(void *in_msg, void *out_msg, int op)
322 struct hv_kvp_ip_msg *in = in_msg;
323 struct hv_kvp_msg *out = out_msg;
326 case KVP_OP_SET_IP_INFO:
328 * Transform all parameters into utf8 encoding.
330 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.ip_addr,
333 (__u8 *)out->body.kvp_ip_val.ip_addr,
336 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.sub_net,
339 (__u8 *)out->body.kvp_ip_val.sub_net,
342 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.gate_way,
345 (__u8 *)out->body.kvp_ip_val.gate_way,
348 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.dns_addr,
351 (__u8 *)out->body.kvp_ip_val.dns_addr,
354 out->body.kvp_ip_val.dhcp_enabled = in->kvp_ip_val.dhcp_enabled;
357 utf16s_to_utf8s((wchar_t *)in->kvp_ip_val.adapter_id,
360 (__u8 *)out->body.kvp_ip_val.adapter_id,
361 MAX_ADAPTER_ID_SIZE);
363 out->body.kvp_ip_val.addr_family = in->kvp_ip_val.addr_family;
371 kvp_send_key(struct work_struct *dummy)
373 struct hv_kvp_msg *message;
374 struct hv_kvp_msg *in_msg;
375 __u8 operation = kvp_transaction.kvp_msg->kvp_hdr.operation;
376 __u8 pool = kvp_transaction.kvp_msg->kvp_hdr.pool;
381 /* The transaction state is wrong. */
382 if (kvp_transaction.state != HVUTIL_HOSTMSG_RECEIVED)
385 message = kzalloc(sizeof(*message), GFP_KERNEL);
389 message->kvp_hdr.operation = operation;
390 message->kvp_hdr.pool = pool;
391 in_msg = kvp_transaction.kvp_msg;
394 * The key/value strings sent from the host are encoded in
395 * in utf16; convert it to utf8 strings.
396 * The host assures us that the utf16 strings will not exceed
397 * the max lengths specified. We will however, reserve room
398 * for the string terminating character - in the utf16s_utf8s()
399 * function we limit the size of the buffer where the converted
400 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to guarantee
401 * that the strings can be properly terminated!
404 switch (message->kvp_hdr.operation) {
405 case KVP_OP_SET_IP_INFO:
406 process_ib_ipinfo(in_msg, message, KVP_OP_SET_IP_INFO);
408 case KVP_OP_GET_IP_INFO:
409 process_ib_ipinfo(in_msg, message, KVP_OP_GET_IP_INFO);
412 switch (in_msg->body.kvp_set.data.value_type) {
415 * The value is a string - utf16 encoding.
417 message->body.kvp_set.data.value_size =
419 (wchar_t *)in_msg->body.kvp_set.data.value,
420 in_msg->body.kvp_set.data.value_size,
422 message->body.kvp_set.data.value,
423 HV_KVP_EXCHANGE_MAX_VALUE_SIZE - 1) + 1;
428 * The value is a 32 bit scalar.
429 * We save this as a utf8 string.
431 val32 = in_msg->body.kvp_set.data.value_u32;
432 message->body.kvp_set.data.value_size =
433 sprintf(message->body.kvp_set.data.value,
439 * The value is a 64 bit scalar.
440 * We save this as a utf8 string.
442 val64 = in_msg->body.kvp_set.data.value_u64;
443 message->body.kvp_set.data.value_size =
444 sprintf(message->body.kvp_set.data.value,
450 message->body.kvp_set.data.key_size =
452 (wchar_t *)in_msg->body.kvp_set.data.key,
453 in_msg->body.kvp_set.data.key_size,
455 message->body.kvp_set.data.key,
456 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
460 message->body.kvp_delete.key_size =
462 (wchar_t *)in_msg->body.kvp_delete.key,
463 in_msg->body.kvp_delete.key_size,
465 message->body.kvp_delete.key,
466 HV_KVP_EXCHANGE_MAX_KEY_SIZE - 1) + 1;
469 case KVP_OP_ENUMERATE:
470 message->body.kvp_enum_data.index =
471 in_msg->body.kvp_enum_data.index;
475 kvp_transaction.state = HVUTIL_USERSPACE_REQ;
476 rc = hvutil_transport_send(hvt, message, sizeof(*message), NULL);
478 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc);
479 if (cancel_delayed_work_sync(&kvp_timeout_work)) {
480 kvp_respond_to_host(message, HV_E_FAIL);
481 kvp_transaction.state = HVUTIL_READY;
489 * Send a response back to the host.
493 kvp_respond_to_host(struct hv_kvp_msg *msg_to_host, int error)
495 struct hv_kvp_msg *kvp_msg;
496 struct hv_kvp_exchg_msg_value *kvp_data;
499 struct icmsg_hdr *icmsghdrp;
503 struct vmbus_channel *channel;
508 * Copy the global state for completing the transaction. Note that
509 * only one transaction can be active at a time.
512 buf_len = kvp_transaction.recv_len;
513 channel = kvp_transaction.recv_channel;
514 req_id = kvp_transaction.recv_req_id;
516 icmsghdrp = (struct icmsg_hdr *)
517 &recv_buffer[sizeof(struct vmbuspipe_hdr)];
519 if (channel->onchannel_callback == NULL)
521 * We have raced with util driver being unloaded;
526 icmsghdrp->status = error;
529 * If the error parameter is set, terminate the host's enumeration
534 * Something failed or we have timed out;
535 * terminate the current host-side iteration.
540 kvp_msg = (struct hv_kvp_msg *)
541 &recv_buffer[sizeof(struct vmbuspipe_hdr) +
542 sizeof(struct icmsg_hdr)];
544 switch (kvp_transaction.kvp_msg->kvp_hdr.operation) {
545 case KVP_OP_GET_IP_INFO:
546 ret = process_ob_ipinfo(msg_to_host,
547 (struct hv_kvp_ip_msg *)kvp_msg,
550 icmsghdrp->status = HV_E_FAIL;
553 case KVP_OP_SET_IP_INFO:
556 kvp_data = &kvp_msg->body.kvp_get.data;
567 kvp_data = &kvp_msg->body.kvp_enum_data.data;
568 key_name = msg_to_host->body.kvp_enum_data.data.key;
571 * The windows host expects the key/value pair to be encoded
572 * in utf16. Ensure that the key/value size reported to the host
573 * will be less than or equal to the MAX size (including the
574 * terminating character).
576 keylen = utf8s_to_utf16s(key_name, strlen(key_name), UTF16_HOST_ENDIAN,
577 (wchar_t *) kvp_data->key,
578 (HV_KVP_EXCHANGE_MAX_KEY_SIZE / 2) - 2);
579 kvp_data->key_size = 2*(keylen + 1); /* utf16 encoding */
582 value = msg_to_host->body.kvp_enum_data.data.value;
583 valuelen = utf8s_to_utf16s(value, strlen(value), UTF16_HOST_ENDIAN,
584 (wchar_t *) kvp_data->value,
585 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE / 2) - 2);
586 kvp_data->value_size = 2*(valuelen + 1); /* utf16 encoding */
589 * If the utf8s to utf16s conversion failed; notify host
592 if ((keylen < 0) || (valuelen < 0))
593 icmsghdrp->status = HV_E_FAIL;
595 kvp_data->value_type = REG_SZ; /* all our values are strings */
598 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE;
600 vmbus_sendpacket(channel, recv_buffer, buf_len, req_id,
601 VM_PKT_DATA_INBAND, 0);
605 * This callback is invoked when we get a KVP message from the host.
606 * The host ensures that only one KVP transaction can be active at a time.
607 * KVP implementation in Linux needs to forward the key to a user-mde
608 * component to retrieve the corresponding value. Consequently, we cannot
609 * respond to the host in the context of this callback. Since the host
610 * guarantees that at most only one transaction can be active at a time,
611 * we stash away the transaction state in a set of global variables.
614 void hv_kvp_onchannelcallback(void *context)
616 struct vmbus_channel *channel = context;
620 struct hv_kvp_msg *kvp_msg;
622 struct icmsg_hdr *icmsghdrp;
624 static enum {NEGO_NOT_STARTED,
626 NEGO_FINISHED} host_negotiatied = NEGO_NOT_STARTED;
628 if (kvp_transaction.state < HVUTIL_READY) {
630 * If userspace daemon is not connected and host is asking
631 * us to negotiate we need to delay to not lose messages.
632 * This is important for Failover IP setting.
634 if (host_negotiatied == NEGO_NOT_STARTED) {
635 host_negotiatied = NEGO_IN_PROGRESS;
636 schedule_delayed_work(&kvp_host_handshake_work,
637 HV_UTIL_NEGO_TIMEOUT * HZ);
641 if (kvp_transaction.state > HVUTIL_READY)
644 vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 4, &recvlen,
648 icmsghdrp = (struct icmsg_hdr *)&recv_buffer[
649 sizeof(struct vmbuspipe_hdr)];
651 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
652 if (vmbus_prep_negotiate_resp(icmsghdrp,
653 recv_buffer, fw_versions, FW_VER_COUNT,
654 kvp_versions, KVP_VER_COUNT,
655 NULL, &kvp_srv_version)) {
656 pr_info("KVP IC version %d.%d\n",
657 kvp_srv_version >> 16,
658 kvp_srv_version & 0xFFFF);
661 kvp_msg = (struct hv_kvp_msg *)&recv_buffer[
662 sizeof(struct vmbuspipe_hdr) +
663 sizeof(struct icmsg_hdr)];
666 * Stash away this global state for completing the
667 * transaction; note transactions are serialized.
670 kvp_transaction.recv_len = recvlen;
671 kvp_transaction.recv_req_id = requestid;
672 kvp_transaction.kvp_msg = kvp_msg;
674 if (kvp_transaction.state < HVUTIL_READY) {
675 /* Userspace is not registered yet */
676 kvp_respond_to_host(NULL, HV_E_FAIL);
679 kvp_transaction.state = HVUTIL_HOSTMSG_RECEIVED;
682 * Get the information from the
683 * user-mode component.
684 * component. This transaction will be
685 * completed when we get the value from
686 * the user-mode component.
687 * Set a timeout to deal with
688 * user-mode not responding.
690 schedule_work(&kvp_sendkey_work);
691 schedule_delayed_work(&kvp_timeout_work,
692 HV_UTIL_TIMEOUT * HZ);
698 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
699 | ICMSGHDRFLAG_RESPONSE;
701 vmbus_sendpacket(channel, recv_buffer,
703 VM_PKT_DATA_INBAND, 0);
705 host_negotiatied = NEGO_FINISHED;
706 hv_poll_channel(kvp_transaction.recv_channel, kvp_poll_wrapper);
711 static void kvp_on_reset(void)
713 if (cancel_delayed_work_sync(&kvp_timeout_work))
714 kvp_respond_to_host(NULL, HV_E_FAIL);
715 kvp_transaction.state = HVUTIL_DEVICE_INIT;
719 hv_kvp_init(struct hv_util_service *srv)
721 recv_buffer = srv->recv_buffer;
722 kvp_transaction.recv_channel = srv->channel;
725 * When this driver loads, the user level daemon that
726 * processes the host requests may not yet be running.
727 * Defer processing channel callbacks until the daemon
730 kvp_transaction.state = HVUTIL_DEVICE_INIT;
732 hvt = hvutil_transport_init(kvp_devname, CN_KVP_IDX, CN_KVP_VAL,
733 kvp_on_msg, kvp_on_reset);
740 void hv_kvp_deinit(void)
742 kvp_transaction.state = HVUTIL_DEVICE_DYING;
743 cancel_delayed_work_sync(&kvp_host_handshake_work);
744 cancel_delayed_work_sync(&kvp_timeout_work);
745 cancel_work_sync(&kvp_sendkey_work);
746 hvutil_transport_destroy(hvt);