Annotation of src/usr.bin/rdist/defs.h, Revision 1.30
1.30 ! guenther 1: /* $OpenBSD: defs.h,v 1.29 2014/07/12 03:40:16 guenther Exp $ */
1.8 millert 2:
1.2 dm 3: #ifndef __DEFS_H__
4: #define __DEFS_H__
1.1 deraadt 5: /*
1.2 dm 6: * Copyright (c) 1983 Regents of the University of California.
7: * All rights reserved.
1.1 deraadt 8: *
9: * Redistribution and use in source and binary forms, with or without
10: * modification, are permitted provided that the following conditions
11: * are met:
12: * 1. Redistributions of source code must retain the above copyright
13: * notice, this list of conditions and the following disclaimer.
14: * 2. Redistributions in binary form must reproduce the above copyright
15: * notice, this list of conditions and the following disclaimer in the
16: * documentation and/or other materials provided with the distribution.
1.14 millert 17: * 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 18: * may be used to endorse or promote products derived from this software
19: * without specific prior written permission.
20: *
21: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31: * SUCH DAMAGE.
32: */
33:
1.2 dm 34: /*
1.13 millert 35: * $From: defs.h,v 1.6 2001/03/12 18:16:30 kim Exp $
1.2 dm 36: * @(#)defs.h 5.2 (Berkeley) 3/20/86
37: */
1.1 deraadt 38:
1.21 guenther 39: #include <sys/types.h>
40: #include <sys/param.h>
41: #include <sys/file.h>
42: #include <sys/time.h>
43: #include <sys/stat.h>
1.2 dm 44: #include <ctype.h>
1.1 deraadt 45: #include <errno.h>
1.21 guenther 46: #include <grp.h>
1.1 deraadt 47: #include <pwd.h>
1.28 guenther 48: #include <paths.h>
1.12 millert 49: #include <regex.h>
1.21 guenther 50: #include <setjmp.h>
51: #include <signal.h>
52: #include <stdarg.h>
53: #include <stdio.h>
54: #include <stdlib.h>
55: #include <string.h>
1.2 dm 56: #include <syslog.h>
1.21 guenther 57: #include <unistd.h>
1.2 dm 58:
1.13 millert 59: #ifndef __GNUC__
60: # ifndef __attribute__
61: # define __attribute__(a)
62: # endif
63: #endif
64:
1.2 dm 65: #include "version.h"
66: #include "config.h"
1.1 deraadt 67: #include "pathnames.h"
1.2 dm 68: #include "types.h"
1.13 millert 69: #include "filesys.h"
1.2 dm 70:
1.29 guenther 71: /*
72: * Define the read and write values for the file descriptor array
73: * used by pipe().
74: */
75: #define PIPE_READ 0
76: #define PIPE_WRITE 1
1.1 deraadt 77:
1.2 dm 78: /* boolean truth */
79: #ifndef TRUE
80: #define TRUE 1
81: #endif
82: #ifndef FALSE
83: #define FALSE 0
84: #endif
85:
1.1 deraadt 86: /* lexical definitions */
1.2 dm 87: #define QUOTECHAR 160 /* quote next character */
1.1 deraadt 88:
89: /* table sizes */
90: #define HASHSIZE 1021
1.2 dm 91: #define INMAX 3500
1.1 deraadt 92:
93: /* expand type definitions */
1.2 dm 94: #define E_VARS 0x1
95: #define E_SHELL 0x2
96: #define E_TILDE 0x4
97: #define E_ALL 0x7
1.1 deraadt 98:
99: /* actions for lookup() */
1.2 dm 100: #define LOOKUP 0
101: #define INSERT 1
102: #define REPLACE 2
103:
104: /* Bit flag test macros */
105: #define IS_ON(b,f) (b > 0 && (b & f))
106: #define IS_OFF(b,f) !(IS_ON(b,f))
107: #define FLAG_ON(b,f) b |= f
108: #define FLAG_OFF(b,f) b &= ~(f)
109:
110: #define ALLOC(x) (struct x *) xmalloc(sizeof(struct x))
111: #define A(s) ((s) ? s : "<null>")
112:
113: /*
114: * Environment variable names
115: */
116: #define E_FILES "FILES" /* List of files */
117: #define E_LOCFILE "FILE" /* Local Filename */
118: #define E_REMFILE "REMFILE" /* Remote Filename */
119: #define E_BASEFILE "BASEFILE" /* basename of Remote File */
120:
121: /*
122: * Suffix to use when saving files
123: */
124: #ifndef SAVE_SUFFIX
125: #define SAVE_SUFFIX ".OLD"
126: #endif
1.1 deraadt 127:
1.2 dm 128: /*
129: * Get system error string
130: */
131: #define SYSERR strerror(errno)
132:
133: #define COMMENT_CHAR '#' /* Config file comment char */
134: #define CNULL '\0' /* NULL character */
135:
136: /*
137: * These are the top level protocol commands.
138: */
139: #define C_NONE '=' /* No command - pass cleanly */
140: #define C_ERRMSG '\1' /* Log an error message */
141: #define C_FERRMSG '\2' /* Log a fatal error message */
142: #define C_NOTEMSG '\3' /* Log a note message */
143: #define C_LOGMSG '\4' /* Log a message */
144: #define C_ACK '\5' /* Acknowledge */
145: #define C_SETCONFIG 'c' /* Set configuration parameters */
146: #define C_DIRTARGET 'T' /* Set target directory name */
147: #define C_TARGET 't' /* Set target file name */
148: #define C_RECVREG 'R' /* Receive a regular file */
149: #define C_RECVDIR 'D' /* Receive a directory */
150: #define C_RECVSYMLINK 'K' /* Receive a symbolic link */
151: #define C_RECVHARDLINK 'k' /* Receive a hard link */
1.15 jmc 152: #define C_END 'E' /* Indicate end of receive/send */
1.2 dm 153: #define C_CLEAN 'C' /* Clean up */
154: #define C_QUERY 'Q' /* Query without checking */
155: #define C_SPECIAL 'S' /* Execute special command */
156: #define C_CMDSPECIAL 's' /* Execute cmd special command */
1.13 millert 157: #define C_CHMOG 'M' /* Chown,Chgrp,Chmod a file */
1.2 dm 158:
1.21 guenther 159: #define ack() (void) sendcmd(C_ACK, NULL)
160: #define err() (void) sendcmd(C_ERRMSG, NULL)
1.2 dm 161:
162: /*
163: * Session startup commands.
164: */
165: #define S_VERSION 'V' /* Version number */
166: #define S_REMOTEUSER 'R' /* Remote user name */
167: #define S_LOCALUSER 'L' /* Local user name */
168: #define S_END 'E' /* End of session startup commands */
1.1 deraadt 169:
1.2 dm 170: /*
171: * These are the commands for "set config".
172: */
173: #define SC_FREESPACE 's' /* Set min free space */
174: #define SC_FREEFILES 'f' /* Set min free files */
175: #define SC_HOSTNAME 'H' /* Set client hostname */
176: #define SC_LOGGING 'L' /* Set logging options */
1.13 millert 177: #define SC_DEFOWNER 'o' /* Set default owner */
178: #define SC_DEFGROUP 'g' /* Set default group */
1.2 dm 179:
180: /*
181: * Query commands
182: */
183: #define QC_ONNFS 'F' /* File exists & is on a NFS */
184: #define QC_ONRO 'O' /* File exists & is on a readonly fs */
185: #define QC_NO 'N' /* File does not exist */
186: #define QC_SYM 'l' /* File exists & is a symlink */
187: #define QC_YES 'Y' /* File does exist */
1.1 deraadt 188:
1.2 dm 189: /*
190: * Clean commands
191: */
192: #define CC_QUERY 'Q' /* Query if file should be rm'ed */
193: #define CC_END 'E' /* End of cleaning */
194: #define CC_YES 'Y' /* File doesn't exist - remove */
195: #define CC_NO 'N' /* File does exist - don't remove */
196:
197: /*
198: * Run Command commands
199: */
200: #define RC_FILE 'F' /* Name of a target file */
201: #define RC_COMMAND 'C' /* Command to run */
202:
203: /*
204: * Name list
205: */
206: struct namelist { /* for making lists of strings */
1.1 deraadt 207: char *n_name;
1.12 millert 208: regex_t *n_regex;
1.1 deraadt 209: struct namelist *n_next;
210: };
211:
1.2 dm 212: /*
213: * Sub command structure
214: */
1.1 deraadt 215: struct subcmd {
216: short sc_type; /* type - INSTALL,NOTIFY,EXCEPT,SPECIAL */
1.2 dm 217: opt_t sc_options;
1.1 deraadt 218: char *sc_name;
219: struct namelist *sc_args;
220: struct subcmd *sc_next;
221: };
222:
1.2 dm 223: /*
224: * Cmd flags
225: */
226: #define CMD_ASSIGNED 0x01 /* This entry has been assigned */
227: #define CMD_CONNFAILED 0x02 /* Connection failed */
228: #define CMD_NOCHKNFS 0x04 /* Disable NFS checks */
229:
230: /*
231: * General command structure
232: */
1.1 deraadt 233: struct cmd {
234: int c_type; /* type - ARROW,DCOLON */
1.2 dm 235: int c_flags; /* flags - CMD_USED,CMD_FAILED */
1.1 deraadt 236: char *c_name; /* hostname or time stamp file name */
237: char *c_label; /* label for partial update */
238: struct namelist *c_files;
239: struct subcmd *c_cmds;
240: struct cmd *c_next;
241: };
242:
1.2 dm 243: /*
244: * Hard link buffer information
245: */
1.1 deraadt 246: struct linkbuf {
247: ino_t inum;
248: dev_t devnum;
249: int count;
1.10 millert 250: char *pathname;
251: char *src;
252: char *target;
1.1 deraadt 253: struct linkbuf *nextp;
254: };
255:
1.2 dm 256: extern char *optarg; /* Option argument */
257: extern char *path_remsh; /* Remote shell command */
258: extern char host[]; /* Host name of master copy */
259: extern char *currenthost; /* Name of current host */
260: extern char *progname; /* Name of this program */
261: extern char **realargv; /* Real argv */
262: extern int optind; /* Option index into argv */
263: extern int debug; /* Debugging flag */
264: extern opt_t defoptions; /* Default install options */
265: extern int do_fork; /* Should we do fork()'ing */
266: extern int isserver; /* Acting as remote server */
267: extern int nerrs; /* Number of errors seen */
268: extern int nflag; /* NOP flag, don't execute commands */
269: extern opt_t options; /* Global options */
270: extern int proto_version; /* Protocol version number */
271: extern int realargc; /* Real argc */
272: extern int rem_r; /* Remote file descriptor, reading */
273: extern int rem_w; /* Remote file descriptor, writing */
274: extern int rtimeout; /* Response time out in seconds */
1.3 dm 275: extern int setjmp_ok; /* setjmp/longjmp flag */
1.22 guenther 276: extern uid_t userid; /* User ID of rdist user */
1.2 dm 277: extern jmp_buf finish_jmpbuf; /* Setjmp buffer for finish() */
278: extern struct linkbuf *ihead; /* list of files with more than one link */
279: extern struct passwd *pw; /* pointer to static area used by getpwent */
1.13 millert 280: extern char defowner[64]; /* Default owner */
281: extern char defgroup[64]; /* Default group */
282: extern volatile sig_atomic_t contimedout; /* Connection timed out */
1.2 dm 283: #ifdef USE_STATDB
284: extern int dostatdb;
285: extern int juststatdb;
286: #endif /* USE_STATDB */
287:
288: /*
1.13 millert 289: * Our own declarations.
1.2 dm 290: */
291:
1.13 millert 292: /* child.c */
293: void waitup(void);
294: int spawn(struct cmd *, struct cmd *);
295:
296: /* client.c */
297: char *remfilename(char *, char *, char *, char *, int);
298: int inlist(struct namelist *, char *);
299: void runcmdspecial(struct cmd *, opt_t);
300: int checkfilename(char *);
301: void freelinkinfo(struct linkbuf *);
302: void cleanup(int);
303: int install(char *, char *, int, int , opt_t);
304:
305: /* common.c */
1.23 guenther 306: ssize_t xwrite(int, void *, size_t);
1.13 millert 307: int init(int, char **, char **);
308: void finish(void);
309: void lostconn(void);
310: void coredump(void);
311: void sighandler(int);
1.21 guenther 312: int sendcmd(char, const char *, ...) __attribute__((__format__ (printf, 2, 3)));
1.13 millert 313: int remline(u_char *, int, int);
1.17 krw 314: ssize_t readrem(char *, ssize_t);
1.22 guenther 315: char *getusername(uid_t, char *, opt_t);
316: char *getgroupname(gid_t, char *, opt_t);
1.13 millert 317: int response(void);
318: char *exptilde(char *, char *, size_t);
319: int becomeuser(void);
320: int becomeroot(void);
321: int setfiletime(char *, time_t, time_t);
322: char *getversion(void);
323: void runcommand(char *);
1.20 guenther 324: void *xmalloc(size_t);
325: void *xrealloc(void *, size_t);
326: void *xcalloc(size_t, size_t);
1.13 millert 327: char *xstrdup(const char *);
328: char *xbasename(char *);
329: char *searchpath(char *);
330:
331: /* distopt.c */
332: DISTOPTINFO *getdistopt(char *, int *);
333: int parsedistopts(char *, opt_t *, int);
334: char *getdistoptlist(void);
335: char *getondistoptlist(opt_t);
336:
337: /* docmd.c */
338: void markassigned(struct cmd *, struct cmd *);
339: int okname(char *);
340: int except(char *);
341: void docmds(struct namelist *, int, char **);
342:
343: /* expand.c */
344: struct namelist *expand(struct namelist *, int);
345: u_char *xstrchr(u_char *, int);
346: void expstr(u_char *);
347: void expsh(u_char *);
348: void matchdir(char *);
349: int execbrc(u_char *, u_char *);
350: int match(char *, char *);
351: int amatch(char *, u_char *);
352:
353: /* filesys.c */
354: char *find_file(char *, struct stat *, int *);
355: mntent_t *findmnt(struct stat *, struct mntinfo *);
356: int isdupmnt(mntent_t *, struct mntinfo *);
357: void wakeup(int);
358: struct mntinfo *makemntinfo(struct mntinfo *);
359: mntent_t *getmntpt(char *, struct stat *, int *);
360: int is_nfs_mounted(char *, struct stat *, int *);
361: int is_ro_mounted(char *, struct stat *, int *);
362: int is_symlinked(char *, struct stat *, int *);
1.17 krw 363: int getfilesysinfo(char *, int64_t *, int64_t *);
1.13 millert 364:
365: /* gram.c */
366: int yylex(void);
367: int any(int, char *);
368: void insert(char *, struct namelist *, struct namelist *, struct subcmd *);
369: void append(char *, struct namelist *, char *, struct subcmd *);
370: void yyerror(char *);
371: struct namelist *makenl(char *);
372: struct subcmd *makesubcmd(int);
373: int yyparse(void);
374:
375: /* isexec.c */
376: int isexec(char *, struct stat *);
377:
378: /* lookup.c */
379: void define(char *);
380: struct namelist *lookup(char *, int, struct namelist *);
381:
382: /* message.c */
383: void msgprusage(void);
384: void msgprconfig(void);
385: char *msgparseopts(char *, int);
386: void checkhostname(void);
1.19 guenther 387: void message(int, const char *, ...) __attribute__((format (printf, 2, 3)));
388: void debugmsg(int, const char *, ...) __attribute__((format (printf, 2, 3)));
389: void error(const char *, ...) __attribute__((format (printf, 1, 2)));
390: void fatalerr(const char *, ...) __attribute__((format (printf, 1, 2)));
1.13 millert 391: char *getnotifyfile(void);
392:
393: /* rdist.c */
394: FILE *opendist(char *);
395: void docmdargs(int, char *[]);
396: char *getnlstr(struct namelist *);
397:
398: /* server.c */
399: void server(void);
400:
401: #include <vis.h>
402: #define DECODE(a, b) strunvis(a, b)
403: #define ENCODE(a, b) strvis(a, b, VIS_WHITE)
1.2 dm 404:
405: #endif /* __DEFS_H__ */