sys/dev/hyperv/utilities/hv_shutdown.c

   1 /*-
   2  * Copyright (c) 2014,2016 Microsoft Corp.
   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 unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 /*
  30  * A common driver for all hyper-V util services.
  31  */
  32
  33 #include <sys/param.h>
  34 #include <sys/kernel.h>
  35 #include <sys/bus.h>
  36 #include <sys/malloc.h>
  37 #include <sys/module.h>
  38 #include <sys/reboot.h>
  39 #include <sys/timetc.h>
  40 #include <sys/syscallsubr.h>
  41 #include <sys/systm.h>
  42
  43 #include <dev/hyperv/include/hyperv.h>
  44 #include <dev/hyperv/include/vmbus.h>
  45 #include <dev/hyperv/utilities/hv_utilreg.h>
  46 #include "hv_util.h"
  47 #include "vmbus_if.h"
  48
  49 static const struct hyperv_guid service_guid = { .hv_guid =
  50         {0x31, 0x60, 0x0B, 0X0E, 0x13, 0x52, 0x34, 0x49,
  51         0x81, 0x8B, 0x38, 0XD9, 0x0C, 0xED, 0x39, 0xDB} };
  52
  53 /**
  54  * Shutdown
  55  */
  56 static void
  57 hv_shutdown_cb(struct vmbus_channel *channel, void *context)
  58 {
  59         uint8_t*                        buf;
  60         uint8_t                         execute_shutdown = 0;
  61         hv_vmbus_icmsg_hdr*             icmsghdrp;
  62         uint32_t                        recv_len;
  63         uint64_t                        request_id;
  64         int                             ret;
  65         hv_vmbus_shutdown_msg_data*     shutdown_msg;
  66         hv_util_sc                      *softc;
  67
  68         softc = (hv_util_sc*)context;
  69         buf = softc->receive_buffer;;
  70
  71         recv_len = PAGE_SIZE;
  72         ret = vmbus_chan_recv(channel, buf, &recv_len, &request_id);
  73         KASSERT(ret != ENOBUFS, ("hvshutdown recvbuf is not large enough"));
  74         /* XXX check recv_len to make sure that it contains enough data */
  75
  76         if ((ret == 0) && recv_len > 0) {
  77
  78             icmsghdrp = (struct hv_vmbus_icmsg_hdr *)
  79                 &buf[sizeof(struct hv_vmbus_pipe_hdr)];
  80
  81             if (icmsghdrp->icmsgtype == HV_ICMSGTYPE_NEGOTIATE) {
  82                 hv_negotiate_version(icmsghdrp, NULL, buf);
  83
  84             } else {
  85                 shutdown_msg =
  86                     (struct hv_vmbus_shutdown_msg_data *)
  87                     &buf[sizeof(struct hv_vmbus_pipe_hdr) +
  88                         sizeof(struct hv_vmbus_icmsg_hdr)];
  89
  90                 switch (shutdown_msg->flags) {
  91                     case 0:
  92                     case 1:
  93                         icmsghdrp->status = HV_S_OK;
  94                         execute_shutdown = 1;
  95                         if(bootverbose)
  96                             printf("Shutdown request received -"
  97                                     " graceful shutdown initiated\n");
  98                         break;
  99                     default:
 100                         icmsghdrp->status = HV_E_FAIL;
 101                         execute_shutdown = 0;
 102                         printf("Shutdown request received -"
 103                             " Invalid request\n");
 104                         break;
 105                     }
 106             }
 107
 108         icmsghdrp->icflags = HV_ICMSGHDRFLAG_TRANSACTION |
 109                                  HV_ICMSGHDRFLAG_RESPONSE;
 110
 111             vmbus_chan_send(channel, VMBUS_CHANPKT_TYPE_INBAND, 0,
 112                 buf, recv_len, request_id);
 113         }
 114
 115         if (execute_shutdown)
 116             shutdown_nice(RB_POWEROFF);
 117 }
 118
 119 static int
 120 hv_shutdown_probe(device_t dev)
 121 {
 122         if (resource_disabled("hvshutdown", 0))
 123                 return ENXIO;
 124
 125         if (VMBUS_PROBE_GUID(device_get_parent(dev), dev, &service_guid) == 0) {
 126                 device_set_desc(dev, "Hyper-V Shutdown Service");
 127                 return BUS_PROBE_DEFAULT;
 128         }
 129         return ENXIO;
 130 }
 131
 132 static int
 133 hv_shutdown_attach(device_t dev)
 134 {
 135         hv_util_sc *softc = (hv_util_sc*)device_get_softc(dev);
 136
 137         softc->callback = hv_shutdown_cb;
 138
 139         return hv_util_attach(dev);
 140 }
 141
 142 static device_method_t shutdown_methods[] = {
 143         /* Device interface */
 144         DEVMETHOD(device_probe, hv_shutdown_probe),
 145         DEVMETHOD(device_attach, hv_shutdown_attach),
 146         DEVMETHOD(device_detach, hv_util_detach),
 147         { 0, 0 }
 148 };
 149
 150 static driver_t shutdown_driver = { "hvshutdown", shutdown_methods, sizeof(hv_util_sc)};
 151
 152 static devclass_t shutdown_devclass;
 153
 154 DRIVER_MODULE(hv_shutdown, vmbus, shutdown_driver, shutdown_devclass, NULL, NULL);
 155 MODULE_VERSION(hv_shutdown, 1);
 156 MODULE_DEPEND(hv_shutdown, vmbus, 1, 1, 1);