source: MondoRescue/branches/stable/mondo/src/include/my-stuff.h @ 1438

Last change on this file since 1438 was 1438, checked in by Bruno Cornec, 13 years ago

Merge Andree's patch (2.2.4 rev [1437] around MINDI_CACHE define)
Announce for LinuxDay? added

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