]> git.ipfire.org Git - thirdparty/mdadm.git/blobdiff - mdadm.h
DDF: ddf_process_update: some more debug messages
[thirdparty/mdadm.git] / mdadm.h
diff --git a/mdadm.h b/mdadm.h
index e0837acb6234310416b707ca8f3cb16baec5baa8..fed3bc8ca015f75a8256d6e1611e530ec9580113 100644 (file)
--- a/mdadm.h
+++ b/mdadm.h
@@ -51,7 +51,6 @@ extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
 #define srandom srand
 #endif
 
-
 #include       <linux/kdev_t.h>
 /*#include     <linux/fs.h> */
 #include       <sys/mount.h>
@@ -162,7 +161,6 @@ extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
 #endif
 #endif /* __KLIBC__ */
 
-
 /*
  * min()/max()/clamp() macros that also do
  * strict type-checking.. See the
@@ -233,7 +231,7 @@ struct mdinfo {
        int container_enough; /* flag external handlers can set to
                               * indicate that subarrays have not enough (-1),
                               * enough to start (0), or all expected disks (1) */
-       char            sys_name[20];
+       char            sys_name[20];
        struct mdinfo *devs;
        struct mdinfo *next;
 
@@ -448,7 +446,6 @@ typedef struct mapping {
        int num;
 } mapping_t;
 
-
 struct mdstat_ent {
        char            *dev;
        char            devnm[32];
@@ -463,7 +460,7 @@ struct mdstat_ent {
        struct dev_member {
                char                    *name;
                struct dev_member       *next;
-       }               *members;
+       }               *members;
        struct mdstat_ent *next;
 };
 
@@ -487,12 +484,22 @@ extern int map_update(struct map_ent **mpp, char *devnm, char *metadata,
                      int uuid[4], char *path);
 extern void map_remove(struct map_ent **map, char *devnm);
 extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
+#ifdef MDASSEMBLE
+static inline struct map_ent *map_by_devnm(struct map_ent **map, char *name)
+{
+       return NULL;
+}
+static inline void map_free(struct map_ent *map)
+{
+}
+#else
 extern struct map_ent *map_by_devnm(struct map_ent **map, char *devnm);
+extern void map_free(struct map_ent *map);
+#endif
 extern struct map_ent *map_by_name(struct map_ent **map, char *name);
 extern void map_read(struct map_ent **melp);
 extern int map_write(struct map_ent *mel);
 extern void map_delete(struct map_ent **mapp, char *devnm);
-extern void map_free(struct map_ent *map);
 extern void map_add(struct map_ent **melp,
                    char *devnm, char *metadata, int uuid[4], char *path);
 extern int map_lock(struct map_ent **melp);
@@ -541,6 +548,9 @@ extern int sysfs_get_fd(struct mdinfo *sra, struct mdinfo *dev,
 extern int sysfs_fd_get_ll(int fd, unsigned long long *val);
 extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
                        char *name, unsigned long long *val);
+extern int sysfs_fd_get_two(int fd, unsigned long long *v1, unsigned long long *v2);
+extern int sysfs_get_two(struct mdinfo *sra, struct mdinfo *dev,
+                        char *name, unsigned long long *v1, unsigned long long *v2);
 extern int sysfs_fd_get_str(int fd, char *val, int size);
 extern int sysfs_attribute_available(struct mdinfo *sra, struct mdinfo *dev,
                                     char *name);
@@ -552,6 +562,7 @@ extern int sysfs_add_disk(struct mdinfo *sra, struct mdinfo *sd, int resume);
 extern int sysfs_disk_to_scsi_id(int fd, __u32 *id);
 extern int sysfs_unique_holder(char *devnm, long rdev);
 extern int sysfs_freeze_array(struct mdinfo *sra);
+extern int sysfs_wait(int fd, int *msec);
 extern int load_sys(char *path, char *buf);
 extern int reshape_prepare_fdlist(char *devname,
                                  struct mdinfo *sra,
@@ -605,7 +616,6 @@ static inline char *map_dev(int major, int minor, int create)
 struct active_array;
 struct metadata_update;
 
-
 /* 'struct reshape' records the intermediate states of
  * a general reshape.
  * The starting geometry is converted to the 'before' geometry
@@ -776,23 +786,62 @@ extern struct superswitch {
        /*  Write all metadata for this array.
         */
        int (*write_init_super)(struct supertype *st);
+       /* Check if metadata read from one device is compatible with an array,
+        * used when assembling an array, or pseudo-assembling was with
+        * "--examine --brief"
+        * If "st" has not yet been loaded the superblock from, "tst" is
+        * moved in, otherwise the superblock in 'st' is compared with
+        * 'tst'.
+        */
        int (*compare_super)(struct supertype *st, struct supertype *tst);
+       /* Load metadata from a single device.  If 'devname' is not NULL
+        * print error messages as appropriate */
        int (*load_super)(struct supertype *st, int fd, char *devname);
+       /* 'fd' is a 'container' md array - load array metadata from the
+        * whole container.
+        */
        int (*load_container)(struct supertype *st, int fd, char *devname);
+       /* If 'arg' is a valid name of this metadata type, allocate and
+        * return a 'supertype' for the particular minor version */
        struct supertype * (*match_metadata_desc)(char *arg);
+       /* If a device has the given size, and the data_offset has been
+        * requested - work out how much space is available for data.
+        * This involves adjusting for reserved space (e.g. bitmaps)
+        * and for any rounding.
+        * 'mdadm' only calls this for existing arrays where a possible
+        * spare is being added.  However some super-handlers call it
+        * internally from validate_geometry when creating an array.
+        */
        __u64 (*avail_size)(struct supertype *st, __u64 size,
                            unsigned long long data_offset);
+       /* This is similar to 'avail_size' in purpose, but is used for
+        * containers for which there is no 'component size' to compare.
+        * This reports that whole-device size which is a minimum
+        */
        unsigned long long (*min_acceptable_spare_size)(struct supertype *st);
+       /* Find somewhere to put a bitmap - possibly auto-size it - and
+        * update the metadata to record this.  The array may be newly
+        * created, in which case data_size may be updated, or it might
+        * already exist.  Metadata handler can know if init_super
+        * has been called, but not write_init_super.
+        */
        int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
                                   int delay, int write_behind,
                                   unsigned long long size, int may_change, int major);
+       /* Seek 'fd' to start of write-intent-bitmap.  Must be an
+        * md-native format bitmap
+        */
        void (*locate_bitmap)(struct supertype *st, int fd);
+       /* if add_internal_bitmap succeeded for existing array, this
+        * writes it out.
+        */
        int (*write_bitmap)(struct supertype *st, int fd);
+       /* Free the superblock and any other allocated data */
        void (*free_super)(struct supertype *st);
 
        /* validate_geometry is called with an st returned by
         * match_metadata_desc.
-        * It should check that the geometry described in compatible with
+        * It should check that the geometry described is compatible with
         * the metadata type.  It will be called repeatedly as devices
         * added to validate changing size and new devices.  If there are
         * inter-device dependencies, it should record sufficient details
@@ -802,7 +851,7 @@ extern struct superswitch {
         *  1: everything is OK
         *  0: not OK for some reason - if 'verbose', then error was reported.
         * -1: st->sb was NULL, 'subdev' is a member of a container of this
-        *     types, but array is not acceptable for some reason
+        *     type, but array is not acceptable for some reason
         *     message was reported even if verbose is 0.
         */
        int (*validate_geometry)(struct supertype *st, int level, int layout,
@@ -812,6 +861,9 @@ extern struct superswitch {
                                 char *subdev, unsigned long long *freesize,
                                 int verbose);
 
+       /* Return a linked list of 'mdinfo' structures for all arrays
+        * in the container.  For non-containers, it is like
+        * getinfo_super with an allocated mdinfo.*/
        struct mdinfo *(*container_content)(struct supertype *st, char *subarray);
        /* query the supertype for default geometry */
        void (*default_geometry)(struct supertype *st, int *level, int *layout, int *chunk); /* optional */
@@ -850,7 +902,7 @@ extern struct superswitch {
         * (in a->resync_start).
         * resync status is really irrelevant if the array is not consistent,
         * but some metadata (DDF!) have a place to record the distinction.
-        * If 'consistent' is '2', then the array can mark it dirty if a 
+        * If 'consistent' is '2', then the array can mark it dirty if a
         * resync/recovery/whatever is required, or leave it clean if not.
         * Return value is 0 dirty (not consistent) and 1 if clean.
         * it is only really important if consistent is passed in as '2'.
@@ -1114,10 +1166,10 @@ struct stat64;
 
 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
 
-
 extern int Manage_ro(char *devname, int fd, int readonly);
-extern int Manage_runstop(char *devname, int fd, int runstop, int quiet,
-                         int will_retry);
+extern int Manage_run(char *devname, int fd, int quiet);
+extern int Manage_stop(char *devname, int fd, 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);
@@ -1238,6 +1290,7 @@ extern char *conf_word(FILE *file, int allow_key);
 extern void print_quoted(char *str);
 extern void print_escape(char *str);
 extern int use_udev(void);
+extern unsigned long GCD(unsigned long a, unsigned long b);
 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);
@@ -1342,7 +1395,7 @@ extern char *fd2devnm(int fd);
 static inline int is_subarray(char *vers)
 {
        /* The version string for a 'subarray' (an array in a container)
-        * is 
+        * is
         *    /containername/componentname    for normal read-write arrays
         *    -containername/componentname    for arrays which mdmon must not
         *                                    reconfigure.  They might be read-only
@@ -1393,7 +1446,6 @@ char *xstrdup(const char *str);
 #define LEVEL_CONTAINER                (-100)
 #define        LEVEL_UNSUPPORTED       (-200)
 
-
 /* faulty stuff */
 
 #define        WriteTransient  0
@@ -1413,7 +1465,6 @@ char *xstrdup(const char *str);
 #define        ModeMask        0x1f
 #define        ModeShift       5
 
-
 #ifdef __TINYC__
 #undef minor
 #undef major
@@ -1451,7 +1502,6 @@ char *xstrdup(const char *str);
 #define ALGORITHM_ROTATING_N_RESTART   9 /* DDF PRL=6 RLQ=2 */
 #define ALGORITHM_ROTATING_N_CONTINUE  10 /*DDF PRL=6 RLQ=3 */
 
-
 /* For every RAID5 algorithm we define a RAID6 algorithm
  * with exactly the same layout for data and parity, and
  * with the Q block always on the last device (N-1).