source: MondoRescue/branches/3.1/mondo/src/common/mondostructures.h@ 3190

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