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_host_handshake_func(struct work_struct
*dummy
);
82 static void kvp_register(int);
84 static DECLARE_DELAYED_WORK(kvp_timeout_work
, kvp_timeout_func
);
85 static DECLARE_DELAYED_WORK(kvp_host_handshake_work
, kvp_host_handshake_func
);
86 static DECLARE_WORK(kvp_sendkey_work
, kvp_send_key
);
88 static const char kvp_devname
[] = "vmbus/hv_kvp";
89 static u8
*recv_buffer
;
90 static struct hvutil_transport
*hvt
;
92 * Register the kernel component with the user-level daemon.
93 * As part of this registration, pass the LIC version number.
94 * This number has no meaning, it satisfies the registration protocol.
96 #define HV_DRV_VERSION "3.1"
98 static void kvp_poll_wrapper(void *channel
)
100 /* Transaction is finished, reset the state here to avoid races. */
101 kvp_transaction
.state
= HVUTIL_READY
;
102 hv_kvp_onchannelcallback(channel
);
105 static void kvp_register_done(void)
108 * If we're still negotiating with the host cancel the timeout
109 * work to not poll the channel twice.
111 pr_debug("KVP: userspace daemon registered\n");
112 cancel_delayed_work_sync(&kvp_host_handshake_work
);
113 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
117 kvp_register(int reg_value
)
120 struct hv_kvp_msg
*kvp_msg
;
123 kvp_msg
= kzalloc(sizeof(*kvp_msg
), GFP_KERNEL
);
126 version
= kvp_msg
->body
.kvp_register
.version
;
127 kvp_msg
->kvp_hdr
.operation
= reg_value
;
128 strcpy(version
, HV_DRV_VERSION
);
130 hvutil_transport_send(hvt
, kvp_msg
, sizeof(*kvp_msg
),
136 static void kvp_timeout_func(struct work_struct
*dummy
)
139 * If the timer fires, the user-mode component has not responded;
140 * process the pending transaction.
142 kvp_respond_to_host(NULL
, HV_E_FAIL
);
144 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
147 static void kvp_host_handshake_func(struct work_struct
*dummy
)
149 hv_poll_channel(kvp_transaction
.recv_channel
, hv_kvp_onchannelcallback
);
152 static int kvp_handle_handshake(struct hv_kvp_msg
*msg
)
154 switch (msg
->kvp_hdr
.operation
) {
155 case KVP_OP_REGISTER
:
156 dm_reg_value
= KVP_OP_REGISTER
;
157 pr_info("KVP: IP injection functionality not available\n");
158 pr_info("KVP: Upgrade the KVP daemon\n");
160 case KVP_OP_REGISTER1
:
161 dm_reg_value
= KVP_OP_REGISTER1
;
164 pr_info("KVP: incompatible daemon\n");
165 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
166 KVP_OP_REGISTER1
, msg
->kvp_hdr
.operation
);
171 * We have a compatible daemon; complete the handshake.
173 pr_debug("KVP: userspace daemon ver. %d connected\n",
174 msg
->kvp_hdr
.operation
);
175 kvp_register(dm_reg_value
);
182 * Callback when data is received from user mode.
185 static int kvp_on_msg(void *msg
, int len
)
187 struct hv_kvp_msg
*message
= (struct hv_kvp_msg
*)msg
;
188 struct hv_kvp_msg_enumerate
*data
;
191 if (len
< sizeof(*message
))
195 * If we are negotiating the version information
196 * with the daemon; handle that first.
199 if (kvp_transaction
.state
< HVUTIL_READY
) {
200 return kvp_handle_handshake(message
);
203 /* We didn't send anything to userspace so the reply is spurious */
204 if (kvp_transaction
.state
< HVUTIL_USERSPACE_REQ
)
207 kvp_transaction
.state
= HVUTIL_USERSPACE_RECV
;
210 * Based on the version of the daemon, we propagate errors from the
211 * daemon differently.
214 data
= &message
->body
.kvp_enum_data
;
216 switch (dm_reg_value
) {
217 case KVP_OP_REGISTER
:
219 * Null string is used to pass back error condition.
221 if (data
->data
.key
[0] == 0)
225 case KVP_OP_REGISTER1
:
227 * We use the message header information from
228 * the user level daemon to transmit errors.
230 error
= message
->error
;
235 * Complete the transaction by forwarding the key value
236 * to the host. But first, cancel the timeout.
238 if (cancel_delayed_work_sync(&kvp_timeout_work
)) {
239 kvp_respond_to_host(message
, error
);
240 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
247 static int process_ob_ipinfo(void *in_msg
, void *out_msg
, int op
)
249 struct hv_kvp_msg
*in
= in_msg
;
250 struct hv_kvp_ip_msg
*out
= out_msg
;
254 case KVP_OP_GET_IP_INFO
:
256 * Transform all parameters into utf16 encoding.
258 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.ip_addr
,
259 strlen((char *)in
->body
.kvp_ip_val
.ip_addr
),
261 (wchar_t *)out
->kvp_ip_val
.ip_addr
,
266 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.sub_net
,
267 strlen((char *)in
->body
.kvp_ip_val
.sub_net
),
269 (wchar_t *)out
->kvp_ip_val
.sub_net
,
274 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.gate_way
,
275 strlen((char *)in
->body
.kvp_ip_val
.gate_way
),
277 (wchar_t *)out
->kvp_ip_val
.gate_way
,
282 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.dns_addr
,
283 strlen((char *)in
->body
.kvp_ip_val
.dns_addr
),
285 (wchar_t *)out
->kvp_ip_val
.dns_addr
,
290 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.adapter_id
,
291 strlen((char *)in
->body
.kvp_ip_val
.adapter_id
),
293 (wchar_t *)out
->kvp_ip_val
.adapter_id
,
298 out
->kvp_ip_val
.dhcp_enabled
=
299 in
->body
.kvp_ip_val
.dhcp_enabled
;
300 out
->kvp_ip_val
.addr_family
=
301 in
->body
.kvp_ip_val
.addr_family
;
307 static void process_ib_ipinfo(void *in_msg
, void *out_msg
, int op
)
309 struct hv_kvp_ip_msg
*in
= in_msg
;
310 struct hv_kvp_msg
*out
= out_msg
;
313 case KVP_OP_SET_IP_INFO
:
315 * Transform all parameters into utf8 encoding.
317 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.ip_addr
,
320 (__u8
*)out
->body
.kvp_ip_val
.ip_addr
,
323 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.sub_net
,
326 (__u8
*)out
->body
.kvp_ip_val
.sub_net
,
329 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.gate_way
,
332 (__u8
*)out
->body
.kvp_ip_val
.gate_way
,
335 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.dns_addr
,
338 (__u8
*)out
->body
.kvp_ip_val
.dns_addr
,
341 out
->body
.kvp_ip_val
.dhcp_enabled
= in
->kvp_ip_val
.dhcp_enabled
;
344 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.adapter_id
,
347 (__u8
*)out
->body
.kvp_ip_val
.adapter_id
,
348 MAX_ADAPTER_ID_SIZE
);
350 out
->body
.kvp_ip_val
.addr_family
= in
->kvp_ip_val
.addr_family
;
358 kvp_send_key(struct work_struct
*dummy
)
360 struct hv_kvp_msg
*message
;
361 struct hv_kvp_msg
*in_msg
;
362 __u8 operation
= kvp_transaction
.kvp_msg
->kvp_hdr
.operation
;
363 __u8 pool
= kvp_transaction
.kvp_msg
->kvp_hdr
.pool
;
368 /* The transaction state is wrong. */
369 if (kvp_transaction
.state
!= HVUTIL_HOSTMSG_RECEIVED
)
372 message
= kzalloc(sizeof(*message
), GFP_KERNEL
);
376 message
->kvp_hdr
.operation
= operation
;
377 message
->kvp_hdr
.pool
= pool
;
378 in_msg
= kvp_transaction
.kvp_msg
;
381 * The key/value strings sent from the host are encoded in
382 * in utf16; convert it to utf8 strings.
383 * The host assures us that the utf16 strings will not exceed
384 * the max lengths specified. We will however, reserve room
385 * for the string terminating character - in the utf16s_utf8s()
386 * function we limit the size of the buffer where the converted
387 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
388 * that the strings can be properly terminated!
391 switch (message
->kvp_hdr
.operation
) {
392 case KVP_OP_SET_IP_INFO
:
393 process_ib_ipinfo(in_msg
, message
, KVP_OP_SET_IP_INFO
);
395 case KVP_OP_GET_IP_INFO
:
396 process_ib_ipinfo(in_msg
, message
, KVP_OP_GET_IP_INFO
);
399 switch (in_msg
->body
.kvp_set
.data
.value_type
) {
402 * The value is a string - utf16 encoding.
404 message
->body
.kvp_set
.data
.value_size
=
406 (wchar_t *)in_msg
->body
.kvp_set
.data
.value
,
407 in_msg
->body
.kvp_set
.data
.value_size
,
409 message
->body
.kvp_set
.data
.value
,
410 HV_KVP_EXCHANGE_MAX_VALUE_SIZE
- 1) + 1;
415 * The value is a 32 bit scalar.
416 * We save this as a utf8 string.
418 val32
= in_msg
->body
.kvp_set
.data
.value_u32
;
419 message
->body
.kvp_set
.data
.value_size
=
420 sprintf(message
->body
.kvp_set
.data
.value
,
426 * The value is a 64 bit scalar.
427 * We save this as a utf8 string.
429 val64
= in_msg
->body
.kvp_set
.data
.value_u64
;
430 message
->body
.kvp_set
.data
.value_size
=
431 sprintf(message
->body
.kvp_set
.data
.value
,
437 message
->body
.kvp_set
.data
.key_size
=
439 (wchar_t *)in_msg
->body
.kvp_set
.data
.key
,
440 in_msg
->body
.kvp_set
.data
.key_size
,
442 message
->body
.kvp_set
.data
.key
,
443 HV_KVP_EXCHANGE_MAX_KEY_SIZE
- 1) + 1;
447 message
->body
.kvp_delete
.key_size
=
449 (wchar_t *)in_msg
->body
.kvp_delete
.key
,
450 in_msg
->body
.kvp_delete
.key_size
,
452 message
->body
.kvp_delete
.key
,
453 HV_KVP_EXCHANGE_MAX_KEY_SIZE
- 1) + 1;
456 case KVP_OP_ENUMERATE
:
457 message
->body
.kvp_enum_data
.index
=
458 in_msg
->body
.kvp_enum_data
.index
;
462 kvp_transaction
.state
= HVUTIL_USERSPACE_REQ
;
463 rc
= hvutil_transport_send(hvt
, message
, sizeof(*message
), NULL
);
465 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc
);
466 if (cancel_delayed_work_sync(&kvp_timeout_work
)) {
467 kvp_respond_to_host(message
, HV_E_FAIL
);
468 kvp_transaction
.state
= HVUTIL_READY
;
478 * Send a response back to the host.
482 kvp_respond_to_host(struct hv_kvp_msg
*msg_to_host
, int error
)
484 struct hv_kvp_msg
*kvp_msg
;
485 struct hv_kvp_exchg_msg_value
*kvp_data
;
488 struct icmsg_hdr
*icmsghdrp
;
492 struct vmbus_channel
*channel
;
497 * Copy the global state for completing the transaction. Note that
498 * only one transaction can be active at a time.
501 buf_len
= kvp_transaction
.recv_len
;
502 channel
= kvp_transaction
.recv_channel
;
503 req_id
= kvp_transaction
.recv_req_id
;
505 icmsghdrp
= (struct icmsg_hdr
*)
506 &recv_buffer
[sizeof(struct vmbuspipe_hdr
)];
508 if (channel
->onchannel_callback
== NULL
)
510 * We have raced with util driver being unloaded;
515 icmsghdrp
->status
= error
;
518 * If the error parameter is set, terminate the host's enumeration
523 * Something failed or we have timedout;
524 * terminate the current host-side iteration.
529 kvp_msg
= (struct hv_kvp_msg
*)
530 &recv_buffer
[sizeof(struct vmbuspipe_hdr
) +
531 sizeof(struct icmsg_hdr
)];
533 switch (kvp_transaction
.kvp_msg
->kvp_hdr
.operation
) {
534 case KVP_OP_GET_IP_INFO
:
535 ret
= process_ob_ipinfo(msg_to_host
,
536 (struct hv_kvp_ip_msg
*)kvp_msg
,
539 icmsghdrp
->status
= HV_E_FAIL
;
542 case KVP_OP_SET_IP_INFO
:
545 kvp_data
= &kvp_msg
->body
.kvp_get
.data
;
556 kvp_data
= &kvp_msg
->body
.kvp_enum_data
.data
;
557 key_name
= msg_to_host
->body
.kvp_enum_data
.data
.key
;
560 * The windows host expects the key/value pair to be encoded
561 * in utf16. Ensure that the key/value size reported to the host
562 * will be less than or equal to the MAX size (including the
563 * terminating character).
565 keylen
= utf8s_to_utf16s(key_name
, strlen(key_name
), UTF16_HOST_ENDIAN
,
566 (wchar_t *) kvp_data
->key
,
567 (HV_KVP_EXCHANGE_MAX_KEY_SIZE
/ 2) - 2);
568 kvp_data
->key_size
= 2*(keylen
+ 1); /* utf16 encoding */
571 value
= msg_to_host
->body
.kvp_enum_data
.data
.value
;
572 valuelen
= utf8s_to_utf16s(value
, strlen(value
), UTF16_HOST_ENDIAN
,
573 (wchar_t *) kvp_data
->value
,
574 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE
/ 2) - 2);
575 kvp_data
->value_size
= 2*(valuelen
+ 1); /* utf16 encoding */
578 * If the utf8s to utf16s conversion failed; notify host
581 if ((keylen
< 0) || (valuelen
< 0))
582 icmsghdrp
->status
= HV_E_FAIL
;
584 kvp_data
->value_type
= REG_SZ
; /* all our values are strings */
587 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
| ICMSGHDRFLAG_RESPONSE
;
589 vmbus_sendpacket(channel
, recv_buffer
, buf_len
, req_id
,
590 VM_PKT_DATA_INBAND
, 0);
594 * This callback is invoked when we get a KVP message from the host.
595 * The host ensures that only one KVP transaction can be active at a time.
596 * KVP implementation in Linux needs to forward the key to a user-mde
597 * component to retrive the corresponding value. Consequently, we cannot
598 * respond to the host in the conext of this callback. Since the host
599 * guarantees that at most only one transaction can be active at a time,
600 * we stash away the transaction state in a set of global variables.
603 void hv_kvp_onchannelcallback(void *context
)
605 struct vmbus_channel
*channel
= context
;
609 struct hv_kvp_msg
*kvp_msg
;
611 struct icmsg_hdr
*icmsghdrp
;
612 struct icmsg_negotiate
*negop
= NULL
;
615 static enum {NEGO_NOT_STARTED
,
617 NEGO_FINISHED
} host_negotiatied
= NEGO_NOT_STARTED
;
619 if (host_negotiatied
== NEGO_NOT_STARTED
&&
620 kvp_transaction
.state
< HVUTIL_READY
) {
622 * If userspace daemon is not connected and host is asking
623 * us to negotiate we need to delay to not lose messages.
624 * This is important for Failover IP setting.
626 host_negotiatied
= NEGO_IN_PROGRESS
;
627 schedule_delayed_work(&kvp_host_handshake_work
,
628 HV_UTIL_NEGO_TIMEOUT
* HZ
);
631 if (kvp_transaction
.state
> HVUTIL_READY
)
634 vmbus_recvpacket(channel
, recv_buffer
, PAGE_SIZE
* 4, &recvlen
,
638 icmsghdrp
= (struct icmsg_hdr
*)&recv_buffer
[
639 sizeof(struct vmbuspipe_hdr
)];
641 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
643 * Based on the host, select appropriate
644 * framework and service versions we will
647 switch (vmbus_proto_version
) {
648 case (VERSION_WS2008
):
649 util_fw_version
= UTIL_WS2K8_FW_VERSION
;
650 kvp_srv_version
= WS2008_SRV_VERSION
;
653 util_fw_version
= UTIL_FW_VERSION
;
654 kvp_srv_version
= WIN7_SRV_VERSION
;
657 util_fw_version
= UTIL_FW_VERSION
;
658 kvp_srv_version
= WIN8_SRV_VERSION
;
660 vmbus_prep_negotiate_resp(icmsghdrp
, negop
,
661 recv_buffer
, util_fw_version
,
665 kvp_msg
= (struct hv_kvp_msg
*)&recv_buffer
[
666 sizeof(struct vmbuspipe_hdr
) +
667 sizeof(struct icmsg_hdr
)];
670 * Stash away this global state for completing the
671 * transaction; note transactions are serialized.
674 kvp_transaction
.recv_len
= recvlen
;
675 kvp_transaction
.recv_req_id
= requestid
;
676 kvp_transaction
.kvp_msg
= kvp_msg
;
678 if (kvp_transaction
.state
< HVUTIL_READY
) {
679 /* Userspace is not registered yet */
680 kvp_respond_to_host(NULL
, HV_E_FAIL
);
683 kvp_transaction
.state
= HVUTIL_HOSTMSG_RECEIVED
;
686 * Get the information from the
687 * user-mode component.
688 * component. This transaction will be
689 * completed when we get the value from
690 * the user-mode component.
691 * Set a timeout to deal with
692 * user-mode not responding.
694 schedule_work(&kvp_sendkey_work
);
695 schedule_delayed_work(&kvp_timeout_work
,
696 HV_UTIL_TIMEOUT
* HZ
);
702 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
703 | ICMSGHDRFLAG_RESPONSE
;
705 vmbus_sendpacket(channel
, recv_buffer
,
707 VM_PKT_DATA_INBAND
, 0);
709 host_negotiatied
= NEGO_FINISHED
;
714 static void kvp_on_reset(void)
716 if (cancel_delayed_work_sync(&kvp_timeout_work
))
717 kvp_respond_to_host(NULL
, HV_E_FAIL
);
718 kvp_transaction
.state
= HVUTIL_DEVICE_INIT
;
722 hv_kvp_init(struct hv_util_service
*srv
)
724 recv_buffer
= srv
->recv_buffer
;
725 kvp_transaction
.recv_channel
= srv
->channel
;
728 * When this driver loads, the user level daemon that
729 * processes the host requests may not yet be running.
730 * Defer processing channel callbacks until the daemon
733 kvp_transaction
.state
= HVUTIL_DEVICE_INIT
;
735 hvt
= hvutil_transport_init(kvp_devname
, CN_KVP_IDX
, CN_KVP_VAL
,
736 kvp_on_msg
, kvp_on_reset
);
743 void hv_kvp_deinit(void)
745 kvp_transaction
.state
= HVUTIL_DEVICE_DYING
;
746 cancel_delayed_work_sync(&kvp_host_handshake_work
);
747 cancel_delayed_work_sync(&kvp_timeout_work
);
748 cancel_work_sync(&kvp_sendkey_work
);
749 hvutil_transport_destroy(hvt
);