diff options
Diffstat (limited to 'include/packet_ring.h')
| -rw-r--r-- | include/packet_ring.h | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/include/packet_ring.h b/include/packet_ring.h new file mode 100644 index 0000000..3ac6b91 --- /dev/null +++ b/include/packet_ring.h @@ -0,0 +1,127 @@ +/*--------------------------------------------------------------- + * Copyright (c) 2019 + * Broadcom Corporation + * All Rights Reserved. + *--------------------------------------------------------------- + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated + * documentation files (the "Software"), to deal in the Software + * without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit + * persons to whom the Software is furnished to do + * so, subject to the following conditions: + * + * + * Redistributions of source code must retain the above + * copyright notice, this list of conditions and + * the following disclaimers. + * + * + * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimers in the documentation and/or other materials + * provided with the distribution. + * + * + * Neither the name of Broadcom Coporation, + * nor the names of its contributors may be used to endorse + * or promote products derived from this Software without + * specific prior written permission. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE CONTIBUTORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, + * ARISING FROM, OUT OF OR IN CONNECTION WITH THE + * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * ________________________________________________________________ + * + * packet_ring.h + * Suppport for packet rings between threads + * + * by Robert J. McMahon (rjmcmahon@rjmcmahon.com, bob.mcmahon@broadcom.com) + * ------------------------------------------------------------------- + */ +#ifndef PACKETRINGC_H +#define PACKETRINGC_H + +#include "Condition.h" +#include "gettcpinfo.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#define ACKRING_DEFAULTSIZE 100 + +struct ReportStruct { + intmax_t packetID; + intmax_t packetLen; + struct timeval packetTime; + struct timeval prevPacketTime; + struct timeval sentTime; + struct timeval prevSentTime; + int errwrite; + int emptyreport; + int l2errors; + int l2len; + int expected_l2len; + // isochStartTime is overloaded: first write timestamp of the frame or burst w/trip-times or very first read w/o trip-times + // reporter calculation will compute latency accordingly + struct timeval isochStartTime; + uint32_t prevframeID; + uint32_t frameID; + uint32_t burstsize; + uint32_t burstperiod; + uint32_t remaining; + int transit_ready; + int writecnt; + long write_time; + bool scheduled; + long sched_err; + struct timeval sentTimeRX; + struct timeval sentTimeTX; + struct iperf_tcpstats tcpstats; +}; + +struct PacketRing { + // producer and consumer + // must be an atomic type, e.g. int + // otherwise reads/write can be torn + int producer; + int consumer; + int maxcount; + int consumerdone; + int awaitcounter; + int mutex_enable; + int bytes; + + // Use a condition variables + // o) awake_producer - producer waits for the consumer thread to + // make space or end (signaled by the consumer) + // o) awake_consumer - signal the consumer thread to to run + // (signaled by the producer) + struct Condition *awake_producer; + struct Condition *awake_consumer; + struct ReportStruct *data; +}; + +extern struct PacketRing * packetring_init(int count, struct Condition *awake_consumer, struct Condition *awake_producer); +extern void packetring_enqueue(struct PacketRing *pr, struct ReportStruct *metapacket); +extern struct ReportStruct *packetring_dequeue(struct PacketRing * pr); +extern void enqueue_ackring(struct PacketRing *pr, struct ReportStruct *metapacket); +extern struct ReportStruct *dequeue_ackring(struct PacketRing * pr); +extern void packetring_free(struct PacketRing *pr); +extern void free_ackring(struct PacketRing *pr); +#ifdef HAVE_THREAD_DEBUG +extern int packetring_getcount(struct PacketRing *pr); +#endif + +#ifdef __cplusplus +} /* end extern "C" */ +#endif + +#endif // PACKETRINGC_H |