common/iobuf.c: Rename iobuf_flush and make it a static function.
[gnupg.git] / common / iobuf.h
1 /* iobuf.h - I/O buffer
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003,
3  *               2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * This file is free software; you can redistribute it and/or modify
8  * it under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * This file is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, see <http://www.gnu.org/licenses/>.
29  */
30
31 #ifndef GNUPG_COMMON_IOBUF_H
32 #define GNUPG_COMMON_IOBUF_H
33
34 /* For estream_t.  */
35 #include <gpg-error.h>
36
37 #include "../common/types.h"
38 #include "../common/sysutils.h"
39
40 #define DBG_IOBUF   iobuf_debug_mode
41
42 /* Filter control modes.  */
43 #define IOBUFCTRL_INIT      1
44 #define IOBUFCTRL_FREE      2
45 #define IOBUFCTRL_UNDERFLOW 3
46 #define IOBUFCTRL_FLUSH     4
47 #define IOBUFCTRL_DESC      5
48 #define IOBUFCTRL_CANCEL    6
49 #define IOBUFCTRL_USER      16
50
51
52 /* Command codes for iobuf_ioctl.  */
53 typedef enum
54   {
55     IOBUF_IOCTL_KEEP_OPEN        = 1, /* Uses intval.  */
56     IOBUF_IOCTL_INVALIDATE_CACHE = 2, /* Uses ptrval.  */
57     IOBUF_IOCTL_NO_CACHE         = 3, /* Uses intval.  */
58     IOBUF_IOCTL_FSYNC            = 4  /* Uses ptrval.  */
59   } iobuf_ioctl_t;
60
61 enum
62   {
63     IOBUF_INPUT=1,
64     IOBUF_OUTPUT=2,
65     IOBUF_TEMP=3
66   };
67
68
69 typedef struct iobuf_struct *iobuf_t;
70 typedef struct iobuf_struct *IOBUF;  /* Compatibility with gpg 1.4. */
71
72 /* fixme: we should hide most of this stuff */
73 struct iobuf_struct
74 {
75   /* The type of filter.  Either IOBUF_INPUT, IOBUF_OUTPUT or
76      IOBUF_TEMP.  */
77   int use;
78   off_t nlimit;
79   off_t nbytes;                 /* Used together with nlimit. */
80   off_t ntotal;                 /* Total bytes read (position of stream). */
81
82   /* Whether we need to read from the filter one byte at a time or
83      whether we can do bulk reads.  We need to read one byte at a time
84      if a limit (set via iobuf_set_limit) is active.  */
85   int nofast;
86   struct
87   {
88     size_t size;                /* Allocated size */
89     size_t start;               /* Number of invalid bytes at the
90                                    begin of the buffer */
91     size_t len;                 /* Currently filled to this size */
92     byte *buf;
93   } d;
94
95   int filter_eof;
96   int error;
97   int (*filter) (void *opaque, int control,
98                  iobuf_t chain, byte * buf, size_t * len);
99   void *filter_ov;              /* Value for opaque */
100   int filter_ov_owner;
101   char *real_fname;
102   iobuf_t chain;                /* Next iobuf used for i/o if any
103                                    (passed to filter) */
104   int no, subno;
105 };
106
107 #ifndef EXTERN_UNLESS_MAIN_MODULE
108 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
109 #define EXTERN_UNLESS_MAIN_MODULE extern
110 #else
111 #define EXTERN_UNLESS_MAIN_MODULE
112 #endif
113 #endif
114 EXTERN_UNLESS_MAIN_MODULE int iobuf_debug_mode;
115
116 void iobuf_enable_special_filenames (int yes);
117 int  iobuf_is_pipe_filename (const char *fname);
118 iobuf_t iobuf_alloc (int use, size_t bufsize);
119 iobuf_t iobuf_temp (void);
120 iobuf_t iobuf_temp_with_content (const char *buffer, size_t length);
121 iobuf_t iobuf_open_fd_or_name (gnupg_fd_t fd, const char *fname,
122                                const char *mode);
123 iobuf_t iobuf_open (const char *fname);
124 iobuf_t iobuf_fdopen (int fd, const char *mode);
125 iobuf_t iobuf_fdopen_nc (int fd, const char *mode);
126 iobuf_t iobuf_esopen (estream_t estream, const char *mode, int keep_open);
127 iobuf_t iobuf_sockopen (int fd, const char *mode);
128 iobuf_t iobuf_create (const char *fname, int mode700);
129 iobuf_t iobuf_openrw (const char *fname);
130 int iobuf_ioctl (iobuf_t a, iobuf_ioctl_t cmd, int intval, void *ptrval);
131 int iobuf_close (iobuf_t iobuf);
132 int iobuf_cancel (iobuf_t iobuf);
133
134 int iobuf_push_filter (iobuf_t a, int (*f) (void *opaque, int control,
135                                           iobuf_t chain, byte * buf,
136                                           size_t * len), void *ov);
137 int iobuf_push_filter2 (iobuf_t a,
138                         int (*f) (void *opaque, int control, iobuf_t chain,
139                                   byte * buf, size_t * len), void *ov,
140                         int rel_ov);
141 #define iobuf_set_error(a)    do { (a)->error = 1; } while(0)
142 #define iobuf_error(a)        ((a)->error)
143
144 void iobuf_set_limit (iobuf_t a, off_t nlimit);
145
146 off_t iobuf_tell (iobuf_t a);
147 int iobuf_seek (iobuf_t a, off_t newpos);
148
149 int iobuf_readbyte (iobuf_t a);
150 int iobuf_read (iobuf_t a, void *buf, unsigned buflen);
151 unsigned iobuf_read_line (iobuf_t a, byte ** addr_of_buffer,
152                           unsigned *length_of_buffer, unsigned *max_length);
153 int iobuf_peek (iobuf_t a, byte * buf, unsigned buflen);
154 int iobuf_writebyte (iobuf_t a, unsigned c);
155 int iobuf_write (iobuf_t a, const void *buf, unsigned buflen);
156 int iobuf_writestr (iobuf_t a, const char *buf);
157
158 void iobuf_flush_temp (iobuf_t temp);
159 int iobuf_write_temp (iobuf_t a, iobuf_t temp);
160 size_t iobuf_temp_to_buffer (iobuf_t a, byte * buffer, size_t buflen);
161
162 off_t iobuf_get_filelength (iobuf_t a, int *overflow);
163 #define IOBUF_FILELENGTH_LIMIT 0xffffffff
164 int  iobuf_get_fd (iobuf_t a);
165 const char *iobuf_get_real_fname (iobuf_t a);
166 const char *iobuf_get_fname (iobuf_t a);
167 const char *iobuf_get_fname_nonnull (iobuf_t a);
168
169 void iobuf_set_partial_block_mode (iobuf_t a, size_t len);
170
171 void iobuf_skip_rest (iobuf_t a, unsigned long n, int partial);
172
173
174 /* Get a byte from the iobuf; must check for eof prior to this
175  * function.  This function returns values in the range 0 .. 255 or -1
176  * to indicate EOF.  iobuf_get_noeof() does not return -1 to indicate
177  * EOF, but masks the returned value to be in the range 0 .. 255.
178  */
179 #define iobuf_get(a)  \
180      (  ((a)->nofast || (a)->d.start >= (a)->d.len )?  \
181         iobuf_readbyte((a)) : ( (a)->nbytes++, (a)->d.buf[(a)->d.start++] ) )
182 #define iobuf_get_noeof(a)    (iobuf_get((a))&0xff)
183
184 /* write a byte to the iobuf and return true on write error
185  * This macro does only write the low order byte
186  */
187 #define iobuf_put(a,c)  iobuf_writebyte(a,c)
188
189 #define iobuf_where(a)  "[don't know]"
190 #define iobuf_id(a)     ((a)->no)
191
192 #define iobuf_get_temp_buffer(a) ( (a)->d.buf )
193 #define iobuf_get_temp_length(a) ( (a)->d.len )
194
195 /* Whether the filter uses an in-memory buffer.  */
196 #define iobuf_is_temp(a)         ( (a)->use == IOBUF_TEMP )
197
198 #endif /*GNUPG_COMMON_IOBUF_H*/