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
|
#ifndef TARANTOOL_SWIM_TEST_TRANSPORT_H_INCLUDED
#define TARANTOOL_SWIM_TEST_TRANSPORT_H_INCLUDED
/*
* Copyright 2010-2019, Tarantool AUTHORS, please see AUTHORS file.
*
* 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 <COPYRIGHT HOLDER> ``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
* <COPYRIGHT HOLDER> 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.
*/
#include <stdbool.h>
struct ev_loop;
/**
* SWIM test_transport implements a 'fake' file descriptors table
* in user space in order to get the full control over UDP
* sockets, used in core SWIM code. Fake fds are used to provide a
* capability to set necessary loss level, delay, reorders.
*/
/**
* Signature of a packet filter function. It takes packet data,
* arbitrary user data, and should return true, if the packet
* should be dropped. False otherwise. Direction is said via
* @a dir parameter. 0 means incoming packet, 1 means outgoing
* packet, just like standard IO descriptors. Via @a peer_fd
* parameter a sender/receiver descriptor number is passed
* depending on @a dir.
*/
typedef bool (*swim_test_filter_check_f)(const char *data, int size,
void *udata, int dir, int peer_fd);
/**
* Until there are no new IO events, feed EV_WRITE event to all
* opened descriptors; EV_READ to ones, who have not empty recv
* queue; invoke callbacks to process the events. Move packets
* from send to recv queues.
*/
void
swim_test_transport_do_loop_step(struct ev_loop *loop);
/**
* Block a file descriptor so as it can not receive nor send any
* packets.
*/
void
swim_test_transport_block_fd(int fd);
/** Unblock a file descriptor. */
void
swim_test_transport_unblock_fd(int fd);
/**
* Add a filter to the file descriptor @a fd. If a filter with
* the same @a check function exists, then it is deleted and a
* new one is created.
* @param fd File descriptor to add filter to.
* @param check Check function. It is called for each packet and
* should return true, when the packet should be dropped.
* @param udata Arbitrary user data, passed to each @a check
* invocation.
*/
void
swim_test_transport_add_filter(int fd, swim_test_filter_check_f check,
void *udata);
/**
* Remove a filter having @a check function. Works just like the
* core triggers library. The found filter is deleted. If nothing
* is found, then it is not an error.
*/
void
swim_test_transport_remove_filter(int fd, swim_test_filter_check_f check);
/** Initialize test transport system. */
void
swim_test_transport_init(void);
/** Destroy test transport system, free resources. */
void
swim_test_transport_free(void);
#endif /* TARANTOOL_SWIM_TEST_TRANSPORT_H_INCLUDED */
|