81f3a67966952c03414d01d5b59e16f3bcb42776
[dragonfly.git] / sys / kern / subr_disk.c
1 /*
2  * Copyright (c) 2003,2004,2009 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * ----------------------------------------------------------------------------
35  * "THE BEER-WARE LICENSE" (Revision 42):
36  * <phk@FreeBSD.ORG> wrote this file.  As long as you retain this notice you
37  * can do whatever you want with this stuff. If we meet some day, and you think
38  * this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
39  * ----------------------------------------------------------------------------
40  *
41  * Copyright (c) 1982, 1986, 1988, 1993
42  *      The Regents of the University of California.  All rights reserved.
43  * (c) UNIX System Laboratories, Inc.
44  * All or some portions of this file are derived from material licensed
45  * to the University of California by American Telephone and Telegraph
46  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
47  * the permission of UNIX System Laboratories, Inc.
48  *
49  * Redistribution and use in source and binary forms, with or without
50  * modification, are permitted provided that the following conditions
51  * are met:
52  * 1. Redistributions of source code must retain the above copyright
53  *    notice, this list of conditions and the following disclaimer.
54  * 2. Redistributions in binary form must reproduce the above copyright
55  *    notice, this list of conditions and the following disclaimer in the
56  *    documentation and/or other materials provided with the distribution.
57  * 3. All advertising materials mentioning features or use of this software
58  *    must display the following acknowledgement:
59  *      This product includes software developed by the University of
60  *      California, Berkeley and its contributors.
61  * 4. Neither the name of the University nor the names of its contributors
62  *    may be used to endorse or promote products derived from this software
63  *    without specific prior written permission.
64  *
65  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
66  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
67  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
68  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
69  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
70  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
71  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
72  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
73  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
74  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
75  * SUCH DAMAGE.
76  *
77  *      @(#)ufs_disksubr.c      8.5 (Berkeley) 1/21/94
78  * $FreeBSD: src/sys/kern/subr_disk.c,v 1.20.2.6 2001/10/05 07:14:57 peter Exp $
79  * $FreeBSD: src/sys/ufs/ufs/ufs_disksubr.c,v 1.44.2.3 2001/03/05 05:42:19 obrien Exp $
80  * $DragonFly: src/sys/kern/subr_disk.c,v 1.40 2008/06/05 18:06:32 swildner Exp $
81  */
82
83 #include <sys/param.h>
84 #include <sys/systm.h>
85 #include <sys/kernel.h>
86 #include <sys/proc.h>
87 #include <sys/sysctl.h>
88 #include <sys/buf.h>
89 #include <sys/conf.h>
90 #include <sys/disklabel.h>
91 #include <sys/disklabel32.h>
92 #include <sys/disklabel64.h>
93 #include <sys/diskslice.h>
94 #include <sys/diskmbr.h>
95 #include <sys/disk.h>
96 #include <sys/kerneldump.h>
97 #include <sys/malloc.h>
98 #include <sys/sysctl.h>
99 #include <machine/md_var.h>
100 #include <sys/ctype.h>
101 #include <sys/syslog.h>
102 #include <sys/device.h>
103 #include <sys/msgport.h>
104 #include <sys/devfs.h>
105 #include <sys/thread.h>
106 #include <sys/dsched.h>
107 #include <sys/queue.h>
108 #include <sys/lock.h>
109 #include <sys/udev.h>
110
111 #include <sys/buf2.h>
112 #include <sys/mplock2.h>
113 #include <sys/msgport2.h>
114 #include <sys/thread2.h>
115
116 static MALLOC_DEFINE(M_DISK, "disk", "disk data");
117 static int disk_debug_enable = 0;
118
119 static void disk_msg_autofree_reply(lwkt_port_t, lwkt_msg_t);
120 static void disk_msg_core(void *);
121 static int disk_probe_slice(struct disk *dp, cdev_t dev, int slice, int reprobe);
122 static void disk_probe(struct disk *dp, int reprobe);
123 static void _setdiskinfo(struct disk *disk, struct disk_info *info);
124 static void bioqwritereorder(struct bio_queue_head *bioq);
125 static void disk_cleanserial(char *serno);
126
127 static d_open_t diskopen;
128 static d_close_t diskclose;
129 static d_ioctl_t diskioctl;
130 static d_strategy_t diskstrategy;
131 static d_psize_t diskpsize;
132 static d_clone_t diskclone;
133 static d_dump_t diskdump;
134
135 static LIST_HEAD(, disk) disklist = LIST_HEAD_INITIALIZER(&disklist);
136 static struct lwkt_token disklist_token;
137
138 static struct dev_ops disk_ops = {
139         { "disk", 0, D_DISK | D_MPSAFE },
140         .d_open = diskopen,
141         .d_close = diskclose,
142         .d_read = physread,
143         .d_write = physwrite,
144         .d_ioctl = diskioctl,
145         .d_strategy = diskstrategy,
146         .d_dump = diskdump,
147         .d_psize = diskpsize,
148         .d_clone = diskclone
149 };
150
151 static struct objcache  *disk_msg_cache;
152
153 struct objcache_malloc_args disk_msg_malloc_args = {
154         sizeof(struct disk_msg), M_DISK };
155
156 static struct lwkt_port disk_dispose_port;
157 static struct lwkt_port disk_msg_port;
158
159 static int
160 disk_debug(int level, char *fmt, ...)
161 {
162         __va_list ap;
163
164         __va_start(ap, fmt);
165         if (level <= disk_debug_enable)
166                 kvprintf(fmt, ap);
167         __va_end(ap);
168
169         return 0;
170 }
171
172 static int
173 disk_probe_slice(struct disk *dp, cdev_t dev, int slice, int reprobe)
174 {
175         struct disk_info *info = &dp->d_info;
176         struct diskslice *sp = &dp->d_slice->dss_slices[slice];
177         disklabel_ops_t ops;
178         struct partinfo part;
179         const char *msg;
180         cdev_t ndev;
181         int sno;
182         u_int i;
183
184         disk_debug(2,
185                     "disk_probe_slice (begin): %s (%s)\n",
186                         dev->si_name, dp->d_cdev->si_name);
187
188         sno = slice ? slice - 1 : 0;
189
190         ops = &disklabel32_ops;
191         msg = ops->op_readdisklabel(dev, sp, &sp->ds_label, info);
192         if (msg && !strcmp(msg, "no disk label")) {
193                 ops = &disklabel64_ops;
194                 msg = ops->op_readdisklabel(dev, sp, &sp->ds_label, info);
195         }
196         if (msg == NULL) {
197                 if (slice != WHOLE_DISK_SLICE)
198                         ops->op_adjust_label_reserved(dp->d_slice, slice, sp);
199                 else
200                         sp->ds_reserved = 0;
201
202                 sp->ds_ops = ops;
203                 for (i = 0; i < ops->op_getnumparts(sp->ds_label); i++) {
204                         ops->op_loadpartinfo(sp->ds_label, i, &part);
205                         if (part.fstype) {
206                                 if (reprobe &&
207                                     (ndev = devfs_find_device_by_name("%s%c",
208                                                 dev->si_name, 'a' + i))
209                                 ) {
210                                         /*
211                                          * Device already exists and
212                                          * is still valid.
213                                          */
214                                         ndev->si_flags |= SI_REPROBE_TEST;
215                                 } else {
216                                         ndev = make_dev_covering(&disk_ops, dp->d_rawdev->si_ops,
217                                                 dkmakeminor(dkunit(dp->d_cdev),
218                                                             slice, i),
219                                                 UID_ROOT, GID_OPERATOR, 0640,
220                                                 "%s%c", dev->si_name, 'a'+ i);
221                                         ndev->si_disk = dp;
222                                         udev_dict_set_cstr(ndev, "subsystem", "disk");
223                                         /* Inherit parent's disk type */
224                                         if (dp->d_disktype) {
225                                                 udev_dict_set_cstr(ndev, "disk-type", 
226                                                     __DECONST(char *, dp->d_disktype));
227                                         }
228                                         if (dp->d_info.d_serialno) {
229                                                 make_dev_alias(ndev,
230                                                     "serno/%s.s%d%c",
231                                                     dp->d_info.d_serialno,
232                                                     sno, 'a' + i);
233                                         }
234                                         ndev->si_flags |= SI_REPROBE_TEST;
235                                 }
236                         }
237                 }
238         } else if (info->d_dsflags & DSO_COMPATLABEL) {
239                 msg = NULL;
240                 if (sp->ds_size >= 0x100000000ULL)
241                         ops = &disklabel64_ops;
242                 else
243                         ops = &disklabel32_ops;
244                 sp->ds_label = ops->op_clone_label(info, sp);
245         } else {
246                 if (sp->ds_type == DOSPTYP_386BSD || /* XXX */
247                     sp->ds_type == DOSPTYP_NETBSD ||
248                     sp->ds_type == DOSPTYP_OPENBSD) {
249                         log(LOG_WARNING, "%s: cannot find label (%s)\n",
250                             dev->si_name, msg);
251                 }
252         }
253
254         if (msg == NULL) {
255                 sp->ds_wlabel = FALSE;
256         }
257
258         return (msg ? EINVAL : 0);
259 }
260
261 /*
262  * This routine is only called for newly minted drives or to reprobe
263  * a drive with no open slices.  disk_probe_slice() is called directly
264  * when reprobing partition changes within slices.
265  */
266 static void
267 disk_probe(struct disk *dp, int reprobe)
268 {
269         struct disk_info *info = &dp->d_info;
270         cdev_t dev = dp->d_cdev;
271         cdev_t ndev;
272         int error, i, sno;
273         struct diskslices *osp;
274         struct diskslice *sp;
275
276         KKASSERT (info->d_media_blksize != 0);
277
278         osp = dp->d_slice;
279         dp->d_slice = dsmakeslicestruct(BASE_SLICE, info);
280         disk_debug(1, "disk_probe (begin): %s\n", dp->d_cdev->si_name);
281
282         error = mbrinit(dev, info, &(dp->d_slice));
283         if (error) {
284                 dsgone(&osp);
285                 return;
286         }
287
288         for (i = 0; i < dp->d_slice->dss_nslices; i++) {
289                 /*
290                  * Ignore the whole-disk slice, it has already been created.
291                  */
292                 if (i == WHOLE_DISK_SLICE)
293                         continue;
294                 sp = &dp->d_slice->dss_slices[i];
295
296                 /*
297                  * Handle s0.  s0 is a compatibility slice if there are no
298                  * other slices and it has not otherwise been set up, else
299                  * we ignore it.
300                  */
301                 if (i == COMPATIBILITY_SLICE) {
302                         sno = 0;
303                         if (sp->ds_type == 0 &&
304                             dp->d_slice->dss_nslices == BASE_SLICE) {
305                                 sp->ds_size = info->d_media_blocks;
306                                 sp->ds_reserved = 0;
307                         }
308                 } else {
309                         sno = i - 1;
310                         sp->ds_reserved = 0;
311                 }
312
313                 /*
314                  * Ignore 0-length slices
315                  */
316                 if (sp->ds_size == 0)
317                         continue;
318
319                 if (reprobe &&
320                     (ndev = devfs_find_device_by_name("%ss%d",
321                                                       dev->si_name, sno))) {
322                         /*
323                          * Device already exists and is still valid
324                          */
325                         ndev->si_flags |= SI_REPROBE_TEST;
326                 } else {
327                         /*
328                          * Else create new device
329                          */
330                         ndev = make_dev_covering(&disk_ops, dp->d_rawdev->si_ops,
331                                         dkmakewholeslice(dkunit(dev), i),
332                                         UID_ROOT, GID_OPERATOR, 0640,
333                                         "%ss%d", dev->si_name, sno);
334                         udev_dict_set_cstr(ndev, "subsystem", "disk");
335                         /* Inherit parent's disk type */
336                         if (dp->d_disktype) {
337                                 udev_dict_set_cstr(ndev, "disk-type", 
338                                     __DECONST(char *, dp->d_disktype));
339                         }
340                         if (dp->d_info.d_serialno) {
341                                 make_dev_alias(ndev, "serno/%s.s%d",
342                                                dp->d_info.d_serialno, sno);
343                         }
344                         ndev->si_disk = dp;
345                         ndev->si_flags |= SI_REPROBE_TEST;
346                 }
347                 sp->ds_dev = ndev;
348
349                 /*
350                  * Probe appropriate slices for a disklabel
351                  *
352                  * XXX slice type 1 used by our gpt probe code.
353                  * XXX slice type 0 used by mbr compat slice.
354                  */
355                 if (sp->ds_type == DOSPTYP_386BSD ||
356                     sp->ds_type == DOSPTYP_NETBSD ||
357                     sp->ds_type == DOSPTYP_OPENBSD ||
358                     sp->ds_type == 0 ||
359                     sp->ds_type == 1) {
360                         if (dp->d_slice->dss_first_bsd_slice == 0)
361                                 dp->d_slice->dss_first_bsd_slice = i;
362                         disk_probe_slice(dp, ndev, i, reprobe);
363                 }
364         }
365         dsgone(&osp);
366         disk_debug(1, "disk_probe (end): %s\n", dp->d_cdev->si_name);
367 }
368
369
370 static void
371 disk_msg_core(void *arg)
372 {
373         struct disk     *dp;
374         struct diskslice *sp;
375         disk_msg_t msg;
376         int run;
377
378         lwkt_initport_thread(&disk_msg_port, curthread);
379         wakeup(curthread);
380         run = 1;
381
382         while (run) {
383                 msg = (disk_msg_t)lwkt_waitport(&disk_msg_port, 0);
384
385                 switch (msg->hdr.u.ms_result) {
386                 case DISK_DISK_PROBE:
387                         dp = (struct disk *)msg->load;
388                         disk_debug(1,
389                                     "DISK_DISK_PROBE: %s\n",
390                                         dp->d_cdev->si_name);
391                         disk_probe(dp, 0);
392                         break;
393                 case DISK_DISK_DESTROY:
394                         dp = (struct disk *)msg->load;
395                         disk_debug(1,
396                                     "DISK_DISK_DESTROY: %s\n",
397                                         dp->d_cdev->si_name);
398                         devfs_destroy_subnames(dp->d_cdev->si_name);
399                         devfs_destroy_dev(dp->d_cdev);
400                         lwkt_gettoken(&disklist_token);
401                         LIST_REMOVE(dp, d_list);
402                         lwkt_reltoken(&disklist_token);
403                         if (dp->d_info.d_serialno) {
404                                 kfree(dp->d_info.d_serialno, M_TEMP);
405                                 dp->d_info.d_serialno = NULL;
406                         }
407                         break;
408                 case DISK_UNPROBE:
409                         dp = (struct disk *)msg->load;
410                         disk_debug(1,
411                                     "DISK_DISK_UNPROBE: %s\n",
412                                         dp->d_cdev->si_name);
413                         devfs_destroy_subnames(dp->d_cdev->si_name);
414                         break;
415                 case DISK_SLICE_REPROBE:
416                         dp = (struct disk *)msg->load;
417                         sp = (struct diskslice *)msg->load2;
418                         devfs_clr_subnames_flag(sp->ds_dev->si_name,
419                                                 SI_REPROBE_TEST);
420                         disk_debug(1,
421                                     "DISK_SLICE_REPROBE: %s\n",
422                                     sp->ds_dev->si_name);
423                         disk_probe_slice(dp, sp->ds_dev,
424                                          dkslice(sp->ds_dev), 1);
425                         devfs_destroy_subnames_without_flag(
426                                         sp->ds_dev->si_name, SI_REPROBE_TEST);
427                         break;
428                 case DISK_DISK_REPROBE:
429                         dp = (struct disk *)msg->load;
430                         devfs_clr_subnames_flag(dp->d_cdev->si_name, SI_REPROBE_TEST);
431                         disk_debug(1,
432                                     "DISK_DISK_REPROBE: %s\n",
433                                     dp->d_cdev->si_name);
434                         disk_probe(dp, 1);
435                         devfs_destroy_subnames_without_flag(
436                                         dp->d_cdev->si_name, SI_REPROBE_TEST);
437                         break;
438                 case DISK_SYNC:
439                         disk_debug(1, "DISK_SYNC\n");
440                         break;
441                 default:
442                         devfs_debug(DEVFS_DEBUG_WARNING,
443                                     "disk_msg_core: unknown message "
444                                     "received at core\n");
445                         break;
446                 }
447                 lwkt_replymsg(&msg->hdr, 0);
448         }
449         lwkt_exit();
450 }
451
452
453 /*
454  * Acts as a message drain. Any message that is replied to here gets
455  * destroyed and the memory freed.
456  */
457 static void
458 disk_msg_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
459 {
460         objcache_put(disk_msg_cache, msg);
461 }
462
463
464 void
465 disk_msg_send(uint32_t cmd, void *load, void *load2)
466 {
467         disk_msg_t disk_msg;
468         lwkt_port_t port = &disk_msg_port;
469
470         disk_msg = objcache_get(disk_msg_cache, M_WAITOK);
471
472         lwkt_initmsg(&disk_msg->hdr, &disk_dispose_port, 0);
473
474         disk_msg->hdr.u.ms_result = cmd;
475         disk_msg->load = load;
476         disk_msg->load2 = load2;
477         KKASSERT(port);
478         lwkt_sendmsg(port, &disk_msg->hdr);
479 }
480
481 void
482 disk_msg_send_sync(uint32_t cmd, void *load, void *load2)
483 {
484         struct lwkt_port rep_port;
485         disk_msg_t disk_msg;
486         lwkt_port_t port;
487
488         disk_msg = objcache_get(disk_msg_cache, M_WAITOK);
489         port = &disk_msg_port;
490
491         /* XXX could probably use curthread's built-in msgport */
492         lwkt_initport_thread(&rep_port, curthread);
493         lwkt_initmsg(&disk_msg->hdr, &rep_port, 0);
494
495         disk_msg->hdr.u.ms_result = cmd;
496         disk_msg->load = load;
497         disk_msg->load2 = load2;
498
499         lwkt_sendmsg(port, &disk_msg->hdr);
500         lwkt_waitmsg(&disk_msg->hdr, 0);
501         objcache_put(disk_msg_cache, disk_msg);
502 }
503
504 /*
505  * Create a raw device for the dev_ops template (which is returned).  Also
506  * create a slice and unit managed disk and overload the user visible
507  * device space with it.
508  *
509  * NOTE: The returned raw device is NOT a slice and unit managed device.
510  * It is an actual raw device representing the raw disk as specified by
511  * the passed dev_ops.  The disk layer not only returns such a raw device,
512  * it also uses it internally when passing (modified) commands through.
513  */
514 cdev_t
515 disk_create(int unit, struct disk *dp, struct dev_ops *raw_ops)
516 {
517         return disk_create_named(NULL, unit, dp, raw_ops);
518 }
519
520 cdev_t
521 disk_create_named(const char *name, int unit, struct disk *dp, struct dev_ops *raw_ops)
522 {
523         cdev_t rawdev;
524
525         if (name == NULL)
526                 name = raw_ops->head.name;
527
528         disk_debug(1, "disk_create (begin): %s%d\n", name, unit);
529
530         rawdev = make_only_dev(raw_ops, dkmakewholedisk(unit),
531                             UID_ROOT, GID_OPERATOR, 0640,
532                             "%s%d", name, unit);
533
534         bzero(dp, sizeof(*dp));
535
536         dp->d_rawdev = rawdev;
537         dp->d_raw_ops = raw_ops;
538         dp->d_dev_ops = &disk_ops;
539         dp->d_cdev = make_dev_covering(&disk_ops, dp->d_rawdev->si_ops,
540                             dkmakewholedisk(unit),
541                             UID_ROOT, GID_OPERATOR, 0640,
542                             "%s%d", name, unit);
543         udev_dict_set_cstr(dp->d_cdev, "subsystem", "disk");
544         dp->d_cdev->si_disk = dp;
545
546         dsched_disk_create_callback(dp, name, unit);
547
548         lwkt_gettoken(&disklist_token);
549         LIST_INSERT_HEAD(&disklist, dp, d_list);
550         lwkt_reltoken(&disklist_token);
551
552         disk_debug(1, "disk_create (end): %s%d\n", name, unit);
553
554         return (dp->d_rawdev);
555 }
556
557 int
558 disk_setdisktype(struct disk *disk, const char *type)
559 {
560         KKASSERT(disk != NULL);
561
562         disk->d_disktype = type;
563         return udev_dict_set_cstr(disk->d_cdev, "disk-type", __DECONST(char *, type));
564 }
565
566 static void
567 _setdiskinfo(struct disk *disk, struct disk_info *info)
568 {
569         char *oldserialno;
570
571         oldserialno = disk->d_info.d_serialno;
572         bcopy(info, &disk->d_info, sizeof(disk->d_info));
573         info = &disk->d_info;
574
575         disk_debug(1,
576                     "_setdiskinfo: %s\n",
577                         disk->d_cdev->si_name);
578
579         /*
580          * The serial number is duplicated so the caller can throw
581          * their copy away.
582          */
583         if (info->d_serialno && info->d_serialno[0]) {
584                 info->d_serialno = kstrdup(info->d_serialno, M_TEMP);
585                 disk_cleanserial(info->d_serialno);
586                 if (disk->d_cdev) {
587                         make_dev_alias(disk->d_cdev, "serno/%s",
588                                         info->d_serialno);
589                 }
590         } else {
591                 info->d_serialno = NULL;
592         }
593         if (oldserialno)
594                 kfree(oldserialno, M_TEMP);
595
596         dsched_disk_update_callback(disk, info);
597
598         /*
599          * The caller may set d_media_size or d_media_blocks and we
600          * calculate the other.
601          */
602         KKASSERT(info->d_media_size == 0 || info->d_media_blksize == 0);
603         if (info->d_media_size == 0 && info->d_media_blocks) {
604                 info->d_media_size = (u_int64_t)info->d_media_blocks *
605                                      info->d_media_blksize;
606         } else if (info->d_media_size && info->d_media_blocks == 0 &&
607                    info->d_media_blksize) {
608                 info->d_media_blocks = info->d_media_size /
609                                        info->d_media_blksize;
610         }
611
612         /*
613          * The si_* fields for rawdev are not set until after the
614          * disk_create() call, so someone using the cooked version
615          * of the raw device (i.e. da0s0) will not get the right
616          * si_iosize_max unless we fix it up here.
617          */
618         if (disk->d_cdev && disk->d_rawdev &&
619             disk->d_cdev->si_iosize_max == 0) {
620                 disk->d_cdev->si_iosize_max = disk->d_rawdev->si_iosize_max;
621                 disk->d_cdev->si_bsize_phys = disk->d_rawdev->si_bsize_phys;
622                 disk->d_cdev->si_bsize_best = disk->d_rawdev->si_bsize_best;
623         }
624
625         /* Add the serial number to the udev_dictionary */
626         if (info->d_serialno)
627                 udev_dict_set_cstr(disk->d_cdev, "serno", info->d_serialno);
628 }
629
630 /*
631  * Disk drivers must call this routine when media parameters are available
632  * or have changed.
633  */
634 void
635 disk_setdiskinfo(struct disk *disk, struct disk_info *info)
636 {
637         _setdiskinfo(disk, info);
638         disk_msg_send(DISK_DISK_PROBE, disk, NULL);
639         disk_debug(1,
640                     "disk_setdiskinfo: sent probe for %s\n",
641                         disk->d_cdev->si_name);
642 }
643
644 void
645 disk_setdiskinfo_sync(struct disk *disk, struct disk_info *info)
646 {
647         _setdiskinfo(disk, info);
648         disk_msg_send_sync(DISK_DISK_PROBE, disk, NULL);
649         disk_debug(1,
650                     "disk_setdiskinfo_sync: sent probe for %s\n",
651                         disk->d_cdev->si_name);
652 }
653
654 /*
655  * This routine is called when an adapter detaches.  The higher level
656  * managed disk device is destroyed while the lower level raw device is
657  * released.
658  */
659 void
660 disk_destroy(struct disk *disk)
661 {
662         dsched_disk_destroy_callback(disk);
663         disk_msg_send_sync(DISK_DISK_DESTROY, disk, NULL);
664         return;
665 }
666
667 int
668 disk_dumpcheck(cdev_t dev, u_int64_t *size, u_int64_t *blkno, u_int32_t *secsize)
669 {
670         struct partinfo pinfo;
671         int error;
672
673         bzero(&pinfo, sizeof(pinfo));
674         error = dev_dioctl(dev, DIOCGPART, (void *)&pinfo, 0,
675                            proc0.p_ucred, NULL);
676         if (error)
677                 return (error);
678
679         if (pinfo.media_blksize == 0)
680                 return (ENXIO);
681
682         if (blkno) /* XXX: make sure this reserved stuff is right */
683                 *blkno = pinfo.reserved_blocks +
684                         pinfo.media_offset / pinfo.media_blksize;
685         if (secsize)
686                 *secsize = pinfo.media_blksize;
687         if (size)
688                 *size = (pinfo.media_blocks - pinfo.reserved_blocks);
689
690         return (0);
691 }
692
693 int
694 disk_dumpconf(cdev_t dev, u_int onoff)
695 {
696         struct dumperinfo di;
697         u_int64_t       size, blkno;
698         u_int32_t       secsize;
699         int error;
700
701         if (!onoff)
702                 return set_dumper(NULL);
703
704         error = disk_dumpcheck(dev, &size, &blkno, &secsize);
705
706         if (error)
707                 return ENXIO;
708
709         bzero(&di, sizeof(struct dumperinfo));
710         di.dumper = diskdump;
711         di.priv = dev;
712         di.blocksize = secsize;
713         di.mediaoffset = blkno * DEV_BSIZE;
714         di.mediasize = size * DEV_BSIZE;
715
716         return set_dumper(&di);
717 }
718
719 void
720 disk_unprobe(struct disk *disk)
721 {
722         if (disk == NULL)
723                 return;
724
725         disk_msg_send_sync(DISK_UNPROBE, disk, NULL);
726 }
727
728 void
729 disk_invalidate (struct disk *disk)
730 {
731         dsgone(&disk->d_slice);
732 }
733
734 struct disk *
735 disk_enumerate(struct disk *disk)
736 {
737         struct disk *dp;
738
739         lwkt_gettoken(&disklist_token);
740         if (!disk)
741                 dp = (LIST_FIRST(&disklist));
742         else
743                 dp = (LIST_NEXT(disk, d_list));
744         lwkt_reltoken(&disklist_token);
745
746         return dp;
747 }
748
749 static
750 int
751 sysctl_disks(SYSCTL_HANDLER_ARGS)
752 {
753         struct disk *disk;
754         int error, first;
755
756         disk = NULL;
757         first = 1;
758
759         while ((disk = disk_enumerate(disk))) {
760                 if (!first) {
761                         error = SYSCTL_OUT(req, " ", 1);
762                         if (error)
763                                 return error;
764                 } else {
765                         first = 0;
766                 }
767                 error = SYSCTL_OUT(req, disk->d_rawdev->si_name,
768                                    strlen(disk->d_rawdev->si_name));
769                 if (error)
770                         return error;
771         }
772         error = SYSCTL_OUT(req, "", 1);
773         return error;
774 }
775
776 SYSCTL_PROC(_kern, OID_AUTO, disks, CTLTYPE_STRING | CTLFLAG_RD, NULL, 0,
777     sysctl_disks, "A", "names of available disks");
778
779 /*
780  * Open a disk device or partition.
781  */
782 static
783 int
784 diskopen(struct dev_open_args *ap)
785 {
786         cdev_t dev = ap->a_head.a_dev;
787         struct disk *dp;
788         int error;
789
790         /*
791          * dp can't be NULL here XXX.
792          *
793          * d_slice will be NULL if setdiskinfo() has not been called yet.
794          * setdiskinfo() is typically called whether the disk is present
795          * or not (e.g. CD), but the base disk device is created first
796          * and there may be a race.
797          */
798         dp = dev->si_disk;
799         if (dp == NULL || dp->d_slice == NULL)
800                 return (ENXIO);
801         error = 0;
802
803         /*
804          * Deal with open races
805          */
806         get_mplock();
807         while (dp->d_flags & DISKFLAG_LOCK) {
808                 dp->d_flags |= DISKFLAG_WANTED;
809                 error = tsleep(dp, PCATCH, "diskopen", hz);
810                 if (error) {
811                         rel_mplock();
812                         return (error);
813                 }
814         }
815         dp->d_flags |= DISKFLAG_LOCK;
816
817         /*
818          * Open the underlying raw device.
819          */
820         if (!dsisopen(dp->d_slice)) {
821 #if 0
822                 if (!pdev->si_iosize_max)
823                         pdev->si_iosize_max = dev->si_iosize_max;
824 #endif
825                 error = dev_dopen(dp->d_rawdev, ap->a_oflags,
826                                   ap->a_devtype, ap->a_cred);
827         }
828 #if 0
829         /*
830          * Inherit properties from the underlying device now that it is
831          * open.
832          */
833         dev_dclone(dev);
834 #endif
835
836         if (error)
837                 goto out;
838         error = dsopen(dev, ap->a_devtype, dp->d_info.d_dsflags,
839                        &dp->d_slice, &dp->d_info);
840         if (!dsisopen(dp->d_slice)) {
841                 dev_dclose(dp->d_rawdev, ap->a_oflags, ap->a_devtype);
842         }
843 out:
844         dp->d_flags &= ~DISKFLAG_LOCK;
845         if (dp->d_flags & DISKFLAG_WANTED) {
846                 dp->d_flags &= ~DISKFLAG_WANTED;
847                 wakeup(dp);
848         }
849         rel_mplock();
850
851         return(error);
852 }
853
854 /*
855  * Close a disk device or partition
856  */
857 static
858 int
859 diskclose(struct dev_close_args *ap)
860 {
861         cdev_t dev = ap->a_head.a_dev;
862         struct disk *dp;
863         int error;
864
865         error = 0;
866         dp = dev->si_disk;
867
868         get_mplock();
869         dsclose(dev, ap->a_devtype, dp->d_slice);
870         if (!dsisopen(dp->d_slice)) {
871                 error = dev_dclose(dp->d_rawdev, ap->a_fflag, ap->a_devtype);
872         }
873         rel_mplock();
874         return (error);
875 }
876
877 /*
878  * First execute the ioctl on the disk device, and if it isn't supported
879  * try running it on the backing device.
880  */
881 static
882 int
883 diskioctl(struct dev_ioctl_args *ap)
884 {
885         cdev_t dev = ap->a_head.a_dev;
886         struct disk *dp;
887         int error;
888         u_int u;
889
890         dp = dev->si_disk;
891         if (dp == NULL)
892                 return (ENXIO);
893
894         devfs_debug(DEVFS_DEBUG_DEBUG,
895                     "diskioctl: cmd is: %lx (name: %s)\n",
896                     ap->a_cmd, dev->si_name);
897         devfs_debug(DEVFS_DEBUG_DEBUG,
898                     "diskioctl: &dp->d_slice is: %p, %p\n",
899                     &dp->d_slice, dp->d_slice);
900
901         if (ap->a_cmd == DIOCGKERNELDUMP) {
902                 u = *(u_int *)ap->a_data;
903                 return disk_dumpconf(dev, u);
904         }
905
906         if (&dp->d_slice == NULL || dp->d_slice == NULL) {
907                 error = ENOIOCTL;
908         } else {
909                 get_mplock();
910                 error = dsioctl(dev, ap->a_cmd, ap->a_data, ap->a_fflag,
911                                 &dp->d_slice, &dp->d_info);
912                 rel_mplock();
913         }
914
915         if (error == ENOIOCTL) {
916                 error = dev_dioctl(dp->d_rawdev, ap->a_cmd, ap->a_data,
917                                    ap->a_fflag, ap->a_cred, NULL);
918         }
919         return (error);
920 }
921
922 /*
923  * Execute strategy routine
924  */
925 static
926 int
927 diskstrategy(struct dev_strategy_args *ap)
928 {
929         cdev_t dev = ap->a_head.a_dev;
930         struct bio *bio = ap->a_bio;
931         struct bio *nbio;
932         struct disk *dp;
933
934         dp = dev->si_disk;
935
936         if (dp == NULL) {
937                 bio->bio_buf->b_error = ENXIO;
938                 bio->bio_buf->b_flags |= B_ERROR;
939                 biodone(bio);
940                 return(0);
941         }
942         KKASSERT(dev->si_disk == dp);
943
944         /*
945          * The dscheck() function will also transform the slice relative
946          * block number i.e. bio->bio_offset into a block number that can be
947          * passed directly to the underlying raw device.  If dscheck()
948          * returns NULL it will have handled the bio for us (e.g. EOF
949          * or error due to being beyond the device size).
950          */
951         if ((nbio = dscheck(dev, bio, dp->d_slice)) != NULL) {
952                 dsched_queue(dp, nbio);
953         } else {
954                 biodone(bio);
955         }
956         return(0);
957 }
958
959 /*
960  * Return the partition size in ?blocks?
961  */
962 static
963 int
964 diskpsize(struct dev_psize_args *ap)
965 {
966         cdev_t dev = ap->a_head.a_dev;
967         struct disk *dp;
968
969         dp = dev->si_disk;
970         if (dp == NULL)
971                 return(ENODEV);
972         ap->a_result = dssize(dev, &dp->d_slice);
973         return(0);
974 }
975
976 /*
977  * When new device entries are instantiated, make sure they inherit our
978  * si_disk structure and block and iosize limits from the raw device.
979  *
980  * This routine is always called synchronously in the context of the
981  * client.
982  *
983  * XXX The various io and block size constraints are not always initialized
984  * properly by devices.
985  */
986 static
987 int
988 diskclone(struct dev_clone_args *ap)
989 {
990         cdev_t dev = ap->a_head.a_dev;
991         struct disk *dp;
992         dp = dev->si_disk;
993
994         KKASSERT(dp != NULL);
995         dev->si_disk = dp;
996         dev->si_iosize_max = dp->d_rawdev->si_iosize_max;
997         dev->si_bsize_phys = dp->d_rawdev->si_bsize_phys;
998         dev->si_bsize_best = dp->d_rawdev->si_bsize_best;
999         return(0);
1000 }
1001
1002 int
1003 diskdump(struct dev_dump_args *ap)
1004 {
1005         cdev_t dev = ap->a_head.a_dev;
1006         struct disk *dp = dev->si_disk;
1007         u_int64_t size, offset;
1008         int error;
1009
1010         error = disk_dumpcheck(dev, &size, &ap->a_blkno, &ap->a_secsize);
1011         /* XXX: this should probably go in disk_dumpcheck somehow */
1012         if (ap->a_length != 0) {
1013                 size *= DEV_BSIZE;
1014                 offset = ap->a_blkno * DEV_BSIZE;
1015                 if ((ap->a_offset < offset) ||
1016                     (ap->a_offset + ap->a_length - offset > size)) {
1017                         kprintf("Attempt to write outside dump device boundaries.\n");
1018                         error = ENOSPC;
1019                 }
1020         }
1021
1022         if (error == 0) {
1023                 ap->a_head.a_dev = dp->d_rawdev;
1024                 error = dev_doperate(&ap->a_head);
1025         }
1026
1027         return(error);
1028 }
1029
1030
1031 SYSCTL_INT(_debug_sizeof, OID_AUTO, diskslices, CTLFLAG_RD,
1032     0, sizeof(struct diskslices), "sizeof(struct diskslices)");
1033
1034 SYSCTL_INT(_debug_sizeof, OID_AUTO, disk, CTLFLAG_RD,
1035     0, sizeof(struct disk), "sizeof(struct disk)");
1036
1037 /*
1038  * Reorder interval for burst write allowance and minor write
1039  * allowance.
1040  *
1041  * We always want to trickle some writes in to make use of the
1042  * disk's zone cache.  Bursting occurs on a longer interval and only
1043  * runningbufspace is well over the hirunningspace limit.
1044  */
1045 int bioq_reorder_burst_interval = 60;   /* should be multiple of minor */
1046 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_burst_interval,
1047            CTLFLAG_RW, &bioq_reorder_burst_interval, 0, "");
1048 int bioq_reorder_minor_interval = 5;
1049 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_minor_interval,
1050            CTLFLAG_RW, &bioq_reorder_minor_interval, 0, "");
1051
1052 int bioq_reorder_burst_bytes = 3000000;
1053 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_burst_bytes,
1054            CTLFLAG_RW, &bioq_reorder_burst_bytes, 0, "");
1055 int bioq_reorder_minor_bytes = 262144;
1056 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_minor_bytes,
1057            CTLFLAG_RW, &bioq_reorder_minor_bytes, 0, "");
1058
1059
1060 /*
1061  * Order I/Os.  Generally speaking this code is designed to make better
1062  * use of drive zone caches.  A drive zone cache can typically track linear
1063  * reads or writes for around 16 zones simultaniously.
1064  *
1065  * Read prioritization issues:  It is possible for hundreds of megabytes worth
1066  * of writes to be queued asynchronously.  This creates a huge bottleneck
1067  * for reads which reduce read bandwidth to a trickle.
1068  *
1069  * To solve this problem we generally reorder reads before writes.
1070  *
1071  * However, a large number of random reads can also starve writes and
1072  * make poor use of the drive zone cache so we allow writes to trickle
1073  * in every N reads.
1074  */
1075 void
1076 bioqdisksort(struct bio_queue_head *bioq, struct bio *bio)
1077 {
1078         /*
1079          * The BIO wants to be ordered.  Adding to the tail also
1080          * causes transition to be set to NULL, forcing the ordering
1081          * of all prior I/O's.
1082          */
1083         if (bio->bio_buf->b_flags & B_ORDERED) {
1084                 bioq_insert_tail(bioq, bio);
1085                 return;
1086         }
1087
1088         switch(bio->bio_buf->b_cmd) {
1089         case BUF_CMD_READ:
1090                 if (bioq->transition) {
1091                         /*
1092                          * Insert before the first write.  Bleedover writes
1093                          * based on reorder intervals to prevent starvation.
1094                          */
1095                         TAILQ_INSERT_BEFORE(bioq->transition, bio, bio_act);
1096                         ++bioq->reorder;
1097                         if (bioq->reorder % bioq_reorder_minor_interval == 0) {
1098                                 bioqwritereorder(bioq);
1099                                 if (bioq->reorder >=
1100                                     bioq_reorder_burst_interval) {
1101                                         bioq->reorder = 0;
1102                                 }
1103                         }
1104                 } else {
1105                         /*
1106                          * No writes queued (or ordering was forced),
1107                          * insert at tail.
1108                          */
1109                         TAILQ_INSERT_TAIL(&bioq->queue, bio, bio_act);
1110                 }
1111                 break;
1112         case BUF_CMD_WRITE:
1113                 /*
1114                  * Writes are always appended.  If no writes were previously
1115                  * queued or an ordered tail insertion occured the transition
1116                  * field will be NULL.
1117                  */
1118                 TAILQ_INSERT_TAIL(&bioq->queue, bio, bio_act);
1119                 if (bioq->transition == NULL)
1120                         bioq->transition = bio;
1121                 break;
1122         default:
1123                 /*
1124                  * All other request types are forced to be ordered.
1125                  */
1126                 bioq_insert_tail(bioq, bio);
1127                 break;
1128         }
1129 }
1130
1131 /*
1132  * Move the read-write transition point to prevent reads from
1133  * completely starving our writes.  This brings a number of writes into
1134  * the fold every N reads.
1135  *
1136  * We bring a few linear writes into the fold on a minor interval
1137  * and we bring a non-linear burst of writes into the fold on a major
1138  * interval.  Bursting only occurs if runningbufspace is really high
1139  * (typically from syncs, fsyncs, or HAMMER flushes).
1140  */
1141 static
1142 void
1143 bioqwritereorder(struct bio_queue_head *bioq)
1144 {
1145         struct bio *bio;
1146         off_t next_offset;
1147         size_t left;
1148         size_t n;
1149         int check_off;
1150
1151         if (bioq->reorder < bioq_reorder_burst_interval ||
1152             !buf_runningbufspace_severe()) {
1153                 left = (size_t)bioq_reorder_minor_bytes;
1154                 check_off = 1;
1155         } else {
1156                 left = (size_t)bioq_reorder_burst_bytes;
1157                 check_off = 0;
1158         }
1159
1160         next_offset = bioq->transition->bio_offset;
1161         while ((bio = bioq->transition) != NULL &&
1162                (check_off == 0 || next_offset == bio->bio_offset)
1163         ) {
1164                 n = bio->bio_buf->b_bcount;
1165                 next_offset = bio->bio_offset + n;
1166                 bioq->transition = TAILQ_NEXT(bio, bio_act);
1167                 if (left < n)
1168                         break;
1169                 left -= n;
1170         }
1171 }
1172
1173 /*
1174  * Bounds checking against the media size, used for the raw partition.
1175  * secsize, mediasize and b_blkno must all be the same units.
1176  * Possibly this has to be DEV_BSIZE (512).
1177  */
1178 int
1179 bounds_check_with_mediasize(struct bio *bio, int secsize, uint64_t mediasize)
1180 {
1181         struct buf *bp = bio->bio_buf;
1182         int64_t sz;
1183
1184         sz = howmany(bp->b_bcount, secsize);
1185
1186         if (bio->bio_offset/DEV_BSIZE + sz > mediasize) {
1187                 sz = mediasize - bio->bio_offset/DEV_BSIZE;
1188                 if (sz == 0) {
1189                         /* If exactly at end of disk, return EOF. */
1190                         bp->b_resid = bp->b_bcount;
1191                         return 0;
1192                 }
1193                 if (sz < 0) {
1194                         /* If past end of disk, return EINVAL. */
1195                         bp->b_error = EINVAL;
1196                         return 0;
1197                 }
1198                 /* Otherwise, truncate request. */
1199                 bp->b_bcount = sz * secsize;
1200         }
1201
1202         return 1;
1203 }
1204
1205 /*
1206  * Disk error is the preface to plaintive error messages
1207  * about failing disk transfers.  It prints messages of the form
1208
1209 hp0g: hard error reading fsbn 12345 of 12344-12347 (hp0 bn %d cn %d tn %d sn %d)
1210
1211  * if the offset of the error in the transfer and a disk label
1212  * are both available.  blkdone should be -1 if the position of the error
1213  * is unknown; the disklabel pointer may be null from drivers that have not
1214  * been converted to use them.  The message is printed with kprintf
1215  * if pri is LOG_PRINTF, otherwise it uses log at the specified priority.
1216  * The message should be completed (with at least a newline) with kprintf
1217  * or log(-1, ...), respectively.  There is no trailing space.
1218  */
1219 void
1220 diskerr(struct bio *bio, cdev_t dev, const char *what, int pri, int donecnt)
1221 {
1222         struct buf *bp = bio->bio_buf;
1223         const char *term;
1224
1225         switch(bp->b_cmd) {
1226         case BUF_CMD_READ:
1227                 term = "read";
1228                 break;
1229         case BUF_CMD_WRITE:
1230                 term = "write";
1231                 break;
1232         default:
1233                 term = "access";
1234                 break;
1235         }
1236         kprintf("%s: %s %sing ", dev->si_name, what, term);
1237         kprintf("offset %012llx for %d",
1238                 (long long)bio->bio_offset,
1239                 bp->b_bcount);
1240
1241         if (donecnt)
1242                 kprintf(" (%d bytes completed)", donecnt);
1243 }
1244
1245 /*
1246  * Locate a disk device
1247  */
1248 cdev_t
1249 disk_locate(const char *devname)
1250 {
1251         return devfs_find_device_by_name(devname);
1252 }
1253
1254 void
1255 disk_config(void *arg)
1256 {
1257         disk_msg_send_sync(DISK_SYNC, NULL, NULL);
1258 }
1259
1260 static void
1261 disk_init(void)
1262 {
1263         struct thread* td_core;
1264
1265         disk_msg_cache = objcache_create("disk-msg-cache", 0, 0,
1266                                          NULL, NULL, NULL,
1267                                          objcache_malloc_alloc,
1268                                          objcache_malloc_free,
1269                                          &disk_msg_malloc_args);
1270
1271         lwkt_token_init(&disklist_token, 1, "disks");
1272
1273         /*
1274          * Initialize the reply-only port which acts as a message drain
1275          */
1276         lwkt_initport_replyonly(&disk_dispose_port, disk_msg_autofree_reply);
1277
1278         lwkt_create(disk_msg_core, /*args*/NULL, &td_core, NULL,
1279                     0, 0, "disk_msg_core");
1280
1281         tsleep(td_core, 0, "diskcore", 0);
1282 }
1283
1284 static void
1285 disk_uninit(void)
1286 {
1287         objcache_destroy(disk_msg_cache);
1288 }
1289
1290 /*
1291  * Clean out illegal characters in serial numbers.
1292  */
1293 static void
1294 disk_cleanserial(char *serno)
1295 {
1296         char c;
1297
1298         while ((c = *serno) != 0) {
1299                 if (c >= 'a' && c <= 'z')
1300                         ;
1301                 else if (c >= 'A' && c <= 'Z')
1302                         ;
1303                 else if (c >= '0' && c <= '9')
1304                         ;
1305                 else if (c == '-' || c == '@' || c == '+' || c == '.')
1306                         ;
1307                 else
1308                         c = '_';
1309                 *serno++= c;
1310         }
1311 }
1312
1313 TUNABLE_INT("kern.disk_debug", &disk_debug_enable);
1314 SYSCTL_INT(_kern, OID_AUTO, disk_debug, CTLFLAG_RW, &disk_debug_enable,
1315                 0, "Enable subr_disk debugging");
1316
1317 SYSINIT(disk_register, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST, disk_init, NULL);
1318 SYSUNINIT(disk_register, SI_SUB_PRE_DRIVERS, SI_ORDER_ANY, disk_uninit, NULL);