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.
25 #include <sys/types.h>
26 #include <sys/socket.h>
28 #include <sys/utsname.h>
29 #include <linux/types.h>
35 #include <arpa/inet.h>
36 #include <linux/connector.h>
37 #include <linux/netlink.h>
43 * KYS: TODO. Need to register these in the kernel.
45 * The following definitions are shared with the in-kernel component; do not
46 * change any of this without making the corresponding changes in
47 * the KVP kernel component.
49 #define CN_KVP_IDX 0x9 /* MSFT KVP functionality */
50 #define CN_KVP_VAL 0x1 /* This supports queries from the kernel */
51 #define CN_KVP_USER_VAL 0x2 /* This supports queries from the user */
54 * KVP protocol: The user mode component first registers with the
55 * the kernel component. Subsequently, the kernel component requests, data
56 * for the specified keys. In response to this message the user mode component
57 * fills in the value corresponding to the specified key. We overload the
58 * sequence field in the cn_msg header to define our KVP message types.
60 * We use this infrastructure for also supporting queries from user mode
61 * application for state that may be maintained in the KVP kernel component.
63 * XXXKYS: Have a shared header file between the user and kernel (TODO)
67 KVP_REGISTER
= 0, /* Register the user mode component*/
68 KVP_KERNEL_GET
, /*Kernel is requesting the value for the specified key*/
69 KVP_KERNEL_SET
, /*Kernel is providing the value for the specified key*/
70 KVP_USER_GET
, /*User is requesting the value for the specified key*/
71 KVP_USER_SET
/*User is providing the value for the specified key*/
74 #define HV_KVP_EXCHANGE_MAX_KEY_SIZE 512
75 #define HV_KVP_EXCHANGE_MAX_VALUE_SIZE 2048
79 __u8 kvp_key
[HV_KVP_EXCHANGE_MAX_KEY_SIZE
]; /* Key name */
80 __u8 kvp_value
[HV_KVP_EXCHANGE_MAX_VALUE_SIZE
]; /* Key value */
84 FullyQualifiedDomainName
= 0,
85 IntegrationServicesVersion
, /*This key is serviced in the kernel*/
97 * End of shared definitions.
100 static char kvp_send_buffer
[4096];
101 static char kvp_recv_buffer
[4096];
102 static struct sockaddr_nl addr
;
104 static char *os_name
= "";
105 static char *os_major
= "";
106 static char *os_minor
= "";
107 static char *processor_arch
;
108 static char *os_build
;
109 static char *lic_version
;
110 static struct utsname uts_buf
;
112 void kvp_get_os_info(void)
118 os_build
= uts_buf
.release
;
119 processor_arch
= uts_buf
.machine
;
121 file
= fopen("/etc/SuSE-release", "r");
123 goto kvp_osinfo_found
;
124 file
= fopen("/etc/redhat-release", "r");
126 goto kvp_osinfo_found
;
128 * Add code for other supported platforms.
132 * We don't have information about the os.
134 os_name
= uts_buf
.sysname
;
138 /* up to three lines */
139 p
= fgets(buf
, sizeof(buf
), file
);
141 p
= strchr(buf
, '\n');
150 p
= fgets(buf
, sizeof(buf
), file
);
152 p
= strchr(buf
, '\n');
161 p
= fgets(buf
, sizeof(buf
), file
);
163 p
= strchr(buf
, '\n');
179 kvp_get_ip_address(int family
, char *buffer
, int length
)
181 struct ifaddrs
*ifap
;
182 struct ifaddrs
*curp
;
183 int ipv4_len
= strlen("255.255.255.255") + 1;
184 int ipv6_len
= strlen("ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff")+1;
191 * On entry into this function, the buffer is capable of holding the
192 * maximum key value (2048 bytes).
195 if (getifaddrs(&ifap
)) {
196 strcpy(buffer
, "getifaddrs failed\n");
201 while (curp
!= NULL
) {
202 if ((curp
->ifa_addr
!= NULL
) &&
203 (curp
->ifa_addr
->sa_family
== family
)) {
204 if (family
== AF_INET
) {
205 struct sockaddr_in
*addr
=
206 (struct sockaddr_in
*) curp
->ifa_addr
;
208 str
= inet_ntop(family
, &addr
->sin_addr
,
211 strcpy(buffer
, "inet_ntop failed\n");
221 offset
+= strlen(str
) + 1;
222 if ((length
- offset
) < (ipv4_len
+ 1))
228 * We only support AF_INET and AF_INET6
229 * and the list of addresses is separated by a ";".
231 struct sockaddr_in6
*addr
=
232 (struct sockaddr_in6
*) curp
->ifa_addr
;
234 str
= inet_ntop(family
,
235 &addr
->sin6_addr
.s6_addr
,
238 strcpy(buffer
, "inet_ntop failed\n");
247 offset
+= strlen(str
) + 1;
248 if ((length
- offset
) < (ipv6_len
+ 1))
254 curp
= curp
->ifa_next
;
264 kvp_get_domain_name(char *buffer
, int length
)
266 struct addrinfo hints
, *info
;
267 gethostname(buffer
, length
);
270 memset(&hints
, 0, sizeof(hints
));
271 hints
.ai_family
= AF_INET
; /*Get only ipv4 addrinfo. */
272 hints
.ai_socktype
= SOCK_STREAM
;
273 hints
.ai_flags
= AI_CANONNAME
;
275 error
= getaddrinfo(buffer
, "http", &hints
, &info
);
277 strcpy(buffer
, "getaddrinfo failed\n");
279 goto get_domain_done
;
281 strcpy(buffer
, info
->ai_canonname
);
288 netlink_send(int fd
, struct cn_msg
*msg
)
290 struct nlmsghdr
*nlh
;
292 struct msghdr message
;
296 size
= NLMSG_SPACE(sizeof(struct cn_msg
) + msg
->len
);
298 nlh
= (struct nlmsghdr
*)buffer
;
300 nlh
->nlmsg_pid
= getpid();
301 nlh
->nlmsg_type
= NLMSG_DONE
;
302 nlh
->nlmsg_len
= NLMSG_LENGTH(size
- sizeof(*nlh
));
303 nlh
->nlmsg_flags
= 0;
305 iov
[0].iov_base
= nlh
;
306 iov
[0].iov_len
= sizeof(*nlh
);
308 iov
[1].iov_base
= msg
;
309 iov
[1].iov_len
= size
;
311 memset(&message
, 0, sizeof(message
));
312 message
.msg_name
= &addr
;
313 message
.msg_namelen
= sizeof(addr
);
314 message
.msg_iov
= iov
;
315 message
.msg_iovlen
= 2;
317 return sendmsg(fd
, &message
, 0);
322 int fd
, len
, sock_opt
;
324 struct cn_msg
*message
;
326 struct nlmsghdr
*incoming_msg
;
327 struct cn_msg
*incoming_cn_msg
;
328 struct hv_ku_msg
*hv_msg
;
334 openlog("KVP", 0, LOG_USER
);
335 syslog(LOG_INFO
, "KVP starting; pid is:%d", getpid());
337 * Retrieve OS release information.
341 fd
= socket(AF_NETLINK
, SOCK_DGRAM
, NETLINK_CONNECTOR
);
343 syslog(LOG_ERR
, "netlink socket creation failed; error:%d", fd
);
346 addr
.nl_family
= AF_NETLINK
;
349 addr
.nl_groups
= CN_KVP_IDX
;
352 error
= bind(fd
, (struct sockaddr
*)&addr
, sizeof(addr
));
354 syslog(LOG_ERR
, "bind failed; error:%d", error
);
358 sock_opt
= addr
.nl_groups
;
359 setsockopt(fd
, 270, 1, &sock_opt
, sizeof(sock_opt
));
361 * Register ourselves with the kernel.
363 message
= (struct cn_msg
*)kvp_send_buffer
;
364 message
->id
.idx
= CN_KVP_IDX
;
365 message
->id
.val
= CN_KVP_VAL
;
366 message
->seq
= KVP_REGISTER
;
370 len
= netlink_send(fd
, message
);
372 syslog(LOG_ERR
, "netlink_send failed; error:%d", len
);
384 len
= recv(fd
, kvp_recv_buffer
, sizeof(kvp_recv_buffer
), 0);
387 syslog(LOG_ERR
, "recv failed; error:%d", len
);
392 incoming_msg
= (struct nlmsghdr
*)kvp_recv_buffer
;
393 incoming_cn_msg
= (struct cn_msg
*)NLMSG_DATA(incoming_msg
);
395 switch (incoming_cn_msg
->seq
) {
398 * Driver is registering with us; stash away the version
401 p
= (char *)incoming_cn_msg
->data
;
402 lic_version
= malloc(strlen(p
) + 1);
404 strcpy(lic_version
, p
);
405 syslog(LOG_INFO
, "KVP LIC Version: %s",
408 syslog(LOG_ERR
, "malloc failed");
418 hv_msg
= (struct hv_ku_msg
*)incoming_cn_msg
->data
;
419 key_name
= (char *)hv_msg
->kvp_key
;
420 key_value
= (char *)hv_msg
->kvp_value
;
422 switch (hv_msg
->kvp_index
) {
423 case FullyQualifiedDomainName
:
424 kvp_get_domain_name(key_value
,
425 HV_KVP_EXCHANGE_MAX_VALUE_SIZE
);
426 strcpy(key_name
, "FullyQualifiedDomainName");
428 case IntegrationServicesVersion
:
429 strcpy(key_name
, "IntegrationServicesVersion");
430 strcpy(key_value
, lic_version
);
432 case NetworkAddressIPv4
:
433 kvp_get_ip_address(AF_INET
, key_value
,
434 HV_KVP_EXCHANGE_MAX_VALUE_SIZE
);
435 strcpy(key_name
, "NetworkAddressIPv4");
437 case NetworkAddressIPv6
:
438 kvp_get_ip_address(AF_INET6
, key_value
,
439 HV_KVP_EXCHANGE_MAX_VALUE_SIZE
);
440 strcpy(key_name
, "NetworkAddressIPv6");
443 strcpy(key_value
, os_build
);
444 strcpy(key_name
, "OSBuildNumber");
447 strcpy(key_value
, os_name
);
448 strcpy(key_name
, "OSName");
451 strcpy(key_value
, os_major
);
452 strcpy(key_name
, "OSMajorVersion");
455 strcpy(key_value
, os_minor
);
456 strcpy(key_name
, "OSMinorVersion");
459 strcpy(key_value
, os_build
);
460 strcpy(key_name
, "OSVersion");
462 case ProcessorArchitecture
:
463 strcpy(key_value
, processor_arch
);
464 strcpy(key_name
, "ProcessorArchitecture");
467 strcpy(key_value
, "Unknown Key");
469 * We use a null key name to terminate enumeration.
471 strcpy(key_name
, "");
475 * Send the value back to the kernel. The response is
476 * already in the receive buffer. Update the cn_msg header to
477 * reflect the key value that has been added to the message
480 incoming_cn_msg
->id
.idx
= CN_KVP_IDX
;
481 incoming_cn_msg
->id
.val
= CN_KVP_VAL
;
482 incoming_cn_msg
->seq
= KVP_USER_SET
;
483 incoming_cn_msg
->ack
= 0;
484 incoming_cn_msg
->len
= sizeof(struct hv_ku_msg
);
486 len
= netlink_send(fd
, incoming_cn_msg
);
488 syslog(LOG_ERR
, "net_link send failed; error:%d", len
);