]>
git.proxmox.com Git - mirror_frr.git/blob - lib/frr_zmq.c
2 * libzebra ZeroMQ bindings
3 * Copyright (C) 2015 David Lamparter
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * IF YOU MODIFY THIS FILE PLEASE RUN `make check` and ensure that
22 * the test_zmq.c unit test is still working. There are dependancies
23 * between the two that are extremely fragile. My understanding
24 * is that there is specialized ownership of the cb pointer based
25 * upon what is happening. Those assumptions are supposed to be
26 * tested in the test_zmq.c
35 #include "lib_errors.h"
37 DEFINE_MTYPE_STATIC(LIB
, ZEROMQ_CB
, "ZeroMQ callback");
39 /* libzmq's context */
40 void *frrzmq_context
= NULL
;
41 static unsigned frrzmq_initcount
= 0;
43 void frrzmq_init(void)
45 if (frrzmq_initcount
++ == 0) {
46 frrzmq_context
= zmq_ctx_new();
47 zmq_ctx_set(frrzmq_context
, ZMQ_IPV6
, 1);
51 void frrzmq_finish(void)
53 if (--frrzmq_initcount
== 0) {
54 zmq_ctx_term(frrzmq_context
);
55 frrzmq_context
= NULL
;
59 static int frrzmq_read_msg(struct thread
*t
)
61 struct frrzmq_cb
**cbp
= THREAD_ARG(t
);
65 unsigned char read
= 0;
72 if (!cb
|| !cb
->zmqsock
)
76 zmq_pollitem_t polli
= {.socket
= cb
->zmqsock
,
77 .events
= ZMQ_POLLIN
};
78 ret
= zmq_poll(&polli
, 1, 0);
83 if (!(polli
.revents
& ZMQ_POLLIN
))
86 if (cb
->read
.cb_msg
) {
87 cb
->read
.cb_msg(cb
->read
.arg
, cb
->zmqsock
);
90 if (cb
->read
.cancelled
) {
91 frrzmq_check_events(cbp
, &cb
->write
,
93 cb
->read
.thread
= NULL
;
94 if (cb
->write
.cancelled
&& !cb
->write
.thread
)
95 XFREE(MTYPE_ZEROMQ_CB
, cb
);
102 if (zmq_msg_init(&msg
))
105 ret
= zmq_msg_recv(&msg
, cb
->zmqsock
, ZMQ_NOBLOCK
);
115 cb
->read
.cb_part(cb
->read
.arg
, cb
->zmqsock
, &msg
,
117 if (cb
->read
.cancelled
) {
119 frrzmq_check_events(cbp
, &cb
->write
,
121 cb
->read
.thread
= NULL
;
122 if (cb
->write
.cancelled
&& !cb
->write
.thread
)
123 XFREE(MTYPE_ZEROMQ_CB
, cb
);
127 /* cb_part may have read additional parts of the
128 * message; don't use zmq_msg_more here */
129 moresz
= sizeof(more
);
131 ret
= zmq_getsockopt(cb
->zmqsock
, ZMQ_RCVMORE
, &more
,
144 frrzmq_check_events(cbp
, &cb
->write
, ZMQ_POLLOUT
);
146 thread_add_read(t
->master
, frrzmq_read_msg
, cbp
,
147 cb
->fd
, &cb
->read
.thread
);
151 flog_err(EC_LIB_ZMQ
, "ZeroMQ read error: %s(%d)", strerror(errno
),
153 if (cb
->read
.cb_error
)
154 cb
->read
.cb_error(cb
->read
.arg
, cb
->zmqsock
);
158 int _frrzmq_thread_add_read(const struct xref_threadsched
*xref
,
159 struct thread_master
*master
,
160 void (*msgfunc
)(void *arg
, void *zmqsock
),
161 void (*partfunc
)(void *arg
, void *zmqsock
,
162 zmq_msg_t
*msg
, unsigned partnum
),
163 void (*errfunc
)(void *arg
, void *zmqsock
),
164 void *arg
, void *zmqsock
,
165 struct frrzmq_cb
**cbp
)
169 struct frrzmq_cb
*cb
;
173 if (!(msgfunc
|| partfunc
) || (msgfunc
&& partfunc
))
176 if (zmq_getsockopt(zmqsock
, ZMQ_FD
, &fd
, &len
))
178 len
= sizeof(events
);
179 if (zmq_getsockopt(zmqsock
, ZMQ_EVENTS
, &events
, &len
))
185 cb
= XCALLOC(MTYPE_ZEROMQ_CB
, sizeof(struct frrzmq_cb
));
187 cb
->write
.cancelled
= true;
191 cb
->zmqsock
= zmqsock
;
194 cb
->read
.cb_msg
= msgfunc
;
195 cb
->read
.cb_part
= partfunc
;
196 cb
->read
.cb_error
= errfunc
;
197 cb
->read
.cancelled
= false;
199 if (events
& ZMQ_POLLIN
) {
200 thread_cancel(&cb
->read
.thread
);
202 thread_add_event(master
, frrzmq_read_msg
, cbp
, fd
,
205 thread_add_read(master
, frrzmq_read_msg
, cbp
, fd
,
210 static int frrzmq_write_msg(struct thread
*t
)
212 struct frrzmq_cb
**cbp
= THREAD_ARG(t
);
213 struct frrzmq_cb
*cb
;
214 unsigned char written
= 0;
220 if (!cb
|| !cb
->zmqsock
)
224 zmq_pollitem_t polli
= {.socket
= cb
->zmqsock
,
225 .events
= ZMQ_POLLOUT
};
226 ret
= zmq_poll(&polli
, 1, 0);
231 if (!(polli
.revents
& ZMQ_POLLOUT
))
234 if (cb
->write
.cb_msg
) {
235 cb
->write
.cb_msg(cb
->write
.arg
, cb
->zmqsock
);
238 if (cb
->write
.cancelled
) {
239 frrzmq_check_events(cbp
, &cb
->read
, ZMQ_POLLIN
);
240 cb
->write
.thread
= NULL
;
241 if (cb
->read
.cancelled
&& !cb
->read
.thread
)
242 XFREE(MTYPE_ZEROMQ_CB
, cb
);
250 frrzmq_check_events(cbp
, &cb
->read
, ZMQ_POLLIN
);
252 thread_add_write(t
->master
, frrzmq_write_msg
, cbp
,
253 cb
->fd
, &cb
->write
.thread
);
257 flog_err(EC_LIB_ZMQ
, "ZeroMQ write error: %s(%d)", strerror(errno
),
259 if (cb
->write
.cb_error
)
260 cb
->write
.cb_error(cb
->write
.arg
, cb
->zmqsock
);
264 int _frrzmq_thread_add_write(const struct xref_threadsched
*xref
,
265 struct thread_master
*master
,
266 void (*msgfunc
)(void *arg
, void *zmqsock
),
267 void (*errfunc
)(void *arg
, void *zmqsock
),
268 void *arg
, void *zmqsock
, struct frrzmq_cb
**cbp
)
272 struct frrzmq_cb
*cb
;
279 if (zmq_getsockopt(zmqsock
, ZMQ_FD
, &fd
, &len
))
281 len
= sizeof(events
);
282 if (zmq_getsockopt(zmqsock
, ZMQ_EVENTS
, &events
, &len
))
288 cb
= XCALLOC(MTYPE_ZEROMQ_CB
, sizeof(struct frrzmq_cb
));
290 cb
->read
.cancelled
= true;
294 cb
->zmqsock
= zmqsock
;
297 cb
->write
.cb_msg
= msgfunc
;
298 cb
->write
.cb_part
= NULL
;
299 cb
->write
.cb_error
= errfunc
;
300 cb
->write
.cancelled
= false;
302 if (events
& ZMQ_POLLOUT
) {
303 thread_cancel(&cb
->write
.thread
);
305 _thread_add_event(xref
, master
, frrzmq_write_msg
, cbp
, fd
,
308 thread_add_write(master
, frrzmq_write_msg
, cbp
, fd
,
313 void frrzmq_thread_cancel(struct frrzmq_cb
**cb
, struct cb_core
*core
)
317 core
->cancelled
= true;
318 thread_cancel(&core
->thread
);
321 * Looking at this code one would assume that FRR
322 * would want a `!(*cb)->write.thread. This was
323 * attempted in e08165def1c62beee0e87385 but this
324 * change caused `make check` to stop working
325 * which was not noticed because our CI system
326 * does not build with zeromq. Put this back
327 * to the code as written in 2017. e08165de..
328 * was introduced in 2021. So someone was ok
329 * with frrzmq_thread_cancel for 4 years. This will
330 * allow those people doing `make check` to continue
331 * working. In the meantime if the people using
332 * this code see an issue they can fix it
334 if ((*cb
)->read
.cancelled
&& !(*cb
)->read
.thread
335 && (*cb
)->write
.cancelled
&& (*cb
)->write
.thread
)
336 XFREE(MTYPE_ZEROMQ_CB
, *cb
);
339 void frrzmq_check_events(struct frrzmq_cb
**cbp
, struct cb_core
*core
,
342 struct frrzmq_cb
*cb
;
349 if (!cb
|| !cb
->zmqsock
)
352 len
= sizeof(events
);
353 if (zmq_getsockopt(cb
->zmqsock
, ZMQ_EVENTS
, &events
, &len
))
355 if ((events
& event
) && core
->thread
&& !core
->cancelled
) {
356 struct thread_master
*tm
= core
->thread
->master
;
358 thread_cancel(&core
->thread
);
360 if (event
== ZMQ_POLLIN
)
361 thread_add_event(tm
, frrzmq_read_msg
,
362 cbp
, cb
->fd
, &core
->thread
);
364 thread_add_event(tm
, frrzmq_write_msg
,
365 cbp
, cb
->fd
, &core
->thread
);