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

Last change on this file since 1629 was 1629, checked in by Bruno Cornec, 13 years ago

STD_PREFIX only for restore now, waiting for removal also.

  • Property svn:eol-style set to native
File size: 9.2 KB
RevLine 
[1054]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
[1069]13/*The number of lines of log output to keep at the bottom of the screen.*/
14#define NOOF_ERR_LINES  6   
15
[1087]16/* Hardcoded: Bad for the moment */
17#define MONDO_CACHE "/var/cache/mondo"
[1438]18#define MINDI_CACHE "/var/cache/mindi"
[1087]19#define MONDORESTORECFG MONDO_CACHE"/mondo-restore.cfg"
[1158]20/**
21 * The mondo-restore.cfg stub (appended to the directory where all.tar.gz was unpacked).
22 */
23#define MONDO_CFG_FILE_STUB "tmp/mondo-restore.cfg"
[1087]24
25
[1158]26
[1054]27/**
28 * @file
29 * The main header file for Mondo.
30 */
31
32#include <stdio.h>
[1080]33#include "mr_mem.h"
[1144]34#include "mr_msg.h"
[1264]35#include "mr_types.h"
[1054]36
37#ifdef HAVE_CONFIG_H
38#include <config.h>
39#endif
40/* BERLIOS
41 * Useful ?
42*/
43
44#ifndef __FreeBSD__
45#include <getopt.h>
46#endif
47
48#include <sys/types.h>
49#include <sys/shm.h>
50#include <sys/ipc.h>
51#include <sys/ioctl.h>
52#include <sys/sem.h>
53#include <sys/param.h>
54
55#include <stdlib.h>
56#include <sys/stat.h>
57#include <fcntl.h>
58#include <errno.h>
59#include <stddef.h>
60#include <sys/stat.h>
61#include <sys/wait.h>
62#include <time.h>
63#include <unistd.h>
64#ifndef S_SPLINT_S
65#include <signal.h>
66#endif
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/**
76 * The biggielist stub (appended to the directory where all.tar.gz was unpacked).
77 */
78#define BIGGIELIST_TXT_STUB "tmp/biggielist.txt"
79
80/**
81 * The filelist stub (appended to the directory where all.tar.gz was unpacked).
82 */
83#define FILELIST_FULL_STUB "tmp/filelist.full.gz"
84
85/**
86 * The mountlist stub (appended to the directory where all.tar.gz was unpacked).
87 */
88#define MOUNTLIST_FNAME_STUB "tmp/mountlist.txt"
89
90/**
91 * The RAID kernel proc file
92 */
93#define MDSTAT_FILE "/proc/mdstat"
94
95#undef assert
96
97extern void _mondo_assert_fail(const char *file, const char *function,
98                               int line, const char *exp);
99
100/**
101 * An assert macro that calls _mondo_assert_fail() when it fails.
102 */
103#ifdef NDEBUG
104#   define assert(exp) ((void)0)
105#else
106#   ifndef S_SPLINT_S
107#       define assert(exp) ((exp)?((void)0):_mondo_assert_fail(__FILE__, __FUNCTION__, __LINE__, #exp))
108#   else
109#       define assert(exp) ((void)0)
110#   endif
111#endif
112
113#define CRC_M16 0xA001          ///< Mask for crc16.
114#define CRC_MTT 0x1021          ///< Mask for crc-ccitt.
115
116#define SCREEN_LENGTH 25        ///< The default size of the screen.
117#define ARBITRARY_MAXIMUM 2000  ///< The maximum number of items showing at once in the mountlist or filelist editor.
118#define MAX_TAPECATALOG_ENTRIES 8192    ///< The maximum number of entries in the tape catalog.
[1078]119#define MAX_STR_LEN 384         ///< 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 like ia64.
[1054]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 32   ///< 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 || x == cdstream)
172
173/**
174 * Assert that (@p x != NULL) and (@p x[0] != '\\0').
175 */
176#define assert_string_is_neither_NULL_nor_zerolength(x) {assert(x!=NULL);assert(x[0]!='\0');}
177
178/**
179 * Log the file, line, Mondo error message, and OS error message (errno).
180 */
[1144]181#define log_OS_error(x) {mr_msg(1, "%s, line %ld: %s (%s)", __FILE__, __LINE__, x, strerror(errno));}
[1054]182
183/**
184 * Assert that (@p x != NULL).
185 */
186#define assert_pointer_is_not_NULL(x) {assert(x!=NULL);}
187
188/**
189 * close() @p x and log a message if it fails.
190 */
[1144]191#define paranoid_close(x) {if(close(x)) {mr_msg(5, "close err");} x=-999; }
[1054]192
193/**
194 * fclose() @p x and log a message if it fails.
195 */
[1144]196#define paranoid_fclose(x) {if(fclose(x)) {mr_msg(5, "fclose err");} x=NULL; }
[1054]197
198/**
199 * pclose() @p x and log a message if it fails.
200 */
[1144]201#define paranoid_pclose(x) {if(pclose(x)) {mr_msg(5, "pclose err");} x=NULL; }
[1054]202
203/**
204 * Run the command @p x and log it if it fails.
205 */
[1144]206#define paranoid_system(x) {if(system(x)) mr_msg(4, x); }
[1054]207
208/**
209 * Free variables and call finish(@p x).
210 */
[1166]211#define paranoid_MR_finish(x) {free_MR_global_filenames (); if (bkpinfo) mr_free (bkpinfo); finish(x); }
[1054]212
213/**
214 * Log file, function, line, and @p x.
215 */
[1559]216#define iamhere(x) {mr_msg(2, x);}
[1054]217
218/**
219 * Yes, we want malloc() to help us fix bugs.
220 */
221#define MALLOC_CHECK_ 1
222
223/**
224 * Malloc @p x to be MAX_STR_LEN bytes and call fatal_error() if we're out of memory.
225 */
[1080]226#define malloc_string(x) { x = (char *)mr_malloc(MAX_STR_LEN); x[0] = x[1] = '\0'; }
[1054]227
228/**
229 * Path to the location the hard drive is mounted on during a restore.
230 */
231#define MNT_RESTORING "/mnt/RESTORING"
232
233/** @def VANILLA_SCSI_TAPE  The SCSI tape radical on the system (most likely to be the one towrite to. */
234/** @def DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE A string whose presence in a device name indicates the
235 * inability to check this device for errors in the mountlist. */
236/** @def RAID_DEVICE_STUB The stub of a RAID device (set up RAID if we find it). */
237/** @def SANE_FORMATS Sane formats for this OS, separated by spaces. */
238/** @def ALT_TAPE The first IDE tape in the system. */
239/** @def MKE2FS_OR_NEWFS @c mke2fs or @c newfs, depending on the OS. */
240/** @def CP_BIN The GNU @c cp binary to use. */
241#ifdef __FreeBSD__
242#define VANILLA_SCSI_TAPE   "/dev/sa"
243#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE  "/dev/vinum/"
244#define RAID_DEVICE_STUB    DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
245#define SANE_FORMATS        "swap image msdosfs nfs ntfs raid lvm ffs ufs ext2fs"
246#define ALT_TAPE        "/dev/ast"
247#define MKE2FS_OR_NEWFS "newfs"
248#define CP_BIN      "gcp"
249#else
[1574]250#define VANILLA_SCSI_TAPE   "/dev/st0"
[1054]251#define DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE  "/dev/md"
252#define RAID_DEVICE_STUB    DONT_KNOW_HOW_TO_EVALUATE_THIS_DEVICE_TYPE
253#define SANE_FORMATS        "swap image vfat ext2 ext3 xfs vfs jfs reiserfs dos minix coda nfs ntfs hpfs raid lvm cifs"
[1574]254#define ALT_TAPE        "/dev/ht0"
[1054]255#define MKE2FS_OR_NEWFS "mke2fs"
256#define CP_BIN      "cp"
257#endif
258
259
260/**
261 * The template for a filelist filename.
262 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
263 */
264#define FILELIST_FNAME_RAW_SZ "%s/filelist.%ld"
265
266#define XATTR_LIST_FNAME_RAW_SZ      "%s/xattr_list.%ld.gz"
267#define XATTR_BIGGLST_FNAME_RAW_SZ   "%s/xattr_list.big.gz"
268#define ACL_LIST_FNAME_RAW_SZ        "%s/acl_list.%ld.gz"
269#define ACL_BIGGLST_FNAME_RAW_SZ     "%s/acl_list.big.gz"
270
271/**
272 * The template for an afioball filename.
273 * The first argument (%s) is the tempdir and the second (%d) is the filelist number.
274 */
275#define AFIOBALL_FNAME_RAW_SZ (bkpinfo->use_star)?"%s/tmpfs/%ld.star.%s":"%s/tmpfs/%ld.afio.%s"
276#define ARCH_THREADS 2          ///< The number of simultaneous threads running afio in the background.
277#define ARCH_BUFFER_NUM (ARCH_THREADS*4)    // Number of permissible queued afio files
278#define PPCFG_RAMDISK_SIZE 350  ///< Size of the tmpfs, in megabytes, to attempt to mount (to speed up Mondo).
279
280/**
[1144]281 * Shorter log command
[1054]282 */
[1144]283#define log_it(format, args...) mr_msg(2, format, ## args)
[1054]284
285#define SZ_NTFSPROG_VOLSIZE "1048576"   // was 4096
286#define NTFSPROG_PARAMS "-z0 -V" SZ_NTFSPROG_VOLSIZE " -o -b -d -g1"
287
288#define MNT_CDROM "/mnt/cdrom"
289
290#endif                          /* _MY_STUFF_H_ */
Note: See TracBrowser for help on using the repository browser.