1 /* $NetBSD: vstream.h,v 1.3 2020/03/18 19:05:22 christos Exp $ */ 2 3 #ifndef _VSTREAM_H_INCLUDED_ 4 #define _VSTREAM_H_INCLUDED_ 5 6 /*++ 7 /* NAME 8 /* vstream 3h 9 /* SUMMARY 10 /* simple buffered I/O package 11 /* SYNOPSIS 12 /* #include <vstream.h> 13 /* DESCRIPTION 14 /* .nf 15 16 /* 17 * System library. 18 */ 19 #include <sys/time.h> 20 #include <time.h> 21 #include <fcntl.h> 22 #include <stdarg.h> 23 #include <setjmp.h> 24 #include <unistd.h> 25 26 /* 27 * Utility library. 28 */ 29 #include <vbuf.h> 30 #include <check_arg.h> 31 32 /* 33 * Simple buffered stream. The members of this structure are not part of the 34 * official interface and can change without prior notice. 35 */ 36 typedef ssize_t (*VSTREAM_RW_FN) (int, void *, size_t, int, void *); 37 typedef pid_t(*VSTREAM_WAITPID_FN) (pid_t, WAIT_STATUS_T *, int); 38 39 #ifdef NO_SIGSETJMP 40 #define VSTREAM_JMP_BUF jmp_buf 41 #else 42 #define VSTREAM_JMP_BUF sigjmp_buf 43 #endif 44 45 typedef struct VSTREAM { 46 VBUF buf; /* generic intelligent buffer */ 47 int fd; /* file handle, no 256 limit */ 48 VSTREAM_RW_FN read_fn; /* buffer fill action */ 49 VSTREAM_RW_FN write_fn; /* buffer flush action */ 50 ssize_t req_bufsize; /* requested read/write buffer size */ 51 void *context; /* application context */ 52 off_t offset; /* cached seek info */ 53 char *path; /* give it at least try */ 54 int read_fd; /* read channel (double-buffered) */ 55 int write_fd; /* write channel (double-buffered) */ 56 VBUF read_buf; /* read buffer (double-buffered) */ 57 VBUF write_buf; /* write buffer (double-buffered) */ 58 pid_t pid; /* vstream_popen/close() */ 59 VSTREAM_WAITPID_FN waitpid_fn; /* vstream_popen/close() */ 60 int timeout; /* read/write timeout */ 61 VSTREAM_JMP_BUF *jbuf; /* exception handling */ 62 struct timeval iotime; /* time of last fill/flush */ 63 struct timeval time_limit; /* read/write time limit */ 64 struct VSTRING *vstring; /* memory-backed stream */ 65 } VSTREAM; 66 67 extern VSTREAM vstream_fstd[]; /* pre-defined streams */ 68 69 #define VSTREAM_IN (&vstream_fstd[0]) 70 #define VSTREAM_OUT (&vstream_fstd[1]) 71 #define VSTREAM_ERR (&vstream_fstd[2]) 72 73 #define VSTREAM_FLAG_RD_ERR VBUF_FLAG_RD_ERR /* read error */ 74 #define VSTREAM_FLAG_WR_ERR VBUF_FLAG_WR_ERR /* write error */ 75 #define VSTREAM_FLAG_RD_TIMEOUT VBUF_FLAG_RD_TIMEOUT /* read timeout */ 76 #define VSTREAM_FLAG_WR_TIMEOUT VBUF_FLAG_WR_TIMEOUT /* write timeout */ 77 78 #define VSTREAM_FLAG_ERR VBUF_FLAG_ERR /* some I/O error */ 79 #define VSTREAM_FLAG_EOF VBUF_FLAG_EOF /* end of file */ 80 #define VSTREAM_FLAG_TIMEOUT VBUF_FLAG_TIMEOUT /* timeout error */ 81 #define VSTREAM_FLAG_FIXED VBUF_FLAG_FIXED /* fixed-size buffer */ 82 #define VSTREAM_FLAG_BAD VBUF_FLAG_BAD 83 84 /* Flags 1<<24 and above are reserved for VSTRING. */ 85 #define VSTREAM_FLAG_READ (1<<8) /* read buffer */ 86 #define VSTREAM_FLAG_WRITE (1<<9) /* write buffer */ 87 #define VSTREAM_FLAG_SEEK (1<<10) /* seek info valid */ 88 #define VSTREAM_FLAG_NSEEK (1<<11) /* can't seek this file */ 89 #define VSTREAM_FLAG_DOUBLE (1<<12) /* double buffer */ 90 #define VSTREAM_FLAG_DEADLINE (1<<13) /* deadline active */ 91 #define VSTREAM_FLAG_MEMORY (1<<14) /* internal stream */ 92 93 #define VSTREAM_PURGE_READ (1<<0) /* flush unread data */ 94 #define VSTREAM_PURGE_WRITE (1<<1) /* flush unwritten data */ 95 #define VSTREAM_PURGE_BOTH (VSTREAM_PURGE_READ|VSTREAM_PURGE_WRITE) 96 97 #define VSTREAM_BUFSIZE 4096 98 99 extern VSTREAM *vstream_fopen(const char *, int, mode_t); 100 extern int vstream_fclose(VSTREAM *); 101 extern off_t WARN_UNUSED_RESULT vstream_fseek(VSTREAM *, off_t, int); 102 extern off_t vstream_ftell(VSTREAM *); 103 extern int vstream_fpurge(VSTREAM *, int); 104 extern int vstream_fflush(VSTREAM *); 105 extern int vstream_fputs(const char *, VSTREAM *); 106 extern VSTREAM *vstream_fdopen(int, int); 107 extern int vstream_fdclose(VSTREAM *); 108 109 #define vstream_fread(v, b, n) vbuf_read(&(v)->buf, (b), (n)) 110 #define vstream_fwrite(v, b, n) vbuf_write(&(v)->buf, (b), (n)) 111 112 #define VSTREAM_PUTC(ch, vp) VBUF_PUT(&(vp)->buf, (ch)) 113 #define VSTREAM_GETC(vp) VBUF_GET(&(vp)->buf) 114 #define vstream_ungetc(vp, ch) vbuf_unget(&(vp)->buf, (ch)) 115 #define VSTREAM_EOF VBUF_EOF 116 117 #define VSTREAM_PUTCHAR(ch) VSTREAM_PUTC((ch), VSTREAM_OUT) 118 #define VSTREAM_GETCHAR() VSTREAM_GETC(VSTREAM_IN) 119 120 #define vstream_fileno(vp) ((vp)->fd) 121 #define vstream_req_bufsize(vp) ((const ssize_t) ((vp)->req_bufsize)) 122 #define vstream_context(vp) ((vp)->context) 123 #define vstream_rd_error(vp) vbuf_rd_error(&(vp)->buf) 124 #define vstream_wr_error(vp) vbuf_wr_error(&(vp)->buf) 125 #define vstream_ferror(vp) vbuf_error(&(vp)->buf) 126 #define vstream_feof(vp) vbuf_eof(&(vp)->buf) 127 #define vstream_rd_timeout(vp) vbuf_rd_timeout(&(vp)->buf) 128 #define vstream_wr_timeout(vp) vbuf_wr_timeout(&(vp)->buf) 129 #define vstream_ftimeout(vp) vbuf_timeout(&(vp)->buf) 130 #define vstream_clearerr(vp) vbuf_clearerr(&(vp)->buf) 131 #define VSTREAM_PATH(vp) ((vp)->path ? (const char *) (vp)->path : "unknown_stream") 132 #define vstream_ftime(vp) ((time_t) ((vp)->iotime.tv_sec)) 133 #define vstream_ftimeval(vp) ((vp)->iotime) 134 135 #define vstream_fstat(vp, fl) ((vp)->buf.flags & (fl)) 136 137 extern ssize_t vstream_fread_buf(VSTREAM *, struct VSTRING *, ssize_t); 138 extern ssize_t vstream_fread_app(VSTREAM *, struct VSTRING *, ssize_t); 139 extern void vstream_control(VSTREAM *, int,...); 140 141 /* Legacy API: type-unchecked arguments, internal use. */ 142 #define VSTREAM_CTL_END 0 143 #define VSTREAM_CTL_READ_FN 1 144 #define VSTREAM_CTL_WRITE_FN 2 145 #define VSTREAM_CTL_PATH 3 146 #define VSTREAM_CTL_DOUBLE 4 147 #define VSTREAM_CTL_READ_FD 5 148 #define VSTREAM_CTL_WRITE_FD 6 149 #define VSTREAM_CTL_WAITPID_FN 7 150 #define VSTREAM_CTL_TIMEOUT 8 151 #define VSTREAM_CTL_EXCEPT 9 152 #define VSTREAM_CTL_CONTEXT 10 153 #ifdef F_DUPFD 154 #define VSTREAM_CTL_DUPFD 11 155 #endif 156 #define VSTREAM_CTL_BUFSIZE 12 157 #define VSTREAM_CTL_SWAP_FD 13 158 #define VSTREAM_CTL_START_DEADLINE 14 159 #define VSTREAM_CTL_STOP_DEADLINE 15 160 161 /* Safer API: type-checked arguments, external use. */ 162 #define CA_VSTREAM_CTL_END VSTREAM_CTL_END 163 #define CA_VSTREAM_CTL_READ_FN(v) VSTREAM_CTL_READ_FN, CHECK_VAL(VSTREAM_CTL, VSTREAM_RW_FN, (v)) 164 #define CA_VSTREAM_CTL_WRITE_FN(v) VSTREAM_CTL_WRITE_FN, CHECK_VAL(VSTREAM_CTL, VSTREAM_RW_FN, (v)) 165 #define CA_VSTREAM_CTL_PATH(v) VSTREAM_CTL_PATH, CHECK_CPTR(VSTREAM_CTL, char, (v)) 166 #define CA_VSTREAM_CTL_DOUBLE VSTREAM_CTL_DOUBLE 167 #define CA_VSTREAM_CTL_READ_FD(v) VSTREAM_CTL_READ_FD, CHECK_VAL(VSTREAM_CTL, int, (v)) 168 #define CA_VSTREAM_CTL_WRITE_FD(v) VSTREAM_CTL_WRITE_FD, CHECK_VAL(VSTREAM_CTL, int, (v)) 169 #define CA_VSTREAM_CTL_WAITPID_FN(v) VSTREAM_CTL_WAITPID_FN, CHECK_VAL(VSTREAM_CTL, VSTREAM_WAITPID_FN, (v)) 170 #define CA_VSTREAM_CTL_TIMEOUT(v) VSTREAM_CTL_TIMEOUT, CHECK_VAL(VSTREAM_CTL, int, (v)) 171 #define CA_VSTREAM_CTL_EXCEPT VSTREAM_CTL_EXCEPT 172 #define CA_VSTREAM_CTL_CONTEXT(v) VSTREAM_CTL_CONTEXT, CHECK_PTR(VSTREAM_CTL, void, (v)) 173 #ifdef F_DUPFD 174 #define CA_VSTREAM_CTL_DUPFD(v) VSTREAM_CTL_DUPFD, CHECK_VAL(VSTREAM_CTL, int, (v)) 175 #endif 176 #define CA_VSTREAM_CTL_BUFSIZE(v) VSTREAM_CTL_BUFSIZE, CHECK_VAL(VSTREAM_CTL, ssize_t, (v)) 177 #define CA_VSTREAM_CTL_SWAP_FD(v) VSTREAM_CTL_SWAP_FD, CHECK_PTR(VSTREAM_CTL, VSTREAM, (v)) 178 #define CA_VSTREAM_CTL_START_DEADLINE VSTREAM_CTL_START_DEADLINE 179 #define CA_VSTREAM_CTL_STOP_DEADLINE VSTREAM_CTL_STOP_DEADLINE 180 181 CHECK_VAL_HELPER_DCL(VSTREAM_CTL, ssize_t); 182 CHECK_VAL_HELPER_DCL(VSTREAM_CTL, int); 183 CHECK_VAL_HELPER_DCL(VSTREAM_CTL, VSTREAM_WAITPID_FN); 184 CHECK_VAL_HELPER_DCL(VSTREAM_CTL, VSTREAM_RW_FN); 185 CHECK_PTR_HELPER_DCL(VSTREAM_CTL, void); 186 CHECK_PTR_HELPER_DCL(VSTREAM_CTL, VSTREAM); 187 CHECK_CPTR_HELPER_DCL(VSTREAM_CTL, char); 188 189 extern VSTREAM *PRINTFLIKE(1, 2) vstream_printf(const char *,...); 190 extern VSTREAM *PRINTFLIKE(2, 3) vstream_fprintf(VSTREAM *, const char *,...); 191 192 extern VSTREAM *vstream_popen(int,...); 193 extern int vstream_pclose(VSTREAM *); 194 195 #define vstream_ispipe(vp) ((vp)->pid != 0) 196 197 /* Legacy API: type-unchecked arguments, internal use. */ 198 #define VSTREAM_POPEN_END 0 /* terminator */ 199 #define VSTREAM_POPEN_COMMAND 1 /* command is string */ 200 #define VSTREAM_POPEN_ARGV 2 /* command is array */ 201 #define VSTREAM_POPEN_UID 3 /* privileges */ 202 #define VSTREAM_POPEN_GID 4 /* privileges */ 203 #define VSTREAM_POPEN_ENV 5 /* extra environment */ 204 #define VSTREAM_POPEN_SHELL 6 /* alternative shell */ 205 #define VSTREAM_POPEN_WAITPID_FN 7 /* child catcher, waitpid() compat. */ 206 #define VSTREAM_POPEN_EXPORT 8 /* exportable environment */ 207 208 /* Safer API: type-checked arguments, external use. */ 209 #define CA_VSTREAM_POPEN_END VSTREAM_POPEN_END 210 #define CA_VSTREAM_POPEN_COMMAND(v) VSTREAM_POPEN_COMMAND, CHECK_CPTR(VSTREAM_PPN, char, (v)) 211 #define CA_VSTREAM_POPEN_ARGV(v) VSTREAM_POPEN_ARGV, CHECK_PPTR(VSTREAM_PPN, char, (v)) 212 #define CA_VSTREAM_POPEN_UID(v) VSTREAM_POPEN_UID, CHECK_VAL(VSTREAM_PPN, uid_t, (v)) 213 #define CA_VSTREAM_POPEN_GID(v) VSTREAM_POPEN_GID, CHECK_VAL(VSTREAM_PPN, gid_t, (v)) 214 #define CA_VSTREAM_POPEN_ENV(v) VSTREAM_POPEN_ENV, CHECK_PPTR(VSTREAM_PPN, char, (v)) 215 #define CA_VSTREAM_POPEN_SHELL(v) VSTREAM_POPEN_SHELL, CHECK_CPTR(VSTREAM_PPN, char, (v)) 216 #define CA_VSTREAM_POPEN_WAITPID_FN(v) VSTREAM_POPEN_WAITPID_FN, CHECK_VAL(VSTREAM_PPN, VSTREAM_WAITPID_FN, (v)) 217 #define CA_VSTREAM_POPEN_EXPORT(v) VSTREAM_POPEN_EXPORT, CHECK_PPTR(VSTREAM_PPN, char, (v)) 218 219 CHECK_VAL_HELPER_DCL(VSTREAM_PPN, uid_t); 220 CHECK_VAL_HELPER_DCL(VSTREAM_PPN, gid_t); 221 CHECK_VAL_HELPER_DCL(VSTREAM_PPN, VSTREAM_WAITPID_FN); 222 CHECK_PPTR_HELPER_DCL(VSTREAM_PPN, char); 223 CHECK_CPTR_HELPER_DCL(VSTREAM_PPN, char); 224 225 extern VSTREAM *vstream_vprintf(const char *, va_list); 226 extern VSTREAM *vstream_vfprintf(VSTREAM *, const char *, va_list); 227 228 extern ssize_t vstream_peek(VSTREAM *); 229 extern ssize_t vstream_bufstat(VSTREAM *, int); 230 231 #define VSTREAM_BST_FLAG_IN (1<<0) 232 #define VSTREAM_BST_FLAG_OUT (1<<1) 233 #define VSTREAM_BST_FLAG_PEND (1<<2) 234 235 #define VSTREAM_BST_MASK_DIR (VSTREAM_BST_FLAG_IN | VSTREAM_BST_FLAG_OUT) 236 #define VSTREAM_BST_IN_PEND (VSTREAM_BST_FLAG_IN | VSTREAM_BST_FLAG_PEND) 237 #define VSTREAM_BST_OUT_PEND (VSTREAM_BST_FLAG_OUT | VSTREAM_BST_FLAG_PEND) 238 239 #define vstream_peek(vp) vstream_bufstat((vp), VSTREAM_BST_IN_PEND) 240 241 extern const char *vstream_peek_data(VSTREAM *); 242 243 /* 244 * Exception handling. We use pointer to jmp_buf to avoid a lot of unused 245 * baggage for streams that don't need this functionality. 246 * 247 * XXX sigsetjmp()/siglongjmp() save and restore the signal mask which can 248 * avoid surprises in code that manipulates signals, but unfortunately some 249 * systems have bugs in their implementation. 250 */ 251 #ifdef NO_SIGSETJMP 252 #define vstream_setjmp(stream) setjmp((stream)->jbuf[0]) 253 #define vstream_longjmp(stream, val) longjmp((stream)->jbuf[0], (val)) 254 #else 255 #define vstream_setjmp(stream) sigsetjmp((stream)->jbuf[0], 1) 256 #define vstream_longjmp(stream, val) siglongjmp((stream)->jbuf[0], (val)) 257 #endif 258 259 /* 260 * Tweaks and workarounds. 261 */ 262 extern int vstream_tweak_sock(VSTREAM *); 263 extern int vstream_tweak_tcp(VSTREAM *); 264 265 #define vstream_flags(stream) ((const int) (stream)->buf.flags) 266 267 /* 268 * Read/write VSTRING memory. 269 */ 270 #define vstream_memopen(string, flags) \ 271 vstream_memreopen((VSTREAM *) 0, (string), (flags)) 272 VSTREAM *vstream_memreopen(VSTREAM *, struct VSTRING *, int); 273 274 /* LICENSE 275 /* .ad 276 /* .fi 277 /* The Secure Mailer license must be distributed with this software. 278 /* AUTHOR(S) 279 /* Wietse Venema 280 /* IBM T.J. Watson Research 281 /* P.O. Box 704 282 /* Yorktown Heights, NY 10598, USA 283 /* 284 /* Wietse Venema 285 /* Google, Inc. 286 /* 111 8th Avenue 287 /* New York, NY 10011, USA 288 /*--*/ 289 290 #endif 291