source: MondoRescue/trunk/mondo/mondo/common/my-stuff.h @ 539

Last change on this file since 539 was 539, checked in by bcornec, 14 years ago

merge -r 534:538 $SVN_M/branches/stable

  • Property svn:keywords set to Id
File size: 14.4 KB
Line 
1/*
2 * Common defines across the project
3 *
4 *  $Id: my-stuff.h 539 2006-05-13 17:38:44Z bcornec $
5 */
6
7#ifndef _MY_STUFF_H_
8#define _MY_STUFF_H_
9
10/* BERLIOS
11#define HAVE_MALLOC 1
12*/
13
14// Extra info for ACLs and SELINUX users
15#define STAR_ACL_SZ "-xfflags -acl"
16//#define STAR_ACL_SZ "-xfflags"
17//#define STAR_ACL_SZ ""
18// Enable the first line and disable the second if you are a Fedora Core 2 user
19
20/**
21 * @file
22 * The main header file for Mondo.
23 */
24#ifndef _MY_STUFF_H_
25#define _MY_STUFF_H_
26
27/* Required for the use of getline, ... */
28#define __USE_GNU
29#define _GNU_SOURCE
30
31#include <stdio.h>
32
33#if !defined(bool) && !defined(__cplusplus)
34/**
35 * Create the illusion of a Boolean type.
36 */
37#define bool unsigned char
38#define TRUE 1
39#define FALSE 0
40#endif
41
42#ifdef HAVE_CONFIG_H
43#include <config.h>
44#endif
45/* BERLIOS
46 * Useful ?
47*/
48
49#ifndef __FreeBSD__
50#include <getopt.h>
51#endif
52
53#include <sys/types.h>
54#include <sys/shm.h>
55#include <sys/ipc.h>
56#include <sys/ioctl.h>
57#include <sys/sem.h>
58#include <sys/param.h>
59
60#include <stdlib.h>
61/* BERLIOS
62#ifndef  __USE_FILE_OFFSET64
63#define  __USE_FILE_OFFSET64
64#endif
65#ifndef  __USE_LARGEFILE64
66#define  __USE_LARGEFILE64
67#endif
68*/
69#include <sys/stat.h>
70#include <fcntl.h>
71#include <errno.h>
72#include <stddef.h>
73#include <sys/stat.h>
74#include <sys/wait.h>
75#include <time.h>
76#include <unistd.h>
77#ifndef S_SPLINT_S
78#include <signal.h>
79#endif
80#include <newt.h>
81#include <ctype.h>
82#include <string.h>
83#ifndef S_SPLINT_S
84#include <pthread.h>
85#include <assert.h>
86
87/*
88#if defined(DEBUG) && !__cplusplus
89int count;
90char trace_log[255];
91char *trace_log_ptr;
92#endif
93*/
94
95#define STD_PREFIX "mondorescue"
96
97/**
98 * The biggielist stub (appended to the directory where all.tar.gz was unpacked).
99 */
100#define BIGGIELIST_TXT_STUB "tmp/biggielist.txt"
101
102/**
103 * The filelist stub (appended to the directory where all.tar.gz was unpacked).
104 */
105#define FILELIST_FULL_STUB "tmp/filelist.full.gz"
106
107/**
108 * The mountlist stub (appended to the directory where all.tar.gz was unpacked).
109 */
110#define MOUNTLIST_FNAME_STUB "tmp/mountlist.txt"
111
112/**
113 * The mondo-restore.cfg stub (appended to the directory where all.tar.gz was unpacked).
114 */
115#define MONDO_CFG_FILE_STUB "tmp/mondo-restore.cfg"
116
117/**
118 * @bug Apparently unused.
119 */
120#define MONDO_TRACEFILE "/var/log/mondo-tracefile.log"
121
122#undef assert
123
124extern void _mondo_assert_fail(const char *file, const char *function,
125                               int line, const char *exp);
126
127/**
128 * An assert macro that calls _mondo_assert_fail() when it fails.
129 */
130#ifdef NDEBUG
131#   define assert(exp) ((void)0)
132#else
133#   ifndef S_SPLINT_S
134#       define assert(exp) ((exp)?((void)0):_mondo_assert_fail(__FILE__, __FUNCTION__, __LINE__, #exp))
135#   else
136#       define assert(exp) ((void)0)
137#   endif
138#endif
139
140#define CRC_M16 0xA001          ///< Mask for crc16.
141#define CRC_MTT 0x1021          ///< Mask for crc-ccitt.
142
143#define SCREEN_LENGTH 25        ///< The default size of the screen.
144#define NOOF_ERR_LINES 6        ///< The number of lines of log output to keep at the bottom of the screen.
145#define ARBITRARY_MAXIMUM 2000  ///< The maximum number of items showing at once in the mountlist or filelist editor.
146#define MAX_TAPECATALOG_ENTRIES 4096    ///< The maximum number of entries in the tape catalog.
147#define MAX_STR_LEN 380         ///< The maximum length of almost all @p char buffers in Mondo.
148#define MAXIMUM_RAID_DEVS 32    ///< The maximum number of RAID devices in the raidlist.
149#define MAXIMUM_ADDITIONAL_RAID_VARS 32 ///< The maximum number of additional RAID variables per RAID device in the raidlist.
150#define MAXIMUM_DISKS_PER_RAID_DEV 32   ///< The maximum number of disks per RAID device in the raidtab.
151
152#define RAIDTAB_FNAME "/etc/raidtab"    ///< The filename of the raidtab file, at least on Linux.
153
154#define BLK_START_OF_BACKUP     1   ///< Marker block: start a backup.
155#define BLK_START_OF_TAPE       2   ///< Marker block: start a tape.
156#define BLK_START_AFIOBALLS 10  ///< Marker block: start the afioball section.
157#define BLK_STOP_AFIOBALLS  19  ///< Marker block: stop the afioball section.
158#define BLK_START_AN_AFIO_OR_SLICE      20  ///< Marker block: start an afioball or a slice.
159#define BLK_STOP_AN_AFIO_OR_SLICE   29  ///< Marker block: stop an afioball or a slice.
160#define BLK_START_BIGGIEFILES   30  ///< Marker block: start the biggiefile section.
161#define BLK_STOP_BIGGIEFILES    39  ///< Marker block: stop the biggiefile section.
162#define BLK_START_A_NORMBIGGIE  40  ///< Marker block: start a normal biggiefile.
163#define BLK_START_A_PIHBIGGIE   41  ///< Marker block: start a ntfsprog'd biggiefile
164#define BLK_START_EXTENDED_ATTRIBUTES 45    ///< Marker block: start xattr/acl info
165#define BLK_STOP_EXTENDED_ATTRIBUTES 46 ///< Marker block: stop xattr/acl info
166#define BLK_START_EXAT_FILE     47
167#define BLK_STOP_EXAT_FILE      48
168#define BLK_STOP_A_BIGGIE   59  ///< Marker block: stop a biggiefile.
169#define BLK_START_FILE          80  ///< Marker block: start a file (non-afio or slice).
170#define BLK_STOP_FILE           89  ///< Marker block: stop a file (non-afio or slice).
171#define BLK_END_OF_TAPE         100 ///< Marker block: end of tape.
172#define BLK_END_OF_BACKUP       101 ///< Marker block: end of backup.
173#define BLK_ABORTED_BACKUP      102 ///< Marker block: backup was aborted.
174
175/// The external tape blocksize.
176#ifdef EXTTAPE
177#define TAPE_BLOCK_SIZE (long)EXTTAPE
178#else
179#define TAPE_BLOCK_SIZE 131072L /* was 8192; 06/2002-->65536; 11/2002-->131072 */
180#endif
181
182#define DEFAULT_INTERNAL_TAPE_BLOCK_SIZE 32768  // Nov 2003?
183
184
185
186
187#define SLICE_SIZE 4096         ///< The size of a slice of a biggiefile.
188
189
190
191
192
193
194/**
195 * Determine whether @p x (t_bkptype) is a streaming backup.
196 */
197#define IS_THIS_A_STREAMING_BACKUP(x) (x == tape || x == udev || x == cdstream)
198
199
200/**
201 * @c mkisofs command to generate a nonbootable CD, except for -o option and the directory to image.
202 */
203#define MONDO_MKISOFS_NONBOOT   "mkisofs -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL_Version -V _CD#_"
204
205/**
206 * @c mkisofs command to generate a bootable CD using isolinux, except for -o option and the directory to image.
207 */
208#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#_"
209
210/**
211 * @c mkisofs command to generate a bootable CD using LILO, except for -o option and the directory to image.
212 */
213// -b images/mindi-boot.2880.img
214#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#_"
215
216/**
217 * @c mkisofs command to generate a bootable CD using ELILO, except for -o option and the directory to image.
218 */
219// -b images/mindi-boot.2880.img
220// Should replace 8192 by IA64_BOOT_SIZE
221#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#_"
222
223/**
224 * The stub name of the temporary ISO image to create, burn, and remove.
225 */
226#define MONDO_TMPISOS "/temporary.iso"
227
228/**
229 * @c growisofs command to generate a bootable DVD using isolinux, except for the directory to image.
230 */
231#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"
232
233/**
234 * @c growisofs command to generate a bootable DVD using LILO, except for the directory to image.
235     */// -b images/mindi-boot.2880.img
236#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"
237
238/**
239 * @c growisofs command to generate a bootable DVD using LILO, except for the directory to image.
240     */// -b images/mindi-boot.2880.img
241#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"
242
243/**
244 * @c growisofs command to generate a nonbootable DVD, except for the directory to image.
245 */
246#define MONDO_GROWISOFS_NONBOOT          "growisofs -use-the-force-luke -J -r -p MondoRescue -publisher www.mondorescue.org -A Mondo_Rescue_GPL -V _CD#_ -v"
247
248/**
249 * Welcome string displayed at the top of the newt interface.
250 */
251#define WELCOME_STRING _("W E L C O M E   T O   M O N D O   R E S C U E")
252
253/**
254 * The maximum length of a filename in the tape catalog.
255 */
256#define MAX_TAPECAT_FNAME_LEN 32
257
258/**
259 * Compatibility #define to ease the transition to logfile-in-a-variable.
260 */
261#define MONDO_LOGFILE    "/var/log/mondo-archive.log"
262
263/**
264 * Assert that (@p x != NULL) and (@p x[0] != '\\0').
265 */
266#define assert_string_is_neither_NULL_nor_zerolength(x) {assert(x!=NULL);assert(x[0]!='\0');}
267
268/**
269 * Log the file, line, Mondo error message, and OS error message (errno).
270 */
271#define log_OS_error(x) {log_msg(0, "%s, line %ld: %s (%s)", __FILE__, __LINE__, x, strerror(errno));}
272
273/**
274 * Assert that (@p x != NULL).
275 */
276#define assert_pointer_is_not_NULL(x) {assert(x!=NULL);}
277
278/**
279 * close() @p x and log a message if it fails.
280 */
281#define paranoid_close(x) {if(close(x)) {log_msg(5, "close err");} x=-999; }
282
283/**
284 * fclose() @p x and log a message if it fails.
285 */
286#define paranoid_fclose(x) {if(fclose(x)) {log_msg(5, "fclose err");} x=NULL; }
287
288/**
289 * pclose() @p x and log a message if it fails.
290 */
291#define paranoid_pclose(x) {if(pclose(x)) {log_msg(5, "pclose err");} x=NULL; }
292
293/**
294 * Run the command @p x and log it if it fails.
295 */
296#define paranoid_system(x) {if(system(x)) log_msg(4, x); }
297
298/**
299 * Free @p x and set it to NULL.
300 */
301#define paranoid_free(x) {if ((x) != NULL) free(x); (x)=NULL;}
302
303/**
304 * Free variables and call finish(@p x).
305 */
306#define paranoid_MR_finish(x) {free_MR_global_filenames (); if (g_bkpinfo_DONTUSETHIS) paranoid_free ( g_bkpinfo_DONTUSETHIS ); finish(x); }
307
308/**
309 * Log file, function, line, and @p x.
310 */
311#define iamhere(x) {log_it("%s, %s, %ld: %s", __FILE__, __FUNCTION__, __LINE__, x);}
312
313/**
314 * Yes, we want malloc() to help us fix bugs.
315 */
316#define MALLOC_CHECK_ 1
317
318/**
319 * Kill any process containing the string @p x surrounded by spaces in its commandline.
320 */
321#define kill_anything_like_this(x) {run_program_and_log_output("kill `ps wax | grep \"" x "\" | awk '{print $1;}' | grep -vx \"\\?\"`", TRUE);}
322
323/**
324 * Malloc @p x to be MAX_STR_LEN bytes and call fatal_error() if we're out of memory.
325 */
326#define malloc_string(x) { x = (char *)malloc(MAX_STR_LEN); if (!x) { fatal_error("Unable to malloc"); } x[0] = x[1] = '\0'; }
327
328/**
329 * Path to the location the hard drive is mounted on during a restore.
330 */
331#define MNT_RESTORING "/mnt/RESTORING"
332
333/** @def VANILLA_SCSI_CDROM The first SCSI CD-ROM in the system (most likely to be the one to write to). */
334/** @def VANILLA_SCSI_TAPE  The first SCSI tape in the system (most likely to be the one towrite to. */
335/** @def DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE A string whose presence in a device name indicates the
336 * inability to check this device for errors in the mountlist. */
337/** @def RAID_DEVICE_STUB The stub of a RAID device (set up RAID if we find it). */
338/** @def SANE_FORMATS Sane formats for this OS, separated by spaces. */
339/** @def ALT_TAPE The first IDE tape in the system. */
340/** @def MKE2FS_OR_NEWFS @c mke2fs or @c newfs, depending on the OS. */
341/** @def CP_BIN The GNU @c cp binary to use. */
342#ifdef __FreeBSD__
343#define VANILLA_SCSI_CDROM  "/dev/cd0"
344#define VANILLA_SCSI_TAPE   "/dev/sa0"
345#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE  "/dev/vinum/"
346#define RAID_DEVICE_STUB    DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
347#define SANE_FORMATS        "swap image msdosfs nfs ntfs raid lvm ffs ufs ext2fs"
348#define ALT_TAPE        "/dev/ast0"
349#define MKE2FS_OR_NEWFS "newfs"
350#define CP_BIN      "gcp"
351#else
352#define VANILLA_SCSI_CDROM  "/dev/scd0"
353#define VANILLA_SCSI_TAPE   "/dev/st0"
354#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE  "/dev/md"
355#define RAID_DEVICE_STUB    DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
356#define SANE_FORMATS        "swap image vfat ext2 ext3 xfs vfs jfs reiserfs dos minix coda nfs ntfs hpfs raid lvm cifs"
357#define ALT_TAPE        "/dev/ht0"
358#define MKE2FS_OR_NEWFS "mke2fs"
359#define CP_BIN      "cp"
360#endif
361
362
363/**
364 * The template for a filelist filename.
365 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
366 */
367#define FILELIST_FNAME_RAW_SZ "%s/filelist.%ld"
368
369#define XATTR_LIST_FNAME_RAW_SZ      "%s/xattr_list.%ld.gz"
370#define XATTR_BIGGLST_FNAME_RAW_SZ   "%s/xattr_list.big.gz"
371#define ACL_LIST_FNAME_RAW_SZ        "%s/acl_list.%ld.gz"
372#define ACL_BIGGLST_FNAME_RAW_SZ     "%s/acl_list.big.gz"
373
374/**
375 * The template for an afioball filename.
376 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
377 */
378#define AFIOBALL_FNAME_RAW_SZ (bkpinfo->use_star)?"%s/tmpfs/%ld.star.%s":"%s/tmpfs/%ld.afio.%s"
379#define ARCH_THREADS 2          ///< The number of simultaneous threads running afio in the background.
380#define ARCH_BUFFER_NUM (ARCH_THREADS*4)    // Number of permissible queued afio files
381#define FORTY_SPACES "                                         "    ///< 40 spaces.
382#define PPCFG_RAMDISK_SIZE 250  ///< Size of the tmpfs, in megabytes, to attempt to mount (to speed up Mondo).
383
384#define DO_MBR_PLEASE "/tmp/DO-MBR-PLEASE"
385
386
387/**
388 * Compatibility define to change log_it() calls to log_debug_msg() calls.
389 */
390#define log_it(format, args...) log_debug_msg(2, __FILE__, __FUNCTION__, __LINE__, format, ## args)
391
392/**
393 * Macro to log a message along with file, line, and function information.
394 */
395#define log_msg(level, format, args...) log_debug_msg(level, __FILE__, __FUNCTION__, __LINE__, format, ## args)
396
397#define DEFAULT_DVD_DISK_SIZE 4380  ///< The default size (in MB) of a DVD disk, unless the user says otherwise.
398
399#define DEFAULT_DEBUG_LEVEL 4   ///< By default, don't log messages with a loglevel higher than this.
400
401#define SZ_NTFSPROG_VOLSIZE "1048576"   // was 4096
402#define NTFSPROG_PARAMS "-z0 -V" SZ_NTFSPROG_VOLSIZE " -o -b -d -g1"
403
404#define MNT_CDROM "/mnt/cdrom"
405#define MNT_FLOPPY "/mnt/floppy"
406
407#define DEFAULT_MR_LOGLEVEL 4
408
409#ifdef ENABLE_NLS 
410# include <libintl.h> 
411# undef _ 
412# define _(String) dgettext (PACKAGE, String)
413# ifdef gettext_noop 
414#  define N_(String) gettext_noop (String) 
415# else 
416#  define N_(String) (String) 
417# endif 
418#else 
419# define textdomain(String) (String) 
420# define gettext(String) (String) 
421# define dgettext(Domain,Message) (Message) 
422# define dcgettext(Domain,Message,Type) (Message) 
423# define bindtextdomain(Domain,Directory) (Domain) 
424# define _(String) (String) 
425# define N_(String) (String) 
426
427#endif
428
429
430
431#endif                          /* _MY_STUFF_H_ */
Note: See TracBrowser for help on using the repository browser.