source: MondoRescue/trunk/mondo/src/include/my-stuff.h@ 1081

Last change on this file since 1081 was 1081, checked in by Bruno Cornec, 17 years ago

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