git.sur5r.net Git - bacula/bacula/blob - bacula/src/cats/cats.h

   1 /*
   2  * SQL header file
   3  *
   4  *   by Kern E. Sibbald
   5  *
   6  *   Anyone who accesses the database will need to include
   7  *   this file.
   8  *
   9  * This file contains definitions common to sql.c and
  10  * the external world, and definitions destined only
  11  * for the external world. This is control with
  12  * the define __SQL_C, which is defined only in sql.c
  13  *
  14  *    Version $Id$
  15  */
  16 /*
  17    Copyright (C) 2000-2006 Kern Sibbald
  18
  19    This program is free software; you can redistribute it and/or
  20    modify it under the terms of the GNU General Public License
  21    version 2 as amended with additional clauses defined in the
  22    file LICENSE in the main source directory.
  23
  24    This program is distributed in the hope that it will be useful,
  25    but WITHOUT ANY WARRANTY; without even the implied warranty of
  26    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  27    the file LICENSE for additional details.
  28
  29  */
  30
  31 /*
  32    Here is how database versions work.
  33
  34    While I am working on a new release with database changes, the
  35    update scripts are in the src/cats directory under the names
  36    update_xxx_tables.in.  Most of the time, I make database updates
  37    in one go and immediately update the version, but not always.  If
  38    there are going to be several updates as is the case with version
  39    1.37, then I will often forgo changing the version until the last
  40    update otherwise I will end up with too many versions and a lot
  41    of confusion.
  42
  43    When I am pretty sure there will be no more updates, I will
  44    change the version from 8 to 9 (in the present case), and when I
  45    am 100% sure there will be no more changes, the update script
  46    will be copied to the updatedb directory with the correct name
  47    (in the present case 8 to 9).
  48
  49    Now, in principle, each of the different DB implementations
  50    can have a different version, but in practice they are all
  51    the same (simplifies things). The exception is the internal
  52    database, which is no longer used, and hence, no longer changes.
  53  */
  54
  55
  56 #ifndef __SQL_H_
  57 #define __SQL_H_ 1
  58
  59
  60 typedef void (DB_LIST_HANDLER)(void *, const char *);
  61 typedef int (DB_RESULT_HANDLER)(void *, int, char **);
  62
  63 #define db_lock(mdb)   _db_lock(__FILE__, __LINE__, mdb)
  64 #define db_unlock(mdb) _db_unlock(__FILE__, __LINE__, mdb)
  65
  66 #ifdef __SQL_C
  67
  68 #ifdef HAVE_SQLITE
  69
  70 #define BDB_VERSION 10
  71
  72 #include <sqlite.h>
  73
  74 /* Define opaque structure for sqlite */
  75 struct sqlite {
  76    char dummy;
  77 };
  78
  79 #define IS_NUM(x)             ((x) == 1)
  80 #define IS_NOT_NULL(x)        ((x) == 1)
  81
  82 typedef struct s_sql_field {
  83    char *name;                        /* name of column */
  84    int length;                        /* length */
  85    int max_length;                    /* max length */
  86    uint32_t type;                     /* type */
  87    uint32_t flags;                    /* flags */
  88 } SQL_FIELD;
  89
  90 /*
  91  * This is the "real" definition that should only be
  92  * used inside sql.c and associated database interface
  93  * subroutines.
  94  *                    S Q L I T E
  95  */
  96 struct B_DB {
  97    BQUEUE bq;                         /* queue control */
  98    brwlock_t lock;                    /* transaction lock */
  99    struct sqlite *db;
 100    char **result;
 101    int status;
 102    int nrow;                          /* nrow returned from sqlite */
 103    int ncolumn;                       /* ncolum returned from sqlite */
 104    int num_rows;                      /* used by code */
 105    int row;                           /* seek row */
 106    int field;                         /* seek field */
 107    SQL_FIELD **fields;                /* defined fields */
 108    int ref_count;
 109    char *db_name;
 110    char *db_user;
 111    char *db_address;                  /* host name address */
 112    char *db_socket;                   /* socket for local access */
 113    char *db_password;
 114    int  db_port;                      /* port for host name address */
 115    bool connected;                    /* connection made to db */
 116    bool have_insert_id;               /* do not have insert id */
 117    bool fields_defined;               /* set when fields defined */
 118    char *sqlite_errmsg;               /* error message returned by sqlite */
 119    POOLMEM *errmsg;                   /* nicely edited error message */
 120    POOLMEM *cmd;                      /* SQL command string */
 121    POOLMEM *cached_path;              /* cached path name */
 122    int cached_path_len;               /* length of cached path */
 123    uint32_t cached_path_id;           /* cached path id */
 124    bool allow_transactions;           /* transactions allowed */
 125    bool transaction;                  /* transaction started */
 126    int changes;                       /* changes during transaction */
 127    POOLMEM *fname;                    /* Filename only */
 128    POOLMEM *path;                     /* Path only */
 129    POOLMEM *esc_name;                 /* Escaped file/path name */
 130    int fnl;                           /* file name length */
 131    int pnl;                           /* path name length */
 132 };
 133
 134
 135 /*
 136  * "Generic" names for easier conversion
 137  *
 138  *                    S Q L I T E
 139  */
 140 #define sql_store_result(x)   (x)->result
 141 #define sql_free_result(x)    my_sqlite_free_table(x)
 142 #define sql_fetch_row(x)      my_sqlite_fetch_row(x)
 143 #define sql_query(x, y)       my_sqlite_query((x), (y))
 144 #ifdef HAVE_SQLITE3
 145 #define sql_insert_id(x,y)    sqlite3_last_insert_rowid((x)->db)
 146 #define sql_close(x)          sqlite3_close((x)->db)
 147 #else
 148 #define sql_insert_id(x,y)    sqlite_last_insert_rowid((x)->db)
 149 #define sql_close(x)          sqlite_close((x)->db)
 150 #endif
 151 #define sql_strerror(x)       (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
 152 #define sql_num_rows(x)       (x)->nrow
 153 #define sql_data_seek(x, i)   (x)->row = (i)
 154 #define sql_affected_rows(x)  1
 155 #define sql_field_seek(x, y)  my_sqlite_field_seek((x), (y))
 156 #define sql_fetch_field(x)    my_sqlite_fetch_field(x)
 157 #define sql_num_fields(x)     ((x)->ncolumn)
 158 #define SQL_ROW               char**
 159
 160
 161
 162 /* In cats/sqlite.c */
 163 void       my_sqlite_free_table(B_DB *mdb);
 164 SQL_ROW    my_sqlite_fetch_row(B_DB *mdb);
 165 int        my_sqlite_query(B_DB *mdb, char *cmd);
 166 void       my_sqlite_field_seek(B_DB *mdb, int field);
 167 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
 168
 169
 170 #else
 171
 172 /*                    S Q L I T E 3            */
 173
 174
 175 #ifdef HAVE_SQLITE3
 176
 177
 178 #define BDB_VERSION 10
 179
 180 #include <sqlite3.h>
 181
 182 /* Define opaque structure for sqlite */
 183 struct sqlite3 {
 184    char dummy;
 185 };
 186
 187 #define IS_NUM(x)             ((x) == 1)
 188 #define IS_NOT_NULL(x)        ((x) == 1)
 189
 190 typedef struct s_sql_field {
 191    char *name;                        /* name of column */
 192    int length;                        /* length */
 193    int max_length;                    /* max length */
 194    uint32_t type;                     /* type */
 195    uint32_t flags;                    /* flags */
 196 } SQL_FIELD;
 197
 198 /*
 199  * This is the "real" definition that should only be
 200  * used inside sql.c and associated database interface
 201  * subroutines.
 202  *                    S Q L I T E
 203  */
 204 struct B_DB {
 205    BQUEUE bq;                         /* queue control */
 206    brwlock_t lock;                    /* transaction lock */
 207    struct sqlite3 *db;
 208    char **result;
 209    int status;
 210    int nrow;                          /* nrow returned from sqlite */
 211    int ncolumn;                       /* ncolum returned from sqlite */
 212    int num_rows;                      /* used by code */
 213    int row;                           /* seek row */
 214    int field;                         /* seek field */
 215    SQL_FIELD **fields;                /* defined fields */
 216    int ref_count;
 217    char *db_name;
 218    char *db_user;
 219    char *db_address;                  /* host name address */
 220    char *db_socket;                   /* socket for local access */
 221    char *db_password;
 222    int  db_port;                      /* port for host name address */
 223    bool connected;                    /* connection made to db */
 224    bool have_insert_id;               /* do not have insert id */
 225    bool fields_defined;               /* set when fields defined */
 226    char *sqlite_errmsg;               /* error message returned by sqlite */
 227    POOLMEM *errmsg;                   /* nicely edited error message */
 228    POOLMEM *cmd;                      /* SQL command string */
 229    POOLMEM *cached_path;              /* cached path name */
 230    int cached_path_len;               /* length of cached path */
 231    uint32_t cached_path_id;           /* cached path id */
 232    bool allow_transactions;           /* transactions allowed */
 233    bool transaction;                  /* transaction started */
 234    int changes;                       /* changes during transaction */
 235    POOLMEM *fname;                    /* Filename only */
 236    POOLMEM *path;                     /* Path only */
 237    POOLMEM *esc_name;                 /* Escaped file/path name */
 238    int fnl;                           /* file name length */
 239    int pnl;                           /* path name length */
 240 };
 241
 242 /*
 243  * Conversion of sqlite 2 names to sqlite3
 244  */
 245 #define sqlite_last_insert_rowid sqlite3_last_insert_rowid
 246 #define sqlite_open sqlite3_open
 247 #define sqlite_close sqlite3_close
 248 #define sqlite_result sqlite3_result
 249 #define sqlite_exec sqlite3_exec
 250 #define sqlite_get_table sqlite3_get_table
 251 #define sqlite_free_table sqlite3_free_table
 252
 253
 254 /*
 255  * "Generic" names for easier conversion
 256  *
 257  *                    S Q L I T E 3
 258  */
 259 #define sql_store_result(x)   (x)->result
 260 #define sql_free_result(x)    my_sqlite_free_table(x)
 261 #define sql_fetch_row(x)      my_sqlite_fetch_row(x)
 262 #define sql_query(x, y)       my_sqlite_query((x), (y))
 263 #ifdef HAVE_SQLITE3
 264 #define sql_insert_id(x,y)    sqlite3_last_insert_rowid((x)->db)
 265 #define sql_close(x)          sqlite3_close((x)->db)
 266 #else
 267 #define sql_insert_id(x,y)    sqlite_last_insert_rowid((x)->db)
 268 #define sql_close(x)          sqlite_close((x)->db)
 269 #endif
 270 #define sql_strerror(x)       (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
 271 #define sql_num_rows(x)       (x)->nrow
 272 #define sql_data_seek(x, i)   (x)->row = (i)
 273 #define sql_affected_rows(x)  1
 274 #define sql_field_seek(x, y)  my_sqlite_field_seek((x), (y))
 275 #define sql_fetch_field(x)    my_sqlite_fetch_field(x)
 276 #define sql_num_fields(x)     ((x)->ncolumn)
 277 #define SQL_ROW               char**
 278
 279
 280
 281 /* In cats/sqlite.c */
 282 void       my_sqlite_free_table(B_DB *mdb);
 283 SQL_ROW    my_sqlite_fetch_row(B_DB *mdb);
 284 int        my_sqlite_query(B_DB *mdb, char *cmd);
 285 void       my_sqlite_field_seek(B_DB *mdb, int field);
 286 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
 287
 288
 289 #else
 290
 291 #ifdef HAVE_MYSQL
 292
 293 #define BDB_VERSION 10
 294
 295 #include <mysql.h>
 296
 297 /*
 298  * This is the "real" definition that should only be
 299  * used inside sql.c and associated database interface
 300  * subroutines.
 301  *
 302  *                     M Y S Q L
 303  */
 304 struct B_DB {
 305    BQUEUE bq;                         /* queue control */
 306    brwlock_t lock;                    /* transaction lock */
 307    MYSQL mysql;
 308    MYSQL *db;
 309    MYSQL_RES *result;
 310    int status;
 311    my_ulonglong num_rows;
 312    int ref_count;
 313    char *db_name;
 314    char *db_user;
 315    char *db_password;
 316    char *db_address;                  /* host address */
 317    char *db_socket;                   /* socket for local access */
 318    int db_port;                       /* port of host address */
 319    int have_insert_id;                /* do have insert_id() */
 320    bool connected;
 321    POOLMEM *errmsg;                   /* nicely edited error message */
 322    POOLMEM *cmd;                      /* SQL command string */
 323    POOLMEM *cached_path;
 324    int cached_path_len;               /* length of cached path */
 325    uint32_t cached_path_id;
 326    int changes;                       /* changes made to db */
 327    POOLMEM *fname;                    /* Filename only */
 328    POOLMEM *path;                     /* Path only */
 329    POOLMEM *esc_name;                 /* Escaped file/path name */
 330    int fnl;                           /* file name length */
 331    int pnl;                           /* path name length */
 332 };
 333
 334 #define DB_STATUS int
 335
 336 /* "Generic" names for easier conversion */
 337 #define sql_store_result(x)   mysql_store_result((x)->db)
 338 #define sql_use_result(x)     mysql_use_result((x)->db)
 339 #define sql_free_result(x)    mysql_free_result((x)->result)
 340 #define sql_fetch_row(x)      mysql_fetch_row((x)->result)
 341 #define sql_query(x, y)       mysql_query((x)->db, (y))
 342 #define sql_close(x)          mysql_close((x)->db)
 343 #define sql_strerror(x)       mysql_error((x)->db)
 344 #define sql_num_rows(x)       mysql_num_rows((x)->result)
 345 #define sql_data_seek(x, i)   mysql_data_seek((x)->result, (i))
 346 #define sql_affected_rows(x)  mysql_affected_rows((x)->db)
 347 #define sql_insert_id(x,y)    mysql_insert_id((x)->db)
 348 #define sql_field_seek(x, y)  mysql_field_seek((x)->result, (y))
 349 #define sql_fetch_field(x)    mysql_fetch_field((x)->result)
 350 #define sql_num_fields(x)     (int)mysql_num_fields((x)->result)
 351 #define SQL_ROW               MYSQL_ROW
 352 #define SQL_FIELD             MYSQL_FIELD
 353
 354 #else
 355
 356 #ifdef HAVE_POSTGRESQL
 357
 358 #define BDB_VERSION 10
 359
 360 #include <libpq-fe.h>
 361
 362 /* TEMP: the following is taken from select OID, typname from pg_type; */
 363 #define IS_NUM(x)        ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
 364 #define IS_NOT_NULL(x)   ((x) == 1)
 365
 366 typedef char **POSTGRESQL_ROW;
 367 typedef struct pg_field {
 368    char         *name;
 369    int           max_length;
 370    unsigned int  type;
 371    unsigned int  flags;       // 1 == not null
 372 } POSTGRESQL_FIELD;
 373
 374
 375 /*
 376  * This is the "real" definition that should only be
 377  * used inside sql.c and associated database interface
 378  * subroutines.
 379  *
 380  *                     P O S T G R E S Q L
 381  */
 382 struct B_DB {
 383    BQUEUE bq;                         /* queue control */
 384    brwlock_t lock;                    /* transaction lock */
 385    PGconn *db;
 386    PGresult *result;
 387    int status;
 388    POSTGRESQL_ROW row;
 389    POSTGRESQL_FIELD *fields;
 390    int num_rows;
 391    int num_fields;
 392    int row_number;            /* what row number did we get via my_postgresql_data_seek? */
 393    int field_number;          /* what field number did we get via my_postgresql_field_seek? */
 394    int ref_count;
 395    char *db_name;
 396    char *db_user;
 397    char *db_password;
 398    char *db_address;              /* host address */
 399    char *db_socket;               /* socket for local access */
 400    int db_port;                   /* port of host address */
 401    int have_insert_id;            /* do have insert_id() */
 402    bool connected;
 403    POOLMEM *errmsg;               /* nicely edited error message */
 404    POOLMEM *cmd;                  /* SQL command string */
 405    POOLMEM *cached_path;
 406    int cached_path_len;           /* length of cached path */
 407    uint32_t cached_path_id;
 408    bool allow_transactions;       /* transactions allowed */
 409    bool transaction;              /* transaction started */
 410    int changes;                   /* changes made to db */
 411    POOLMEM *fname;                /* Filename only */
 412    POOLMEM *path;                 /* Path only */
 413    POOLMEM *esc_name;             /* Escaped file/path name */
 414    int fnl;                       /* file name length */
 415    int pnl;                       /* path name length */
 416 };
 417
 418 void               my_postgresql_free_result(B_DB *mdb);
 419 POSTGRESQL_ROW     my_postgresql_fetch_row  (B_DB *mdb);
 420 int                my_postgresql_query      (B_DB *mdb, const char *query);
 421 void               my_postgresql_data_seek  (B_DB *mdb, int row);
 422 int                my_postgresql_currval    (B_DB *mdb, char *table_name);
 423 void               my_postgresql_field_seek (B_DB *mdb, int row);
 424 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
 425
 426
 427 /* "Generic" names for easier conversion */
 428 #define sql_store_result(x)   ((x)->result)
 429 #define sql_free_result(x)    my_postgresql_free_result(x)
 430 #define sql_fetch_row(x)      my_postgresql_fetch_row(x)
 431 #define sql_query(x, y)       my_postgresql_query((x), (y))
 432 #define sql_close(x)          PQfinish((x)->db)
 433 #define sql_strerror(x)       PQresultErrorMessage((x)->result)
 434 #define sql_num_rows(x)       ((unsigned) PQntuples((x)->result))
 435 #define sql_data_seek(x, i)   my_postgresql_data_seek((x), (i))
 436 #define sql_affected_rows(x)  ((unsigned) atoi(PQcmdTuples((x)->result)))
 437 #define sql_insert_id(x,y)    my_postgresql_currval((x), (y))
 438 #define sql_field_seek(x, y)  my_postgresql_field_seek((x), (y))
 439 #define sql_fetch_field(x)    my_postgresql_fetch_field(x)
 440 #define sql_num_fields(x)     ((x)->num_fields)
 441 #define SQL_ROW               POSTGRESQL_ROW
 442 #define SQL_FIELD             POSTGRESQL_FIELD
 443
 444 #else  /* USE BACULA DB routines */
 445
 446 #define HAVE_BACULA_DB 1
 447
 448 /* Change this each time there is some incompatible
 449  * file format change!!!!
 450  */
 451 #define BDB_VERSION 13                /* file version number */
 452
 453 struct s_control {
 454    int bdb_version;                   /* Version number */
 455    uint32_t JobId;                    /* next Job Id */
 456    uint32_t PoolId;                   /* next Pool Id */
 457    uint32_t MediaId;                  /* next Media Id */
 458    uint32_t JobMediaId;               /* next JobMedia Id */
 459    uint32_t ClientId;                 /* next Client Id */
 460    uint32_t FileSetId;                /* nest FileSet Id */
 461    time_t time;                       /* time file written */
 462 };
 463
 464
 465 /* This is the REAL definition for using the
 466  *  Bacula internal DB
 467  */
 468 struct B_DB {
 469    BQUEUE bq;                         /* queue control */
 470 /* pthread_mutex_t mutex;  */         /* single thread lock */
 471    brwlock_t lock;                    /* transaction lock */
 472    int ref_count;                     /* number of times opened */
 473    struct s_control control;          /* control file structure */
 474    int cfd;                           /* control file device */
 475    FILE *jobfd;                       /* Jobs records file descriptor */
 476    FILE *poolfd;                      /* Pool records fd */
 477    FILE *mediafd;                     /* Media records fd */
 478    FILE *jobmediafd;                  /* JobMedia records fd */
 479    FILE *clientfd;                    /* Client records fd */
 480    FILE *filesetfd;                   /* FileSet records fd */
 481    char *db_name;                     /* name of database */
 482    POOLMEM *errmsg;                   /* nicely edited error message */
 483    POOLMEM *cmd;                      /* Command string */
 484    POOLMEM *cached_path;
 485    int cached_path_len;               /* length of cached path */
 486    uint32_t cached_path_id;
 487 };
 488
 489 #endif /* HAVE_SQLITE3 */
 490 #endif /* HAVE_MYSQL */
 491 #endif /* HAVE_SQLITE */
 492 #endif /* HAVE_POSTGRESQL */
 493
 494 /* Use for better error location printing */
 495 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
 496 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
 497 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
 498 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
 499
 500
 501 #else    /* not __SQL_C */
 502
 503 /* This is a "dummy" definition for use outside of sql.c
 504  */
 505 struct B_DB {
 506    int dummy;                         /* for SunOS compiler */
 507 };
 508
 509 #endif /*  __SQL_C */
 510
 511 extern uint32_t bacula_db_version;
 512
 513 /* ***FIXME*** FileId_t should *really* be uint64_t
 514  *  but at the current time, this breaks MySQL.
 515  */
 516 typedef uint32_t FileId_t;
 517 typedef uint32_t DBId_t;              /* general DB id type */
 518 typedef uint32_t JobId_t;
 519
 520 #define faddr_t long
 521
 522
 523 /* Job information passed to create job record and update
 524  * job record at end of job. Note, although this record
 525  * contains all the fields found in the Job database record,
 526  * it also contains fields found in the JobMedia record.
 527  */
 528 /* Job record */
 529 struct JOB_DBR {
 530    JobId_t JobId;
 531    char Job[MAX_NAME_LENGTH];         /* Job unique name */
 532    char Name[MAX_NAME_LENGTH];        /* Job base name */
 533    int JobType;                       /* actually char(1) */
 534    int JobLevel;                      /* actually char(1) */
 535    int JobStatus;                     /* actually char(1) */
 536    DBId_t ClientId;                   /* Id of client */
 537    DBId_t PoolId;                     /* Id of pool */
 538    DBId_t FileSetId;                  /* Id of FileSet */
 539    DBId_t PriorJobId;                 /* Id of migrated (prior) job */
 540    time_t SchedTime;                  /* Time job scheduled */
 541    time_t StartTime;                  /* Job start time */
 542    time_t EndTime;                    /* Job termination time of orig job */
 543    time_t RealEndTime;                /* Job termination time of this job */
 544    utime_t JobTDate;                  /* Backup time/date in seconds */
 545    uint32_t VolSessionId;
 546    uint32_t VolSessionTime;
 547    uint32_t JobFiles;
 548    uint32_t JobErrors;
 549    uint32_t JobMissingFiles;
 550    uint64_t JobBytes;
 551    int PurgedFiles;
 552    int HasBase;
 553
 554    /* Note, FirstIndex, LastIndex, Start/End File and Block
 555     * are only used in the JobMedia record.
 556     */
 557    uint32_t FirstIndex;               /* First index this Volume */
 558    uint32_t LastIndex;                /* Last index this Volume */
 559    uint32_t StartFile;
 560    uint32_t EndFile;
 561    uint32_t StartBlock;
 562    uint32_t EndBlock;
 563
 564    char cSchedTime[MAX_TIME_LENGTH];
 565    char cStartTime[MAX_TIME_LENGTH];
 566    char cEndTime[MAX_TIME_LENGTH];
 567    char cRealEndTime[MAX_TIME_LENGTH];
 568    /* Extra stuff not in DB */
 569    int limit;                         /* limit records to display */
 570    faddr_t rec_addr;
 571 };
 572
 573 /* Job Media information used to create the media records
 574  * for each Volume used for the job.
 575  */
 576 /* JobMedia record */
 577 struct JOBMEDIA_DBR {
 578    DBId_t JobMediaId;                 /* record id */
 579    JobId_t  JobId;                    /* JobId */
 580    DBId_t MediaId;                    /* MediaId */
 581    uint32_t FirstIndex;               /* First index this Volume */
 582    uint32_t LastIndex;                /* Last index this Volume */
 583    uint32_t StartFile;                /* File for start of data */
 584    uint32_t EndFile;                  /* End file on Volume */
 585    uint32_t StartBlock;               /* start block on tape */
 586    uint32_t EndBlock;                 /* last block */
 587    uint32_t Copy;                     /* identical copy */
 588 };
 589
 590
 591 /* Volume Parameter structure */
 592 struct VOL_PARAMS {
 593    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 594    char MediaType[MAX_NAME_LENGTH];   /* Media Type */
 595    char Storage[MAX_NAME_LENGTH];     /* Storage name */
 596    uint32_t VolIndex;                 /* Volume seqence no. */
 597    uint32_t FirstIndex;               /* First index this Volume */
 598    uint32_t LastIndex;                /* Last index this Volume */
 599    uint32_t StartFile;                /* File for start of data */
 600    uint32_t EndFile;                  /* End file on Volume */
 601    uint32_t StartBlock;               /* start block on tape */
 602    uint32_t EndBlock;                 /* last block */
 603    int32_t Slot;                      /* Slot */
 604 // uint32_t Copy;                     /* identical copy */
 605 // uint32_t Stripe;                   /* RAIT strip number */
 606 };
 607
 608
 609 /* Attributes record -- NOT same as in database because
 610  *  in general, this "record" creates multiple database
 611  *  records (e.g. pathname, filename, fileattributes).
 612  */
 613 struct ATTR_DBR {
 614    char *fname;                       /* full path & filename */
 615    char *link;                        /* link if any */
 616    char *attr;                        /* attributes statp */
 617    uint32_t FileIndex;
 618    uint32_t Stream;
 619    JobId_t  JobId;
 620    DBId_t ClientId;
 621    DBId_t PathId;
 622    DBId_t FilenameId;
 623    FileId_t FileId;
 624    char *Digest;
 625    int DigestType;
 626 };
 627
 628
 629 /* File record -- same format as database */
 630 struct FILE_DBR {
 631    FileId_t FileId;
 632    uint32_t FileIndex;
 633    JobId_t  JobId;
 634    DBId_t FilenameId;
 635    DBId_t PathId;
 636    JobId_t  MarkId;
 637    char LStat[256];
 638    char Digest[BASE64_SIZE(CRYPTO_DIGEST_MAX_SIZE)];
 639    int DigestType;                    /* NO_SIG/MD5_SIG/SHA1_SIG */
 640 };
 641
 642 /* Pool record -- same format as database */
 643 struct POOL_DBR {
 644    DBId_t PoolId;
 645    char Name[MAX_NAME_LENGTH];        /* Pool name */
 646    uint32_t NumVols;                  /* total number of volumes */
 647    uint32_t MaxVols;                  /* max allowed volumes */
 648    int32_t LabelType;                 /* Bacula/ANSI/IBM */
 649    int32_t UseOnce;                   /* set to use once only */
 650    int32_t UseCatalog;                /* set to use catalog */
 651    int32_t AcceptAnyVolume;           /* set to accept any volume sequence */
 652    int32_t AutoPrune;                 /* set to prune automatically */
 653    int32_t Recycle;                   /* default Vol recycle flag */
 654    utime_t  VolRetention;             /* retention period in seconds */
 655    utime_t  VolUseDuration;           /* time in secs volume can be used */
 656    uint32_t MaxVolJobs;               /* Max Jobs on Volume */
 657    uint32_t MaxVolFiles;              /* Max files on Volume */
 658    uint64_t MaxVolBytes;              /* Max bytes on Volume */
 659    char PoolType[MAX_NAME_LENGTH];
 660    char LabelFormat[MAX_NAME_LENGTH];
 661    /* Extra stuff not in DB */
 662    faddr_t rec_addr;
 663 };
 664
 665 class DEVICE_DBR {
 666 public:
 667    DBId_t DeviceId;
 668    char Name[MAX_NAME_LENGTH];        /* Device name */
 669    DBId_t MediaTypeId;                /* MediaType */
 670    DBId_t StorageId;                  /* Storage id if autochanger */
 671    uint32_t DevMounts;                /* Number of times mounted */
 672    uint32_t DevErrors;                /* Number of read/write errors */
 673    uint64_t DevReadBytes;             /* Number of bytes read */
 674    uint64_t DevWriteBytes;            /* Number of bytew written */
 675    uint64_t DevReadTime;              /* time spent reading volume */
 676    uint64_t DevWriteTime;             /* time spent writing volume */
 677    uint64_t DevReadTimeSincCleaning;  /* read time since cleaning */
 678    uint64_t DevWriteTimeSincCleaning; /* write time since cleaning */
 679    time_t   CleaningDate;             /* time last cleaned */
 680    utime_t  CleaningPeriod;           /* time between cleanings */
 681 };
 682
 683 class STORAGE_DBR {
 684 public:
 685    DBId_t StorageId;
 686    char Name[MAX_NAME_LENGTH];        /* Device name */
 687    int AutoChanger;                   /* Set if autochanger */
 688
 689    /* Not in database */
 690    bool created;                      /* set if created by db_create ... */
 691 };
 692
 693 class MEDIATYPE_DBR {
 694 public:
 695    DBId_t MediaTypeId;
 696    char MediaType[MAX_NAME_LENGTH];   /* MediaType string */
 697    int ReadOnly;                      /* Set if read-only */
 698 };
 699
 700
 701 /* Media record -- same as the database */
 702 struct MEDIA_DBR {
 703    DBId_t MediaId;                    /* Unique volume id */
 704    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 705    char MediaType[MAX_NAME_LENGTH];   /* Media type */
 706    DBId_t PoolId;                     /* Pool id */
 707    time_t   FirstWritten;             /* Time Volume first written this usage */
 708    time_t   LastWritten;              /* Time Volume last written */
 709    time_t   LabelDate;                /* Date/Time Volume labeled */
 710    time_t   InitialWrite;             /* Date/Time Volume first written */
 711    int32_t  LabelType;                /* Label (Bacula/ANSI/IBM) */
 712    uint32_t VolJobs;                  /* number of jobs on this medium */
 713    uint32_t VolFiles;                 /* Number of files */
 714    uint32_t VolBlocks;                /* Number of blocks */
 715    uint32_t VolMounts;                /* Number of times mounted */
 716    uint32_t VolErrors;                /* Number of read/write errors */
 717    uint32_t VolWrites;                /* Number of writes */
 718    uint32_t VolReads;                 /* Number of reads */
 719    uint64_t VolBytes;                 /* Number of bytes written */
 720    uint32_t VolParts;                 /* Number of parts written */
 721    uint64_t MaxVolBytes;              /* Max bytes to write to Volume */
 722    uint64_t VolCapacityBytes;         /* capacity estimate */
 723    uint64_t VolReadTime;              /* time spent reading volume */
 724    uint64_t VolWriteTime;             /* time spent writing volume */
 725    utime_t  VolRetention;             /* Volume retention in seconds */
 726    utime_t  VolUseDuration;           /* time in secs volume can be used */
 727    uint32_t MaxVolJobs;               /* Max Jobs on Volume */
 728    uint32_t MaxVolFiles;              /* Max files on Volume */
 729    int32_t  Recycle;                  /* recycle yes/no */
 730    int32_t  Slot;                     /* slot in changer */
 731    int32_t  Enabled;                  /* 0=disabled, 1=enabled, 2=archived */
 732    int32_t  InChanger;                /* Volume currently in changer */
 733    DBId_t   StorageId;                /* Storage record Id */
 734    uint32_t EndFile;                  /* Last file on volume */
 735    uint32_t EndBlock;                 /* Last block on volume */
 736    uint32_t RecycleCount;             /* Number of times recycled */
 737    char     VolStatus[20];            /* Volume status */
 738    DBId_t   DeviceId;                 /* Device where Vol last written */
 739    DBId_t   LocationId;               /* Where Volume is -- user defined */
 740    DBId_t   ScratchPoolId;            /* Where to move if scratch */
 741    DBId_t   RecyclePoolId;            /* Where to move when recycled */
 742    /* Extra stuff not in DB */
 743    faddr_t rec_addr;                  /* found record address */
 744    /* Since the database returns times as strings, this is how we pass
 745     *   them back.
 746     */
 747    char    cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
 748    char    cLastWritten[MAX_TIME_LENGTH];  /* LastWritten returned from DB */
 749    char    cLabelDate[MAX_TIME_LENGTH];    /* LabelData returned from DB */
 750    char    cInitialWrite[MAX_TIME_LENGTH]; /* InitialWrite returned from DB */
 751    bool    set_first_written;
 752    bool    set_label_date;
 753 };
 754
 755 /* Client record -- same as the database */
 756 struct CLIENT_DBR {
 757    DBId_t ClientId;                   /* Unique Client id */
 758    int AutoPrune;
 759    utime_t FileRetention;
 760    utime_t JobRetention;
 761    char Name[MAX_NAME_LENGTH];        /* Client name */
 762    char Uname[256];                   /* Uname for client */
 763 };
 764
 765 /* Counter record as in database */
 766 struct COUNTER_DBR {
 767    char Counter[MAX_NAME_LENGTH];
 768    int32_t MinValue;
 769    int32_t MaxValue;
 770    int32_t CurrentValue;
 771    char WrapCounter[MAX_NAME_LENGTH];
 772 };
 773
 774
 775 /* FileSet record -- same as the database */
 776 struct FILESET_DBR {
 777    DBId_t FileSetId;                  /* Unique FileSet id */
 778    char FileSet[MAX_NAME_LENGTH];     /* FileSet name */
 779    char MD5[50];                      /* MD5 signature of include/exclude */
 780    time_t CreateTime;                 /* date created */
 781    /*
 782     * This is where we return CreateTime
 783     */
 784    char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
 785    /* Not in DB but returned by db_create_fileset() */
 786    bool created;                      /* set when record newly created */
 787 };
 788
 789
 790
 791 #include "protos.h"
 792 #include "jcr.h"
 793
 794 /*
 795  * Some functions exported by sql.c for use withing the
 796  *   cats directory.
 797  */
 798 void list_result(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type);
 799 void list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx);
 800 int get_sql_record_max(JCR *jcr, B_DB *mdb);
 801 int check_tables_version(JCR *jcr, B_DB *mdb);
 802 void _db_unlock(const char *file, int line, B_DB *mdb);
 803 void _db_lock(const char *file, int line, B_DB *mdb);
 804
 805 #endif /* __SQL_H_ */