]> git.ipfire.org Git - thirdparty/mdadm.git/blobdiff - mdadm.h
test: redirect all output to log file to keep output clean
[thirdparty/mdadm.git] / mdadm.h
diff --git a/mdadm.h b/mdadm.h
index fec93aab476b5f541b3252fc2e63beb3c26dcbb5..ac051178a711deb3eb52d3a724e5134f1dbccdf5 100644 (file)
--- a/mdadm.h
+++ b/mdadm.h
@@ -71,10 +71,10 @@ extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
 
 /* MAP_DIR should be somewhere that persists across the pivotroot
  * from early boot to late boot.
- * Currently /dev seems to be the only option on most distros.
+ * /run  seems to have emerged as the best standard.
  */
 #ifndef MAP_DIR
-#define MAP_DIR "/dev/.mdadm"
+#define MAP_DIR "/run/mdadm"
 #endif /* MAP_DIR */
 /* MAP_FILE is what we name the map file we put in MAP_DIR, in case you
  * want something other than the default of "map"
@@ -83,7 +83,7 @@ extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
 #define MAP_FILE "map"
 #endif /* MAP_FILE */
 /* MDMON_DIR is where pid and socket files used for communicating
- * with mdmon normally live.  It *should* be /var/run, but when
+ * with mdmon normally live.  Best is /var/run/mdadm as
  * mdmon is needed at early boot then it needs to write there prior
  * to /var/run being mounted read/write, and it also then needs to
  * persist beyond when /var/run is mounter read-only.  So, to be
@@ -91,7 +91,7 @@ extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
  * boot process and stays up as long as possible during shutdown.
  */
 #ifndef MDMON_DIR
-#define MDMON_DIR "/dev/.mdadm/"
+#define MDMON_DIR "/run/mdadm"
 #endif /* MDMON_DIR */
 
 /* FAILED_SLOTS is where to save files storing recent removal of array
@@ -99,7 +99,7 @@ extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
  * slot for array recovery
  */
 #ifndef FAILED_SLOTS_DIR
-#define FAILED_SLOTS_DIR "/dev/.mdadm/failed-slots"
+#define FAILED_SLOTS_DIR "/run/mdadm/failed-slots"
 #endif /* FAILED_SLOTS */
 
 #include       "md_u.h"
@@ -188,6 +188,7 @@ struct mdinfo {
        int                     uuid[4];
        char                    name[33];
        unsigned long long      data_offset;
+       unsigned long long      new_data_offset;
        unsigned long long      component_size; /* same as array.size, except in
                                                 * sectors and up to 64bits.
                                                 */
@@ -197,6 +198,7 @@ struct mdinfo {
 #define NO_RESHAPE             0
 #define VOLUME_RESHAPE         1
 #define CONTAINER_RESHAPE      2
+#define RESHAPE_NO_BACKUP      16 /* Mask 'or'ed in */
        int                     reshape_active;
        unsigned long long      reshape_progress;
        int                     recovery_blocked; /* for external metadata it
@@ -206,12 +208,18 @@ struct mdinfo {
                                                   * for native metadata it is
                                                   * reshape_active field mirror
                                                   */
+       /* During reshape we can sometimes change the data_offset to avoid
+        * over-writing still-valid data.  We need to know if there is space.
+        * So getinfo_super will fill in space_before and space_after in sectors.
+        * data_offset can be increased or decreased by this amount.
+        */
+       unsigned long long      space_before, space_after;
        union {
                unsigned long long resync_start; /* per-array resync position */
                unsigned long long recovery_start; /* per-device rebuild position */
                #define MaxSector  (~0ULL) /* resync/recovery complete position */
        };
-       unsigned long           bitmap_offset;  /* 0 == none, 1 == a file */
+       long                    bitmap_offset;  /* 0 == none, 1 == a file */
        unsigned long           safe_mode_delay; /* ms delay to mark clean */
        int                     new_level, delta_disks, new_layout, new_chunk;
        int                     errors;
@@ -264,6 +272,7 @@ enum mode {
        GROW,
        INCREMENTAL,
        AUTODETECT,
+       mode_count
 };
 
 extern char short_options[];
@@ -271,6 +280,7 @@ extern char short_bitmap_options[];
 extern char short_bitmap_auto_options[];
 extern struct option long_options[];
 extern char Version[], Usage[], Help[], OptionHelp[],
+       *mode_help[],
        Help_create[], Help_build[], Help_assemble[], Help_grow[],
        Help_incr[],
        Help_manage[], Help_misc[], Help_monitor[], Help_config[];
@@ -322,6 +332,14 @@ enum special_options {
        FreezeReshape,
        Continue,
        OffRootOpt,
+       Prefer,
+       KillOpt,
+       DataOffset,
+};
+
+enum prefix_standard {
+       JEDEC,
+       IEC
 };
 
 /* structures read from config file */
@@ -370,15 +388,52 @@ struct mddev_ident {
        };
 };
 
+struct context {
+       int     readonly;
+       int     runstop;
+       int     verbose;
+       int     brief;
+       int     force;
+       char    *homehost;
+       int     require_homehost;
+       char    *prefer;
+       int     export;
+       int     test;
+       char    *subarray;
+       char    *update;
+       int     scan;
+       int     SparcAdjust;
+       int     autof;
+       int     delay;
+       int     freeze_reshape;
+       char    *backup_file;
+       int     invalid_backup;
+};
+
+struct shape {
+       int     raiddisks;
+       int     sparedisks;
+       int     level;
+       int     layout;
+       char    *layout_str;
+       int     chunk;
+       int     bitmap_chunk;
+       char    *bitmap_file;
+       int     assume_clean;
+       int     write_behind;
+       unsigned long long size;
+};
+
 /* List of device names - wildcards expanded */
 struct mddev_dev {
        char *devname;
-       int disposition;        /* 'a' for add, 'r' for remove, 'f' for fail.
+       int disposition;        /* 'a' for add, 'r' for remove, 'f' for fail,
+                                * 'A' for re_add.
                                 * Not set for names read from .config
                                 */
        char writemostly;       /* 1 for 'set writemostly', 2 for 'clear writemostly' */
-       char re_add;
        char used;              /* set when used */
+       long long data_offset;
        struct mddev_dev *next;
 };
 
@@ -472,6 +527,8 @@ extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
                         char *name, char *val);
 extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
                         char *name, unsigned long long val);
+extern int sysfs_set_num_signed(struct mdinfo *sra, struct mdinfo *dev,
+                               char *name, long long val);
 extern int sysfs_uevent(struct mdinfo *sra, char *event);
 extern int sysfs_get_fd(struct mdinfo *sra, struct mdinfo *dev,
                        char *name);
@@ -532,13 +589,18 @@ extern char *map_num(mapping_t *map, int num);
 extern int map_name(mapping_t *map, char *name);
 extern mapping_t r5layout[], r6layout[], pers[], modes[], faultylayout[];
 
-extern char *map_dev(int major, int minor, int create);
+extern char *map_dev_preferred(int major, int minor, int create,
+                              char *prefer);
+static inline char *map_dev(int major, int minor, int create)
+{
+       return map_dev_preferred(major, minor, create, NULL);
+}
 
 struct active_array;
 struct metadata_update;
 
 
-/* 'struct reshape' records the intermediate states
+/* 'struct reshape' records the intermediate states of
  * a general reshape.
  * The starting geometry is converted to the 'before' geometry
  * by at most an atomic level change. They could be the same.
@@ -607,7 +669,8 @@ extern struct superswitch {
        void (*export_detail_super)(struct supertype *st);
 
        /* Optional: platform hardware / firmware details */
-       int (*detail_platform)(int verbose, int enumerate_only);
+       int (*detail_platform)(int verbose, int enumerate_only, char *controller_path);
+       int (*export_detail_platform)(int verbose, char *controller_path);
 
        /* Used:
         *   to get uuid to storing in bitmap metadata
@@ -673,13 +736,15 @@ extern struct superswitch {
         */
        int (*init_super)(struct supertype *st, mdu_array_info_t *info,
                          unsigned long long size, char *name,
-                         char *homehost, int *uuid);
+                         char *homehost, int *uuid,
+                         unsigned long long data_offset);
 
        /* update the metadata to include new device, either at create or
         * when hot-adding a spare.
         */
        int (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
-                           int fd, char *devname);
+                           int fd, char *devname,
+                           unsigned long long data_offset);
        /* update the metadata to delete a device,
         * when hot-removing.
         */
@@ -697,7 +762,8 @@ extern struct superswitch {
        int (*load_super)(struct supertype *st, int fd, char *devname);
        int (*load_container)(struct supertype *st, int fd, char *devname);
        struct supertype * (*match_metadata_desc)(char *arg);
-       __u64 (*avail_size)(struct supertype *st, __u64 size);
+       __u64 (*avail_size)(struct supertype *st, __u64 size,
+                           unsigned long long data_offset);
        unsigned long long (*min_acceptable_spare_size)(struct supertype *st);
        int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
                                   int delay, int write_behind,
@@ -724,6 +790,7 @@ extern struct superswitch {
        int (*validate_geometry)(struct supertype *st, int level, int layout,
                                 int raiddisks,
                                 int *chunk, unsigned long long size,
+                                unsigned long long data_offset,
                                 char *subdev, unsigned long long *freesize,
                                 int verbose);
 
@@ -740,9 +807,14 @@ extern struct superswitch {
         * initialized to indicate if reshape is being performed at the
         * container or subarray level
         */
-       int (*reshape_super)(struct supertype *st, long long size, int level,
+#define APPLY_METADATA_CHANGES         1
+#define ROLLBACK_METADATA_CHANGES      0
+
+       int (*reshape_super)(struct supertype *st,
+                            unsigned long long size, int level,
                             int layout, int chunksize, int raid_disks,
                             int delta_disks, char *backup, char *dev,
+                            int direction,
                             int verbose); /* optional */
        int (*manage_reshape)( /* optional */
                int afd, struct mdinfo *sra, struct reshape *reshape,
@@ -884,8 +956,6 @@ extern struct supertype *dup_super(struct supertype *st);
 extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
 extern int must_be_container(int fd);
 extern int dev_size_from_id(dev_t id, unsigned long long *size);
-extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
-                        mdu_disk_info_t *disk);
 void wait_for(char *dev, int fd);
 
 /*
@@ -1027,19 +1097,19 @@ extern int add_dev(const char *name, const struct stat *stb, int flag, struct FT
 
 
 extern int Manage_ro(char *devname, int fd, int readonly);
-extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
-extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
+extern int Manage_runstop(char *devname, int fd, int runstop, int quiet,
+                         int will_retry);
 extern int Manage_subdevs(char *devname, int fd,
                          struct mddev_dev *devlist, int verbose, int test,
                          char *update, int force);
 extern int autodetect(void);
 extern int Grow_Add_device(char *devname, int fd, char *newdev);
-extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
-extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
-                       long long size,
-                       int level, char *layout_str, int chunksize, int raid_disks,
+extern int Grow_addbitmap(char *devname, int fd,
+                         struct context *c, struct shape *s);
+extern int Grow_reshape(char *devname, int fd,
                        struct mddev_dev *devlist,
-                       int assume_clean, int force);
+                       unsigned long long data_offset,
+                       struct context *c, struct shape *s);
 extern int Grow_restart(struct supertype *st, struct mdinfo *info,
                        int *fdlist, int cnt, char *backup_file, int verbose);
 extern int Grow_continue(int mdfd, struct supertype *st,
@@ -1058,44 +1128,38 @@ extern int Grow_continue_command(char *devname, int fd,
 extern int Assemble(struct supertype *st, char *mddev,
                    struct mddev_ident *ident,
                    struct mddev_dev *devlist,
-                   char *backup_file, int invalid_backup,
-                   int readonly, int runstop,
-                   char *update, char *homehost, int require_homehost,
-                   int verbose, int force, int freeze_reshape);
-
-extern int Build(char *mddev, int chunk, int level, int layout,
-                int raiddisks, struct mddev_dev *devlist, int assume_clean,
-                char *bitmap_file, int bitmap_chunk, int write_behind,
-                int delay, int verbose, int autof, unsigned long long size);
+                   struct context *c);
 
+extern int Build(char *mddev, struct mddev_dev *devlist,
+                struct shape *s, struct context *c);
 
 extern int Create(struct supertype *st, char *mddev,
-                 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
-                 char *name, char *homehost, int *uuid,
+                 char *name, int *uuid,
                  int subdevs, struct mddev_dev *devlist,
-                 int runstop, int verbose, int force, int assume_clean,
-                 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int autof);
+                 struct shape *s,
+                 struct context *c,
+                 unsigned long long data_offset);
 
-extern int Detail(char *dev, int brief, int export, int test, char *homehost);
-extern int Detail_Platform(struct superswitch *ss, int scan, int verbose);
+extern int Detail(char *dev, struct context *c);
+extern int Detail_Platform(struct superswitch *ss, int scan, int verbose, int export, char *controller_path);
 extern int Query(char *dev);
-extern int Examine(struct mddev_dev *devlist, int brief, int export, int scan,
-                  int SparcAdjust, struct supertype *forcest, char *homehost);
+extern int Examine(struct mddev_dev *devlist, struct context *c,
+                  struct supertype *forcest);
 extern int Monitor(struct mddev_dev *devlist,
                   char *mailaddr, char *alert_cmd,
-                  int period, int daemonise, int scan, int oneshot,
-                  int dosyslog, int test, char *pidfile, int increments,
+                  struct context *c,
+                  int daemonise, int oneshot,
+                  int dosyslog, char *pidfile, int increments,
                   int share);
 
-extern int Kill(char *dev, struct supertype *st, int force, int quiet, int noexcl);
-extern int Kill_subarray(char *dev, char *subarray, int quiet);
+extern int Kill(char *dev, struct supertype *st, int force, int verbose, int noexcl);
+extern int Kill_subarray(char *dev, char *subarray, int verbose);
 extern int Update_subarray(char *dev, char *subarray, char *update, struct mddev_ident *ident, int quiet);
 extern int Wait(char *dev);
 extern int WaitClean(char *dev, int sock, int verbose);
 
-extern int Incremental(char *devname, int verbose, int runstop,
-                      struct supertype *st, char *homehost, int require_homehost,
-                      int autof, int freeze_reshape);
+extern int Incremental(char *devname, struct context *c,
+                      struct supertype *st);
 extern void RebuildMap(void);
 extern int IncrementalScan(int verbose);
 extern int IncrementalRemove(char *devname, char *path, int verbose);
@@ -1112,10 +1176,11 @@ extern unsigned long bitmap_sectors(struct bitmap_super_s *bsb);
 extern int md_get_version(int fd);
 extern int get_linux_version(void);
 extern int mdadm_version(char *version);
-extern long long parse_size(char *size);
+extern unsigned long long parse_size(char *size);
 extern int parse_uuid(char *str, int uuid[4]);
 extern int parse_layout_10(char *layout);
 extern int parse_layout_faulty(char *layout);
+extern long parse_num(char *num);
 extern int check_ext2(int fd, char *name);
 extern int check_reiser(int fd, char *name);
 extern int check_raid(int fd, char *name);
@@ -1130,6 +1195,7 @@ extern int open_dev_flags(int devnum, int flags);
 extern int open_dev_excl(int devnum);
 extern int is_standard(char *dev, int *nump);
 extern int same_dev(char *one, char *two);
+extern int compare_paths (char* path1,char* path2);
 
 extern int parse_auto(char *str, char *msg, int config);
 extern struct mddev_ident *conf_get_ident(char *dev);
@@ -1144,6 +1210,8 @@ extern char *conf_get_program(void);
 extern char *conf_get_homehost(int *require_homehostp);
 extern char *conf_line(FILE *file);
 extern char *conf_word(FILE *file, int allow_key);
+extern void print_quoted(char *str);
+extern void print_escape(char *str);
 extern int conf_name_is_free(char *name);
 extern int conf_verify_devnames(struct mddev_ident *array_list);
 extern int devname_matches(char *name, char *match);
@@ -1164,7 +1232,7 @@ extern char *fname_from_uuid(struct supertype *st,
                             struct mdinfo *info, char *buf, char sep);
 extern unsigned long calc_csum(void *super, int bytes);
 extern int enough(int level, int raid_disks, int layout, int clean,
-                  char *avail, int avail_disks);
+                  char *avail);
 extern int enough_fd(int fd);
 extern int ask(char *mesg);
 extern unsigned long long get_component_size(int fd);
@@ -1177,9 +1245,9 @@ extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
 extern int flush_metadata_updates(struct supertype *st);
 extern void append_metadata_update(struct supertype *st, void *buf, int len);
 extern int assemble_container_content(struct supertype *st, int mdfd,
-                                     struct mdinfo *content, int runstop,
-                                     char *chosen_name, int verbose,
-                                     char *backup_file, int freeze_reshape);
+                                     struct mdinfo *content,
+                                     struct context *c,
+                                     char *chosen_name);
 extern struct mdinfo *container_choose_spares(struct supertype *st,
                                              unsigned long long min_size,
                                              struct domainlist *domlist,
@@ -1194,7 +1262,7 @@ extern int set_array_info(int mdfd, struct supertype *st, struct mdinfo *info);
 unsigned long long min_recovery_start(struct mdinfo *array);
 
 extern char *human_size(long long bytes);
-extern char *human_size_brief(long long bytes);
+extern char *human_size_brief(long long bytes, int prefix);
 extern void print_r10_layout(int layout);
 
 #define NoMdDev (1<<23)
@@ -1252,10 +1320,10 @@ static inline int dev2minor(int d)
        return (-1-d) << MdpMinorShift;
 }
 
-static inline int ROUND_UP(int a, int base)
-{
-       return ((a+base-1)/base)*base;
-}
+#define _ROUND_UP(val, base)   (((val) + (base) - 1) & ~(base - 1))
+#define ROUND_UP(val, base)    _ROUND_UP(val, (typeof(val))(base))
+#define ROUND_UP_PTR(ptr, base)        ((typeof(ptr)) \
+                                (ROUND_UP((unsigned long)(ptr), base)))
 
 static inline int is_subarray(char *vers)
 {
@@ -1295,6 +1363,14 @@ static inline int xasprintf(char **strp, const char *fmt, ...) {
        return ret;
 }
 
+#define pr_err(fmt ...) fprintf(stderr, Name ": " fmt)
+#define cont_err(fmt ...) fprintf(stderr, "       " fmt)
+
+void *xmalloc(size_t len);
+void *xrealloc(void *ptr, size_t len);
+void *xcalloc(size_t num, size_t size);
+char *xstrdup(const char *str);
+
 #define        LEVEL_MULTIPATH         (-4)
 #define        LEVEL_LINEAR            (-1)
 #define        LEVEL_FAULTY            (-5)
@@ -1381,5 +1457,29 @@ static inline int xasprintf(char **strp, const char *fmt, ...) {
 #define PATH_MAX       4096
 #endif
 
-#define PROCESS_DELAYED -2
-#define PROCESS_PENDING -3
+#define RESYNC_NONE -1
+#define RESYNC_DELAYED -2
+#define RESYNC_PENDING -3
+#define RESYNC_UNKNOWN -4
+
+/* When using "GET_DISK_INFO" it isn't certain how high
+ * we need to check.  So we impose an absolute limit of
+ * MAX_DISKS.  This needs to be much more than the largest
+ * number of devices any metadata can support.  Currently
+ * v1.x can support 1920
+ */
+#define MAX_DISKS      4096
+
+/* Sometimes the 'size' value passed needs to mean "Maximum".
+ * In those cases with use MAX_SIZE
+ */
+#define MAX_SIZE       1
+
+/* We want to use unsigned numbers for sector counts, but need
+ * a value for 'invalid'.  Use '1'.
+ */
+#define INVALID_SECTORS 1
+/* And another special number needed for --data_offset=variable */
+#define VARIABLE_OFFSET 3
+
+extern int __offroot;