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

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

r3334@localhost: bruno | 2009-08-08 12:17:37 +0200

  • Change mr_asprintf interface to pass only the char * (makes bkpinfo usage more easy)
  • Property svn:keywords set to Id
File size: 19.9 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 2323 2009-08-18 13:05:43Z 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   * If TRUE, then we should verify a backup.
424   */
425    bool verify_data;
426
427  /**
428   * If TRUE, then we should back up some data.
429   */
430    bool backup_data;
431
432  /**
433   * If TRUE, then we should restore some data.
434   */
435    bool restore_data;
436
437
438  /**
439    * If TRUE, then we should backup/restore using star, not afio
440   */
441    bool use_star;
442
443
444  /**
445   * Size of internal block reads/writes
446   */
447    long internal_tape_block_size;
448
449  /**
450   * If TRUE, we're making a CD that will autonuke without confirmation when booted.
451   */
452    bool disaster_recovery;
453
454  /**
455   * The directory we're backing up to.
456   * If backup_media_type is @b iso, then this is that directory.
457   * If backup_media_type is anything else, this is ignored.
458   */
459    char *isodir;
460
461/**
462   * The prefix to put in front of media number
463   * If backup_media_type is @b iso, then this is the prefix for the filename
464   * If backup_media_type is anything else, this is ignored.
465   */
466    char *prefix;
467
468  /**
469   * The scratch directory to use.
470   * This is the "stage" that the CD image is made directly from.
471   * As such, it needs to be at least as large as the largest CD/DVD/ISO.
472   */
473    char *scratchdir;
474
475  /**
476   * The temp directory to use.
477   * This is where filesets are stored by the archival threads before
478   * the main thread moves them to the scratchdir. You don't need a lot
479   * of space here.
480   */
481    char *tmpdir;
482
483  /**
484   * The optimal size for each fileset. This is set automatically in
485   * post_param_configuration() based on your @p backup_media_type; you
486   * needn't set it yourself.
487   */
488    long optimal_set_size;
489
490  /**
491   * The type of media we're backing up to.
492   */
493    t_bkptype backup_media_type;
494
495  /**
496   * Whether we should use a premade filelist or generate our own.
497   * If TRUE, then we generate our own filelist from the directories in @p include_paths.
498   * If FALSE, then we use the filelist whose name is specified in @p include_paths.
499   */
500    bool make_filelist;
501
502  /**
503   * Directories to back up, or (if !make_filelist) the filelist to use.
504   * In the former case, multiple directories should be separated by spaces.
505   * If you do nothing, "/" will be used.
506   */
507    char *include_paths;
508
509  /**
510   * Directories to NOT back up. Ignored if make_filelist == FALSE.
511   * Multiple directories should be separated by spaces. /tmp, /proc,
512   * the scratchdir, and the tempdir are automatically excluded.
513   */
514    char *exclude_paths;
515
516  /**
517   * The path to restore files relative to during a restore.
518   * This is useful if you want to extract the files (to test, for example)
519   * without overwriting the old ones. Ignored during a backup.
520   */
521    char restore_path[MAX_STR_LEN];
522
523  /**
524   * A command to call BEFORE making an ISO image.
525   */
526    char call_before_iso[MAX_STR_LEN];
527
528  /**
529   * A command to call to make an ISO image.
530   */
531    char call_make_iso[MAX_STR_LEN];
532
533  /**
534   * A command to call to burn the ISO image.
535   */
536    char call_burn_iso[MAX_STR_LEN];
537
538  /**
539   * A command to call AFTER making an ISO image.
540   */
541    char call_after_iso[MAX_STR_LEN];
542
543  /**
544   * Path to the user's kernel, or "FAILSAFE" or "SUCKS" to use the kernel
545   * included with Mindi.
546   */
547    char kernel_path[MAX_STR_LEN];
548
549  /**
550   * The NFS mount to back up to/restore from.
551   * If backup_media_type is not @b nfs, this is ignored.
552   * It must contain a colon, and the server's address should be in dotted-decimal IP
553   * address form. (Domain names will be resolved in post_param_configuration().)
554   */
555    char nfs_mount[MAX_STR_LEN];
556
557  /**
558   * The directory, relative to the root of @p nfs_mount, to put
559   * the backups in.
560   */
561    char nfs_remote_dir[MAX_STR_LEN];
562
563  /**
564   * The potential user to use for NFS backup
565   */
566    char *nfs_user;
567
568  /**
569   * A tarball containing a program called "usr/bin/post-nuke" that will be run
570   * after nuking the system. If "", do not use a post-nuke tarball.
571   */
572    char postnuke_tarball[MAX_STR_LEN];
573
574  /**
575   * If TRUE, then pass cdrecord the argument "blank=fast" to wipe the CDs before
576   * writing to them. This has no effect for DVDs.
577   */
578    bool wipe_media_first;
579
580// patch by Herman Kuster
581  /**
582   * The differential level of this backup. Currently only 0 (full backup) and 1
583   * (files changed since last full backup) are supported.
584   */
585    int differential;
586// end patch
587
588  /**
589   * If TRUE, then don't eject media when backing up or restoring.
590   */
591    bool please_dont_eject;
592
593  /**
594   * The speed of the CD-R[W] drive.
595   */
596    int cdrw_speed;
597
598  /**
599   * If TRUE, then cdrecord will be passed some flags to help compensate for PCs
600   * with eccentric CD-ROM drives. If it has BurnProof technology, or is in a laptop,
601   * it probably falls into this category.
602   */
603    bool manual_cd_tray;
604
605  /**
606   * If TRUE, do not make the first CD bootable. This is dangerous but it saves a minute
607   * or so. It is useful in testing. Use with care.
608   */
609    bool nonbootable_backup;
610
611  /**
612   * If TRUE, make the bootable CD use LILO/ELILO. If FALSE, use isolinux (the default).
613   */
614    bool make_cd_use_lilo;
615
616  /**
617   * If TRUE, make the the tape bootable. If FALSE, normal tape, the default
618   */
619    bool use_obdr;
620
621  /**
622   * Nature of the restore
623   */
624    t_restore_mode restore_mode;
625};
626
627
628
629/**
630 * A node in a directory structure.
631 * Its internals are managed by load_filelist() et al; you only need to keep track of the top node.
632 * @bug My understanding of this structure is horrendously incomplete. Could you please fill in the details?
633 */
634struct s_node {
635  /**
636   * The character this node contains.
637   */
638    char ch;
639
640  /**
641   * The node to the right of this one.
642   */
643    struct s_node *right;
644
645  /**
646   * The node below this one.
647   */
648    struct s_node *down;
649
650  /**
651   * If TRUE, then this node is selected (for restore, for example).
652   */
653    bool selected;
654
655  /**
656   * If TRUE, then we want to see the directories below this one.
657   */
658    bool expanded;
659};
660
661
662
663/**
664 * Information about one file.
665 * This is used as the "zeroth slice" of a biggiefile to be able to recreate
666 * its name, mode, owner, group, mtime, atime, and to be able to verify it in Compare Mode.
667 */
668struct s_filename_and_lstat_info {
669        /**
670     * The filename of the file this structure is describing.
671     */
672    char filename[MAX_STR_LEN];
673
674        /**
675     * The MD5 checksum (32 hex digits) of this file.
676     */
677    char checksum[64];
678
679        /**
680     * Unused; kept for backwards compatibility.
681     */
682    char for_backward_compatibility;
683
684        /**
685     * The stat buffer for this file.
686     * Generated with a call to <tt>lstat(&(struc->properties))</tt> where @p struc
687     * is the @p s_filename_and_lstat_info.
688     */
689    struct stat properties;
690    bool use_ntfsprog;
691};
692
693
694/**
695 * A file with associated severity if it differed in a verify or compare.
696 */
697struct s_filelist_entry {
698        /**
699     * The name of the file.
700     */
701    char filename[MAX_STR_LEN];
702        /**
703     * The severity if the file has changed between the backup and live filesystem.
704     * This is on a scale from 1 to 3, 3 being the most important. File patterns which cause
705     * a severity of 1 are:
706     * - /etc/adjtime
707     * - /etc/mtab
708     * - /var/lib/slocate
709     * - /var/lock
710     * - /var/log
711     * - /var/spool (except /var/spool/mail)
712     * - /var/run
713     * - *~
714     * - *.log
715     * - *cache*
716     * - other temporary or unimportant files
717     *
718     * File patterns which cause a severity of 2 are:
719     * - /var (except /var/lock, /var/log, /var/run, /var/spool)
720     * - /home
721     * - /root/.*
722     * - /var/lib (except /var/lib/slocate, /var/lib/rpm)
723     * - /var/spool/mail
724     *
725     * File patterns which cause a severity of 3 are:
726     * - /etc (except /etc/adjtime, /etc/mtab)
727     * - /root (except /root/.*)
728     * - /usr
729     * - /var/lib/rpm
730     * - Anything else not matched explicitly
731     *
732     * @see severity_of_difference
733     */
734    int severity;
735};
736
737
738/**
739 * A list of @c s_filelist_entry.
740 */
741struct s_filelist {
742        /**
743     * The number of entries in the list.
744     */
745    int entries;
746
747        /**
748     * The entries themselves, all @p entries of them.
749     */
750    struct s_filelist_entry el[ARBITRARY_MAXIMUM];
751};
752
753
754/**
755 * An entry in the tape catalog.
756 */
757struct s_tapecat_entry {
758        /**
759     * The type of archive it is (afioball, slice, or something else).
760     */
761    t_archtype type;
762
763        /**
764     * The filelist number or biggiefile (not slice!) number.
765     */
766    int number;
767
768        /**
769     * The slice number if it's a biggiefile.
770     */
771    long aux;
772
773        /**
774     * The tape position at the point this entry was added.
775     */
776    long long tape_posK;
777
778        /**
779     * The filename of the file cataloged here.
780     */
781    char fname[MAX_TAPECAT_FNAME_LEN + 1];
782};
783
784
785/**
786 * A tape catalog, made of a list of @p s_tapecat_entry.
787 */
788struct s_tapecatalog {
789        /**
790     * The number of entries in the tape catalog.
791     */
792    int entries;
793
794        /**
795     * The entries themselves, all @p entries of them.
796     */
797    struct s_tapecat_entry el[MAX_TAPECATALOG_ENTRIES];
798};
Note: See TracBrowser for help on using the repository browser.