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
;
91 static struct completion release_event
;
93 * Register the kernel component with the user-level daemon.
94 * As part of this registration, pass the LIC version number.
95 * This number has no meaning, it satisfies the registration protocol.
97 #define HV_DRV_VERSION "3.1"
99 static void kvp_poll_wrapper(void *channel
)
101 /* Transaction is finished, reset the state here to avoid races. */
102 kvp_transaction
.state
= HVUTIL_READY
;
103 hv_kvp_onchannelcallback(channel
);
106 static void kvp_register_done(void)
109 * If we're still negotiating with the host cancel the timeout
110 * work to not poll the channel twice.
112 pr_debug("KVP: userspace daemon registered\n");
113 cancel_delayed_work_sync(&kvp_host_handshake_work
);
114 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
118 kvp_register(int reg_value
)
121 struct hv_kvp_msg
*kvp_msg
;
124 kvp_msg
= kzalloc(sizeof(*kvp_msg
), GFP_KERNEL
);
127 version
= kvp_msg
->body
.kvp_register
.version
;
128 kvp_msg
->kvp_hdr
.operation
= reg_value
;
129 strcpy(version
, HV_DRV_VERSION
);
131 hvutil_transport_send(hvt
, kvp_msg
, sizeof(*kvp_msg
),
137 static void kvp_timeout_func(struct work_struct
*dummy
)
140 * If the timer fires, the user-mode component has not responded;
141 * process the pending transaction.
143 kvp_respond_to_host(NULL
, HV_E_FAIL
);
145 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
148 static void kvp_host_handshake_func(struct work_struct
*dummy
)
150 hv_poll_channel(kvp_transaction
.recv_channel
, hv_kvp_onchannelcallback
);
153 static int kvp_handle_handshake(struct hv_kvp_msg
*msg
)
155 switch (msg
->kvp_hdr
.operation
) {
156 case KVP_OP_REGISTER
:
157 dm_reg_value
= KVP_OP_REGISTER
;
158 pr_info("KVP: IP injection functionality not available\n");
159 pr_info("KVP: Upgrade the KVP daemon\n");
161 case KVP_OP_REGISTER1
:
162 dm_reg_value
= KVP_OP_REGISTER1
;
165 pr_info("KVP: incompatible daemon\n");
166 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
167 KVP_OP_REGISTER1
, msg
->kvp_hdr
.operation
);
172 * We have a compatible daemon; complete the handshake.
174 pr_debug("KVP: userspace daemon ver. %d connected\n",
175 msg
->kvp_hdr
.operation
);
176 kvp_register(dm_reg_value
);
183 * Callback when data is received from user mode.
186 static int kvp_on_msg(void *msg
, int len
)
188 struct hv_kvp_msg
*message
= (struct hv_kvp_msg
*)msg
;
189 struct hv_kvp_msg_enumerate
*data
;
192 if (len
< sizeof(*message
))
196 * If we are negotiating the version information
197 * with the daemon; handle that first.
200 if (kvp_transaction
.state
< HVUTIL_READY
) {
201 return kvp_handle_handshake(message
);
204 /* We didn't send anything to userspace so the reply is spurious */
205 if (kvp_transaction
.state
< HVUTIL_USERSPACE_REQ
)
208 kvp_transaction
.state
= HVUTIL_USERSPACE_RECV
;
211 * Based on the version of the daemon, we propagate errors from the
212 * daemon differently.
215 data
= &message
->body
.kvp_enum_data
;
217 switch (dm_reg_value
) {
218 case KVP_OP_REGISTER
:
220 * Null string is used to pass back error condition.
222 if (data
->data
.key
[0] == 0)
226 case KVP_OP_REGISTER1
:
228 * We use the message header information from
229 * the user level daemon to transmit errors.
231 error
= message
->error
;
236 * Complete the transaction by forwarding the key value
237 * to the host. But first, cancel the timeout.
239 if (cancel_delayed_work_sync(&kvp_timeout_work
)) {
240 kvp_respond_to_host(message
, error
);
241 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
248 static int process_ob_ipinfo(void *in_msg
, void *out_msg
, int op
)
250 struct hv_kvp_msg
*in
= in_msg
;
251 struct hv_kvp_ip_msg
*out
= out_msg
;
255 case KVP_OP_GET_IP_INFO
:
257 * Transform all parameters into utf16 encoding.
259 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.ip_addr
,
260 strlen((char *)in
->body
.kvp_ip_val
.ip_addr
),
262 (wchar_t *)out
->kvp_ip_val
.ip_addr
,
267 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.sub_net
,
268 strlen((char *)in
->body
.kvp_ip_val
.sub_net
),
270 (wchar_t *)out
->kvp_ip_val
.sub_net
,
275 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.gate_way
,
276 strlen((char *)in
->body
.kvp_ip_val
.gate_way
),
278 (wchar_t *)out
->kvp_ip_val
.gate_way
,
283 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.dns_addr
,
284 strlen((char *)in
->body
.kvp_ip_val
.dns_addr
),
286 (wchar_t *)out
->kvp_ip_val
.dns_addr
,
291 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.adapter_id
,
292 strlen((char *)in
->body
.kvp_ip_val
.adapter_id
),
294 (wchar_t *)out
->kvp_ip_val
.adapter_id
,
299 out
->kvp_ip_val
.dhcp_enabled
=
300 in
->body
.kvp_ip_val
.dhcp_enabled
;
301 out
->kvp_ip_val
.addr_family
=
302 in
->body
.kvp_ip_val
.addr_family
;
308 static void process_ib_ipinfo(void *in_msg
, void *out_msg
, int op
)
310 struct hv_kvp_ip_msg
*in
= in_msg
;
311 struct hv_kvp_msg
*out
= out_msg
;
314 case KVP_OP_SET_IP_INFO
:
316 * Transform all parameters into utf8 encoding.
318 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.ip_addr
,
321 (__u8
*)out
->body
.kvp_ip_val
.ip_addr
,
324 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.sub_net
,
327 (__u8
*)out
->body
.kvp_ip_val
.sub_net
,
330 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.gate_way
,
333 (__u8
*)out
->body
.kvp_ip_val
.gate_way
,
336 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.dns_addr
,
339 (__u8
*)out
->body
.kvp_ip_val
.dns_addr
,
342 out
->body
.kvp_ip_val
.dhcp_enabled
= in
->kvp_ip_val
.dhcp_enabled
;
345 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.adapter_id
,
348 (__u8
*)out
->body
.kvp_ip_val
.adapter_id
,
349 MAX_ADAPTER_ID_SIZE
);
351 out
->body
.kvp_ip_val
.addr_family
= in
->kvp_ip_val
.addr_family
;
359 kvp_send_key(struct work_struct
*dummy
)
361 struct hv_kvp_msg
*message
;
362 struct hv_kvp_msg
*in_msg
;
363 __u8 operation
= kvp_transaction
.kvp_msg
->kvp_hdr
.operation
;
364 __u8 pool
= kvp_transaction
.kvp_msg
->kvp_hdr
.pool
;
369 /* The transaction state is wrong. */
370 if (kvp_transaction
.state
!= HVUTIL_HOSTMSG_RECEIVED
)
373 message
= kzalloc(sizeof(*message
), GFP_KERNEL
);
377 message
->kvp_hdr
.operation
= operation
;
378 message
->kvp_hdr
.pool
= pool
;
379 in_msg
= kvp_transaction
.kvp_msg
;
382 * The key/value strings sent from the host are encoded in
383 * in utf16; convert it to utf8 strings.
384 * The host assures us that the utf16 strings will not exceed
385 * the max lengths specified. We will however, reserve room
386 * for the string terminating character - in the utf16s_utf8s()
387 * function we limit the size of the buffer where the converted
388 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
389 * that the strings can be properly terminated!
392 switch (message
->kvp_hdr
.operation
) {
393 case KVP_OP_SET_IP_INFO
:
394 process_ib_ipinfo(in_msg
, message
, KVP_OP_SET_IP_INFO
);
396 case KVP_OP_GET_IP_INFO
:
397 process_ib_ipinfo(in_msg
, message
, KVP_OP_GET_IP_INFO
);
400 switch (in_msg
->body
.kvp_set
.data
.value_type
) {
403 * The value is a string - utf16 encoding.
405 message
->body
.kvp_set
.data
.value_size
=
407 (wchar_t *)in_msg
->body
.kvp_set
.data
.value
,
408 in_msg
->body
.kvp_set
.data
.value_size
,
410 message
->body
.kvp_set
.data
.value
,
411 HV_KVP_EXCHANGE_MAX_VALUE_SIZE
- 1) + 1;
416 * The value is a 32 bit scalar.
417 * We save this as a utf8 string.
419 val32
= in_msg
->body
.kvp_set
.data
.value_u32
;
420 message
->body
.kvp_set
.data
.value_size
=
421 sprintf(message
->body
.kvp_set
.data
.value
,
427 * The value is a 64 bit scalar.
428 * We save this as a utf8 string.
430 val64
= in_msg
->body
.kvp_set
.data
.value_u64
;
431 message
->body
.kvp_set
.data
.value_size
=
432 sprintf(message
->body
.kvp_set
.data
.value
,
438 message
->body
.kvp_set
.data
.key_size
=
440 (wchar_t *)in_msg
->body
.kvp_set
.data
.key
,
441 in_msg
->body
.kvp_set
.data
.key_size
,
443 message
->body
.kvp_set
.data
.key
,
444 HV_KVP_EXCHANGE_MAX_KEY_SIZE
- 1) + 1;
448 message
->body
.kvp_delete
.key_size
=
450 (wchar_t *)in_msg
->body
.kvp_delete
.key
,
451 in_msg
->body
.kvp_delete
.key_size
,
453 message
->body
.kvp_delete
.key
,
454 HV_KVP_EXCHANGE_MAX_KEY_SIZE
- 1) + 1;
457 case KVP_OP_ENUMERATE
:
458 message
->body
.kvp_enum_data
.index
=
459 in_msg
->body
.kvp_enum_data
.index
;
463 kvp_transaction
.state
= HVUTIL_USERSPACE_REQ
;
464 rc
= hvutil_transport_send(hvt
, message
, sizeof(*message
), NULL
);
466 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc
);
467 if (cancel_delayed_work_sync(&kvp_timeout_work
)) {
468 kvp_respond_to_host(message
, HV_E_FAIL
);
469 kvp_transaction
.state
= HVUTIL_READY
;
479 * Send a response back to the host.
483 kvp_respond_to_host(struct hv_kvp_msg
*msg_to_host
, int error
)
485 struct hv_kvp_msg
*kvp_msg
;
486 struct hv_kvp_exchg_msg_value
*kvp_data
;
489 struct icmsg_hdr
*icmsghdrp
;
493 struct vmbus_channel
*channel
;
498 * Copy the global state for completing the transaction. Note that
499 * only one transaction can be active at a time.
502 buf_len
= kvp_transaction
.recv_len
;
503 channel
= kvp_transaction
.recv_channel
;
504 req_id
= kvp_transaction
.recv_req_id
;
506 icmsghdrp
= (struct icmsg_hdr
*)
507 &recv_buffer
[sizeof(struct vmbuspipe_hdr
)];
509 if (channel
->onchannel_callback
== NULL
)
511 * We have raced with util driver being unloaded;
516 icmsghdrp
->status
= error
;
519 * If the error parameter is set, terminate the host's enumeration
524 * Something failed or we have timedout;
525 * terminate the current host-side iteration.
530 kvp_msg
= (struct hv_kvp_msg
*)
531 &recv_buffer
[sizeof(struct vmbuspipe_hdr
) +
532 sizeof(struct icmsg_hdr
)];
534 switch (kvp_transaction
.kvp_msg
->kvp_hdr
.operation
) {
535 case KVP_OP_GET_IP_INFO
:
536 ret
= process_ob_ipinfo(msg_to_host
,
537 (struct hv_kvp_ip_msg
*)kvp_msg
,
540 icmsghdrp
->status
= HV_E_FAIL
;
543 case KVP_OP_SET_IP_INFO
:
546 kvp_data
= &kvp_msg
->body
.kvp_get
.data
;
557 kvp_data
= &kvp_msg
->body
.kvp_enum_data
.data
;
558 key_name
= msg_to_host
->body
.kvp_enum_data
.data
.key
;
561 * The windows host expects the key/value pair to be encoded
562 * in utf16. Ensure that the key/value size reported to the host
563 * will be less than or equal to the MAX size (including the
564 * terminating character).
566 keylen
= utf8s_to_utf16s(key_name
, strlen(key_name
), UTF16_HOST_ENDIAN
,
567 (wchar_t *) kvp_data
->key
,
568 (HV_KVP_EXCHANGE_MAX_KEY_SIZE
/ 2) - 2);
569 kvp_data
->key_size
= 2*(keylen
+ 1); /* utf16 encoding */
572 value
= msg_to_host
->body
.kvp_enum_data
.data
.value
;
573 valuelen
= utf8s_to_utf16s(value
, strlen(value
), UTF16_HOST_ENDIAN
,
574 (wchar_t *) kvp_data
->value
,
575 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE
/ 2) - 2);
576 kvp_data
->value_size
= 2*(valuelen
+ 1); /* utf16 encoding */
579 * If the utf8s to utf16s conversion failed; notify host
582 if ((keylen
< 0) || (valuelen
< 0))
583 icmsghdrp
->status
= HV_E_FAIL
;
585 kvp_data
->value_type
= REG_SZ
; /* all our values are strings */
588 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
| ICMSGHDRFLAG_RESPONSE
;
590 vmbus_sendpacket(channel
, recv_buffer
, buf_len
, req_id
,
591 VM_PKT_DATA_INBAND
, 0);
595 * This callback is invoked when we get a KVP message from the host.
596 * The host ensures that only one KVP transaction can be active at a time.
597 * KVP implementation in Linux needs to forward the key to a user-mde
598 * component to retrive the corresponding value. Consequently, we cannot
599 * respond to the host in the conext of this callback. Since the host
600 * guarantees that at most only one transaction can be active at a time,
601 * we stash away the transaction state in a set of global variables.
604 void hv_kvp_onchannelcallback(void *context
)
606 struct vmbus_channel
*channel
= context
;
610 struct hv_kvp_msg
*kvp_msg
;
612 struct icmsg_hdr
*icmsghdrp
;
613 struct icmsg_negotiate
*negop
= NULL
;
616 static enum {NEGO_NOT_STARTED
,
618 NEGO_FINISHED
} host_negotiatied
= NEGO_NOT_STARTED
;
620 if (host_negotiatied
== NEGO_NOT_STARTED
&&
621 kvp_transaction
.state
< HVUTIL_READY
) {
623 * If userspace daemon is not connected and host is asking
624 * us to negotiate we need to delay to not lose messages.
625 * This is important for Failover IP setting.
627 host_negotiatied
= NEGO_IN_PROGRESS
;
628 schedule_delayed_work(&kvp_host_handshake_work
,
629 HV_UTIL_NEGO_TIMEOUT
* HZ
);
632 if (kvp_transaction
.state
> HVUTIL_READY
)
635 vmbus_recvpacket(channel
, recv_buffer
, PAGE_SIZE
* 4, &recvlen
,
639 icmsghdrp
= (struct icmsg_hdr
*)&recv_buffer
[
640 sizeof(struct vmbuspipe_hdr
)];
642 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
644 * Based on the host, select appropriate
645 * framework and service versions we will
648 switch (vmbus_proto_version
) {
649 case (VERSION_WS2008
):
650 util_fw_version
= UTIL_WS2K8_FW_VERSION
;
651 kvp_srv_version
= WS2008_SRV_VERSION
;
654 util_fw_version
= UTIL_FW_VERSION
;
655 kvp_srv_version
= WIN7_SRV_VERSION
;
658 util_fw_version
= UTIL_FW_VERSION
;
659 kvp_srv_version
= WIN8_SRV_VERSION
;
661 vmbus_prep_negotiate_resp(icmsghdrp
, negop
,
662 recv_buffer
, util_fw_version
,
666 kvp_msg
= (struct hv_kvp_msg
*)&recv_buffer
[
667 sizeof(struct vmbuspipe_hdr
) +
668 sizeof(struct icmsg_hdr
)];
671 * Stash away this global state for completing the
672 * transaction; note transactions are serialized.
675 kvp_transaction
.recv_len
= recvlen
;
676 kvp_transaction
.recv_req_id
= requestid
;
677 kvp_transaction
.kvp_msg
= kvp_msg
;
679 if (kvp_transaction
.state
< HVUTIL_READY
) {
680 /* Userspace is not registered yet */
681 kvp_respond_to_host(NULL
, HV_E_FAIL
);
684 kvp_transaction
.state
= HVUTIL_HOSTMSG_RECEIVED
;
687 * Get the information from the
688 * user-mode component.
689 * component. This transaction will be
690 * completed when we get the value from
691 * the user-mode component.
692 * Set a timeout to deal with
693 * user-mode not responding.
695 schedule_work(&kvp_sendkey_work
);
696 schedule_delayed_work(&kvp_timeout_work
,
697 HV_UTIL_TIMEOUT
* HZ
);
703 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
704 | ICMSGHDRFLAG_RESPONSE
;
706 vmbus_sendpacket(channel
, recv_buffer
,
708 VM_PKT_DATA_INBAND
, 0);
710 host_negotiatied
= NEGO_FINISHED
;
715 static void kvp_on_reset(void)
717 if (cancel_delayed_work_sync(&kvp_timeout_work
))
718 kvp_respond_to_host(NULL
, HV_E_FAIL
);
719 kvp_transaction
.state
= HVUTIL_DEVICE_INIT
;
720 complete(&release_event
);
724 hv_kvp_init(struct hv_util_service
*srv
)
726 recv_buffer
= srv
->recv_buffer
;
727 kvp_transaction
.recv_channel
= srv
->channel
;
729 init_completion(&release_event
);
731 * When this driver loads, the user level daemon that
732 * processes the host requests may not yet be running.
733 * Defer processing channel callbacks until the daemon
736 kvp_transaction
.state
= HVUTIL_DEVICE_INIT
;
738 hvt
= hvutil_transport_init(kvp_devname
, CN_KVP_IDX
, CN_KVP_VAL
,
739 kvp_on_msg
, kvp_on_reset
);
746 void hv_kvp_deinit(void)
748 kvp_transaction
.state
= HVUTIL_DEVICE_DYING
;
749 cancel_delayed_work_sync(&kvp_host_handshake_work
);
750 cancel_delayed_work_sync(&kvp_timeout_work
);
751 cancel_work_sync(&kvp_sendkey_work
);
752 hvutil_transport_destroy(hvt
);
753 wait_for_completion(&release_event
);