2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
30 * Kern Sibbald, January MM
36 struct RES_ITEM; /* Declare forward referenced structure */
37 class RES; /* Declare forware referenced structure */
38 typedef void (MSG_RES_HANDLER)(LEX *lc, RES_ITEM *item, int index, int pass);
42 /* This is the structure that defines
43 * the record types (items) permitted within each
44 * resource. It is used to define the configuration
48 const char *name; /* Resource name i.e. Director, ... */
49 MSG_RES_HANDLER *handler; /* Routine storing the resource item */
51 char **value; /* Where to store the item */
62 int32_t code; /* item code/additional info */
63 uint32_t flags; /* flags: default, required, ... */
64 int32_t default_value; /* default value */
67 /* For storing name_addr items in res_items table */
68 #define ITEM(x) {(char **)&res_all.x}
70 #define MAX_RES_ITEMS 80 /* maximum resource items per RES */
72 /* This is the universal header that is
73 * at the beginning of every resource
78 RES *next; /* pointer to next resource of this type */
79 char *name; /* resource name */
80 char *desc; /* resource description */
81 uint32_t rcode; /* resource id or type */
82 int32_t refcnt; /* reference count for releasing */
83 char item_present[MAX_RES_ITEMS]; /* set if item is present in conf file */
88 * Master Resource configuration structure definition
89 * This is the structure that defines the
90 * resources that are available to this daemon.
93 const char *name; /* resource name */
94 RES_ITEM *items; /* list of resource keywords */
95 uint32_t rcode; /* code if needed */
100 /* Common Resource definitions */
102 #define MAX_RES_NAME_LENGTH MAX_NAME_LENGTH-1 /* maximum resource name length */
104 #define ITEM_REQUIRED 0x1 /* item required */
105 #define ITEM_DEFAULT 0x2 /* default supplied */
106 #define ITEM_NO_EQUALS 0x4 /* Don't scan = after name */
108 /* Message Resource */
112 char *mail_cmd; /* mail command */
113 char *operator_cmd; /* Operator command */
114 DEST *dest_chain; /* chain of destinations */
115 char send_msg[nbytes_for_bits(M_MAX+1)]; /* bit array of types */
121 inline char *MSGS::name() const { return hdr.name; }
124 * Old C style configuration routines -- deprecated do not use.
126 //int parse_config(const char *cf, LEX_ERROR_HANDLER *scan_error = NULL, int err_type=M_ERROR_TERM);
127 void free_config_resources(void);
128 RES **save_config_resources(void);
129 RES **new_res_head();
132 * New C++ configuration routines
137 const char *m_cf; /* config file */
138 LEX_ERROR_HANDLER *m_scan_error; /* error handler if non-null */
139 int32_t m_err_type; /* the way to terminate on failure */
140 void *m_res_all; /* pointer to res_all buffer */
141 int32_t m_res_all_size; /* length of buffer */
143 /* The below are not yet implemented */
144 int32_t m_r_first; /* first daemon resource type */
145 int32_t m_r_last; /* last daemon resource type */
146 RES_TABLE *m_resources; /* pointer to table of permitted resources */
147 RES **m_res_head; /* pointer to defined resources */
148 brwlock_t m_res_lock; /* resource lock */
153 LEX_ERROR_HANDLER *scan_error,
156 int32_t res_all_size,
159 RES_TABLE *resources,
163 void free_resources();
164 RES **save_resources();
165 RES **new_res_head();
168 CONFIG *new_config_parser();
171 /* Resource routines */
172 RES *GetResWithName(int rcode, const char *name);
173 RES *GetNextRes(int rcode, RES *res);
174 void b_LockRes(const char *file, int line);
175 void b_UnlockRes(const char *file, int line);
176 void dump_resource(int type, RES *res, void sendmsg(void *sock, const char *fmt, ...), void *sock);
177 void free_resource(RES *res, int type);
178 void init_resource(int type, RES_ITEM *item);
179 void save_resource(int type, RES_ITEM *item, int pass);
180 const char *res_to_str(int rcode);
182 /* Loop through each resource of type, returning in var */
184 #define foreach_res(var, type) \
185 for((var)=NULL; ((var)=(typeof(var))GetNextRes((type), (RES *)var));)
187 #define foreach_res(var, type) \
188 for(var=NULL; (*((void **)&(var))=(void *)GetNextRes((type), (RES *)var));)
193 * Standard global parsers defined in parse_config.c
195 void store_str(LEX *lc, RES_ITEM *item, int index, int pass);
196 void store_dir(LEX *lc, RES_ITEM *item, int index, int pass);
197 void store_password(LEX *lc, RES_ITEM *item, int index, int pass);
198 void store_name(LEX *lc, RES_ITEM *item, int index, int pass);
199 void store_strname(LEX *lc, RES_ITEM *item, int index, int pass);
200 void store_res(LEX *lc, RES_ITEM *item, int index, int pass);
201 void store_alist_res(LEX *lc, RES_ITEM *item, int index, int pass);
202 void store_alist_str(LEX *lc, RES_ITEM *item, int index, int pass);
203 void store_int32(LEX *lc, RES_ITEM *item, int index, int pass);
204 void store_pint32(LEX *lc, RES_ITEM *item, int index, int pass);
205 void store_msgs(LEX *lc, RES_ITEM *item, int index, int pass);
206 void store_int64(LEX *lc, RES_ITEM *item, int index, int pass);
207 void store_bit(LEX *lc, RES_ITEM *item, int index, int pass);
208 void store_bool(LEX *lc, RES_ITEM *item, int index, int pass);
209 void store_time(LEX *lc, RES_ITEM *item, int index, int pass);
210 void store_size(LEX *lc, RES_ITEM *item, int index, int pass);
211 void store_defs(LEX *lc, RES_ITEM *item, int index, int pass);
212 void store_label(LEX *lc, RES_ITEM *item, int index, int pass);
214 /* ***FIXME*** eliminate these globals */
215 extern int32_t r_first;
216 extern int32_t r_last;
217 extern RES_TABLE resources[];
218 extern RES **res_head;
219 extern int32_t res_all_size;