xref: /minix3/external/bsd/bind/dist/lib/isccc/ccmsg.c (revision 00b67f09dd46474d133c95011a48590a8e8f94c7)
1*00b67f09SDavid van Moolenbroek /*	$NetBSD: ccmsg.c,v 1.4 2014/12/10 04:38:01 christos Exp $	*/
2*00b67f09SDavid van Moolenbroek 
3*00b67f09SDavid van Moolenbroek /*
4*00b67f09SDavid van Moolenbroek  * Portions Copyright (C) 2004, 2005, 2007  Internet Systems Consortium, Inc. ("ISC")
5*00b67f09SDavid van Moolenbroek  * Portions Copyright (C) 2001  Internet Software Consortium.
6*00b67f09SDavid van Moolenbroek  *
7*00b67f09SDavid van Moolenbroek  * Permission to use, copy, modify, and/or distribute this software for any
8*00b67f09SDavid van Moolenbroek  * purpose with or without fee is hereby granted, provided that the above
9*00b67f09SDavid van Moolenbroek  * copyright notice and this permission notice appear in all copies.
10*00b67f09SDavid van Moolenbroek  *
11*00b67f09SDavid van Moolenbroek  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC AND NOMINUM DISCLAIMS ALL
12*00b67f09SDavid van Moolenbroek  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
13*00b67f09SDavid van Moolenbroek  * OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY
14*00b67f09SDavid van Moolenbroek  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15*00b67f09SDavid van Moolenbroek  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16*00b67f09SDavid van Moolenbroek  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17*00b67f09SDavid van Moolenbroek  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18*00b67f09SDavid van Moolenbroek  *
19*00b67f09SDavid van Moolenbroek  * Portions Copyright (C) 2001  Nominum, Inc.
20*00b67f09SDavid van Moolenbroek  *
21*00b67f09SDavid van Moolenbroek  * Permission to use, copy, modify, and/or distribute this software for any
22*00b67f09SDavid van Moolenbroek  * purpose with or without fee is hereby granted, provided that the above
23*00b67f09SDavid van Moolenbroek  * copyright notice and this permission notice appear in all copies.
24*00b67f09SDavid van Moolenbroek  *
25*00b67f09SDavid van Moolenbroek  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC AND NOMINUM DISCLAIMS ALL
26*00b67f09SDavid van Moolenbroek  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
27*00b67f09SDavid van Moolenbroek  * OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY
28*00b67f09SDavid van Moolenbroek  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
29*00b67f09SDavid van Moolenbroek  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
30*00b67f09SDavid van Moolenbroek  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
31*00b67f09SDavid van Moolenbroek  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
32*00b67f09SDavid van Moolenbroek  */
33*00b67f09SDavid van Moolenbroek 
34*00b67f09SDavid van Moolenbroek /* Id: ccmsg.c,v 1.10 2007/08/28 07:20:43 tbox Exp  */
35*00b67f09SDavid van Moolenbroek 
36*00b67f09SDavid van Moolenbroek /*! \file */
37*00b67f09SDavid van Moolenbroek 
38*00b67f09SDavid van Moolenbroek #include <config.h>
39*00b67f09SDavid van Moolenbroek 
40*00b67f09SDavid van Moolenbroek #include <isc/mem.h>
41*00b67f09SDavid van Moolenbroek #include <isc/result.h>
42*00b67f09SDavid van Moolenbroek #include <isc/task.h>
43*00b67f09SDavid van Moolenbroek #include <isc/util.h>
44*00b67f09SDavid van Moolenbroek 
45*00b67f09SDavid van Moolenbroek #include <isccc/events.h>
46*00b67f09SDavid van Moolenbroek #include <isccc/ccmsg.h>
47*00b67f09SDavid van Moolenbroek 
48*00b67f09SDavid van Moolenbroek #define CCMSG_MAGIC		ISC_MAGIC('C', 'C', 'm', 's')
49*00b67f09SDavid van Moolenbroek #define VALID_CCMSG(foo)	ISC_MAGIC_VALID(foo, CCMSG_MAGIC)
50*00b67f09SDavid van Moolenbroek 
51*00b67f09SDavid van Moolenbroek static void recv_length(isc_task_t *, isc_event_t *);
52*00b67f09SDavid van Moolenbroek static void recv_message(isc_task_t *, isc_event_t *);
53*00b67f09SDavid van Moolenbroek 
54*00b67f09SDavid van Moolenbroek 
55*00b67f09SDavid van Moolenbroek static void
recv_length(isc_task_t * task,isc_event_t * ev_in)56*00b67f09SDavid van Moolenbroek recv_length(isc_task_t *task, isc_event_t *ev_in) {
57*00b67f09SDavid van Moolenbroek 	isc_socketevent_t *ev = (isc_socketevent_t *)ev_in;
58*00b67f09SDavid van Moolenbroek 	isc_event_t *dev;
59*00b67f09SDavid van Moolenbroek 	isccc_ccmsg_t *ccmsg = ev_in->ev_arg;
60*00b67f09SDavid van Moolenbroek 	isc_region_t region;
61*00b67f09SDavid van Moolenbroek 	isc_result_t result;
62*00b67f09SDavid van Moolenbroek 
63*00b67f09SDavid van Moolenbroek 	INSIST(VALID_CCMSG(ccmsg));
64*00b67f09SDavid van Moolenbroek 
65*00b67f09SDavid van Moolenbroek 	dev = &ccmsg->event;
66*00b67f09SDavid van Moolenbroek 
67*00b67f09SDavid van Moolenbroek 	if (ev->result != ISC_R_SUCCESS) {
68*00b67f09SDavid van Moolenbroek 		ccmsg->result = ev->result;
69*00b67f09SDavid van Moolenbroek 		goto send_and_free;
70*00b67f09SDavid van Moolenbroek 	}
71*00b67f09SDavid van Moolenbroek 
72*00b67f09SDavid van Moolenbroek 	/*
73*00b67f09SDavid van Moolenbroek 	 * Success.
74*00b67f09SDavid van Moolenbroek 	 */
75*00b67f09SDavid van Moolenbroek 	ccmsg->size = ntohl(ccmsg->size);
76*00b67f09SDavid van Moolenbroek 	if (ccmsg->size == 0) {
77*00b67f09SDavid van Moolenbroek 		ccmsg->result = ISC_R_UNEXPECTEDEND;
78*00b67f09SDavid van Moolenbroek 		goto send_and_free;
79*00b67f09SDavid van Moolenbroek 	}
80*00b67f09SDavid van Moolenbroek 	if (ccmsg->size > ccmsg->maxsize) {
81*00b67f09SDavid van Moolenbroek 		ccmsg->result = ISC_R_RANGE;
82*00b67f09SDavid van Moolenbroek 		goto send_and_free;
83*00b67f09SDavid van Moolenbroek 	}
84*00b67f09SDavid van Moolenbroek 
85*00b67f09SDavid van Moolenbroek 	region.base = isc_mem_get(ccmsg->mctx, ccmsg->size);
86*00b67f09SDavid van Moolenbroek 	region.length = ccmsg->size;
87*00b67f09SDavid van Moolenbroek 	if (region.base == NULL) {
88*00b67f09SDavid van Moolenbroek 		ccmsg->result = ISC_R_NOMEMORY;
89*00b67f09SDavid van Moolenbroek 		goto send_and_free;
90*00b67f09SDavid van Moolenbroek 	}
91*00b67f09SDavid van Moolenbroek 
92*00b67f09SDavid van Moolenbroek 	isc_buffer_init(&ccmsg->buffer, region.base, region.length);
93*00b67f09SDavid van Moolenbroek 	result = isc_socket_recv(ccmsg->sock, &region, 0,
94*00b67f09SDavid van Moolenbroek 				 task, recv_message, ccmsg);
95*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS) {
96*00b67f09SDavid van Moolenbroek 		ccmsg->result = result;
97*00b67f09SDavid van Moolenbroek 		goto send_and_free;
98*00b67f09SDavid van Moolenbroek 	}
99*00b67f09SDavid van Moolenbroek 
100*00b67f09SDavid van Moolenbroek 	isc_event_free(&ev_in);
101*00b67f09SDavid van Moolenbroek 	return;
102*00b67f09SDavid van Moolenbroek 
103*00b67f09SDavid van Moolenbroek  send_and_free:
104*00b67f09SDavid van Moolenbroek 	isc_task_send(ccmsg->task, &dev);
105*00b67f09SDavid van Moolenbroek 	ccmsg->task = NULL;
106*00b67f09SDavid van Moolenbroek 	isc_event_free(&ev_in);
107*00b67f09SDavid van Moolenbroek 	return;
108*00b67f09SDavid van Moolenbroek }
109*00b67f09SDavid van Moolenbroek 
110*00b67f09SDavid van Moolenbroek static void
recv_message(isc_task_t * task,isc_event_t * ev_in)111*00b67f09SDavid van Moolenbroek recv_message(isc_task_t *task, isc_event_t *ev_in) {
112*00b67f09SDavid van Moolenbroek 	isc_socketevent_t *ev = (isc_socketevent_t *)ev_in;
113*00b67f09SDavid van Moolenbroek 	isc_event_t *dev;
114*00b67f09SDavid van Moolenbroek 	isccc_ccmsg_t *ccmsg = ev_in->ev_arg;
115*00b67f09SDavid van Moolenbroek 
116*00b67f09SDavid van Moolenbroek 	(void)task;
117*00b67f09SDavid van Moolenbroek 
118*00b67f09SDavid van Moolenbroek 	INSIST(VALID_CCMSG(ccmsg));
119*00b67f09SDavid van Moolenbroek 
120*00b67f09SDavid van Moolenbroek 	dev = &ccmsg->event;
121*00b67f09SDavid van Moolenbroek 
122*00b67f09SDavid van Moolenbroek 	if (ev->result != ISC_R_SUCCESS) {
123*00b67f09SDavid van Moolenbroek 		ccmsg->result = ev->result;
124*00b67f09SDavid van Moolenbroek 		goto send_and_free;
125*00b67f09SDavid van Moolenbroek 	}
126*00b67f09SDavid van Moolenbroek 
127*00b67f09SDavid van Moolenbroek 	ccmsg->result = ISC_R_SUCCESS;
128*00b67f09SDavid van Moolenbroek 	isc_buffer_add(&ccmsg->buffer, ev->n);
129*00b67f09SDavid van Moolenbroek 	ccmsg->address = ev->address;
130*00b67f09SDavid van Moolenbroek 
131*00b67f09SDavid van Moolenbroek  send_and_free:
132*00b67f09SDavid van Moolenbroek 	isc_task_send(ccmsg->task, &dev);
133*00b67f09SDavid van Moolenbroek 	ccmsg->task = NULL;
134*00b67f09SDavid van Moolenbroek 	isc_event_free(&ev_in);
135*00b67f09SDavid van Moolenbroek }
136*00b67f09SDavid van Moolenbroek 
137*00b67f09SDavid van Moolenbroek void
isccc_ccmsg_init(isc_mem_t * mctx,isc_socket_t * sock,isccc_ccmsg_t * ccmsg)138*00b67f09SDavid van Moolenbroek isccc_ccmsg_init(isc_mem_t *mctx, isc_socket_t *sock, isccc_ccmsg_t *ccmsg) {
139*00b67f09SDavid van Moolenbroek 	REQUIRE(mctx != NULL);
140*00b67f09SDavid van Moolenbroek 	REQUIRE(sock != NULL);
141*00b67f09SDavid van Moolenbroek 	REQUIRE(ccmsg != NULL);
142*00b67f09SDavid van Moolenbroek 
143*00b67f09SDavid van Moolenbroek 	ccmsg->magic = CCMSG_MAGIC;
144*00b67f09SDavid van Moolenbroek 	ccmsg->size = 0;
145*00b67f09SDavid van Moolenbroek 	ccmsg->buffer.base = NULL;
146*00b67f09SDavid van Moolenbroek 	ccmsg->buffer.length = 0;
147*00b67f09SDavid van Moolenbroek 	ccmsg->maxsize = 4294967295U;	/* Largest message possible. */
148*00b67f09SDavid van Moolenbroek 	ccmsg->mctx = mctx;
149*00b67f09SDavid van Moolenbroek 	ccmsg->sock = sock;
150*00b67f09SDavid van Moolenbroek 	ccmsg->task = NULL;			/* None yet. */
151*00b67f09SDavid van Moolenbroek 	ccmsg->result = ISC_R_UNEXPECTED;	/* None yet. */
152*00b67f09SDavid van Moolenbroek 	/*
153*00b67f09SDavid van Moolenbroek 	 * Should probably initialize the event here, but it can wait.
154*00b67f09SDavid van Moolenbroek 	 */
155*00b67f09SDavid van Moolenbroek }
156*00b67f09SDavid van Moolenbroek 
157*00b67f09SDavid van Moolenbroek 
158*00b67f09SDavid van Moolenbroek void
isccc_ccmsg_setmaxsize(isccc_ccmsg_t * ccmsg,unsigned int maxsize)159*00b67f09SDavid van Moolenbroek isccc_ccmsg_setmaxsize(isccc_ccmsg_t *ccmsg, unsigned int maxsize) {
160*00b67f09SDavid van Moolenbroek 	REQUIRE(VALID_CCMSG(ccmsg));
161*00b67f09SDavid van Moolenbroek 
162*00b67f09SDavid van Moolenbroek 	ccmsg->maxsize = maxsize;
163*00b67f09SDavid van Moolenbroek }
164*00b67f09SDavid van Moolenbroek 
165*00b67f09SDavid van Moolenbroek 
166*00b67f09SDavid van Moolenbroek isc_result_t
isccc_ccmsg_readmessage(isccc_ccmsg_t * ccmsg,isc_task_t * task,isc_taskaction_t action,void * arg)167*00b67f09SDavid van Moolenbroek isccc_ccmsg_readmessage(isccc_ccmsg_t *ccmsg,
168*00b67f09SDavid van Moolenbroek 		       isc_task_t *task, isc_taskaction_t action, void *arg)
169*00b67f09SDavid van Moolenbroek {
170*00b67f09SDavid van Moolenbroek 	isc_result_t result;
171*00b67f09SDavid van Moolenbroek 	isc_region_t region;
172*00b67f09SDavid van Moolenbroek 
173*00b67f09SDavid van Moolenbroek 	REQUIRE(VALID_CCMSG(ccmsg));
174*00b67f09SDavid van Moolenbroek 	REQUIRE(task != NULL);
175*00b67f09SDavid van Moolenbroek 	REQUIRE(ccmsg->task == NULL);  /* not currently in use */
176*00b67f09SDavid van Moolenbroek 
177*00b67f09SDavid van Moolenbroek 	if (ccmsg->buffer.base != NULL) {
178*00b67f09SDavid van Moolenbroek 		isc_mem_put(ccmsg->mctx, ccmsg->buffer.base,
179*00b67f09SDavid van Moolenbroek 			    ccmsg->buffer.length);
180*00b67f09SDavid van Moolenbroek 		ccmsg->buffer.base = NULL;
181*00b67f09SDavid van Moolenbroek 		ccmsg->buffer.length = 0;
182*00b67f09SDavid van Moolenbroek 	}
183*00b67f09SDavid van Moolenbroek 
184*00b67f09SDavid van Moolenbroek 	ccmsg->task = task;
185*00b67f09SDavid van Moolenbroek 	ccmsg->action = action;
186*00b67f09SDavid van Moolenbroek 	ccmsg->arg = arg;
187*00b67f09SDavid van Moolenbroek 	ccmsg->result = ISC_R_UNEXPECTED;  /* unknown right now */
188*00b67f09SDavid van Moolenbroek 
189*00b67f09SDavid van Moolenbroek 	ISC_EVENT_INIT(&ccmsg->event, sizeof(isc_event_t), 0, 0,
190*00b67f09SDavid van Moolenbroek 		       ISCCC_EVENT_CCMSG, action, arg, ccmsg,
191*00b67f09SDavid van Moolenbroek 		       NULL, NULL);
192*00b67f09SDavid van Moolenbroek 
193*00b67f09SDavid van Moolenbroek 	region.base = (unsigned char *)&ccmsg->size;
194*00b67f09SDavid van Moolenbroek 	region.length = 4;  /* isc_uint32_t */
195*00b67f09SDavid van Moolenbroek 	result = isc_socket_recv(ccmsg->sock, &region, 0,
196*00b67f09SDavid van Moolenbroek 				 ccmsg->task, recv_length, ccmsg);
197*00b67f09SDavid van Moolenbroek 
198*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS)
199*00b67f09SDavid van Moolenbroek 		ccmsg->task = NULL;
200*00b67f09SDavid van Moolenbroek 
201*00b67f09SDavid van Moolenbroek 	return (result);
202*00b67f09SDavid van Moolenbroek }
203*00b67f09SDavid van Moolenbroek 
204*00b67f09SDavid van Moolenbroek void
isccc_ccmsg_cancelread(isccc_ccmsg_t * ccmsg)205*00b67f09SDavid van Moolenbroek isccc_ccmsg_cancelread(isccc_ccmsg_t *ccmsg) {
206*00b67f09SDavid van Moolenbroek 	REQUIRE(VALID_CCMSG(ccmsg));
207*00b67f09SDavid van Moolenbroek 
208*00b67f09SDavid van Moolenbroek 	isc_socket_cancel(ccmsg->sock, NULL, ISC_SOCKCANCEL_RECV);
209*00b67f09SDavid van Moolenbroek }
210*00b67f09SDavid van Moolenbroek 
211*00b67f09SDavid van Moolenbroek #if 0
212*00b67f09SDavid van Moolenbroek void
213*00b67f09SDavid van Moolenbroek isccc_ccmsg_freebuffer(isccc_ccmsg_t *ccmsg) {
214*00b67f09SDavid van Moolenbroek 	REQUIRE(VALID_CCMSG(ccmsg));
215*00b67f09SDavid van Moolenbroek 
216*00b67f09SDavid van Moolenbroek 	if (ccmsg->buffer.base == NULL)
217*00b67f09SDavid van Moolenbroek 		return;
218*00b67f09SDavid van Moolenbroek 
219*00b67f09SDavid van Moolenbroek 	isc_mem_put(ccmsg->mctx, ccmsg->buffer.base, ccmsg->buffer.length);
220*00b67f09SDavid van Moolenbroek 	ccmsg->buffer.base = NULL;
221*00b67f09SDavid van Moolenbroek 	ccmsg->buffer.length = 0;
222*00b67f09SDavid van Moolenbroek }
223*00b67f09SDavid van Moolenbroek #endif
224*00b67f09SDavid van Moolenbroek 
225*00b67f09SDavid van Moolenbroek void
isccc_ccmsg_invalidate(isccc_ccmsg_t * ccmsg)226*00b67f09SDavid van Moolenbroek isccc_ccmsg_invalidate(isccc_ccmsg_t *ccmsg) {
227*00b67f09SDavid van Moolenbroek 	REQUIRE(VALID_CCMSG(ccmsg));
228*00b67f09SDavid van Moolenbroek 
229*00b67f09SDavid van Moolenbroek 	ccmsg->magic = 0;
230*00b67f09SDavid van Moolenbroek 
231*00b67f09SDavid van Moolenbroek 	if (ccmsg->buffer.base != NULL) {
232*00b67f09SDavid van Moolenbroek 		isc_mem_put(ccmsg->mctx, ccmsg->buffer.base,
233*00b67f09SDavid van Moolenbroek 			    ccmsg->buffer.length);
234*00b67f09SDavid van Moolenbroek 		ccmsg->buffer.base = NULL;
235*00b67f09SDavid van Moolenbroek 		ccmsg->buffer.length = 0;
236*00b67f09SDavid van Moolenbroek 	}
237*00b67f09SDavid van Moolenbroek }
238