allow userspace to modify scsi command filter on per device basis
[linux-3.10.git] / include / linux / genhd.h
1 #ifndef _LINUX_GENHD_H
2 #define _LINUX_GENHD_H
3
4 /*
5  *      genhd.h Copyright (C) 1992 Drew Eckhardt
6  *      Generic hard disk header file by  
7  *              Drew Eckhardt
8  *
9  *              <drew@colorado.edu>
10  */
11
12 #include <linux/types.h>
13 #include <linux/kdev_t.h>
14
15 #ifdef CONFIG_BLOCK
16
17 #define kobj_to_dev(k) container_of(k, struct device, kobj)
18 #define dev_to_disk(device) container_of(device, struct gendisk, dev)
19 #define dev_to_part(device) container_of(device, struct hd_struct, dev)
20
21 extern struct device_type part_type;
22 extern struct kobject *block_depr;
23 extern struct class block_class;
24
25 extern const struct seq_operations partitions_op;
26 extern const struct seq_operations diskstats_op;
27
28 enum {
29 /* These three have identical behaviour; use the second one if DOS FDISK gets
30    confused about extended/logical partitions starting past cylinder 1023. */
31         DOS_EXTENDED_PARTITION = 5,
32         LINUX_EXTENDED_PARTITION = 0x85,
33         WIN98_EXTENDED_PARTITION = 0x0f,
34
35         SUN_WHOLE_DISK = DOS_EXTENDED_PARTITION,
36
37         LINUX_SWAP_PARTITION = 0x82,
38         LINUX_DATA_PARTITION = 0x83,
39         LINUX_LVM_PARTITION = 0x8e,
40         LINUX_RAID_PARTITION = 0xfd,    /* autodetect RAID partition */
41
42         SOLARIS_X86_PARTITION = LINUX_SWAP_PARTITION,
43         NEW_SOLARIS_X86_PARTITION = 0xbf,
44
45         DM6_AUX1PARTITION = 0x51,       /* no DDO:  use xlated geom */
46         DM6_AUX3PARTITION = 0x53,       /* no DDO:  use xlated geom */
47         DM6_PARTITION = 0x54,           /* has DDO: use xlated geom & offset */
48         EZD_PARTITION = 0x55,           /* EZ-DRIVE */
49
50         FREEBSD_PARTITION = 0xa5,       /* FreeBSD Partition ID */
51         OPENBSD_PARTITION = 0xa6,       /* OpenBSD Partition ID */
52         NETBSD_PARTITION = 0xa9,        /* NetBSD Partition ID */
53         BSDI_PARTITION = 0xb7,          /* BSDI Partition ID */
54         MINIX_PARTITION = 0x81,         /* Minix Partition ID */
55         UNIXWARE_PARTITION = 0x63,      /* Same as GNU_HURD and SCO Unix */
56 };
57
58 #include <linux/major.h>
59 #include <linux/device.h>
60 #include <linux/smp.h>
61 #include <linux/string.h>
62 #include <linux/fs.h>
63 #include <linux/workqueue.h>
64
65 struct partition {
66         unsigned char boot_ind;         /* 0x80 - active */
67         unsigned char head;             /* starting head */
68         unsigned char sector;           /* starting sector */
69         unsigned char cyl;              /* starting cylinder */
70         unsigned char sys_ind;          /* What partition type */
71         unsigned char end_head;         /* end head */
72         unsigned char end_sector;       /* end sector */
73         unsigned char end_cyl;          /* end cylinder */
74         __le32 start_sect;      /* starting sector counting from 0 */
75         __le32 nr_sects;                /* nr of sectors in partition */
76 } __attribute__((packed));
77
78 struct disk_stats {
79         unsigned long sectors[2];       /* READs and WRITEs */
80         unsigned long ios[2];
81         unsigned long merges[2];
82         unsigned long ticks[2];
83         unsigned long io_ticks;
84         unsigned long time_in_queue;
85 };
86         
87 struct hd_struct {
88         sector_t start_sect;
89         sector_t nr_sects;
90         struct device dev;
91         struct kobject *holder_dir;
92         int policy, partno;
93 #ifdef CONFIG_FAIL_MAKE_REQUEST
94         int make_it_fail;
95 #endif
96         unsigned long stamp;
97         int in_flight;
98 #ifdef  CONFIG_SMP
99         struct disk_stats *dkstats;
100 #else
101         struct disk_stats dkstats;
102 #endif
103 };
104
105 #define GENHD_FL_REMOVABLE                      1
106 #define GENHD_FL_DRIVERFS                       2
107 #define GENHD_FL_MEDIA_CHANGE_NOTIFY            4
108 #define GENHD_FL_CD                             8
109 #define GENHD_FL_UP                             16
110 #define GENHD_FL_SUPPRESS_PARTITION_INFO        32
111 #define GENHD_FL_FAIL                           64
112
113 #define BLK_SCSI_MAX_CMDS       (256)
114 #define BLK_SCSI_CMD_PER_LONG   (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
115
116 struct blk_scsi_cmd_filter {
117         unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
118         unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
119         struct kobject kobj;
120 };
121
122 struct gendisk {
123         int major;                      /* major number of driver */
124         int first_minor;
125         int minors;                     /* maximum number of minors, =1 for
126                                          * disks that can't be partitioned. */
127         char disk_name[32];             /* name of major driver */
128         struct hd_struct **part;        /* [indexed by minor] */
129         struct block_device_operations *fops;
130         struct request_queue *queue;
131         struct blk_scsi_cmd_filter cmd_filter;
132         void *private_data;
133         sector_t capacity;
134
135         int flags;
136         struct device *driverfs_dev;  // FIXME: remove
137         struct device dev;
138         struct kobject *holder_dir;
139         struct kobject *slave_dir;
140
141         struct timer_rand_state *random;
142         int policy;
143
144         atomic_t sync_io;               /* RAID */
145         unsigned long stamp;
146         int in_flight;
147 #ifdef  CONFIG_SMP
148         struct disk_stats *dkstats;
149 #else
150         struct disk_stats dkstats;
151 #endif
152         struct work_struct async_notify;
153 #ifdef  CONFIG_BLK_DEV_INTEGRITY
154         struct blk_integrity *integrity;
155 #endif
156 };
157
158 /* 
159  * Macros to operate on percpu disk statistics:
160  *
161  * The __ variants should only be called in critical sections. The full
162  * variants disable/enable preemption.
163  */
164 static inline struct hd_struct *get_part(struct gendisk *gendiskp,
165                                          sector_t sector)
166 {
167         struct hd_struct *part;
168         int i;
169         for (i = 0; i < gendiskp->minors - 1; i++) {
170                 part = gendiskp->part[i];
171                 if (part && part->start_sect <= sector
172                     && sector < part->start_sect + part->nr_sects)
173                         return part;
174         }
175         return NULL;
176 }
177
178 #ifdef  CONFIG_SMP
179 #define __disk_stat_add(gendiskp, field, addnd)         \
180         (per_cpu_ptr(gendiskp->dkstats, smp_processor_id())->field += addnd)
181
182 #define disk_stat_read(gendiskp, field)                                 \
183 ({                                                                      \
184         typeof(gendiskp->dkstats->field) res = 0;                       \
185         int i;                                                          \
186         for_each_possible_cpu(i)                                        \
187                 res += per_cpu_ptr(gendiskp->dkstats, i)->field;        \
188         res;                                                            \
189 })
190
191 static inline void disk_stat_set_all(struct gendisk *gendiskp, int value)       {
192         int i;
193
194         for_each_possible_cpu(i)
195                 memset(per_cpu_ptr(gendiskp->dkstats, i), value,
196                                 sizeof(struct disk_stats));
197 }               
198
199 #define __part_stat_add(part, field, addnd)                             \
200         (per_cpu_ptr(part->dkstats, smp_processor_id())->field += addnd)
201
202 #define __all_stat_add(gendiskp, part, field, addnd, sector)    \
203 ({                                                              \
204         if (part)                                               \
205                 __part_stat_add(part, field, addnd);            \
206         __disk_stat_add(gendiskp, field, addnd);                \
207 })
208
209 #define part_stat_read(part, field)                                     \
210 ({                                                                      \
211         typeof(part->dkstats->field) res = 0;                           \
212         int i;                                                          \
213         for_each_possible_cpu(i)                                        \
214                 res += per_cpu_ptr(part->dkstats, i)->field;            \
215         res;                                                            \
216 })
217
218 static inline void part_stat_set_all(struct hd_struct *part, int value)
219 {
220         int i;
221
222         for_each_possible_cpu(i)
223                 memset(per_cpu_ptr(part->dkstats, i), value,
224                                 sizeof(struct disk_stats));
225 }
226                                 
227 #else /* !CONFIG_SMP */
228 #define __disk_stat_add(gendiskp, field, addnd) \
229                                 (gendiskp->dkstats.field += addnd)
230 #define disk_stat_read(gendiskp, field) (gendiskp->dkstats.field)
231
232 static inline void disk_stat_set_all(struct gendisk *gendiskp, int value)
233 {
234         memset(&gendiskp->dkstats, value, sizeof (struct disk_stats));
235 }
236
237 #define __part_stat_add(part, field, addnd) \
238         (part->dkstats.field += addnd)
239
240 #define __all_stat_add(gendiskp, part, field, addnd, sector)    \
241 ({                                                              \
242         if (part)                                               \
243                 part->dkstats.field += addnd;                   \
244         __disk_stat_add(gendiskp, field, addnd);                \
245 })
246
247 #define part_stat_read(part, field)     (part->dkstats.field)
248
249 static inline void part_stat_set_all(struct hd_struct *part, int value)
250 {
251         memset(&part->dkstats, value, sizeof(struct disk_stats));
252 }
253
254 #endif /* CONFIG_SMP */
255
256 #define disk_stat_add(gendiskp, field, addnd)                   \
257         do {                                                    \
258                 preempt_disable();                              \
259                 __disk_stat_add(gendiskp, field, addnd);        \
260                 preempt_enable();                               \
261         } while (0)
262
263 #define __disk_stat_dec(gendiskp, field) __disk_stat_add(gendiskp, field, -1)
264 #define disk_stat_dec(gendiskp, field) disk_stat_add(gendiskp, field, -1)
265
266 #define __disk_stat_inc(gendiskp, field) __disk_stat_add(gendiskp, field, 1)
267 #define disk_stat_inc(gendiskp, field) disk_stat_add(gendiskp, field, 1)
268
269 #define __disk_stat_sub(gendiskp, field, subnd) \
270                 __disk_stat_add(gendiskp, field, -subnd)
271 #define disk_stat_sub(gendiskp, field, subnd) \
272                 disk_stat_add(gendiskp, field, -subnd)
273
274 #define part_stat_add(gendiskp, field, addnd)           \
275         do {                                            \
276                 preempt_disable();                      \
277                 __part_stat_add(gendiskp, field, addnd);\
278                 preempt_enable();                       \
279         } while (0)
280
281 #define __part_stat_dec(gendiskp, field) __part_stat_add(gendiskp, field, -1)
282 #define part_stat_dec(gendiskp, field) part_stat_add(gendiskp, field, -1)
283
284 #define __part_stat_inc(gendiskp, field) __part_stat_add(gendiskp, field, 1)
285 #define part_stat_inc(gendiskp, field) part_stat_add(gendiskp, field, 1)
286
287 #define __part_stat_sub(gendiskp, field, subnd) \
288                 __part_stat_add(gendiskp, field, -subnd)
289 #define part_stat_sub(gendiskp, field, subnd) \
290                 part_stat_add(gendiskp, field, -subnd)
291
292 #define all_stat_add(gendiskp, part, field, addnd, sector)      \
293         do {                                                    \
294                 preempt_disable();                              \
295                 __all_stat_add(gendiskp, part, field, addnd, sector);   \
296                 preempt_enable();                               \
297         } while (0)
298
299 #define __all_stat_dec(gendiskp, field, sector) \
300                 __all_stat_add(gendiskp, field, -1, sector)
301 #define all_stat_dec(gendiskp, field, sector) \
302                 all_stat_add(gendiskp, field, -1, sector)
303
304 #define __all_stat_inc(gendiskp, part, field, sector) \
305                 __all_stat_add(gendiskp, part, field, 1, sector)
306 #define all_stat_inc(gendiskp, part, field, sector) \
307                 all_stat_add(gendiskp, part, field, 1, sector)
308
309 #define __all_stat_sub(gendiskp, part, field, subnd, sector) \
310                 __all_stat_add(gendiskp, part, field, -subnd, sector)
311 #define all_stat_sub(gendiskp, part, field, subnd, sector) \
312                 all_stat_add(gendiskp, part, field, -subnd, sector)
313
314 /* Inlines to alloc and free disk stats in struct gendisk */
315 #ifdef  CONFIG_SMP
316 static inline int init_disk_stats(struct gendisk *disk)
317 {
318         disk->dkstats = alloc_percpu(struct disk_stats);
319         if (!disk->dkstats)
320                 return 0;
321         return 1;
322 }
323
324 static inline void free_disk_stats(struct gendisk *disk)
325 {
326         free_percpu(disk->dkstats);
327 }
328
329 static inline int init_part_stats(struct hd_struct *part)
330 {
331         part->dkstats = alloc_percpu(struct disk_stats);
332         if (!part->dkstats)
333                 return 0;
334         return 1;
335 }
336
337 static inline void free_part_stats(struct hd_struct *part)
338 {
339         free_percpu(part->dkstats);
340 }
341
342 #else   /* CONFIG_SMP */
343 static inline int init_disk_stats(struct gendisk *disk)
344 {
345         return 1;
346 }
347
348 static inline void free_disk_stats(struct gendisk *disk)
349 {
350 }
351
352 static inline int init_part_stats(struct hd_struct *part)
353 {
354         return 1;
355 }
356
357 static inline void free_part_stats(struct hd_struct *part)
358 {
359 }
360 #endif  /* CONFIG_SMP */
361
362 /* drivers/block/ll_rw_blk.c */
363 extern void disk_round_stats(struct gendisk *disk);
364 extern void part_round_stats(struct hd_struct *part);
365
366 /* drivers/block/genhd.c */
367 extern int get_blkdev_list(char *, int);
368 extern void add_disk(struct gendisk *disk);
369 extern void del_gendisk(struct gendisk *gp);
370 extern void unlink_gendisk(struct gendisk *gp);
371 extern struct gendisk *get_gendisk(dev_t dev, int *part);
372
373 extern void set_device_ro(struct block_device *bdev, int flag);
374 extern void set_disk_ro(struct gendisk *disk, int flag);
375
376 /* drivers/char/random.c */
377 extern void add_disk_randomness(struct gendisk *disk);
378 extern void rand_initialize_disk(struct gendisk *disk);
379
380 static inline sector_t get_start_sect(struct block_device *bdev)
381 {
382         return bdev->bd_contains == bdev ? 0 : bdev->bd_part->start_sect;
383 }
384 static inline sector_t get_capacity(struct gendisk *disk)
385 {
386         return disk->capacity;
387 }
388 static inline void set_capacity(struct gendisk *disk, sector_t size)
389 {
390         disk->capacity = size;
391 }
392
393 #ifdef CONFIG_SOLARIS_X86_PARTITION
394
395 #define SOLARIS_X86_NUMSLICE    16
396 #define SOLARIS_X86_VTOC_SANE   (0x600DDEEEUL)
397
398 struct solaris_x86_slice {
399         __le16 s_tag;           /* ID tag of partition */
400         __le16 s_flag;          /* permission flags */
401         __le32 s_start;         /* start sector no of partition */
402         __le32 s_size;          /* # of blocks in partition */
403 };
404
405 struct solaris_x86_vtoc {
406         unsigned int v_bootinfo[3];     /* info needed by mboot (unsupported) */
407         __le32 v_sanity;                /* to verify vtoc sanity */
408         __le32 v_version;               /* layout version */
409         char    v_volume[8];            /* volume name */
410         __le16  v_sectorsz;             /* sector size in bytes */
411         __le16  v_nparts;               /* number of partitions */
412         unsigned int v_reserved[10];    /* free space */
413         struct solaris_x86_slice
414                 v_slice[SOLARIS_X86_NUMSLICE]; /* slice headers */
415         unsigned int timestamp[SOLARIS_X86_NUMSLICE]; /* timestamp (unsupported) */
416         char    v_asciilabel[128];      /* for compatibility */
417 };
418
419 #endif /* CONFIG_SOLARIS_X86_PARTITION */
420
421 #ifdef CONFIG_BSD_DISKLABEL
422 /*
423  * BSD disklabel support by Yossi Gottlieb <yogo@math.tau.ac.il>
424  * updated by Marc Espie <Marc.Espie@openbsd.org>
425  */
426
427 /* check against BSD src/sys/sys/disklabel.h for consistency */
428
429 #define BSD_DISKMAGIC   (0x82564557UL)  /* The disk magic number */
430 #define BSD_MAXPARTITIONS       16
431 #define OPENBSD_MAXPARTITIONS   16
432 #define BSD_FS_UNUSED           0       /* disklabel unused partition entry ID */
433 struct bsd_disklabel {
434         __le32  d_magic;                /* the magic number */
435         __s16   d_type;                 /* drive type */
436         __s16   d_subtype;              /* controller/d_type specific */
437         char    d_typename[16];         /* type name, e.g. "eagle" */
438         char    d_packname[16];                 /* pack identifier */ 
439         __u32   d_secsize;              /* # of bytes per sector */
440         __u32   d_nsectors;             /* # of data sectors per track */
441         __u32   d_ntracks;              /* # of tracks per cylinder */
442         __u32   d_ncylinders;           /* # of data cylinders per unit */
443         __u32   d_secpercyl;            /* # of data sectors per cylinder */
444         __u32   d_secperunit;           /* # of data sectors per unit */
445         __u16   d_sparespertrack;       /* # of spare sectors per track */
446         __u16   d_sparespercyl;         /* # of spare sectors per cylinder */
447         __u32   d_acylinders;           /* # of alt. cylinders per unit */
448         __u16   d_rpm;                  /* rotational speed */
449         __u16   d_interleave;           /* hardware sector interleave */
450         __u16   d_trackskew;            /* sector 0 skew, per track */
451         __u16   d_cylskew;              /* sector 0 skew, per cylinder */
452         __u32   d_headswitch;           /* head switch time, usec */
453         __u32   d_trkseek;              /* track-to-track seek, usec */
454         __u32   d_flags;                /* generic flags */
455 #define NDDATA 5
456         __u32   d_drivedata[NDDATA];    /* drive-type specific information */
457 #define NSPARE 5
458         __u32   d_spare[NSPARE];        /* reserved for future use */
459         __le32  d_magic2;               /* the magic number (again) */
460         __le16  d_checksum;             /* xor of data incl. partitions */
461
462                         /* filesystem and partition information: */
463         __le16  d_npartitions;          /* number of partitions in following */
464         __le32  d_bbsize;               /* size of boot area at sn0, bytes */
465         __le32  d_sbsize;               /* max size of fs superblock, bytes */
466         struct  bsd_partition {         /* the partition table */
467                 __le32  p_size;         /* number of sectors in partition */
468                 __le32  p_offset;       /* starting sector */
469                 __le32  p_fsize;        /* filesystem basic fragment size */
470                 __u8    p_fstype;       /* filesystem type, see below */
471                 __u8    p_frag;         /* filesystem fragments per block */
472                 __le16  p_cpg;          /* filesystem cylinders per group */
473         } d_partitions[BSD_MAXPARTITIONS];      /* actually may be more */
474 };
475
476 #endif  /* CONFIG_BSD_DISKLABEL */
477
478 #ifdef CONFIG_UNIXWARE_DISKLABEL
479 /*
480  * Unixware slices support by Andrzej Krzysztofowicz <ankry@mif.pg.gda.pl>
481  * and Krzysztof G. Baranowski <kgb@knm.org.pl>
482  */
483
484 #define UNIXWARE_DISKMAGIC     (0xCA5E600DUL)   /* The disk magic number */
485 #define UNIXWARE_DISKMAGIC2    (0x600DDEEEUL)   /* The slice table magic nr */
486 #define UNIXWARE_NUMSLICE      16
487 #define UNIXWARE_FS_UNUSED     0                /* Unused slice entry ID */
488
489 struct unixware_slice {
490         __le16   s_label;       /* label */
491         __le16   s_flags;       /* permission flags */
492         __le32   start_sect;    /* starting sector */
493         __le32   nr_sects;      /* number of sectors in slice */
494 };
495
496 struct unixware_disklabel {
497         __le32   d_type;                /* drive type */
498         __le32   d_magic;                /* the magic number */
499         __le32   d_version;              /* version number */
500         char    d_serial[12];           /* serial number of the device */
501         __le32   d_ncylinders;           /* # of data cylinders per device */
502         __le32   d_ntracks;              /* # of tracks per cylinder */
503         __le32   d_nsectors;             /* # of data sectors per track */
504         __le32   d_secsize;              /* # of bytes per sector */
505         __le32   d_part_start;           /* # of first sector of this partition */
506         __le32   d_unknown1[12];         /* ? */
507         __le32  d_alt_tbl;              /* byte offset of alternate table */
508         __le32  d_alt_len;              /* byte length of alternate table */
509         __le32  d_phys_cyl;             /* # of physical cylinders per device */
510         __le32  d_phys_trk;             /* # of physical tracks per cylinder */
511         __le32  d_phys_sec;             /* # of physical sectors per track */
512         __le32  d_phys_bytes;           /* # of physical bytes per sector */
513         __le32  d_unknown2;             /* ? */
514         __le32   d_unknown3;             /* ? */
515         __le32  d_pad[8];               /* pad */
516
517         struct unixware_vtoc {
518                 __le32  v_magic;                /* the magic number */
519                 __le32  v_version;              /* version number */
520                 char    v_name[8];              /* volume name */
521                 __le16  v_nslices;              /* # of slices */
522                 __le16  v_unknown1;             /* ? */
523                 __le32  v_reserved[10];         /* reserved */
524                 struct unixware_slice
525                         v_slice[UNIXWARE_NUMSLICE];     /* slice headers */
526         } vtoc;
527
528 };  /* 408 */
529
530 #endif /* CONFIG_UNIXWARE_DISKLABEL */
531
532 #ifdef CONFIG_MINIX_SUBPARTITION
533 #   define MINIX_NR_SUBPARTITIONS  4
534 #endif /* CONFIG_MINIX_SUBPARTITION */
535
536 #define ADDPART_FLAG_NONE       0
537 #define ADDPART_FLAG_RAID       1
538 #define ADDPART_FLAG_WHOLEDISK  2
539
540 extern dev_t blk_lookup_devt(const char *name, int part);
541 extern char *disk_name (struct gendisk *hd, int part, char *buf);
542
543 extern int rescan_partitions(struct gendisk *disk, struct block_device *bdev);
544 extern void add_partition(struct gendisk *, int, sector_t, sector_t, int);
545 extern void delete_partition(struct gendisk *, int);
546 extern void printk_all_partitions(void);
547
548 extern struct gendisk *alloc_disk_node(int minors, int node_id);
549 extern struct gendisk *alloc_disk(int minors);
550 extern struct kobject *get_disk(struct gendisk *disk);
551 extern void put_disk(struct gendisk *disk);
552 extern void blk_register_region(dev_t devt, unsigned long range,
553                         struct module *module,
554                         struct kobject *(*probe)(dev_t, int *, void *),
555                         int (*lock)(dev_t, void *),
556                         void *data);
557 extern void blk_unregister_region(dev_t devt, unsigned long range);
558
559 static inline struct block_device *bdget_disk(struct gendisk *disk, int index)
560 {
561         return bdget(MKDEV(disk->major, disk->first_minor) + index);
562 }
563
564 #else /* CONFIG_BLOCK */
565
566 static inline void printk_all_partitions(void) { }
567
568 static inline dev_t blk_lookup_devt(const char *name, int part)
569 {
570         dev_t devt = MKDEV(0, 0);
571         return devt;
572 }
573
574 #endif /* CONFIG_BLOCK */
575
576 #endif /* _LINUX_GENHD_H */