]> git.ipfire.org Git - thirdparty/mdadm.git/blame_incremental - mdadm.h
projects / thirdparty / mdadm.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Allow default metadata to be specified in mdadm.conf
[thirdparty/mdadm.git] / mdadm.h
... / ...
CommitLineData
1/*
2 * mdadm - manage Linux "md" devices aka RAID arrays.
3 *
4 * Copyright (C) 2001-2006 Neil Brown <neilb@suse.de>
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 _GNU_SOURCE
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__
48#include <strings.h>
49/* dietlibc has deprecated random and srandom!! */
50#define random rand
51#define srandom srand
52#endif
53
54
55#include <linux/kdev_t.h>
56/*#include <linux/fs.h> */
57#include <sys/mount.h>
58#include <asm/types.h>
59#include <sys/ioctl.h>
60#define MD_MAJOR 9
61#define MdpMinorShift 6
62
63#ifndef BLKGETSIZE64
64#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
65#endif
66
67#define DEFAULT_BITMAP_CHUNK 4096
68#define DEFAULT_BITMAP_DELAY 5
69#define DEFAULT_MAX_WRITE_BEHIND 256
70
71#include "md_u.h"
72#include "md_p.h"
73#include "bitmap.h"
74
75#include <endian.h>
76#include <byteswap.h>
77/* Redhat don't like to #include <asm/byteorder.h>, and
78 * some time include <linux/byteorder/xxx_endian.h> isn't enough,
79 * and there is no standard conversion function so... */
80#if BYTE_ORDER == LITTLE_ENDIAN
81#define __cpu_to_le16(_x) (_x)
82#define __cpu_to_le32(_x) (_x)
83#define __cpu_to_le64(_x) (_x)
84#define __le16_to_cpu(_x) (_x)
85#define __le32_to_cpu(_x) (_x)
86#define __le64_to_cpu(_x) (_x)
87#elif BYTE_ORDER == BIG_ENDIAN
88#define __cpu_to_le16(_x) bswap_16(_x)
89#define __cpu_to_le32(_x) bswap_32(_x)
90#define __cpu_to_le64(_x) bswap_64(_x)
91#define __le16_to_cpu(_x) bswap_16(_x)
92#define __le32_to_cpu(_x) bswap_32(_x)
93#define __le64_to_cpu(_x) bswap_64(_x)
94#else
95# error "unknown endianness."
96#endif
97
98
99
100/* general information that might be extracted from a superblock */
101struct mdinfo {
102 mdu_array_info_t array;
103 mdu_disk_info_t disk;
104 __u64 events;
105 int uuid[4];
106 char name[33];
107 unsigned long long data_offset;
108 unsigned long long component_size;
109 int reshape_active;
110 unsigned long long reshape_progress;
111 int new_level, delta_disks, new_layout, new_chunk;
112};
113
114struct createinfo {
115 int uid;
116 int gid;
117 int autof;
118 int mode;
119 struct supertype *supertype;
120};
121
122#define Name "mdadm"
123
124enum mode {
125 ASSEMBLE=1,
126 BUILD,
127 CREATE,
128 MANAGE,
129 MISC,
130 MONITOR,
131 GROW,
132};
133
134extern char short_options[];
135extern char short_bitmap_auto_options[];
136extern struct option long_options[];
137extern char Version[], Usage[], Help[], OptionHelp[],
138 Help_create[], Help_build[], Help_assemble[], Help_grow[],
139 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
140
141/* for option that don't have short equivilents, we assign arbitrary
142 * small numbers. '1' means an undecorated option, so we start at '2'.
143 */
144enum special_options {
145 AssumeClean = 2,
146 BitmapChunk,
147 WriteBehind,
148 ReAdd,
149 NoDegraded,
150 Sparc22,
151 BackupFile,
152 HomeHost,
153 AutoHomeHost,
154};
155
156/* structures read from config file */
157/* List of mddevice names and identifiers
158 * Identifiers can be:
159 * uuid=128-hex-uuid
160 * super-minor=decimal-minor-number-from-superblock
161 * devices=comma,separated,list,of,device,names,with,wildcards
162 *
163 * If multiple fields are present, the intersection of all matching
164 * devices is considered
165 */
166#define UnSet (0xfffe)
167typedef struct mddev_ident_s {
168 char *devname;
169
170 int uuid_set;
171 int uuid[4];
172 char name[33];
173
174 unsigned int super_minor;
175
176 char *devices; /* comma separated list of device
177 * names with wild cards
178 */
179 int level;
180 unsigned int raid_disks;
181 unsigned int spare_disks;
182 struct supertype *st;
183 int autof; /* 1 for normal, 2 for partitioned */
184 char *spare_group;
185 char *bitmap_file;
186 int bitmap_fd;
187
188 struct mddev_ident_s *next;
189} *mddev_ident_t;
190
191/* List of device names - wildcards expanded */
192typedef struct mddev_dev_s {
193 char *devname;
194 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
195 * Not set for names read from .config
196 */
197 char writemostly;
198 char re_add;
199 char used; /* set when used */
200 struct mddev_dev_s *next;
201} *mddev_dev_t;
202
203typedef struct mapping {
204 char *name;
205 int num;
206} mapping_t;
207
208
209struct mdstat_ent {
210 char *dev;
211 int devnum;
212 int active;
213 char *level;
214 char *pattern; /* U or up, _ for down */
215 int percent; /* -1 if no resync */
216 int resync; /* 1 if resync, 0 if recovery */
217 struct mdstat_ent *next;
218};
219
220extern struct mdstat_ent *mdstat_read(int hold, int start);
221extern void free_mdstat(struct mdstat_ent *ms);
222extern void mdstat_wait(int seconds);
223
224/* Data structure for holding info read from sysfs */
225struct sysdev {
226 char name[20];
227 int role;
228 int major, minor;
229 unsigned long long offset, size;
230 int state;
231 int errors;
232 struct sysdev *next;
233};
234struct sysarray {
235 char name[20];
236 struct sysdev *devs;
237 int chunk;
238 unsigned long long component_size;
239 int layout;
240 int level;
241 int spares;
242};
243/* various details can be requested */
244#define GET_LEVEL 1
245#define GET_LAYOUT 2
246#define GET_COMPONENT 4
247#define GET_CHUNK 8
248
249#define GET_DEVS 1024 /* gets role, major, minor */
250#define GET_OFFSET 2048
251#define GET_SIZE 4096
252#define GET_STATE 8192
253#define GET_ERROR 16384
254
255/* If fd >= 0, get the array it is open on,
256 * else use devnum. >=0 -> major9. <0.....
257 */
258extern struct sysarray *sysfs_read(int fd, int devnum, unsigned long options);
259extern int sysfs_set_str(struct sysarray *sra, struct sysdev *dev,
260 char *name, char *val);
261extern int sysfs_set_num(struct sysarray *sra, struct sysdev *dev,
262 char *name, unsigned long long val);
263extern int sysfs_get_ll(struct sysarray *sra, struct sysdev *dev,
264 char *name, unsigned long long *val);
265
266
267extern int save_stripes(int *source, unsigned long long *offsets,
268 int raid_disks, int chunk_size, int level, int layout,
269 int nwrites, int *dest,
270 unsigned long long start, unsigned long long length);
271extern int restore_stripes(int *dest, unsigned long long *offsets,
272 int raid_disks, int chunk_size, int level, int layout,
273 int source, unsigned long long read_offset,
274 unsigned long long start, unsigned long long length);
275
276#ifndef Sendmail
277#define Sendmail "/usr/lib/sendmail -t"
278#endif
279
280#define SYSLOG_FACILITY LOG_DAEMON
281
282extern char *map_num(mapping_t *map, int num);
283extern int map_name(mapping_t *map, char *name);
284extern mapping_t r5layout[], pers[], modes[], faultylayout[];
285
286extern char *map_dev(int major, int minor, int create);
287
288
289extern struct superswitch {
290 void (*examine_super)(void *sbv, char *homehost);
291 void (*brief_examine_super)(void *sbv);
292 void (*detail_super)(void *sbv, char *homehost);
293 void (*brief_detail_super)(void *sbv);
294 void (*uuid_from_super)(int uuid[4], void *sbv);
295 void (*getinfo_super)(struct mdinfo *info, void *sbv);
296 int (*match_home)(void *sbv, char *homehost);
297 int (*update_super)(struct mdinfo *info, void *sbv, char *update,
298 char *devname, int verbose,
299 int uuid_set, char *homehost);
300 __u64 (*event_super)(void *sbv);
301 int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info, unsigned long long size, char *name, char *homehost);
302 void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
303 int (*store_super)(struct supertype *st, int fd, void *sbv);
304 int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
305 int (*compare_super)(void **firstp, void *secondv);
306 int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
307 struct supertype * (*match_metadata_desc)(char *arg);
308 __u64 (*avail_size)(struct supertype *st, __u64 size);
309 int (*add_internal_bitmap)(struct supertype *st, void *sbv, int chunk, int delay, int write_behind,
310 unsigned long long size, int may_change, int major);
311 void (*locate_bitmap)(struct supertype *st, int fd, void *sbv);
312 int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
313 int major;
314 int swapuuid; /* true if uuid is bigending rather than hostendian */
315} super0, super1, *superlist[];
316
317struct supertype {
318 struct superswitch *ss;
319 int minor_version;
320 int max_devs;
321};
322
323extern struct supertype *super_by_version(int vers, int minor);
324extern struct supertype *guess_super(int fd);
325
326#if __GNUC__ < 3
327struct stat64;
328#endif
329
330#ifdef UCLIBC
331 struct FTW {};
332# define FTW_PHYS 1
333#else
334# include <ftw.h>
335# ifdef __dietlibc__
336# define FTW_PHYS 1
337# endif
338#endif
339
340extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
341
342
343extern int Manage_ro(char *devname, int fd, int readonly);
344extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
345extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
346extern int Manage_reconfig(char *devname, int fd, int layout);
347extern int Manage_subdevs(char *devname, int fd,
348 mddev_dev_t devlist, int verbose);
349extern int Grow_Add_device(char *devname, int fd, char *newdev);
350extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
351extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
352 long long size,
353 int level, int layout, int chunksize, int raid_disks);
354extern int Grow_restart(struct supertype *st, struct mdinfo *info,
355 int *fdlist, int cnt, char *backup_file);
356
357
358extern int Assemble(struct supertype *st, char *mddev, int mdfd,
359 mddev_ident_t ident,
360 char *conffile,
361 mddev_dev_t devlist, char *backup_file,
362 int readonly, int runstop,
363 char *update, char *homehost,
364 int verbose, int force);
365
366extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
367 int raiddisks,
368 mddev_dev_t devlist, int assume_clean,
369 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
370
371
372extern int Create(struct supertype *st, char *mddev, int mdfd,
373 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
374 char *name, char *homehost,
375 int subdevs, mddev_dev_t devlist,
376 int runstop, int verbose, int force, int assume_clean,
377 char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
378
379extern int Detail(char *dev, int brief, int test, char *homehost);
380extern int Query(char *dev);
381extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
382 struct supertype *forcest, char *homehost);
383extern int Monitor(mddev_dev_t devlist,
384 char *mailaddr, char *alert_cmd,
385 int period, int daemonise, int scan, int oneshot,
386 int dosyslog, char *config, int test, char *pidfile);
387
388extern int Kill(char *dev, int force, int quiet);
389
390extern int CreateBitmap(char *filename, int force, char uuid[16],
391 unsigned long chunksize, unsigned long daemon_sleep,
392 unsigned long write_behind,
393 unsigned long long array_size,
394 int major);
395extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
396extern int bitmap_update_uuid(int fd, int *uuid);
397
398extern int md_get_version(int fd);
399extern int get_linux_version(void);
400extern int parse_uuid(char *str, int uuid[4]);
401extern int check_ext2(int fd, char *name);
402extern int check_reiser(int fd, char *name);
403extern int check_raid(int fd, char *name);
404
405extern int get_mdp_major(void);
406extern int dev_open(char *dev, int flags);
407extern int is_standard(char *dev, int *nump);
408
409extern int parse_auto(char *str, char *msg, int config);
410extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
411extern mddev_dev_t conf_get_devs(char *conffile);
412extern struct createinfo *conf_get_create_info(char *conffile);
413extern char *conf_get_mailaddr(char *conffile);
414extern char *conf_get_mailfrom(char *conffile);
415extern char *conf_get_program(char *conffile);
416extern char *conf_get_homehost(char *conffile);
417extern char *conf_line(FILE *file);
418extern char *conf_word(FILE *file, int allow_key);
419extern void free_line(char *line);
420extern int match_oneof(char *devices, char *devname);
421extern void uuid_from_super(int uuid[4], mdp_super_t *super);
422extern int same_uuid(int a[4], int b[4], int swapuuid);
423/* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
424extern unsigned long calc_csum(void *super, int bytes);
425extern int enough(int level, int raid_disks, int layout,
426 char *avail, int avail_disks);
427extern int ask(char *mesg);
428extern unsigned long long get_component_size(int fd);
429
430
431extern char *human_size(long long bytes);
432char *human_size_brief(long long bytes);
433
434extern void put_md_name(char *name);
435extern char *get_md_name(int dev);
436
437extern char DefaultConfFile[];
438
439extern int open_mddev(char *dev, int autof);
440
441
442#define LEVEL_MULTIPATH (-4)
443#define LEVEL_LINEAR (-1)
444#define LEVEL_FAULTY (-5)
445
446
447/* faulty stuff */
448
449#define WriteTransient 0
450#define ReadTransient 1
451#define WritePersistent 2
452#define ReadPersistent 3
453#define WriteAll 4 /* doesn't go to device */
454#define ReadFixable 5
455#define Modes 6
456
457#define ClearErrors 31
458#define ClearFaults 30
459
460#define AllPersist 100 /* internal use only */
461#define NoPersist 101
462
463#define ModeMask 0x1f
464#define ModeShift 5
465
466
467#ifdef __TINYC__
468#undef minor
469#undef major
470#undef makedev
471#define minor(x) ((x)&0xff)
472#define major(x) (((x)>>8)&0xff)
473#define makedev(M,m) (((M)<<8) | (m))
474#endif
475
476/* for raid5 */
477#define ALGORITHM_LEFT_ASYMMETRIC 0
478#define ALGORITHM_RIGHT_ASYMMETRIC 1
479#define ALGORITHM_LEFT_SYMMETRIC 2
480#define ALGORITHM_RIGHT_SYMMETRIC 3
Unnamed repository; edit this file 'description' to name the repository.