/*
* Amanda, The Advanced Maryland Automatic Network Disk Archiver
* Copyright (c) 1991-1998 University of Maryland at College Park
* Copyright (c) 2007-2012 Zmanda, Inc. All Rights Reserved.
* Copyright (c) 2013-2016 Carbonite, Inc. All Rights Reserved.
* All Rights Reserved.
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
* documentation, and that the name of U.M. not be used in advertising or
* publicity pertaining to distribution of the software without specific,
* written prior permission. U.M. makes no representations about the
* suitability of this software for any purpose. It is provided "as is"
* without express or implied warranty.
*
* U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
* BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* Author: James da Silva, Systems Design and Analysis Group
* Computer Science Department
* University of Maryland at College Park
*/
/*
* $Id: diskfile.h,v 1.38 2006/06/22 20:41:33 martinea Exp $
*
* interface for disklist file reading code
*/
#ifndef DISKFILE_H
#define DISKFILE_H
#include "amanda.h"
#include "conffile.h"
#include "fileheader.h"
#include "amfeatures.h"
typedef struct netif_s {
struct netif_s *next;
interface_t *config;
unsigned long curusage;
} netif_t;
typedef struct amhost_s {
struct amhost_s *next; /* next host */
char *hostname; /* name of host */
struct disk_s *disks; /* linked list of disk records */
int inprogress; /* # dumps in progress */
int maxdumps; /* maximum dumps in parallel */
netif_t *netif; /* network interface this host is on */
time_t start_t; /* time last dump was started on this host */
am_feature_t *features; /* feature set */
int pre_script;
int post_script;
int status;
} am_host_t;
typedef struct disk_s {
int line; /* line number of last definition */
char *filename; /* the filename where it is read */
am_host_t *host; /* host list */
struct disk_s *hostnext;
char *hostname; /* hostname */
char *name; /* label name for disk */
char *device; /* device name for disk, eg "sd0g" */
char *dtype_name; /* name of dump type */
dumptype_t *config; /* pointer to the dumptype config */
char *program; /* dump program, eg DUMP, STAR, GNUTAR */
char *srvcompprog; /* custom compression server filter */
char *clntcompprog; /* custom compression client filter */
char *srv_encrypt; /* custom encryption server filter */
char *clnt_encrypt; /* custom encryption client filter */
char *amandad_path; /* amandad path on the client */
char *client_username; /* username to connect on the client */
char *ssl_fingerprint_file; /* */
char *ssl_cert_file; /* */
char *ssl_key_file; /* */
char *ssl_ca_cert_file; /* */
char *ssl_cipher_list; /* */
int ssl_check_host; /* */
int ssl_check_certificate_host; /* */
int ssl_check_fingerprint; /* */
char *client_port; /* port to connect on the client */
char *ssh_keys; /* ssh_key file to use */
am_sl_t *exclude_file; /* file exclude spec */
am_sl_t *exclude_list; /* exclude list */
am_sl_t *include_file; /* file include spec */
am_sl_t *include_list; /* include list */
int exclude_optional; /* exclude list are optional */
int include_optional; /* include list are optional */
int priority; /* priority of disk */
int allow_split;
int max_warnings;
off_t tape_splitsize; /* size of dumpfile chunks on tape */
char *split_diskbuffer; /* place where we can buffer PORT-WRITE dumps other than RAM */
off_t fallback_splitsize; /* size for in-RAM PORT-WRITE buffers */
int dumpcycle; /* days between fulls */
long frequency; /* XXX - not used */
char *auth; /* type of authentication (per disk) */
int maxdumps; /* max number of parallel dumps (per system) */
int maxpromoteday; /* maximum of promote day */
int bumppercent;
off_t bumpsize;
int bumpdays;
double bumpmult;
time_t starttime; /* start this dump after this time (integer: HHMM) */
time_t start_t; /* start this dump after this time (time_t) */
int strategy; /* what dump strategy to use */
int ignore; /* ignore */
estimatelist_t estimatelist; /* what estimate strategy to use */
int compress; /* type of compression to use */
int encrypt; /* type of encryption to use */
char *srv_decrypt_opt; /* server-side decryption option parameter to use */
char *clnt_decrypt_opt; /* client-side decryption option parameter to use */
double comprate[2]; /* default compression rates */
/* flag options */
int record; /* record dump in /etc/dumpdates ? */
int skip_incr; /* incs done externally ? */
int skip_full; /* fulls done externally ? */
int orig_holdingdisk; /* original holdingdisk setting */
int to_holdingdisk; /* holding disk setting */
int kencrypt;
int index; /* produce an index ? */
data_path_t data_path; /* defined data-path */
char *dataport_list; /* list of address to send data */
char *shm_name; /* shm-ring name to put data to */
int spindle; /* spindle # - for parallel dumps */
int inprogress; /* being dumped now? */
int todo;
char *application;
identlist_t pp_scriptlist;
host_limit_t *dump_limit;
int retry_dump;
identlist_t tags;
int status; /* for amcheck */
} disk_t;
typedef struct disklist_s {
GList *head, *tail;
} disklist_t;
#define get_disk(dlist)((disk_t *)((dlist)->data))
#define empty(dlist) ((dlist).head == NULL)
/* This function is integrated with the conffile.c error-handling; handle its return
* value just as you would the return of config_init() */
cfgerr_level_t read_diskfile(const char *, disklist_t *);
disklist_t * get_disklist(void);
am_host_t *get_hostlist(void);
am_host_t *lookup_host(const char *hostname);
disk_t *lookup_disk(const char *hostname, const char *diskname);
disk_t *add_disk(disklist_t *list, char *hostname, char *diskname);
void enqueue_disk(disklist_t *list, disk_t *disk);
void headqueue_disk(disklist_t *list, disk_t *disk);
void insert_disk(disklist_t *list, disk_t *disk, int (*f)(disk_t *a, disk_t *b));
int find_disk(disklist_t *list, disk_t *disk);
void sort_disk(disklist_t *in, disklist_t *out, int (*f)(disk_t *a, disk_t *b));
disk_t *dequeue_disk(disklist_t *list);
void remove_disk(disklist_t *list, disk_t *disk);
void dump_queue(char *str, disklist_t q, int npr, FILE *f);
char *optionstr(disk_t *dp);
/* xml_optionstr()
* to_server must be set to 1 if the result is sent to another server
* application, eg. driver to dumper.
* It must be set to 0 if the result is sent to the client.
*/
gchar **validate_optionstr(disk_t *dp);
char *xml_optionstr(disk_t *dp, int to_server);
char *xml_optionstr_disk(char *hostname, char *diskname);
char *xml_estimate(estimatelist_t estimatelist, am_feature_t *their_features);
char *xml_estimate_disk(char *hostname, char *diskname,
am_feature_t *their_features);
char *clean_dle_str_for_client(char *dle_str, am_feature_t *their_features);
char *xml_application(disk_t *dp, application_t *application,
am_feature_t *their_features);
char *xml_application_disk(char *hostname, char *diskname,
am_feature_t *their_features);
char *xml_scripts(identlist_t pp_scriptlist, am_feature_t *their_features);
char *xml_dumptype_properties(disk_t *dp);
/* disable_skip_disk() set the db->todo flag to 0 for each dle with 'ignore'
* 'strategy skip'. It is useful for all programs that want to skip them,i
* eg. all amdump process.
* Program use for listing dump or index should not use it.
*/
void disable_skip_disk(disklist_t *origqp);
GPtrArray *match_disklist(disklist_t *origqp, gboolean exact_match, int sargc,
char **sargv);
gboolean match_dumpfile(dumpfile_t *file, gboolean exact_match, int sargc,
char **sargv);
void free_disklist(disklist_t *dl);
void unload_disklist(void);
netif_t *disklist_netifs(void);
#endif /* ! DISKFILE_H */