source: branches/3.2/mondo/src/include/my-stuff.h @ 3505

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