2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2010 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.
29 * Bacula Catalog Database routines specific to MySQL
30 * These are MySQL specific routines -- hopefully all
31 * other files are generic.
33 * Kern Sibbald, March 2000
38 /* The following is necessary so that we do not include
39 * the dummy external definition of DB.
41 #define __SQL_C /* indicate that this is sql.c */
48 /* -----------------------------------------------------------------------
50 * MySQL dependent defines and subroutines
52 * -----------------------------------------------------------------------
55 /* List of open databases */
56 static dlist *db_list = NULL;
58 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
61 * Retrieve database type
70 * Initialize database data structure. In principal this should
71 * never have errors, or it is really fatal.
74 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
75 const char *db_address, int db_port, const char *db_socket,
76 int mult_db_connections)
81 Jmsg(jcr, M_FATAL, 0, _("A user name for MySQL must be supplied.\n"));
84 P(mutex); /* lock DB queue */
85 if (db_list == NULL) {
86 db_list = New(dlist(mdb, &mdb->link));
88 /* Look to see if DB already open */
89 if (!mult_db_connections) {
90 foreach_dlist(mdb, db_list) {
91 if (bstrcmp(mdb->db_name, db_name) &&
92 bstrcmp(mdb->db_address, db_address) &&
93 mdb->db_port == db_port) {
94 Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
97 Dmsg3(100, "initdb ref=%d connected=%d db=%p\n", mdb->ref_count,
98 mdb->connected, mdb->db);
99 return mdb; /* already open */
103 db_check_backend_thread_safe();
104 Dmsg0(100, "db_open first time\n");
105 mdb = (B_DB *)malloc(sizeof(B_DB));
106 memset(mdb, 0, sizeof(B_DB));
107 mdb->db_name = bstrdup(db_name);
108 mdb->db_user = bstrdup(db_user);
110 mdb->db_password = bstrdup(db_password);
113 mdb->db_address = bstrdup(db_address);
116 mdb->db_socket = bstrdup(db_socket);
118 mdb->db_port = db_port;
119 mdb->have_insert_id = true;
120 mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
122 mdb->cmd = get_pool_memory(PM_EMSG); /* get command buffer */
123 mdb->cached_path = get_pool_memory(PM_FNAME);
124 mdb->cached_path_id = 0;
126 mdb->fname = get_pool_memory(PM_FNAME);
127 mdb->path = get_pool_memory(PM_FNAME);
128 mdb->esc_name = get_pool_memory(PM_FNAME);
129 mdb->esc_path = get_pool_memory(PM_FNAME);
130 mdb->allow_transactions = mult_db_connections;
131 db_list->append(mdb); /* put db in list */
132 Dmsg3(100, "initdb ref=%d connected=%d db=%p\n", mdb->ref_count,
133 mdb->connected, mdb->db);
139 * Now actually open the database. This can generate errors,
140 * which are returned in the errmsg
142 * DO NOT close the database or free(mdb) here !!!!
145 db_open_database(JCR *jcr, B_DB *mdb)
150 if (mdb->connected) {
155 if ((errstat=rwl_init(&mdb->lock)) != 0) {
157 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
158 be.bstrerror(errstat));
163 /* connect to the database */
164 #ifdef xHAVE_EMBEDDED_MYSQL
165 // mysql_server_init(0, NULL, NULL);
167 mysql_init(&mdb->mysql);
169 Dmsg0(50, "mysql_init done\n");
170 /* If connection fails, try at 5 sec intervals for 30 seconds. */
171 for (int retry=0; retry < 6; retry++) {
172 mdb->db = mysql_real_connect(
173 &(mdb->mysql), /* db */
174 mdb->db_address, /* default = localhost */
175 mdb->db_user, /* login name */
176 mdb->db_password, /* password */
177 mdb->db_name, /* database name */
178 mdb->db_port, /* default port */
179 mdb->db_socket, /* default = socket */
180 CLIENT_FOUND_ROWS); /* flags */
182 /* If no connect, try once more in case it is a timing problem */
183 if (mdb->db != NULL) {
189 mdb->mysql.reconnect = 1; /* so connection does not timeout */
190 Dmsg0(50, "mysql_real_connect done\n");
191 Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
192 mdb->db_password==NULL?"(NULL)":mdb->db_password);
194 if (mdb->db == NULL) {
195 Mmsg2(&mdb->errmsg, _("Unable to connect to MySQL server.\n"
196 "Database=%s User=%s\n"
197 "MySQL connect failed either server not running or your authorization is incorrect.\n"),
198 mdb->db_name, mdb->db_user);
199 #if MYSQL_VERSION_ID >= 40101
200 Dmsg3(50, "Error %u (%s): %s\n",
201 mysql_errno(&(mdb->mysql)), mysql_sqlstate(&(mdb->mysql)),
202 mysql_error(&(mdb->mysql)));
204 Dmsg2(50, "Error %u: %s\n",
205 mysql_errno(&(mdb->mysql)), mysql_error(&(mdb->mysql)));
211 mdb->connected = true;
212 if (!check_tables_version(jcr, mdb)) {
217 Dmsg3(100, "opendb ref=%d connected=%d db=%p\n", mdb->ref_count,
218 mdb->connected, mdb->db);
220 /* Set connection timeout to 8 days specialy for batch mode */
221 sql_query(mdb, "SET wait_timeout=691200");
222 sql_query(mdb, "SET interactive_timeout=691200");
229 db_close_database(JCR *jcr, B_DB *mdb)
234 db_end_transaction(jcr, mdb);
236 sql_free_result(mdb);
238 Dmsg3(100, "closedb ref=%d connected=%d db=%p\n", mdb->ref_count,
239 mdb->connected, mdb->db);
240 if (mdb->ref_count == 0) {
241 db_list->remove(mdb);
242 if (mdb->connected) {
243 Dmsg1(100, "close db=%p\n", mdb->db);
244 mysql_close(&mdb->mysql);
246 #ifdef xHAVE_EMBEDDED_MYSQL
247 // mysql_server_end();
250 rwl_destroy(&mdb->lock);
251 free_pool_memory(mdb->errmsg);
252 free_pool_memory(mdb->cmd);
253 free_pool_memory(mdb->cached_path);
254 free_pool_memory(mdb->fname);
255 free_pool_memory(mdb->path);
256 free_pool_memory(mdb->esc_name);
257 free_pool_memory(mdb->esc_path);
264 if (mdb->db_password) {
265 free(mdb->db_password);
267 if (mdb->db_address) {
268 free(mdb->db_address);
270 if (mdb->db_socket) {
271 free(mdb->db_socket);
274 if (db_list->size() == 0) {
282 void db_check_backend_thread_safe()
284 #ifdef HAVE_BATCH_FILE_INSERT
285 if (!mysql_thread_safe()) {
286 Emsg0(M_ABORT, 0, _("MySQL client library must be thread-safe "
287 "when using BatchMode.\n"));
293 * This call is needed because the message channel thread
294 * opens a database on behalf of a jcr that was created in
295 * a different thread. MySQL then allocates thread specific
296 * data, which is NOT freed when the original jcr thread
297 * closes the database. Thus the msgchan must call here
298 * to cleanup any thread specific data that it created.
300 void db_thread_cleanup()
308 * Return the next unique index (auto-increment) for
309 * the given table. Return NULL on error.
311 * For MySQL, NULL causes the auto-increment value
314 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
316 strcpy(index, "NULL");
322 * Escape strings so that MySQL is happy
324 * NOTE! len is the length of the old string. Your new
325 * string must be long enough (max 2*old+1) to hold
326 * the escaped output.
329 db_escape_string(JCR *jcr, B_DB *mdb, char *snew, char *old, int len)
331 mysql_real_escape_string(mdb->db, snew, old, len);
335 * Submit a general SQL command (cmd), and for each row returned,
336 * the sqlite_handler is called with the ctx.
338 bool db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
344 if (sql_query(mdb, query) != 0) {
345 Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
349 if (result_handler != NULL) {
350 if ((mdb->result = sql_use_result(mdb)) != NULL) {
351 int num_fields = sql_num_fields(mdb);
353 /* We *must* fetch all rows */
354 while ((row = sql_fetch_row(mdb)) != NULL) {
356 /* the result handler returns 1 when it has
357 * seen all the data it wants. However, we
358 * loop to the end of the data.
360 if (result_handler(ctx, num_fields, row)) {
366 sql_free_result(mdb);
374 void my_mysql_free_result(B_DB *mdb)
378 mysql_free_result(mdb->result);
384 #ifdef HAVE_BATCH_FILE_INSERT
385 const char *my_mysql_batch_lock_path_query =
386 "LOCK TABLES Path write, batch write, Path as p write";
389 const char *my_mysql_batch_lock_filename_query =
390 "LOCK TABLES Filename write, batch write, Filename as f write";
392 const char *my_mysql_batch_unlock_tables_query = "UNLOCK TABLES";
394 const char *my_mysql_batch_fill_path_query =
395 "INSERT INTO Path (Path) "
396 "SELECT a.Path FROM "
397 "(SELECT DISTINCT Path FROM batch) AS a WHERE NOT EXISTS "
398 "(SELECT Path FROM Path AS p WHERE p.Path = a.Path)";
400 const char *my_mysql_batch_fill_filename_query =
401 "INSERT INTO Filename (Name) "
402 "SELECT a.Name FROM "
403 "(SELECT DISTINCT Name FROM batch) AS a WHERE NOT EXISTS "
404 "(SELECT Name FROM Filename AS f WHERE f.Name = a.Name)";
405 #endif /* HAVE_BATCH_FILE_INSERT */
407 #endif /* HAVE_MYSQL */