summaryrefslogtreecommitdiffstats
path: root/contrib/pgcrypto/mbuf.h
blob: 97873c931f913397a6da8e03936917a1e9255720 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
 * mbuf.h
 *		Memory buffer operations.
 *
 * Copyright (c) 2005 Marko Kreen
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *	  notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *	  notice, this list of conditions and the following disclaimer in the
 *	  documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * contrib/pgcrypto/mbuf.h
 */

#ifndef __PX_MBUF_H
#define __PX_MBUF_H

typedef struct MBuf MBuf;
typedef struct PushFilter PushFilter;
typedef struct PullFilter PullFilter;
typedef struct PushFilterOps PushFilterOps;
typedef struct PullFilterOps PullFilterOps;

struct PushFilterOps
{
	/*
	 * should return needed buffer size, 0- no buffering, <0 on error if NULL,
	 * no buffering, and priv=init_arg
	 */
	int			(*init) (PushFilter *next, void *init_arg, void **priv_p);

	/*
	 * send data to next.  should consume all? if null, it will be simply
	 * copied (in-place) returns 0 on error
	 */
	int			(*push) (PushFilter *next, void *priv,
						 const uint8 *src, int len);
	int			(*flush) (PushFilter *next, void *priv);
	void		(*free) (void *priv);
};

struct PullFilterOps
{
	/*
	 * should return needed buffer size, 0- no buffering, <0 on error if NULL,
	 * no buffering, and priv=init_arg
	 */
	int			(*init) (void **priv_p, void *init_arg, PullFilter *src);

	/*
	 * request data from src, put result ptr to data_p can use ptr from src or
	 * use buf as work area if NULL in-place copy
	 */
	int			(*pull) (void *priv, PullFilter *src, int len,
						 uint8 **data_p, uint8 *buf, int buflen);
	void		(*free) (void *priv);
};

/*
 * Memory buffer
 */
MBuf	   *mbuf_create(int len);
MBuf	   *mbuf_create_from_data(uint8 *data, int len);
int			mbuf_avail(MBuf *mbuf);
int			mbuf_size(MBuf *mbuf);
int			mbuf_grab(MBuf *mbuf, int len, uint8 **data_p);
int			mbuf_steal_data(MBuf *mbuf, uint8 **data_p);
int			mbuf_append(MBuf *dst, const uint8 *buf, int len);
int			mbuf_free(MBuf *mbuf);

/*
 * Push filter
 */
int			pushf_create(PushFilter **mp_p, const PushFilterOps *op,
						 void *init_arg, PushFilter *next);
int			pushf_write(PushFilter *mp, const uint8 *data, int len);
void		pushf_free_all(PushFilter *mp);
void		pushf_free(PushFilter *mp);
int			pushf_flush(PushFilter *mp);

int			pushf_create_mbuf_writer(PushFilter **res, MBuf *dst);

/*
 * Pull filter
 */
int			pullf_create(PullFilter **pf_p, const PullFilterOps *op,
						 void *init_arg, PullFilter *src);
int			pullf_read(PullFilter *pf, int len, uint8 **data_p);
int			pullf_read_max(PullFilter *pf, int len,
						   uint8 **data_p, uint8 *tmpbuf);
void		pullf_free(PullFilter *pf);
int			pullf_read_fixed(PullFilter *src, int len, uint8 *dst);

int			pullf_create_mbuf_reader(PullFilter **mp_p, MBuf *src);

#define GETBYTE(pf, dst) \
	do { \
		uint8 __b; \
		int __res = pullf_read_fixed(pf, 1, &__b); \
		if (__res < 0) \
			return __res; \
		(dst) = __b; \
	} while (0)

#endif							/* __PX_MBUF_H */