Adding upstream version 8.4.4.upstream/8.4.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 103 insertions, 0 deletions

diff --git a/bgpd/bgp_io.h b/bgpd/bgp_io.h
new file mode 100644
index 0000000..75d014f
--- /dev/null
+++ b/bgpd/bgp_io.h
@@ -0,0 +1,103 @@
+/* BGP I/O.
+ * Implements packet I/O in a pthread.
+ * Copyright (C) 2017  Cumulus Networks
+ * Quentin Young
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
+ * MA 02110-1301 USA
+ */
+
+#ifndef _FRR_BGP_IO_H
+#define _FRR_BGP_IO_H
+
+#define BGP_WRITE_PACKET_MAX 64U
+#define BGP_READ_PACKET_MAX  10U
+
+#include "bgpd/bgpd.h"
+#include "frr_pthread.h"
+
+/**
+ * Start function for write thread.
+ *
+ * @param arg - unused
+ */
+extern void *bgp_io_start(void *arg);
+
+/**
+ * Start function for write thread.
+ *
+ * Uninitializes all resources and stops the thread.
+ *
+ * @param result - where to store data result, unused
+ */
+extern int bgp_io_stop(void **result, struct frr_pthread *fpt);
+
+/**
+ * Turns on packet writing for a peer.
+ *
+ * After this function is called, any packets placed on peer->obuf will be
+ * written to peer->fd until no more packets remain.
+ *
+ * Additionally, it becomes unsafe to perform socket actions on peer->fd.
+ *
+ * @param peer - peer to register
+ */
+extern void bgp_writes_on(struct peer *peer);
+
+/**
+ * Turns off packet writing for a peer.
+ *
+ * After this function returns, packets placed on peer->obuf will not be
+ * written to peer->fd by the I/O thread.
+ *
+ * After this function returns it becomes safe to perform socket actions on
+ * peer->fd.
+ *
+ * @param peer - peer to deregister
+ * @param flush - as described
+ */
+extern void bgp_writes_off(struct peer *peer);
+
+/**
+ * Turns on packet reading for a peer.
+ *
+ * After this function is called, any packets received on peer->fd will be read
+ * and copied into the FIFO queue peer->ibuf.
+ *
+ * Additionally, it becomes unsafe to perform socket actions on peer->fd.
+ *
+ * Whenever one or more packets are placed onto peer->ibuf, a task of type
+ * THREAD_EVENT will be placed on the main thread whose handler is
+ *
+ *   bgp_packet.c:bgp_process_packet()
+ *
+ * @param peer - peer to register
+ */
+extern void bgp_reads_on(struct peer *peer);
+
+/**
+ * Turns off packet reading for a peer.
+ *
+ * After this function is called, any packets received on peer->fd will not be
+ * read by the I/O thread.
+ *
+ * After this function returns it becomes safe to perform socket actions on
+ * peer->fd.
+ *
+ * @param peer - peer to deregister
+ */
+extern void bgp_reads_off(struct peer *peer);
+
+#endif /* _FRR_BGP_IO_H */