sys/dev/null/null.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2000 Mark R. V. Murray & Jeroen C. van Gelderen
   5  * Copyright (c) 2001-2004 Mark R. V. Murray
   6  * Copyright (c) 2014 Eitan Adler
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer
  14  *    in this position and unchanged.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  */
  31
  32 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/conf.h>
  38 #include <sys/uio.h>
  39 #include <sys/kernel.h>
  40 #include <sys/malloc.h>
  41 #include <sys/module.h>
  42 #include <sys/disk.h>
  43 #include <sys/bus.h>
  44 #include <sys/filio.h>
  45
  46 #include <machine/bus.h>
  47 #include <machine/vmparam.h>
  48
  49 /* For use with destroy_dev(9). */
  50 static struct cdev *full_dev;
  51 static struct cdev *null_dev;
  52 static struct cdev *zero_dev;
  53
  54 static d_write_t full_write;
  55 static d_write_t null_write;
  56 static d_ioctl_t null_ioctl;
  57 static d_ioctl_t zero_ioctl;
  58 static d_read_t zero_read;
  59
  60 static struct cdevsw full_cdevsw = {
  61         .d_version =    D_VERSION,
  62         .d_read =       zero_read,
  63         .d_write =      full_write,
  64         .d_ioctl =      zero_ioctl,
  65         .d_name =       "full",
  66 };
  67
  68 static struct cdevsw null_cdevsw = {
  69         .d_version =    D_VERSION,
  70         .d_read =       (d_read_t *)nullop,
  71         .d_write =      null_write,
  72         .d_ioctl =      null_ioctl,
  73         .d_name =       "null",
  74 };
  75
  76 static struct cdevsw zero_cdevsw = {
  77         .d_version =    D_VERSION,
  78         .d_read =       zero_read,
  79         .d_write =      null_write,
  80         .d_ioctl =      zero_ioctl,
  81         .d_name =       "zero",
  82         .d_flags =      D_MMAP_ANON,
  83 };
  84
  85
  86
  87 /* ARGSUSED */
  88 static int
  89 full_write(struct cdev *dev __unused, struct uio *uio __unused, int flags __unused)
  90 {
  91
  92         return (ENOSPC);
  93 }
  94
  95 /* ARGSUSED */
  96 static int
  97 null_write(struct cdev *dev __unused, struct uio *uio, int flags __unused)
  98 {
  99         uio->uio_resid = 0;
 100
 101         return (0);
 102 }
 103
 104 /* ARGSUSED */
 105 static int
 106 null_ioctl(struct cdev *dev __unused, u_long cmd, caddr_t data __unused,
 107     int flags __unused, struct thread *td)
 108 {
 109         struct diocskerneldump_arg kda;
 110         int error;
 111
 112         error = 0;
 113         switch (cmd) {
 114 #ifdef COMPAT_FREEBSD11
 115         case DIOCSKERNELDUMP_FREEBSD11:
 116                 gone_in(13, "FreeBSD 11.x ABI compat");
 117                 /* FALLTHROUGH */
 118 #endif
 119 #ifdef COMPAT_FREEBSD12
 120         case DIOCSKERNELDUMP_FREEBSD12:
 121                 if (cmd == DIOCSKERNELDUMP_FREEBSD12)
 122                         gone_in(14, "FreeBSD 12.x ABI compat");
 123                 /* FALLTHROUGH */
 124 #endif
 125         case DIOCSKERNELDUMP:
 126                 bzero(&kda, sizeof(kda));
 127                 kda.kda_index = KDA_REMOVE_ALL;
 128                 error = dumper_remove(NULL, &kda);
 129                 break;
 130         case FIONBIO:
 131                 break;
 132         case FIOASYNC:
 133                 if (*(int *)data != 0)
 134                         error = EINVAL;
 135                 break;
 136         default:
 137                 error = ENOIOCTL;
 138         }
 139         return (error);
 140 }
 141
 142 /* ARGSUSED */
 143 static int
 144 zero_ioctl(struct cdev *dev __unused, u_long cmd, caddr_t data __unused,
 145            int flags __unused, struct thread *td)
 146 {
 147         int error;
 148         error = 0;
 149
 150         switch (cmd) {
 151         case FIONBIO:
 152                 break;
 153         case FIOASYNC:
 154                 if (*(int *)data != 0)
 155                         error = EINVAL;
 156                 break;
 157         default:
 158                 error = ENOIOCTL;
 159         }
 160         return (error);
 161 }
 162
 163
 164 /* ARGSUSED */
 165 static int
 166 zero_read(struct cdev *dev __unused, struct uio *uio, int flags __unused)
 167 {
 168         void *zbuf;
 169         ssize_t len;
 170         int error = 0;
 171
 172         KASSERT(uio->uio_rw == UIO_READ,
 173             ("Can't be in %s for write", __func__));
 174         zbuf = __DECONST(void *, zero_region);
 175         while (uio->uio_resid > 0 && error == 0) {
 176                 len = uio->uio_resid;
 177                 if (len > ZERO_REGION_SIZE)
 178                         len = ZERO_REGION_SIZE;
 179                 error = uiomove(zbuf, len, uio);
 180         }
 181
 182         return (error);
 183 }
 184
 185 /* ARGSUSED */
 186 static int
 187 null_modevent(module_t mod __unused, int type, void *data __unused)
 188 {
 189         switch(type) {
 190         case MOD_LOAD:
 191                 if (bootverbose)
 192                         printf("null: <full device, null device, zero device>\n");
 193                 full_dev = make_dev_credf(MAKEDEV_ETERNAL_KLD, &full_cdevsw, 0,
 194                     NULL, UID_ROOT, GID_WHEEL, 0666, "full");
 195                 null_dev = make_dev_credf(MAKEDEV_ETERNAL_KLD, &null_cdevsw, 0,
 196                     NULL, UID_ROOT, GID_WHEEL, 0666, "null");
 197                 zero_dev = make_dev_credf(MAKEDEV_ETERNAL_KLD, &zero_cdevsw, 0,
 198                     NULL, UID_ROOT, GID_WHEEL, 0666, "zero");
 199                 break;
 200
 201         case MOD_UNLOAD:
 202                 destroy_dev(full_dev);
 203                 destroy_dev(null_dev);
 204                 destroy_dev(zero_dev);
 205                 break;
 206
 207         case MOD_SHUTDOWN:
 208                 break;
 209
 210         default:
 211                 return (EOPNOTSUPP);
 212         }
 213
 214         return (0);
 215 }
 216
 217 DEV_MODULE(null, null_modevent, NULL);
 218 MODULE_VERSION(null, 1);