source: MondoRescue/branches/3.3/mondo/src/include/my-stuff.h

Last change on this file was 3885, checked in by Bruno Cornec, 7 weeks ago

Removes support for ia64 depracated in upstream kernel, and elilo

  • Property svn:keywords set to Id
File size: 12.1 KB
Line 
1/* my-stuff.h
2 $Id: my-stuff.h 3885 2024-03-10 18:23:12Z bruno $
3*/
4
5#define HAVE_MALLOC 1
6
7/**
8 * @file
9 * The main header file for Mondo.
10 */
11
12#if !defined(bool) && !defined(__cplusplus)
13/**
14 * Create the illusion of a Boolean type.
15 */
16#define bool int
17#define TRUE 1
18#define FALSE 0
19#endif
20
21#ifndef _MY_STUFF_H_
22#define _MY_STUFF_H_
23
24#ifndef __FreeBSD__
25#include <getopt.h>
26#endif
27#include <sys/types.h>
28#include <sys/ipc.h>
29#include <sys/ioctl.h>
30#include <sys/sem.h>
31#include <sys/param.h>
32#include <stdio.h>
33#include <stdlib.h>
34#ifndef __USE_FILE_OFFSET64
35#define __USE_FILE_OFFSET64
36#endif
37#ifndef __USE_LARGEFILE64
38#define __USE_LARGEFILE64
39#endif
40#include <sys/stat.h>
41#include <fcntl.h>
42#include <errno.h>
43#include <stddef.h>
44#include <sys/stat.h>
45#include <sys/wait.h>
46#include <time.h>
47#include <unistd.h>
48#include <signal.h>
49//#include <curses.h>
50#include <newt.h>
51#include <ctype.h>
52#include <string.h>
53#include <pthread.h>
54#include <assert.h>
55
56#if defined(DEBUG) && !__cplusplus
57int count;
58char trace_log[255]; /*buffer for logging */
59char *trace_log_ptr;
60#endif /* DEBUG */
61
62#define STD_PREFIX "mondorescue" /* Should be coherent with mindi */
63
64/**
65 * The location where mindi media images are stored.
66 */
67#define MINDI_CACHE_REL "var/cache/mindi" /* Should be coherent with mindi */
68#define MINDI_CACHE "/"MINDI_CACHE_REL
69#define MINDI_LOGFILE "/var/log/mindi.log"
70#define MINDI_RUNFILE "/var/log/mindi.run"
71
72/**
73 * The location where mondo changed info are stored.
74 */
75#define MONDO_CACHE "/var/cache/mondo"
76#define ARCHIVES_PATH MNT_CDROM"/archives"
77#define BIGGIELIST ARCHIVES_PATH"/biggielist.txt"
78
79/**
80 * The RAID kernel proc file
81 */
82#define MDSTAT_FILE "/proc/mdstat"
83
84#ifdef __FreeBSD__
85#define CMDLINE "/tmp/cmdline"
86#else
87// Default Linux
88#define CMDLINE "/proc/cmdline"
89#endif
90
91#undef assert
92
93extern void _mondo_assert_fail(const char *file, const char *function,
94 int line, const char *exp);
95
96/**
97 * An assert macro that calls _mondo_assert_fail() when it fails.
98 */
99#ifdef NDEBUG
100#define assert(exp) ((void)0)
101#else
102#define assert(exp) ((exp)?((void)0):_mondo_assert_fail(__FILE__, __FUNCTION__, __LINE__, #exp))
103#endif
104
105// Extra info for ACLs and SELINUX users
106#define STAR_ACL_SZ "-xattr -acl"
107
108#define CRC_M16 0xA001 ///< Mask for crc16.
109#define CRC_MTT 0x1021 ///< Mask for crc-ccitt.
110
111#define FALSE 0 ///< The ubiquitous FALSE macro.
112#define TRUE 1 ///< The even more ubiquitous TRUE macro.
113
114#define SCREEN_LENGTH 25 ///< The default size of the screen.
115#define NOOF_ERR_LINES 6 ///< The number of lines of log output to keep at the bottom of the screen.
116#define ARBITRARY_MAXIMUM 2000 ///< The maximum number of items showing at once in the mountlist or filelist editor.
117#define MAX_TAPECATALOG_ENTRIES 16384 ///< The maximum number of entries in the tape catalog.
118#define MAX_MOUNTLIST_ENTRIES 8192 ///< The maximum number of entries in the mountlist.
119#define MAX_STR_LEN 512 ///< The maximum length of almost all @p char buffers in Mondo.
120 /// Note: Make this divisible by eight to avoid aligment issues
121 /// on 64bit platforms
122#define MAXIMUM_RAID_DEVS 32 ///< The maximum number of RAID devices in the raidlist.
123#define MAXIMUM_ADDITIONAL_RAID_VARS 32 ///< The maximum number of additional RAID variables per RAID device in the raidlist.
124#define MAXIMUM_DISKS_PER_RAID_DEV 1024 ///< The maximum number of disks per RAID device in the raidtab.
125
126#define RAIDTAB_FNAME "/etc/raidtab" ///< The filename of the raidtab file, at least on Linux.
127
128#define BLK_START_OF_BACKUP 1 ///< Marker block: start a backup.
129#define BLK_START_OF_TAPE 2 ///< Marker block: start a tape.
130#define BLK_START_AFIOBALLS 10 ///< Marker block: start the afioball section.
131#define BLK_STOP_AFIOBALLS 19 ///< Marker block: stop the afioball section.
132#define BLK_START_AN_AFIO_OR_SLICE 20 ///< Marker block: start an afioball or a slice.
133#define BLK_STOP_AN_AFIO_OR_SLICE 29 ///< Marker block: stop an afioball or a slice.
134#define BLK_START_BIGGIEFILES 30 ///< Marker block: start the biggiefile section.
135#define BLK_STOP_BIGGIEFILES 39 ///< Marker block: stop the biggiefile section.
136#define BLK_START_A_NORMBIGGIE 40 ///< Marker block: start a normal biggiefile.
137#define BLK_START_A_PIHBIGGIE 41 ///< Marker block: start a ntfsprog'd biggiefile
138#define BLK_START_EXTENDED_ATTRIBUTES 45 ///< Marker block: start xattr/acl info
139#define BLK_STOP_EXTENDED_ATTRIBUTES 46 ///< Marker block: stop xattr/acl info
140#define BLK_START_EXAT_FILE 47
141#define BLK_STOP_EXAT_FILE 48
142#define BLK_STOP_A_BIGGIE 59 ///< Marker block: stop a biggiefile.
143#define BLK_START_FILE 80 ///< Marker block: start a file (non-afio or slice).
144#define BLK_STOP_FILE 89 ///< Marker block: stop a file (non-afio or slice).
145#define BLK_END_OF_TAPE 100 ///< Marker block: end of tape.
146#define BLK_END_OF_BACKUP 101 ///< Marker block: end of backup.
147#define BLK_ABORTED_BACKUP 102 ///< Marker block: backup was aborted.
148
149/// The external tape blocksize.
150#ifdef EXTTAPE
151#define TAPE_BLOCK_SIZE (long)EXTTAPE
152#else
153#define TAPE_BLOCK_SIZE 131072L /* was 8192; 06/2002-->65536; 11/2002-->131072 */
154#endif
155
156#define DEFAULT_INTERNAL_TAPE_BLOCK_SIZE 32768 // Nov 2003?
157
158
159
160
161#define SLICE_SIZE 4096 ///< The size of a slice of a biggiefile.
162
163
164
165
166
167
168/**
169 * Determine whether @p x (t_bkptype) is a streaming backup.
170 */
171#define IS_THIS_A_STREAMING_BACKUP(x) (x == tape || x == udev)
172
173
174#define MONDO_MKISOFS_CMD "mkisofs"
175#define MONDO_MKISOFS_OPT ""
176#define MONDO_WODIM_OPT ""
177#define MONDO_GENISOIMAGE_OPT ""
178#define MONDO_XORRISO_OPT "-as mkisofs"
179#define MONDO_MKISOFS " -J -r -v -p MondoRescue -publisher http://www.mondorescue.org -A MondoRescue -V _CD#_ "
180#define MONDO_MKISOFS_CMS " -b syslinux/isolinux.bin -c syslinux/boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table "
181#define MONDO_UEFI_PREFIX " -b EFI/isolinux.bin -c EFI/boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table -eltorito-alt-boot "
182/* No space before this one as we may want to add another '-' before it */
183#define MONDO_MKISOFS_UEFI "-efi-boot images/mindi-bootroot.img -no-emul-boot "
184
185/**
186 * @c mkisofs command to generate a bootable CD using isolinux, except for -o option and the directory to image.
187 */
188#define MONDO_MKISOFS_REGULAR_SYSLINUX MONDO_MKISOFS
189
190/**
191 * @c mkisofs command to generate a bootable CD using LILO, except for -o option and the directory to image.
192 */
193#define MONDO_MKISOFS_REGULAR_LILO MONDO_MKISOFS_REGULAR_SYSLINUX
194
195/**
196 * The stub name of the temporary ISO image to create, burn, and remove.
197 */
198#define MONDO_TMPISOS "temporary.iso"
199
200/**
201 * @c growisofs command to generate a bootable DVD using isolinux, except for the directory to image.
202 */
203#define MONDO_GROWISOFS_REGULAR_SYSLINUX "growisofs -use-the-force-luke "MONDO_MKISOFS_REGULAR_SYSLINUX
204
205/**
206 * @c growisofs command to generate a bootable DVD using LILO, except for the directory to image.
207 */
208#define MONDO_GROWISOFS_REGULAR_LILO "growisofs "MONDO_MKISOFS_REGULAR_SYSLINUX
209
210/**
211 * Welcome string displayed at the top of the newt interface.
212 */
213#define WELCOME_STRING "W E L C O M E T O M O N D O R E S C U E"
214
215/**
216 * The maximum length of a filename in the tape catalog.
217 */
218#define MAX_TAPECAT_FNAME_LEN 32
219
220/**
221 * Assert that (@p x != NULL) and (@p x[0] != '\\0').
222 */
223#define assert_string_is_neither_NULL_nor_zerolength(x) {assert(x!=NULL);assert(x[0]!='\0');}
224
225/**
226 * Log the file, line, Mondo error message, and OS error message (errno).
227 */
228#define log_OS_error(x) {log_msg(0, "%s (%s)", x, strerror(errno));}
229
230/**
231 * Assert that (@p x != NULL).
232 */
233#define assert_pointer_is_not_NULL(x) {assert(x!=NULL);}
234
235/**
236 * close() @p x and log a message if it fails.
237 */
238#define paranoid_close(x) {if(close(x)) {log_msg(5, "close err");} x=-999; }
239
240/**
241 * fclose() @p x and log a message if it fails.
242 */
243#define paranoid_fclose(x) {if(fclose(x)) {log_msg(5, "fclose err");} x=NULL; }
244
245/**
246 * pclose() @p x and log a message if it fails.
247 */
248#define paranoid_pclose(x) {if(pclose(x)) {log_msg(5, "pclose err");} x=NULL; }
249
250/**
251 * Run the command @p x and log it if it fails.
252 */
253#define paranoid_system(x) {if(system(x)) log_msg(4, x); }
254
255/**
256 * Free @p x and set it to NULL.
257 */
258#define paranoid_free(x) {if (x != NULL) free(x); x=NULL;}
259
260/**
261 * Free variables and call finish(@p x).
262 */
263#define paranoid_MR_finish(x) {free_MR_global_filenames (); finish(x); }
264
265/**
266 * Yes, we want malloc() to help us fix bugs.
267 */
268#define MALLOC_CHECK_ 1
269
270/**
271 * Malloc @p x to be MAX_STR_LEN bytes and call fatal_error() if we're out of memory.
272 */
273#define malloc_string(x) { x = (char *)malloc(MAX_STR_LEN); if (!x) { fatal_error("Unable to malloc"); } x[0] = x[1] = '\0'; }
274
275/**
276 * Path to the location the hard drive is mounted on during a restore.
277 */
278#define MNT_RESTORING "/mnt/RESTORING"
279
280/** @def VANILLA_SCSI_CDROM The first SCSI CD-ROM in the system (most likely to be the one to write to). */
281/** @def VANILLA_SCSI_TAPE The first SCSI tape in the system (most likely to be the one towrite to. */
282/** @def DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE A string whose presence in a device name indicates the
283 * inability to check this device for errors in the mountlist. */
284/** @def RAID_DEVICE_STUB The stub of a RAID device (set up RAID if we find it). */
285/** @def ALT_TAPE The first IDE tape in the system. */
286/** @def MKE2FS_OR_NEWFS @c mke2fs or @c newfs, depending on the OS. */
287/** @def CP_BIN The GNU @c cp binary to use. */
288#ifdef __FreeBSD__
289#define VANILLA_SCSI_CDROM "/dev/cd0"
290#define ALT_CDROM "/dev/ad0"
291#define VANILLA_SCSI_TAPE "/dev/sa0"
292#define VANILLA_USB_DEVICE "tobegivenbybsdguru"
293#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE "/dev/vinum/"
294#define RAID_DEVICE_STUB DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
295#define ALT_TAPE "/dev/ast0"
296#define MKE2FS_OR_NEWFS "newfs"
297#define CP_BIN "gcp"
298#else
299#define VANILLA_SCSI_CDROM "/dev/sr0"
300#define ALT_CDROM "/dev/scd0"
301#define VANILLA_SCSI_TAPE "/dev/st0"
302#define VANILLA_USB_DEVICE "/dev/hda"
303#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE "/dev/md"
304#define RAID_DEVICE_STUB DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
305#define ALT_TAPE "/dev/ht0"
306#define MKE2FS_OR_NEWFS "mke2fs"
307#define CP_BIN "cp"
308#endif
309
310
311/**
312 * The template for a filelist filename.
313 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
314 */
315#define FILELIST_FNAME_RAW_SZ "%s/filelist.%ld"
316
317#define XATTR_LIST_FNAME_RAW_SZ "%s/xattr_list.%ld.gz"
318#define XATTR_BIGGLST_FNAME_RAW_SZ "%s/xattr_list.big.gz"
319#define ACL_LIST_FNAME_RAW_SZ "%s/acl_list.%ld.gz"
320#define ACL_BIGGLST_FNAME_RAW_SZ "%s/acl_list.big.gz"
321
322#define BIGGIEMAXSIZE 64L*1024L
323/**
324 * The template for an afioball filename.
325 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
326 */
327#define AFIOBALL_FNAME_RAW_SZ (bkpinfo->use_star)?"%s/tmpfs/%ld.star.%s":"%s/tmpfs/%ld.afio.%s"
328#define ARCH_THREADS 2 ///< The number of simultaneous threads running afio in the background.
329#define ARCH_BUFFER_NUM (ARCH_THREADS*4) // Number of permissible queued afio files
330#define FORTY_SPACES " " ///< 40 spaces.
331#define DO_MBR_PLEASE "/tmp/DO-MBR-PLEASE"
332#define MONDO_MNTLISTCHG "/tmp/mountlist.changed"
333
334extern void (*log_debug_msg) (int debug_level, const char *szFile,
335 const char *szFunction, int nLine,
336 const char *fmt, ...);
337extern void standard_log_debug_msg(int debug_level, const char *szFile,
338 const char *szFunction, int nLine,
339 const char *fmt, ...);
340
341/**
342 * Compatibility define to change log_it() calls to log_debug_msg() calls.
343 */
344#define log_it(format, args...) log_debug_msg(2, __FILE__, __FUNCTION__, __LINE__, format, ## args)
345
346/**
347 * Macro to log a message along with file, line, and function information.
348 */
349#define log_msg(level, format, args...) log_debug_msg(level, __FILE__, __FUNCTION__, __LINE__, format, ## args)
350
351#define DEFAULT_DVD_DISK_SIZE 4480 ///< The default size (in MB) of a DVD disk, unless the user says otherwise.
352
353#define DEFAULT_DEBUG_LEVEL 4 ///< By default, don't log messages with a loglevel higher than this.
354
355#define SZ_NTFSPROG_VOLSIZE "1048576" // was 4096
356#define NTFSPROG_PARAMS "-z0 -V" SZ_NTFSPROG_VOLSIZE " -o -b -d -g1"
357
358#define MNT_CDROM "/mnt/cdrom"
359
360#define DEFAULT_MR_LOGLEVEL 4
361
362#endif /* _MY_STUFF_H_ */
Note: See TracBrowser for help on using the repository browser.