source: MondoRescue/branches/2.2.10/mondo/src/common/mondostructures.h @ 2321

Last change on this file since 2321 was 2321, checked in by Bruno Cornec, 11 years ago

r3332@localhost: bruno | 2009-08-07 23:59:34 +0200

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