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-2005 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 9
  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 9
 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 9
 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_free_result(x)    mysql_free_result((x)->result)
 339 #define sql_fetch_row(x)      mysql_fetch_row((x)->result)
 340 #define sql_query(x, y)       mysql_query((x)->db, (y))
 341 #define sql_close(x)          mysql_close((x)->db)
 342 #define sql_strerror(x)       mysql_error((x)->db)
 343 #define sql_num_rows(x)       mysql_num_rows((x)->result)
 344 #define sql_data_seek(x, i)   mysql_data_seek((x)->result, (i))
 345 #define sql_affected_rows(x)  mysql_affected_rows((x)->db)
 346 #define sql_insert_id(x,y)    mysql_insert_id((x)->db)
 347 #define sql_field_seek(x, y)  mysql_field_seek((x)->result, (y))
 348 #define sql_fetch_field(x)    mysql_fetch_field((x)->result)
 349 #define sql_num_fields(x)     (int)mysql_num_fields((x)->result)
 350 #define SQL_ROW               MYSQL_ROW
 351 #define SQL_FIELD             MYSQL_FIELD
 352
 353 #else
 354
 355 #ifdef HAVE_POSTGRESQL
 356
 357 #define BDB_VERSION 9
 358
 359 #include <libpq-fe.h>
 360
 361 /* TEMP: the following is taken from select OID, typname from pg_type; */
 362 #define IS_NUM(x)        ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
 363 #define IS_NOT_NULL(x)   ((x) == 1)
 364
 365 typedef char **POSTGRESQL_ROW;
 366 typedef struct pg_field {
 367    char         *name;
 368    int           max_length;
 369    unsigned int  type;
 370    unsigned int  flags;       // 1 == not null
 371 } POSTGRESQL_FIELD;
 372
 373
 374 /*
 375  * This is the "real" definition that should only be
 376  * used inside sql.c and associated database interface
 377  * subroutines.
 378  *
 379  *                     P O S T G R E S Q L
 380  */
 381 struct B_DB {
 382    BQUEUE bq;                         /* queue control */
 383    brwlock_t lock;                    /* transaction lock */
 384    PGconn *db;
 385    PGresult *result;
 386    int status;
 387    POSTGRESQL_ROW row;
 388    POSTGRESQL_FIELD *fields;
 389    int num_rows;
 390    int num_fields;
 391    int row_number;            /* what row number did we get via my_postgresql_data_seek? */
 392    int field_number;          /* what field number did we get via my_postgresql_field_seek? */
 393    int ref_count;
 394    char *db_name;
 395    char *db_user;
 396    char *db_password;
 397    char *db_address;              /* host address */
 398    char *db_socket;               /* socket for local access */
 399    int db_port;                   /* port of host address */
 400    int have_insert_id;            /* do have insert_id() */
 401    bool connected;
 402    POOLMEM *errmsg;               /* nicely edited error message */
 403    POOLMEM *cmd;                  /* SQL command string */
 404    POOLMEM *cached_path;
 405    int cached_path_len;           /* length of cached path */
 406    uint32_t cached_path_id;
 407    bool allow_transactions;       /* transactions allowed */
 408    bool transaction;              /* transaction started */
 409    int changes;                   /* changes made to db */
 410    POOLMEM *fname;                /* Filename only */
 411    POOLMEM *path;                 /* Path only */
 412    POOLMEM *esc_name;             /* Escaped file/path name */
 413    int fnl;                       /* file name length */
 414    int pnl;                       /* path name length */
 415 };
 416
 417 void               my_postgresql_free_result(B_DB *mdb);
 418 POSTGRESQL_ROW     my_postgresql_fetch_row  (B_DB *mdb);
 419 int                my_postgresql_query      (B_DB *mdb, const char *query);
 420 void               my_postgresql_data_seek  (B_DB *mdb, int row);
 421 int                my_postgresql_currval    (B_DB *mdb, char *table_name);
 422 void               my_postgresql_field_seek (B_DB *mdb, int row);
 423 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
 424
 425
 426 /* "Generic" names for easier conversion */
 427 #define sql_store_result(x)   ((x)->result)
 428 #define sql_free_result(x)    my_postgresql_free_result(x)
 429 #define sql_fetch_row(x)      my_postgresql_fetch_row(x)
 430 #define sql_query(x, y)       my_postgresql_query((x), (y))
 431 #define sql_close(x)          PQfinish((x)->db)
 432 #define sql_strerror(x)       PQresultErrorMessage((x)->result)
 433 #define sql_num_rows(x)       ((unsigned) PQntuples((x)->result))
 434 #define sql_data_seek(x, i)   my_postgresql_data_seek((x), (i))
 435 #define sql_affected_rows(x)  ((unsigned) atoi(PQcmdTuples((x)->result)))
 436 #define sql_insert_id(x,y)    my_postgresql_currval((x), (y))
 437 #define sql_field_seek(x, y)  my_postgresql_field_seek((x), (y))
 438 #define sql_fetch_field(x)    my_postgresql_fetch_field(x)
 439 #define sql_num_fields(x)     ((x)->num_fields)
 440 #define SQL_ROW               POSTGRESQL_ROW
 441 #define SQL_FIELD             POSTGRESQL_FIELD
 442
 443 #else  /* USE BACULA DB routines */
 444
 445 #define HAVE_BACULA_DB 1
 446
 447 /* Change this each time there is some incompatible
 448  * file format change!!!!
 449  */
 450 #define BDB_VERSION 13                /* file version number */
 451
 452 struct s_control {
 453    int bdb_version;                   /* Version number */
 454    uint32_t JobId;                    /* next Job Id */
 455    uint32_t PoolId;                   /* next Pool Id */
 456    uint32_t MediaId;                  /* next Media Id */
 457    uint32_t JobMediaId;               /* next JobMedia Id */
 458    uint32_t ClientId;                 /* next Client Id */
 459    uint32_t FileSetId;                /* nest FileSet Id */
 460    time_t time;                       /* time file written */
 461 };
 462
 463
 464 /* This is the REAL definition for using the
 465  *  Bacula internal DB
 466  */
 467 struct B_DB {
 468    BQUEUE bq;                         /* queue control */
 469 /* pthread_mutex_t mutex;  */         /* single thread lock */
 470    brwlock_t lock;                    /* transaction lock */
 471    int ref_count;                     /* number of times opened */
 472    struct s_control control;          /* control file structure */
 473    int cfd;                           /* control file device */
 474    FILE *jobfd;                       /* Jobs records file descriptor */
 475    FILE *poolfd;                      /* Pool records fd */
 476    FILE *mediafd;                     /* Media records fd */
 477    FILE *jobmediafd;                  /* JobMedia records fd */
 478    FILE *clientfd;                    /* Client records fd */
 479    FILE *filesetfd;                   /* FileSet records fd */
 480    char *db_name;                     /* name of database */
 481    POOLMEM *errmsg;                   /* nicely edited error message */
 482    POOLMEM *cmd;                      /* Command string */
 483    POOLMEM *cached_path;
 484    int cached_path_len;               /* length of cached path */
 485    uint32_t cached_path_id;
 486 };
 487
 488 #endif /* HAVE_SQLITE3 */
 489 #endif /* HAVE_MYSQL */
 490 #endif /* HAVE_SQLITE */
 491 #endif /* HAVE_POSTGRESQL */
 492
 493 /* Use for better error location printing */
 494 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
 495 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
 496 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
 497 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
 498
 499
 500 #else    /* not __SQL_C */
 501
 502 /* This is a "dummy" definition for use outside of sql.c
 503  */
 504 struct B_DB {
 505    int dummy;                         /* for SunOS compiler */
 506 };
 507
 508 #endif /*  __SQL_C */
 509
 510 extern uint32_t bacula_db_version;
 511
 512 /* ***FIXME*** FileId_t should *really* be uint64_t
 513  *  but at the current time, this breaks MySQL.
 514  */
 515 typedef uint32_t FileId_t;
 516 typedef uint32_t DBId_t;              /* general DB id type */
 517 typedef uint32_t JobId_t;
 518
 519 #define faddr_t long
 520
 521
 522 /* Job information passed to create job record and update
 523  * job record at end of job. Note, although this record
 524  * contains all the fields found in the Job database record,
 525  * it also contains fields found in the JobMedia record.
 526  */
 527 /* Job record */
 528 struct JOB_DBR {
 529    JobId_t JobId;
 530    char Job[MAX_NAME_LENGTH];         /* Job unique name */
 531    char Name[MAX_NAME_LENGTH];        /* Job base name */
 532    int JobType;                       /* actually char(1) */
 533    int JobLevel;                      /* actually char(1) */
 534    int JobStatus;                     /* actually char(1) */
 535    DBId_t ClientId;                   /* Id of client */
 536    DBId_t PoolId;                     /* Id of pool */
 537    DBId_t FileSetId;                  /* Id of FileSet */
 538    time_t SchedTime;                  /* Time job scheduled */
 539    time_t StartTime;                  /* Job start time */
 540    time_t EndTime;                    /* Job termination time */
 541    utime_t JobTDate;                  /* Backup time/date in seconds */
 542    uint32_t VolSessionId;
 543    uint32_t VolSessionTime;
 544    uint32_t JobFiles;
 545    uint32_t JobErrors;
 546    uint32_t JobMissingFiles;
 547    uint64_t JobBytes;
 548
 549    /* Note, FirstIndex, LastIndex, Start/End File and Block
 550     * are only used in the JobMedia record.
 551     */
 552    uint32_t FirstIndex;               /* First index this Volume */
 553    uint32_t LastIndex;                /* Last index this Volume */
 554    uint32_t StartFile;
 555    uint32_t EndFile;
 556    uint32_t StartBlock;
 557    uint32_t EndBlock;
 558
 559    char cSchedTime[MAX_TIME_LENGTH];
 560    char cStartTime[MAX_TIME_LENGTH];
 561    char cEndTime[MAX_TIME_LENGTH];
 562    /* Extra stuff not in DB */
 563    int limit;                         /* limit records to display */
 564    faddr_t rec_addr;
 565 };
 566
 567 /* Job Media information used to create the media records
 568  * for each Volume used for the job.
 569  */
 570 /* JobMedia record */
 571 struct JOBMEDIA_DBR {
 572    DBId_t JobMediaId;                 /* record id */
 573    JobId_t  JobId;                    /* JobId */
 574    DBId_t MediaId;                    /* MediaId */
 575    uint32_t FirstIndex;               /* First index this Volume */
 576    uint32_t LastIndex;                /* Last index this Volume */
 577    uint32_t StartFile;                /* File for start of data */
 578    uint32_t EndFile;                  /* End file on Volume */
 579    uint32_t StartBlock;               /* start block on tape */
 580    uint32_t EndBlock;                 /* last block */
 581    uint32_t Copy;                     /* identical copy */
 582    uint32_t Stripe;                   /* RAIT strip number */
 583 };
 584
 585
 586 /* Volume Parameter structure */
 587 struct VOL_PARAMS {
 588    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 589    char MediaType[MAX_NAME_LENGTH];   /* Media Type */
 590    uint32_t VolIndex;                 /* Volume seqence no. */
 591    uint32_t FirstIndex;               /* First index this Volume */
 592    uint32_t LastIndex;                /* Last index this Volume */
 593    uint32_t StartFile;                /* File for start of data */
 594    uint32_t EndFile;                  /* End file on Volume */
 595    uint32_t StartBlock;               /* start block on tape */
 596    uint32_t EndBlock;                 /* last block */
 597 // uint32_t Copy;                     /* identical copy */
 598 // uint32_t Stripe;                   /* RAIT strip number */
 599 };
 600
 601
 602 /* Attributes record -- NOT same as in database because
 603  *  in general, this "record" creates multiple database
 604  *  records (e.g. pathname, filename, fileattributes).
 605  */
 606 struct ATTR_DBR {
 607    char *fname;                       /* full path & filename */
 608    char *link;                        /* link if any */
 609    char *attr;                        /* attributes statp */
 610    uint32_t FileIndex;
 611    uint32_t Stream;
 612    JobId_t  JobId;
 613    DBId_t ClientId;
 614    DBId_t PathId;
 615    DBId_t FilenameId;
 616    FileId_t FileId;
 617    char *Sig;
 618    int SigType;
 619 };
 620
 621
 622 /* File record -- same format as database */
 623 struct FILE_DBR {
 624    FileId_t FileId;
 625    uint32_t FileIndex;
 626    JobId_t  JobId;
 627    DBId_t FilenameId;
 628    DBId_t PathId;
 629    JobId_t  MarkId;
 630    char LStat[256];
 631    char SIG[50];
 632    int SigType;                       /* NO_SIG/MD5_SIG/SHA1_SIG */
 633 };
 634
 635 /* Pool record -- same format as database */
 636 struct POOL_DBR {
 637    DBId_t PoolId;
 638    char Name[MAX_NAME_LENGTH];        /* Pool name */
 639    uint32_t NumVols;                  /* total number of volumes */
 640    uint32_t MaxVols;                  /* max allowed volumes */
 641    int32_t LabelType;                 /* Bacula/ANSI/IBM */
 642    int32_t UseOnce;                   /* set to use once only */
 643    int32_t UseCatalog;                /* set to use catalog */
 644    int32_t AcceptAnyVolume;           /* set to accept any volume sequence */
 645    int32_t AutoPrune;                 /* set to prune automatically */
 646    int32_t Recycle;                   /* default Vol recycle flag */
 647    utime_t  VolRetention;             /* retention period in seconds */
 648    utime_t  VolUseDuration;           /* time in secs volume can be used */
 649    uint32_t MaxVolJobs;               /* Max Jobs on Volume */
 650    uint32_t MaxVolFiles;              /* Max files on Volume */
 651    uint64_t MaxVolBytes;              /* Max bytes on Volume */
 652    char PoolType[MAX_NAME_LENGTH];
 653    char LabelFormat[MAX_NAME_LENGTH];
 654    /* Extra stuff not in DB */
 655    faddr_t rec_addr;
 656 };
 657
 658 class DEVICE_DBR {
 659 public:
 660    DBId_t DeviceId;
 661    char Name[MAX_NAME_LENGTH];        /* Device name */
 662    DBId_t MediaTypeId;                /* MediaType */
 663    DBId_t StorageId;                  /* Storage id if autochanger */
 664    uint32_t DevMounts;                /* Number of times mounted */
 665    uint32_t DevErrors;                /* Number of read/write errors */
 666    uint64_t DevReadBytes;             /* Number of bytes read */
 667    uint64_t DevWriteBytes;            /* Number of bytew written */
 668    uint64_t DevReadTime;              /* time spent reading volume */
 669    uint64_t DevWriteTime;             /* time spent writing volume */
 670    uint64_t DevReadTimeSincCleaning;  /* read time since cleaning */
 671    uint64_t DevWriteTimeSincCleaning; /* write time since cleaning */
 672    time_t   CleaningDate;             /* time last cleaned */
 673    utime_t  CleaningPeriod;           /* time between cleanings */
 674 };
 675
 676 class STORAGE_DBR {
 677 public:
 678    DBId_t StorageId;
 679    char Name[MAX_NAME_LENGTH];        /* Device name */
 680    int AutoChanger;                   /* Set if autochanger */
 681
 682    /* Not in database */
 683    bool created;                      /* set if created by db_create ... */
 684 };
 685
 686 class MEDIATYPE_DBR {
 687 public:
 688    DBId_t MediaTypeId;
 689    char MediaType[MAX_NAME_LENGTH];   /* MediaType string */
 690    int ReadOnly;                      /* Set if read-only */
 691 };
 692
 693
 694 /* Media record -- same as the database */
 695 struct MEDIA_DBR {
 696    DBId_t MediaId;                    /* Unique volume id */
 697    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 698    char MediaType[MAX_NAME_LENGTH];   /* Media type */
 699    DBId_t PoolId;                     /* Pool id */
 700    time_t   FirstWritten;             /* Time Volume first written */
 701    time_t   LastWritten;              /* Time Volume last written */
 702    time_t   LabelDate;                /* Date/Time Volume labeled */
 703    int32_t  LabelType;                /* Label (Bacula/ANSI/IBM) */
 704    uint32_t VolJobs;                  /* number of jobs on this medium */
 705    uint32_t VolFiles;                 /* Number of files */
 706    uint32_t VolBlocks;                /* Number of blocks */
 707    uint32_t VolMounts;                /* Number of times mounted */
 708    uint32_t VolErrors;                /* Number of read/write errors */
 709    uint32_t VolWrites;                /* Number of writes */
 710    uint32_t VolReads;                 /* Number of reads */
 711    uint64_t VolBytes;                 /* Number of bytes written */
 712    uint32_t VolParts;                 /* Number of parts written */
 713    uint64_t MaxVolBytes;              /* Max bytes to write to Volume */
 714    uint64_t VolCapacityBytes;         /* capacity estimate */
 715    uint64_t VolReadTime;              /* time spent reading volume */
 716    uint64_t VolWriteTime;             /* time spent writing volume */
 717    utime_t  VolRetention;             /* Volume retention in seconds */
 718    utime_t  VolUseDuration;           /* time in secs volume can be used */
 719    uint32_t MaxVolJobs;               /* Max Jobs on Volume */
 720    uint32_t MaxVolFiles;              /* Max files on Volume */
 721    int32_t  Recycle;                  /* recycle yes/no */
 722    int32_t  Slot;                     /* slot in changer */
 723    int32_t  InChanger;                /* Volume currently in changer */
 724    DBId_t   StorageId;                /* Storage record Id */
 725    uint32_t EndFile;                  /* Last file on volume */
 726    uint32_t EndBlock;                 /* Last block on volume */
 727    char VolStatus[20];                /* Volume status */
 728    /* Extra stuff not in DB */
 729    faddr_t rec_addr;                  /* found record address */
 730    /* Since the database returns times as strings, this is how we pass
 731     *   them back.
 732     */
 733    char    cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
 734    char    cLastWritten[MAX_TIME_LENGTH];  /* LastWritten returned from DB */
 735    char    cLabelDate[MAX_TIME_LENGTH];    /* LabelData returned from DB */
 736    bool    set_first_written;
 737    bool    set_label_date;
 738 };
 739
 740 /* Client record -- same as the database */
 741 struct CLIENT_DBR {
 742    DBId_t ClientId;                   /* Unique Client id */
 743    int AutoPrune;
 744    utime_t FileRetention;
 745    utime_t JobRetention;
 746    char Name[MAX_NAME_LENGTH];        /* Client name */
 747    char Uname[256];                   /* Uname for client */
 748 };
 749
 750 /* Counter record as in database */
 751 struct COUNTER_DBR {
 752    char Counter[MAX_NAME_LENGTH];
 753    int32_t MinValue;
 754    int32_t MaxValue;
 755    int32_t CurrentValue;
 756    char WrapCounter[MAX_NAME_LENGTH];
 757 };
 758
 759
 760 /* FileSet record -- same as the database */
 761 struct FILESET_DBR {
 762    DBId_t FileSetId;                  /* Unique FileSet id */
 763    char FileSet[MAX_NAME_LENGTH];     /* FileSet name */
 764    char MD5[50];                      /* MD5 signature of include/exclude */
 765    time_t CreateTime;                 /* date created */
 766    /*
 767     * This is where we return CreateTime
 768     */
 769    char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
 770    /* Not in DB but returned by db_create_fileset() */
 771    bool created;                      /* set when record newly created */
 772 };
 773
 774
 775
 776 #include "protos.h"
 777 #include "jcr.h"
 778
 779 /*
 780  * Some functions exported by sql.c for use withing the
 781  *   cats directory.
 782  */
 783 void list_result(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type);
 784 void list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx);
 785 int get_sql_record_max(JCR *jcr, B_DB *mdb);
 786 int check_tables_version(JCR *jcr, B_DB *mdb);
 787 void _db_unlock(const char *file, int line, B_DB *mdb);
 788 void _db_lock(const char *file, int line, B_DB *mdb);
 789
 790 #endif /* __SQL_H_ */