1 /*- 2 * Copyright (c) 2010 Justin T. Gibbs, Spectra Logic Corporation 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions, and the following disclaimer, 10 * without modification. 11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12 * substantially similar to the "NO WARRANTY" disclaimer below 13 * ("Disclaimer") and any redistribution must be conditioned upon 14 * including a substantially similar Disclaimer requirement for further 15 * binary redistribution. 16 * 17 * NO WARRANTY 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGES. 29 */ 30 31 /*- 32 * PV suspend/resume support: 33 * 34 * Copyright (c) 2004 Christian Limpach. 35 * Copyright (c) 2004-2006,2008 Kip Macy 36 * All rights reserved. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 1. Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * 2. Redistributions in binary form must reproduce the above copyright 44 * notice, this list of conditions and the following disclaimer in the 45 * documentation and/or other materials provided with the distribution. 46 * 3. All advertising materials mentioning features or use of this software 47 * must display the following acknowledgement: 48 * This product includes software developed by Christian Limpach. 49 * 4. The name of the author may not be used to endorse or promote products 50 * derived from this software without specific prior written permission. 51 * 52 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 53 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 54 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 55 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 56 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 57 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 61 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 62 */ 63 64 /*- 65 * HVM suspend/resume support: 66 * 67 * Copyright (c) 2008 Citrix Systems, Inc. 68 * All rights reserved. 69 * 70 * Redistribution and use in source and binary forms, with or without 71 * modification, are permitted provided that the following conditions 72 * are met: 73 * 1. Redistributions of source code must retain the above copyright 74 * notice, this list of conditions and the following disclaimer. 75 * 2. Redistributions in binary form must reproduce the above copyright 76 * notice, this list of conditions and the following disclaimer in the 77 * documentation and/or other materials provided with the distribution. 78 * 79 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 80 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 81 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 82 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 83 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 84 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 85 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 86 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 87 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 88 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 89 * SUCH DAMAGE. 90 */ 91 #include <sys/cdefs.h> 92 __FBSDID("$FreeBSD$"); 93 94 /** 95 * \file control.c 96 * 97 * \brief Device driver to repond to control domain events that impact 98 * this VM. 99 */ 100 101 #include <sys/param.h> 102 #include <sys/systm.h> 103 #include <sys/kernel.h> 104 #include <sys/malloc.h> 105 106 #include <sys/bio.h> 107 #include <sys/bus.h> 108 #include <sys/conf.h> 109 #include <sys/disk.h> 110 #include <sys/fcntl.h> 111 #include <sys/filedesc.h> 112 #include <sys/kdb.h> 113 #include <sys/module.h> 114 #include <sys/namei.h> 115 #include <sys/proc.h> 116 #include <sys/reboot.h> 117 #include <sys/rman.h> 118 #include <sys/taskqueue.h> 119 #include <sys/types.h> 120 #include <sys/vnode.h> 121 122 #ifndef XENHVM 123 #include <sys/sched.h> 124 #include <sys/smp.h> 125 #endif 126 127 128 #include <geom/geom.h> 129 130 #include <machine/_inttypes.h> 131 #include <machine/xen/xen-os.h> 132 133 #include <vm/vm.h> 134 #include <vm/vm_extern.h> 135 #include <vm/vm_kern.h> 136 137 #include <xen/blkif.h> 138 #include <xen/evtchn.h> 139 #include <xen/gnttab.h> 140 #include <xen/xen_intr.h> 141 142 #include <xen/interface/event_channel.h> 143 #include <xen/interface/grant_table.h> 144 145 #include <xen/xenbus/xenbusvar.h> 146 147 #define NUM_ELEMENTS(x) (sizeof(x) / sizeof(*(x))) 148 149 /*--------------------------- Forward Declarations --------------------------*/ 150 /** Function signature for shutdown event handlers. */ 151 typedef void (xctrl_shutdown_handler_t)(void); 152 153 static xctrl_shutdown_handler_t xctrl_poweroff; 154 static xctrl_shutdown_handler_t xctrl_reboot; 155 static xctrl_shutdown_handler_t xctrl_suspend; 156 static xctrl_shutdown_handler_t xctrl_crash; 157 static xctrl_shutdown_handler_t xctrl_halt; 158 159 /*-------------------------- Private Data Structures -------------------------*/ 160 /** Element type for lookup table of event name to handler. */ 161 struct xctrl_shutdown_reason { 162 const char *name; 163 xctrl_shutdown_handler_t *handler; 164 }; 165 166 /** Lookup table for shutdown event name to handler. */ 167 static struct xctrl_shutdown_reason xctrl_shutdown_reasons[] = { 168 { "poweroff", xctrl_poweroff }, 169 { "reboot", xctrl_reboot }, 170 { "suspend", xctrl_suspend }, 171 { "crash", xctrl_crash }, 172 { "halt", xctrl_halt }, 173 }; 174 175 struct xctrl_softc { 176 struct xs_watch xctrl_watch; 177 }; 178 179 /*------------------------------ Event Handlers ------------------------------*/ 180 static void 181 xctrl_poweroff() 182 { 183 shutdown_nice(RB_POWEROFF|RB_HALT); 184 } 185 186 static void 187 xctrl_reboot() 188 { 189 shutdown_nice(0); 190 } 191 192 #ifndef XENHVM 193 extern void xencons_suspend(void); 194 extern void xencons_resume(void); 195 196 /* Full PV mode suspension. */ 197 static void 198 xctrl_suspend() 199 { 200 u_int cpuid; 201 int i, j, k, fpp; 202 unsigned long max_pfn, start_info_mfn; 203 204 #ifdef SMP 205 struct thread *td; 206 cpuset_t map; 207 /* 208 * Bind us to CPU 0 and stop any other VCPUs. 209 */ 210 td = curthread; 211 thread_lock(td); 212 sched_bind(td, 0); 213 thread_unlock(td); 214 cpuid = PCPU_GET(cpuid); 215 KASSERT(cpuid == 0, ("xen_suspend: not running on cpu 0")); 216 217 map = all_cpus; 218 CPU_CLR(cpuid, &map); 219 CPU_NAND(&map, &stopped_cpus); 220 if (!CPU_EMPTY(&map)) 221 stop_cpus(map); 222 #endif 223 224 if (DEVICE_SUSPEND(root_bus) != 0) { 225 printf("xen_suspend: device_suspend failed\n"); 226 #ifdef SMP 227 if (!CPU_EMPTY(&map)) 228 restart_cpus(map); 229 #endif 230 return; 231 } 232 233 local_irq_disable(); 234 235 xencons_suspend(); 236 gnttab_suspend(); 237 238 max_pfn = HYPERVISOR_shared_info->arch.max_pfn; 239 240 void *shared_info = HYPERVISOR_shared_info; 241 HYPERVISOR_shared_info = NULL; 242 pmap_kremove((vm_offset_t) shared_info); 243 PT_UPDATES_FLUSH(); 244 245 xen_start_info->store_mfn = MFNTOPFN(xen_start_info->store_mfn); 246 xen_start_info->console.domU.mfn = MFNTOPFN(xen_start_info->console.domU.mfn); 247 248 /* 249 * We'll stop somewhere inside this hypercall. When it returns, 250 * we'll start resuming after the restore. 251 */ 252 start_info_mfn = VTOMFN(xen_start_info); 253 pmap_suspend(); 254 HYPERVISOR_suspend(start_info_mfn); 255 pmap_resume(); 256 257 pmap_kenter_ma((vm_offset_t) shared_info, xen_start_info->shared_info); 258 HYPERVISOR_shared_info = shared_info; 259 260 HYPERVISOR_shared_info->arch.pfn_to_mfn_frame_list_list = 261 VTOMFN(xen_pfn_to_mfn_frame_list_list); 262 263 fpp = PAGE_SIZE/sizeof(unsigned long); 264 for (i = 0, j = 0, k = -1; i < max_pfn; i += fpp, j++) { 265 if ((j % fpp) == 0) { 266 k++; 267 xen_pfn_to_mfn_frame_list_list[k] = 268 VTOMFN(xen_pfn_to_mfn_frame_list[k]); 269 j = 0; 270 } 271 xen_pfn_to_mfn_frame_list[k][j] = 272 VTOMFN(&xen_phys_machine[i]); 273 } 274 HYPERVISOR_shared_info->arch.max_pfn = max_pfn; 275 276 gnttab_resume(); 277 irq_resume(); 278 local_irq_enable(); 279 xencons_resume(); 280 281 #ifdef CONFIG_SMP 282 for_each_cpu(i) 283 vcpu_prepare(i); 284 285 #endif 286 /* 287 * Only resume xenbus /after/ we've prepared our VCPUs; otherwise 288 * the VCPU hotplug callback can race with our vcpu_prepare 289 */ 290 DEVICE_RESUME(root_bus); 291 292 #ifdef SMP 293 thread_lock(curthread); 294 sched_unbind(curthread); 295 thread_unlock(curthread); 296 if (!CPU_EMPTY(&map)) 297 restart_cpus(map); 298 #endif 299 } 300 301 static void 302 xen_pv_shutdown_final(void *arg, int howto) 303 { 304 /* 305 * Inform the hypervisor that shutdown is complete. 306 * This is not necessary in HVM domains since Xen 307 * emulates ACPI in that mode and FreeBSD's ACPI 308 * support will request this transition. 309 */ 310 if (howto & (RB_HALT | RB_POWEROFF)) 311 HYPERVISOR_shutdown(SHUTDOWN_poweroff); 312 else 313 HYPERVISOR_shutdown(SHUTDOWN_reboot); 314 } 315 316 #else 317 extern void xenpci_resume(void); 318 319 /* HVM mode suspension. */ 320 static void 321 xctrl_suspend() 322 { 323 int suspend_cancelled; 324 325 if (DEVICE_SUSPEND(root_bus)) { 326 printf("xen_suspend: device_suspend failed\n"); 327 return; 328 } 329 330 /* 331 * Make sure we don't change cpus or switch to some other 332 * thread. for the duration. 333 */ 334 critical_enter(); 335 336 /* 337 * Prevent any races with evtchn_interrupt() handler. 338 */ 339 irq_suspend(); 340 disable_intr(); 341 342 suspend_cancelled = HYPERVISOR_suspend(0); 343 if (!suspend_cancelled) 344 xenpci_resume(); 345 346 /* 347 * Re-enable interrupts and put the scheduler back to normal. 348 */ 349 enable_intr(); 350 critical_exit(); 351 352 /* 353 * FreeBSD really needs to add DEVICE_SUSPEND_CANCEL or 354 * similar. 355 */ 356 if (!suspend_cancelled) 357 DEVICE_RESUME(root_bus); 358 } 359 #endif 360 361 static void 362 xctrl_crash() 363 { 364 panic("Xen directed crash"); 365 } 366 367 static void 368 xctrl_halt() 369 { 370 shutdown_nice(RB_HALT); 371 } 372 373 /*------------------------------ Event Reception -----------------------------*/ 374 static void 375 xctrl_on_watch_event(struct xs_watch *watch, const char **vec, unsigned int len) 376 { 377 struct xctrl_shutdown_reason *reason; 378 struct xctrl_shutdown_reason *last_reason; 379 char *result; 380 int error; 381 int result_len; 382 383 error = xs_read(XST_NIL, "control", "shutdown", 384 &result_len, (void **)&result); 385 if (error != 0) 386 return; 387 388 reason = xctrl_shutdown_reasons; 389 last_reason = reason + NUM_ELEMENTS(xctrl_shutdown_reasons); 390 while (reason < last_reason) { 391 392 if (!strcmp(result, reason->name)) { 393 reason->handler(); 394 break; 395 } 396 reason++; 397 } 398 399 free(result, M_XENSTORE); 400 } 401 402 /*------------------ Private Device Attachment Functions --------------------*/ 403 /** 404 * \brief Identify instances of this device type in the system. 405 * 406 * \param driver The driver performing this identify action. 407 * \param parent The NewBus parent device for any devices this method adds. 408 */ 409 static void 410 xctrl_identify(driver_t *driver __unused, device_t parent) 411 { 412 /* 413 * A single device instance for our driver is always present 414 * in a system operating under Xen. 415 */ 416 BUS_ADD_CHILD(parent, 0, driver->name, 0); 417 } 418 419 /** 420 * \brief Probe for the existance of the Xen Control device 421 * 422 * \param dev NewBus device_t for this Xen control instance. 423 * 424 * \return Always returns 0 indicating success. 425 */ 426 static int 427 xctrl_probe(device_t dev) 428 { 429 device_set_desc(dev, "Xen Control Device"); 430 431 return (0); 432 } 433 434 /** 435 * \brief Attach the Xen control device. 436 * 437 * \param dev NewBus device_t for this Xen control instance. 438 * 439 * \return On success, 0. Otherwise an errno value indicating the 440 * type of failure. 441 */ 442 static int 443 xctrl_attach(device_t dev) 444 { 445 struct xctrl_softc *xctrl; 446 447 xctrl = device_get_softc(dev); 448 449 /* Activate watch */ 450 xctrl->xctrl_watch.node = "control/shutdown"; 451 xctrl->xctrl_watch.callback = xctrl_on_watch_event; 452 xctrl->xctrl_watch.callback_data = (uintptr_t)xctrl; 453 xs_register_watch(&xctrl->xctrl_watch); 454 455 #ifndef XENHVM 456 EVENTHANDLER_REGISTER(shutdown_final, xen_pv_shutdown_final, NULL, 457 SHUTDOWN_PRI_LAST); 458 #endif 459 460 return (0); 461 } 462 463 /** 464 * \brief Detach the Xen control device. 465 * 466 * \param dev NewBus device_t for this Xen control device instance. 467 * 468 * \return On success, 0. Otherwise an errno value indicating the 469 * type of failure. 470 */ 471 static int 472 xctrl_detach(device_t dev) 473 { 474 struct xctrl_softc *xctrl; 475 476 xctrl = device_get_softc(dev); 477 478 /* Release watch */ 479 xs_unregister_watch(&xctrl->xctrl_watch); 480 481 return (0); 482 } 483 484 /*-------------------- Private Device Attachment Data -----------------------*/ 485 static device_method_t xctrl_methods[] = { 486 /* Device interface */ 487 DEVMETHOD(device_identify, xctrl_identify), 488 DEVMETHOD(device_probe, xctrl_probe), 489 DEVMETHOD(device_attach, xctrl_attach), 490 DEVMETHOD(device_detach, xctrl_detach), 491 492 { 0, 0 } 493 }; 494 495 DEFINE_CLASS_0(xctrl, xctrl_driver, xctrl_methods, sizeof(struct xctrl_softc)); 496 devclass_t xctrl_devclass; 497 498 DRIVER_MODULE(xctrl, xenstore, xctrl_driver, xctrl_devclass, 0, 0); 499