diff options
Diffstat (limited to 'fluent-bit/include/fluent-bit/flb_connection.h')
| -rw-r--r-- | fluent-bit/include/fluent-bit/flb_connection.h | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/fluent-bit/include/fluent-bit/flb_connection.h b/fluent-bit/include/fluent-bit/flb_connection.h new file mode 100644 index 00000000..46fd80c4 --- /dev/null +++ b/fluent-bit/include/fluent-bit/flb_connection.h @@ -0,0 +1,184 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ + +/* Fluent Bit + * ========== + * Copyright (C) 2015-2022 The Fluent Bit Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef FLB_CONNECTION_H +#define FLB_CONNECTION_H + +#include <fluent-bit/flb_info.h> +#include <fluent-bit/flb_socket.h> +#include <fluent-bit/flb_config.h> + +#define FLB_UNKNOWN_CONNECTION 0 +#define FLB_UPSTREAM_CONNECTION 1 +#define FLB_DOWNSTREAM_CONNECTION 2 + +/* FLB_CONNECTION_MAX_PORT_LENGTH is the maximum length of + * an unsigned 16 bit integer + */ + +#define FLB_CONNECTION_MAX_PORT_LENGTH 5 + +/* FLB_CONNECTION_MAX_LABEL_LENGTH is the maximum length of + * any of the following variants plus an optional colon if + * the spec includes a port number : + * + * udp:// + * tcp:// + * unix:// + */ +#define FLB_CONNECTION_MAX_LABEL_LENGTH 7 + +#define FLB_CONNECTION_MAX_IPV4_ADDRESS_LENGTH 15 +#define FLB_CONNECTION_MAX_IPV6_ADDRESS_LENGTH 39 +#define FLB_CONNECTION_MAX_UNIX_ADDRESS_LENGTH (11 + 4 + 1) +#define FLB_CONNECTION_MAX_ADDRESS_LENGTH FLB_CONNECTION_MAX_IPV6_ADDRESS_LENGTH + +#define FLB_CONNECTION_MAX_USER_FRIENDLY_ADDRESS_LENGTH \ + (FLB_CONNECTION_MAX_ADDRESS_LENGTH + \ + FLB_CONNECTION_MAX_PORT_LENGTH + \ + FLB_CONNECTION_MAX_LABEL_LENGTH) + +struct flb_net_setup; +struct flb_upstream; +struct flb_downstream; +struct flb_tls_session; + +/* Base network connection */ +struct flb_connection { + struct mk_event event; + + void *user_data; + + /* Socket */ + flb_sockfd_t fd; + + struct sockaddr_storage raw_remote_host; + + char remote_host[FLB_CONNECTION_MAX_ADDRESS_LENGTH + 1]; + unsigned short int remote_port; + + char user_friendly_remote_host[FLB_CONNECTION_MAX_USER_FRIENDLY_ADDRESS_LENGTH + 1]; + + /* Net setup shortcut */ + struct flb_net_setup *net; + + /* + * Custom 'error' for the connection file descriptor. Commonly used to + * specify a reason for an exception that was generated locally: consider + * a connect timeout, we shutdown(2) the connection but in reallity we + * might want to express an 'ETIMEDOUT' + */ + int net_error; + + /* If this flag is set, then destroy_conn will ignore this connection, this + * helps mitigate issues caused by flb_upstream_conn_timeouts marking a connection + * to be dropped and the event loop manager function destroying that connection + * at the end of the cycle while the connection coroutine is still suspended which + * causes the outer functions to access invalid memory when handling the error amongst + * other things. + */ + int busy_flag; + + /* This flag is used to determine if the connection was shut down to ensure we + * don't do it twice when a timeout is detected. + * + * This is required in order to overcome a limitation in the async read / write + * functions that will be addressed as soon as possible. + */ + int shutdown_flag; + + /* + * Recycle: if the connection is keepalive, this flag is always on, but if + * the caller wants to drop the connection once is released, it can set + * recycle to false. + */ + int recycle; + + /* Keepalive */ + int ka_count; /* how many times this connection has been used */ + + /* Timestamps */ + time_t ts_assigned; + time_t ts_created; + time_t ts_available; /* sets the 'start' available time */ + + /* IO activity tracker used to enforce net.io_timeout */ + time_t ts_io_timeout; + + /* Connect */ + time_t ts_connect_start; + time_t ts_connect_timeout; + + /* Event loop */ + struct mk_event_loop *evl; + + /* Parent stream */ + union { + struct flb_stream *stream; + struct flb_upstream *upstream; + struct flb_downstream *downstream; + }; + + /* Coroutine in charge of this connection */ + struct flb_coro *coroutine; + + /* Connection type : FLB_UPSTREAM_CONNECTION or FLB_DOWNSTREAM_CONNECTION */ + int type; + + int dynamically_allocated; + + /* + * Link to list head on the stream, if the connection is busy, + * it's linked to 'busy_queue', otherwise it resides in 'av_queue' + * for upstream connections so it can be used by a plugin or + * 'destroy_queue' awaiting release. + */ + struct mk_list _head; + + /* Each TCP connections using TLS needs a session */ + struct flb_tls_session *tls_session; +}; + +int flb_connection_setup(struct flb_connection *connection, + flb_sockfd_t socket, + int type, + void *stream, + struct mk_event_loop *event_loop, + struct flb_coro *coroutine); + +struct flb_connection *flb_connection_create(flb_sockfd_t socket, + int type, + void *stream, + struct mk_event_loop *event_loop, + struct flb_coro *coroutine); + +void flb_connection_destroy(struct flb_connection *connection); + +void flb_connection_set_remote_host(struct flb_connection *connection, + struct sockaddr *remote_host); +char *flb_connection_get_remote_address(struct flb_connection *connection); + +int flb_connection_get_flags(struct flb_connection *connection); +void flb_connection_reset_connection_timeout(struct flb_connection *connection); +void flb_connection_unset_connection_timeout(struct flb_connection *connection); + +void flb_connection_reset_io_timeout(struct flb_connection *connection); +void flb_connection_unset_io_timeout(struct flb_connection *connection); + +#endif |