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

Last change on this file since 688 was 688, checked in by bcornec, 13 years ago

Huge memory management patch.
Still not finished but a lot as been done.
What remains is around some functions returning strings, and some structure members.
(Could not finish due to laptop failure !)

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