multipath-tools: replace leading spaces with tabs
[multipath-tools/.git] / kpartx / dasd.h
1 /*
2  * dasd.h
3  *
4  * IBM DASD partition table handling.
5  *
6  * Mostly taken from drivers/s390/block/dasd.c
7  *
8  * Copyright (c) 2005, Hannes Reinecke, SUSE Linux Products GmbH
9  * Copyright IBM Corporation, 2009
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24
25 #ifndef _DASD_H
26 #define _DASD_H
27
28 typedef struct ttr
29 {
30         uint16_t tt;
31         uint8_t  r;
32 } __attribute__ ((packed)) ttr_t;
33
34 typedef struct cchhb
35 {
36         uint16_t cc;
37         uint16_t hh;
38         uint8_t b;
39 } __attribute__ ((packed)) cchhb_t;
40
41 typedef struct cchh
42 {
43         uint16_t cc;
44         uint16_t hh;
45 } __attribute__ ((packed)) cchh_t;
46
47 typedef struct labeldate
48 {
49         uint8_t  year;
50         uint16_t day;
51 } __attribute__ ((packed)) labeldate_t;
52
53
54 typedef struct volume_label
55 {
56         char volkey[4];         /* volume key = volume label                 */
57         char vollbl[4];         /* volume label                              */
58         char volid[6];          /* volume identifier                         */
59         uint8_t security;               /* security byte                             */
60         cchhb_t vtoc;           /* VTOC address                              */
61         char res1[5];           /* reserved                                  */
62         char cisize[4];         /* CI-size for FBA,...                       */
63                                 /* ...blanks for CKD                         */
64         char blkperci[4];       /* no of blocks per CI (FBA), blanks for CKD */
65         char labperci[4];       /* no of labels per CI (FBA), blanks for CKD */
66         char res2[4];           /* reserved                                  */
67         char lvtoc[14];         /* owner code for LVTOC                      */
68         char res3[28];          /* reserved                                  */
69         uint8_t ldl_version;    /* version number, valid for ldl format      */
70         uint64_t formatted_blocks; /* valid when ldl_version >= f2           */
71 } __attribute__ ((packed)) volume_label_t;
72
73
74 typedef struct extent
75 {
76         uint8_t  typeind;          /* extent type indicator                     */
77         uint8_t  seqno;            /* extent sequence number                    */
78         cchh_t llimit;          /* starting point of this extent             */
79         cchh_t ulimit;          /* ending point of this extent               */
80 } __attribute__ ((packed)) extent_t;
81
82
83 typedef struct dev_const
84 {
85         uint16_t DS4DSCYL;           /* number of logical cyls                  */
86         uint16_t DS4DSTRK;           /* number of tracks in a logical cylinder  */
87         uint16_t DS4DEVTK;           /* device track length                     */
88         uint8_t  DS4DEVI;            /* non-last keyed record overhead          */
89         uint8_t  DS4DEVL;            /* last keyed record overhead              */
90         uint8_t  DS4DEVK;            /* non-keyed record overhead differential  */
91         uint8_t  DS4DEVFG;           /* flag byte                               */
92         uint16_t DS4DEVTL;           /* device tolerance                        */
93         uint8_t  DS4DEVDT;           /* number of DSCB's per track              */
94         uint8_t  DS4DEVDB;           /* number of directory blocks per track    */
95 } __attribute__ ((packed)) dev_const_t;
96
97
98 typedef struct format1_label
99 {
100         char  DS1DSNAM[44];       /* data set name                           */
101         uint8_t  DS1FMTID;           /* format identifier                       */
102         char  DS1DSSN[6];         /* data set serial number                  */
103         uint16_t DS1VOLSQ;           /* volume sequence number                  */
104         labeldate_t DS1CREDT;     /* creation date: ydd                      */
105         labeldate_t DS1EXPDT;     /* expiration date                         */
106         uint8_t  DS1NOEPV;           /* number of extents on volume             */
107         uint8_t  DS1NOBDB;           /* no. of bytes used in last direction blk */
108         uint8_t  DS1FLAG1;           /* flag 1                                  */
109         char  DS1SYSCD[13];       /* system code                             */
110         labeldate_t DS1REFD;      /* date last referenced                    */
111         uint8_t  DS1SMSFG;           /* system managed storage indicators       */
112         uint8_t  DS1SCXTF;           /* sec. space extension flag byte          */
113         uint16_t DS1SCXTV;           /* secondary space extension value         */
114         uint8_t  DS1DSRG1;           /* data set organisation byte 1            */
115         uint8_t  DS1DSRG2;           /* data set organisation byte 2            */
116         uint8_t  DS1RECFM;           /* record format                           */
117         uint8_t  DS1OPTCD;           /* option code                             */
118         uint16_t DS1BLKL;            /* block length                            */
119         uint16_t DS1LRECL;           /* record length                           */
120         uint8_t  DS1KEYL;            /* key length                              */
121         uint16_t DS1RKP;             /* relative key position                   */
122         uint8_t  DS1DSIND;           /* data set indicators                     */
123         uint8_t  DS1SCAL1;           /* secondary allocation flag byte          */
124         char DS1SCAL3[3];         /* secondary allocation quantity           */
125         ttr_t DS1LSTAR;           /* last used track and block on track      */
126         uint16_t DS1TRBAL;           /* space remaining on last used track      */
127         uint16_t res1;               /* reserved                                */
128         extent_t DS1EXT1;         /* first extent description                */
129         extent_t DS1EXT2;         /* second extent description               */
130         extent_t DS1EXT3;         /* third extent description                */
131         cchhb_t DS1PTRDS;         /* possible pointer to f2 or f3 DSCB       */
132 } __attribute__ ((packed)) format1_label_t;
133
134
135 /*
136  * struct dasd_information_t
137  * represents any data about the data, which is visible to userspace
138  */
139 typedef struct dasd_information_t {
140         unsigned int devno;             /* S/390 devno */
141         unsigned int real_devno;        /* for aliases */
142         unsigned int schid;             /* S/390 subchannel identifier */
143         unsigned int cu_type  : 16;     /* from SenseID */
144         unsigned int cu_model :  8;     /* from SenseID */
145         unsigned int dev_type : 16;     /* from SenseID */
146         unsigned int dev_model : 8;     /* from SenseID */
147         unsigned int open_count;
148         unsigned int req_queue_len;
149         unsigned int chanq_len;         /* length of chanq */
150         char type[4];                   /* from discipline.name, 'none' for unknown */
151         unsigned int status;            /* current device level */
152         unsigned int label_block;       /* where to find the VOLSER */
153         unsigned int FBA_layout;        /* fixed block size (like AIXVOL) */
154         unsigned int characteristics_size;
155         unsigned int confdata_size;
156         char characteristics[64];       /* from read_device_characteristics */
157         char configuration_data[256];   /* from read_configuration_data */
158 } dasd_information_t;
159
160 #define DASD_IOCTL_LETTER        'D'
161 #define BIODASDINFO _IOR(DASD_IOCTL_LETTER,1,dasd_information_t)
162 #define BLKGETSIZE _IO(0x12,96)
163 #define BLKSSZGET _IO(0x12,104)
164 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* device size in bytes (u64 *arg)*/
165 #define LV_COMPAT_CYL 0xFFFE
166
167 /*
168  * Only compile this on S/390. Doesn't make any sense
169  * for other architectures.
170  */
171
172 static unsigned char EBCtoASC[256] =
173 {
174 /* 0x00  NUL   SOH   STX   ETX  *SEL    HT  *RNL   DEL */
175         0x00, 0x01, 0x02, 0x03, 0x07, 0x09, 0x07, 0x7F,
176 /* 0x08  -GE  -SPS  -RPT    VT    FF    CR    SO    SI */
177         0x07, 0x07, 0x07, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
178 /* 0x10  DLE   DC1   DC2   DC3  -RES   -NL    BS  -POC
179                                 -ENP  ->LF             */
180         0x10, 0x11, 0x12, 0x13, 0x07, 0x0A, 0x08, 0x07,
181 /* 0x18  CAN    EM  -UBS  -CU1  -IFS  -IGS  -IRS  -ITB
182                                                   -IUS */
183         0x18, 0x19, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07,
184 /* 0x20  -DS  -SOS    FS  -WUS  -BYP    LF   ETB   ESC
185                                 -INP                   */
186         0x07, 0x07, 0x1C, 0x07, 0x07, 0x0A, 0x17, 0x1B,
187 /* 0x28  -SA  -SFE   -SM  -CSP  -MFA   ENQ   ACK   BEL
188                      -SW                               */
189         0x07, 0x07, 0x07, 0x07, 0x07, 0x05, 0x06, 0x07,
190 /* 0x30 ----  ----   SYN   -IR   -PP  -TRN  -NBS   EOT */
191         0x07, 0x07, 0x16, 0x07, 0x07, 0x07, 0x07, 0x04,
192 /* 0x38 -SBS   -IT  -RFF  -CU3   DC4   NAK  ----   SUB */
193         0x07, 0x07, 0x07, 0x07, 0x14, 0x15, 0x07, 0x1A,
194 /* 0x40   SP   RSP           ä              ----       */
195         0x20, 0xFF, 0x83, 0x84, 0x85, 0xA0, 0x07, 0x86,
196 /* 0x48                      .     <     (     +     | */
197         0x87, 0xA4, 0x9B, 0x2E, 0x3C, 0x28, 0x2B, 0x7C,
198 /* 0x50    &                                      ---- */
199         0x26, 0x82, 0x88, 0x89, 0x8A, 0xA1, 0x8C, 0x07,
200 /* 0x58          ß     !     $     *     )     ;       */
201         0x8D, 0xE1, 0x21, 0x24, 0x2A, 0x29, 0x3B, 0xAA,
202 /* 0x60    -     /  ----     Ä  ----  ----  ----       */
203         0x2D, 0x2F, 0x07, 0x8E, 0x07, 0x07, 0x07, 0x8F,
204 /* 0x68             ----     ,     %     _     >     ? */
205         0x80, 0xA5, 0x07, 0x2C, 0x25, 0x5F, 0x3E, 0x3F,
206 /* 0x70  ---        ----  ----  ----  ----  ----  ---- */
207         0x07, 0x90, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07,
208 /* 0x78    *     `     :     #     @     '     =     " */
209         0x70, 0x60, 0x3A, 0x23, 0x40, 0x27, 0x3D, 0x22,
210 /* 0x80    *     a     b     c     d     e     f     g */
211         0x07, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
212 /* 0x88    h     i              ----  ----  ----       */
213         0x68, 0x69, 0xAE, 0xAF, 0x07, 0x07, 0x07, 0xF1,
214 /* 0x90    °     j     k     l     m     n     o     p */
215         0xF8, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F, 0x70,
216 /* 0x98    q     r                    ----        ---- */
217         0x71, 0x72, 0xA6, 0xA7, 0x91, 0x07, 0x92, 0x07,
218 /* 0xA0          ~     s     t     u     v     w     x */
219         0xE6, 0x7E, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78,
220 /* 0xA8    y     z              ----  ----  ----  ---- */
221         0x79, 0x7A, 0xAD, 0xAB, 0x07, 0x07, 0x07, 0x07,
222 /* 0xB0    ^                    ----     §  ----       */
223         0x5E, 0x9C, 0x9D, 0xFA, 0x07, 0x07, 0x07, 0xAC,
224 /* 0xB8       ----     [     ]  ----  ----  ----  ---- */
225         0xAB, 0x07, 0x5B, 0x5D, 0x07, 0x07, 0x07, 0x07,
226 /* 0xC0    {     A     B     C     D     E     F     G */
227         0x7B, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
228 /* 0xC8    H     I  ----           ö              ---- */
229         0x48, 0x49, 0x07, 0x93, 0x94, 0x95, 0xA2, 0x07,
230 /* 0xD0    }     J     K     L     M     N     O     P */
231         0x7D, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F, 0x50,
232 /* 0xD8    Q     R  ----           ü                   */
233         0x51, 0x52, 0x07, 0x96, 0x81, 0x97, 0xA3, 0x98,
234 /* 0xE0    \           S     T     U     V     W     X */
235         0x5C, 0xF6, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58,
236 /* 0xE8    Y     Z        ----     Ö  ----  ----  ---- */
237         0x59, 0x5A, 0xFD, 0x07, 0x99, 0x07, 0x07, 0x07,
238 /* 0xF0    0     1     2     3     4     5     6     7 */
239         0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
240 /* 0xF8    8     9  ----  ----     Ü  ----  ----  ---- */
241         0x38, 0x39, 0x07, 0x07, 0x9A, 0x07, 0x07, 0x07
242 };
243
244 static inline void
245 vtoc_ebcdic_dec (const char *source, char *target, int l)
246 {
247         int i;
248
249         for (i = 0; i < l; i++)
250                 target[i]=(char)EBCtoASC[(unsigned char)(source[i])];
251 }
252
253 /*
254  * compute the block number from a
255  * cyl-cyl-head-head structure
256  */
257 static inline uint64_t
258 cchh2blk (cchh_t *ptr, struct hd_geometry *geo)
259 {
260         uint64_t cyl;
261         uint16_t head;
262
263         /*decode cylinder and heads for large volumes */
264         cyl = ptr->hh & 0xFFF0;
265         cyl <<= 12;
266         cyl |= ptr->cc;
267         head = ptr->hh & 0x000F;
268         return cyl * geo->heads * geo->sectors +
269                head * geo->sectors;
270 }
271
272 /*
273  * compute the block number from a
274  * cyl-cyl-head-head-block structure
275  */
276 static inline uint64_t
277 cchhb2blk (cchhb_t *ptr, struct hd_geometry *geo)
278 {
279         uint64_t cyl;
280         uint16_t head;
281
282         /*decode cylinder and heads for large volumes */
283         cyl = ptr->hh & 0xFFF0;
284         cyl <<= 12;
285         cyl |= ptr->cc;
286         head = ptr->hh & 0x000F;
287         return  cyl * geo->heads * geo->sectors +
288                 head * geo->sectors +
289                 ptr->b;
290 }
291
292 #endif /* _DASD_H */