source: branches/stable/mondo/src/include/my-stuff.h @ 1924

Last change on this file since 1924 was 1924, checked in by bruno, 11 years ago

svn merge -r 1902:1923 $SVN_M/branches/2.2.6

  • Property svn:eol-style set to native
File size: 9.3 KB
Line 
1/*
2 * Common defines across the project
3 *
4 *  $Id: my-stuff.h 973 2006-11-23 18:05:21Z bruno $
5 */
6
7#ifndef _MY_STUFF_H_
8#define _MY_STUFF_H_
9
10// Extra info for ACLs and SELINUX users
11#define STAR_ACL_SZ "-xfflags -acl"
12
13/*The number of lines of log output to keep at the bottom of the screen.*/
14#define NOOF_ERR_LINES  6   
15
16/* Hardcoded: Bad for the moment */
17#define MONDO_CACHE "/var/cache/mondo"
18#define MINDI_CACHE "/var/cache/mindi"
19#define MONDORESTORECFG MONDO_CACHE"/mondo-restore.cfg"
20
21/**
22 * The mondo-restore.cfg stub (appended to the directory where all.tar.gz was unpacked).
23 */
24#define MONDO_CFG_FILE_STUB "./tmp/mondo-restore.cfg"
25
26/**
27 * @file
28 * The main header file for Mondo.
29 */
30
31#include <stdio.h>
32#include "mr_mem.h"
33#include "mr_msg.h"
34#include "mr_types.h"
35
36#ifdef HAVE_CONFIG_H
37#include <config.h>
38#endif
39/* BERLIOS
40 * Useful ?
41*/
42
43#ifndef __FreeBSD__
44#include <getopt.h>
45#endif
46
47#include <sys/types.h>
48#include <sys/shm.h>
49#include <sys/ipc.h>
50#include <sys/ioctl.h>
51#include <sys/sem.h>
52#include <sys/param.h>
53
54#include <stdlib.h>
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 <newt.h>
67#include <ctype.h>
68#include <string.h>
69#ifndef S_SPLINT_S
70#include <pthread.h>
71#endif
72#include <assert.h>
73
74/**
75 * The biggielist stub (appended to the directory where all.tar.gz was unpacked).
76 */
77#define BIGGIELIST_TXT_STUB "./tmp/biggielist.txt"
78
79/**
80 * The filelist stub (appended to the directory where all.tar.gz was unpacked).
81 */
82#define FILELIST_FULL_STUB "./tmp/filelist.full.gz"
83
84/**
85 * The mountlist stub (appended to the directory where all.tar.gz was unpacked).
86 */
87#define MOUNTLIST_FNAME_STUB "./tmp/mountlist.txt"
88
89/**
90 * The mondo-restore.cfg stub (appended to the directory where all.tar.gz was unpacked).
91 */
92#define MONDO_CFG_FILE_STUB "./tmp/mondo-restore.cfg"
93
94/**
95 * The location where mondo changed info are stored.
96 */
97#define MONDO_CACHE "/var/cache/mondo"
98
99/**
100 * The RAID kernel proc file
101 */
102#define MDSTAT_FILE "/proc/mdstat"
103
104#undef assert
105
106extern void _mondo_assert_fail(const char *file, const char *function,
107                               int line, const char *exp);
108
109/**
110 * An assert macro that calls _mondo_assert_fail() when it fails.
111 */
112#ifdef NDEBUG
113#   define assert(exp) ((void)0)
114#else
115#   ifndef S_SPLINT_S
116#       define assert(exp) ((exp)?((void)0):_mondo_assert_fail(__FILE__, __FUNCTION__, __LINE__, #exp))
117#   else
118#       define assert(exp) ((void)0)
119#   endif
120#endif
121
122#define CRC_M16 0xA001          ///< Mask for crc16.
123#define CRC_MTT 0x1021          ///< Mask for crc-ccitt.
124
125#define SCREEN_LENGTH 25        ///< The default size of the screen.
126#define ARBITRARY_MAXIMUM 2000  ///< The maximum number of items showing at once in the mountlist or filelist editor.
127#define MAX_TAPECATALOG_ENTRIES 8192    ///< The maximum number of entries in the tape catalog.
128#define MAX_STR_LEN 384         ///< The maximum length of almost all @p char buffers in Mondo.
129                                        ///  Note: Make this divisible by eight to avoid aligment issues
130                                        ///        on 64bit platforms like ia64.
131#define MAXIMUM_RAID_DEVS 32    ///< The maximum number of RAID devices in the raidlist.
132#define MAXIMUM_ADDITIONAL_RAID_VARS 32 ///< The maximum number of additional RAID variables per RAID device in the raidlist.
133#define MAXIMUM_DISKS_PER_RAID_DEV 32   ///< The maximum number of disks per RAID device in the raidtab.
134
135#define RAIDTAB_FNAME "/etc/raidtab"    ///< The filename of the raidtab file, at least on Linux.
136
137#define BLK_START_OF_BACKUP     1   ///< Marker block: start a backup.
138#define BLK_START_OF_TAPE       2   ///< Marker block: start a tape.
139#define BLK_START_AFIOBALLS 10  ///< Marker block: start the afioball section.
140#define BLK_STOP_AFIOBALLS  19  ///< Marker block: stop the afioball section.
141#define BLK_START_AN_AFIO_OR_SLICE      20  ///< Marker block: start an afioball or a slice.
142#define BLK_STOP_AN_AFIO_OR_SLICE   29  ///< Marker block: stop an afioball or a slice.
143#define BLK_START_BIGGIEFILES   30  ///< Marker block: start the biggiefile section.
144#define BLK_STOP_BIGGIEFILES    39  ///< Marker block: stop the biggiefile section.
145#define BLK_START_A_NORMBIGGIE  40  ///< Marker block: start a normal biggiefile.
146#define BLK_START_A_PIHBIGGIE   41  ///< Marker block: start a ntfsprog'd biggiefile
147#define BLK_START_EXTENDED_ATTRIBUTES 45    ///< Marker block: start xattr/acl info
148#define BLK_STOP_EXTENDED_ATTRIBUTES 46 ///< Marker block: stop xattr/acl info
149#define BLK_START_EXAT_FILE     47
150#define BLK_STOP_EXAT_FILE      48
151#define BLK_STOP_A_BIGGIE   59  ///< Marker block: stop a biggiefile.
152#define BLK_START_FILE          80  ///< Marker block: start a file (non-afio or slice).
153#define BLK_STOP_FILE           89  ///< Marker block: stop a file (non-afio or slice).
154#define BLK_END_OF_TAPE         100 ///< Marker block: end of tape.
155#define BLK_END_OF_BACKUP       101 ///< Marker block: end of backup.
156#define BLK_ABORTED_BACKUP      102 ///< Marker block: backup was aborted.
157
158/**
159 * Determine whether @p x (t_bkptype) is a streaming backup.
160 */
161#define IS_THIS_A_STREAMING_BACKUP(x) (x == tape || x == udev || x == cdstream)
162
163/**
164 * The stub name of the temporary ISO image to create, burn, and remove.
165 */
166#define MONDO_TMPISOS "temporary.iso"
167
168/**
169 * Assert that (@p x != NULL) and (@p x[0] != '\\0').
170 */
171#define assert_string_is_neither_NULL_nor_zerolength(x) {assert(x!=NULL);assert(x[0]!='\0');}
172
173/**
174 * Log the file, line, Mondo error message, and OS error message (errno).
175 */
176#define log_OS_error(x) {mr_msg(1, "%s, (%s)", x, strerror(errno));}
177
178/**
179 * Assert that (@p x != NULL).
180 */
181#define assert_pointer_is_not_NULL(x) {assert(x!=NULL);}
182
183/**
184 * close() @p x and log a message if it fails.
185 */
186#define paranoid_close(x) {if(close(x)) {mr_msg(5, "close err");} x=-999; }
187
188/**
189 * fclose() @p x and log a message if it fails.
190 */
191#define paranoid_fclose(x) {if(fclose(x)) {mr_msg(5, "fclose err");} x=NULL; }
192
193/**
194 * pclose() @p x and log a message if it fails.
195 */
196#define paranoid_pclose(x) {if(pclose(x)) {mr_msg(5, "pclose err");} x=NULL; }
197
198/**
199 * Run the command @p x and log it if it fails.
200 */
201#define paranoid_system(x) {if(system(x)) mr_msg(4, x); }
202
203/**
204 * Free variables and call finish(@p x).
205 */
206#define paranoid_MR_finish(x) {free_MR_global_filenames (); finish(x); }
207
208/**
209 * Log file, function, line, and @p x.
210 */
211#define iamhere(x) {mr_msg(2, x);}
212
213/**
214 * Yes, we want malloc() to help us fix bugs.
215 */
216#define MALLOC_CHECK_ 1
217
218/**
219 * Malloc @p x to be MAX_STR_LEN bytes and call fatal_error() if we're out of memory.
220 */
221#define malloc_string(x) { x = (char *)mr_malloc(MAX_STR_LEN); x[0] = x[1] = '\0'; }
222
223/**
224 * Path to the location the hard drive is mounted on during a restore.
225 */
226#define MNT_RESTORING "/mnt/RESTORING"
227
228/** @def VANILLA_SCSI_TAPE  The SCSI tape radical on the system (most likely to be the one towrite to. */
229/** @def DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE A string whose presence in a device name indicates the
230 * inability to check this device for errors in the mountlist. */
231/** @def RAID_DEVICE_STUB The stub of a RAID device (set up RAID if we find it). */
232/** @def SANE_FORMATS Sane formats for this OS, separated by spaces. */
233/** @def ALT_TAPE The first IDE tape in the system. */
234/** @def MKE2FS_OR_NEWFS @c mke2fs or @c newfs, depending on the OS. */
235/** @def CP_BIN The GNU @c cp binary to use. */
236#ifdef __FreeBSD__
237#define VANILLA_SCSI_TAPE   "/dev/sa"
238#define VANILLA_USB_DEVICE  "tobegivenbybsdguru"
239#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE  "/dev/vinum/"
240#define RAID_DEVICE_STUB    DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
241#define SANE_FORMATS        "swap image msdosfs nfs ntfs raid lvm ffs ufs ext2fs"
242#define ALT_TAPE        "/dev/ast"
243#define MKE2FS_OR_NEWFS "newfs"
244#define CP_BIN      "gcp"
245#else
246#define VANILLA_SCSI_TAPE   "/dev/st0"
247#define VANILLA_USB_DEVICE  "/dev/hda"
248#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE  "/dev/md"
249#define RAID_DEVICE_STUB    DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
250#define SANE_FORMATS        "swap image vfat ext2 ext3 xfs vfs jfs reiserfs dos minix coda nfs ntfs hpfs raid lvm cifs"
251#define ALT_TAPE        "/dev/ht0"
252#define MKE2FS_OR_NEWFS "mke2fs"
253#define CP_BIN      "cp"
254#endif
255
256
257/**
258 * The template for a filelist filename.
259 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
260 */
261#define FILELIST_FNAME_RAW_SZ "%s/filelist.%ld"
262
263#define XATTR_LIST_FNAME_RAW_SZ      "%s/xattr_list.%ld.gz"
264#define XATTR_BIGGLST_FNAME_RAW_SZ   "%s/xattr_list.big.gz"
265#define ACL_LIST_FNAME_RAW_SZ        "%s/acl_list.%ld.gz"
266#define ACL_BIGGLST_FNAME_RAW_SZ     "%s/acl_list.big.gz"
267
268/**
269 * The template for an afioball filename.
270 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
271 */
272#define AFIOBALL_FNAME_RAW_SZ (bkpinfo->use_star)?"%s/tmpfs/%ld.star.%s":"%s/tmpfs/%ld.afio.%s"
273#define ARCH_THREADS 2          ///< The number of simultaneous threads running afio in the background.
274#define ARCH_BUFFER_NUM (ARCH_THREADS*4)    // Number of permissible queued afio files
275#define PPCFG_RAMDISK_SIZE 350  ///< Size of the tmpfs, in megabytes, to attempt to mount (to speed up Mondo).
276
277/**
278 * Shorter log command
279 */
280#define log_it(format, args...) mr_msg(2, format, ## args)
281
282#define SZ_NTFSPROG_VOLSIZE "1048576"   // was 4096
283#define NTFSPROG_PARAMS "-z0 -V" SZ_NTFSPROG_VOLSIZE " -o -b -d -g1"
284
285#define MNT_CDROM "/mnt/cdrom"
286
287#endif                          /* _MY_STUFF_H_ */
Note: See TracBrowser for help on using the repository browser.