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
);
106 kvp_register(int reg_value
)
109 struct hv_kvp_msg
*kvp_msg
;
112 kvp_msg
= kzalloc(sizeof(*kvp_msg
), GFP_KERNEL
);
115 version
= kvp_msg
->body
.kvp_register
.version
;
116 kvp_msg
->kvp_hdr
.operation
= reg_value
;
117 strcpy(version
, HV_DRV_VERSION
);
119 hvutil_transport_send(hvt
, kvp_msg
, sizeof(*kvp_msg
));
124 static void kvp_timeout_func(struct work_struct
*dummy
)
127 * If the timer fires, the user-mode component has not responded;
128 * process the pending transaction.
130 kvp_respond_to_host(NULL
, HV_E_FAIL
);
132 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
135 static void kvp_host_handshake_func(struct work_struct
*dummy
)
137 hv_poll_channel(kvp_transaction
.recv_channel
, hv_kvp_onchannelcallback
);
140 static int kvp_handle_handshake(struct hv_kvp_msg
*msg
)
142 switch (msg
->kvp_hdr
.operation
) {
143 case KVP_OP_REGISTER
:
144 dm_reg_value
= KVP_OP_REGISTER
;
145 pr_info("KVP: IP injection functionality not available\n");
146 pr_info("KVP: Upgrade the KVP daemon\n");
148 case KVP_OP_REGISTER1
:
149 dm_reg_value
= KVP_OP_REGISTER1
;
152 pr_info("KVP: incompatible daemon\n");
153 pr_info("KVP: KVP version: %d, Daemon version: %d\n",
154 KVP_OP_REGISTER1
, msg
->kvp_hdr
.operation
);
159 * We have a compatible daemon; complete the handshake.
161 pr_debug("KVP: userspace daemon ver. %d registered\n",
163 kvp_register(dm_reg_value
);
166 * If we're still negotiating with the host cancel the timeout
167 * work to not poll the channel twice.
169 cancel_delayed_work_sync(&kvp_host_handshake_work
);
170 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
177 * Callback when data is received from user mode.
180 static int kvp_on_msg(void *msg
, int len
)
182 struct hv_kvp_msg
*message
= (struct hv_kvp_msg
*)msg
;
183 struct hv_kvp_msg_enumerate
*data
;
186 if (len
< sizeof(*message
))
190 * If we are negotiating the version information
191 * with the daemon; handle that first.
194 if (kvp_transaction
.state
< HVUTIL_READY
) {
195 return kvp_handle_handshake(message
);
198 /* We didn't send anything to userspace so the reply is spurious */
199 if (kvp_transaction
.state
< HVUTIL_USERSPACE_REQ
)
202 kvp_transaction
.state
= HVUTIL_USERSPACE_RECV
;
205 * Based on the version of the daemon, we propagate errors from the
206 * daemon differently.
209 data
= &message
->body
.kvp_enum_data
;
211 switch (dm_reg_value
) {
212 case KVP_OP_REGISTER
:
214 * Null string is used to pass back error condition.
216 if (data
->data
.key
[0] == 0)
220 case KVP_OP_REGISTER1
:
222 * We use the message header information from
223 * the user level daemon to transmit errors.
225 error
= message
->error
;
230 * Complete the transaction by forwarding the key value
231 * to the host. But first, cancel the timeout.
233 if (cancel_delayed_work_sync(&kvp_timeout_work
)) {
234 kvp_respond_to_host(message
, error
);
235 hv_poll_channel(kvp_transaction
.recv_channel
, kvp_poll_wrapper
);
242 static int process_ob_ipinfo(void *in_msg
, void *out_msg
, int op
)
244 struct hv_kvp_msg
*in
= in_msg
;
245 struct hv_kvp_ip_msg
*out
= out_msg
;
249 case KVP_OP_GET_IP_INFO
:
251 * Transform all parameters into utf16 encoding.
253 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.ip_addr
,
254 strlen((char *)in
->body
.kvp_ip_val
.ip_addr
),
256 (wchar_t *)out
->kvp_ip_val
.ip_addr
,
261 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.sub_net
,
262 strlen((char *)in
->body
.kvp_ip_val
.sub_net
),
264 (wchar_t *)out
->kvp_ip_val
.sub_net
,
269 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.gate_way
,
270 strlen((char *)in
->body
.kvp_ip_val
.gate_way
),
272 (wchar_t *)out
->kvp_ip_val
.gate_way
,
277 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.dns_addr
,
278 strlen((char *)in
->body
.kvp_ip_val
.dns_addr
),
280 (wchar_t *)out
->kvp_ip_val
.dns_addr
,
285 len
= utf8s_to_utf16s((char *)in
->body
.kvp_ip_val
.adapter_id
,
286 strlen((char *)in
->body
.kvp_ip_val
.adapter_id
),
288 (wchar_t *)out
->kvp_ip_val
.adapter_id
,
293 out
->kvp_ip_val
.dhcp_enabled
=
294 in
->body
.kvp_ip_val
.dhcp_enabled
;
295 out
->kvp_ip_val
.addr_family
=
296 in
->body
.kvp_ip_val
.addr_family
;
302 static void process_ib_ipinfo(void *in_msg
, void *out_msg
, int op
)
304 struct hv_kvp_ip_msg
*in
= in_msg
;
305 struct hv_kvp_msg
*out
= out_msg
;
308 case KVP_OP_SET_IP_INFO
:
310 * Transform all parameters into utf8 encoding.
312 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.ip_addr
,
315 (__u8
*)out
->body
.kvp_ip_val
.ip_addr
,
318 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.sub_net
,
321 (__u8
*)out
->body
.kvp_ip_val
.sub_net
,
324 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.gate_way
,
327 (__u8
*)out
->body
.kvp_ip_val
.gate_way
,
330 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.dns_addr
,
333 (__u8
*)out
->body
.kvp_ip_val
.dns_addr
,
336 out
->body
.kvp_ip_val
.dhcp_enabled
= in
->kvp_ip_val
.dhcp_enabled
;
339 utf16s_to_utf8s((wchar_t *)in
->kvp_ip_val
.adapter_id
,
342 (__u8
*)out
->body
.kvp_ip_val
.adapter_id
,
343 MAX_ADAPTER_ID_SIZE
);
345 out
->body
.kvp_ip_val
.addr_family
= in
->kvp_ip_val
.addr_family
;
353 kvp_send_key(struct work_struct
*dummy
)
355 struct hv_kvp_msg
*message
;
356 struct hv_kvp_msg
*in_msg
;
357 __u8 operation
= kvp_transaction
.kvp_msg
->kvp_hdr
.operation
;
358 __u8 pool
= kvp_transaction
.kvp_msg
->kvp_hdr
.pool
;
363 /* The transaction state is wrong. */
364 if (kvp_transaction
.state
!= HVUTIL_HOSTMSG_RECEIVED
)
367 message
= kzalloc(sizeof(*message
), GFP_KERNEL
);
371 message
->kvp_hdr
.operation
= operation
;
372 message
->kvp_hdr
.pool
= pool
;
373 in_msg
= kvp_transaction
.kvp_msg
;
376 * The key/value strings sent from the host are encoded in
377 * in utf16; convert it to utf8 strings.
378 * The host assures us that the utf16 strings will not exceed
379 * the max lengths specified. We will however, reserve room
380 * for the string terminating character - in the utf16s_utf8s()
381 * function we limit the size of the buffer where the converted
382 * string is placed to HV_KVP_EXCHANGE_MAX_*_SIZE -1 to gaurantee
383 * that the strings can be properly terminated!
386 switch (message
->kvp_hdr
.operation
) {
387 case KVP_OP_SET_IP_INFO
:
388 process_ib_ipinfo(in_msg
, message
, KVP_OP_SET_IP_INFO
);
390 case KVP_OP_GET_IP_INFO
:
391 process_ib_ipinfo(in_msg
, message
, KVP_OP_GET_IP_INFO
);
394 switch (in_msg
->body
.kvp_set
.data
.value_type
) {
397 * The value is a string - utf16 encoding.
399 message
->body
.kvp_set
.data
.value_size
=
401 (wchar_t *)in_msg
->body
.kvp_set
.data
.value
,
402 in_msg
->body
.kvp_set
.data
.value_size
,
404 message
->body
.kvp_set
.data
.value
,
405 HV_KVP_EXCHANGE_MAX_VALUE_SIZE
- 1) + 1;
410 * The value is a 32 bit scalar.
411 * We save this as a utf8 string.
413 val32
= in_msg
->body
.kvp_set
.data
.value_u32
;
414 message
->body
.kvp_set
.data
.value_size
=
415 sprintf(message
->body
.kvp_set
.data
.value
,
421 * The value is a 64 bit scalar.
422 * We save this as a utf8 string.
424 val64
= in_msg
->body
.kvp_set
.data
.value_u64
;
425 message
->body
.kvp_set
.data
.value_size
=
426 sprintf(message
->body
.kvp_set
.data
.value
,
432 message
->body
.kvp_set
.data
.key_size
=
434 (wchar_t *)in_msg
->body
.kvp_set
.data
.key
,
435 in_msg
->body
.kvp_set
.data
.key_size
,
437 message
->body
.kvp_set
.data
.key
,
438 HV_KVP_EXCHANGE_MAX_KEY_SIZE
- 1) + 1;
442 message
->body
.kvp_delete
.key_size
=
444 (wchar_t *)in_msg
->body
.kvp_delete
.key
,
445 in_msg
->body
.kvp_delete
.key_size
,
447 message
->body
.kvp_delete
.key
,
448 HV_KVP_EXCHANGE_MAX_KEY_SIZE
- 1) + 1;
451 case KVP_OP_ENUMERATE
:
452 message
->body
.kvp_enum_data
.index
=
453 in_msg
->body
.kvp_enum_data
.index
;
457 kvp_transaction
.state
= HVUTIL_USERSPACE_REQ
;
458 rc
= hvutil_transport_send(hvt
, message
, sizeof(*message
));
460 pr_debug("KVP: failed to communicate to the daemon: %d\n", rc
);
461 if (cancel_delayed_work_sync(&kvp_timeout_work
)) {
462 kvp_respond_to_host(message
, HV_E_FAIL
);
463 kvp_transaction
.state
= HVUTIL_READY
;
473 * Send a response back to the host.
477 kvp_respond_to_host(struct hv_kvp_msg
*msg_to_host
, int error
)
479 struct hv_kvp_msg
*kvp_msg
;
480 struct hv_kvp_exchg_msg_value
*kvp_data
;
483 struct icmsg_hdr
*icmsghdrp
;
487 struct vmbus_channel
*channel
;
492 * Copy the global state for completing the transaction. Note that
493 * only one transaction can be active at a time.
496 buf_len
= kvp_transaction
.recv_len
;
497 channel
= kvp_transaction
.recv_channel
;
498 req_id
= kvp_transaction
.recv_req_id
;
500 icmsghdrp
= (struct icmsg_hdr
*)
501 &recv_buffer
[sizeof(struct vmbuspipe_hdr
)];
503 if (channel
->onchannel_callback
== NULL
)
505 * We have raced with util driver being unloaded;
510 icmsghdrp
->status
= error
;
513 * If the error parameter is set, terminate the host's enumeration
518 * Something failed or we have timedout;
519 * terminate the current host-side iteration.
524 kvp_msg
= (struct hv_kvp_msg
*)
525 &recv_buffer
[sizeof(struct vmbuspipe_hdr
) +
526 sizeof(struct icmsg_hdr
)];
528 switch (kvp_transaction
.kvp_msg
->kvp_hdr
.operation
) {
529 case KVP_OP_GET_IP_INFO
:
530 ret
= process_ob_ipinfo(msg_to_host
,
531 (struct hv_kvp_ip_msg
*)kvp_msg
,
534 icmsghdrp
->status
= HV_E_FAIL
;
537 case KVP_OP_SET_IP_INFO
:
540 kvp_data
= &kvp_msg
->body
.kvp_get
.data
;
551 kvp_data
= &kvp_msg
->body
.kvp_enum_data
.data
;
552 key_name
= msg_to_host
->body
.kvp_enum_data
.data
.key
;
555 * The windows host expects the key/value pair to be encoded
556 * in utf16. Ensure that the key/value size reported to the host
557 * will be less than or equal to the MAX size (including the
558 * terminating character).
560 keylen
= utf8s_to_utf16s(key_name
, strlen(key_name
), UTF16_HOST_ENDIAN
,
561 (wchar_t *) kvp_data
->key
,
562 (HV_KVP_EXCHANGE_MAX_KEY_SIZE
/ 2) - 2);
563 kvp_data
->key_size
= 2*(keylen
+ 1); /* utf16 encoding */
566 value
= msg_to_host
->body
.kvp_enum_data
.data
.value
;
567 valuelen
= utf8s_to_utf16s(value
, strlen(value
), UTF16_HOST_ENDIAN
,
568 (wchar_t *) kvp_data
->value
,
569 (HV_KVP_EXCHANGE_MAX_VALUE_SIZE
/ 2) - 2);
570 kvp_data
->value_size
= 2*(valuelen
+ 1); /* utf16 encoding */
573 * If the utf8s to utf16s conversion failed; notify host
576 if ((keylen
< 0) || (valuelen
< 0))
577 icmsghdrp
->status
= HV_E_FAIL
;
579 kvp_data
->value_type
= REG_SZ
; /* all our values are strings */
582 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
| ICMSGHDRFLAG_RESPONSE
;
584 vmbus_sendpacket(channel
, recv_buffer
, buf_len
, req_id
,
585 VM_PKT_DATA_INBAND
, 0);
589 * This callback is invoked when we get a KVP message from the host.
590 * The host ensures that only one KVP transaction can be active at a time.
591 * KVP implementation in Linux needs to forward the key to a user-mde
592 * component to retrive the corresponding value. Consequently, we cannot
593 * respond to the host in the conext of this callback. Since the host
594 * guarantees that at most only one transaction can be active at a time,
595 * we stash away the transaction state in a set of global variables.
598 void hv_kvp_onchannelcallback(void *context
)
600 struct vmbus_channel
*channel
= context
;
604 struct hv_kvp_msg
*kvp_msg
;
606 struct icmsg_hdr
*icmsghdrp
;
607 struct icmsg_negotiate
*negop
= NULL
;
610 static enum {NEGO_NOT_STARTED
,
612 NEGO_FINISHED
} host_negotiatied
= NEGO_NOT_STARTED
;
614 if (host_negotiatied
== NEGO_NOT_STARTED
&&
615 kvp_transaction
.state
< HVUTIL_READY
) {
617 * If userspace daemon is not connected and host is asking
618 * us to negotiate we need to delay to not lose messages.
619 * This is important for Failover IP setting.
621 host_negotiatied
= NEGO_IN_PROGRESS
;
622 schedule_delayed_work(&kvp_host_handshake_work
,
623 HV_UTIL_NEGO_TIMEOUT
* HZ
);
626 if (kvp_transaction
.state
> HVUTIL_READY
)
629 vmbus_recvpacket(channel
, recv_buffer
, PAGE_SIZE
* 4, &recvlen
,
633 icmsghdrp
= (struct icmsg_hdr
*)&recv_buffer
[
634 sizeof(struct vmbuspipe_hdr
)];
636 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
638 * Based on the host, select appropriate
639 * framework and service versions we will
642 switch (vmbus_proto_version
) {
643 case (VERSION_WS2008
):
644 util_fw_version
= UTIL_WS2K8_FW_VERSION
;
645 kvp_srv_version
= WS2008_SRV_VERSION
;
648 util_fw_version
= UTIL_FW_VERSION
;
649 kvp_srv_version
= WIN7_SRV_VERSION
;
652 util_fw_version
= UTIL_FW_VERSION
;
653 kvp_srv_version
= WIN8_SRV_VERSION
;
655 vmbus_prep_negotiate_resp(icmsghdrp
, negop
,
656 recv_buffer
, util_fw_version
,
660 kvp_msg
= (struct hv_kvp_msg
*)&recv_buffer
[
661 sizeof(struct vmbuspipe_hdr
) +
662 sizeof(struct icmsg_hdr
)];
665 * Stash away this global state for completing the
666 * transaction; note transactions are serialized.
669 kvp_transaction
.recv_len
= recvlen
;
670 kvp_transaction
.recv_req_id
= requestid
;
671 kvp_transaction
.kvp_msg
= kvp_msg
;
673 if (kvp_transaction
.state
< HVUTIL_READY
) {
674 /* Userspace is not registered yet */
675 kvp_respond_to_host(NULL
, HV_E_FAIL
);
678 kvp_transaction
.state
= HVUTIL_HOSTMSG_RECEIVED
;
681 * Get the information from the
682 * user-mode component.
683 * component. This transaction will be
684 * completed when we get the value from
685 * the user-mode component.
686 * Set a timeout to deal with
687 * user-mode not responding.
689 schedule_work(&kvp_sendkey_work
);
690 schedule_delayed_work(&kvp_timeout_work
,
691 HV_UTIL_TIMEOUT
* HZ
);
697 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
698 | ICMSGHDRFLAG_RESPONSE
;
700 vmbus_sendpacket(channel
, recv_buffer
,
702 VM_PKT_DATA_INBAND
, 0);
704 host_negotiatied
= NEGO_FINISHED
;
709 static void kvp_on_reset(void)
711 if (cancel_delayed_work_sync(&kvp_timeout_work
))
712 kvp_respond_to_host(NULL
, HV_E_FAIL
);
713 kvp_transaction
.state
= HVUTIL_DEVICE_INIT
;
717 hv_kvp_init(struct hv_util_service
*srv
)
719 recv_buffer
= srv
->recv_buffer
;
720 kvp_transaction
.recv_channel
= srv
->channel
;
723 * When this driver loads, the user level daemon that
724 * processes the host requests may not yet be running.
725 * Defer processing channel callbacks until the daemon
728 kvp_transaction
.state
= HVUTIL_DEVICE_INIT
;
730 hvt
= hvutil_transport_init(kvp_devname
, CN_KVP_IDX
, CN_KVP_VAL
,
731 kvp_on_msg
, kvp_on_reset
);
738 void hv_kvp_deinit(void)
740 kvp_transaction
.state
= HVUTIL_DEVICE_DYING
;
741 cancel_delayed_work_sync(&kvp_host_handshake_work
);
742 cancel_delayed_work_sync(&kvp_timeout_work
);
743 cancel_work_sync(&kvp_sendkey_work
);
744 hvutil_transport_destroy(hvt
);