ffab5eab294eacd2f1301128a58986eb2aa24a62
[debian/amanda] / server-src / server_util.h
1 /*
2  * Amanda, The Advanced Maryland Automatic Network Disk Archiver
3  * Copyright (c) 1991-1999 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  * Authors: the Amanda Development Team.  Its members are listed in a
24  * file named AUTHORS, in the root directory of this distribution.
25  */
26 /*
27  * $Id: server_util.h,v 1.11 2006/05/25 01:47:20 johnfranks Exp $
28  *
29  */
30 #ifndef SERVER_UTIL_H
31 #define SERVER_UTIL_H
32
33 #include "util.h"
34 #include "diskfile.h"
35
36 #define MAX_ARGS 32
37
38 /*
39  * Some lints are confused by: typedef enum (...) xxx_t;
40  * So here we use an equivalent of type int and an unnamed enum for constants.
41  */
42 typedef int cmd_t;
43 enum {
44     BOGUS, QUIT, QUITTING, DONE, PARTIAL,
45     START, FILE_DUMP, PORT_DUMP, CONTINUE, ABORT,       /* dumper cmds */
46     FAILED, TRYAGAIN, NO_ROOM, RQ_MORE_DISK,            /* dumper results */
47     ABORT_FINISHED, BAD_COMMAND,                        /* dumper results */
48     START_TAPER, FILE_WRITE, NEW_TAPE, NO_NEW_TAPE,     /* taper... */
49     PARTDONE, PORT_WRITE, DUMPER_STATUS,                /* ... cmds */
50     PORT, TAPE_ERROR, TAPER_OK,                         /* taper results */
51     REQUEST_NEW_TAPE,
52     LAST_TOK
53 };
54 extern const char *cmdstr[];
55
56 struct cmdargs {
57     cmd_t cmd;
58     int argc;
59     char **argv;
60 };
61
62 struct cmdargs *getcmd(void);
63 struct cmdargs *get_pending_cmd(void);
64 void free_cmdargs(struct cmdargs *cmdargs);
65 void putresult(cmd_t result, const char *, ...) G_GNUC_PRINTF(2, 3);
66 int taper_cmd(cmd_t cmd, void *ptr, char *destname, int level, char *datestamp);
67
68 struct disk_s;
69 struct chunker_s;
70 int chunker_cmd(struct chunker_s *chunker, cmd_t cmd, struct disk_s *dp,
71                 char *mesg);
72
73 struct dumper_s;
74 int dumper_cmd(struct dumper_s *dumper, cmd_t cmd, struct disk_s *dp,
75                char *mesg);
76
77 char *amhost_get_security_conf(char *string, void *arg);
78 int check_infofile(char *infodir, disklist_t *dl, char **errmsg);
79
80 void run_server_script(pp_script_t  *pp_script,
81                        execute_on_t  execute_on,
82                        char         *config,
83                        disk_t       *dp,
84                        int           level);
85 void run_server_scripts(execute_on_t  execute_on,
86                         char         *config,
87                         disk_t       *dp,
88                         int           level);
89
90 void run_amcleanup(char *config_name);
91 char *get_master_process(char *logfile);
92
93 #endif  /* SERVER_UTIL_H */