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/hyperv.h>
38 #include <linux/netlink.h>
46 * KVP protocol: The user mode component first registers with the
47 * the kernel component. Subsequently, the kernel component requests, data
48 * for the specified keys. In response to this message the user mode component
49 * fills in the value corresponding to the specified key. We overload the
50 * sequence field in the cn_msg header to define our KVP message types.
52 * We use this infrastructure for also supporting queries from user mode
53 * application for state that may be maintained in the KVP kernel component.
59 FullyQualifiedDomainName = 0,
60 IntegrationServicesVersion, /*This key is serviced in the kernel*/
71 static char kvp_send_buffer[4096];
72 static char kvp_recv_buffer[4096 * 2];
73 static struct sockaddr_nl addr;
74 static int in_hand_shake = 1;
76 static char *os_name = "";
77 static char *os_major = "";
78 static char *os_minor = "";
79 static char *processor_arch;
80 static char *os_build;
81 static char *lic_version = "Unknown version";
82 static struct utsname uts_buf;
85 #define MAX_FILE_NAME 100
86 #define ENTRIES_PER_BLOCK 50
89 __u8 key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
90 __u8 value[HV_KVP_EXCHANGE_MAX_VALUE_SIZE];
93 struct kvp_file_state {
96 struct kvp_record *records;
98 __u8 fname[MAX_FILE_NAME];
101 static struct kvp_file_state kvp_file_info[KVP_POOL_COUNT];
103 static void kvp_acquire_lock(int pool)
105 struct flock fl = {F_WRLCK, SEEK_SET, 0, 0, 0};
108 if (fcntl(kvp_file_info[pool].fd, F_SETLKW, &fl) == -1) {
109 syslog(LOG_ERR, "Failed to acquire the lock pool: %d", pool);
114 static void kvp_release_lock(int pool)
116 struct flock fl = {F_UNLCK, SEEK_SET, 0, 0, 0};
119 if (fcntl(kvp_file_info[pool].fd, F_SETLK, &fl) == -1) {
121 syslog(LOG_ERR, "Failed to release the lock pool: %d", pool);
126 static void kvp_update_file(int pool)
129 size_t bytes_written;
132 * We are going to write our in-memory registry out to
133 * disk; acquire the lock first.
135 kvp_acquire_lock(pool);
137 filep = fopen(kvp_file_info[pool].fname, "w");
139 kvp_release_lock(pool);
140 syslog(LOG_ERR, "Failed to open file, pool: %d", pool);
144 bytes_written = fwrite(kvp_file_info[pool].records,
145 sizeof(struct kvp_record),
146 kvp_file_info[pool].num_records, filep);
149 kvp_release_lock(pool);
152 static void kvp_update_mem_state(int pool)
155 size_t records_read = 0;
156 struct kvp_record *record = kvp_file_info[pool].records;
157 struct kvp_record *readp;
158 int num_blocks = kvp_file_info[pool].num_blocks;
159 int alloc_unit = sizeof(struct kvp_record) * ENTRIES_PER_BLOCK;
161 kvp_acquire_lock(pool);
163 filep = fopen(kvp_file_info[pool].fname, "r");
165 kvp_release_lock(pool);
166 syslog(LOG_ERR, "Failed to open file, pool: %d", pool);
169 while (!feof(filep)) {
170 readp = &record[records_read];
171 records_read += fread(readp, sizeof(struct kvp_record),
172 ENTRIES_PER_BLOCK * num_blocks,
177 * We have more data to read.
180 record = realloc(record, alloc_unit * num_blocks);
182 if (record == NULL) {
183 syslog(LOG_ERR, "malloc failed");
191 kvp_file_info[pool].num_blocks = num_blocks;
192 kvp_file_info[pool].records = record;
193 kvp_file_info[pool].num_records = records_read;
195 kvp_release_lock(pool);
197 static int kvp_file_init(void)
203 struct kvp_record *record;
204 struct kvp_record *readp;
207 int alloc_unit = sizeof(struct kvp_record) * ENTRIES_PER_BLOCK;
209 if (access("/var/opt/hyperv", F_OK)) {
210 if (mkdir("/var/opt/hyperv", S_IRUSR | S_IWUSR | S_IROTH)) {
211 syslog(LOG_ERR, " Failed to create /var/opt/hyperv");
216 for (i = 0; i < KVP_POOL_COUNT; i++) {
217 fname = kvp_file_info[i].fname;
220 sprintf(fname, "/var/opt/hyperv/.kvp_pool_%d", i);
221 fd = open(fname, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IROTH);
227 filep = fopen(fname, "r");
231 record = malloc(alloc_unit * num_blocks);
232 if (record == NULL) {
236 while (!feof(filep)) {
237 readp = &record[records_read];
238 records_read += fread(readp, sizeof(struct kvp_record),
244 * We have more data to read.
247 record = realloc(record, alloc_unit *
249 if (record == NULL) {
257 kvp_file_info[i].fd = fd;
258 kvp_file_info[i].num_blocks = num_blocks;
259 kvp_file_info[i].records = record;
260 kvp_file_info[i].num_records = records_read;
268 static int kvp_key_delete(int pool, __u8 *key, int key_size)
273 struct kvp_record *record;
276 * First update the in-memory state.
278 kvp_update_mem_state(pool);
280 num_records = kvp_file_info[pool].num_records;
281 record = kvp_file_info[pool].records;
283 for (i = 0; i < num_records; i++) {
284 if (memcmp(key, record[i].key, key_size))
287 * Found a match; just move the remaining
290 if (i == num_records) {
291 kvp_file_info[pool].num_records--;
292 kvp_update_file(pool);
298 for (; k < num_records; k++) {
299 strcpy(record[j].key, record[k].key);
300 strcpy(record[j].value, record[k].value);
304 kvp_file_info[pool].num_records--;
305 kvp_update_file(pool);
311 static int kvp_key_add_or_modify(int pool, __u8 *key, int key_size, __u8 *value,
317 struct kvp_record *record;
320 if ((key_size > HV_KVP_EXCHANGE_MAX_KEY_SIZE) ||
321 (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
325 * First update the in-memory state.
327 kvp_update_mem_state(pool);
329 num_records = kvp_file_info[pool].num_records;
330 record = kvp_file_info[pool].records;
331 num_blocks = kvp_file_info[pool].num_blocks;
333 for (i = 0; i < num_records; i++) {
334 if (memcmp(key, record[i].key, key_size))
337 * Found a match; just update the value -
338 * this is the modify case.
340 memcpy(record[i].value, value, value_size);
341 kvp_update_file(pool);
346 * Need to add a new entry;
348 if (num_records == (ENTRIES_PER_BLOCK * num_blocks)) {
349 /* Need to allocate a larger array for reg entries. */
350 record = realloc(record, sizeof(struct kvp_record) *
351 ENTRIES_PER_BLOCK * (num_blocks + 1));
355 kvp_file_info[pool].num_blocks++;
358 memcpy(record[i].value, value, value_size);
359 memcpy(record[i].key, key, key_size);
360 kvp_file_info[pool].records = record;
361 kvp_file_info[pool].num_records++;
362 kvp_update_file(pool);
366 static int kvp_get_value(int pool, __u8 *key, int key_size, __u8 *value,
371 struct kvp_record *record;
373 if ((key_size > HV_KVP_EXCHANGE_MAX_KEY_SIZE) ||
374 (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
378 * First update the in-memory state.
380 kvp_update_mem_state(pool);
382 num_records = kvp_file_info[pool].num_records;
383 record = kvp_file_info[pool].records;
385 for (i = 0; i < num_records; i++) {
386 if (memcmp(key, record[i].key, key_size))
389 * Found a match; just copy the value out.
391 memcpy(value, record[i].value, value_size);
398 static int kvp_pool_enumerate(int pool, int index, __u8 *key, int key_size,
399 __u8 *value, int value_size)
401 struct kvp_record *record;
404 * First update our in-memory database.
406 kvp_update_mem_state(pool);
407 record = kvp_file_info[pool].records;
409 if (index >= kvp_file_info[pool].num_records) {
413 memcpy(key, record[index].key, key_size);
414 memcpy(value, record[index].value, value_size);
419 void kvp_get_os_info(void)
425 os_build = uts_buf.release;
426 processor_arch = uts_buf.machine;
429 * The current windows host (win7) expects the build
430 * string to be of the form: x.y.z
431 * Strip additional information we may have.
433 p = strchr(os_build, '-');
437 file = fopen("/etc/SuSE-release", "r");
439 goto kvp_osinfo_found;
440 file = fopen("/etc/redhat-release", "r");
442 goto kvp_osinfo_found;
444 * Add code for other supported platforms.
448 * We don't have information about the os.
450 os_name = uts_buf.sysname;
454 /* up to three lines */
455 p = fgets(buf, sizeof(buf), file);
457 p = strchr(buf, '\n');
466 p = fgets(buf, sizeof(buf), file);
468 p = strchr(buf, '\n');
477 p = fgets(buf, sizeof(buf), file);
479 p = strchr(buf, '\n');
494 static unsigned int hweight32(unsigned int *w)
496 unsigned int res = *w - ((*w >> 1) & 0x55555555);
497 res = (res & 0x33333333) + ((res >> 2) & 0x33333333);
498 res = (res + (res >> 4)) & 0x0F0F0F0F;
499 res = res + (res >> 8);
500 return (res + (res >> 16)) & 0x000000FF;
503 static int kvp_process_ip_address(void *addrp,
504 int family, char *buffer,
505 int length, int *offset)
507 struct sockaddr_in *addr;
508 struct sockaddr_in6 *addr6;
513 if (family == AF_INET) {
514 addr = (struct sockaddr_in *)addrp;
515 str = inet_ntop(family, &addr->sin_addr, tmp, 50);
516 addr_length = INET_ADDRSTRLEN;
518 addr6 = (struct sockaddr_in6 *)addrp;
519 str = inet_ntop(family, &addr6->sin6_addr.s6_addr, tmp, 50);
520 addr_length = INET6_ADDRSTRLEN;
523 if ((length - *offset) < addr_length + 1)
526 strcpy(buffer, "inet_ntop failed\n");
535 *offset += strlen(str) + 1;
540 kvp_get_ip_address(int family, char *if_name, int op,
541 void *out_buffer, int length)
543 struct ifaddrs *ifap;
544 struct ifaddrs *curp;
549 struct hv_kvp_ipaddr_value *ip_buffer;
550 char cidr_mask[5]; /* /xyz */
555 struct sockaddr_in6 *addr6;
557 if (op == KVP_OP_ENUMERATE) {
560 ip_buffer = out_buffer;
561 buffer = (char *)ip_buffer->ip_addr;
562 ip_buffer->addr_family = 0;
565 * On entry into this function, the buffer is capable of holding the
569 if (getifaddrs(&ifap)) {
570 strcpy(buffer, "getifaddrs failed\n");
575 while (curp != NULL) {
576 if (curp->ifa_addr == NULL) {
577 curp = curp->ifa_next;
581 if ((if_name != NULL) &&
582 (strncmp(curp->ifa_name, if_name, strlen(if_name)))) {
584 * We want info about a specific interface;
587 curp = curp->ifa_next;
592 * We only support two address families: AF_INET and AF_INET6.
593 * If a family value of 0 is specified, we collect both
594 * supported address families; if not we gather info on
595 * the specified address family.
597 if ((family != 0) && (curp->ifa_addr->sa_family != family)) {
598 curp = curp->ifa_next;
601 if ((curp->ifa_addr->sa_family != AF_INET) &&
602 (curp->ifa_addr->sa_family != AF_INET6)) {
603 curp = curp->ifa_next;
607 if (op == KVP_OP_GET_IP_INFO) {
609 * Gather info other than the IP address.
610 * IP address info will be gathered later.
612 if (curp->ifa_addr->sa_family == AF_INET) {
613 ip_buffer->addr_family |= ADDR_FAMILY_IPV4;
617 error = kvp_process_ip_address(
627 ip_buffer->addr_family |= ADDR_FAMILY_IPV6;
630 * Get subnet info in CIDR format.
633 sn_str = (char *)ip_buffer->sub_net;
634 addr6 = (struct sockaddr_in6 *)
636 w = addr6->sin6_addr.s6_addr32;
638 for (i = 0; i < 4; i++)
639 weight += hweight32(&w[i]);
641 sprintf(cidr_mask, "/%d", weight);
642 if ((length - sn_offset) <
643 (strlen(cidr_mask) + 1))
647 strcpy(sn_str, cidr_mask);
649 strcat(sn_str, cidr_mask);
650 strcat((char *)ip_buffer->sub_net, ";");
651 sn_offset += strlen(sn_str) + 1;
656 error = kvp_process_ip_address(curp->ifa_addr,
657 curp->ifa_addr->sa_family,
663 curp = curp->ifa_next;
673 kvp_get_domain_name(char *buffer, int length)
675 struct addrinfo hints, *info ;
678 gethostname(buffer, length);
679 memset(&hints, 0, sizeof(hints));
680 hints.ai_family = AF_INET; /*Get only ipv4 addrinfo. */
681 hints.ai_socktype = SOCK_STREAM;
682 hints.ai_flags = AI_CANONNAME;
684 error = getaddrinfo(buffer, NULL, &hints, &info);
686 strcpy(buffer, "getaddrinfo failed\n");
689 strcpy(buffer, info->ai_canonname);
695 netlink_send(int fd, struct cn_msg *msg)
697 struct nlmsghdr *nlh;
699 struct msghdr message;
703 size = NLMSG_SPACE(sizeof(struct cn_msg) + msg->len);
705 nlh = (struct nlmsghdr *)buffer;
707 nlh->nlmsg_pid = getpid();
708 nlh->nlmsg_type = NLMSG_DONE;
709 nlh->nlmsg_len = NLMSG_LENGTH(size - sizeof(*nlh));
710 nlh->nlmsg_flags = 0;
712 iov[0].iov_base = nlh;
713 iov[0].iov_len = sizeof(*nlh);
715 iov[1].iov_base = msg;
716 iov[1].iov_len = size;
718 memset(&message, 0, sizeof(message));
719 message.msg_name = &addr;
720 message.msg_namelen = sizeof(addr);
721 message.msg_iov = iov;
722 message.msg_iovlen = 2;
724 return sendmsg(fd, &message, 0);
729 int fd, len, sock_opt;
731 struct cn_msg *message;
733 struct nlmsghdr *incoming_msg;
734 struct cn_msg *incoming_cn_msg;
735 struct hv_kvp_msg *hv_msg;
743 openlog("KVP", 0, LOG_USER);
744 syslog(LOG_INFO, "KVP starting; pid is:%d", getpid());
746 * Retrieve OS release information.
750 if (kvp_file_init()) {
751 syslog(LOG_ERR, "Failed to initialize the pools");
755 fd = socket(AF_NETLINK, SOCK_DGRAM, NETLINK_CONNECTOR);
757 syslog(LOG_ERR, "netlink socket creation failed; error:%d", fd);
760 addr.nl_family = AF_NETLINK;
763 addr.nl_groups = CN_KVP_IDX;
766 error = bind(fd, (struct sockaddr *)&addr, sizeof(addr));
768 syslog(LOG_ERR, "bind failed; error:%d", error);
772 sock_opt = addr.nl_groups;
773 setsockopt(fd, 270, 1, &sock_opt, sizeof(sock_opt));
775 * Register ourselves with the kernel.
777 message = (struct cn_msg *)kvp_send_buffer;
778 message->id.idx = CN_KVP_IDX;
779 message->id.val = CN_KVP_VAL;
781 hv_msg = (struct hv_kvp_msg *)message->data;
782 hv_msg->kvp_hdr.operation = KVP_OP_REGISTER1;
784 message->len = sizeof(struct hv_kvp_msg);
786 len = netlink_send(fd, message);
788 syslog(LOG_ERR, "netlink_send failed; error:%d", len);
796 struct sockaddr *addr_p = (struct sockaddr *) &addr;
797 socklen_t addr_l = sizeof(addr);
802 len = recvfrom(fd, kvp_recv_buffer, sizeof(kvp_recv_buffer), 0,
805 if (len < 0 || addr.nl_pid) {
806 syslog(LOG_ERR, "recvfrom failed; pid:%u error:%d %s",
807 addr.nl_pid, errno, strerror(errno));
812 incoming_msg = (struct nlmsghdr *)kvp_recv_buffer;
813 incoming_cn_msg = (struct cn_msg *)NLMSG_DATA(incoming_msg);
814 hv_msg = (struct hv_kvp_msg *)incoming_cn_msg->data;
817 * We will use the KVP header information to pass back
818 * the error from this daemon. So, first copy the state
819 * and set the error code to success.
821 op = hv_msg->kvp_hdr.operation;
822 pool = hv_msg->kvp_hdr.pool;
823 hv_msg->error = HV_S_OK;
825 if ((in_hand_shake) && (op == KVP_OP_REGISTER1)) {
827 * Driver is registering with us; stash away the version
831 p = (char *)hv_msg->body.kvp_register.version;
832 lic_version = malloc(strlen(p) + 1);
834 strcpy(lic_version, p);
835 syslog(LOG_INFO, "KVP LIC Version: %s",
838 syslog(LOG_ERR, "malloc failed");
845 if (kvp_key_add_or_modify(pool,
846 hv_msg->body.kvp_set.data.key,
847 hv_msg->body.kvp_set.data.key_size,
848 hv_msg->body.kvp_set.data.value,
849 hv_msg->body.kvp_set.data.value_size))
850 hv_msg->error = HV_S_CONT;
854 if (kvp_get_value(pool,
855 hv_msg->body.kvp_set.data.key,
856 hv_msg->body.kvp_set.data.key_size,
857 hv_msg->body.kvp_set.data.value,
858 hv_msg->body.kvp_set.data.value_size))
859 hv_msg->error = HV_S_CONT;
863 if (kvp_key_delete(pool,
864 hv_msg->body.kvp_delete.key,
865 hv_msg->body.kvp_delete.key_size))
866 hv_msg->error = HV_S_CONT;
873 if (op != KVP_OP_ENUMERATE)
877 * If the pool is KVP_POOL_AUTO, dynamically generate
878 * both the key and the value; if not read from the
881 if (pool != KVP_POOL_AUTO) {
882 if (kvp_pool_enumerate(pool,
883 hv_msg->body.kvp_enum_data.index,
884 hv_msg->body.kvp_enum_data.data.key,
885 HV_KVP_EXCHANGE_MAX_KEY_SIZE,
886 hv_msg->body.kvp_enum_data.data.value,
887 HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
888 hv_msg->error = HV_S_CONT;
892 hv_msg = (struct hv_kvp_msg *)incoming_cn_msg->data;
893 key_name = (char *)hv_msg->body.kvp_enum_data.data.key;
894 key_value = (char *)hv_msg->body.kvp_enum_data.data.value;
896 switch (hv_msg->body.kvp_enum_data.index) {
897 case FullyQualifiedDomainName:
898 kvp_get_domain_name(key_value,
899 HV_KVP_EXCHANGE_MAX_VALUE_SIZE);
900 strcpy(key_name, "FullyQualifiedDomainName");
902 case IntegrationServicesVersion:
903 strcpy(key_name, "IntegrationServicesVersion");
904 strcpy(key_value, lic_version);
906 case NetworkAddressIPv4:
907 kvp_get_ip_address(AF_INET, NULL, KVP_OP_ENUMERATE,
908 key_value, HV_KVP_EXCHANGE_MAX_VALUE_SIZE);
909 strcpy(key_name, "NetworkAddressIPv4");
911 case NetworkAddressIPv6:
912 kvp_get_ip_address(AF_INET6, NULL, KVP_OP_ENUMERATE,
913 key_value, HV_KVP_EXCHANGE_MAX_VALUE_SIZE);
914 strcpy(key_name, "NetworkAddressIPv6");
917 strcpy(key_value, os_build);
918 strcpy(key_name, "OSBuildNumber");
921 strcpy(key_value, os_name);
922 strcpy(key_name, "OSName");
925 strcpy(key_value, os_major);
926 strcpy(key_name, "OSMajorVersion");
929 strcpy(key_value, os_minor);
930 strcpy(key_name, "OSMinorVersion");
933 strcpy(key_value, os_build);
934 strcpy(key_name, "OSVersion");
936 case ProcessorArchitecture:
937 strcpy(key_value, processor_arch);
938 strcpy(key_name, "ProcessorArchitecture");
941 hv_msg->error = HV_S_CONT;
945 * Send the value back to the kernel. The response is
946 * already in the receive buffer. Update the cn_msg header to
947 * reflect the key value that has been added to the message
951 incoming_cn_msg->id.idx = CN_KVP_IDX;
952 incoming_cn_msg->id.val = CN_KVP_VAL;
953 incoming_cn_msg->ack = 0;
954 incoming_cn_msg->len = sizeof(struct hv_kvp_msg);
956 len = netlink_send(fd, incoming_cn_msg);
958 syslog(LOG_ERR, "net_link send failed; error:%d", len);