kernel/cpr/cpr_mod.c

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  * Copyright (c) 2011 Bayard G. Bell. All rights reserved.
  25  * Copyright 2012 Milan Jurik. All rights reserved.
  26  */
  27
  28 /*
  29  * System call to checkpoint and resume the currently running kernel
  30  */
  31 #include <sys/types.h>
  32 #include <sys/errno.h>
  33 #include <sys/modctl.h>
  34 #include <sys/syscall.h>
  35 #include <sys/cred.h>
  36 #include <sys/uadmin.h>
  37 #include <sys/cmn_err.h>
  38 #include <sys/systm.h>
  39 #include <sys/cpr.h>
  40 #include <sys/swap.h>
  41 #include <sys/vfs.h>
  42 #include <sys/autoconf.h>
  43 #include <sys/machsystm.h>
  44
  45 extern int i_cpr_is_supported(int sleeptype);
  46 extern int cpr_is_ufs(struct vfs *);
  47 extern int cpr_is_zfs(struct vfs *);
  48 extern int cpr_check_spec_statefile(void);
  49 extern int cpr_reusable_mount_check(void);
  50 extern int i_cpr_reusable_supported(void);
  51 extern int i_cpr_reusefini(void);
  52 extern struct mod_ops mod_miscops;
  53
  54 extern int cpr_init(int);
  55 extern void cpr_done(void);
  56 extern void i_cpr_stop_other_cpus(void);
  57 extern int i_cpr_power_down(int);
  58
  59
  60 static struct modlmisc modlmisc = {
  61         &mod_miscops, "checkpoint resume"
  62 };
  63
  64 static struct modlinkage modlinkage = {
  65         MODREV_1, (void *)&modlmisc, NULL
  66 };
  67
  68 int cpr_reusable_mode;
  69
  70 kmutex_t        cpr_slock;      /* cpr serial lock */
  71 cpr_t           cpr_state;
  72 int             cpr_debug;
  73 int             cpr_test_mode; /* true if called via uadmin testmode */
  74 int             cpr_test_point = LOOP_BACK_NONE;        /* cpr test point */
  75 int             cpr_mp_enable = 0;      /* set to 1 to enable MP suspend */
  76 major_t         cpr_device = 0;         /* major number for S3 on one device */
  77
  78 /*
  79  * All the loadable module related code follows
  80  */
  81 int
  82 _init(void)
  83 {
  84         register int e;
  85
  86         if ((e = mod_install(&modlinkage)) == 0) {
  87                 mutex_init(&cpr_slock, NULL, MUTEX_DEFAULT, NULL);
  88         }
  89         return (e);
  90 }
  91
  92 int
  93 _fini(void)
  94 {
  95         register int e;
  96
  97         if ((e = mod_remove(&modlinkage)) == 0) {
  98                 mutex_destroy(&cpr_slock);
  99         }
 100         return (e);
 101 }
 102
 103 int
 104 _info(struct modinfo *modinfop)
 105 {
 106         return (mod_info(&modlinkage, modinfop));
 107 }
 108
 109 static
 110 int
 111 atoi(char *p)
 112 {
 113         int     i;
 114
 115         i = (*p++ - '0');
 116
 117         while (*p != '\0')
 118                 i = 10 * i + (*p++ - '0');
 119
 120         return (i);
 121 }
 122
 123 int
 124 cpr(int fcn, void *mdep)
 125 {
 126
 127         register int rc = 0;
 128         int cpr_sleeptype;
 129
 130         /*
 131          * First, reject commands that we don't (yet) support on this arch.
 132          * This is easier to understand broken out like this than grotting
 133          * through the second switch below.
 134          */
 135
 136         switch (fcn) {
 137 #if defined(__x86)
 138         case AD_CHECK_SUSPEND_TO_DISK:
 139         case AD_SUSPEND_TO_DISK:
 140         case AD_CPR_REUSEINIT:
 141         case AD_CPR_NOCOMPRESS:
 142         case AD_CPR_FORCE:
 143         case AD_CPR_REUSABLE:
 144         case AD_CPR_REUSEFINI:
 145         case AD_CPR_TESTZ:
 146         case AD_CPR_TESTNOZ:
 147         case AD_CPR_TESTHALT:
 148         case AD_CPR_PRINT:
 149                 return (ENOTSUP);
 150         /* The DEV_* values need to be removed after sys-syspend is fixed */
 151         case DEV_CHECK_SUSPEND_TO_RAM:
 152         case DEV_SUSPEND_TO_RAM:
 153         case AD_CPR_SUSP_DEVICES:
 154         case AD_CHECK_SUSPEND_TO_RAM:
 155         case AD_SUSPEND_TO_RAM:
 156         case AD_LOOPBACK_SUSPEND_TO_RAM_PASS:
 157         case AD_LOOPBACK_SUSPEND_TO_RAM_FAIL:
 158         case AD_FORCE_SUSPEND_TO_RAM:
 159         case AD_DEVICE_SUSPEND_TO_RAM:
 160                 cpr_sleeptype = CPR_TORAM;
 161                 break;
 162 #endif
 163         }
 164
 165         switch (fcn) {
 166
 167
 168         case AD_CPR_DEBUG0:
 169                 cpr_debug = 0;
 170                 return (0);
 171
 172         case AD_CPR_DEBUG1:
 173         case AD_CPR_DEBUG2:
 174         case AD_CPR_DEBUG3:
 175         case AD_CPR_DEBUG4:
 176         case AD_CPR_DEBUG5:
 177         case AD_CPR_DEBUG7:
 178         case AD_CPR_DEBUG8:
 179                 cpr_debug |= CPR_DEBUG_BIT(fcn);
 180                 return (0);
 181
 182         case AD_CPR_DEBUG9:
 183                 cpr_debug |= CPR_DEBUG6;
 184                 return (0);
 185
 186         /* The DEV_* values need to be removed after sys-syspend is fixed */
 187         case DEV_CHECK_SUSPEND_TO_RAM:
 188         case DEV_SUSPEND_TO_RAM:
 189         case AD_CHECK_SUSPEND_TO_RAM:
 190         case AD_SUSPEND_TO_RAM:
 191                 cpr_test_point = LOOP_BACK_NONE;
 192                 break;
 193
 194         case AD_LOOPBACK_SUSPEND_TO_RAM_PASS:
 195                 cpr_test_point = LOOP_BACK_PASS;
 196                 break;
 197
 198         case AD_LOOPBACK_SUSPEND_TO_RAM_FAIL:
 199                 cpr_test_point = LOOP_BACK_FAIL;
 200                 break;
 201
 202         case AD_FORCE_SUSPEND_TO_RAM:
 203                 cpr_test_point = FORCE_SUSPEND_TO_RAM;
 204                 break;
 205
 206         case AD_DEVICE_SUSPEND_TO_RAM:
 207                 if (mdep == NULL) {
 208                         /* Didn't pass enough arguments */
 209                         return (EINVAL);
 210                 }
 211                 cpr_test_point = DEVICE_SUSPEND_TO_RAM;
 212                 cpr_device = (major_t)atoi((char *)mdep);
 213                 break;
 214
 215         case AD_CPR_SUSP_DEVICES:
 216                 cpr_test_point = FORCE_SUSPEND_TO_RAM;
 217                 if (cpr_suspend_devices(ddi_root_node()) != DDI_SUCCESS)
 218                         cmn_err(CE_WARN,
 219                             "Some devices did not suspend "
 220                             "and may be unusable");
 221                 (void) cpr_resume_devices(ddi_root_node(), 0);
 222                 return (0);
 223
 224         default:
 225                 return (ENOTSUP);
 226         }
 227
 228         if (!i_cpr_is_supported(cpr_sleeptype))
 229                 return (ENOTSUP);
 230
 231
 232         if (fcn == AD_CHECK_SUSPEND_TO_RAM ||
 233             fcn == DEV_CHECK_SUSPEND_TO_RAM) {
 234                 ASSERT(i_cpr_is_supported(cpr_sleeptype));
 235                 return (0);
 236         }
 237
 238
 239         /*
 240          * acquire cpr serial lock and init cpr state structure.
 241          */
 242         if (rc = cpr_init(fcn))
 243                 return (rc);
 244
 245
 246         /*
 247          * Call the main cpr routine. If we are successful, we will be coming
 248          * down from the resume side, otherwise we are still in suspend.
 249          */
 250         cpr_err(CE_CONT, "System is being suspended");
 251         if (rc = cpr_main(cpr_sleeptype)) {
 252                 CPR->c_flags |= C_ERROR;
 253                 PMD(PMD_SX, ("cpr: Suspend operation failed.\n"))
 254                 cpr_err(CE_NOTE, "Suspend operation failed.");
 255         } else if (CPR->c_flags & C_SUSPENDING) {
 256
 257                 /*
 258                  * In the suspend to RAM case, by the time we get
 259                  * control back we're already resumed
 260                  */
 261                 if (cpr_sleeptype == CPR_TORAM) {
 262                         PMD(PMD_SX, ("cpr: cpr CPR_TORAM done\n"))
 263                         cpr_done();
 264                         return (rc);
 265                 }
 266
 267         }
 268         PMD(PMD_SX, ("cpr: cpr done\n"))
 269         cpr_done();
 270         return (rc);
 271 }