source: branches/2.2.5/mondo/src/common/my-stuff.h

Last change on this file was 1885, checked in by bruno, 11 years ago
  • Remove floppy support from mindi and mondo and adapt docs
  • Align more mindi with the version from stable
  • Property svn:keywords set to Id
File size: 15.9 KB
Line 
1/* my-stuff.h
2   $Id: my-stuff.h 1885 2008-03-01 23:38:35Z bruno $
3.
4
5
607/14
7- ARCH_THREADS is now 2; buffers, 4
8
907/10
10- added acl, xattr stuff
11
1206/19
13- added AUX_VER
14
1506/14
16- added DO_MBR_PLEASE
17
1804/17
19- replaced INTERNAL_TAPE_BLK_SIZE with g_internal_tape_block_size
20  and DEFAULT_INTERNAL_TAPE_BLOCK_SIZE
21
2204/13
23- log_msg is now calling standard_log_debug_msg, not the alias (log_debug_msg)
24
2504/03/2004
26- added star and SELINUX support
27
2811/20/2003
29- boot from isolinux.bin, not mindi-boot.2880.img
30
3111/15
32- reduced SLICE_SIZE from 8192 to 4096
33
3410/08
35- set p-i-h volsize to 1GB
36
3710/21
38- added MNT_CDROM and FREELOADER
39
4010/11
41- added DEFAULT_DVD_DISK_SIZE
42- added PARTIMAGE_DEBUG_LEVEL
43
4409/27
45- better logging
46
4709/24
48- added MR_LOGFILE="/tmp/mondo-restore.log"
49
5009/22
51- added bool, FALSE, TRUE
52
5309/20
54- increasd PPCFG_RAMDISK_SIZE to 150
55
5609/12
57- reduced MAX_STR_LEN from 512 to 460
58
5909/10
60- moved PPCFG_RAMDISK_SIZE here
61
6209/05
63- better config.h stuff
64
6506/05
66- changed fgrep to grep
67
6805/19
69- added CP_BIN
70
7105/05
72- added #include <sys/param.h> and sys/sem.h and ioctl.h
73
7405/03
75- added kill_anything_like_this()
76
7704/24/2003
78- added *STUB #define's
79
8011/22/2002
81- added INTERNAL_TAPE_BLK_SIZE
82
8310/10
84- use #define to create XMondo-friendly log file name if appropriate
85
8608/30
87- changed ARBITRARY_MAXIMUM to 512
88
8908/26
90- set MAX_STR_LEN at 512 but halved it within many _structures_
91- changed ARBITRARY_MAXIMUM to 128
92
9308/08
94- added '#include <signal.h>'
95- added WELCOME_STRING
96
9706/19
98- changed tape block size from 8192 to 65536
99
10004/08
101- added manual_cd_tray flag to bkpinfo
102
10303/31
104- added restore_path to struct s_bkpinfo
105
10603/21
107- updated version# to 1.42
108
10902/20
110- added bkpinfo->using_cdstream
111
11202/06
113- added MONDO_VERSION
114
11502/02
116- added MONDO_CFG_FILE
117- added SLICE_SIZE
118
11901/31
120- removed MINDI_HOME: it is unnecessary
121- replaced MONDO_HOME with variable g_mondo_home
122
12301/25
124- added MONDO_HOME, MINDI_HOME
125
12601/21
127- added s_node{} structure
128
12901/17
130- added sys/shm.h, types.h, ipc.h
131
13201/02/2002
133- added that groovy bkpinfo{} stuff
134
13511/29/2001
136- added raidlist{} struct
137
13808/27
139- stuff
140*/
141
142#define HAVE_MALLOC 1
143
144
145// Extra info for ACLs and SELINUX users
146#define STAR_ACL_SZ "-xfflags -acl"
147//#define STAR_ACL_SZ "-xfflags"
148//#define STAR_ACL_SZ ""
149// Enable the first line and disable the second if you are a Fedora Core 2 user
150
151/**
152 * @file
153 * The main header file for Mondo.
154 */
155
156#if !defined(bool) && !defined(__cplusplus)
157/**
158 * Create the illusion of a Boolean type.
159 */
160#define bool int
161#define TRUE 1
162#define FALSE 0
163#endif
164
165#ifndef _MY_STUFF_H_
166#define _MY_STUFF_H_
167
168#ifdef HAVE_CONFIG_H
169#include <config.h>
170#endif
171
172#ifndef __FreeBSD__
173#include <getopt.h>
174#endif
175#include <sys/types.h>
176#include <sys/shm.h>
177#include <sys/ipc.h>
178#include <sys/ioctl.h>
179#include <sys/sem.h>
180#include <sys/param.h>
181#include <stdio.h>
182#include <stdlib.h>
183#ifndef  __USE_FILE_OFFSET64
184#define  __USE_FILE_OFFSET64
185#endif
186#ifndef  __USE_LARGEFILE64
187#define  __USE_LARGEFILE64
188#endif
189#include <sys/stat.h>
190#include <fcntl.h>
191#include <errno.h>
192#include <stddef.h>
193#include <sys/stat.h>
194#include <sys/wait.h>
195#include <time.h>
196#include <unistd.h>
197#include <signal.h>
198//#include <curses.h>
199#include <newt.h>
200#include <ctype.h>
201#include <string.h>
202#include <pthread.h>
203#include <assert.h>
204
205#if defined(DEBUG) && !__cplusplus
206int count;
207char trace_log[255];            /*buffer for logging */
208char *trace_log_ptr;
209#endif                          /* DEBUG */
210
211#define IA64_BOOT_SIZE "16384"  /* Should be coherent with mindi */
212#define STD_PREFIX "mondorescue"    /* Should be coherent with mindi */
213
214/**
215 * The biggielist stub (appended to the directory where all.tar.gz was unpacked).
216 */
217#define BIGGIELIST_TXT_STUB "tmp/biggielist.txt"
218
219/**
220 * The filelist stub (appended to the directory where all.tar.gz was unpacked).
221 */
222#define FILELIST_FULL_STUB "tmp/filelist.full.gz"
223
224/**
225 * The mountlist stub (appended to the directory where all.tar.gz was unpacked).
226 */
227#define MOUNTLIST_FNAME_STUB "tmp/mountlist.txt"
228
229/**
230 * The mondo-restore.cfg stub (appended to the directory where all.tar.gz was unpacked).
231 */
232#define MONDO_CFG_FILE_STUB "tmp/mondo-restore.cfg"
233/**
234 * The location where mindi media images are stored.
235 */
236#define MINDI_CACHE "/var/cache/mindi"
237
238/**
239 * The location where mondo changed info are stored.
240 */
241#define MONDO_CACHE "/var/cache/mondo"
242
243/**
244 * The RAID kernel proc file
245 */
246#define MDSTAT_FILE "/proc/mdstat"
247
248/**
249 * @bug Apparently unused.
250 */
251#define MONDO_TRACEFILE "/var/log/mondo-tracefile.log"
252
253#undef assert
254
255extern void _mondo_assert_fail(const char *file, const char *function,
256                               int line, const char *exp);
257
258/**
259 * An assert macro that calls _mondo_assert_fail() when it fails.
260 */
261#ifdef NDEBUG
262#define assert(exp) ((void)0)
263#else
264#define assert(exp) ((exp)?((void)0):_mondo_assert_fail(__FILE__, __FUNCTION__, __LINE__, #exp))
265#endif
266
267#define CRC_M16 0xA001          ///< Mask for crc16.
268#define CRC_MTT 0x1021          ///< Mask for crc-ccitt.
269
270#define FALSE 0                 ///< The ubiquitous FALSE macro.
271#define TRUE 1                  ///< The even more ubiquitous TRUE macro.
272
273#define SCREEN_LENGTH 25        ///< The default size of the screen.
274#define NOOF_ERR_LINES 6        ///< The number of lines of log output to keep at the bottom of the screen.
275#define ARBITRARY_MAXIMUM 2000  ///< The maximum number of items showing at once in the mountlist or filelist editor.
276#define MAX_TAPECATALOG_ENTRIES 8192    ///< The maximum number of entries in the tape catalog.
277#define MAX_STR_LEN 384         ///< The maximum length of almost all @p char buffers in Mondo.
278                                        ///  Note: Make this divisible by eight to avoid aligment issues
279                                        ///        on 64bit platforms like ia64.
280#define MAXIMUM_RAID_DEVS 32    ///< The maximum number of RAID devices in the raidlist.
281#define MAXIMUM_ADDITIONAL_RAID_VARS 32 ///< The maximum number of additional RAID variables per RAID device in the raidlist.
282#define MAXIMUM_DISKS_PER_RAID_DEV 32   ///< The maximum number of disks per RAID device in the raidtab.
283
284#define RAIDTAB_FNAME "/etc/raidtab"    ///< The filename of the raidtab file, at least on Linux.
285
286#define BLK_START_OF_BACKUP     1   ///< Marker block: start a backup.
287#define BLK_START_OF_TAPE       2   ///< Marker block: start a tape.
288#define BLK_START_AFIOBALLS 10  ///< Marker block: start the afioball section.
289#define BLK_STOP_AFIOBALLS  19  ///< Marker block: stop the afioball section.
290#define BLK_START_AN_AFIO_OR_SLICE      20  ///< Marker block: start an afioball or a slice.
291#define BLK_STOP_AN_AFIO_OR_SLICE   29  ///< Marker block: stop an afioball or a slice.
292#define BLK_START_BIGGIEFILES   30  ///< Marker block: start the biggiefile section.
293#define BLK_STOP_BIGGIEFILES    39  ///< Marker block: stop the biggiefile section.
294#define BLK_START_A_NORMBIGGIE  40  ///< Marker block: start a normal biggiefile.
295#define BLK_START_A_PIHBIGGIE   41  ///< Marker block: start a ntfsprog'd biggiefile
296#define BLK_START_EXTENDED_ATTRIBUTES 45    ///< Marker block: start xattr/acl info
297#define BLK_STOP_EXTENDED_ATTRIBUTES 46 ///< Marker block: stop xattr/acl info
298#define BLK_START_EXAT_FILE     47
299#define BLK_STOP_EXAT_FILE      48
300#define BLK_STOP_A_BIGGIE   59  ///< Marker block: stop a biggiefile.
301#define BLK_START_FILE          80  ///< Marker block: start a file (non-afio or slice).
302#define BLK_STOP_FILE           89  ///< Marker block: stop a file (non-afio or slice).
303#define BLK_END_OF_TAPE         100 ///< Marker block: end of tape.
304#define BLK_END_OF_BACKUP       101 ///< Marker block: end of backup.
305#define BLK_ABORTED_BACKUP      102 ///< Marker block: backup was aborted.
306
307/// The external tape blocksize.
308#ifdef EXTTAPE
309#define TAPE_BLOCK_SIZE (long)EXTTAPE
310#else
311#define TAPE_BLOCK_SIZE 131072L /* was 8192; 06/2002-->65536; 11/2002-->131072 */
312#endif
313
314#define DEFAULT_INTERNAL_TAPE_BLOCK_SIZE 32768  // Nov 2003?
315
316
317
318
319#define SLICE_SIZE 4096         ///< The size of a slice of a biggiefile.
320
321
322
323
324
325
326/**
327 * Determine whether @p x (t_bkptype) is a streaming backup.
328 */
329#define IS_THIS_A_STREAMING_BACKUP(x) (x == tape || x == udev || x == cdstream)
330
331
332/**
333 * @c mkisofs command to generate a nonbootable CD, except for -o option and the directory to image.
334 */
335#define MONDO_MKISOFS_NONBOOT   "mkisofs -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL_Version -V _CD#_"
336
337/**
338 * @c mkisofs command to generate a bootable CD using isolinux, except for -o option and the directory to image.
339 */
340#define MONDO_MKISOFS_REGULAR_SYSLINUX  "mkisofs -J -boot-info-table -no-emul-boot -b isolinux.bin -c boot.cat -boot-load-size 4 -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL_Version -V _CD#_"
341
342/**
343 * @c mkisofs command to generate a bootable CD using LILO, except for -o option and the directory to image.
344 */
345// -b images/mindi-boot.2880.img
346#define MONDO_MKISOFS_REGULAR_LILO      "mkisofs -boot-info-table -no-emul-boot -b isolinux.bin -c boot.cat -boot-load-size 4 -J -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL -V _CD#_"
347
348/**
349 * @c mkisofs command to generate a bootable CD using ELILO, except for -o option and the directory to image.
350 */
351// -b images/mindi-boot.2880.img
352// Should replace 8192 by IA64_BOOT_SIZE
353#define MONDO_MKISOFS_REGULAR_ELILO      "mkisofs -no-emul-boot -b images/mindi-bootroot.8192.img -c boot.cat -J -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL -V _CD#_"
354
355/**
356 * The stub name of the temporary ISO image to create, burn, and remove.
357 */
358#define MONDO_TMPISOS "temporary.iso"
359
360/**
361 * @c growisofs command to generate a bootable DVD using isolinux, except for the directory to image.
362 */
363#define MONDO_GROWISOFS_REGULAR_SYSLINUX "growisofs -use-the-force-luke -J -no-emul-boot -boot-load-size 4 -b isolinux.bin --boot-info-table -c boot.cat -boot-load-size 4 -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL_Version -V _CD#_ -v"
364
365/**
366 * @c growisofs command to generate a bootable DVD using LILO, except for the directory to image.
367     */// -b images/mindi-boot.2880.img
368#define MONDO_GROWISOFS_REGULAR_ELILO     "growisofs -use-the-force-luke -no-emul-boot -b images/mindi-boot.2880.img -c boot.cat -J -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL -V _CD#_ -v"
369
370/**
371 * @c growisofs command to generate a bootable DVD using LILO, except for the directory to image.
372     */// -b images/mindi-boot.2880.img
373#define MONDO_GROWISOFS_REGULAR_LILO     "growisofs -no-emul-boot -b isolinux.bin -c boot.cat -J -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL -V _CD#_ -v"
374
375/**
376 * @c growisofs command to generate a nonbootable DVD, except for the directory to image.
377 */
378#define MONDO_GROWISOFS_NONBOOT          "growisofs -use-the-force-luke -J -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL -V _CD#_ -v"
379
380/**
381 * Welcome string displayed at the top of the newt interface.
382 */
383#define WELCOME_STRING "W E L C O M E   T O   M O N D O   R E S C U E"
384
385/**
386 * The maximum length of a filename in the tape catalog.
387 */
388#define MAX_TAPECAT_FNAME_LEN 32
389
390//#define strcpy(y,x) strncpy(y, x, sizeof(y)-1)
391
392
393/**
394 * Assert that (@p x != NULL) and (@p x[0] != '\\0').
395 */
396#define assert_string_is_neither_NULL_nor_zerolength(x) {assert(x!=NULL);assert(x[0]!='\0');}
397
398/**
399 * Log the file, line, Mondo error message, and OS error message (errno).
400 */
401#define log_OS_error(x) {log_msg(0, "%s (%s)", x, strerror(errno));}
402
403/**
404 * Assert that (@p x != NULL).
405 */
406#define assert_pointer_is_not_NULL(x) {assert(x!=NULL);}
407
408/**
409 * close() @p x and log a message if it fails.
410 */
411#define paranoid_close(x) {if(close(x)) {log_msg(5, "close err");} x=-999; }
412
413/**
414 * fclose() @p x and log a message if it fails.
415 */
416#define paranoid_fclose(x) {if(fclose(x)) {log_msg(5, "fclose err");} x=NULL; }
417
418/**
419 * pclose() @p x and log a message if it fails.
420 */
421#define paranoid_pclose(x) {if(pclose(x)) {log_msg(5, "pclose err");} x=NULL; }
422
423/**
424 * Run the command @p x and log it if it fails.
425 */
426#define paranoid_system(x) {if(system(x)) log_msg(4, x); }
427
428/**
429 * Free @p x and set it to NULL.
430 */
431#define paranoid_free(x) {if (x != NULL) free(x); x=NULL;}
432
433/**
434 * Free variables and call finish(@p x).
435 */
436#define paranoid_MR_finish(x) {free_MR_global_filenames (); finish(x); }
437
438/**
439 * Log file, function, line, and @p x.
440 */
441#define iamhere(x) {log_it("%s, %s, %ld: %s", __FILE__, __FUNCTION__, __LINE__, x);}
442
443/**
444 * Yes, we want malloc() to help us fix bugs.
445 */
446#define MALLOC_CHECK_ 1
447
448/**
449 * Malloc @p x to be MAX_STR_LEN bytes and call fatal_error() if we're out of memory.
450 */
451#define malloc_string(x) { x = (char *)malloc(MAX_STR_LEN); if (!x) { fatal_error("Unable to malloc"); } x[0] = x[1] = '\0'; }
452
453/**
454 * Path to the location the hard drive is mounted on during a restore.
455 */
456#define MNT_RESTORING "/mnt/RESTORING"
457
458/** @def VANILLA_SCSI_CDROM The first SCSI CD-ROM in the system (most likely to be the one to write to). */
459/** @def VANILLA_SCSI_TAPE  The first SCSI tape in the system (most likely to be the one towrite to. */
460/** @def DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE A string whose presence in a device name indicates the
461 * inability to check this device for errors in the mountlist. */
462/** @def RAID_DEVICE_STUB The stub of a RAID device (set up RAID if we find it). */
463/** @def SANE_FORMATS Sane formats for this OS, separated by spaces. */
464/** @def ALT_TAPE The first IDE tape in the system. */
465/** @def MKE2FS_OR_NEWFS @c mke2fs or @c newfs, depending on the OS. */
466/** @def CP_BIN The GNU @c cp binary to use. */
467#ifdef __FreeBSD__
468#define VANILLA_SCSI_CDROM  "/dev/cd0"
469#define VANILLA_SCSI_TAPE   "/dev/sa0"
470#define VANILLA_USB_DEVICE  "tobegivenbybsdguru"
471#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE  "/dev/vinum/"
472#define RAID_DEVICE_STUB    DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
473#define SANE_FORMATS        "swap image msdosfs nfs ntfs raid lvm ffs ufs ext2fs"
474#define ALT_TAPE        "/dev/ast0"
475#define MKE2FS_OR_NEWFS "newfs"
476#define CP_BIN      "gcp"
477#else
478#define VANILLA_SCSI_CDROM  "/dev/scd0"
479#define VANILLA_SCSI_TAPE   "/dev/st0"
480#define VANILLA_USB_DEVICE  "/dev/hda"
481#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE  "/dev/md"
482#define RAID_DEVICE_STUB    DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
483#define SANE_FORMATS        "swap image vfat ext2 ext3 xfs vfs jfs reiserfs vmfs dos minix coda nfs ntfs hpfs raid lvm cifs"
484#define ALT_TAPE        "/dev/ht0"
485#define MKE2FS_OR_NEWFS "mke2fs"
486#define CP_BIN      "cp"
487#endif
488
489
490/**
491 * The template for a filelist filename.
492 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
493 */
494#define FILELIST_FNAME_RAW_SZ "%s/filelist.%ld"
495
496#define XATTR_LIST_FNAME_RAW_SZ      "%s/xattr_list.%ld.gz"
497#define XATTR_BIGGLST_FNAME_RAW_SZ   "%s/xattr_list.big.gz"
498#define ACL_LIST_FNAME_RAW_SZ        "%s/acl_list.%ld.gz"
499#define ACL_BIGGLST_FNAME_RAW_SZ     "%s/acl_list.big.gz"
500
501/**
502 * The template for an afioball filename.
503 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
504 */
505#define AFIOBALL_FNAME_RAW_SZ (bkpinfo->use_star)?"%s/tmpfs/%ld.star.%s":"%s/tmpfs/%ld.afio.%s"
506#define ARCH_THREADS 2          ///< The number of simultaneous threads running afio in the background.
507#define ARCH_BUFFER_NUM (ARCH_THREADS*4)    // Number of permissible queued afio files
508#define FORTY_SPACES "                                         "    ///< 40 spaces.
509#define PPCFG_RAMDISK_SIZE 350  ///< Size of the tmpfs, in megabytes, to attempt to mount (to speed up Mondo).
510
511#define DO_MBR_PLEASE "/tmp/DO-MBR-PLEASE"
512
513
514/**
515 * Compatibility define to change log_it() calls to log_debug_msg() calls.
516 */
517#define log_it(format, args...) log_debug_msg(2, __FILE__, __FUNCTION__, __LINE__, format, ## args)
518
519/**
520 * Macro to log a message along with file, line, and function information.
521 */
522#define log_msg(level, format, args...) log_debug_msg(level, __FILE__, __FUNCTION__, __LINE__, format, ## args)
523
524#define DEFAULT_DVD_DISK_SIZE 4480  ///< The default size (in MB) of a DVD disk, unless the user says otherwise.
525
526#define DEFAULT_DEBUG_LEVEL 4   ///< By default, don't log messages with a loglevel higher than this.
527
528#define SZ_NTFSPROG_VOLSIZE "1048576"   // was 4096
529#define NTFSPROG_PARAMS "-z0 -V" SZ_NTFSPROG_VOLSIZE " -o -b -d -g1"
530
531#define MNT_CDROM "/mnt/cdrom"
532#define MNT_FLOPPY "/mnt/floppy"
533
534#define DEFAULT_MR_LOGLEVEL 4
535
536#endif                          /* _MY_STUFF_H_ */
Note: See TracBrowser for help on using the repository browser.