]> git.ipfire.org Git - thirdparty/mdadm.git/blame_incremental - mdadm.h
Add ANNOUNCE-2.3.1
[thirdparty/mdadm.git] / mdadm.h
... / ...
CommitLineData
1/*
2 * mdadm - manage Linux "md" devices aka RAID arrays.
3 *
4 * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
5 *
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 *
21 * Author: Neil Brown
22 * Email: <neilb@cse.unsw.edu.au>
23 * Paper: Neil Brown
24 * School of Computer Science and Engineering
25 * The University of New South Wales
26 * Sydney, 2052
27 * Australia
28 */
29
30#define __USE_LARGEFILE64
31#include <unistd.h>
32#ifndef __dietlibc__
33extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
34#endif
35
36#include <sys/types.h>
37#include <sys/stat.h>
38#include <stdlib.h>
39#include <time.h>
40#include <sys/time.h>
41#include <getopt.h>
42#include <fcntl.h>
43#include <stdio.h>
44#include <errno.h>
45#include <string.h>
46#include <syslog.h>
47#ifdef __dietlibc__NONO
48int strncmp(const char *s1, const char *s2, size_t n) __THROW __pure__;
49char *strncpy(char *dest, const char *src, size_t n) __THROW;
50#include <strings.h>
51#endif
52
53
54#include <linux/kdev_t.h>
55/*#include <linux/fs.h> */
56#include <sys/mount.h>
57#include <asm/types.h>
58#include <sys/ioctl.h>
59#define MD_MAJOR 9
60#define MdpMinorShift 6
61
62#ifndef BLKGETSIZE64
63#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
64#endif
65
66#define DEFAULT_BITMAP_CHUNK 4096
67#define DEFAULT_BITMAP_DELAY 5
68#define DEFAULT_MAX_WRITE_BEHIND 256
69
70#include "md_u.h"
71#include "md_p.h"
72#include "bitmap.h"
73
74#include <endian.h>
75/* #include "asm/byteorder.h" Redhat don't like this so... */
76#if __BYTE_ORDER == __LITTLE_ENDIAN
77# include <linux/byteorder/little_endian.h>
78#elif __BYTE_ORDER == __BIG_ENDIAN
79# include <linux/byteorder/big_endian.h>
80#elif __BYTE_ORDER == __PDP_ENDIAN
81# include <linux/byteorder/pdp_endian.h>
82#else
83# error "unknown endianness."
84#endif
85
86
87
88/* general information that might be extracted from a superblock */
89struct mdinfo {
90 mdu_array_info_t array;
91 mdu_disk_info_t disk;
92 __u64 events;
93 int uuid[4];
94};
95
96#define Name "mdadm"
97
98enum mode {
99 ASSEMBLE=1,
100 BUILD,
101 CREATE,
102 MANAGE,
103 MISC,
104 MONITOR,
105 GROW,
106};
107
108extern char short_options[];
109extern char short_bitmap_auto_options[];
110extern struct option long_options[];
111extern char Version[], Usage[], Help[], OptionHelp[],
112 Help_create[], Help_build[], Help_assemble[], Help_grow[],
113 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
114
115/* structures read from config file */
116/* List of mddevice names and identifiers
117 * Identifiers can be:
118 * uuid=128-hex-uuid
119 * super-minor=decimal-minor-number-from-superblock
120 * devices=comma,separated,list,of,device,names,with,wildcards
121 *
122 * If multiple fields are present, the intersection of all matching
123 * devices is considered
124 */
125#define UnSet (0xfffe)
126typedef struct mddev_ident_s {
127 char *devname;
128
129 int uuid_set;
130 int uuid[4];
131 char name[33];
132
133 unsigned int super_minor;
134
135 char *devices; /* comma separated list of device
136 * names with wild cards
137 */
138 int level;
139 unsigned int raid_disks;
140 unsigned int spare_disks;
141 struct supertype *st;
142 int autof; /* 1 for normal, 2 for partitioned */
143 char *spare_group;
144 int bitmap_fd;
145
146 struct mddev_ident_s *next;
147} *mddev_ident_t;
148
149/* List of device names - wildcards expanded */
150typedef struct mddev_dev_s {
151 char *devname;
152 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
153 * Not set for names read from .config
154 */
155 char writemostly;
156 char re_add;
157 struct mddev_dev_s *next;
158} *mddev_dev_t;
159
160typedef struct mapping {
161 char *name;
162 int num;
163} mapping_t;
164
165
166struct mdstat_ent {
167 char *dev;
168 int devnum;
169 int active;
170 char *level;
171 char *pattern; /* U or up, _ for down */
172 int percent; /* -1 if no resync */
173 int resync; /* 1 if resync, 0 if recovery */
174 struct mdstat_ent *next;
175};
176
177extern struct mdstat_ent *mdstat_read(int hold, int start);
178extern void free_mdstat(struct mdstat_ent *ms);
179extern void mdstat_wait(int seconds);
180
181#ifndef Sendmail
182#define Sendmail "/usr/lib/sendmail -t"
183#endif
184
185#define SYSLOG_FACILITY LOG_DAEMON
186
187extern char *map_num(mapping_t *map, int num);
188extern int map_name(mapping_t *map, char *name);
189extern mapping_t r5layout[], pers[], modes[], faultylayout[];
190
191extern char *map_dev(int major, int minor);
192
193
194extern struct superswitch {
195 void (*examine_super)(void *sbv);
196 void (*brief_examine_super)(void *sbv);
197 void (*detail_super)(void *sbv);
198 void (*brief_detail_super)(void *sbv);
199 void (*uuid_from_super)(int uuid[4], void *sbv);
200 void (*getinfo_super)(struct mdinfo *info, mddev_ident_t ident, void *sbv);
201 int (*update_super)(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
202 __u64 (*event_super)(void *sbv);
203 int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info, unsigned long long size, char *name);
204 void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
205 int (*store_super)(struct supertype *st, int fd, void *sbv);
206 int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
207 int (*compare_super)(void **firstp, void *secondv);
208 int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
209 struct supertype * (*match_metadata_desc)(char *arg);
210 __u64 (*avail_size)(struct supertype *st, __u64 size);
211 int (*add_internal_bitmap)(struct supertype *st, void *sbv, int chunk, int delay, int write_behind,
212 unsigned long long size, int may_change, int major);
213 void (*locate_bitmap)(struct supertype *st, int fd, void *sbv);
214 int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
215 int major;
216 int swapuuid; /* true if uuid is bigending rather than hostendian */
217} super0, super1, *superlist[];
218
219struct supertype {
220 struct superswitch *ss;
221 int minor_version;
222 int max_devs;
223};
224
225extern struct supertype *super_by_version(int vers, int minor);
226extern struct supertype *guess_super(int fd);
227
228#if __GNUC__ < 3
229struct stat64;
230#endif
231
232#ifdef UCLIBC
233 struct FTW {};
234# define FTW_PHYS 1
235#else
236# define __USE_XOPEN_EXTENDED
237# include <ftw.h>
238# ifdef __dietlibc__
239# define FTW_PHYS 1
240# endif
241#endif
242
243extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
244
245
246extern int Manage_ro(char *devname, int fd, int readonly);
247extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
248extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
249extern int Manage_reconfig(char *devname, int fd, int layout);
250extern int Manage_subdevs(char *devname, int fd,
251 mddev_dev_t devlist, int verbose);
252extern int Grow_Add_device(char *devname, int fd, char *newdev);
253extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
254
255
256extern int Assemble(struct supertype *st, char *mddev, int mdfd,
257 mddev_ident_t ident,
258 char *conffile,
259 mddev_dev_t devlist,
260 int readonly, int runstop,
261 char *update,
262 int verbose, int force);
263
264extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
265 int raiddisks,
266 mddev_dev_t devlist, int assume_clean,
267 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
268
269
270extern int Create(struct supertype *st, char *mddev, int mdfd,
271 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
272 char *name,
273 int subdevs, mddev_dev_t devlist,
274 int runstop, int verbose, int force, int assume_clean,
275 char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
276
277extern int Detail(char *dev, int brief, int test);
278extern int Query(char *dev);
279extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
280 struct supertype *forcest);
281extern int Monitor(mddev_dev_t devlist,
282 char *mailaddr, char *alert_cmd,
283 int period, int daemonise, int scan, int oneshot,
284 int dosyslog, char *config, int test, char *pidfile);
285
286extern int Kill(char *dev, int force);
287
288extern int CreateBitmap(char *filename, int force, char uuid[16],
289 unsigned long chunksize, unsigned long daemon_sleep,
290 unsigned long write_behind,
291 unsigned long long array_size,
292 int major);
293extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
294
295extern int md_get_version(int fd);
296extern int get_linux_version(void);
297extern int parse_uuid(char *str, int uuid[4]);
298extern int check_ext2(int fd, char *name);
299extern int check_reiser(int fd, char *name);
300extern int check_raid(int fd, char *name);
301
302extern int get_mdp_major(void);
303extern int dev_open(char *dev, int flags);
304extern int is_standard(char *dev, int *nump);
305
306
307extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
308extern mddev_dev_t conf_get_devs(char *conffile);
309extern char *conf_get_mailaddr(char *conffile);
310extern char *conf_get_program(char *conffile);
311extern char *conf_line(FILE *file);
312extern char *conf_word(FILE *file, int allow_key);
313extern void free_line(char *line);
314extern int match_oneof(char *devices, char *devname);
315extern void uuid_from_super(int uuid[4], mdp_super_t *super);
316extern int same_uuid(int a[4], int b[4], int swapuuid);
317/* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
318extern unsigned long calc_csum(void *super, int bytes);
319extern int enough(int level, int raid_disks, int layout,
320 char *avail, int avail_disks);
321extern int ask(char *mesg);
322extern unsigned long long get_component_size(int fd);
323
324
325extern char *human_size(long long bytes);
326char *human_size_brief(long long bytes);
327
328extern void put_md_name(char *name);
329extern char *get_md_name(int dev);
330
331extern char DefaultConfFile[];
332
333extern int open_mddev(char *dev, int autof);
334
335
336#define LEVEL_MULTIPATH (-4)
337#define LEVEL_LINEAR (-1)
338#define LEVEL_FAULTY (-5)
339
340
341/* faulty stuff */
342
343#define WriteTransient 0
344#define ReadTransient 1
345#define WritePersistent 2
346#define ReadPersistent 3
347#define WriteAll 4 /* doesn't go to device */
348#define ReadFixable 5
349#define Modes 6
350
351#define ClearErrors 31
352#define ClearFaults 30
353
354#define AllPersist 100 /* internal use only */
355#define NoPersist 101
356
357#define ModeMask 0x1f
358#define ModeShift 5
359
360
361#ifdef __TINYC__
362#undef minor
363#undef major
364#undef makedev
365#define minor(x) ((x)&0xff)
366#define major(x) (((x)>>8)&0xff)
367#define makedev(M,m) (((M)<<8) | (m))
368#endif
369