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

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

MONDO_LOGFILE used each time now
memory management on libmondo-devices.c
some splint improvements

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