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.
26 #include <sys/utsname.h>
33 #include <arpa/inet.h>
34 #include <linux/hyperv.h>
45 * KVP protocol: The user mode component first registers with the
46 * the kernel component. Subsequently, the kernel component requests, data
47 * for the specified keys. In response to this message the user mode component
48 * fills in the value corresponding to the specified key. We overload the
49 * sequence field in the cn_msg header to define our KVP message types.
51 * We use this infrastructure for also supporting queries from user mode
52 * application for state that may be maintained in the KVP kernel component.
58 FullyQualifiedDomainName = 0,
59 IntegrationServicesVersion, /*This key is serviced in the kernel*/
78 static int in_hand_shake = 1;
80 static char *os_name = "";
81 static char *os_major = "";
82 static char *os_minor = "";
83 static char *processor_arch;
84 static char *os_build;
85 static char *os_version;
86 static char *lic_version = "Unknown version";
87 static char full_domain_name[HV_KVP_EXCHANGE_MAX_VALUE_SIZE];
88 static struct utsname uts_buf;
91 * The location of the interface configuration file.
94 #define KVP_CONFIG_LOC "/var/lib/hyperv"
96 #ifndef KVP_SCRIPTS_PATH
97 #define KVP_SCRIPTS_PATH "/usr/libexec/hypervkvpd/"
100 #define MAX_FILE_NAME 100
101 #define ENTRIES_PER_BLOCK 50
104 char key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
105 char value[HV_KVP_EXCHANGE_MAX_VALUE_SIZE];
108 struct kvp_file_state {
111 struct kvp_record *records;
113 char fname[MAX_FILE_NAME];
116 static struct kvp_file_state kvp_file_info[KVP_POOL_COUNT];
118 static void kvp_acquire_lock(int pool)
120 struct flock fl = {F_WRLCK, SEEK_SET, 0, 0, 0};
123 if (fcntl(kvp_file_info[pool].fd, F_SETLKW, &fl) == -1) {
124 syslog(LOG_ERR, "Failed to acquire the lock pool: %d; error: %d %s", pool,
125 errno, strerror(errno));
130 static void kvp_release_lock(int pool)
132 struct flock fl = {F_UNLCK, SEEK_SET, 0, 0, 0};
135 if (fcntl(kvp_file_info[pool].fd, F_SETLK, &fl) == -1) {
136 syslog(LOG_ERR, "Failed to release the lock pool: %d; error: %d %s", pool,
137 errno, strerror(errno));
142 static void kvp_update_file(int pool)
147 * We are going to write our in-memory registry out to
148 * disk; acquire the lock first.
150 kvp_acquire_lock(pool);
152 filep = fopen(kvp_file_info[pool].fname, "we");
154 syslog(LOG_ERR, "Failed to open file, pool: %d; error: %d %s", pool,
155 errno, strerror(errno));
156 kvp_release_lock(pool);
160 fwrite(kvp_file_info[pool].records, sizeof(struct kvp_record),
161 kvp_file_info[pool].num_records, filep);
163 if (ferror(filep) || fclose(filep)) {
164 kvp_release_lock(pool);
165 syslog(LOG_ERR, "Failed to write file, pool: %d", pool);
169 kvp_release_lock(pool);
172 static void kvp_update_mem_state(int pool)
175 size_t records_read = 0;
176 struct kvp_record *record = kvp_file_info[pool].records;
177 struct kvp_record *readp;
178 int num_blocks = kvp_file_info[pool].num_blocks;
179 int alloc_unit = sizeof(struct kvp_record) * ENTRIES_PER_BLOCK;
181 kvp_acquire_lock(pool);
183 filep = fopen(kvp_file_info[pool].fname, "re");
185 syslog(LOG_ERR, "Failed to open file, pool: %d; error: %d %s", pool,
186 errno, strerror(errno));
187 kvp_release_lock(pool);
191 readp = &record[records_read];
192 records_read += fread(readp, sizeof(struct kvp_record),
193 ENTRIES_PER_BLOCK * num_blocks,
197 syslog(LOG_ERR, "Failed to read file, pool: %d", pool);
203 * We have more data to read.
206 record = realloc(record, alloc_unit * num_blocks);
208 if (record == NULL) {
209 syslog(LOG_ERR, "malloc failed");
217 kvp_file_info[pool].num_blocks = num_blocks;
218 kvp_file_info[pool].records = record;
219 kvp_file_info[pool].num_records = records_read;
222 kvp_release_lock(pool);
224 static int kvp_file_init(void)
230 struct kvp_record *record;
231 struct kvp_record *readp;
234 int alloc_unit = sizeof(struct kvp_record) * ENTRIES_PER_BLOCK;
236 if (access(KVP_CONFIG_LOC, F_OK)) {
237 if (mkdir(KVP_CONFIG_LOC, 0755 /* rwxr-xr-x */)) {
238 syslog(LOG_ERR, "Failed to create '%s'; error: %d %s", KVP_CONFIG_LOC,
239 errno, strerror(errno));
244 for (i = 0; i < KVP_POOL_COUNT; i++) {
245 fname = kvp_file_info[i].fname;
248 sprintf(fname, "%s/.kvp_pool_%d", KVP_CONFIG_LOC, i);
249 fd = open(fname, O_RDWR | O_CREAT | O_CLOEXEC, 0644 /* rw-r--r-- */);
255 filep = fopen(fname, "re");
261 record = malloc(alloc_unit * num_blocks);
262 if (record == NULL) {
268 readp = &record[records_read];
269 records_read += fread(readp, sizeof(struct kvp_record),
274 syslog(LOG_ERR, "Failed to read file, pool: %d",
281 * We have more data to read.
284 record = realloc(record, alloc_unit *
286 if (record == NULL) {
295 kvp_file_info[i].fd = fd;
296 kvp_file_info[i].num_blocks = num_blocks;
297 kvp_file_info[i].records = record;
298 kvp_file_info[i].num_records = records_read;
306 static int kvp_key_delete(int pool, const __u8 *key, int key_size)
311 struct kvp_record *record;
314 * First update the in-memory state.
316 kvp_update_mem_state(pool);
318 num_records = kvp_file_info[pool].num_records;
319 record = kvp_file_info[pool].records;
321 for (i = 0; i < num_records; i++) {
322 if (memcmp(key, record[i].key, key_size))
325 * Found a match; just move the remaining
328 if (i == num_records) {
329 kvp_file_info[pool].num_records--;
330 kvp_update_file(pool);
336 for (; k < num_records; k++) {
337 strcpy(record[j].key, record[k].key);
338 strcpy(record[j].value, record[k].value);
342 kvp_file_info[pool].num_records--;
343 kvp_update_file(pool);
349 static int kvp_key_add_or_modify(int pool, const __u8 *key, int key_size,
350 const __u8 *value, int value_size)
354 struct kvp_record *record;
357 if ((key_size > HV_KVP_EXCHANGE_MAX_KEY_SIZE) ||
358 (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
362 * First update the in-memory state.
364 kvp_update_mem_state(pool);
366 num_records = kvp_file_info[pool].num_records;
367 record = kvp_file_info[pool].records;
368 num_blocks = kvp_file_info[pool].num_blocks;
370 for (i = 0; i < num_records; i++) {
371 if (memcmp(key, record[i].key, key_size))
374 * Found a match; just update the value -
375 * this is the modify case.
377 memcpy(record[i].value, value, value_size);
378 kvp_update_file(pool);
383 * Need to add a new entry;
385 if (num_records == (ENTRIES_PER_BLOCK * num_blocks)) {
386 /* Need to allocate a larger array for reg entries. */
387 record = realloc(record, sizeof(struct kvp_record) *
388 ENTRIES_PER_BLOCK * (num_blocks + 1));
392 kvp_file_info[pool].num_blocks++;
395 memcpy(record[i].value, value, value_size);
396 memcpy(record[i].key, key, key_size);
397 kvp_file_info[pool].records = record;
398 kvp_file_info[pool].num_records++;
399 kvp_update_file(pool);
403 static int kvp_get_value(int pool, const __u8 *key, int key_size, __u8 *value,
408 struct kvp_record *record;
410 if ((key_size > HV_KVP_EXCHANGE_MAX_KEY_SIZE) ||
411 (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
415 * First update the in-memory state.
417 kvp_update_mem_state(pool);
419 num_records = kvp_file_info[pool].num_records;
420 record = kvp_file_info[pool].records;
422 for (i = 0; i < num_records; i++) {
423 if (memcmp(key, record[i].key, key_size))
426 * Found a match; just copy the value out.
428 memcpy(value, record[i].value, value_size);
435 static int kvp_pool_enumerate(int pool, int index, __u8 *key, int key_size,
436 __u8 *value, int value_size)
438 struct kvp_record *record;
441 * First update our in-memory database.
443 kvp_update_mem_state(pool);
444 record = kvp_file_info[pool].records;
446 if (index >= kvp_file_info[pool].num_records) {
450 memcpy(key, record[index].key, key_size);
451 memcpy(value, record[index].value, value_size);
456 void kvp_get_os_info(void)
462 os_version = uts_buf.release;
463 os_build = strdup(uts_buf.release);
465 os_name = uts_buf.sysname;
466 processor_arch = uts_buf.machine;
469 * The current windows host (win7) expects the build
470 * string to be of the form: x.y.z
471 * Strip additional information we may have.
473 p = strchr(os_version, '-');
478 * Parse the /etc/os-release file if present:
479 * http://www.freedesktop.org/software/systemd/man/os-release.html
481 file = fopen("/etc/os-release", "r");
483 while (fgets(buf, sizeof(buf), file)) {
486 /* Ignore comments */
490 /* Split into name=value */
491 p = strchr(buf, '=');
496 /* Remove quotes and newline; un-escape */
505 } else if (*p == '\'' || *p == '"' ||
514 if (!strcmp(buf, "NAME")) {
519 } else if (!strcmp(buf, "VERSION_ID")) {
530 /* Fallback for older RH/SUSE releases */
531 file = fopen("/etc/SuSE-release", "r");
533 goto kvp_osinfo_found;
534 file = fopen("/etc/redhat-release", "r");
536 goto kvp_osinfo_found;
539 * We don't have information about the os.
544 /* up to three lines */
545 p = fgets(buf, sizeof(buf), file);
547 p = strchr(buf, '\n');
556 p = fgets(buf, sizeof(buf), file);
558 p = strchr(buf, '\n');
567 p = fgets(buf, sizeof(buf), file);
569 p = strchr(buf, '\n');
587 * Retrieve an interface name corresponding to the specified guid.
588 * If there is a match, the function returns a pointer
589 * to the interface name and if not, a NULL is returned.
590 * If a match is found, the caller is responsible for
591 * freeing the memory.
594 static char *kvp_get_if_name(char *guid)
597 struct dirent *entry;
600 char *if_name = NULL;
602 char *kvp_net_dir = "/sys/class/net/";
605 dir = opendir(kvp_net_dir);
609 snprintf(dev_id, sizeof(dev_id), "%s", kvp_net_dir);
610 q = dev_id + strlen(kvp_net_dir);
612 while ((entry = readdir(dir)) != NULL) {
614 * Set the state for the next pass.
617 strcat(dev_id, entry->d_name);
618 strcat(dev_id, "/device/device_id");
620 file = fopen(dev_id, "r");
624 p = fgets(buf, sizeof(buf), file);
630 if (!strcmp(p, guid)) {
632 * Found the guid match; return the interface
633 * name. The caller will free the memory.
635 if_name = strdup(entry->d_name);
648 * Retrieve the MAC address given the interface name.
651 static char *kvp_if_name_to_mac(char *if_name)
658 char *mac_addr = NULL;
660 snprintf(addr_file, sizeof(addr_file), "%s%s%s", "/sys/class/net/",
661 if_name, "/address");
663 file = fopen(addr_file, "r");
667 p = fgets(buf, sizeof(buf), file);
672 for (i = 0; i < strlen(p); i++)
673 p[i] = toupper(p[i]);
674 mac_addr = strdup(p);
683 * Retrieve the interface name given tha MAC address.
686 static char *kvp_mac_to_if_name(char *mac)
689 struct dirent *entry;
692 char *if_name = NULL;
694 char *kvp_net_dir = "/sys/class/net/";
698 dir = opendir(kvp_net_dir);
702 snprintf(dev_id, sizeof(dev_id), "%s", kvp_net_dir);
703 q = dev_id + strlen(kvp_net_dir);
705 while ((entry = readdir(dir)) != NULL) {
707 * Set the state for the next pass.
711 strcat(dev_id, entry->d_name);
712 strcat(dev_id, "/address");
714 file = fopen(dev_id, "r");
718 p = fgets(buf, sizeof(buf), file);
724 for (i = 0; i < strlen(p); i++)
725 p[i] = toupper(p[i]);
727 if (!strcmp(p, mac)) {
729 * Found the MAC match; return the interface
730 * name. The caller will free the memory.
732 if_name = strdup(entry->d_name);
745 static void kvp_process_ipconfig_file(char *cmd,
746 char *config_buf, unsigned int len,
747 int element_size, int offset)
755 * First execute the command.
757 file = popen(cmd, "r");
762 memset(config_buf, 0, len);
763 while ((p = fgets(buf, sizeof(buf), file)) != NULL) {
764 if (len < strlen(config_buf) + element_size + 1)
771 strcat(config_buf, p);
772 strcat(config_buf, ";");
777 static void kvp_get_ipconfig_info(char *if_name,
778 struct hv_kvp_ipaddr_value *buffer)
786 * Get the address of default gateway (ipv4).
788 sprintf(cmd, "%s %s", "ip route show dev", if_name);
789 strcat(cmd, " | awk '/default/ {print $3 }'");
792 * Execute the command to gather gateway info.
794 kvp_process_ipconfig_file(cmd, (char *)buffer->gate_way,
795 (MAX_GATEWAY_SIZE * 2), INET_ADDRSTRLEN, 0);
798 * Get the address of default gateway (ipv6).
800 sprintf(cmd, "%s %s", "ip -f inet6 route show dev", if_name);
801 strcat(cmd, " | awk '/default/ {print $3 }'");
804 * Execute the command to gather gateway info (ipv6).
806 kvp_process_ipconfig_file(cmd, (char *)buffer->gate_way,
807 (MAX_GATEWAY_SIZE * 2), INET6_ADDRSTRLEN, 1);
811 * Gather the DNS state.
812 * Since there is no standard way to get this information
813 * across various distributions of interest; we just invoke
814 * an external script that needs to be ported across distros
817 * Following is the expected format of the information from the script:
819 * ipaddr1 (nameserver1)
820 * ipaddr2 (nameserver2)
825 sprintf(cmd, KVP_SCRIPTS_PATH "%s", "hv_get_dns_info");
828 * Execute the command to gather DNS info.
830 kvp_process_ipconfig_file(cmd, (char *)buffer->dns_addr,
831 (MAX_IP_ADDR_SIZE * 2), INET_ADDRSTRLEN, 0);
834 * Gather the DHCP state.
835 * We will gather this state by invoking an external script.
836 * The parameter to the script is the interface name.
837 * Here is the expected output:
839 * Enabled: DHCP enabled.
842 sprintf(cmd, KVP_SCRIPTS_PATH "%s %s", "hv_get_dhcp_info", if_name);
844 file = popen(cmd, "r");
848 p = fgets(dhcp_info, sizeof(dhcp_info), file);
854 if (!strncmp(p, "Enabled", 7))
855 buffer->dhcp_enabled = 1;
857 buffer->dhcp_enabled = 0;
863 static unsigned int hweight32(unsigned int *w)
865 unsigned int res = *w - ((*w >> 1) & 0x55555555);
866 res = (res & 0x33333333) + ((res >> 2) & 0x33333333);
867 res = (res + (res >> 4)) & 0x0F0F0F0F;
868 res = res + (res >> 8);
869 return (res + (res >> 16)) & 0x000000FF;
872 static int kvp_process_ip_address(void *addrp,
873 int family, char *buffer,
874 int length, int *offset)
876 struct sockaddr_in *addr;
877 struct sockaddr_in6 *addr6;
882 if (family == AF_INET) {
883 addr = (struct sockaddr_in *)addrp;
884 str = inet_ntop(family, &addr->sin_addr, tmp, 50);
885 addr_length = INET_ADDRSTRLEN;
887 addr6 = (struct sockaddr_in6 *)addrp;
888 str = inet_ntop(family, &addr6->sin6_addr.s6_addr, tmp, 50);
889 addr_length = INET6_ADDRSTRLEN;
892 if ((length - *offset) < addr_length + 2)
895 strcpy(buffer, "inet_ntop failed\n");
905 *offset += strlen(str) + 1;
911 kvp_get_ip_info(int family, char *if_name, int op,
912 void *out_buffer, unsigned int length)
914 struct ifaddrs *ifap;
915 struct ifaddrs *curp;
920 struct hv_kvp_ipaddr_value *ip_buffer;
921 char cidr_mask[5]; /* /xyz */
926 struct sockaddr_in6 *addr6;
928 if (op == KVP_OP_ENUMERATE) {
931 ip_buffer = out_buffer;
932 buffer = (char *)ip_buffer->ip_addr;
933 ip_buffer->addr_family = 0;
936 * On entry into this function, the buffer is capable of holding the
940 if (getifaddrs(&ifap)) {
941 strcpy(buffer, "getifaddrs failed\n");
946 while (curp != NULL) {
947 if (curp->ifa_addr == NULL) {
948 curp = curp->ifa_next;
952 if ((if_name != NULL) &&
953 (strncmp(curp->ifa_name, if_name, strlen(if_name)))) {
955 * We want info about a specific interface;
958 curp = curp->ifa_next;
963 * We only support two address families: AF_INET and AF_INET6.
964 * If a family value of 0 is specified, we collect both
965 * supported address families; if not we gather info on
966 * the specified address family.
968 if ((((family != 0) &&
969 (curp->ifa_addr->sa_family != family))) ||
970 (curp->ifa_flags & IFF_LOOPBACK)) {
971 curp = curp->ifa_next;
974 if ((curp->ifa_addr->sa_family != AF_INET) &&
975 (curp->ifa_addr->sa_family != AF_INET6)) {
976 curp = curp->ifa_next;
980 if (op == KVP_OP_GET_IP_INFO) {
982 * Gather info other than the IP address.
983 * IP address info will be gathered later.
985 if (curp->ifa_addr->sa_family == AF_INET) {
986 ip_buffer->addr_family |= ADDR_FAMILY_IPV4;
990 error = kvp_process_ip_address(
1000 ip_buffer->addr_family |= ADDR_FAMILY_IPV6;
1003 * Get subnet info in CIDR format.
1006 sn_str = (char *)ip_buffer->sub_net;
1007 addr6 = (struct sockaddr_in6 *)
1009 w = addr6->sin6_addr.s6_addr32;
1011 for (i = 0; i < 4; i++)
1012 weight += hweight32(&w[i]);
1014 sprintf(cidr_mask, "/%d", weight);
1015 if (length < sn_offset + strlen(cidr_mask) + 1)
1019 strcpy(sn_str, cidr_mask);
1021 strcat((char *)ip_buffer->sub_net, ";");
1022 strcat(sn_str, cidr_mask);
1024 sn_offset += strlen(sn_str) + 1;
1028 * Collect other ip related configuration info.
1031 kvp_get_ipconfig_info(if_name, ip_buffer);
1035 error = kvp_process_ip_address(curp->ifa_addr,
1036 curp->ifa_addr->sa_family,
1042 curp = curp->ifa_next;
1051 static int expand_ipv6(char *addr, int type)
1054 struct in6_addr v6_addr;
1056 ret = inet_pton(AF_INET6, addr, &v6_addr);
1059 if (type == NETMASK)
1064 sprintf(addr, "%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
1065 "%02x%02x:%02x%02x:%02x%02x",
1066 (int)v6_addr.s6_addr[0], (int)v6_addr.s6_addr[1],
1067 (int)v6_addr.s6_addr[2], (int)v6_addr.s6_addr[3],
1068 (int)v6_addr.s6_addr[4], (int)v6_addr.s6_addr[5],
1069 (int)v6_addr.s6_addr[6], (int)v6_addr.s6_addr[7],
1070 (int)v6_addr.s6_addr[8], (int)v6_addr.s6_addr[9],
1071 (int)v6_addr.s6_addr[10], (int)v6_addr.s6_addr[11],
1072 (int)v6_addr.s6_addr[12], (int)v6_addr.s6_addr[13],
1073 (int)v6_addr.s6_addr[14], (int)v6_addr.s6_addr[15]);
1079 static int is_ipv4(char *addr)
1082 struct in_addr ipv4_addr;
1084 ret = inet_pton(AF_INET, addr, &ipv4_addr);
1091 static int parse_ip_val_buffer(char *in_buf, int *offset,
1092 char *out_buf, int out_len)
1098 * in_buf has sequence of characters that are seperated by
1099 * the character ';'. The last sequence does not have the
1100 * terminating ";" character.
1102 start = in_buf + *offset;
1104 x = strchr(start, ';');
1108 x = start + strlen(start);
1110 if (strlen(start) != 0) {
1113 * Get rid of leading spaces.
1115 while (start[i] == ' ')
1118 if ((x - start) <= out_len) {
1119 strcpy(out_buf, (start + i));
1120 *offset += (x - start) + 1;
1127 static int kvp_write_file(FILE *f, char *s1, char *s2, char *s3)
1131 ret = fprintf(f, "%s%s%s%s\n", s1, s2, "=", s3);
1140 static int process_ip_string(FILE *f, char *ip_string, int type)
1143 char addr[INET6_ADDRSTRLEN];
1150 memset(addr, 0, sizeof(addr));
1152 while (parse_ip_val_buffer(ip_string, &offset, addr,
1153 (MAX_IP_ADDR_SIZE * 2))) {
1156 if (is_ipv4(addr)) {
1159 snprintf(str, sizeof(str), "%s", "IPADDR");
1162 snprintf(str, sizeof(str), "%s", "NETMASK");
1165 snprintf(str, sizeof(str), "%s", "GATEWAY");
1168 snprintf(str, sizeof(str), "%s", "DNS");
1173 snprintf(sub_str, sizeof(sub_str), "%d", ++i);
1174 } else if (type == GATEWAY && i == 0) {
1177 snprintf(sub_str, sizeof(sub_str), "%d", i++);
1181 } else if (expand_ipv6(addr, type)) {
1184 snprintf(str, sizeof(str), "%s", "IPV6ADDR");
1187 snprintf(str, sizeof(str), "%s", "IPV6NETMASK");
1190 snprintf(str, sizeof(str), "%s",
1194 snprintf(str, sizeof(str), "%s", "DNS");
1199 snprintf(sub_str, sizeof(sub_str), "%d", ++i);
1200 } else if (j == 0) {
1203 snprintf(sub_str, sizeof(sub_str), "_%d", j++);
1206 return HV_INVALIDARG;
1209 error = kvp_write_file(f, str, sub_str, addr);
1212 memset(addr, 0, sizeof(addr));
1218 static int kvp_set_ip_info(char *if_name, struct hv_kvp_ipaddr_value *new_val)
1227 * Set the configuration for the specified interface with
1228 * the information provided. Since there is no standard
1229 * way to configure an interface, we will have an external
1230 * script that does the job of configuring the interface and
1231 * flushing the configuration.
1233 * The parameters passed to this external script are:
1234 * 1. A configuration file that has the specified configuration.
1236 * We will embed the name of the interface in the configuration
1237 * file: ifcfg-ethx (where ethx is the interface name).
1239 * The information provided here may be more than what is needed
1240 * in a given distro to configure the interface and so are free
1241 * ignore information that may not be relevant.
1243 * Here is the format of the ip configuration file:
1246 * DEVICE=interface name
1247 * BOOTPROTO=<protocol> (where <protocol> is "dhcp" if DHCP is configured
1248 * or "none" if no boot-time protocol should be used)
1252 * IPADDRx=ipaddry (where y = x + 1)
1255 * NETMASKx=netmasky (where y = x + 1)
1258 * GATEWAYx=ipaddry (where y = x + 1)
1260 * DNSx=ipaddrx (where first DNS address is tagged as DNS1 etc)
1262 * IPV6 addresses will be tagged as IPV6ADDR, IPV6 gateway will be
1263 * tagged as IPV6_DEFAULTGW and IPV6 NETMASK will be tagged as
1266 * The host can specify multiple ipv4 and ipv6 addresses to be
1267 * configured for the interface. Furthermore, the configuration
1268 * needs to be persistent. A subsequent GET call on the interface
1269 * is expected to return the configuration that is set via the SET
1273 snprintf(if_file, sizeof(if_file), "%s%s%s", KVP_CONFIG_LOC,
1274 "/ifcfg-", if_name);
1276 file = fopen(if_file, "w");
1279 syslog(LOG_ERR, "Failed to open config file; error: %d %s",
1280 errno, strerror(errno));
1285 * First write out the MAC address.
1288 mac_addr = kvp_if_name_to_mac(if_name);
1289 if (mac_addr == NULL) {
1294 error = kvp_write_file(file, "HWADDR", "", mac_addr);
1299 error = kvp_write_file(file, "DEVICE", "", if_name);
1304 * The dhcp_enabled flag is only for IPv4. In the case the host only
1305 * injects an IPv6 address, the flag is true, but we still need to
1306 * proceed to parse and pass the IPv6 information to the
1307 * disto-specific script hv_set_ifconfig.
1309 if (new_val->dhcp_enabled) {
1310 error = kvp_write_file(file, "BOOTPROTO", "", "dhcp");
1315 error = kvp_write_file(file, "BOOTPROTO", "", "none");
1321 * Write the configuration for ipaddress, netmask, gateway and
1325 error = process_ip_string(file, (char *)new_val->ip_addr, IPADDR);
1329 error = process_ip_string(file, (char *)new_val->sub_net, NETMASK);
1333 error = process_ip_string(file, (char *)new_val->gate_way, GATEWAY);
1337 error = process_ip_string(file, (char *)new_val->dns_addr, DNS);
1344 * Now that we have populated the configuration file,
1345 * invoke the external script to do its magic.
1348 snprintf(cmd, sizeof(cmd), KVP_SCRIPTS_PATH "%s %s",
1349 "hv_set_ifconfig", if_file);
1351 syslog(LOG_ERR, "Failed to execute cmd '%s'; error: %d %s",
1352 cmd, errno, strerror(errno));
1358 syslog(LOG_ERR, "Failed to write config file");
1365 kvp_get_domain_name(char *buffer, int length)
1367 struct addrinfo hints, *info ;
1370 gethostname(buffer, length);
1371 memset(&hints, 0, sizeof(hints));
1372 hints.ai_family = AF_INET; /*Get only ipv4 addrinfo. */
1373 hints.ai_socktype = SOCK_STREAM;
1374 hints.ai_flags = AI_CANONNAME;
1376 error = getaddrinfo(buffer, NULL, &hints, &info);
1378 snprintf(buffer, length, "getaddrinfo failed: 0x%x %s",
1379 error, gai_strerror(error));
1382 snprintf(buffer, length, "%s", info->ai_canonname);
1386 void print_usage(char *argv[])
1388 fprintf(stderr, "Usage: %s [options]\n"
1390 " -n, --no-daemon stay in foreground, don't daemonize\n"
1391 " -h, --help print this help\n", argv[0]);
1394 int main(int argc, char *argv[])
1400 struct hv_kvp_msg hv_msg[1];
1406 struct hv_kvp_ipaddr_value *kvp_ip_val;
1407 int daemonize = 1, long_index = 0, opt;
1409 static struct option long_options[] = {
1410 {"help", no_argument, 0, 'h' },
1411 {"no-daemon", no_argument, 0, 'n' },
1415 while ((opt = getopt_long(argc, argv, "hn", long_options,
1416 &long_index)) != -1) {
1428 if (daemonize && daemon(1, 0))
1431 openlog("KVP", 0, LOG_USER);
1432 syslog(LOG_INFO, "KVP starting; pid is:%d", getpid());
1434 kvp_fd = open("/dev/vmbus/hv_kvp", O_RDWR | O_CLOEXEC);
1437 syslog(LOG_ERR, "open /dev/vmbus/hv_kvp failed; error: %d %s",
1438 errno, strerror(errno));
1443 * Retrieve OS release information.
1447 * Cache Fully Qualified Domain Name because getaddrinfo takes an
1448 * unpredictable amount of time to finish.
1450 kvp_get_domain_name(full_domain_name, sizeof(full_domain_name));
1452 if (kvp_file_init()) {
1453 syslog(LOG_ERR, "Failed to initialize the pools");
1458 * Register ourselves with the kernel.
1460 hv_msg->kvp_hdr.operation = KVP_OP_REGISTER1;
1461 len = write(kvp_fd, hv_msg, sizeof(struct hv_kvp_msg));
1462 if (len != sizeof(struct hv_kvp_msg)) {
1463 syslog(LOG_ERR, "registration to kernel failed; error: %d %s",
1464 errno, strerror(errno));
1472 pfd.events = POLLIN;
1475 if (poll(&pfd, 1, -1) < 0) {
1476 syslog(LOG_ERR, "poll failed; error: %d %s", errno, strerror(errno));
1477 if (errno == EINVAL) {
1485 len = read(kvp_fd, hv_msg, sizeof(struct hv_kvp_msg));
1487 if (len != sizeof(struct hv_kvp_msg)) {
1488 syslog(LOG_ERR, "read failed; error:%d %s",
1489 errno, strerror(errno));
1492 return EXIT_FAILURE;
1496 * We will use the KVP header information to pass back
1497 * the error from this daemon. So, first copy the state
1498 * and set the error code to success.
1500 op = hv_msg->kvp_hdr.operation;
1501 pool = hv_msg->kvp_hdr.pool;
1502 hv_msg->error = HV_S_OK;
1504 if ((in_hand_shake) && (op == KVP_OP_REGISTER1)) {
1506 * Driver is registering with us; stash away the version
1510 p = (char *)hv_msg->body.kvp_register.version;
1511 lic_version = malloc(strlen(p) + 1);
1513 strcpy(lic_version, p);
1514 syslog(LOG_INFO, "KVP LIC Version: %s",
1517 syslog(LOG_ERR, "malloc failed");
1523 case KVP_OP_GET_IP_INFO:
1524 kvp_ip_val = &hv_msg->body.kvp_ip_val;
1526 kvp_mac_to_if_name((char *)kvp_ip_val->adapter_id);
1528 if (if_name == NULL) {
1530 * We could not map the mac address to an
1531 * interface name; return error.
1533 hv_msg->error = HV_E_FAIL;
1536 error = kvp_get_ip_info(
1537 0, if_name, KVP_OP_GET_IP_INFO,
1539 (MAX_IP_ADDR_SIZE * 2));
1542 hv_msg->error = error;
1547 case KVP_OP_SET_IP_INFO:
1548 kvp_ip_val = &hv_msg->body.kvp_ip_val;
1549 if_name = kvp_get_if_name(
1550 (char *)kvp_ip_val->adapter_id);
1551 if (if_name == NULL) {
1553 * We could not map the guid to an
1554 * interface name; return error.
1556 hv_msg->error = HV_GUID_NOTFOUND;
1559 error = kvp_set_ip_info(if_name, kvp_ip_val);
1561 hv_msg->error = error;
1567 if (kvp_key_add_or_modify(pool,
1568 hv_msg->body.kvp_set.data.key,
1569 hv_msg->body.kvp_set.data.key_size,
1570 hv_msg->body.kvp_set.data.value,
1571 hv_msg->body.kvp_set.data.value_size))
1572 hv_msg->error = HV_S_CONT;
1576 if (kvp_get_value(pool,
1577 hv_msg->body.kvp_set.data.key,
1578 hv_msg->body.kvp_set.data.key_size,
1579 hv_msg->body.kvp_set.data.value,
1580 hv_msg->body.kvp_set.data.value_size))
1581 hv_msg->error = HV_S_CONT;
1585 if (kvp_key_delete(pool,
1586 hv_msg->body.kvp_delete.key,
1587 hv_msg->body.kvp_delete.key_size))
1588 hv_msg->error = HV_S_CONT;
1595 if (op != KVP_OP_ENUMERATE)
1599 * If the pool is KVP_POOL_AUTO, dynamically generate
1600 * both the key and the value; if not read from the
1603 if (pool != KVP_POOL_AUTO) {
1604 if (kvp_pool_enumerate(pool,
1605 hv_msg->body.kvp_enum_data.index,
1606 hv_msg->body.kvp_enum_data.data.key,
1607 HV_KVP_EXCHANGE_MAX_KEY_SIZE,
1608 hv_msg->body.kvp_enum_data.data.value,
1609 HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
1610 hv_msg->error = HV_S_CONT;
1614 key_name = (char *)hv_msg->body.kvp_enum_data.data.key;
1615 key_value = (char *)hv_msg->body.kvp_enum_data.data.value;
1617 switch (hv_msg->body.kvp_enum_data.index) {
1618 case FullyQualifiedDomainName:
1619 strcpy(key_value, full_domain_name);
1620 strcpy(key_name, "FullyQualifiedDomainName");
1622 case IntegrationServicesVersion:
1623 strcpy(key_name, "IntegrationServicesVersion");
1624 strcpy(key_value, lic_version);
1626 case NetworkAddressIPv4:
1627 kvp_get_ip_info(AF_INET, NULL, KVP_OP_ENUMERATE,
1628 key_value, HV_KVP_EXCHANGE_MAX_VALUE_SIZE);
1629 strcpy(key_name, "NetworkAddressIPv4");
1631 case NetworkAddressIPv6:
1632 kvp_get_ip_info(AF_INET6, NULL, KVP_OP_ENUMERATE,
1633 key_value, HV_KVP_EXCHANGE_MAX_VALUE_SIZE);
1634 strcpy(key_name, "NetworkAddressIPv6");
1637 strcpy(key_value, os_build);
1638 strcpy(key_name, "OSBuildNumber");
1641 strcpy(key_value, os_name);
1642 strcpy(key_name, "OSName");
1644 case OSMajorVersion:
1645 strcpy(key_value, os_major);
1646 strcpy(key_name, "OSMajorVersion");
1648 case OSMinorVersion:
1649 strcpy(key_value, os_minor);
1650 strcpy(key_name, "OSMinorVersion");
1653 strcpy(key_value, os_version);
1654 strcpy(key_name, "OSVersion");
1656 case ProcessorArchitecture:
1657 strcpy(key_value, processor_arch);
1658 strcpy(key_name, "ProcessorArchitecture");
1661 hv_msg->error = HV_S_CONT;
1665 /* Send the value back to the kernel. */
1667 len = write(kvp_fd, hv_msg, sizeof(struct hv_kvp_msg));
1668 if (len != sizeof(struct hv_kvp_msg)) {
1669 syslog(LOG_ERR, "write failed; error: %d %s", errno,