git.gag.com Git - debian/amanda/blob - server-src/diskfile.h

   1 /*
   2  * Amanda, The Advanced Maryland Automatic Network Disk Archiver
   3  * Copyright (c) 1991-1998 University of Maryland at College Park
   4  * All Rights Reserved.
   5  *
   6  * Permission to use, copy, modify, distribute, and sell this software and its
   7  * documentation for any purpose is hereby granted without fee, provided that
   8  * the above copyright notice appear in all copies and that both that
   9  * copyright notice and this permission notice appear in supporting
  10  * documentation, and that the name of U.M. not be used in advertising or
  11  * publicity pertaining to distribution of the software without specific,
  12  * written prior permission.  U.M. makes no representations about the
  13  * suitability of this software for any purpose.  It is provided "as is"
  14  * without express or implied warranty.
  15  *
  16  * U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
  18  * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  19  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  20  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22  *
  23  * Author: James da Silva, Systems Design and Analysis Group
  24  *                         Computer Science Department
  25  *                         University of Maryland at College Park
  26  */
  27 /*
  28  * $Id: diskfile.h,v 1.38 2006/06/22 20:41:33 martinea Exp $
  29  *
  30  * interface for disklist file reading code
  31  */
  32 #ifndef DISKFILE_H
  33 #define DISKFILE_H
  34
  35 #include "amanda.h"
  36 #include "conffile.h"
  37 #include "amfeatures.h"
  38
  39 typedef struct netif_s {
  40     struct netif_s *next;
  41     interface_t *config;
  42     unsigned long curusage;
  43 } netif_t;
  44
  45 typedef struct amhost_s {
  46     struct amhost_s *next;              /* next host */
  47     char *hostname;                     /* name of host */
  48     struct disk_s *disks;               /* linked list of disk records */
  49     int inprogress;                     /* # dumps in progress */
  50     int maxdumps;                       /* maximum dumps in parallel */
  51     netif_t *netif;                     /* network interface this host is on */
  52     time_t start_t;                     /* start dump after this time */
  53     char *up;                           /* generic user pointer */
  54     am_feature_t *features;             /* feature set */
  55     int  pre_script;
  56     int  post_script;
  57 } am_host_t;
  58
  59 typedef struct disk_s {
  60     int         line;                   /* line number of last definition */
  61     struct disk_s *prev, *next;         /* doubly linked disk list */
  62
  63     am_host_t   *host;                  /* host list */
  64     struct disk_s *hostnext;
  65
  66     char        *hostname;              /* hostname */
  67     char        *name;                  /* label name for disk */
  68     char        *device;                /* device name for disk, eg "sd0g" */
  69     char        *dtype_name;            /* name of dump type   XXX shouldn't need this */
  70     char        *program;               /* dump program, eg DUMP, STAR, GNUTAR */
  71     char        *srvcompprog;           /* custom compression server filter */
  72     char        *clntcompprog;          /* custom compression client filter */
  73     char        *srv_encrypt;           /* custom encryption server filter */
  74     char        *clnt_encrypt;          /* custom encryption client filter */
  75     char        *amandad_path;          /* amandad path on the client */
  76     char        *client_username;       /* username to connect on the client */
  77     char        *ssh_keys;              /* ssh_key file to use */
  78     sl_t        *exclude_file;          /* file exclude spec */
  79     sl_t        *exclude_list;          /* exclude list */
  80     sl_t        *include_file;          /* file include spec */
  81     sl_t        *include_list;          /* include list */
  82     int         exclude_optional;       /* exclude list are optional */
  83     int         include_optional;       /* include list are optional */
  84     int         priority;               /* priority of disk */
  85     off_t       tape_splitsize;         /* size of dumpfile chunks on tape */
  86     char        *split_diskbuffer;      /* place where we can buffer PORT-WRITE dumps other than RAM */
  87     off_t       fallback_splitsize;     /* size for in-RAM PORT-WRITE buffers */
  88     int         dumpcycle;              /* days between fulls */
  89     long        frequency;              /* XXX - not used */
  90     char        *security_driver;       /* type of authentication (per disk) */
  91     int         maxdumps;               /* max number of parallel dumps (per system) */
  92     int         maxpromoteday;          /* maximum of promote day */
  93     int         bumppercent;
  94     off_t       bumpsize;
  95     int         bumpdays;
  96     double      bumpmult;
  97     time_t      starttime;              /* start this dump after this time */
  98     time_t      start_t;                /* start this dump after this time */
  99     int         strategy;               /* what dump strategy to use */
 100     int         ignore;                 /* ignore */
 101     int         estimate;               /* what estimate strategy to use */
 102     int         compress;               /* type of compression to use */
 103     int         encrypt;                /* type of encryption to use */
 104     char        *srv_decrypt_opt;       /* server-side decryption option parameter to use */
 105     char        *clnt_decrypt_opt;      /* client-side decryption option parameter to use */
 106     double      comprate[2];            /* default compression rates */
 107     /* flag options */
 108     int         record;                 /* record dump in /var/lib/dumpdates ? */
 109     int         skip_incr;              /* incs done externally ? */
 110     int         skip_full;              /* fulls done externally ? */
 111     int         to_holdingdisk;         /* use holding disk ? */
 112     int         kencrypt;
 113     int         index;                  /* produce an index ? */
 114     int         spindle;                /* spindle # - for parallel dumps */
 115     int         inprogress;             /* being dumped now? */
 116     int         todo;
 117     application_t *application;
 118     pp_scriptlist_t pp_scriptlist;
 119     void        *up;                    /* generic user pointer */
 120 } disk_t;
 121
 122 typedef struct disklist_s {
 123     disk_t *head, *tail;
 124 } disklist_t;
 125
 126 #define empty(dlist)    ((dlist).head == NULL)
 127
 128 /* This function is integrated with the conffile.c error-handling; handle its return
 129  * value just as you would the return of config_init() */
 130 cfgerr_level_t read_diskfile(const char *, disklist_t *);
 131
 132 am_host_t *lookup_host(const char *hostname);
 133 disk_t *lookup_disk(const char *hostname, const char *diskname);
 134
 135 disk_t *add_disk(disklist_t *list, char *hostname, char *diskname);
 136
 137 void enqueue_disk(disklist_t *list, disk_t *disk);
 138 void headqueue_disk(disklist_t *list, disk_t *disk);
 139 void insert_disk(disklist_t *list, disk_t *disk, int (*f)(disk_t *a, disk_t *b));
 140 int  find_disk(disklist_t *list, disk_t *disk);
 141 void sort_disk(disklist_t *in, disklist_t *out, int (*f)(disk_t *a, disk_t *b));
 142 disk_t *dequeue_disk(disklist_t *list);
 143 void remove_disk(disklist_t *list, disk_t *disk);
 144
 145 void dump_queue(char *str, disklist_t q, int npr, FILE *f);
 146
 147 char *optionstr(disk_t *dp, am_feature_t *their_features, FILE *fdout);
 148
 149 /* xml_optionstr()
 150  * to_server must be set to 1 if the result is sent to another server
 151  *           application, eg. driver to dumper.
 152  *           It must be set to 0 if the result is sent to the client.
 153  */
 154 char *xml_optionstr(disk_t *dp, am_feature_t *their_features, FILE *fdout,
 155                     int to_server);
 156 char *clean_dle_str_for_client(char *dle_str);
 157 char *xml_application(application_t *application,
 158                       am_feature_t *their_features);
 159 char *xml_scripts(pp_scriptlist_t pp_scriptlist, am_feature_t *their_features);
 160
 161 char *match_disklist(disklist_t *origqp, int sargc, char **sargv);
 162 void free_disklist(disklist_t *dl);
 163
 164 netif_t *disklist_netifs(void);
 165
 166 #endif /* ! DISKFILE_H */