Replace sysarray with mdinfo
[thirdparty/mdadm.git] / mdadm.h
CommitLineData
64c4757e 1/*
9a9dab36 2 * mdadm - manage Linux "md" devices aka RAID arrays.
64c4757e 3 *
4f589ad0 4 * Copyright (C) 2001-2006 Neil Brown <neilb@suse.de>
64c4757e
NB
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
4ccdb956 30#define _GNU_SOURCE
64c4757e 31#include <unistd.h>
e39b673e 32#if !defined(__dietlibc__) && !defined(__KLIBC__)
64c4757e 33extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
f783ca4f 34#else
fffdbe5e 35# if defined(__NO_STAT64) || __WORDSIZE != 32
f783ca4f
NB
36# define lseek64 lseek
37# endif
98c6faba 38#endif
64c4757e
NB
39
40#include <sys/types.h>
41#include <sys/stat.h>
42#include <stdlib.h>
43#include <time.h>
11018a45 44#include <sys/time.h>
64c4757e
NB
45#include <getopt.h>
46#include <fcntl.h>
47#include <stdio.h>
48#include <errno.h>
49#include <string.h>
773135f5 50#include <syslog.h>
b56c3630
NB
51#ifdef __dietlibc__
52#include <strings.h>
280a927d
NB
53/* dietlibc has deprecated random and srandom!! */
54#define random rand
55#define srandom srand
98c6faba
NB
56#endif
57
64c4757e
NB
58
59#include <linux/kdev_t.h>
e0d19036
NB
60/*#include <linux/fs.h> */
61#include <sys/mount.h>
62#include <asm/types.h>
64c4757e
NB
63#include <sys/ioctl.h>
64#define MD_MAJOR 9
dd0781e5 65#define MdpMinorShift 6
64c4757e 66
e0d19036 67#ifndef BLKGETSIZE64
98c6faba 68#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
e0d19036 69#endif
56eb10c0 70
c82f047c
NB
71#define DEFAULT_BITMAP_CHUNK 4096
72#define DEFAULT_BITMAP_DELAY 5
dfd4d8ee 73#define DEFAULT_MAX_WRITE_BEHIND 256
64c4757e
NB
74
75#include "md_u.h"
e0d19036 76#include "md_p.h"
c82f047c 77#include "bitmap.h"
64c4757e 78
1e0d770c 79#include <endian.h>
efd441d1
NB
80/* Redhat don't like to #include <asm/byteorder.h>, and
81 * some time include <linux/byteorder/xxx_endian.h> isn't enough,
82 * and there is no standard conversion function so... */
0ae03b8a
NB
83/* And dietlibc doesn't think byteswap is ok, so.. */
84/* #include <byteswap.h> */
85#define bswap_16(x) (((x) & 0x00ffU) << 8 | \
86 ((x) & 0xff00U) >> 8)
87#define bswap_32(x) (((x) & 0x000000ffU) << 24 | \
88 ((x) & 0xff000000U) >> 24 | \
89 ((x) & 0x0000ff00U) << 8 | \
90 ((x) & 0x00ff0000U) >> 8)
91#define bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
92 ((x) & 0xff00000000000000ULL) >> 56 | \
93 ((x) & 0x000000000000ff00ULL) << 40 | \
94 ((x) & 0x00ff000000000000ULL) >> 40 | \
95 ((x) & 0x0000000000ff0000ULL) << 24 | \
96 ((x) & 0x0000ff0000000000ULL) >> 24 | \
97 ((x) & 0x00000000ff000000ULL) << 8 | \
98 ((x) & 0x000000ff00000000ULL) >> 8)
99
e39b673e 100#if !defined(__KLIBC__)
efd441d1
NB
101#if BYTE_ORDER == LITTLE_ENDIAN
102#define __cpu_to_le16(_x) (_x)
103#define __cpu_to_le32(_x) (_x)
104#define __cpu_to_le64(_x) (_x)
105#define __le16_to_cpu(_x) (_x)
106#define __le32_to_cpu(_x) (_x)
107#define __le64_to_cpu(_x) (_x)
108#elif BYTE_ORDER == BIG_ENDIAN
109#define __cpu_to_le16(_x) bswap_16(_x)
110#define __cpu_to_le32(_x) bswap_32(_x)
111#define __cpu_to_le64(_x) bswap_64(_x)
112#define __le16_to_cpu(_x) bswap_16(_x)
113#define __le32_to_cpu(_x) bswap_32(_x)
114#define __le64_to_cpu(_x) bswap_64(_x)
1e0d770c
NB
115#else
116# error "unknown endianness."
117#endif
e39b673e 118#endif /* __KLIBC__ */
1e0d770c
NB
119
120
121
4b1ac34b
NB
122/* general information that might be extracted from a superblock */
123struct mdinfo {
124 mdu_array_info_t array;
125 mdu_disk_info_t disk;
126 __u64 events;
fbf8a0b7 127 int uuid[4];
31317663 128 char name[33];
353632d9
NB
129 unsigned long long data_offset;
130 unsigned long long component_size;
131 int reshape_active;
132 unsigned long long reshape_progress;
133 int new_level, delta_disks, new_layout, new_chunk;
06c7f68e 134 int errors;
7e0f6979
NB
135 int cache_size; /* size of raid456 stripe cache*/
136 int mismatch_cnt;
137 char text_version[50];
06c7f68e
NB
138
139 char sys_name[20];
7e0f6979 140 struct mdinfo *devs;
06c7f68e 141 struct mdinfo *next;
4b1ac34b
NB
142};
143
5bbb4842
NB
144struct createinfo {
145 int uid;
146 int gid;
147 int autof;
148 int mode;
38098016 149 int symlinks;
058574b1 150 struct supertype *supertype;
5bbb4842
NB
151};
152
9a9dab36 153#define Name "mdadm"
682c7051 154
e0d19036
NB
155enum mode {
156 ASSEMBLE=1,
157 BUILD,
158 CREATE,
159 MANAGE,
160 MISC,
161 MONITOR,
dd0781e5 162 GROW,
8382f19b 163 INCREMENTAL,
1f48664b 164 AUTODETECT,
e0d19036
NB
165};
166
64c4757e 167extern char short_options[];
024768c4 168extern char short_bitmap_options[];
c06487ce 169extern char short_bitmap_auto_options[];
64c4757e 170extern struct option long_options[];
56eedc1a 171extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 172 Help_create[], Help_build[], Help_assemble[], Help_grow[],
8382f19b 173 Help_incr[],
e0d19036 174 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e 175
997aed5d
NB
176/* for option that don't have short equivilents, we assign arbitrary
177 * small numbers. '1' means an undecorated option, so we start at '2'.
178 */
179enum special_options {
180 AssumeClean = 2,
181 BitmapChunk,
182 WriteBehind,
183 ReAdd,
184 NoDegraded,
185 Sparc22,
186 BackupFile,
187 HomeHost,
589395d6 188 AutoHomeHost,
38098016 189 Symlinks,
1f48664b 190 AutoDetect,
997aed5d
NB
191};
192
64c4757e 193/* structures read from config file */
52826846
NB
194/* List of mddevice names and identifiers
195 * Identifiers can be:
196 * uuid=128-hex-uuid
197 * super-minor=decimal-minor-number-from-superblock
198 * devices=comma,separated,list,of,device,names,with,wildcards
199 *
200 * If multiple fields are present, the intersection of all matching
201 * devices is considered
202 */
98c6faba 203#define UnSet (0xfffe)
52826846 204typedef struct mddev_ident_s {
dd0781e5 205 char *devname;
aba69144 206
dd0781e5 207 int uuid_set;
3fa06e9d 208 int uuid[4];
947fd4dd 209 char name[33];
52826846 210
98c6faba 211 unsigned int super_minor;
52826846 212
dd0781e5 213 char *devices; /* comma separated list of device
52826846
NB
214 * names with wild cards
215 */
dd0781e5 216 int level;
98c6faba
NB
217 unsigned int raid_disks;
218 unsigned int spare_disks;
82d9eba6 219 struct supertype *st;
dd0781e5
NB
220 int autof; /* 1 for normal, 2 for partitioned */
221 char *spare_group;
7ef02d01 222 char *bitmap_file;
c82f047c 223 int bitmap_fd;
dd0781e5 224
52826846
NB
225 struct mddev_ident_s *next;
226} *mddev_ident_t;
64c4757e
NB
227
228/* List of device names - wildcards expanded */
229typedef struct mddev_dev_s {
230 char *devname;
cd29a5c8
NB
231 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
232 * Not set for names read from .config
233 */
dfd4d8ee 234 char writemostly;
fe80f49b 235 char re_add;
811e6cbe 236 char used; /* set when used */
64c4757e
NB
237 struct mddev_dev_s *next;
238} *mddev_dev_t;
239
682c7051
NB
240typedef struct mapping {
241 char *name;
242 int num;
243} mapping_t;
244
e0d19036
NB
245
246struct mdstat_ent {
247 char *dev;
248 int devnum;
249 int active;
250 char *level;
251 char *pattern; /* U or up, _ for down */
252 int percent; /* -1 if no resync */
e5329c37 253 int resync; /* 1 if resync, 0 if recovery */
e0d19036
NB
254 struct mdstat_ent *next;
255};
256
22a88995 257extern struct mdstat_ent *mdstat_read(int hold, int start);
e0d19036 258extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 259extern void mdstat_wait(int seconds);
8382f19b
NB
260extern int mddev_busy(int devnum);
261
262struct map_ent {
263 struct map_ent *next;
264 int devnum;
265 int major,minor;
266 int uuid[4];
267 char *path;
268};
269extern int map_update(struct map_ent **mpp, int devnum, int major, int minor,
270 int uuid[4], char *path);
271extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
272extern void map_read(struct map_ent **melp);
273extern int map_write(struct map_ent *mel);
274extern void map_delete(struct map_ent **mapp, int devnum);
275extern void map_free(struct map_ent *map);
276extern void map_add(struct map_ent **melp,
277 int devnum, int major, int minor, int uuid[4], char *path);
e0d19036 278
e86c9dd6
NB
279/* various details can be requested */
280#define GET_LEVEL 1
281#define GET_LAYOUT 2
282#define GET_COMPONENT 4
283#define GET_CHUNK 8
758d3a8e 284#define GET_CACHE 16
37dfc3d6 285#define GET_MISMATCH 32
8382f19b 286#define GET_VERSION 64
e86c9dd6
NB
287
288#define GET_DEVS 1024 /* gets role, major, minor */
289#define GET_OFFSET 2048
290#define GET_SIZE 4096
291#define GET_STATE 8192
292#define GET_ERROR 16384
293
294/* If fd >= 0, get the array it is open on,
295 * else use devnum. >=0 -> major9. <0.....
296 */
7e0f6979
NB
297extern void sysfs_free(struct mdinfo *sra);
298extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
299extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 300 char *name, char *val);
7e0f6979 301extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 302 char *name, unsigned long long val);
7e0f6979 303extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6
NB
304 char *name, unsigned long long *val);
305
306
307extern int save_stripes(int *source, unsigned long long *offsets,
308 int raid_disks, int chunk_size, int level, int layout,
309 int nwrites, int *dest,
310 unsigned long long start, unsigned long long length);
353632d9
NB
311extern int restore_stripes(int *dest, unsigned long long *offsets,
312 int raid_disks, int chunk_size, int level, int layout,
313 int source, unsigned long long read_offset,
314 unsigned long long start, unsigned long long length);
e86c9dd6 315
52826846
NB
316#ifndef Sendmail
317#define Sendmail "/usr/lib/sendmail -t"
318#endif
319
773135f5
NB
320#define SYSLOG_FACILITY LOG_DAEMON
321
682c7051
NB
322extern char *map_num(mapping_t *map, int num);
323extern int map_name(mapping_t *map, char *name);
b5e64645 324extern mapping_t r5layout[], pers[], modes[], faultylayout[];
682c7051 325
16c6fa80 326extern char *map_dev(int major, int minor, int create);
64c4757e
NB
327
328
f9ce90ba 329extern struct superswitch {
3da92f27
NB
330 void (*examine_super)(struct supertype *st, char *homehost);
331 void (*brief_examine_super)(struct supertype *st);
332 void (*detail_super)(struct supertype *st, char *homehost);
333 void (*export_super)(struct supertype *st);
334 void (*brief_detail_super)(struct supertype *st);
335 void (*uuid_from_super)(struct supertype *st, int uuid[4]);
336 void (*getinfo_super)(struct supertype *st, struct mdinfo *info);
337 int (*match_home)(struct supertype *st, char *homehost);
68c7d6d7 338 int (*update_super)(struct supertype *st, struct mdinfo *info,
3da92f27 339 char *update,
e5eac01f
NB
340 char *devname, int verbose,
341 int uuid_set, char *homehost);
3da92f27
NB
342 int (*init_super)(struct supertype *st, mdu_array_info_t *info,
343 unsigned long long size, char *name,
344 char *homehost, int *uuid);
345 void (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo);
346 int (*store_super)(struct supertype *st, int fd);
347 int (*write_init_super)(struct supertype *st, mdu_disk_info_t *dinfo,
348 char *devname);
64557c33 349 int (*compare_super)(struct supertype *st, struct supertype *tst);
3da92f27 350 int (*load_super)(struct supertype *st, int fd, char *devname);
82d9eba6 351 struct supertype * (*match_metadata_desc)(char *arg);
1bf4e2d9 352 __u64 (*avail_size)(struct supertype *st, __u64 size);
3da92f27 353 int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
199171a2 354 int delay, int write_behind,
f9c25f1d 355 unsigned long long size, int may_change, int major);
3da92f27
NB
356 void (*locate_bitmap)(struct supertype *st, int fd);
357 int (*write_bitmap)(struct supertype *st, int fd);
358 void (*free_super)(struct supertype *st);
82d9eba6 359 int major;
f277ce36 360 int swapuuid; /* true if uuid is bigending rather than hostendian */
82d9eba6
NB
361} super0, super1, *superlist[];
362
363struct supertype {
364 struct superswitch *ss;
365 int minor_version;
ea329559 366 int max_devs;
64557c33 367 void *sb;
82d9eba6 368};
f9ce90ba 369
1686dc25 370extern struct supertype *super_by_fd(int fd);
82d9eba6 371extern struct supertype *guess_super(int fd);
3da92f27 372extern struct supertype *dup_super(struct supertype *st);
beae1dfe 373extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
8382f19b
NB
374extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
375 mdu_disk_info_t *disk);
f9ce90ba 376
838acbc2
NB
377#if __GNUC__ < 3
378struct stat64;
379#endif
380
45e878bb
NB
381#define HAVE_NFTW we assume
382#define HAVE_FTW
383
173fc515 384#ifdef UCLIBC
45e878bb
NB
385# include <features.h>
386# ifndef __UCLIBC_HAS_FTW__
387# undef HAVE_FTW
388# undef HAVE_NFTW
389# endif
390#endif
391
392#ifdef __dietlibc__
393# undef HAVE_NFTW
394#endif
395
e39b673e 396#if defined(__KLIBC__)
397# undef HAVE_NFTW
398# undef HAVE_FTW
399#endif
400
45e878bb 401#ifndef HAVE_NFTW
173fc515 402# define FTW_PHYS 1
45e878bb
NB
403# ifndef HAVE_FTW
404 struct FTW {};
173fc515
NB
405# endif
406#endif
407
45e878bb
NB
408#ifdef HAVE_FTW
409# include <ftw.h>
410#endif
411
173fc515
NB
412extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
413
f9ce90ba 414
64c4757e 415extern int Manage_ro(char *devname, int fd, int readonly);
91f068bf 416extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
dd0781e5 417extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645 418extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e 419extern int Manage_subdevs(char *devname, int fd,
dab6685f 420 mddev_dev_t devlist, int verbose);
1f48664b 421extern int autodetect(void);
e5329c37 422extern int Grow_Add_device(char *devname, int fd, char *newdev);
8fac0577 423extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
06b0d786 424extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
e86c9dd6
NB
425 long long size,
426 int level, int layout, int chunksize, int raid_disks);
06b0d786
NB
427extern int Grow_restart(struct supertype *st, struct mdinfo *info,
428 int *fdlist, int cnt, char *backup_file);
64c4757e
NB
429
430
82d9eba6 431extern int Assemble(struct supertype *st, char *mddev, int mdfd,
52826846 432 mddev_ident_t ident,
06b0d786 433 mddev_dev_t devlist, char *backup_file,
64c4757e 434 int readonly, int runstop,
e5eac01f 435 char *update, char *homehost,
64c4757e
NB
436 int verbose, int force);
437
b5e64645 438extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
64c4757e 439 int raiddisks,
c82f047c 440 mddev_dev_t devlist, int assume_clean,
dab6685f 441 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
64c4757e
NB
442
443
82d9eba6 444extern int Create(struct supertype *st, char *mddev, int mdfd,
5dd497ee 445 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
3d3dd91e 446 char *name, char *homehost, int *uuid,
cd29a5c8 447 int subdevs, mddev_dev_t devlist,
47d79ef8 448 int runstop, int verbose, int force, int assume_clean,
dfd4d8ee 449 char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
64c4757e 450
54bad364 451extern int Detail(char *dev, int brief, int export, int test, char *homehost);
e0d19036 452extern int Query(char *dev);
82d9eba6 453extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
a1cbd7d0 454 struct supertype *forcest, char *homehost);
cd29a5c8 455extern int Monitor(mddev_dev_t devlist,
e0d19036 456 char *mailaddr, char *alert_cmd,
aa88f531 457 int period, int daemonise, int scan, int oneshot,
8aec876d 458 int dosyslog, int test, char *pidfile);
64c4757e 459
6409687b 460extern int Kill(char *dev, int force, int quiet);
b90c0e9a 461extern int Wait(char *dev);
9a9dab36 462
8382f19b
NB
463extern int Incremental(char *devname, int verbose, int runstop,
464 struct supertype *st, char *homehost, int autof);
465extern void RebuildMap(void);
466extern int IncrementalScan(int verbose);
467
c82f047c
NB
468extern int CreateBitmap(char *filename, int force, char uuid[16],
469 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 470 unsigned long write_behind,
dcec9ee5
NB
471 unsigned long long array_size,
472 int major);
55935d51 473extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
bf4fb153 474extern int bitmap_update_uuid(int fd, int *uuid, int swap);
c82f047c 475
64c4757e 476extern int md_get_version(int fd);
e0d19036 477extern int get_linux_version(void);
64c4757e 478extern int parse_uuid(char *str, int uuid[4]);
682c7051
NB
479extern int check_ext2(int fd, char *name);
480extern int check_reiser(int fd, char *name);
481extern int check_raid(int fd, char *name);
64c4757e 482
dd0781e5 483extern int get_mdp_major(void);
8b0dabea 484extern int dev_open(char *dev, int flags);
8d80900b 485extern int is_standard(char *dev, int *nump);
dd0781e5 486
f1ae21c4 487extern int parse_auto(char *str, char *msg, int config);
8aec876d
NB
488extern mddev_ident_t conf_get_ident(char *dev);
489extern mddev_dev_t conf_get_devs(void);
8382f19b 490extern int conf_test_dev(char *devname);
8aec876d
NB
491extern struct createinfo *conf_get_create_info(void);
492extern void set_conffile(char *file);
493extern char *conf_get_mailaddr(void);
494extern char *conf_get_mailfrom(void);
495extern char *conf_get_program(void);
496extern char *conf_get_homehost(void);
e0d19036 497extern char *conf_line(FILE *file);
98c6faba 498extern char *conf_word(FILE *file, int allow_key);
e0d19036
NB
499extern void free_line(char *line);
500extern int match_oneof(char *devices, char *devname);
e0d19036 501extern void uuid_from_super(int uuid[4], mdp_super_t *super);
f277ce36 502extern int same_uuid(int a[4], int b[4], int swapuuid);
350f29f9 503extern void copy_uuid(void *a, int b[4], int swapuuid);
4b1ac34b 504extern unsigned long calc_csum(void *super, int bytes);
583315d9 505extern int enough(int level, int raid_disks, int layout, int clean,
265e0f17 506 char *avail, int avail_disks);
e0d19036 507extern int ask(char *mesg);
8fac0577 508extern unsigned long long get_component_size(int fd);
0430ed48 509extern void remove_partitions(int fd);
e0d19036 510
cd29a5c8 511
56eb10c0 512extern char *human_size(long long bytes);
e0d19036
NB
513char *human_size_brief(long long bytes);
514
515extern void put_md_name(char *name);
516extern char *get_md_name(int dev);
517
c913b90e 518extern char DefaultConfFile[];
b5e64645
NB
519
520extern int open_mddev(char *dev, int autof);
8382f19b
NB
521extern int open_mddev_devnum(char *devname, int devnum, char *name,
522 char *chosen_name);
b5e64645
NB
523
524
525#define LEVEL_MULTIPATH (-4)
526#define LEVEL_LINEAR (-1)
527#define LEVEL_FAULTY (-5)
528
529
530/* faulty stuff */
531
532#define WriteTransient 0
533#define ReadTransient 1
534#define WritePersistent 2
535#define ReadPersistent 3
536#define WriteAll 4 /* doesn't go to device */
537#define ReadFixable 5
538#define Modes 6
539
540#define ClearErrors 31
541#define ClearFaults 30
542
543#define AllPersist 100 /* internal use only */
544#define NoPersist 101
545
546#define ModeMask 0x1f
547#define ModeShift 5
fe6729fa
NB
548
549
550#ifdef __TINYC__
551#undef minor
552#undef major
553#undef makedev
554#define minor(x) ((x)&0xff)
555#define major(x) (((x)>>8)&0xff)
556#define makedev(M,m) (((M)<<8) | (m))
557#endif
558
e86c9dd6
NB
559/* for raid5 */
560#define ALGORITHM_LEFT_ASYMMETRIC 0
561#define ALGORITHM_RIGHT_ASYMMETRIC 1
562#define ALGORITHM_LEFT_SYMMETRIC 2
563#define ALGORITHM_RIGHT_SYMMETRIC 3