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

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

merge -r139:141 $SVN_M/branches/2.05
splint improvements (begin)

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