source: branches/2.2.6/mondo/src/common/mondostructures.h @ 1948

Last change on this file since 1948 was 1948, checked in by bruno, 9 years ago
  • Adds OBDR support (use_obdr field in bkpinfo added, -o option changed to mean OBDR - LILO not usable anyway as a bootloader for ISO images)
  • Property svn:keywords set to Id
File size: 20.7 KB
Line 
1/***************************************************************************
2                          mondostructures.h  -  description
3                             -------------------
4    begin                : Fri Apr 19 2002
5    copyright            : (C) 2002 by Stan Benoit
6    email                : troff@nakedsoul.org
7    cvsid                : $Id: mondostructures.h 1948 2008-05-26 15:35:44Z bruno $
8 ***************************************************************************/
9
10/***************************************************************************
11 *                                                                         *
12 *   This program is free software; you can redistribute it and/or modify  *
13 *   it under the terms of the GNU General Public License as published by  *
14 *   the Free Software Foundation; either version 2 of the License, or     *
15 *   (at your option) any later version.                                   *
16 *                                                                         *
17 ***************************************************************************/
18
19
20/**
21 * @file
22 * The header file defining all of Mondo's structures.
23 */
24
25
26/** @def MAX_NOOF_MEDIA The maximum number of media that can be used in any one backup. */
27
28///* So we can override it in config.h: */
29//#ifndef MAX_NOOF_MEDIA
30#define MAX_NOOF_MEDIA 50
31//#endif
32
33/**
34 * Structure indicating one entry in the mountlist.
35 * There is one mountlist_line for each device we're keeping track of in the mountlist.
36 */
37struct mountlist_line {
38  /**
39   * The name of the device (/dev entry) for this mountlist line. Guaranteed to be unique.
40   */
41    char device[64];
42
43  /**
44   * The mountpoint for this mountlist line. Should be unique.
45   * This can be "raid", for a RAID subdisk, or "lvm", for an LVM PV.
46   */
47    char mountpoint[256];
48
49  /**
50   * The filesystem type of this entry. Examples: ext2, ext3, reiserfs, xfs, swap.
51   * Also, this can be "raid", for a RAID subdisk, or "lvm", for an LVM PV.
52   */
53    char format[64];
54
55  /**
56   * The size in kilobytes of this device. 0 or -1 indicates LVM.
57   */
58    long long size;
59
60  /**
61   * For ext2 and ext3, this is the filesystem label or uuid (if there is one). If not, this should be "".
62   */
63    char label[256];
64
65};
66
67/**
68 * The mountlist structure.
69 * This is used to keep track of a list of all the devices/partitions/formats/sizes/labels in the
70 * system, so we can recreate them in a nuke restore.
71 */
72struct mountlist_itself {
73  /**
74   * Number of entries in the mountlist.
75   */
76    int entries;
77
78  /**
79   * The list of entries, all @p entries of them.
80   */
81    struct mountlist_line el[MAX_TAPECATALOG_ENTRIES];
82};
83
84/**
85 * A structure which holds references to elements of the mountlist.
86 * This is used in resize_drive_proportionately_to_fit_new_drives() to
87 * ensure accurate resizing.
88 */
89struct mountlist_reference {
90  /**
91   * The number of entries in the list of mountlist references.
92   */
93    int entries;
94
95  /**
96   * The array of mountlist_line, allocated on demand.
97   */
98    struct mountlist_line **el;
99};
100
101/**
102 * A line in @p additional_raid_variables.
103 */
104struct raid_var_line {
105  /**
106   * The label for this RAID variable.
107   */
108    char label[64];
109
110  /**
111   * The value for this RAID variable.
112   */
113    char value[64];
114};
115
116/**
117 * The additional RAID variables structure.
118 * This is used to store a list of additional variables to be put in the raidtab,
119 * to allow users to use (new) features of RAID which Mondo doesn't (yet) support directly.
120 * Each @p raid_device_record has one.
121 */
122struct additional_raid_variables {
123  /**
124   * The number of entries in the list.
125   */
126    int entries;
127
128  /**
129   * The list of entries, all @p entries of them.
130   */
131    struct raid_var_line el[MAXIMUM_ADDITIONAL_RAID_VARS];
132};
133
134/**
135 * One disk in a @p list_of_disks.
136 */
137struct s_disk {
138#ifdef __FreeBSD__
139    /**
140     * The name of this disk. If blank it will eventually get filled in automatically.
141     */
142    char name[64];
143#endif
144  /**
145   * The device this entry describes.
146   */
147    char device[64];
148
149  /**
150   * Index number of this entry in the whole disklist.
151   */
152    int index;
153   
154  /**
155   * Type of disk.
156   */
157    char type;  // ' ' = data (default), S = spare, F = faulty
158   
159};
160
161/**
162 * A list of @p s_disk. Every @p raid_device_record has four.
163 */
164struct list_of_disks {
165  /**
166   * The number of entries in the disklist.
167   */
168    int entries;
169
170  /**
171   * The entries themselves, all @p entries of them.
172   */
173    struct s_disk el[MAXIMUM_DISKS_PER_RAID_DEV];
174};
175
176/**
177 * A type of media we're backing up to.
178 */
179typedef enum { none = 0,        ///< No type has been set yet.
180    iso,                        ///< Back up to ISO images.
181    cdr,                        ///< Back up to recordable CDs (do not erase them).
182    cdrw,                       ///< Back up to CD-RWs and blank them first.
183    dvd,                        ///< Back up to DVD+R[W] or DVD-R[W] disks.
184    cdstream,                   ///< Back up to recordable CDs but treat them like a tape streamer.
185    nfs,                        ///< Back up to an NFS mount on the local subnet.
186    tape,                       ///< Back up to tapes.
187    usb,                        ///< Back up to USB devices.
188    udev                        ///< Back up to another unsupported device; just send a stream of bytes.
189} t_bkptype;
190
191/**
192 * A type of file in the catalog of recent archives.
193 */
194typedef enum { other,           ///< Some other kind of file.
195    fileset,                    ///< An afioball (fileset), optionally compressed.
196    biggieslice                 ///< A slice of a biggiefile, optionally compressed.
197} t_archtype;
198
199
200#ifdef __FreeBSD__
201
202struct vinum_subdisk {
203    char which_device[64];
204};
205
206struct vinum_plex {
207    int raidlevel;
208    int stripesize;
209    int subdisks;
210    struct vinum_subdisk sd[MAXIMUM_RAID_DEVS];
211};
212
213struct vinum_volume {
214    char volname[64];
215    int plexes;
216    struct vinum_plex plex[9];
217};
218
219struct raidlist_itself {
220    int entries;
221    struct list_of_disks spares;
222    struct list_of_disks disks;
223    struct vinum_volume el[MAXIMUM_RAID_DEVS];
224};
225
226#else
227
228        /**
229         * A RAID device in the raidlist.
230         */
231struct raid_device_record {
232      /**
233       * The name of the RAID device (e.g. /dev/md0).
234       */
235    char raid_device[64];
236
237      /**
238       * The RAID level (-1 to 5) we're using.
239       */
240    int raid_level;
241
242      /**
243       * Whether the disk has a persistent superblock.
244       */
245    int persistent_superblock;
246
247      /**
248       * The chunk size of this RAID device.
249       */
250    int chunk_size;
251   
252      /**
253       * The parity algorithm of this RAID device. (RAID5 only)
254       */
255    int parity; // 0=left-asymmetric, 1=right-asymmetric, 2=left-symmetric, 3=right-symmetric
256
257      /**
258       * A list of the disks to use for storing data.
259       */
260    struct list_of_disks data_disks;
261
262      /**
263       * A list of the disks to use as "hot spares" in case one dies.
264       */
265    struct list_of_disks spare_disks;
266
267      /**
268       * A list of the disks to use for storing parity information.
269       */
270    struct list_of_disks parity_disks;
271
272      /**
273       * A list of the disks in this RAID device that have failed\. Rare.
274       */
275    struct list_of_disks failed_disks;
276
277      /**
278       * The additional RAID variables for this device.
279       */
280    struct additional_raid_variables additional_vars;
281
282      /**
283       * Resync progress for this device.
284       */
285    int progress;
286};
287
288        /**
289         * The list of RAID devices.
290         * This is intended to be used along with the mountlist, and it can be
291         * directly loaded from/saved to raidtab format.
292         */
293struct raidlist_itself {
294      /**
295       * The number of entries in the list.
296       */
297    int entries;
298
299      /**
300       * The RAID devices in the raidlist, all @p entries of them.
301       */
302    struct raid_device_record el[MAXIMUM_RAID_DEVS];
303};
304
305#endif
306
307/**
308 * The backup information structure.
309 *
310 * This is the central structure to all the activity going on inside Mondo.
311 * It is passed to almost every function that is not just a helper, even those
312 * which only use one variable of it, because it is useful keeping all the information
313 * together in one place. The usage of particular fields in the bkpinfo is marked in
314 * function documentation, but it is best to fill out as many fields as apply, because
315 * that function may in turn pass the bkpinfo to other functions which use other fields.
316 *
317 * To fill out the bkpinfo first call reset_bkpinfo() and pre_param_configuration(). Then set
318 * the backup-specific parameters (see mondo/mondoarchive/mondo-cli.c-\>process_switches for
319 * an example). After that, you should call post_param_configuration() to set some final
320 * parameters based on those you have already set. Failure to do the last step will result in
321 * extremely strange and hard-to-track errors in chop_filelist(), since optimal_set_size is 0.
322 */
323struct s_bkpinfo {
324  /**
325   * The device we're backing up to.
326   * If backup_media_type is @b cdr, @b cdrw, or @b cdstream, this should be the SCSI node (e.g. 0,1,0).
327   * If backup_media_type is @b dvd, @b tape, @b usb or @b udev, this should be a /dev entry.
328   * If backup_media_type is anything else, this should be blank.
329   */
330    char media_device[MAX_STR_LEN / 4];
331
332  /**
333   * An array containing the sizes of each media in our backup set, in MB.
334   * For example, media 1's size would be stored in media_size[1].
335   * Element 0 is unused.
336   * If the size should be autodetected, make it -1 (preferable) or 0.
337   * @bug This should probably be only one variable, not an array.
338   */
339    long media_size[MAX_NOOF_MEDIA + 1];
340
341  /**
342   * The boot loader that is installed. Available choices are:
343   * - 'G' for GRUB
344   * - 'L' for LILO
345   * - 'E' for ELILO
346   * - (FreeBSD only) 'B' for boot0
347   * - (FreeBSD only) 'D' for dangerously dedicated
348   * - 'R' for Raw
349   * - 'U' for Unknown or None
350   *
351   * The function which_boot_loader() can help you set this.
352   */
353    char boot_loader;
354
355  /**
356   * The boot device on which @p boot_loader is installed.
357   * This is a bit difficult to autodetect; you may want
358   * to take truncate_to_drive_name() of where_is_root_mounted().
359   */
360    char boot_device[MAX_STR_LEN / 4];
361
362  /**
363   * The compression program to use. Currently supported
364   * choices are lzop and bzip2; gzip may also work. This is ignored if
365   * compression_level is 0.
366   */
367    char zip_exe[MAX_STR_LEN / 4];
368
369  /**
370   * The extension your compression program uses. lzop uses lzo, bzip uses
371   * bz2, gzip uses gz, etc. Do not include the dot.
372   */
373    char zip_suffix[MAX_STR_LEN / 4];
374
375  /**
376   * Devices to back up as biggiefiles.
377   *
378   * This is useful for backing up NTFS partitions.
379   * @c ntfsclone is used to back up only the used sectors, so the space tradeoff is not bad.
380   * However, several caveats apply to such a partition:
381   * - It must not be mounted during the backup
382   * - It must be in a format that ntfsclone knows how to handle, i.e. NTFS
383   * - It cannot be verified during the verify or compare phase
384   * - It may not be resized or selectively restored at restore-time (all or nothing)
385   *
386   * This is a useful feature, but use at your own risk.
387   */
388    char image_devs[MAX_STR_LEN / 4];
389
390  /**
391   * The compression level (1-9) to use. 0 disables compression.
392   */
393    int compression_level;
394
395  /**
396   * If TRUE, then use @c lzop to compress data.
397   * This is used mainly in estimates. The backup/restore may or may
398   * not work if you do not set this. You should also set @p zip_exe
399   * and @p zip_suffix.
400   */
401    bool use_lzo;
402
403  /**
404   * If TRUE, then use @c gzip to compress data.
405   * This is used mainly in estimates. The backup/restore may or may
406   * not work if you do not set this. You should also set @p zip_exe
407   * and @p zip_suffix.
408   */
409    bool use_gzip;
410
411  /**
412   * A filename containing a list of extensions, one per line, to not
413   * compress. If this is set to "", afio will still exclude a set of well-known
414   * compressed files from compression, but biggiefiles that are compressed
415   * will be recompressed again.
416   */
417    char do_not_compress_these[MAX_STR_LEN / 2];
418
419  /**
420   * If TRUE, then we should verify a backup.
421   */
422    bool verify_data;
423
424  /**
425   * If TRUE, then we should back up some data.
426   */
427    bool backup_data;
428
429  /**
430   * If TRUE, then we should restore some data.
431   */
432    bool restore_data;
433
434
435  /**
436    * If TRUE, then we should backup/restore using star, not afio
437   */
438    bool use_star;
439
440
441  /**
442   * Size of internal block reads/writes
443   */
444    long internal_tape_block_size;
445
446  /**
447   * If TRUE, we're making a CD that will autonuke without confirmation when booted.
448   */
449    bool disaster_recovery;
450
451  /**
452   * The directory we're backing up to.
453   * If backup_media_type is @b iso, then this is that directory.
454   * If backup_media_type is anything else, this is ignored.
455   */
456    char isodir[MAX_STR_LEN / 4];
457
458/**
459   * The prefix to put in front of media number
460   * If backup_media_type is @b iso, then this is the prefix for the filename
461   * If backup_media_type is anything else, this is ignored.
462   */
463    char prefix[MAX_STR_LEN / 4];
464
465  /**
466   * The scratch directory to use.
467   * This is the "stage" that the CD image is made directly from.
468   * As such, it needs to be at least as large as the largest CD/DVD/ISO.
469   */
470    char scratchdir[MAX_STR_LEN / 4];
471
472  /**
473   * The temp directory to use.
474   * This is where filesets are stored by the archival threads before
475   * the main thread moves them to the scratchdir. You don't need a lot
476   * of space here.
477   */
478    char tmpdir[MAX_STR_LEN / 4];
479
480  /**
481   * The optimal size for each fileset. This is set automatically in
482   * post_param_configuration() based on your @p backup_media_type; you
483   * needn't set it yourself.
484   */
485    long optimal_set_size;
486
487  /**
488   * The type of media we're backing up to.
489   */
490    t_bkptype backup_media_type;
491//  bool blank_dvd_first;
492
493  /**
494   * Whether we should use a premade filelist or generate our own.
495   * If TRUE, then we generate our own filelist from the directories in @p include_paths.
496   * If FALSE, then we use the filelist whose name is specified in @p include_paths.
497   */
498    bool make_filelist;
499
500  /**
501   * Directories to back up, or (if !make_filelist) the filelist to use.
502   * In the former case, multiple directories should be separated by spaces.
503   * If you do nothing, "/" will be used.
504   */
505    char include_paths[MAX_STR_LEN*4];
506
507  /**
508   * Directories to NOT back up. Ignored if make_filelist == FALSE.
509   * Multiple directories should be separated by spaces. /tmp, /proc,
510   * the scratchdir, and the tempdir are automatically excluded.
511   */
512    char exclude_paths[MAX_STR_LEN*4];
513
514  /**
515   * The path to restore files relative to during a restore.
516   * This is useful if you want to extract the files (to test, for example)
517   * without overwriting the old ones. Ignored during a backup.
518   */
519    char restore_path[MAX_STR_LEN];
520
521  /**
522   * A command to call BEFORE making an ISO image.
523   */
524    char call_before_iso[MAX_STR_LEN];
525
526  /**
527   * A command to call to make an ISO image.
528   */
529    char call_make_iso[MAX_STR_LEN];
530
531  /**
532   * A command to call to burn the ISO image.
533   */
534    char call_burn_iso[MAX_STR_LEN];
535
536  /**
537   * A command to call AFTER making an ISO image.
538   */
539    char call_after_iso[MAX_STR_LEN];
540
541  /**
542   * Path to the user's kernel, or "FAILSAFE" or "SUCKS" to use the kernel
543   * included with Mindi.
544   */
545    char kernel_path[MAX_STR_LEN];
546
547  /**
548   * The NFS mount to back up to/restore from.
549   * If backup_media_type is not @b nfs, this is ignored.
550   * It must contain a colon, and the server's address should be in dotted-decimal IP
551   * address form. (Domain names will be resolved in post_param_configuration().)
552   */
553    char nfs_mount[MAX_STR_LEN];
554
555  /**
556   * The directory, relative to the root of @p nfs_mount, to put
557   * the backups in.
558   */
559    char nfs_remote_dir[MAX_STR_LEN];
560
561  /**
562   * A tarball containing a program called "usr/bin/post-nuke" that will be run
563   * after nuking the system. If "", do not use a post-nuke tarball.
564   */
565    char postnuke_tarball[MAX_STR_LEN];
566
567  /**
568   * If TRUE, then pass cdrecord the argument "blank=fast" to wipe the CDs before
569   * writing to them. This has no effect for DVDs.
570   */
571    bool wipe_media_first;
572
573// patch by Herman Kuster 
574  /**
575   * The differential level of this backup. Currently only 0 (full backup) and 1
576   * (files changed since last full backup) are supported.
577   */
578    int differential;
579// end patch 
580
581  /**
582   * If TRUE, then don't eject media when backing up or restoring.
583   */
584    bool please_dont_eject;
585
586  /**
587   * The speed of the CD-R[W] drive.
588   */
589    int cdrw_speed;
590
591  /**
592   * If TRUE, then cdrecord will be passed some flags to help compensate for PCs
593   * with eccentric CD-ROM drives. If it has BurnProof technology, or is in a laptop,
594   * it probably falls into this category.
595   */
596    bool manual_cd_tray;
597
598  /**
599   * If TRUE, do not make the first CD bootable. This is dangerous but it saves a minute
600   * or so. It is useful in testing. Use with care.
601   */
602    bool nonbootable_backup;
603
604  /**
605   * If TRUE, make the bootable CD use LILO/ELILO. If FALSE, use isolinux (the default).
606   */
607    bool make_cd_use_lilo;
608
609  /**
610   * If TRUE, make the the tape bootable. If FALSE, normal tape, the default
611   */
612    bool use_obdr;
613};
614
615
616
617/**
618 * A node in a directory structure.
619 * Its internals are managed by load_filelist() et al; you only need to keep track of the top node.
620 * @bug My understanding of this structure is horrendously incomplete. Could you please fill in the details?
621 */
622struct s_node {
623  /**
624   * The character this node contains.
625   */
626    char ch;
627
628  /**
629   * The node to the right of this one.
630   */
631    struct s_node *right;
632
633  /**
634   * The node below this one.
635   */
636    struct s_node *down;
637
638  /**
639   * If TRUE, then this node is selected (for restore, for example).
640   */
641    bool selected;
642
643  /**
644   * If TRUE, then we want to see the directories below this one.
645   */
646    bool expanded;
647};
648
649
650
651/**
652 * A structure to wrap a FIFO device for writing to a tape/CD stream.
653 * @bug Is this structure used (w/the move to a standalone @c buffer and all)?
654 */
655struct s_wrapfifo {
656        /**
657     * The device we write to or read from (a FIFO).
658     */
659    char public_device[MAX_STR_LEN / 4];
660
661        /**
662     * The actual device that data from the FIFO should be buffered and written to.
663     */
664    char private_device[MAX_STR_LEN / 4];
665
666        /**
667     * A buffer for holding data read from the FIFO.
668     */
669    char internal_buffer_IN_fifo[MAX_STR_LEN / 4];
670
671        /**
672     * A buffer for holding data to be written to the FIFO.
673     */
674    char internal_buffer_OUT_fifo[MAX_STR_LEN / 4];
675
676        /**
677     * If TRUE, then we're writing directly to the tape streamer; if FALSE, we're writing to the FIFO.
678     */
679    bool writing_to_private_device;
680};
681
682
683
684/**
685 * Information about one file.
686 * This is used as the "zeroth slice" of a biggiefile to be able to recreate
687 * its name, mode, owner, group, mtime, atime, and to be able to verify it in Compare Mode.
688 */
689struct s_filename_and_lstat_info {
690        /**
691     * The filename of the file this structure is describing.
692     */
693    char filename[MAX_STR_LEN];
694
695        /**
696     * The MD5 checksum (32 hex digits) of this file.
697     */
698    char checksum[64];
699
700        /**
701     * Unused; kept for backwards compatibility.
702     */
703    char for_backward_compatibility;
704
705        /**
706     * The stat buffer for this file.
707     * Generated with a call to <tt>lstat(&(struc->properties))</tt> where @p struc
708     * is the @p s_filename_and_lstat_info.
709     */
710    struct stat properties;
711    bool use_ntfsprog;
712};
713
714
715/**
716 * A file with associated severity if it differed in a verify or compare.
717 */
718struct s_filelist_entry {
719        /**
720     * The name of the file.
721     */
722    char filename[MAX_STR_LEN];
723        /**
724     * The severity if the file has changed between the backup and live filesystem.
725     * This is on a scale from 1 to 3, 3 being the most important. File patterns which cause
726     * a severity of 1 are:
727     * - /etc/adjtime
728     * - /etc/mtab
729     * - /var/lib/slocate
730     * - /var/lock
731     * - /var/log
732     * - /var/spool (except /var/spool/mail)
733     * - /var/run
734     * - *~
735     * - *.log
736     * - *cache*
737     * - other temporary or unimportant files
738     *
739     * File patterns which cause a severity of 2 are:
740     * - /var (except /var/lock, /var/log, /var/run, /var/spool)
741     * - /home
742     * - /root/.*
743     * - /var/lib (except /var/lib/slocate, /var/lib/rpm)
744     * - /var/spool/mail
745     *
746     * File patterns which cause a severity of 3 are:
747     * - /etc (except /etc/adjtime, /etc/mtab)
748     * - /root (except /root/.*)
749     * - /usr
750     * - /var/lib/rpm
751     * - Anything else not matched explicitly
752     *
753     * @see severity_of_difference
754     */
755    int severity;
756};
757
758
759/**
760 * A list of @c s_filelist_entry.
761 */
762struct s_filelist {
763        /**
764     * The number of entries in the list.
765     */
766    int entries;
767
768        /**
769     * The entries themselves, all @p entries of them.
770     */
771    struct s_filelist_entry el[ARBITRARY_MAXIMUM];
772};
773
774
775/**
776 * An entry in the tape catalog.
777 */
778struct s_tapecat_entry {
779        /**
780     * The type of archive it is (afioball, slice, or something else).
781     */
782    t_archtype type;
783
784        /**
785     * The filelist number or biggiefile (not slice!) number.
786     */
787    int number;
788
789        /**
790     * The slice number if it's a biggiefile.
791     */
792    long aux;
793
794        /**
795     * The tape position at the point this entry was added.
796     */
797    long long tape_posK;
798
799        /**
800     * The filename of the file cataloged here.
801     */
802    char fname[MAX_TAPECAT_FNAME_LEN + 1];
803};
804
805
806/**
807 * A tape catalog, made of a list of @p s_tapecat_entry.
808 */
809struct s_tapecatalog {
810        /**
811     * The number of entries in the tape catalog.
812     */
813    int entries;
814
815        /**
816     * The entries themselves, all @p entries of them.
817     */
818    struct s_tapecat_entry el[MAX_TAPECATALOG_ENTRIES];
819};
Note: See TracBrowser for help on using the repository browser.