sys/dev/hyperv/utilities/hv_kvp.h

   1 /*-
   2  * Copyright (c) 2009-2012 Microsoft Corp.
   3  * Copyright (c) 2012 NetApp Inc.
   4  * Copyright (c) 2012 Citrix Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice unmodified, this list of conditions, and the following
  12  *    disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28  */
  29
  30 #ifndef _KVP_H
  31 #define _KVP_H
  32
  33 /*
  34  * An implementation of HyperV key value pair (KVP) functionality for FreeBSD
  35  *
  36  */
  37
  38 /*
  39  * Maximum value size - used for both key names and value data, and includes
  40  * any applicable NULL terminators.
  41  *
  42  * Note:  This limit is somewhat arbitrary, but falls easily within what is
  43  * supported for all native guests (back to Win 2000) and what is reasonable
  44  * for the IC KVP exchange functionality.  Note that Windows Me/98/95 are
  45  * limited to 255 character key names.
  46  *
  47  * MSDN recommends not storing data values larger than 2048 bytes in the
  48  * registry.
  49  *
  50  * Note:  This value is used in defining the KVP exchange message - this value
  51  * cannot be modified without affecting the message size and compatibility.
  52  */
  53
  54 /*
  55  * bytes, including any null terminators
  56  */
  57 #define HV_KVP_EXCHANGE_MAX_VALUE_SIZE          (2048)
  58
  59
  60 /*
  61  * Maximum key size - the registry limit for the length of an entry name
  62  * is 256 characters, including the null terminator
  63  */
  64
  65 #define HV_KVP_EXCHANGE_MAX_KEY_SIZE            (512)
  66
  67 /*
  68  * In FreeBSD, we implement the KVP functionality in two components:
  69  * 1) The kernel component which is packaged as part of the hv_utils driver
  70  * is responsible for communicating with the host and responsible for
  71  * implementing the host/guest protocol. 2) A user level daemon that is
  72  * responsible for data gathering.
  73  *
  74  * Host/Guest Protocol: The host iterates over an index and expects the guest
  75  * to assign a key name to the index and also return the value corresponding to
  76  * the key. The host will have atmost one KVP transaction outstanding at any
  77  * given point in time. The host side iteration stops when the guest returns
  78  * an error. Microsoft has specified the following mapping of key names to
  79  * host specified index:
  80  *
  81  *  Index               Key Name
  82  *      0               FullyQualifiedDomainName
  83  *      1               IntegrationServicesVersion
  84  *      2               NetworkAddressIPv4
  85  *      3               NetworkAddressIPv6
  86  *      4               OSBuildNumber
  87  *      5               OSName
  88  *      6               OSMajorVersion
  89  *      7               OSMinorVersion
  90  *      8               OSVersion
  91  *      9               ProcessorArchitecture
  92  *
  93  * The Windows host expects the Key Name and Key Value to be encoded in utf16.
  94  *
  95  * Guest Kernel/KVP Daemon Protocol: As noted earlier, we implement all of the
  96  * data gathering functionality in a user mode daemon. The user level daemon
  97  * is also responsible for binding the key name to the index as well. The
  98  * kernel and user-level daemon communicate using a connector channel.
  99  *
 100  * The user mode component first registers with the
 101  * the kernel component. Subsequently, the kernel component requests, data
 102  * for the specified keys. In response to this message the user mode component
 103  * fills in the value corresponding to the specified key. We overload the
 104  * sequence field in the cn_msg header to define our KVP message types.
 105  *
 106  *
 107  * The kernel component simply acts as a conduit for communication between the
 108  * Windows host and the user-level daemon. The kernel component passes up the
 109  * index received from the Host to the user-level daemon. If the index is
 110  * valid (supported), the corresponding key as well as its
 111  * value (both are strings) is returned. If the index is invalid
 112  * (not supported), a NULL key string is returned.
 113  */
 114
 115
 116 /*
 117  * Registry value types.
 118  */
 119
 120 #define HV_REG_SZ  1
 121 #define HV_REG_U32 4
 122 #define HV_REG_U64 8
 123
 124
 125 /*
 126  * Daemon code not supporting IP injection (legacy daemon).
 127  */
 128
 129 #define HV_KVP_OP_REGISTER      4
 130
 131 /*
 132  * Daemon code supporting IP injection.
 133  * The KVP opcode field is used to communicate the
 134  * registration information; so define a namespace that
 135  * will be distinct from the host defined KVP opcode.
 136  */
 137
 138 #define KVP_OP_REGISTER1 100
 139
 140 enum hv_kvp_exchg_op {
 141         HV_KVP_OP_GET = 0,
 142         HV_KVP_OP_SET,
 143         HV_KVP_OP_DELETE,
 144         HV_KVP_OP_ENUMERATE,
 145         HV_KVP_OP_GET_IP_INFO,
 146         HV_KVP_OP_SET_IP_INFO,
 147         HV_KVP_OP_COUNT /* Number of operations, must be last. */
 148 };
 149
 150 enum hv_kvp_exchg_pool {
 151         HV_KVP_POOL_EXTERNAL = 0,
 152         HV_KVP_POOL_GUEST,
 153         HV_KVP_POOL_AUTO,
 154         HV_KVP_POOL_AUTO_EXTERNAL,
 155         HV_KVP_POOL_AUTO_INTERNAL,
 156         HV_KVP_POOL_COUNT /* Number of pools, must be last. */
 157 };
 158
 159 /*
 160  * Some Hyper-V status codes.
 161  */
 162 #define HV_KVP_S_OK                             0x00000000
 163 #define HV_KVP_E_FAIL                   0x80004005
 164 #define HV_KVP_S_CONT                   0x80070103
 165 #define HV_ERROR_NOT_SUPPORTED          0x80070032
 166 #define HV_ERROR_MACHINE_LOCKED         0x800704F7
 167 #define HV_ERROR_DEVICE_NOT_CONNECTED   0x8007048F
 168 #define HV_INVALIDARG                   0x80070057
 169 #define HV_KVP_GUID_NOTFOUND            0x80041002
 170
 171 #define ADDR_FAMILY_NONE        0x00
 172 #define ADDR_FAMILY_IPV4        0x01
 173 #define ADDR_FAMILY_IPV6        0x02
 174
 175 #define MAX_ADAPTER_ID_SIZE     128
 176 #define MAX_IP_ADDR_SIZE        1024
 177 #define MAX_GATEWAY_SIZE        512
 178
 179
 180 struct hv_kvp_ipaddr_value {
 181         uint16_t        adapter_id[MAX_ADAPTER_ID_SIZE];
 182         uint8_t addr_family;
 183         uint8_t dhcp_enabled;
 184         uint16_t        ip_addr[MAX_IP_ADDR_SIZE];
 185         uint16_t        sub_net[MAX_IP_ADDR_SIZE];
 186         uint16_t        gate_way[MAX_GATEWAY_SIZE];
 187         uint16_t        dns_addr[MAX_IP_ADDR_SIZE];
 188 } __attribute__((packed));
 189
 190
 191 struct hv_kvp_hdr {
 192         uint8_t operation;
 193         uint8_t pool;
 194         uint16_t pad;
 195 } __attribute__((packed));
 196
 197 struct hv_kvp_exchg_msg_value {
 198         uint32_t value_type;
 199         uint32_t key_size;
 200         uint32_t value_size;
 201         uint8_t key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
 202         union {
 203                 uint8_t value[HV_KVP_EXCHANGE_MAX_VALUE_SIZE];
 204                 uint32_t value_u32;
 205                 uint64_t value_u64;
 206         } msg_value;
 207 } __attribute__((packed));
 208
 209 struct hv_kvp_msg_enumerate {
 210         uint32_t index;
 211         struct hv_kvp_exchg_msg_value data;
 212 } __attribute__((packed));
 213
 214 struct hv_kvp_msg_get {
 215         struct hv_kvp_exchg_msg_value data;
 216 } __attribute__((packed));
 217
 218 struct hv_kvp_msg_set {
 219         struct hv_kvp_exchg_msg_value data;
 220 } __attribute__((packed));
 221
 222 struct hv_kvp_msg_delete {
 223         uint32_t key_size;
 224         uint8_t key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
 225 } __attribute__((packed));
 226
 227 struct hv_kvp_register {
 228         uint8_t version[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
 229 } __attribute__((packed));
 230
 231 struct hv_kvp_msg {
 232         union {
 233                 struct hv_kvp_hdr       kvp_hdr;
 234                 int error;
 235         } hdr;
 236         union {
 237                 struct hv_kvp_msg_get   kvp_get;
 238                 struct hv_kvp_msg_set   kvp_set;
 239                 struct hv_kvp_msg_delete        kvp_delete;
 240                 struct hv_kvp_msg_enumerate     kvp_enum_data;
 241                 struct hv_kvp_ipaddr_value  kvp_ip_val;
 242                 struct hv_kvp_register  kvp_register;
 243         } body;
 244 } __attribute__((packed));
 245
 246 struct hv_kvp_ip_msg {
 247         uint8_t operation;
 248         uint8_t pool;
 249         struct hv_kvp_ipaddr_value      kvp_ip_val;
 250 } __attribute__((packed));
 251
 252 #define BSD_SOC_PATH "/etc/hyperv/socket"
 253
 254 #define HV_SHUT_DOWN            0
 255 #define HV_TIME_SYNCH           1
 256 #define HV_HEART_BEAT           2
 257 #define HV_KVP                  3
 258 #define HV_MAX_UTIL_SERVICES    4
 259
 260 #define HV_WLTIMEDELTA                  116444736000000000L /* in 100ns unit */
 261 #define HV_ICTIMESYNCFLAG_PROBE         0
 262 #define HV_ICTIMESYNCFLAG_SYNC          1
 263 #define HV_ICTIMESYNCFLAG_SAMPLE        2
 264 #define HV_NANO_SEC_PER_SEC             1000000000
 265
 266 typedef struct hv_vmbus_service {
 267         hv_guid         guid;           /* Hyper-V GUID */
 268        char*                    name;           /* name of service */
 269        boolean_t                enabled;        /* service enabled */
 270        hv_work_queue*   work_queue;     /* background work queue */
 271
 272         //
 273         // function to initialize service
 274         //
 275        int (*init)(struct hv_vmbus_service *);
 276
 277         //
 278         // function to process Hyper-V messages
 279         //
 280        void (*callback)(void *);
 281 } hv_vmbus_service;
 282
 283 extern uint8_t* receive_buffer[];
 284 extern hv_vmbus_service service_table[];
 285
 286 #endif /* _KVP_H */