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>
46 * KVP protocol: The user mode component first registers with the
47 * 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*/
79 static int in_hand_shake;
81 static char *os_name = "";
82 static char *os_major = "";
83 static char *os_minor = "";
84 static char *processor_arch;
85 static char *os_build;
86 static char *os_version;
87 static char *lic_version = "Unknown version";
88 static char full_domain_name[HV_KVP_EXCHANGE_MAX_VALUE_SIZE];
89 static struct utsname uts_buf;
92 * The location of the interface configuration file.
95 #define KVP_CONFIG_LOC "/var/lib/hyperv"
97 #ifndef KVP_SCRIPTS_PATH
98 #define KVP_SCRIPTS_PATH "/usr/libexec/hypervkvpd/"
101 #define KVP_NET_DIR "/sys/class/net/"
103 #define MAX_FILE_NAME 100
104 #define ENTRIES_PER_BLOCK 50
107 char key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
108 char value[HV_KVP_EXCHANGE_MAX_VALUE_SIZE];
111 struct kvp_file_state {
114 struct kvp_record *records;
116 char fname[MAX_FILE_NAME];
119 static struct kvp_file_state kvp_file_info[KVP_POOL_COUNT];
121 static void kvp_acquire_lock(int pool)
123 struct flock fl = {F_WRLCK, SEEK_SET, 0, 0, 0};
126 if (fcntl(kvp_file_info[pool].fd, F_SETLKW, &fl) == -1) {
127 syslog(LOG_ERR, "Failed to acquire the lock pool: %d; error: %d %s", pool,
128 errno, strerror(errno));
133 static void kvp_release_lock(int pool)
135 struct flock fl = {F_UNLCK, SEEK_SET, 0, 0, 0};
138 if (fcntl(kvp_file_info[pool].fd, F_SETLK, &fl) == -1) {
139 syslog(LOG_ERR, "Failed to release the lock pool: %d; error: %d %s", pool,
140 errno, strerror(errno));
145 static void kvp_update_file(int pool)
150 * We are going to write our in-memory registry out to
151 * disk; acquire the lock first.
153 kvp_acquire_lock(pool);
155 filep = fopen(kvp_file_info[pool].fname, "we");
157 syslog(LOG_ERR, "Failed to open file, pool: %d; error: %d %s", pool,
158 errno, strerror(errno));
159 kvp_release_lock(pool);
163 fwrite(kvp_file_info[pool].records, sizeof(struct kvp_record),
164 kvp_file_info[pool].num_records, filep);
166 if (ferror(filep) || fclose(filep)) {
167 kvp_release_lock(pool);
168 syslog(LOG_ERR, "Failed to write file, pool: %d", pool);
172 kvp_release_lock(pool);
175 static void kvp_update_mem_state(int pool)
178 size_t records_read = 0;
179 struct kvp_record *record = kvp_file_info[pool].records;
180 struct kvp_record *readp;
181 int num_blocks = kvp_file_info[pool].num_blocks;
182 int alloc_unit = sizeof(struct kvp_record) * ENTRIES_PER_BLOCK;
184 kvp_acquire_lock(pool);
186 filep = fopen(kvp_file_info[pool].fname, "re");
188 syslog(LOG_ERR, "Failed to open file, pool: %d; error: %d %s", pool,
189 errno, strerror(errno));
190 kvp_release_lock(pool);
194 readp = &record[records_read];
195 records_read += fread(readp, sizeof(struct kvp_record),
196 ENTRIES_PER_BLOCK * num_blocks - records_read,
201 "Failed to read file, pool: %d; error: %d %s",
202 pool, errno, strerror(errno));
203 kvp_release_lock(pool);
209 * We have more data to read.
212 record = realloc(record, alloc_unit * num_blocks);
214 if (record == NULL) {
215 syslog(LOG_ERR, "malloc failed");
216 kvp_release_lock(pool);
224 kvp_file_info[pool].num_blocks = num_blocks;
225 kvp_file_info[pool].records = record;
226 kvp_file_info[pool].num_records = records_read;
229 kvp_release_lock(pool);
232 static int kvp_file_init(void)
237 int alloc_unit = sizeof(struct kvp_record) * ENTRIES_PER_BLOCK;
239 if (access(KVP_CONFIG_LOC, F_OK)) {
240 if (mkdir(KVP_CONFIG_LOC, 0755 /* rwxr-xr-x */)) {
241 syslog(LOG_ERR, "Failed to create '%s'; error: %d %s", KVP_CONFIG_LOC,
242 errno, strerror(errno));
247 for (i = 0; i < KVP_POOL_COUNT; i++) {
248 fname = kvp_file_info[i].fname;
249 sprintf(fname, "%s/.kvp_pool_%d", KVP_CONFIG_LOC, i);
250 fd = open(fname, O_RDWR | O_CREAT | O_CLOEXEC, 0644 /* rw-r--r-- */);
255 kvp_file_info[i].fd = fd;
256 kvp_file_info[i].num_blocks = 1;
257 kvp_file_info[i].records = malloc(alloc_unit);
258 if (kvp_file_info[i].records == NULL)
260 kvp_file_info[i].num_records = 0;
261 kvp_update_mem_state(i);
267 static int kvp_key_delete(int pool, const __u8 *key, int key_size)
272 struct kvp_record *record;
275 * First update the in-memory state.
277 kvp_update_mem_state(pool);
279 num_records = kvp_file_info[pool].num_records;
280 record = kvp_file_info[pool].records;
282 for (i = 0; i < num_records; i++) {
283 if (memcmp(key, record[i].key, key_size))
286 * Found a match; just move the remaining
289 if (i == (num_records - 1)) {
290 kvp_file_info[pool].num_records--;
291 kvp_update_file(pool);
297 for (; k < num_records; k++) {
298 strcpy(record[j].key, record[k].key);
299 strcpy(record[j].value, record[k].value);
303 kvp_file_info[pool].num_records--;
304 kvp_update_file(pool);
310 static int kvp_key_add_or_modify(int pool, const __u8 *key, int key_size,
311 const __u8 *value, int value_size)
315 struct kvp_record *record;
318 if ((key_size > HV_KVP_EXCHANGE_MAX_KEY_SIZE) ||
319 (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
323 * First update the in-memory state.
325 kvp_update_mem_state(pool);
327 num_records = kvp_file_info[pool].num_records;
328 record = kvp_file_info[pool].records;
329 num_blocks = kvp_file_info[pool].num_blocks;
331 for (i = 0; i < num_records; i++) {
332 if (memcmp(key, record[i].key, key_size))
335 * Found a match; just update the value -
336 * this is the modify case.
338 memcpy(record[i].value, value, value_size);
339 kvp_update_file(pool);
344 * Need to add a new entry;
346 if (num_records == (ENTRIES_PER_BLOCK * num_blocks)) {
347 /* Need to allocate a larger array for reg entries. */
348 record = realloc(record, sizeof(struct kvp_record) *
349 ENTRIES_PER_BLOCK * (num_blocks + 1));
353 kvp_file_info[pool].num_blocks++;
356 memcpy(record[i].value, value, value_size);
357 memcpy(record[i].key, key, key_size);
358 kvp_file_info[pool].records = record;
359 kvp_file_info[pool].num_records++;
360 kvp_update_file(pool);
364 static int kvp_get_value(int pool, const __u8 *key, int key_size, __u8 *value,
369 struct kvp_record *record;
371 if ((key_size > HV_KVP_EXCHANGE_MAX_KEY_SIZE) ||
372 (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
376 * First update the in-memory state.
378 kvp_update_mem_state(pool);
380 num_records = kvp_file_info[pool].num_records;
381 record = kvp_file_info[pool].records;
383 for (i = 0; i < num_records; i++) {
384 if (memcmp(key, record[i].key, key_size))
387 * Found a match; just copy the value out.
389 memcpy(value, record[i].value, value_size);
396 static int kvp_pool_enumerate(int pool, int index, __u8 *key, int key_size,
397 __u8 *value, int value_size)
399 struct kvp_record *record;
402 * First update our in-memory database.
404 kvp_update_mem_state(pool);
405 record = kvp_file_info[pool].records;
407 if (index >= kvp_file_info[pool].num_records) {
411 memcpy(key, record[index].key, key_size);
412 memcpy(value, record[index].value, value_size);
417 void kvp_get_os_info(void)
423 os_version = uts_buf.release;
424 os_build = strdup(uts_buf.release);
426 os_name = uts_buf.sysname;
427 processor_arch = uts_buf.machine;
430 * The current windows host (win7) expects the build
431 * string to be of the form: x.y.z
432 * Strip additional information we may have.
434 p = strchr(os_version, '-');
439 * Parse the /etc/os-release file if present:
440 * https://www.freedesktop.org/software/systemd/man/os-release.html
442 file = fopen("/etc/os-release", "r");
444 while (fgets(buf, sizeof(buf), file)) {
447 /* Ignore comments */
451 /* Split into name=value */
452 p = strchr(buf, '=');
457 /* Remove quotes and newline; un-escape */
466 } else if (*p == '\'' || *p == '"' ||
475 if (!strcmp(buf, "NAME")) {
480 } else if (!strcmp(buf, "VERSION_ID")) {
491 /* Fallback for older RH/SUSE releases */
492 file = fopen("/etc/SuSE-release", "r");
494 goto kvp_osinfo_found;
495 file = fopen("/etc/redhat-release", "r");
497 goto kvp_osinfo_found;
500 * We don't have information about the os.
505 /* up to three lines */
506 p = fgets(buf, sizeof(buf), file);
508 p = strchr(buf, '\n');
517 p = fgets(buf, sizeof(buf), file);
519 p = strchr(buf, '\n');
528 p = fgets(buf, sizeof(buf), file);
530 p = strchr(buf, '\n');
548 * Retrieve an interface name corresponding to the specified guid.
549 * If there is a match, the function returns a pointer
550 * to the interface name and if not, a NULL is returned.
551 * If a match is found, the caller is responsible for
552 * freeing the memory.
555 static char *kvp_get_if_name(char *guid)
558 struct dirent *entry;
561 char *if_name = NULL;
563 char dev_id[PATH_MAX];
565 dir = opendir(KVP_NET_DIR);
569 while ((entry = readdir(dir)) != NULL) {
571 * Set the state for the next pass.
573 snprintf(dev_id, sizeof(dev_id), "%s%s/device/device_id",
574 KVP_NET_DIR, entry->d_name);
576 file = fopen(dev_id, "r");
580 p = fgets(buf, sizeof(buf), file);
586 if (!strcmp(p, guid)) {
588 * Found the guid match; return the interface
589 * name. The caller will free the memory.
591 if_name = strdup(entry->d_name);
604 * Retrieve the MAC address given the interface name.
607 static char *kvp_if_name_to_mac(char *if_name)
612 char addr_file[PATH_MAX];
614 char *mac_addr = NULL;
616 snprintf(addr_file, sizeof(addr_file), "%s%s%s", KVP_NET_DIR,
617 if_name, "/address");
619 file = fopen(addr_file, "r");
623 p = fgets(buf, sizeof(buf), file);
628 for (i = 0; i < strlen(p); i++)
629 p[i] = toupper(p[i]);
630 mac_addr = strdup(p);
637 static void kvp_process_ipconfig_file(char *cmd,
638 char *config_buf, unsigned int len,
639 int element_size, int offset)
647 * First execute the command.
649 file = popen(cmd, "r");
654 memset(config_buf, 0, len);
655 while ((p = fgets(buf, sizeof(buf), file)) != NULL) {
656 if (len < strlen(config_buf) + element_size + 1)
663 strcat(config_buf, p);
664 strcat(config_buf, ";");
669 static void kvp_get_ipconfig_info(char *if_name,
670 struct hv_kvp_ipaddr_value *buffer)
678 * Get the address of default gateway (ipv4).
680 sprintf(cmd, "%s %s", "ip route show dev", if_name);
681 strcat(cmd, " | awk '/default/ {print $3 }'");
684 * Execute the command to gather gateway info.
686 kvp_process_ipconfig_file(cmd, (char *)buffer->gate_way,
687 (MAX_GATEWAY_SIZE * 2), INET_ADDRSTRLEN, 0);
690 * Get the address of default gateway (ipv6).
692 sprintf(cmd, "%s %s", "ip -f inet6 route show dev", if_name);
693 strcat(cmd, " | awk '/default/ {print $3 }'");
696 * Execute the command to gather gateway info (ipv6).
698 kvp_process_ipconfig_file(cmd, (char *)buffer->gate_way,
699 (MAX_GATEWAY_SIZE * 2), INET6_ADDRSTRLEN, 1);
703 * Gather the DNS state.
704 * Since there is no standard way to get this information
705 * across various distributions of interest; we just invoke
706 * an external script that needs to be ported across distros
709 * Following is the expected format of the information from the script:
711 * ipaddr1 (nameserver1)
712 * ipaddr2 (nameserver2)
717 sprintf(cmd, KVP_SCRIPTS_PATH "%s", "hv_get_dns_info");
720 * Execute the command to gather DNS info.
722 kvp_process_ipconfig_file(cmd, (char *)buffer->dns_addr,
723 (MAX_IP_ADDR_SIZE * 2), INET_ADDRSTRLEN, 0);
726 * Gather the DHCP state.
727 * We will gather this state by invoking an external script.
728 * The parameter to the script is the interface name.
729 * Here is the expected output:
731 * Enabled: DHCP enabled.
734 sprintf(cmd, KVP_SCRIPTS_PATH "%s %s", "hv_get_dhcp_info", if_name);
736 file = popen(cmd, "r");
740 p = fgets(dhcp_info, sizeof(dhcp_info), file);
746 if (!strncmp(p, "Enabled", 7))
747 buffer->dhcp_enabled = 1;
749 buffer->dhcp_enabled = 0;
755 static unsigned int hweight32(unsigned int *w)
757 unsigned int res = *w - ((*w >> 1) & 0x55555555);
758 res = (res & 0x33333333) + ((res >> 2) & 0x33333333);
759 res = (res + (res >> 4)) & 0x0F0F0F0F;
760 res = res + (res >> 8);
761 return (res + (res >> 16)) & 0x000000FF;
764 static int kvp_process_ip_address(void *addrp,
765 int family, char *buffer,
766 int length, int *offset)
768 struct sockaddr_in *addr;
769 struct sockaddr_in6 *addr6;
774 if (family == AF_INET) {
776 str = inet_ntop(family, &addr->sin_addr, tmp, 50);
777 addr_length = INET_ADDRSTRLEN;
780 str = inet_ntop(family, &addr6->sin6_addr.s6_addr, tmp, 50);
781 addr_length = INET6_ADDRSTRLEN;
784 if ((length - *offset) < addr_length + 2)
787 strcpy(buffer, "inet_ntop failed\n");
797 *offset += strlen(str) + 1;
803 kvp_get_ip_info(int family, char *if_name, int op,
804 void *out_buffer, unsigned int length)
806 struct ifaddrs *ifap;
807 struct ifaddrs *curp;
812 struct hv_kvp_ipaddr_value *ip_buffer = NULL;
813 char cidr_mask[5]; /* /xyz */
818 struct sockaddr_in6 *addr6;
820 if (op == KVP_OP_ENUMERATE) {
823 ip_buffer = out_buffer;
824 buffer = (char *)ip_buffer->ip_addr;
825 ip_buffer->addr_family = 0;
828 * On entry into this function, the buffer is capable of holding the
832 if (getifaddrs(&ifap)) {
833 strcpy(buffer, "getifaddrs failed\n");
838 while (curp != NULL) {
839 if (curp->ifa_addr == NULL) {
840 curp = curp->ifa_next;
844 if ((if_name != NULL) &&
845 (strncmp(curp->ifa_name, if_name, strlen(if_name)))) {
847 * We want info about a specific interface;
850 curp = curp->ifa_next;
855 * We only support two address families: AF_INET and AF_INET6.
856 * If a family value of 0 is specified, we collect both
857 * supported address families; if not we gather info on
858 * the specified address family.
860 if ((((family != 0) &&
861 (curp->ifa_addr->sa_family != family))) ||
862 (curp->ifa_flags & IFF_LOOPBACK)) {
863 curp = curp->ifa_next;
866 if ((curp->ifa_addr->sa_family != AF_INET) &&
867 (curp->ifa_addr->sa_family != AF_INET6)) {
868 curp = curp->ifa_next;
872 if (op == KVP_OP_GET_IP_INFO) {
874 * Gather info other than the IP address.
875 * IP address info will be gathered later.
877 if (curp->ifa_addr->sa_family == AF_INET) {
878 ip_buffer->addr_family |= ADDR_FAMILY_IPV4;
882 error = kvp_process_ip_address(
892 ip_buffer->addr_family |= ADDR_FAMILY_IPV6;
895 * Get subnet info in CIDR format.
898 sn_str = (char *)ip_buffer->sub_net;
899 addr6 = (struct sockaddr_in6 *)
901 w = addr6->sin6_addr.s6_addr32;
903 for (i = 0; i < 4; i++)
904 weight += hweight32(&w[i]);
906 sprintf(cidr_mask, "/%d", weight);
907 if (length < sn_offset + strlen(cidr_mask) + 1)
911 strcpy(sn_str, cidr_mask);
913 strcat((char *)ip_buffer->sub_net, ";");
914 strcat(sn_str, cidr_mask);
916 sn_offset += strlen(sn_str) + 1;
920 * Collect other ip related configuration info.
923 kvp_get_ipconfig_info(if_name, ip_buffer);
927 error = kvp_process_ip_address(curp->ifa_addr,
928 curp->ifa_addr->sa_family,
934 curp = curp->ifa_next;
943 * Retrieve the IP given the MAC address.
945 static int kvp_mac_to_ip(struct hv_kvp_ipaddr_value *kvp_ip_val)
947 char *mac = (char *)kvp_ip_val->adapter_id;
949 struct dirent *entry;
952 char *if_name = NULL;
954 char dev_id[PATH_MAX];
956 int error = HV_E_FAIL;
958 dir = opendir(KVP_NET_DIR);
962 while ((entry = readdir(dir)) != NULL) {
964 * Set the state for the next pass.
966 snprintf(dev_id, sizeof(dev_id), "%s%s/address", KVP_NET_DIR,
969 file = fopen(dev_id, "r");
973 p = fgets(buf, sizeof(buf), file);
982 for (i = 0; i < strlen(p); i++)
983 p[i] = toupper(p[i]);
989 * Found the MAC match.
990 * A NIC (e.g. VF) matching the MAC, but without IP, is skipped.
992 if_name = entry->d_name;
996 error = kvp_get_ip_info(0, if_name, KVP_OP_GET_IP_INFO,
997 kvp_ip_val, MAX_IP_ADDR_SIZE * 2);
999 if (!error && strlen((char *)kvp_ip_val->ip_addr))
1007 static int expand_ipv6(char *addr, int type)
1010 struct in6_addr v6_addr;
1012 ret = inet_pton(AF_INET6, addr, &v6_addr);
1015 if (type == NETMASK)
1020 sprintf(addr, "%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
1021 "%02x%02x:%02x%02x:%02x%02x",
1022 (int)v6_addr.s6_addr[0], (int)v6_addr.s6_addr[1],
1023 (int)v6_addr.s6_addr[2], (int)v6_addr.s6_addr[3],
1024 (int)v6_addr.s6_addr[4], (int)v6_addr.s6_addr[5],
1025 (int)v6_addr.s6_addr[6], (int)v6_addr.s6_addr[7],
1026 (int)v6_addr.s6_addr[8], (int)v6_addr.s6_addr[9],
1027 (int)v6_addr.s6_addr[10], (int)v6_addr.s6_addr[11],
1028 (int)v6_addr.s6_addr[12], (int)v6_addr.s6_addr[13],
1029 (int)v6_addr.s6_addr[14], (int)v6_addr.s6_addr[15]);
1035 static int is_ipv4(char *addr)
1038 struct in_addr ipv4_addr;
1040 ret = inet_pton(AF_INET, addr, &ipv4_addr);
1047 static int parse_ip_val_buffer(char *in_buf, int *offset,
1048 char *out_buf, int out_len)
1054 * in_buf has sequence of characters that are separated by
1055 * the character ';'. The last sequence does not have the
1056 * terminating ";" character.
1058 start = in_buf + *offset;
1060 x = strchr(start, ';');
1064 x = start + strlen(start);
1066 if (strlen(start) != 0) {
1069 * Get rid of leading spaces.
1071 while (start[i] == ' ')
1074 if ((x - start) <= out_len) {
1075 strcpy(out_buf, (start + i));
1076 *offset += (x - start) + 1;
1083 static int kvp_write_file(FILE *f, char *s1, char *s2, char *s3)
1087 ret = fprintf(f, "%s%s%s%s\n", s1, s2, "=", s3);
1096 static int process_ip_string(FILE *f, char *ip_string, int type)
1099 char addr[INET6_ADDRSTRLEN];
1106 memset(addr, 0, sizeof(addr));
1108 while (parse_ip_val_buffer(ip_string, &offset, addr,
1109 (MAX_IP_ADDR_SIZE * 2))) {
1112 if (is_ipv4(addr)) {
1115 snprintf(str, sizeof(str), "%s", "IPADDR");
1118 snprintf(str, sizeof(str), "%s", "NETMASK");
1121 snprintf(str, sizeof(str), "%s", "GATEWAY");
1124 snprintf(str, sizeof(str), "%s", "DNS");
1129 snprintf(sub_str, sizeof(sub_str), "%d", ++i);
1130 } else if (type == GATEWAY && i == 0) {
1133 snprintf(sub_str, sizeof(sub_str), "%d", i++);
1137 } else if (expand_ipv6(addr, type)) {
1140 snprintf(str, sizeof(str), "%s", "IPV6ADDR");
1143 snprintf(str, sizeof(str), "%s", "IPV6NETMASK");
1146 snprintf(str, sizeof(str), "%s",
1150 snprintf(str, sizeof(str), "%s", "DNS");
1155 snprintf(sub_str, sizeof(sub_str), "%d", ++i);
1156 } else if (j == 0) {
1159 snprintf(sub_str, sizeof(sub_str), "_%d", j++);
1162 return HV_INVALIDARG;
1165 error = kvp_write_file(f, str, sub_str, addr);
1168 memset(addr, 0, sizeof(addr));
1174 static int kvp_set_ip_info(char *if_name, struct hv_kvp_ipaddr_value *new_val)
1177 char if_file[PATH_MAX];
1184 * Set the configuration for the specified interface with
1185 * the information provided. Since there is no standard
1186 * way to configure an interface, we will have an external
1187 * script that does the job of configuring the interface and
1188 * flushing the configuration.
1190 * The parameters passed to this external script are:
1191 * 1. A configuration file that has the specified configuration.
1193 * We will embed the name of the interface in the configuration
1194 * file: ifcfg-ethx (where ethx is the interface name).
1196 * The information provided here may be more than what is needed
1197 * in a given distro to configure the interface and so are free
1198 * ignore information that may not be relevant.
1200 * Here is the format of the ip configuration file:
1203 * DEVICE=interface name
1204 * BOOTPROTO=<protocol> (where <protocol> is "dhcp" if DHCP is configured
1205 * or "none" if no boot-time protocol should be used)
1209 * IPADDRx=ipaddry (where y = x + 1)
1212 * NETMASKx=netmasky (where y = x + 1)
1215 * GATEWAYx=ipaddry (where y = x + 1)
1217 * DNSx=ipaddrx (where first DNS address is tagged as DNS1 etc)
1219 * IPV6 addresses will be tagged as IPV6ADDR, IPV6 gateway will be
1220 * tagged as IPV6_DEFAULTGW and IPV6 NETMASK will be tagged as
1223 * The host can specify multiple ipv4 and ipv6 addresses to be
1224 * configured for the interface. Furthermore, the configuration
1225 * needs to be persistent. A subsequent GET call on the interface
1226 * is expected to return the configuration that is set via the SET
1230 snprintf(if_file, sizeof(if_file), "%s%s%s", KVP_CONFIG_LOC,
1231 "/ifcfg-", if_name);
1233 file = fopen(if_file, "w");
1236 syslog(LOG_ERR, "Failed to open config file; error: %d %s",
1237 errno, strerror(errno));
1242 * First write out the MAC address.
1245 mac_addr = kvp_if_name_to_mac(if_name);
1246 if (mac_addr == NULL) {
1251 error = kvp_write_file(file, "HWADDR", "", mac_addr);
1256 error = kvp_write_file(file, "DEVICE", "", if_name);
1261 * The dhcp_enabled flag is only for IPv4. In the case the host only
1262 * injects an IPv6 address, the flag is true, but we still need to
1263 * proceed to parse and pass the IPv6 information to the
1264 * disto-specific script hv_set_ifconfig.
1266 if (new_val->dhcp_enabled) {
1267 error = kvp_write_file(file, "BOOTPROTO", "", "dhcp");
1272 error = kvp_write_file(file, "BOOTPROTO", "", "none");
1278 * Write the configuration for ipaddress, netmask, gateway and
1282 error = process_ip_string(file, (char *)new_val->ip_addr, IPADDR);
1286 error = process_ip_string(file, (char *)new_val->sub_net, NETMASK);
1290 error = process_ip_string(file, (char *)new_val->gate_way, GATEWAY);
1294 error = process_ip_string(file, (char *)new_val->dns_addr, DNS);
1301 * Now that we have populated the configuration file,
1302 * invoke the external script to do its magic.
1305 str_len = snprintf(cmd, sizeof(cmd), KVP_SCRIPTS_PATH "%s %s",
1306 "hv_set_ifconfig", if_file);
1308 * This is a little overcautious, but it's necessary to suppress some
1309 * false warnings from gcc 8.0.1.
1311 if (str_len <= 0 || (unsigned int)str_len >= sizeof(cmd)) {
1312 syslog(LOG_ERR, "Cmd '%s' (len=%d) may be too long",
1318 syslog(LOG_ERR, "Failed to execute cmd '%s'; error: %d %s",
1319 cmd, errno, strerror(errno));
1325 syslog(LOG_ERR, "Failed to write config file");
1332 kvp_get_domain_name(char *buffer, int length)
1334 struct addrinfo hints, *info ;
1337 gethostname(buffer, length);
1338 memset(&hints, 0, sizeof(hints));
1339 hints.ai_family = AF_INET; /*Get only ipv4 addrinfo. */
1340 hints.ai_socktype = SOCK_STREAM;
1341 hints.ai_flags = AI_CANONNAME;
1343 error = getaddrinfo(buffer, NULL, &hints, &info);
1345 snprintf(buffer, length, "getaddrinfo failed: 0x%x %s",
1346 error, gai_strerror(error));
1349 snprintf(buffer, length, "%s", info->ai_canonname);
1353 void print_usage(char *argv[])
1355 fprintf(stderr, "Usage: %s [options]\n"
1357 " -n, --no-daemon stay in foreground, don't daemonize\n"
1358 " -h, --help print this help\n", argv[0]);
1361 int main(int argc, char *argv[])
1363 int kvp_fd = -1, len;
1367 struct hv_kvp_msg hv_msg[1];
1373 struct hv_kvp_ipaddr_value *kvp_ip_val;
1374 int daemonize = 1, long_index = 0, opt;
1376 static struct option long_options[] = {
1377 {"help", no_argument, 0, 'h' },
1378 {"no-daemon", no_argument, 0, 'n' },
1382 while ((opt = getopt_long(argc, argv, "hn", long_options,
1383 &long_index)) != -1) {
1397 if (daemonize && daemon(1, 0))
1400 openlog("KVP", 0, LOG_USER);
1401 syslog(LOG_INFO, "KVP starting; pid is:%d", getpid());
1404 * Retrieve OS release information.
1408 * Cache Fully Qualified Domain Name because getaddrinfo takes an
1409 * unpredictable amount of time to finish.
1411 kvp_get_domain_name(full_domain_name, sizeof(full_domain_name));
1413 if (kvp_file_init()) {
1414 syslog(LOG_ERR, "Failed to initialize the pools");
1422 kvp_fd = open("/dev/vmbus/hv_kvp", O_RDWR | O_CLOEXEC);
1425 syslog(LOG_ERR, "open /dev/vmbus/hv_kvp failed; error: %d %s",
1426 errno, strerror(errno));
1431 * Register ourselves with the kernel.
1433 hv_msg->kvp_hdr.operation = KVP_OP_REGISTER1;
1434 len = write(kvp_fd, hv_msg, sizeof(struct hv_kvp_msg));
1435 if (len != sizeof(struct hv_kvp_msg)) {
1436 syslog(LOG_ERR, "registration to kernel failed; error: %d %s",
1437 errno, strerror(errno));
1445 pfd.events = POLLIN;
1448 if (poll(&pfd, 1, -1) < 0) {
1449 syslog(LOG_ERR, "poll failed; error: %d %s", errno, strerror(errno));
1450 if (errno == EINVAL) {
1458 len = read(kvp_fd, hv_msg, sizeof(struct hv_kvp_msg));
1460 if (len != sizeof(struct hv_kvp_msg)) {
1461 syslog(LOG_ERR, "read failed; error:%d %s",
1462 errno, strerror(errno));
1467 * We will use the KVP header information to pass back
1468 * the error from this daemon. So, first copy the state
1469 * and set the error code to success.
1471 op = hv_msg->kvp_hdr.operation;
1472 pool = hv_msg->kvp_hdr.pool;
1473 hv_msg->error = HV_S_OK;
1475 if ((in_hand_shake) && (op == KVP_OP_REGISTER1)) {
1477 * Driver is registering with us; stash away the version
1481 p = (char *)hv_msg->body.kvp_register.version;
1482 lic_version = malloc(strlen(p) + 1);
1484 strcpy(lic_version, p);
1485 syslog(LOG_INFO, "KVP LIC Version: %s",
1488 syslog(LOG_ERR, "malloc failed");
1494 case KVP_OP_GET_IP_INFO:
1495 kvp_ip_val = &hv_msg->body.kvp_ip_val;
1497 error = kvp_mac_to_ip(kvp_ip_val);
1500 hv_msg->error = error;
1504 case KVP_OP_SET_IP_INFO:
1505 kvp_ip_val = &hv_msg->body.kvp_ip_val;
1506 if_name = kvp_get_if_name(
1507 (char *)kvp_ip_val->adapter_id);
1508 if (if_name == NULL) {
1510 * We could not map the guid to an
1511 * interface name; return error.
1513 hv_msg->error = HV_GUID_NOTFOUND;
1516 error = kvp_set_ip_info(if_name, kvp_ip_val);
1518 hv_msg->error = error;
1524 if (kvp_key_add_or_modify(pool,
1525 hv_msg->body.kvp_set.data.key,
1526 hv_msg->body.kvp_set.data.key_size,
1527 hv_msg->body.kvp_set.data.value,
1528 hv_msg->body.kvp_set.data.value_size))
1529 hv_msg->error = HV_S_CONT;
1533 if (kvp_get_value(pool,
1534 hv_msg->body.kvp_set.data.key,
1535 hv_msg->body.kvp_set.data.key_size,
1536 hv_msg->body.kvp_set.data.value,
1537 hv_msg->body.kvp_set.data.value_size))
1538 hv_msg->error = HV_S_CONT;
1542 if (kvp_key_delete(pool,
1543 hv_msg->body.kvp_delete.key,
1544 hv_msg->body.kvp_delete.key_size))
1545 hv_msg->error = HV_S_CONT;
1552 if (op != KVP_OP_ENUMERATE)
1556 * If the pool is KVP_POOL_AUTO, dynamically generate
1557 * both the key and the value; if not read from the
1560 if (pool != KVP_POOL_AUTO) {
1561 if (kvp_pool_enumerate(pool,
1562 hv_msg->body.kvp_enum_data.index,
1563 hv_msg->body.kvp_enum_data.data.key,
1564 HV_KVP_EXCHANGE_MAX_KEY_SIZE,
1565 hv_msg->body.kvp_enum_data.data.value,
1566 HV_KVP_EXCHANGE_MAX_VALUE_SIZE))
1567 hv_msg->error = HV_S_CONT;
1571 key_name = (char *)hv_msg->body.kvp_enum_data.data.key;
1572 key_value = (char *)hv_msg->body.kvp_enum_data.data.value;
1574 switch (hv_msg->body.kvp_enum_data.index) {
1575 case FullyQualifiedDomainName:
1576 strcpy(key_value, full_domain_name);
1577 strcpy(key_name, "FullyQualifiedDomainName");
1579 case IntegrationServicesVersion:
1580 strcpy(key_name, "IntegrationServicesVersion");
1581 strcpy(key_value, lic_version);
1583 case NetworkAddressIPv4:
1584 kvp_get_ip_info(AF_INET, NULL, KVP_OP_ENUMERATE,
1585 key_value, HV_KVP_EXCHANGE_MAX_VALUE_SIZE);
1586 strcpy(key_name, "NetworkAddressIPv4");
1588 case NetworkAddressIPv6:
1589 kvp_get_ip_info(AF_INET6, NULL, KVP_OP_ENUMERATE,
1590 key_value, HV_KVP_EXCHANGE_MAX_VALUE_SIZE);
1591 strcpy(key_name, "NetworkAddressIPv6");
1594 strcpy(key_value, os_build);
1595 strcpy(key_name, "OSBuildNumber");
1598 strcpy(key_value, os_name);
1599 strcpy(key_name, "OSName");
1601 case OSMajorVersion:
1602 strcpy(key_value, os_major);
1603 strcpy(key_name, "OSMajorVersion");
1605 case OSMinorVersion:
1606 strcpy(key_value, os_minor);
1607 strcpy(key_name, "OSMinorVersion");
1610 strcpy(key_value, os_version);
1611 strcpy(key_name, "OSVersion");
1613 case ProcessorArchitecture:
1614 strcpy(key_value, processor_arch);
1615 strcpy(key_name, "ProcessorArchitecture");
1618 hv_msg->error = HV_S_CONT;
1623 * Send the value back to the kernel. Note: the write() may
1624 * return an error due to hibernation; we can ignore the error
1625 * by resetting the dev file, i.e. closing and re-opening it.
1628 len = write(kvp_fd, hv_msg, sizeof(struct hv_kvp_msg));
1629 if (len != sizeof(struct hv_kvp_msg)) {
1630 syslog(LOG_ERR, "write failed; error: %d %s", errno,