1 /* 2 * QTest migration utilities 3 * 4 * Copyright (c) 2016-2018 Red Hat, Inc. and/or its affiliates 5 * based on the vhost-user-test.c that is: 6 * Copyright (c) 2014 Virtual Open Systems Sarl. 7 * 8 * This work is licensed under the terms of the GNU GPL, version 2 or later. 9 * See the COPYING file in the top-level directory. 10 * 11 */ 12 13 #include "qemu/osdep.h" 14 #include "qemu/ctype.h" 15 #include "qapi/qapi-visit-sockets.h" 16 #include "qapi/qobject-input-visitor.h" 17 #include "qapi/error.h" 18 #include "qapi/qmp/qlist.h" 19 #include "qemu/cutils.h" 20 #include "qemu/memalign.h" 21 22 #include "migration/bootfile.h" 23 #include "migration/migration-util.h" 24 25 #if defined(__linux__) 26 #include <sys/ioctl.h> 27 #include <sys/syscall.h> 28 #endif 29 30 /* for uffd_version_check() */ 31 #if defined(__linux__) && defined(__NR_userfaultfd) && defined(CONFIG_EVENTFD) 32 #include <sys/eventfd.h> 33 #include "qemu/userfaultfd.h" 34 #endif 35 36 /* For dirty ring test; so far only x86_64 is supported */ 37 #if defined(__linux__) && defined(HOST_X86_64) 38 #include "linux/kvm.h" 39 #endif 40 41 42 static char *SocketAddress_to_str(SocketAddress *addr) 43 { 44 switch (addr->type) { 45 case SOCKET_ADDRESS_TYPE_INET: 46 return g_strdup_printf("tcp:%s:%s", 47 addr->u.inet.host, 48 addr->u.inet.port); 49 case SOCKET_ADDRESS_TYPE_UNIX: 50 return g_strdup_printf("unix:%s", 51 addr->u.q_unix.path); 52 case SOCKET_ADDRESS_TYPE_FD: 53 return g_strdup_printf("fd:%s", addr->u.fd.str); 54 case SOCKET_ADDRESS_TYPE_VSOCK: 55 return g_strdup_printf("vsock:%s:%s", 56 addr->u.vsock.cid, 57 addr->u.vsock.port); 58 default: 59 return g_strdup("unknown address type"); 60 } 61 } 62 63 static QDict *SocketAddress_to_qdict(SocketAddress *addr) 64 { 65 QDict *dict = qdict_new(); 66 67 switch (addr->type) { 68 case SOCKET_ADDRESS_TYPE_INET: 69 qdict_put_str(dict, "type", "inet"); 70 qdict_put_str(dict, "host", addr->u.inet.host); 71 qdict_put_str(dict, "port", addr->u.inet.port); 72 break; 73 case SOCKET_ADDRESS_TYPE_UNIX: 74 qdict_put_str(dict, "type", "unix"); 75 qdict_put_str(dict, "path", addr->u.q_unix.path); 76 break; 77 case SOCKET_ADDRESS_TYPE_FD: 78 qdict_put_str(dict, "type", "fd"); 79 qdict_put_str(dict, "str", addr->u.fd.str); 80 break; 81 case SOCKET_ADDRESS_TYPE_VSOCK: 82 qdict_put_str(dict, "type", "vsock"); 83 qdict_put_str(dict, "cid", addr->u.vsock.cid); 84 qdict_put_str(dict, "port", addr->u.vsock.port); 85 break; 86 default: 87 g_assert_not_reached(); 88 } 89 90 return dict; 91 } 92 93 static SocketAddressList *migrate_get_socket_address(QTestState *who) 94 { 95 QDict *rsp; 96 SocketAddressList *addrs; 97 Visitor *iv = NULL; 98 QObject *object; 99 100 rsp = migrate_query(who); 101 object = qdict_get(rsp, "socket-address"); 102 103 iv = qobject_input_visitor_new(object); 104 visit_type_SocketAddressList(iv, NULL, &addrs, &error_abort); 105 visit_free(iv); 106 107 qobject_unref(rsp); 108 return addrs; 109 } 110 111 char *migrate_get_connect_uri(QTestState *who) 112 { 113 SocketAddressList *addrs; 114 char *connect_uri; 115 116 addrs = migrate_get_socket_address(who); 117 connect_uri = SocketAddress_to_str(addrs->value); 118 119 qapi_free_SocketAddressList(addrs); 120 return connect_uri; 121 } 122 123 static QDict * 124 migrate_get_connect_qdict(QTestState *who) 125 { 126 SocketAddressList *addrs; 127 QDict *connect_qdict; 128 129 addrs = migrate_get_socket_address(who); 130 connect_qdict = SocketAddress_to_qdict(addrs->value); 131 132 qapi_free_SocketAddressList(addrs); 133 return connect_qdict; 134 } 135 136 void migrate_set_ports(QTestState *to, QList *channel_list) 137 { 138 QDict *addr; 139 QListEntry *entry; 140 const char *addr_port = NULL; 141 142 addr = migrate_get_connect_qdict(to); 143 144 QLIST_FOREACH_ENTRY(channel_list, entry) { 145 QDict *channel = qobject_to(QDict, qlist_entry_obj(entry)); 146 QDict *addrdict = qdict_get_qdict(channel, "addr"); 147 148 if (qdict_haskey(addrdict, "port") && 149 qdict_haskey(addr, "port") && 150 (strcmp(qdict_get_str(addrdict, "port"), "0") == 0)) { 151 addr_port = qdict_get_str(addr, "port"); 152 qdict_put_str(addrdict, "port", addr_port); 153 } 154 } 155 156 qobject_unref(addr); 157 } 158 159 bool migrate_watch_for_events(QTestState *who, const char *name, 160 QDict *event, void *opaque) 161 { 162 QTestMigrationState *state = opaque; 163 164 if (g_str_equal(name, "STOP")) { 165 state->stop_seen = true; 166 return true; 167 } else if (g_str_equal(name, "SUSPEND")) { 168 state->suspend_seen = true; 169 return true; 170 } else if (g_str_equal(name, "RESUME")) { 171 state->resume_seen = true; 172 return true; 173 } 174 175 return false; 176 } 177 178 char *find_common_machine_version(const char *mtype, const char *var1, 179 const char *var2) 180 { 181 g_autofree char *type1 = qtest_resolve_machine_alias(var1, mtype); 182 g_autofree char *type2 = qtest_resolve_machine_alias(var2, mtype); 183 184 g_assert(type1 && type2); 185 186 if (g_str_equal(type1, type2)) { 187 /* either can be used */ 188 return g_strdup(type1); 189 } 190 191 if (qtest_has_machine_with_env(var2, type1)) { 192 return g_strdup(type1); 193 } 194 195 if (qtest_has_machine_with_env(var1, type2)) { 196 return g_strdup(type2); 197 } 198 199 g_test_message("No common machine version for machine type '%s' between " 200 "binaries %s and %s", mtype, getenv(var1), getenv(var2)); 201 g_assert_not_reached(); 202 } 203 204 char *resolve_machine_version(const char *alias, const char *var1, 205 const char *var2) 206 { 207 const char *mname = g_getenv("QTEST_QEMU_MACHINE_TYPE"); 208 g_autofree char *machine_name = NULL; 209 210 if (mname) { 211 const char *dash = strrchr(mname, '-'); 212 const char *dot = strrchr(mname, '.'); 213 214 machine_name = g_strdup(mname); 215 216 if (dash && dot) { 217 assert(qtest_has_machine(machine_name)); 218 return g_steal_pointer(&machine_name); 219 } 220 /* else: probably an alias, let it be resolved below */ 221 } else { 222 /* use the hardcoded alias */ 223 machine_name = g_strdup(alias); 224 } 225 226 return find_common_machine_version(machine_name, var1, var2); 227 } 228 229 typedef struct { 230 char *name; 231 void (*func)(void); 232 } MigrationTest; 233 234 static void migration_test_destroy(gpointer data) 235 { 236 MigrationTest *test = (MigrationTest *)data; 237 238 g_free(test->name); 239 g_free(test); 240 } 241 242 static void migration_test_wrapper(const void *data) 243 { 244 MigrationTest *test = (MigrationTest *)data; 245 246 g_test_message("Running /%s%s", qtest_get_arch(), test->name); 247 test->func(); 248 } 249 250 void migration_test_add(const char *path, void (*fn)(void)) 251 { 252 MigrationTest *test = g_new0(MigrationTest, 1); 253 254 test->func = fn; 255 test->name = g_strdup(path); 256 257 qtest_add_data_func_full(path, test, migration_test_wrapper, 258 migration_test_destroy); 259 } 260 261 #ifdef O_DIRECT 262 /* 263 * Probe for O_DIRECT support on the filesystem. Since this is used 264 * for tests, be conservative, if anything fails, assume it's 265 * unsupported. 266 */ 267 bool probe_o_direct_support(const char *tmpfs) 268 { 269 g_autofree char *filename = g_strdup_printf("%s/probe-o-direct", tmpfs); 270 int fd, flags = O_CREAT | O_RDWR | O_TRUNC | O_DIRECT; 271 void *buf; 272 ssize_t ret, len; 273 uint64_t offset; 274 275 fd = open(filename, flags, 0660); 276 if (fd < 0) { 277 unlink(filename); 278 return false; 279 } 280 281 /* 282 * Using 1MB alignment as conservative choice to satisfy any 283 * plausible architecture default page size, and/or filesystem 284 * alignment restrictions. 285 */ 286 len = 0x100000; 287 offset = 0x100000; 288 289 buf = qemu_try_memalign(len, len); 290 g_assert(buf); 291 memset(buf, 0, len); 292 293 ret = pwrite(fd, buf, len, offset); 294 unlink(filename); 295 g_free(buf); 296 297 if (ret < 0) { 298 return false; 299 } 300 301 return true; 302 } 303 #endif 304 305 #if defined(__linux__) && defined(__NR_userfaultfd) && defined(CONFIG_EVENTFD) 306 bool ufd_version_check(bool *uffd_feature_thread_id) 307 { 308 struct uffdio_api api_struct; 309 uint64_t ioctl_mask; 310 311 int ufd = uffd_open(O_CLOEXEC); 312 313 if (ufd == -1) { 314 g_test_message("Skipping test: userfaultfd not available"); 315 return false; 316 } 317 318 api_struct.api = UFFD_API; 319 api_struct.features = 0; 320 if (ioctl(ufd, UFFDIO_API, &api_struct)) { 321 g_test_message("Skipping test: UFFDIO_API failed"); 322 return false; 323 } 324 325 if (uffd_feature_thread_id) { 326 *uffd_feature_thread_id = api_struct.features & UFFD_FEATURE_THREAD_ID; 327 } 328 329 ioctl_mask = (1ULL << _UFFDIO_REGISTER | 330 1ULL << _UFFDIO_UNREGISTER); 331 if ((api_struct.ioctls & ioctl_mask) != ioctl_mask) { 332 g_test_message("Skipping test: Missing userfault feature"); 333 return false; 334 } 335 336 return true; 337 } 338 #else 339 bool ufd_version_check(bool *uffd_feature_thread_id) 340 { 341 g_test_message("Skipping test: Userfault not available (builtdtime)"); 342 return false; 343 } 344 #endif 345 346 bool kvm_dirty_ring_supported(void) 347 { 348 #if defined(__linux__) && defined(HOST_X86_64) 349 int ret, kvm_fd = open("/dev/kvm", O_RDONLY); 350 351 if (kvm_fd < 0) { 352 return false; 353 } 354 355 ret = ioctl(kvm_fd, KVM_CHECK_EXTENSION, KVM_CAP_DIRTY_LOG_RING); 356 close(kvm_fd); 357 358 /* We test with 4096 slots */ 359 if (ret < 4096) { 360 return false; 361 } 362 363 return true; 364 #else 365 return false; 366 #endif 367 } 368