6256b9334f9942182dbcce15c8b02bb7516f6bf5
[dragonfly.git] / sys / dev / raid / vinum / vinum.c
1 /*-
2  * Copyright (c) 1997, 1998
3  *      Nan Yang Computer Services Limited.  All rights reserved.
4  *
5  *  Written by Greg Lehey
6  *
7  *  This software is distributed under the so-called ``Berkeley
8  *  License'':
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by Nan Yang Computer
21  *      Services Limited.
22  * 4. Neither the name of the Company nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * This software is provided ``as is'', and any express or implied
27  * warranties, including, but not limited to, the implied warranties of
28  * merchantability and fitness for a particular purpose are disclaimed.
29  * In no event shall the company or contributors be liable for any
30  * direct, indirect, incidental, special, exemplary, or consequential
31  * damages (including, but not limited to, procurement of substitute
32  * goods or services; loss of use, data, or profits; or business
33  * interruption) however caused and on any theory of liability, whether
34  * in contract, strict liability, or tort (including negligence or
35  * otherwise) arising in any way out of the use of this software, even if
36  * advised of the possibility of such damage.
37  *
38  * $Id: vinum.c,v 1.33 2001/01/09 06:19:15 grog Exp grog $
39  * $FreeBSD: src/sys/dev/vinum/vinum.c,v 1.38.2.3 2003/01/07 12:14:16 joerg Exp $
40  * $DragonFly: src/sys/dev/raid/vinum/vinum.c,v 1.5 2003/07/19 21:14:31 dillon Exp $
41  */
42
43 #define STATIC static                                       /* nothing while we're testing XXX */
44
45 #include <dev/vinum/vinumhdr.h>
46 #include <sys/sysproto.h>                                   /* for sync(2) */
47 #include <sys/devicestat.h>
48 #ifdef VINUMDEBUG
49 #include <sys/reboot.h>
50 int debug = 0;
51 extern int total_malloced;
52 extern int malloccount;
53 extern struct mc malloced[];
54 #endif
55 #include <dev/vinum/request.h>
56
57 STATIC struct cdevsw vinum_cdevsw =
58 {
59     vinumopen, vinumclose, physread, physwrite,
60     vinumioctl, seltrue, nommap, vinumstrategy,
61     "vinum", VINUM_CDEV_MAJOR, vinumdump, vinumsize,
62     D_DISK, VINUM_BDEV_MAJOR
63 };
64
65 /* Called by main() during pseudo-device attachment. */
66 STATIC void vinumattach(void *);
67
68 STATIC int vinum_modevent(module_t mod, modeventtype_t type, void *unused);
69
70 struct _vinum_conf vinum_conf;                              /* configuration information */
71
72 /*
73  * Called by main() during pseudo-device attachment.  All we need
74  * to do is allocate enough space for devices to be configured later, and
75  * add devsw entries.
76  */
77 void
78 vinumattach(void *dummy)
79 {
80     char *cp, *cp1, *cp2, **drives;
81     int i, rv;
82     struct volume *vol;
83
84     /* modload should prevent multiple loads, so this is worth a panic */
85     if ((vinum_conf.flags & VF_LOADED) != 0)
86         panic("vinum: already loaded");
87
88     log(LOG_INFO, "vinum: loaded\n");
89     vinum_conf.flags |= VF_LOADED;                          /* we're loaded now */
90
91     daemonq = NULL;                                         /* initialize daemon's work queue */
92     dqend = NULL;
93
94     cdevsw_add(&vinum_cdevsw);                              /* add the cdevsw entry */
95
96     /* allocate space: drives... */
97     DRIVE = (struct drive *) Malloc(sizeof(struct drive) * INITIAL_DRIVES);
98     CHECKALLOC(DRIVE, "vinum: no memory\n");
99     bzero(DRIVE, sizeof(struct drive) * INITIAL_DRIVES);
100     vinum_conf.drives_allocated = INITIAL_DRIVES;           /* number of drive slots allocated */
101     vinum_conf.drives_used = 0;                             /* and number in use */
102
103     /* volumes, ... */
104     VOL = (struct volume *) Malloc(sizeof(struct volume) * INITIAL_VOLUMES);
105     CHECKALLOC(VOL, "vinum: no memory\n");
106     bzero(VOL, sizeof(struct volume) * INITIAL_VOLUMES);
107     vinum_conf.volumes_allocated = INITIAL_VOLUMES;         /* number of volume slots allocated */
108     vinum_conf.volumes_used = 0;                            /* and number in use */
109
110     /* plexes, ... */
111     PLEX = (struct plex *) Malloc(sizeof(struct plex) * INITIAL_PLEXES);
112     CHECKALLOC(PLEX, "vinum: no memory\n");
113     bzero(PLEX, sizeof(struct plex) * INITIAL_PLEXES);
114     vinum_conf.plexes_allocated = INITIAL_PLEXES;           /* number of plex slots allocated */
115     vinum_conf.plexes_used = 0;                             /* and number in use */
116
117     /* and subdisks */
118     SD = (struct sd *) Malloc(sizeof(struct sd) * INITIAL_SUBDISKS);
119     CHECKALLOC(SD, "vinum: no memory\n");
120     bzero(SD, sizeof(struct sd) * INITIAL_SUBDISKS);
121     vinum_conf.subdisks_allocated = INITIAL_SUBDISKS;       /* number of sd slots allocated */
122     vinum_conf.subdisks_used = 0;                           /* and number in use */
123
124     /*
125      * See if the loader has passed us a disk to
126      * read the initial configuration from.
127      */
128     if ((cp = getenv("vinum.drives")) != NULL) {
129         for (cp1 = cp, i = 0, drives = 0; *cp1 != '\0'; i++) {
130             cp2 = cp1;
131             while (*cp1 != '\0' && *cp1 != ',' && *cp1 != ' ')
132                 cp1++;
133             if (*cp1 != '\0')
134                 *cp1++ = '\0';
135             drives = realloc(drives, (unsigned long)((i + 1) * sizeof(char *)),
136                              M_TEMP, M_WAITOK);
137             drives[i] = cp2;
138         }
139         if (i == 0)
140             goto bailout;
141         rv = vinum_scandisk(drives, i);
142         if (rv)
143             log(LOG_NOTICE, "vinum_scandisk() returned %d", rv);
144     bailout:
145         free(drives, M_TEMP);
146     }
147     if ((cp = getenv("vinum.root")) != NULL) {
148         for (i = 0; i < vinum_conf.volumes_used; i++) {
149             vol = &vinum_conf.volume[i];
150             if ((vol->state == volume_up)
151                 && (strcmp (vol->name, cp) == 0) ) {
152                 rootdev = makedev(VINUM_CDEV_MAJOR, i); 
153                 log(LOG_INFO, "vinum: using volume %s for root device\n", cp);
154                 break;
155             }
156         }
157     }
158 }
159
160 /*
161  * Check if we have anything open.  If confopen is != 0,
162  * that goes for the super device as well, otherwise
163  * only for volumes.
164  *
165  * Return 0 if not inactive, 1 if inactive.
166  */
167 int
168 vinum_inactive(int confopen)
169 {
170     int i;
171     int can_do = 1;                                         /* assume we can do it */
172
173     if (confopen && (vinum_conf.flags & VF_OPEN))           /* open by vinum(8)? */
174         return 0;                                           /* can't do it while we're open */
175     lock_config();
176     for (i = 0; i < vinum_conf.volumes_allocated; i++) {
177         if ((VOL[i].state > volume_down)
178             && (VOL[i].flags & VF_OPEN)) {                  /* volume is open */
179             can_do = 0;
180             break;
181         }
182     }
183     unlock_config();
184     return can_do;
185 }
186
187 /*
188  * Free all structures.
189  * If cleardrive is 0, save the configuration; otherwise
190  * remove the configuration from the drive.
191  *
192  * Before coming here, ensure that no volumes are open.
193  */
194 void
195 free_vinum(int cleardrive)
196 {
197     int i;
198     int drives_allocated = vinum_conf.drives_allocated;
199
200     if (DRIVE != NULL) {
201         if (cleardrive) {                                   /* remove the vinum config */
202             for (i = 0; i < drives_allocated; i++)
203                 remove_drive(i);                            /* remove the drive */
204         } else {                                            /* keep the config */
205             for (i = 0; i < drives_allocated; i++)
206                 free_drive(&DRIVE[i]);                      /* close files and things */
207         }
208         Free(DRIVE);
209     }
210     while ((vinum_conf.flags & (VF_STOPPING | VF_DAEMONOPEN))
211         == (VF_STOPPING | VF_DAEMONOPEN)) {                 /* at least one daemon open, we're stopping */
212         queue_daemon_request(daemonrq_return, (union daemoninfo) 0); /* stop the daemon */
213         tsleep(&vinumclose, 0, "vstop", 1);                 /* and wait for it */
214     }
215     if (SD != NULL)
216         Free(SD);
217     if (PLEX != NULL) {
218         for (i = 0; i < vinum_conf.plexes_allocated; i++) {
219             struct plex *plex = &vinum_conf.plex[i];
220
221             if (plex->state != plex_unallocated) {          /* we have real data there */
222                 if (plex->sdnos)
223                     Free(plex->sdnos);
224             }
225         }
226         Free(PLEX);
227     }
228     if (VOL != NULL)
229         Free(VOL);
230     bzero(&vinum_conf, sizeof(vinum_conf));
231 }
232
233 STATIC int
234 vinum_modevent(module_t mod, modeventtype_t type, void *unused)
235 {
236     struct sync_args dummyarg = {0};
237
238     switch (type) {
239     case MOD_LOAD:
240         vinumattach(NULL);
241         return 0;                                           /* OK */
242     case MOD_UNLOAD:
243         if (!vinum_inactive(1))                             /* is anything open? */
244             return EBUSY;                                   /* yes, we can't do it */
245         vinum_conf.flags |= VF_STOPPING;                    /* note that we want to stop */
246         sync(&dummyarg);                            /* write out buffers */
247         free_vinum(0);                                      /* clean up */
248 #ifdef VINUMDEBUG
249         if (total_malloced) {
250             int i;
251 #ifdef INVARIANTS
252             int *poke;
253 #endif
254
255             for (i = 0; i < malloccount; i++) {
256                 if (debug & DEBUG_WARNINGS)                 /* want to hear about them */
257                     log(LOG_WARNING,
258                         "vinum: exiting with %d bytes malloced from %s:%d\n",
259                         malloced[i].size,
260                         malloced[i].file,
261                         malloced[i].line);
262 #ifdef INVARIANTS
263                 poke = &((int *) malloced[i].address)
264                     [malloced[i].size / (2 * sizeof(int))]; /* middle of the area */
265                 if (*poke == 0xdeadc0de)                    /* already freed */
266                     log(LOG_ERR,
267                         "vinum: exiting with malloc table inconsistency at %p from %s:%d\n",
268                         malloced[i].address,
269                         malloced[i].file,
270                         malloced[i].line);
271 #endif
272                 Free(malloced[i].address);
273             }
274         }
275 #endif
276         cdevsw_remove(&vinum_cdevsw);
277         log(LOG_INFO, "vinum: unloaded\n");                 /* tell the world */
278         return 0;
279     default:
280         break;
281     }
282     return 0;
283 }
284
285 moduledata_t vinum_mod =
286 {
287     "vinum",
288     (modeventhand_t) vinum_modevent,
289     0
290 };
291 DECLARE_MODULE(vinum, vinum_mod, SI_SUB_VINUM, SI_ORDER_MIDDLE);
292
293 /* ARGSUSED */
294 /* Open a vinum object */
295 int
296 vinumopen(dev_t dev, int flags, int fmt, d_thread_t *td)
297 {
298     int error;
299     unsigned int index;
300     struct volume *vol;
301     struct plex *plex;
302     struct sd *sd;
303     int devminor;                                           /* minor number */
304
305     devminor = minor(dev);
306     error = 0;
307     /* First, decide what we're looking at */
308     switch (DEVTYPE(dev)) {
309     case VINUM_VOLUME_TYPE:
310         index = Volno(dev);
311         if (index >= vinum_conf.volumes_allocated)
312             return ENXIO;                                   /* no such device */
313         vol = &VOL[index];
314
315         switch (vol->state) {
316         case volume_unallocated:
317         case volume_uninit:
318             return ENXIO;
319
320         case volume_up:
321             vol->flags |= VF_OPEN;                          /* note we're open */
322             return 0;
323
324         case volume_down:
325             return EIO;
326
327         default:
328             return EINVAL;
329         }
330
331     case VINUM_PLEX_TYPE:
332         if (Volno(dev) >= vinum_conf.volumes_allocated)
333             return ENXIO;
334         /* FALLTHROUGH */
335
336     case VINUM_RAWPLEX_TYPE:
337         index = Plexno(dev);                                /* get plex index in vinum_conf */
338         if (index >= vinum_conf.plexes_allocated)
339             return ENXIO;                                   /* no such device */
340         plex = &PLEX[index];
341
342         switch (plex->state) {
343         case plex_referenced:
344         case plex_unallocated:
345             return EINVAL;
346
347         default:
348             plex->flags |= VF_OPEN;                         /* note we're open */
349             return 0;
350         }
351
352     case VINUM_SD_TYPE:
353         if ((Volno(dev) >= vinum_conf.volumes_allocated)    /* no such volume */
354         ||(Plexno(dev) >= vinum_conf.plexes_allocated))     /* or no such plex */
355             return ENXIO;                                   /* no such device */
356
357         /* FALLTHROUGH */
358
359     case VINUM_RAWSD_TYPE:
360         index = Sdno(dev);                                  /* get the subdisk number */
361         if ((index >= vinum_conf.subdisks_allocated)        /* not a valid SD entry */
362         ||(SD[index].state < sd_init))                      /* or SD is not real */
363             return ENXIO;                                   /* no such device */
364         sd = &SD[index];
365
366         /*
367          * Opening a subdisk is always a special operation, so we
368          * ignore the state as long as it represents a real subdisk
369          */
370         switch (sd->state) {
371         case sd_unallocated:
372         case sd_uninit:
373             return EINVAL;
374
375         default:
376             sd->flags |= VF_OPEN;                           /* note we're open */
377             return 0;
378         }
379
380     case VINUM_SUPERDEV_TYPE:
381         error = suser(td);                  /* are we root? */
382         if (error == 0) {                                   /* yes, can do */
383             if (devminor == VINUM_DAEMON_DEV)               /* daemon device */
384                 vinum_conf.flags |= VF_DAEMONOPEN;          /* we're open */
385             else if (devminor == VINUM_SUPERDEV)
386                 vinum_conf.flags |= VF_OPEN;                /* we're open */
387             else
388                 error = ENODEV;                             /* nothing, maybe a debug mismatch */
389         }
390         return error;
391
392         /* Vinum drives are disks.  We already have a disk
393          * driver, so don't handle them here */
394     case VINUM_DRIVE_TYPE:
395     default:
396         return ENODEV;                                      /* don't know what to do with these */
397     }
398 }
399
400 /* ARGSUSED */
401 int
402 vinumclose(dev_t dev, int flags, int fmt, d_thread_t *td)
403 {
404     unsigned int index;
405     struct volume *vol;
406     int devminor;
407
408     devminor = minor(dev);
409     index = Volno(dev);
410     /* First, decide what we're looking at */
411     switch (DEVTYPE(dev)) {
412     case VINUM_VOLUME_TYPE:
413         if (index >= vinum_conf.volumes_allocated)
414             return ENXIO;                                   /* no such device */
415         vol = &VOL[index];
416
417         switch (vol->state) {
418         case volume_unallocated:
419         case volume_uninit:
420             return ENXIO;
421
422         case volume_up:
423             vol->flags &= ~VF_OPEN;                         /* reset our flags */
424             return 0;
425
426         case volume_down:
427             return EIO;
428
429         default:
430             return EINVAL;
431         }
432
433     case VINUM_PLEX_TYPE:
434         if (Volno(dev) >= vinum_conf.volumes_allocated)
435             return ENXIO;
436         /* FALLTHROUGH */
437
438     case VINUM_RAWPLEX_TYPE:
439         index = Plexno(dev);                                /* get plex index in vinum_conf */
440         if (index >= vinum_conf.plexes_allocated)
441             return ENXIO;                                   /* no such device */
442         PLEX[index].flags &= ~VF_OPEN;                      /* reset our flags */
443         return 0;
444
445     case VINUM_SD_TYPE:
446         if ((Volno(dev) >= vinum_conf.volumes_allocated) || /* no such volume */
447             (Plexno(dev) >= vinum_conf.plexes_allocated))   /* or no such plex */
448             return ENXIO;                                   /* no such device */
449         /* FALLTHROUGH */
450
451     case VINUM_RAWSD_TYPE:
452         index = Sdno(dev);                                  /* get the subdisk number */
453         if (index >= vinum_conf.subdisks_allocated)
454             return ENXIO;                                   /* no such device */
455         SD[index].flags &= ~VF_OPEN;                        /* reset our flags */
456         return 0;
457
458     case VINUM_SUPERDEV_TYPE:
459         /*
460          * don't worry about whether we're root:
461          * nobody else would get this far.
462          */
463         if (devminor == VINUM_SUPERDEV)                     /* normal superdev */
464             vinum_conf.flags &= ~VF_OPEN;                   /* no longer open */
465         else if (devminor == VINUM_DAEMON_DEV) {            /* the daemon device */
466             vinum_conf.flags &= ~VF_DAEMONOPEN;             /* no longer open */
467             if (vinum_conf.flags & VF_STOPPING)             /* we're stopping, */
468                 wakeup(&vinumclose);                        /* we can continue stopping now */
469         }
470         return 0;
471
472     case VINUM_DRIVE_TYPE:
473     default:
474         return ENODEV;                                      /* don't know what to do with these */
475     }
476 }
477
478 /* size routine */
479 int
480 vinumsize(dev_t dev)
481 {
482     struct volume *vol;
483     int size;
484
485     vol = &VOL[Volno(dev)];
486
487     if (vol->state == volume_up)
488         size = vol->size;
489     else
490         return 0;                                           /* err on the size of conservatism */
491
492     return size;
493 }
494
495 int
496 vinumdump(dev_t dev)
497 {
498     /* Not implemented. */
499     return ENXIO;
500 }
501
502 /* Local Variables: */
503 /* fill-column: 50 */
504 /* End: */