/* tcpsrv.c
 *
 * Common code for plain TCP syslog based servers. This is currently being
 * utilized by imtcp and imgssapi.
 *
 * NOTE: this is *not* a generic TCP server, but one for syslog servers. For
 *       generic stream servers, please use ./runtime/strmsrv.c!
 *
 * There are actually two classes within the tcpserver code: one is
 * the tcpsrv itself, the other one is its sessions. This is a helper
 * class to tcpsrv.
 *
 * The common code here calls upon specific functionality by using
 * callbacks. The specialised input modules need to set the proper
 * callbacks before the code is run. The tcpsrv then calls back
 * into the specific input modules at the appropriate time.
 *
 * NOTE: read comments in module-template.h to understand how this file
 *       works!
 *
 * File begun on 2007-12-21 by RGerhards (extracted from syslogd.c[which was
 * licensed under BSD at the time of the rsyslog fork])
 *
 * Copyright 2007-2025 Adiscon GmbH.
 *
 * This file is part of rsyslog.
 *
 * 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
 *       -or-
 *       see COPYING.ASL20 in the source distribution
 *
 * 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.
 */
#include "config.h"
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <stdarg.h>
#include <ctype.h>
#include <limits.h>
#include <netinet/in.h>
#include <netdb.h>
#include <pthread.h>
#include <sys/types.h>
#include <signal.h>
#include <sys/socket.h>
#if HAVE_FCNTL_H
    #include <fcntl.h>
#endif
#if !defined(ENABLE_IMTCP_EPOLL)
    #include <sys/poll.h>
#endif
#include "rsyslog.h"
#include "dirty.h"
#include "cfsysline.h"
#include "module-template.h"
#include "net.h"
#include "srUtils.h"
#include "conf.h"
#include "tcpsrv.h"
#include "obj.h"
#include "glbl.h"
#include "netstrms.h"
#include "netstrm.h"
#include "errmsg.h"
#include "ruleset.h"
#include "ratelimit.h"
#include "unicode-helper.h"
#include "nsd_ptcp.h"


PRAGMA_IGNORE_Wswitch_enum MODULE_TYPE_LIB MODULE_TYPE_NOKEEP;

/* defines */
#define TCPSESS_MAX_DEFAULT 200 /* default for nbr of tcp sessions if no number is given */
#define TCPLSTN_MAX_DEFAULT 20 /* default for nbr of listeners */

/* static data */
DEFobjStaticHelpers;
DEFobjCurrIf(conf);
DEFobjCurrIf(glbl);
DEFobjCurrIf(ruleset);
DEFobjCurrIf(tcps_sess);
DEFobjCurrIf(net);
DEFobjCurrIf(netstrms);
DEFobjCurrIf(netstrm);
DEFobjCurrIf(prop);
DEFobjCurrIf(statsobj);
DEFobjCurrIf(regexp);

#define NSPOLL_MAX_EVENTS_PER_WAIT 128


static void enqueueWork(tcpsrv_io_descr_t *const pioDescr);

/* We check which event notification mechanism we have and use the best available one.
 * We switch back from library-specific drivers, because event notification always works
 * at the socket layer and is conceptually the same. As such, we can reduce code, code
 * complexity, and a bit of runtime overhead by using a compile time selection and
 * abstraction of the event notification mechanism.
 * rgerhards, 2025-01-16
 */
#if defined(ENABLE_IMTCP_EPOLL)

static rsRetVal ATTR_NONNULL() eventNotify_init(tcpsrv_t *const pThis) {
    DEFiRet;
    #if defined(ENABLE_IMTCP_EPOLL) && defined(EPOLL_CLOEXEC) && defined(HAVE_EPOLL_CREATE1)
    DBGPRINTF("tcpsrv uses epoll_create1()\n");
    pThis->evtdata.epoll.efd = epoll_create1(EPOLL_CLOEXEC);
    if (pThis->evtdata.epoll.efd < 0 && errno == ENOSYS)
    #endif
    {
        DBGPRINTF("tcpsrv uses epoll_create()\n");
        pThis->evtdata.epoll.efd = epoll_create(100);
        /* size is ignored in newer kernels, but 100 is not bad... */
    }

    if (pThis->evtdata.epoll.efd < 0) {
        DBGPRINTF("epoll_create1() could not create fd\n");
        ABORT_FINALIZE(RS_RET_IO_ERROR);
    }
finalize_it:
    RETiRet;
}


static rsRetVal ATTR_NONNULL() eventNotify_exit(tcpsrv_t *const pThis) {
    DEFiRet;
    close(pThis->evtdata.epoll.efd);
    RETiRet;
}


/* Modify socket set */
static rsRetVal ATTR_NONNULL()
    epoll_Ctl(tcpsrv_t *const pThis, tcpsrv_io_descr_t *const pioDescr, const int isLstn, const int op) {
    DEFiRet;

    const int id = pioDescr->id;
    const int sock = pioDescr->sock;
    assert(sock >= 0);

    if (op == EPOLL_CTL_ADD) {
        dbgprintf("adding epoll entry %d, socket %d\n", id, sock);
        pioDescr->event.events = EPOLLIN | EPOLLET | EPOLLONESHOT;
        pioDescr->event.data.ptr = (void *)pioDescr;
        if (epoll_ctl(pThis->evtdata.epoll.efd, EPOLL_CTL_ADD, sock, &pioDescr->event) < 0) {
            LogError(errno, RS_RET_ERR_EPOLL_CTL, "epoll_ctl failed on fd %d, isLstn %d\n", sock, isLstn);
        }
    } else if (op == EPOLL_CTL_DEL) {
        dbgprintf("removing epoll entry %d, socket %d\n", id, sock);
        if (epoll_ctl(pThis->evtdata.epoll.efd, EPOLL_CTL_DEL, sock, NULL) < 0) {
            if (errno == EBADF || errno == ENOENT) {
                /* already gone-away, everything is well */
                DBGPRINTF("epoll_ctl: fd %d already removed, isLstn %d", sock, isLstn);
            } else {
                LogError(errno, RS_RET_ERR_EPOLL_CTL, "epoll_ctl failed on fd %d, isLstn %d\n", sock, isLstn);
                ABORT_FINALIZE(RS_RET_ERR_EPOLL_CTL);
            }
        }
    } else {
        dbgprintf("program error: invalid NSDPOLL_mode %d - ignoring request\n", op);
        ABORT_FINALIZE(RS_RET_ERR);
    }

finalize_it:
    DBGPRINTF("Done processing epoll entry %d, iRet %d\n", id, iRet);
    RETiRet;
}


/* Wait for io to become ready. After the successful call, idRdy contains the
 * id set by the caller for that i/o event, ppUsr is a pointer to a location
 * where the user pointer shall be stored.
 * numEntries contains the maximum number of entries on entry and the actual
 * number of entries actually read on exit.
 * rgerhards, 2009-11-18
 */
static rsRetVal ATTR_NONNULL()
    epoll_Wait(tcpsrv_t *const pThis, const int timeout, int *const numEntries, tcpsrv_io_descr_t *pWorkset[]) {
    struct epoll_event event[NSPOLL_MAX_EVENTS_PER_WAIT];
    int nfds;
    int i;
    DEFiRet;

    assert(pWorkset != NULL);

    if (*numEntries > NSPOLL_MAX_EVENTS_PER_WAIT) *numEntries = NSPOLL_MAX_EVENTS_PER_WAIT;
    DBGPRINTF("doing epoll_wait for max %d events\n", *numEntries);
    nfds = epoll_wait(pThis->evtdata.epoll.efd, event, *numEntries, timeout);
    if (nfds == -1) {
        if (errno == EINTR) {
            ABORT_FINALIZE(RS_RET_EINTR);
        } else {
            DBGPRINTF("epoll_wait() returned with error code %d\n", errno);
            ABORT_FINALIZE(RS_RET_ERR_EPOLL);
        }
    } else if (nfds == 0) {
        ABORT_FINALIZE(RS_RET_TIMEOUT);
    }

    /* we got valid events, so tell the caller... */
    DBGPRINTF("epoll_wait returned %d entries\n", nfds);
    for (i = 0; i < nfds; ++i) {
        pWorkset[i] = event[i].data.ptr;
        /* default is no error, on error we terminate, so we need only to set in error case! */
        if (event[i].events & EPOLLERR) {
            ATOMIC_STORE_1_TO_INT(&pWorkset[i]->isInError, &pWorkset[i]->mut_isInError);
        }
    }
    *numEntries = nfds;

finalize_it:
    RETiRet;
}


#else /* no epoll, let's use poll()  ------------------------------------------------------------ */
    #define FDSET_INCREMENT 1024 /* increment for struct pollfds array allocation */


static rsRetVal ATTR_NONNULL() eventNotify_init(tcpsrv_t *const pThis ATTR_UNUSED) {
    return RS_RET_OK;
}


static rsRetVal ATTR_NONNULL() eventNotify_exit(tcpsrv_t *const pThis) {
    DEFiRet;
    free(pThis->evtdata.poll.fds);
    RETiRet;
}


/* Add a socket to the poll set */
static rsRetVal ATTR_NONNULL() poll_Add(tcpsrv_t *const pThis, netstrm_t *const pStrm, const nsdsel_waitOp_t waitOp) {
    DEFiRet;
    int sock;

    CHKiRet(netstrm.GetSock(pStrm, &sock));

    if (pThis->evtdata.poll.currfds == pThis->evtdata.poll.maxfds) {
        struct pollfd *newfds;
        CHKmalloc(newfds = realloc(pThis->evtdata.poll.fds,
                                   sizeof(struct pollfd) * (pThis->evtdata.poll.maxfds + FDSET_INCREMENT)));
        pThis->evtdata.poll.maxfds += FDSET_INCREMENT;
        pThis->evtdata.poll.fds = newfds;
    }

    switch (waitOp) {
        case NSDSEL_RD:
            pThis->evtdata.poll.fds[pThis->evtdata.poll.currfds].events = POLLIN;
            break;
        case NSDSEL_WR:
            pThis->evtdata.poll.fds[pThis->evtdata.poll.currfds].events = POLLOUT;
            break;
        case NSDSEL_RDWR:
            pThis->evtdata.poll.fds[pThis->evtdata.poll.currfds].events = POLLIN | POLLOUT;
            break;
        default:
            break;
    }
    pThis->evtdata.poll.fds[pThis->evtdata.poll.currfds].fd = sock;
    ++pThis->evtdata.poll.currfds;

finalize_it:
    RETiRet;
}


/* perform the poll()  piNumReady returns how many descriptors are ready for IO
 */
static rsRetVal ATTR_NONNULL() poll_Poll(tcpsrv_t *const pThis, int *const piNumReady) {
    DEFiRet;

    assert(piNumReady != NULL);

    /* Output debug first*/
    if (Debug) {
        dbgprintf("calling poll, active fds (%d): ", pThis->evtdata.poll.currfds);
        for (uint32_t i = 0; i <= pThis->evtdata.poll.currfds; ++i) dbgprintf("%d ", pThis->evtdata.poll.fds[i].fd);
        dbgprintf("\n");
    }
    assert(pThis->evtdata.poll.currfds >= 1);

    /* now do the select */
    *piNumReady = poll(pThis->evtdata.poll.fds, pThis->evtdata.poll.currfds, -1);
    if (*piNumReady < 0) {
        if (errno == EINTR) {
            DBGPRINTF("tcpsrv received EINTR\n");
        } else {
            LogMsg(errno, RS_RET_POLL_ERR, LOG_WARNING,
                   "ndssel_ptcp: poll system call failed, may cause further troubles");
        }
        *piNumReady = 0;
    }

    RETiRet;
}


/* check if a socket is ready for IO */
static rsRetVal ATTR_NONNULL()
    poll_IsReady(tcpsrv_t *const pThis, netstrm_t *const pStrm, const nsdsel_waitOp_t waitOp, int *const pbIsReady) {
    DEFiRet;
    int sock;

    CHKiRet(netstrm.GetSock(pStrm, &sock));

    uint32_t idx;
    for (idx = 0; idx < pThis->evtdata.poll.currfds; ++idx) {
        if (pThis->evtdata.poll.fds[idx].fd == sock) break;
    }
    if (idx >= pThis->evtdata.poll.currfds) {
        LogMsg(0, RS_RET_INTERNAL_ERROR, LOG_ERR, "ndssel_ptcp: could not find socket %d which should be present",
               sock);
        ABORT_FINALIZE(RS_RET_INTERNAL_ERROR);
    }

    const short revent = pThis->evtdata.poll.fds[idx].revents;
    if (revent & POLLNVAL) {
        DBGPRINTF("ndssel_ptcp: revent & POLLNVAL is TRUE, we had a race, ignoring, revent = %d", revent);
        *pbIsReady = 0;
    }
    switch (waitOp) {
        case NSDSEL_RD:
            *pbIsReady = revent & POLLIN;
            break;
        case NSDSEL_WR:
            *pbIsReady = revent & POLLOUT;
            break;
        case NSDSEL_RDWR:
            *pbIsReady = revent & (POLLIN | POLLOUT);
            break;
        default:
            break;
    }

finalize_it:
    RETiRet;
}

#endif /* event notification compile time selection */

static void freeLstnParams(tcpLstnParams_t *cnf_params) {
    if (cnf_params == NULL) {
        return;
    }

    if (cnf_params->pInputName != NULL) {
        prop.Destruct(&cnf_params->pInputName);
    }
    free((void *)cnf_params->pszInputName);
    free((void *)cnf_params->pszPort);
    free((void *)cnf_params->pszAddr);
    free((void *)cnf_params->pszLstnPortFileName);
    free((void *)cnf_params->pszNetworkNamespace);
    free((void *)cnf_params->pszStrmDrvrName);
    free((void *)cnf_params->pszStartRegex);
    free((void *)cnf_params->pszRatelimitName);
    free(cnf_params);
}


/* add new listener port to listener port list
 * rgerhards, 2009-05-21
 */
static rsRetVal ATTR_NONNULL() addNewLstnPort(tcpsrv_t *const pThis, tcpLstnParams_t *const cnf_params) {
    tcpLstnPortList_t *pEntry;
    uchar statname[64];
    DEFiRet;

    ISOBJ_TYPE_assert(pThis, tcpsrv);

    /* create entry */
    CHKmalloc(pEntry = (tcpLstnPortList_t *)calloc(1, sizeof(tcpLstnPortList_t)));
    pEntry->cnf_params = cnf_params;

    strcpy((char *)pEntry->cnf_params->dfltTZ, (char *)pThis->dfltTZ);
    pEntry->cnf_params->bSPFramingFix = pThis->bSPFramingFix;
    pEntry->cnf_params->bPreserveCase = pThis->bPreserveCase;
    pEntry->pSrv = pThis;

#ifdef FEATURE_REGEXP
    if (cnf_params->pszStartRegex != NULL) {
        if (glbl.GetMaxLine(runConf) > (INT_MAX - 1) / 2) {
            LogError(0, RS_RET_ERR,
                     "imtcp: framing.delimiter.regex requires maxMessageSize <= %d to avoid session buffer overflow",
                     (INT_MAX - 1) / 2);
            ABORT_FINALIZE(RS_RET_ERR);
        }
        const int errcode = regexp.regcomp(&pEntry->start_preg, (char *)cnf_params->pszStartRegex, REG_EXTENDED);
        if (errcode != 0) {
            char errbuff[512];
            regexp.regerror(errcode, &pEntry->start_preg, errbuff, sizeof(errbuff));
            LogError(0, RS_RET_ERR, "imtcp: error in framing.delimiter.regex expansion: %s", errbuff);
            ABORT_FINALIZE(RS_RET_ERR);
        }
        pEntry->bHasStartRegex = 1;
    }
#else
    if (cnf_params->pszStartRegex != NULL) {
        LogError(0, RS_RET_ERR, "imtcp: framing.delimiter.regex set, but regexp support not available");
        ABORT_FINALIZE(RS_RET_ERR);
    }
#endif

    /* support statistics gathering */
    if (pEntry->cnf_params->pszRatelimitName != NULL) {
        CHKiRet(ratelimitNewFromConfig(&(pEntry->ratelimiter), runConf, (char *)pEntry->cnf_params->pszRatelimitName,
                                       "tcpsrv", NULL));
    } else {
        CHKiRet(ratelimitNew(&(pEntry->ratelimiter), "tcpsrv", NULL));
        ratelimitSetLinuxLike(pEntry->ratelimiter, pThis->ratelimitInterval, pThis->ratelimitBurst);
    }
    ratelimitSetThreadSafe(pEntry->ratelimiter);
    CHKiRet(statsobj.Construct(&(pEntry->stats)));
    snprintf((char *)statname, sizeof(statname), "%s(%s)", cnf_params->pszInputName, cnf_params->pszPort);
    statname[sizeof(statname) - 1] = '\0'; /* just to be on the save side... */
    CHKiRet(statsobj.SetName(pEntry->stats, statname));
    CHKiRet(statsobj.SetOrigin(pEntry->stats, pThis->pszOrigin));
    STATSCOUNTER_INIT(pEntry->ctrSubmit, pEntry->mutCtrSubmit);
    CHKiRet(statsobj.AddCounter(pEntry->stats, UCHAR_CONSTANT("submitted"), ctrType_IntCtr, CTR_FLAG_RESETTABLE,
                                &(pEntry->ctrSubmit)));
    CHKiRet(statsobj.ConstructFinalize(pEntry->stats));

    /* all OK - add to list */
    pEntry->pNext = pThis->pLstnPorts;
    pThis->pLstnPorts = pEntry;

finalize_it:
    if (iRet != RS_RET_OK) {
        if (pEntry != NULL) {
            if (pEntry->ratelimiter != NULL) {
                ratelimitDestruct(pEntry->ratelimiter);
            }
            if (pEntry->stats != NULL) {
                statsobj.Destruct(&pEntry->stats);
            }
#ifdef FEATURE_REGEXP
            if (pEntry->bHasStartRegex) {
                regexp.regfree(&pEntry->start_preg);
            }
#endif
            free(pEntry);
        }
    }

    RETiRet;
}


/* configure TCP listener settings.
 * Note: pszPort is handed over to us - the caller MUST NOT free it!
 * rgerhards, 2008-03-20
 */
static rsRetVal ATTR_NONNULL() configureTCPListen(tcpsrv_t *const pThis, tcpLstnParams_t *const cnf_params) {
    assert(cnf_params->pszPort != NULL);
    int i;
    sbool added = 0;
    DEFiRet;

    ISOBJ_TYPE_assert(pThis, tcpsrv);

    /* extract port */
    const uchar *pPort = cnf_params->pszPort;
    i = 0;
    while (isdigit((int)*pPort)) {
        i = i * 10 + *pPort++ - '0';
    }

    if (i >= 0 && i <= 65535) {
        CHKiRet(addNewLstnPort(pThis, cnf_params));
        added = 1;
    } else {
        LogError(0, NO_ERRCODE, "Invalid TCP listen port %s - ignored.\n", cnf_params->pszPort);
    }

finalize_it:
    if (iRet != RS_RET_OK || !added) {
        freeLstnParams(cnf_params);
    }
    RETiRet;
}


/* Initialize the session table
 * returns 0 if OK, somewhat else otherwise
 */
static rsRetVal ATTR_NONNULL() TCPSessTblInit(tcpsrv_t *const pThis) {
    DEFiRet;

    ISOBJ_TYPE_assert(pThis, tcpsrv);
    assert(pThis->pSessions == NULL);

    DBGPRINTF("Allocating buffer for %d TCP sessions.\n", pThis->iSessMax);
    if ((pThis->pSessions = (tcps_sess_t **)calloc(pThis->iSessMax, sizeof(tcps_sess_t *))) == NULL) {
        DBGPRINTF("Error: TCPSessInit() could not alloc memory for TCP session table.\n");
        ABORT_FINALIZE(RS_RET_OUT_OF_MEMORY);
    }

finalize_it:
    RETiRet;
}


/* find a free spot in the session table. If the table
 * is full, -1 is returned, else the index of the free
 * entry (0 or higher).
 */
static int ATTR_NONNULL() TCPSessTblFindFreeSpot(tcpsrv_t *const pThis) {
    register int i;

    ISOBJ_TYPE_assert(pThis, tcpsrv);

    for (i = 0; i < pThis->iSessMax; ++i) {
        if (pThis->pSessions[i] == NULL) break;
    }

    return ((i < pThis->iSessMax) ? i : -1);
}


#if !defined(ENABLE_IMTCP_EPOLL)
/* Get the next session index. Free session tables entries are
 * skipped. This function is provided the index of the last
 * session entry, or -1 if no previous entry was obtained. It
 * returns the index of the next session or -1, if there is no
 * further entry in the table. Please note that the initial call
 * might as well return -1, if there is no session at all in the
 * session table.
 */
static int ATTR_NONNULL() TCPSessGetNxtSess(tcpsrv_t *pThis, const int iCurr) {
    register int i;

    ISOBJ_TYPE_assert(pThis, tcpsrv);
    assert(pThis->pSessions != NULL);
    for (i = iCurr + 1; i < pThis->iSessMax; ++i) {
        if (pThis->pSessions[i] != NULL) break;
    }

    return ((i < pThis->iSessMax) ? i : -1);
}
#endif


/* De-Initialize TCP listener sockets.
 * This function deinitializes everything, including freeing the
 * session table. No TCP listen receive operations are permitted
 * unless the subsystem is reinitialized.
 * rgerhards, 2007-06-21
 */
static void ATTR_NONNULL() deinit_tcp_listener(tcpsrv_t *const pThis) {
    int i;
    tcpLstnPortList_t *pEntry;
    tcpLstnPortList_t *pDel;

    ISOBJ_TYPE_assert(pThis, tcpsrv);

    if (pThis->pSessions != NULL) {
#if !defined(ENABLE_IMTCP_EPOLL)
        /* close all TCP connections! */
        i = TCPSessGetNxtSess(pThis, -1);
        while (i != -1) {
            tcps_sess.Destruct(&pThis->pSessions[i]);
            /* now get next... */
            i = TCPSessGetNxtSess(pThis, i);
        }
#endif

        /* we are done with the session table - so get rid of it...  */
        free(pThis->pSessions);
        pThis->pSessions = NULL; /* just to make sure... */
    }

    /* free list of tcp listen ports */
    pEntry = pThis->pLstnPorts;
    while (pEntry != NULL) {
#ifdef FEATURE_REGEXP
        if (pEntry->bHasStartRegex) {
            regexp.regfree(&pEntry->start_preg);
        }
#endif
        freeLstnParams(pEntry->cnf_params);
        ratelimitDestruct(pEntry->ratelimiter);
        statsobj.Destruct(&(pEntry->stats));
        pDel = pEntry;
        pEntry = pEntry->pNext;
        free(pDel);
    }

    /* finally close our listen streams */
    for (i = 0; i < pThis->iLstnCurr; ++i) {
        netstrm.Destruct(pThis->ppLstn + i);
    }
}


/* add a listen socket to our listen socket array. This is a callback
 * invoked from the netstrm class. -- rgerhards, 2008-04-23
 */
static rsRetVal ATTR_NONNULL() addTcpLstn(void *pUsr, netstrm_t *const pLstn) {
    tcpLstnPortList_t *pPortList = (tcpLstnPortList_t *)pUsr;
    tcpsrv_t *pThis = pPortList->pSrv;
    DEFiRet;

    ISOBJ_TYPE_assert(pThis, tcpsrv);
    ISOBJ_TYPE_assert(pLstn, netstrm);

    if (pThis->iLstnCurr >= pThis->iLstnMax) ABORT_FINALIZE(RS_RET_MAX_LSTN_REACHED);

    pThis->ppLstn[pThis->iLstnCurr] = pLstn;
    pThis->ppLstnPort[pThis->iLstnCurr] = pPortList;
    ++pThis->iLstnCurr;

finalize_it:
    RETiRet;
}


/* Initialize TCP listener socket for a single port
 * Note: at this point, TLS vs. non-TLS does not matter; TLS params are
 * set on connect!
 * rgerhards, 2009-05-21
 */
static rsRetVal ATTR_NONNULL() initTCPListener(tcpsrv_t *pThis, tcpLstnPortList_t *pPortEntry) {
    DEFiRet;

    ISOBJ_TYPE_assert(pThis, tcpsrv);
    assert(pPortEntry != NULL);

    CHKiRet(netstrm.LstnInit(pThis->pNS, (void *)pPortEntry, addTcpLstn, pThis->iSessMax, pPortEntry->cnf_params));

finalize_it:
    RETiRet;
}


/* Initialize TCP sockets (for listener) and listens on them */
static rsRetVal ATTR_NONNULL() create_tcp_socket(tcpsrv_t *const pThis) {
    DEFiRet;
    rsRetVal localRet;
    tcpLstnPortList_t *pEntry;

    ISOBJ_TYPE_assert(pThis, tcpsrv);

    /* init all configured ports */
    pEntry = pThis->pLstnPorts;
    while (pEntry != NULL) {
        localRet = initTCPListener(pThis, pEntry);
        if (localRet != RS_RET_OK) {
            char *ns = pEntry->cnf_params->pszNetworkNamespace;

            LogError(
                0, localRet,
                "Could not create tcp listener, ignoring port "
                "%s bind-address %s%s%s.",
                (pEntry->cnf_params->pszPort == NULL) ? "**UNSPECIFIED**" : (const char *)pEntry->cnf_params->pszPort,
                (pEntry->cnf_params->pszAddr == NULL) ? "**UNSPECIFIED**" : (const char *)pEntry->cnf_params->pszAddr,
                (ns == NULL) ? "" : " namespace ", (ns == NULL) ? "" : ns);
        }
        pEntry = pEntry->pNext;
    }

    /* OK, we had success. Now it is also time to
     * initialize our connections
     */
    if (TCPSessTblInit(pThis) != 0) {
        /* OK, we are in some trouble - we could not initialize the
         * session table, so we can not continue. We need to free all
         * we have assigned so far, because we can not really use it...
         */
        LogError(0, RS_RET_ERR,
                 "Could not initialize TCP session table, suspending TCP "
                 "message reception.");
        ABORT_FINALIZE(RS_RET_ERR);
    }

finalize_it:
    RETiRet;
}


/* Accept new TCP connection; make entry in session table. If there
 * is no more space left in the connection table, the new TCP
 * connection is immediately dropped.
 * ppSess has a pointer to the newly created session, if it succeeds.
 * If it does not succeed, no session is created and ppSess is
 * undefined. If the user has provided an OnSessAccept Callback,
 * this one is executed immediately after creation of the
 * session object, so that it can do its own initialization.
 * rgerhards, 2008-03-02
 */
static ATTR_NONNULL() rsRetVal SessAccept(tcpsrv_t *const pThis,
                                          tcpLstnPortList_t *const pLstnInfo,
                                          tcps_sess_t **ppSess,
                                          int *const piSessIdx,
                                          netstrm_t *pStrm,
                                          char *const connInfo) {
    DEFiRet;
    tcps_sess_t *pSess = NULL;
    netstrm_t *pNewStrm = NULL;
    const tcpLstnParams_t *const cnf_params = pLstnInfo->cnf_params;
    int iSess = -1;
    struct sockaddr_storage *addr;
    uchar *fromHostFQDN = NULL;
    prop_t *fromHostIP = NULL;
    prop_t *fromHostPort = NULL;
    const char *fromHostNameStr = "(hostname unknown)";
    const char *fromHostIPStr = "(IP unknown)";
    const char *fromHostPortStr = "(port unknown)";

    ISOBJ_TYPE_assert(pThis, tcpsrv);
    assert(pLstnInfo != NULL);
    assert(piSessIdx != NULL);

    CHKiRet(netstrm.AcceptConnReq(pStrm, &pNewStrm, connInfo));

    /* Add to session list */
    iSess = TCPSessTblFindFreeSpot(pThis);
    if (iSess == -1) {
        errno = 0;
        LogError(0, RS_RET_MAX_SESS_REACHED, "too many tcp sessions - dropping incoming request");
        ABORT_FINALIZE(RS_RET_MAX_SESS_REACHED);
    }

    if (pThis->bUseKeepAlive) {
        CHKiRet(netstrm.SetKeepAliveProbes(pNewStrm, pThis->iKeepAliveProbes));
        CHKiRet(netstrm.SetKeepAliveTime(pNewStrm, pThis->iKeepAliveTime));
        CHKiRet(netstrm.SetKeepAliveIntvl(pNewStrm, pThis->iKeepAliveIntvl));
        CHKiRet(netstrm.EnableKeepAlive(pNewStrm));
    }

    /* we found a free spot and can construct our session object */
    if (pThis->gnutlsPriorityString != NULL) {
        CHKiRet(netstrm.SetGnutlsPriorityString(pNewStrm, pThis->gnutlsPriorityString));
    }
    CHKiRet(tcps_sess.Construct(&pSess));
    CHKiRet(tcps_sess.SetTcpsrv(pSess, pThis));
    CHKiRet(tcps_sess.SetLstnInfo(pSess, pLstnInfo));
    if (pThis->OnMsgReceive != NULL) CHKiRet(tcps_sess.SetOnMsgReceive(pSess, pThis->OnMsgReceive));

    /* get the host name */
    CHKiRet(netstrm.GetRemoteHName(pNewStrm, &fromHostFQDN));
    fromHostNameStr = szStrOrDefault(fromHostFQDN, "(hostname unknown)");
    if (!cnf_params->bPreserveCase) {
        /* preserve_case = off */
        uchar *p;
        for (p = fromHostFQDN; *p; p++) {
            if (isupper((int)*p)) {
                *p = tolower((int)*p);
            }
        }
    }
    CHKiRet(netstrm.GetRemoteIP(pNewStrm, &fromHostIP));
    fromHostIPStr = propGetSzStrOrDefault(fromHostIP, "(IP unknown)");
    CHKiRet(netstrm.GetRemAddr(pNewStrm, &addr));
    char portbuf[8];
    uint16_t port;
    if (addr->ss_family == AF_INET)
        port = ntohs(((struct sockaddr_in *)addr)->sin_port);
    else if (addr->ss_family == AF_INET6)
        port = ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
    else
        port = 0;
    snprintf(portbuf, sizeof(portbuf), "%u", port);
    CHKiRet(prop.Construct(&fromHostPort));
    CHKiRet(prop.SetString(fromHostPort, (uchar *)portbuf, strlen(portbuf)));
    CHKiRet(prop.ConstructFinalize(fromHostPort));
    fromHostPortStr = propGetSzStrOrDefault(fromHostPort, "(port unknown)");
    /* Here we check if a host is permitted to send us messages. If it isn't, we do not further
     * process the message but log a warning (if we are configured to do this).
     * rgerhards, 2005-09-26
     */
    if (!pThis->pIsPermittedHost((struct sockaddr *)addr, (char *)fromHostFQDN, pThis->pUsr, pSess->pUsr)) {
        DBGPRINTF("%s is not an allowed sender\n", fromHostFQDN);
        if (glbl.GetOptionDisallowWarning(runConf)) {
            errno = 0;
            LogError(0, RS_RET_HOST_NOT_PERMITTED,
                     "connection request from disallowed "
                     "sender %s (%s:%s) discarded",
                     fromHostNameStr, fromHostIPStr, fromHostPortStr);
        }
        ABORT_FINALIZE(RS_RET_HOST_NOT_PERMITTED);
    }

    /* OK, we have an allowed sender, so let's continue, what
     * means we can finally fill in the session object.
     */
    CHKiRet(tcps_sess.SetHost(pSess, fromHostFQDN));
    fromHostFQDN = NULL; /* we handed this string over */
    fromHostNameStr = propGetSzStrOrDefault(pSess->fromHost, "(hostname unknown)");
    CHKiRet(tcps_sess.SetHostIP(pSess, fromHostIP));
    fromHostIPStr = propGetSzStrOrDefault(pSess->fromHostIP, "(IP unknown)");
    fromHostIP = NULL;
    CHKiRet(tcps_sess.SetHostPort(pSess, fromHostPort));
    fromHostPortStr = propGetSzStrOrDefault(pSess->fromHostPort, "(port unknown)");
    fromHostPort = NULL;
    CHKiRet(tcps_sess.SetStrm(pSess, pNewStrm));
    pNewStrm = NULL; /* prevent it from being freed in error handler, now done in tcps_sess! */
    CHKiRet(tcps_sess.SetMsgIdx(pSess, 0));
    CHKiRet(tcps_sess.ConstructFinalize(pSess));

    /* check if we need to call our callback */
    if (pThis->pOnSessAccept != NULL) {
        CHKiRet(pThis->pOnSessAccept(pThis, pSess, connInfo));
    }

    *ppSess = pSess;
    pThis->pSessions[iSess] = pSess;
    *piSessIdx = iSess;
    pSess = NULL; /* this is now also handed over */

    if (pThis->bEmitMsgOnOpen) {
        LogMsg(0, RS_RET_NO_ERRCODE, LOG_INFO, "imtcp: connection established with host: %s (%s:%s)", fromHostNameStr,
               fromHostIPStr, fromHostPortStr);
    }

finalize_it:
    if (iRet != RS_RET_OK) {
        if (iRet != RS_RET_HOST_NOT_PERMITTED && pThis->bEmitMsgOnOpen) {
            LogError(0, NO_ERRCODE,
                     "imtcp: connection could not be "
                     "established with host: %s (%s:%s)",
                     fromHostNameStr, fromHostIPStr, fromHostPortStr);
        }
        if (pSess != NULL) tcps_sess.Destruct(&pSess);
        if (pNewStrm != NULL) netstrm.Destruct(&pNewStrm);
        if (fromHostIP != NULL) prop.Destruct(&fromHostIP);
        if (fromHostPort != NULL) prop.Destruct(&fromHostPort);
        free(fromHostFQDN);
    }

    RETiRet;
}


/**
 * \brief Close a TCP session and release associated resources.
 *
 * Closes the session referenced by \p pioDescr, runs the module-specific
 * close hook, and updates the event notification set. On EPOLL builds the
 * I/O descriptor is heap-allocated and is freed here after best-effort
 * removal from the epoll set.
 *
 * No locking is performed; callers are responsible for any required
 * mutex handling before/after this call.
 *
 * \param[in] pThis    Server instance.
 * \param[in] pioDescr I/O descriptor for the session to close
 *                     (pioDescr->ptrType == NSD_PTR_TYPE_SESS).
 *
 * \pre  \p pioDescr and its \c pSess are valid.
 * \post The session object is destroyed. On EPOLL builds, \p pioDescr is
 *       freed; on non-EPOLL builds, the session table entry is cleared.
 * \post Callers must not access \p pioDescr or \c pSess after return.
 *
 * \note epoll removal is performed on a best-effort basis; teardown proceeds
 *       regardless of epoll_ctl outcome.
 *
 * \retval RS_RET_OK
 */
static ATTR_NONNULL() rsRetVal closeSess(tcpsrv_t *const pThis, tcpsrv_io_descr_t *const pioDescr) {
    DEFiRet;
    assert(pioDescr->ptrType == NSD_PTR_TYPE_SESS);
    tcps_sess_t *pSess = pioDescr->ptr.pSess;

#if defined(ENABLE_IMTCP_EPOLL)
    /* note: we do not check the result of epoll_Ctl because we cannot do
     * anything against a failure BUT we need to do the cleanup in any case.
     */
    epoll_Ctl(pThis, pioDescr, 0, EPOLL_CTL_DEL);
#endif
    assert(pThis->pOnRegularClose != NULL);
    pThis->pOnRegularClose(pSess);

    tcps_sess.Destruct(&pSess);
    pThis->pSessions[pioDescr->id] = NULL;
#if defined(ENABLE_IMTCP_EPOLL)
    /* in epoll mode, pioDescr is dynamically allocated */
    DESTROY_ATOMIC_HELPER_MUT(pioDescr->mut_isInError);
    free(pioDescr);
#endif
    RETiRet;
}


/**
 * @brief Re-arm EPOLLONESHOT for this session’s descriptor.
 *
 * Uses EPOLL_CTL_MOD to (re)register the descriptor for the next I/O event,
 * selecting EPOLLIN or EPOLLOUT from `pioDescr->ioDirection` and always
 * enabling `EPOLLET | EPOLLONESHOT`. The epoll user data is set to the
 * given `pioDescr` so the same descriptor is delivered on the next event.
 *
 * @pre  `pioDescr` is valid; `pioDescr->sock` and
 *       `pioDescr->pSrv->evtdata.epoll.efd` refer to open fds.
 * @pre  `pioDescr->ioDirection` ∈ { `NSDSEL_RD`, `NSDSEL_WR` }.
 * @pre  Called by the thread that owns the descriptor (no concurrent epoll_ctl).
 *
 * @post On success, the descriptor is armed for the next edge-triggered event.
 *       On failure, the previous epoll registration remains unchanged.
 *
 * @param[in] pioDescr  I/O descriptor to (re)arm.
 * @retval RS_RET_OK               on success.
 * @retval RS_RET_ERR_EPOLL_CTL    on epoll_ctl failure (error is logged).
 *
 * @note Compiled only when ENABLE_IMTCP_EPOLL is defined.
 */
#if defined(ENABLE_IMTCP_EPOLL)
static ATTR_NONNULL() rsRetVal rearmIoEvent(tcpsrv_io_descr_t *const pioDescr) {
    DEFiRet;

    /* Debug-only invariants */
    assert(pioDescr->ioDirection == NSDSEL_RD || pioDescr->ioDirection == NSDSEL_WR);
    assert(pioDescr->pSrv != NULL && pioDescr->pSrv->evtdata.epoll.efd >= 0);
    assert(pioDescr->sock >= 0);

    const uint32_t waitIOEvent = (pioDescr->ioDirection == NSDSEL_WR) ? EPOLLOUT : EPOLLIN;
    struct epoll_event event = {.events = waitIOEvent | EPOLLET | EPOLLONESHOT, .data = {.ptr = pioDescr}};
    if (epoll_ctl(pioDescr->pSrv->evtdata.epoll.efd, EPOLL_CTL_MOD, pioDescr->sock, &event) < 0) {
        LogError(errno, RS_RET_ERR_EPOLL_CTL, "epoll_ctl failed re-arm socket %d", pioDescr->sock);
        ABORT_FINALIZE(RS_RET_ERR_EPOLL_CTL);
    }

finalize_it:
    RETiRet;
}
#endif


/**
 * @brief Receive and dispatch data for a TCP session with starvation control and EPOLL re-arm.
 *
 * Flow:
 *  - Read via pThis->pRcvData(), forward to tcps_sess.DataRcvd().
 *  - Starvation: after `starvationMaxReads`, enqueue `pioDescr` (handoff) and return (no re-arm).
 *  - Would-block (RS_RET_RETRY): re-arm EPOLLONESHOT and return.
 *  - Close/error: exit the loop and close the session after unlocking.
 *
 * Locking:
 *  - If workQueue.numWrkr > 1, this function locks `pSess->mut` on entry and always unlocks
 *    before return (including close/error and starvation/handoff paths).
 *  - **Re-arm timing:** on the would-block path, `rearmIoEvent(pioDescr)` is called *before*
 *    unlocking `pSess->mut` to keep ownership until the EPOLL_CTL_MOD completes.
 *  - `closeSess()` is called *after* unlocking.
 *
 * Starvation accounting:
 *  - `read_calls` counts only successful reads (RS_RET_OK), so the cap reflects actual data
 *    consumption, not retries/closures/errors.
 *
 * @pre  `pioDescr`, `pioDescr->ptr.pSess`, and `pioDescr->pSrv` are valid; I/O is non-blocking.
 * @post On close paths, both `pioDescr` and `pSess` are invalid on return.
 */
static rsRetVal ATTR_NONNULL(1)
    doReceive(tcpsrv_io_descr_t *const pioDescr, tcpsrvWrkrData_t *const wrkrData ATTR_UNUSED) {
    char buf[128 * 1024]; /* reception buffer - may hold a partial or multiple messages */
    ssize_t iRcvd;
    rsRetVal localRet;
    DEFiRet;
    int oserr = 0;
    unsigned read_calls = 0;
    tcps_sess_t *const pSess = pioDescr->ptr.pSess;
    tcpsrv_t *const pThis = pioDescr->pSrv;
    const unsigned maxReads = pThis->starvationMaxReads;

    ISOBJ_TYPE_assert(pThis, tcpsrv);
    const char *const peerIP = propGetSzStrOrDefault(pSess->fromHostIP, "(IP unknown)");
    const char *const peerPort = propGetSzStrOrDefault(pSess->fromHostPort, "(port unknown)");
    DBGPRINTF("netstream %p with new data from remote peer %s:%s\n", (pSess)->pStrm, peerIP, peerPort);

    if (pThis->workQueue.numWrkr > 1) {
        pthread_mutex_lock(&pSess->mut);
    }

    /* explicit state machine */
    enum RecvState { RS_READING, RS_STARVATION, RS_DONE_REARM, RS_DONECLOSE, RS_DONE_HANDOFF };
    enum RecvState state = RS_READING;

#if defined(ENABLE_IMTCP_EPOLL)
    /* If we had EPOLLERR, log additional info; processing continues. */
    if (ATOMIC_FETCH_32BIT(&pioDescr->isInError, &pioDescr->mut_isInError)) {
        ATOMIC_STORE_0_TO_INT(&pioDescr->isInError, &pioDescr->mut_isInError);
        int error = 0;
        socklen_t len = sizeof(error);
        const int sock = pioDescr->sock;
        if (getsockopt(sock, SOL_SOCKET, SO_ERROR, &error, &len) == 0) {
            LogError(error, RS_RET_IO_ERROR, "epoll subsystem signaled EPOLLERR for stream %p, peer %s:%s",
                     (pSess)->pStrm, peerIP, peerPort);
        }
    }
#endif

    /* Sanity (debug builds): I/O direction must be valid. */
    assert(pioDescr->ioDirection == NSDSEL_RD || pioDescr->ioDirection == NSDSEL_WR);

    /* Loop while in non-terminal states (positive check for readability). */
    while (state == RS_READING || state == RS_STARVATION) {
        switch (state) {
            case RS_READING:
                /* maxReads==0 is intentional and documented: it disables starvation protection. */
                while (state == RS_READING && (maxReads == 0 || read_calls < maxReads)) {
                    iRet = pThis->pRcvData(pSess, buf, sizeof(buf), &iRcvd, &oserr, &pioDescr->ioDirection);

                    switch (iRet) {
                        case RS_RET_CLOSED:
                            if (pThis->bEmitMsgOnClose) {
                                errno = 0;
                                LogError(0, RS_RET_PEER_CLOSED_CONN,
                                         "Netstream session %p closed by remote peer %s:%s.", (pSess)->pStrm, peerIP,
                                         peerPort);
                            }
                            state = RS_DONECLOSE;
                            break;

                        case RS_RET_RETRY:
#if defined(ENABLE_IMTCP_EPOLL)
                            if (pThis->workQueue.numWrkr > 1 && read_calls == 0) {
                                STATSCOUNTER_ADD(wrkrData->ctrEmptyRead, wrkrData->mutCtrEmptyRead, 1);
                            }
#endif
                            state = RS_DONE_REARM; /* would block → exit and re-arm */
                            break;

                        case RS_RET_OK:
                            /* Successful read counts toward starvation cap */
                            if (pThis->workQueue.numWrkr > 1) {
                                ++read_calls;
                            }
                            localRet = tcps_sess.DataRcvd(pSess, buf, iRcvd);
                            if (localRet != RS_RET_OK && localRet != RS_RET_QUEUE_FULL) {
                                LogError(oserr, localRet, "Tearing down TCP Session from %s:%s", peerIP, peerPort);
                                state = RS_DONECLOSE;
                            }
                            break;

                        default:
                            LogError(oserr, iRet, "netstream session %p from %s:%s will be closed due to error",
                                     pSess->pStrm, peerIP, peerPort);
                            state = RS_DONECLOSE;
                            break;
                    }
                }

                if (state == RS_READING) {
                    state = RS_STARVATION; /* hit the read cap */
                }
                break;

            case RS_STARVATION:
                dbgprintf("starvation avoidance triggered, ctr=%u, maxReads=%u\n", read_calls, maxReads);
                assert(pThis->workQueue.numWrkr > 1);
#if defined(ENABLE_IMTCP_EPOLL)
                STATSCOUNTER_INC(wrkrData->ctrStarvation, wrkrData->mutCtrStarvation);
#endif
                enqueueWork(pioDescr);
                state = RS_DONE_HANDOFF; /* queued behind existing work → exit, no re-arm */
                break;

            default:
                assert(0 && "unhandled RecvState inside doReceive loop");
                state = RS_DONECLOSE;
                break;
        }
    }

    /* Postcondition: we must have transitioned to a terminal state. */
    assert(state == RS_DONE_REARM || state == RS_DONECLOSE || state == RS_DONE_HANDOFF);

#if defined(ENABLE_IMTCP_EPOLL)
    if (pThis->workQueue.numWrkr > 1) {
        STATSCOUNTER_ADD(wrkrData->ctrRead, wrkrData->mutCtrRead, read_calls);
    }
    if (state == RS_DONE_REARM) {
        rearmIoEvent(pioDescr); /* re-arm while still holding pSess->mut */
    }
#endif

    if (pThis->workQueue.numWrkr > 1) {
        pthread_mutex_unlock(&pSess->mut);
    }

    if (state == RS_DONECLOSE) {
        closeSess(pThis, pioDescr); /* also frees pioDescr in epoll builds */
    }

    RETiRet;
}


/* This function processes a single incoming connection */
static rsRetVal ATTR_NONNULL(1) doSingleAccept(tcpsrv_io_descr_t *const pioDescr) {
    tcps_sess_t *pNewSess = NULL;
    tcpsrv_io_descr_t *pDescrNew = NULL;
    const int idx = pioDescr->id;
    int iSess = -1;
    tcpsrv_t *const pThis = pioDescr->pSrv;
    char connInfo[TCPSRV_CONNINFO_SIZE] = "\0";
    DEFiRet;

    DBGPRINTF("New connect on NSD %p.\n", pThis->ppLstn[idx]);
    iRet = SessAccept(pThis, pThis->ppLstnPort[idx], &pNewSess, &iSess, pThis->ppLstn[idx], connInfo);
    if (iRet == RS_RET_NO_MORE_DATA) {
        goto no_more_data;
    }

    if (iRet == RS_RET_OK) {
#if defined(ENABLE_IMTCP_EPOLL)
        /* pDescrNew is only dyn allocated in epoll mode! */
        CHKmalloc(pDescrNew = (tcpsrv_io_descr_t *)calloc(1, sizeof(tcpsrv_io_descr_t)));
        pDescrNew->pSrv = pThis;
        pDescrNew->id = iSess;
        pDescrNew->isInError = 0;
        INIT_ATOMIC_HELPER_MUT(pDescrNew->mut_isInError);
        pDescrNew->ptrType = NSD_PTR_TYPE_SESS;
        pDescrNew->ioDirection = NSDSEL_RD;
        CHKiRet(netstrm.GetSock(pNewSess->pStrm, &pDescrNew->sock));
        pDescrNew->ptr.pSess = pNewSess;
        CHKiRet(epoll_Ctl(pThis, pDescrNew, 0, EPOLL_CTL_ADD));
#endif

        DBGPRINTF("New session created with NSD %p.\n", pNewSess);
    } else {
        DBGPRINTF("tcpsrv: error %d during accept\n", iRet);
    }

#if defined(ENABLE_IMTCP_EPOLL)
finalize_it:
#endif
    if (iRet != RS_RET_OK) {
        const tcpLstnParams_t *cnf_params = pThis->ppLstnPort[idx]->cnf_params;
        LogError(0, iRet,
                 "tcpsrv listener (inputname: '%s') failed "
                 "to process incoming connection %s with error %d",
                 (cnf_params->pszInputName == NULL) ? (uchar *)"*UNSET*" : cnf_params->pszInputName, connInfo, iRet);
        if (pDescrNew != NULL) {
            DESTROY_ATOMIC_HELPER_MUT(pDescrNew->mut_isInError);
            free(pDescrNew);
        }
        srSleep(0, 20000); /* Sleep 20ms */
    }
no_more_data:
    RETiRet;
}


/* This function processes all pending accepts on this fd */
static rsRetVal ATTR_NONNULL(1)
    doAccept(tcpsrv_io_descr_t *const pioDescr, tcpsrvWrkrData_t *const wrkrData ATTR_UNUSED) {
    DEFiRet;
    int bRun = 1;
    int nAccept = 0;

    while (bRun) {
        iRet = doSingleAccept(pioDescr);
        if (iRet != RS_RET_OK) {
            bRun = 0;
        }
        ++nAccept;
    }
#if defined(ENABLE_IMTCP_EPOLL)
    if (pioDescr->pSrv->workQueue.numWrkr > 1) {
        STATSCOUNTER_ADD(wrkrData->ctrAccept, wrkrData->mutCtrAccept, nAccept);
    }
    rearmIoEvent(pioDescr); /* listeners must ALWAYS be re-armed */
#endif

    RETiRet;
}


/* process a single workset item */
static rsRetVal ATTR_NONNULL(1)
    processWorksetItem(tcpsrv_io_descr_t *const pioDescr, tcpsrvWrkrData_t *const wrkrData ATTR_UNUSED) {
    DEFiRet;

    DBGPRINTF("tcpsrv: processing item %d, socket %d\n", pioDescr->id, pioDescr->sock);
    if (pioDescr->ptrType == NSD_PTR_TYPE_LSTN) {
        iRet = doAccept(pioDescr, wrkrData);
    } else {
        iRet = doReceive(pioDescr, wrkrData);
    }

    RETiRet;
}


/* work queue functions */

static void ATTR_NONNULL() * wrkr(void *arg); /* forward-def of wrkr */

/**
 * @brief Start the worker thread pool for tcpsrv (best-effort, single-path cleanup).
 *
 * @details
 *  This function allocates worker arrays, initializes synchronization primitives,
 *  and spawns `workQueue.numWrkr` threads running `wrkr()`.
 *
 *  ### Why all cleanup happens in `finalize_it`
 *  This routine runs during initialization. If we fail here, the process is very
 *  likely unable to run successfully anyway. To keep the code robust and
 *  maintainable as more CHKiRet checks are added over time, we centralize **all**
 *  rollback into the single `finalize_it` block:
 *
 *   - guarantees a single, well-tested teardown path
 *   - avoids fragile “partial cleanups” spread across multiple branches
 *   - tolerates partial initialization (some threads created, some not; mutex/cond
 *     initialized or not), destroying only what actually succeeded
 *   - ignores secondary errors from pthread_*destroy/cancel/join — this is an
 *     extreme error path and best-effort cleanup is sufficient
 *
 *  ### Thread cancellation model
 *  If any threads were created before failure, we call `pthread_cancel()` and then
 *  `pthread_join()` on each. Worker threads block in `pthread_cond_wait()` which is
 *  a POSIX cancellation point, so cancellation is reliable here.
 *
 *  @param pThis Server instance (must have `workQueue.numWrkr > 1`).
 *  @retval RS_RET_OK on success; error code on failure (resources cleaned up).
 */
static rsRetVal ATTR_NONNULL() startWrkrPool(tcpsrv_t *const pThis) {
    DEFiRet;
    workQueue_t *const queue = &pThis->workQueue;
    int mut_initialized = 0;
    int cond_initialized = 0;
    unsigned created = 0;

    assert(queue->numWrkr > 1);

    /* Initialize queue state first. */
    queue->head = NULL;
    queue->tail = NULL;

    /* Allocate arrays. */
    CHKmalloc(queue->wrkr_tids = calloc(queue->numWrkr, sizeof(pthread_t)));
    CHKmalloc(queue->wrkr_data = calloc(queue->numWrkr, sizeof(tcpsrvWrkrData_t)));

    /* Init sync primitives. */
    if (pthread_mutex_init(&queue->mut, NULL) != 0) {
        ABORT_FINALIZE(RS_RET_ERR);
    }
    mut_initialized = 1;

    if (pthread_cond_init(&queue->workRdy, NULL) != 0) {
        ABORT_FINALIZE(RS_RET_ERR);
    }
    cond_initialized = 1;

    /* Spawn workers. */
    pThis->currWrkrs = 0;
    for (unsigned i = 0; i < queue->numWrkr; ++i) {
        if (pthread_create(&queue->wrkr_tids[i], &default_thread_attr, wrkr, pThis) != 0) {
            iRet = RS_RET_ERR;
            break;
        }
        ++created;
    }

finalize_it:
    if (iRet != RS_RET_OK) {
        /* Best-effort rollback in strict reverse order of construction. */

        /* If any threads were created, cancel and join them. */
        if (created > 0) {
            for (unsigned i = 0; i < created; ++i) {
                (void)pthread_cancel(queue->wrkr_tids[i]); /* cond_wait is a cancellation point */
            }
            for (unsigned i = 0; i < created; ++i) {
                (void)pthread_join(queue->wrkr_tids[i], NULL);
            }
        }

        /* Destroy sync primitives IFF they were successfully initialized. */
        if (cond_initialized) {
            (void)pthread_cond_destroy(&queue->workRdy);
        }
        if (mut_initialized) {
            (void)pthread_mutex_destroy(&queue->mut);
        }

        /* Free arrays (they might be NULL if allocation failed early). */
        free(queue->wrkr_tids);
        free(queue->wrkr_data);
        queue->wrkr_tids = NULL;
        queue->wrkr_data = NULL;
    }

    RETiRet;
}

/**
 * @brief Safely stops the worker thread pool.
 *
 * This function can be called multiple times or in partial-init states.
 * It checks preconditions and only performs cleanup operations that are safe.
 */
static void ATTR_NONNULL() stopWrkrPool(tcpsrv_t *const pThis) {
    workQueue_t *const queue = &pThis->workQueue;

    /* Guard against being called when pool was never started or already stopped. */
    if (queue->numWrkr <= 1 || queue->wrkr_tids == NULL) {
        return;
    }

    /* Signal all workers to wake and exit. */
    pthread_mutex_lock(&queue->mut);
    pthread_cond_broadcast(&queue->workRdy);
    pthread_mutex_unlock(&queue->mut);

    /* Wait for all worker threads to finish. */
    for (unsigned i = 0; i < queue->numWrkr; i++) {
        pthread_join(queue->wrkr_tids[i], NULL);
    }

    /* Free allocated resources. */
    free(queue->wrkr_tids);
    free(queue->wrkr_data);

    /* Destroy synchronization primitives. */
    pthread_mutex_destroy(&queue->mut);
    pthread_cond_destroy(&queue->workRdy);

    queue->wrkr_tids = NULL;
    queue->wrkr_data = NULL;
}

static tcpsrv_io_descr_t ATTR_NONNULL() * dequeueWork(tcpsrv_t *pSrv) {
    workQueue_t *const queue = &pSrv->workQueue;
    tcpsrv_io_descr_t *pioDescr;

    pthread_mutex_lock(&queue->mut);
    while ((queue->head == NULL) && !glbl.GetGlobalInputTermState()) {
        pthread_cond_wait(&queue->workRdy, &queue->mut);
    }

    if (queue->head == NULL) {
        pioDescr = NULL;
        goto finalize_it;
    }

    pioDescr = queue->head;
    queue->head = pioDescr->next;
    if (queue->head == NULL) {
        queue->tail = NULL;
    }
finalize_it:
    pthread_mutex_unlock(&queue->mut);
    return pioDescr;
}

/**
 * @brief Queue a ready I/O descriptor for worker processing (best-effort).
 *
 * Appends @p pioDescr to the work FIFO and signals one worker. Performs its
 * own locking; callers must not hold workQueue::mut. No epoll re-arm is done here.
 *
 * Intent:
 *  - File-local helper for starvation/handoff paths.
 *  - Best-effort, side-effect only; no return value. In debug builds you may assert
 *    on obvious misuse, but callers do not recover here.
 *
 * Threading & Ownership:
 *  - Thread-safe; may be called from the event loop or a worker.
 *  - Stores a non-owning pointer; @p pioDescr must remain valid until a worker
 *    dequeues it.
 *
 * Preconditions:
 *  - @p pioDescr != NULL and @p pioDescr->pSrv != NULL.
 *  - Multi-thread mode active (workQueue.numWrkr > 1).
 *
 * Postconditions:
 *  - @p pioDescr is placed at the queue tail and one worker is signaled.
 */
static void ATTR_NONNULL() enqueueWork(tcpsrv_io_descr_t *const pioDescr) {
    workQueue_t *const queue = &pioDescr->pSrv->workQueue;

    pthread_mutex_lock(&queue->mut);
    pioDescr->next = NULL;
    if (queue->tail == NULL) {
        assert(queue->head == NULL);
        queue->head = pioDescr;
    } else {
        queue->tail->next = pioDescr;
    }
    queue->tail = pioDescr;

    pthread_cond_signal(&queue->workRdy);
    pthread_mutex_unlock(&queue->mut);
}

/* Worker thread function */
static void ATTR_NONNULL() * wrkr(void *arg) {
    tcpsrv_t *const pThis = (tcpsrv_t *)arg;
    workQueue_t *const queue = &pThis->workQueue;
    tcpsrv_io_descr_t *pioDescr;

    pthread_mutex_lock(&queue->mut);
    const int wrkrIdx = pThis->currWrkrs++;
    pthread_mutex_unlock(&queue->mut);
    int deinit_stats = 0;
    rsRetVal localRet;

    tcpsrvWrkrData_t *const wrkrData = &(queue->wrkr_data[wrkrIdx]);

    uchar shortThrdName[16];
    snprintf((char *)shortThrdName, sizeof(shortThrdName), "w%d/%s", wrkrIdx,
             (pThis->pszInputName == NULL) ? (uchar *)"tcpsrv" : pThis->pszInputName);
    uchar thrdName[32];
    snprintf((char *)thrdName, sizeof(thrdName), "w%d/%s", wrkrIdx,
             (pThis->pszInputName == NULL) ? (uchar *)"tcpsrv" : pThis->pszInputName);
    dbgSetThrdName(thrdName);

    /* set thread name - we ignore if it fails, has no harsh consequences... */
#if defined(HAVE_PRCTL) && defined(PR_SET_NAME)
    if (prctl(PR_SET_NAME, thrdName, 0, 0, 0) != 0) {
        DBGPRINTF("prctl failed, not setting thread name for '%s'\n", thrdName);
    }
#elif defined(HAVE_PTHREAD_SETNAME_NP)
    #if defined(__APPLE__)
    /* The macOS variant takes only the thread name and returns an int. */
    int r = pthread_setname_np((char *)shortThrdName);
    if (r != 0) {
        DBGPRINTF("pthread_setname_np failed, not setting thread name for '%s'\n", shortThrdName);
    }
    #elif defined(__FreeBSD__)
    /* FreeBSD variant has a void return type. */
    pthread_setname_np(pthread_self(), (char *)shortThrdName);
    #elif defined(__NetBSD__)
    /* NetBSD variant takes a format string and returns an int. */
    int r = pthread_setname_np(pthread_self(), "%s", (void *)shortThrdName);
    if (r != 0) {
        DBGPRINTF("pthread_setname_np failed, not setting thread name for '%s'\n", shortThrdName);
    }
    #else
    /* The glibc variant takes thread ID and name, and returns an int. */
    int r = pthread_setname_np(pthread_self(), (char *)shortThrdName);
    if (r != 0) {
        DBGPRINTF("pthread_setname_np failed, not setting thread name for '%s'\n", shortThrdName);
    }
    #endif
#endif

    if ((localRet = statsobj.Construct(&wrkrData->stats)) == RS_RET_OK) {
        statsobj.SetName(wrkrData->stats, thrdName);
        statsobj.SetOrigin(wrkrData->stats, (uchar *)"imtcp");

        STATSCOUNTER_INIT(wrkrData->ctrRuns, wrkrData->mutCtrRuns);
        statsobj.AddCounter(wrkrData->stats, UCHAR_CONSTANT("runs"), ctrType_IntCtr, CTR_FLAG_RESETTABLE,
                            &(wrkrData->ctrRuns));

        STATSCOUNTER_INIT(wrkrData->ctrRead, wrkrData->mutCtrRead);
        statsobj.AddCounter(wrkrData->stats, UCHAR_CONSTANT("read"), ctrType_IntCtr, CTR_FLAG_RESETTABLE,
                            &(wrkrData->ctrRead));

        STATSCOUNTER_INIT(wrkrData->ctrEmptyRead, wrkrData->mutCtrEmptyRead);
        statsobj.AddCounter(wrkrData->stats, UCHAR_CONSTANT("emptyread"), ctrType_IntCtr, CTR_FLAG_RESETTABLE,
                            &(wrkrData->ctrEmptyRead));

        STATSCOUNTER_INIT(wrkrData->ctrStarvation, wrkrData->mutCtrStarvation);
        statsobj.AddCounter(wrkrData->stats, UCHAR_CONSTANT("starvation_protect"), ctrType_IntCtr, CTR_FLAG_RESETTABLE,
                            &(wrkrData->ctrStarvation));

        STATSCOUNTER_INIT(wrkrData->ctrAccept, wrkrData->mutCtrAccept);
        statsobj.AddCounter(wrkrData->stats, UCHAR_CONSTANT("accept"), ctrType_IntCtr, CTR_FLAG_RESETTABLE,
                            &(wrkrData->ctrAccept));

        statsobj.ConstructFinalize(wrkrData->stats);
        deinit_stats = 1;
    } else {
        LogMsg(errno, localRet, LOG_WARNING,
               "tcpsrv worker %s could not create statistics "
               "counter. Thus, this worker does not provide them. Processing "
               "is otherwise unaffected",
               thrdName);
    }

    /**** main loop ****/
    while (1) {
        pioDescr = dequeueWork(pThis);
        if (pioDescr == NULL) {
            break;
        }

        /* note: we ignore the result as we cannot do anything against errors in any
         * case. Also, errors are reported inside processWorksetItem().
         */
        processWorksetItem(pioDescr, wrkrData);
        STATSCOUNTER_ADD(wrkrData->ctrRuns, wrkrData->mutCtrRuns, 1);
    }

    /**** de-init ****/
    if (deinit_stats) {
        statsobj.Destruct(&wrkrData->stats);
    }

    return NULL;
}


/* Process a workset, that is handle io. We become activated
 * from either poll or epoll handler. We split the workload
 * out to a pool of threads, but try to avoid context switches
 * as much as possible.
 */
static rsRetVal ATTR_NONNULL() processWorkset(const int numEntries, tcpsrv_io_descr_t *const pioDescr[]) {
    int i;
    assert(numEntries > 0);
    const unsigned numWrkr = pioDescr[0]->pSrv->workQueue.numWrkr; /* pSrv is always the same! */
    DEFiRet;

    DBGPRINTF("tcpsrv: ready to process %d event entries\n", numEntries);

    for (i = 0; i < numEntries; ++i) {
        if (numWrkr == 1) {
            /* we process all on this thread, no need for context switch */
            processWorksetItem(pioDescr[i], NULL);
        } else {
            enqueueWork(pioDescr[i]);
        }
    }
    RETiRet;
}


#if !defined(ENABLE_IMTCP_EPOLL)
/* This function is called to gather input.
 */
PRAGMA_DIAGNOSTIC_PUSH
PRAGMA_IGNORE_Wempty_body static ATTR_NONNULL() rsRetVal RunPoll(tcpsrv_t *const pThis) {
    DEFiRet;
    int nfds;
    int i;
    int iWorkset;
    int iTCPSess;
    int bIsReady;
    tcpsrv_io_descr_t *pWorkset[NSPOLL_MAX_EVENTS_PER_WAIT];
    tcpsrv_io_descr_t workset[NSPOLL_MAX_EVENTS_PER_WAIT];
    const int sizeWorkset = sizeof(workset) / sizeof(tcpsrv_io_descr_t);
    rsRetVal localRet;

    ISOBJ_TYPE_assert(pThis, tcpsrv);
    DBGPRINTF("tcpsrv uses poll() [ex-select()] interface\n");

    /* init the workset pointers, they will remain fixed */
    for (i = 0; i < sizeWorkset; ++i) {
        pWorkset[i] = workset + i;
    }

    /* we init the fd set with "constant" data and only later on add the sessions.
     * Note: further optimization would be to keep the sessions as long as possible,
     * but this is currently not considered worth the effort as non-epoll platforms
     * become really rare. 2025-02-25 RGerhards
     */
    pThis->evtdata.poll.maxfds = FDSET_INCREMENT;

    /* we need to alloc one pollfd more, because the list must be 0-terminated! */
    CHKmalloc(pThis->evtdata.poll.fds = calloc(FDSET_INCREMENT + 1, sizeof(struct pollfd)));
    /* Add the TCP listen sockets to the list of read descriptors. */
    for (i = 0; i < pThis->iLstnCurr; ++i) {
        CHKiRet(poll_Add(pThis, pThis->ppLstn[i], NSDSEL_RD));
    }

    while (1) {
        pThis->evtdata.poll.currfds = pThis->iLstnCurr; /* listeners are "fixed" */
        /* do the sessions */
        iTCPSess = TCPSessGetNxtSess(pThis, -1);
        while (iTCPSess != -1) {
            /* TODO: access to pNsd is NOT really CLEAN, use method... */
            CHKiRet(poll_Add(pThis, pThis->pSessions[iTCPSess]->pStrm, NSDSEL_RD));
            DBGPRINTF("tcpsrv process session %d:\n", iTCPSess);

            /* now get next... */
            iTCPSess = TCPSessGetNxtSess(pThis, iTCPSess);
        }

        /* zero-out the last fd - space for it is always reserved! */
        assert(pThis->evtdata.poll.maxfds != pThis->evtdata.poll.currfds);
        pThis->evtdata.poll.fds[pThis->evtdata.poll.currfds].fd = 0;
        /* wait for io to become ready */
        CHKiRet(poll_Poll(pThis, &nfds));
        if (glbl.GetGlobalInputTermState() == 1) break; /* terminate input! */

        iWorkset = 0;
        for (i = 0; i < pThis->iLstnCurr && nfds; ++i) {
            if (glbl.GetGlobalInputTermState() == 1) ABORT_FINALIZE(RS_RET_FORCE_TERM);
            CHKiRet(poll_IsReady(pThis, pThis->ppLstn[i], NSDSEL_RD, &bIsReady));
            if (bIsReady) {
                workset[iWorkset].pSrv = pThis;
                workset[iWorkset].ptrType = NSD_PTR_TYPE_LSTN;
                workset[iWorkset].id = i;
                workset[iWorkset].isInError = 0;
                workset[iWorkset].ioDirection = NSDSEL_RD; /* non-epoll: ensure sane default */
                CHKiRet(netstrm.GetSock(pThis->ppLstn[i], &(workset[iWorkset].sock)));
                workset[iWorkset].ptr.ppLstn = pThis->ppLstn;
                /* this is a flag to indicate listen sock */
                ++iWorkset;
                if (iWorkset >= (int)sizeWorkset) {
                    processWorkset(iWorkset, pWorkset);
                    iWorkset = 0;
                }
                --nfds; /* indicate we have processed one */
            }
        }

        /* now check the sessions */
        iTCPSess = TCPSessGetNxtSess(pThis, -1);
        while (nfds && iTCPSess != -1) {
            if (glbl.GetGlobalInputTermState() == 1) ABORT_FINALIZE(RS_RET_FORCE_TERM);
            localRet = poll_IsReady(pThis, pThis->pSessions[iTCPSess]->pStrm, NSDSEL_RD, &bIsReady);
            if (bIsReady || localRet != RS_RET_OK) {
                workset[iWorkset].pSrv = pThis;
                workset[iWorkset].ptrType = NSD_PTR_TYPE_SESS;
                workset[iWorkset].id = iTCPSess;
                workset[iWorkset].isInError = 0;
                workset[iWorkset].ioDirection = NSDSEL_RD; /* non-epoll: ensure sane default */
                CHKiRet(netstrm.GetSock(pThis->pSessions[iTCPSess]->pStrm, &(workset[iWorkset].sock)));
                workset[iWorkset].ptr.pSess = pThis->pSessions[iTCPSess];
                ++iWorkset;
                if (iWorkset >= (int)sizeWorkset) {
                    processWorkset(iWorkset, pWorkset);
                    iWorkset = 0;
                }
                if (bIsReady) --nfds; /* indicate we have processed one */
            }
            iTCPSess = TCPSessGetNxtSess(pThis, iTCPSess);
        }

        if (iWorkset > 0) {
            processWorkset(iWorkset, pWorkset);
        }

        /* we need to copy back close descriptors */
    finalize_it: /* this is a very special case - this time only we do not exit the function,
                  * because that would not help us either. So we simply retry it. Let's see
                  * if that actually is a better idea. Exiting the loop wasn't we always
                  * crashed, which made sense (the rest of the engine was not prepared for
                  * that) -- rgerhards, 2008-05-19
                  */
        continue; /* keep compiler happy, block end after label is non-standard */
    }

    RETiRet;
}
PRAGMA_DIAGNOSTIC_POP
#endif /* conditional exclude when epoll is available */


#if defined(ENABLE_IMTCP_EPOLL)
static rsRetVal ATTR_NONNULL() RunEpoll(tcpsrv_t *const pThis) {
    DEFiRet;
    int i;
    tcpsrv_io_descr_t *workset[NSPOLL_MAX_EVENTS_PER_WAIT];
    int numEntries;
    rsRetVal localRet;

    DBGPRINTF("tcpsrv uses epoll() interface\n");

    /* Add the TCP listen sockets to the list of sockets to monitor */
    for (i = 0; i < pThis->iLstnCurr; ++i) {
        DBGPRINTF("Trying to add listener %d, pUsr=%p\n", i, pThis->ppLstn);
        CHKmalloc(pThis->ppioDescrPtr[i] = (tcpsrv_io_descr_t *)calloc(1, sizeof(tcpsrv_io_descr_t)));
        pThis->ppioDescrPtr[i]->pSrv = pThis;
        pThis->ppioDescrPtr[i]->id = i;
        pThis->ppioDescrPtr[i]->isInError = 0;
        pThis->ppioDescrPtr[i]->ioDirection = NSDSEL_RD;
        INIT_ATOMIC_HELPER_MUT(pThis->ppioDescrPtr[i]->mut_isInError);
        CHKiRet(netstrm.GetSock(pThis->ppLstn[i], &(pThis->ppioDescrPtr[i]->sock)));
        pThis->ppioDescrPtr[i]->ptrType = NSD_PTR_TYPE_LSTN;
        pThis->ppioDescrPtr[i]->ptr.ppLstn = pThis->ppLstn;
        CHKiRet(epoll_Ctl(pThis, pThis->ppioDescrPtr[i], 1, EPOLL_CTL_ADD));
        DBGPRINTF("Added listener %d\n", i);
    }

    while (glbl.GetGlobalInputTermState() == 0) {
        numEntries = sizeof(workset) / sizeof(tcpsrv_io_descr_t *);
        localRet = epoll_Wait(pThis, -1, &numEntries, workset);
        if (glbl.GetGlobalInputTermState() == 1) {
            break; /* terminate input! */
        }

        /* check if we need to ignore the i/o ready state. We do this if we got an invalid
         * return state. Validly, this can happen for RS_RET_EINTR, for other cases it may
         * not be the right thing, but what is the right thing is really hard at this point...
         * Note: numEntries can be validly 0 in some rare cases (eg spurios wakeup).
         */
        if (localRet != RS_RET_OK || numEntries == 0) {
            continue;
        }

        processWorkset(numEntries, workset);
    }

    /* remove the tcp listen sockets from the epoll set */
    for (i = 0; i < pThis->iLstnCurr; ++i) {
        CHKiRet(epoll_Ctl(pThis, pThis->ppioDescrPtr[i], 1, EPOLL_CTL_DEL));
        DESTROY_ATOMIC_HELPER_MUT(pThis->ppioDescrPtr[i]->mut_isInError);
        free(pThis->ppioDescrPtr[i]);
    }

finalize_it:
    RETiRet;
}
#endif


/* This function is called to gather input. It tries doing that via the epoll()
 * interface. If the driver does not support that, it falls back to calling its
 * select() equivalent.
 * rgerhards, 2009-11-18
 */
static rsRetVal ATTR_NONNULL() Run(tcpsrv_t *const pThis) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);

    if (pThis->iLstnCurr == 0) {
        dbgprintf("tcpsrv: no listeners at all (probably init error), terminating\n");
        FINALIZE;
    }

#if !defined(ENABLE_IMTCP_EPOLL)
    /* if we do not have epoll(), we need to run single-threaded */
    pThis->workQueue.numWrkr = 1;
#endif

    eventNotify_init(pThis);
    if (pThis->workQueue.numWrkr > 1) {
        iRet = startWrkrPool(pThis);
        if (iRet != RS_RET_OK) {
            LogError(errno, iRet,
                     "tcpsrv could not start worker pool "
                     "- now running single threaded '%s')",
                     (pThis->pszInputName == NULL) ? (uchar *)"*UNSET*" : pThis->pszInputName);
            pThis->workQueue.numWrkr = 1;
        }
    }
#if defined(ENABLE_IMTCP_EPOLL)
    iRet = RunEpoll(pThis);
#else
    /* fall back to select */
    iRet = RunPoll(pThis);
#endif

    stopWrkrPool(pThis);
    eventNotify_exit(pThis);

finalize_it:
    RETiRet;
}


/* Standard-Constructor */
BEGINobjConstruct(tcpsrv) /* be sure to specify the object type also in END macro! */
    pThis->iSessMax = TCPSESS_MAX_DEFAULT;
    pThis->iLstnMax = TCPLSTN_MAX_DEFAULT;
    pThis->addtlFrameDelim = TCPSRV_NO_ADDTL_DELIMITER;
    pThis->maxFrameSize = 200000;
    pThis->bDisableLFDelim = 0;
    pThis->discardTruncatedMsg = 0;
    pThis->OnMsgReceive = NULL;
    pThis->dfltTZ[0] = '\0';
    pThis->bSPFramingFix = 0;
    pThis->ratelimitInterval = 0;
    pThis->ratelimitBurst = 10000;
    pThis->bUseFlowControl = 1;
    pThis->pszDrvrName = NULL;
    pThis->bPreserveCase = 1; /* preserve case in fromhost; default to true. */
    pThis->iSynBacklog = 0; /* default: unset */
    pThis->DrvrTlsVerifyDepth = 0;
    pThis->DrvrTlsRevocationCheck = 0;
ENDobjConstruct(tcpsrv)


/* ConstructionFinalizer */
static rsRetVal ATTR_NONNULL() tcpsrvConstructFinalize(tcpsrv_t *pThis) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);

    /* prepare network stream subsystem */
    CHKiRet(netstrms.Construct(&pThis->pNS));
    CHKiRet(netstrms.SetSynBacklog(pThis->pNS, pThis->iSynBacklog));
    if (pThis->pszDrvrName != NULL) CHKiRet(netstrms.SetDrvrName(pThis->pNS, pThis->pszDrvrName));
    CHKiRet(netstrms.SetDrvrMode(pThis->pNS, pThis->iDrvrMode));
    CHKiRet(netstrms.SetDrvrCheckExtendedKeyUsage(pThis->pNS, pThis->DrvrChkExtendedKeyUsage));
    CHKiRet(netstrms.SetDrvrPrioritizeSAN(pThis->pNS, pThis->DrvrPrioritizeSan));
    CHKiRet(netstrms.SetDrvrTlsVerifyDepth(pThis->pNS, pThis->DrvrTlsVerifyDepth));
    CHKiRet(netstrms.SetDrvrTlsRevocationCheck(pThis->pNS, pThis->DrvrTlsRevocationCheck));
    if (pThis->pszDrvrAuthMode != NULL) CHKiRet(netstrms.SetDrvrAuthMode(pThis->pNS, pThis->pszDrvrAuthMode));
    /* Call SetDrvrPermitExpiredCerts required
     * when param is NULL default handling for ExpiredCerts is set! */
    CHKiRet(netstrms.SetDrvrPermitExpiredCerts(pThis->pNS, pThis->pszDrvrPermitExpiredCerts));
    CHKiRet(netstrms.SetDrvrTlsCAFile(pThis->pNS, pThis->pszDrvrCAFile));
    CHKiRet(netstrms.SetDrvrTlsCRLFile(pThis->pNS, pThis->pszDrvrCRLFile));
    CHKiRet(netstrms.SetDrvrTlsKeyFile(pThis->pNS, pThis->pszDrvrKeyFile));
    CHKiRet(netstrms.SetDrvrTlsCertFile(pThis->pNS, pThis->pszDrvrCertFile));
    if (pThis->pPermPeers != NULL) CHKiRet(netstrms.SetDrvrPermPeers(pThis->pNS, pThis->pPermPeers));
    if (pThis->gnutlsPriorityString != NULL)
        CHKiRet(netstrms.SetDrvrGnutlsPriorityString(pThis->pNS, pThis->gnutlsPriorityString));
    CHKiRet(netstrms.ConstructFinalize(pThis->pNS));

    /* set up listeners */
    CHKmalloc(pThis->ppLstn = calloc(pThis->iLstnMax, sizeof(netstrm_t *)));
    CHKmalloc(pThis->ppLstnPort = calloc(pThis->iLstnMax, sizeof(tcpLstnPortList_t *)));
    CHKmalloc(pThis->ppioDescrPtr = calloc(pThis->iLstnMax, sizeof(tcpsrv_io_descr_t *)));
    iRet = pThis->OpenLstnSocks(pThis);

finalize_it:
    if (iRet != RS_RET_OK) {
        if (pThis->pNS != NULL) netstrms.Destruct(&pThis->pNS);
        free(pThis->ppLstn);
        pThis->ppLstn = NULL;
        free(pThis->ppLstnPort);
        pThis->ppLstnPort = NULL;
        free(pThis->ppioDescrPtr);
        pThis->ppioDescrPtr = NULL;

        LogError(0, iRet, "tcpsrv could not create listener (inputname: '%s')",
                 (pThis->pszInputName == NULL) ? (uchar *)"*UNSET*" : pThis->pszInputName);
    }
    RETiRet;
}


/* destructor for the tcpsrv object */
BEGINobjDestruct(tcpsrv) /* be sure to specify the object type also in END and CODESTART macros! */
    CODESTARTobjDestruct(tcpsrv);
    if (pThis->OnDestruct != NULL) pThis->OnDestruct(pThis->pUsr);

    stopWrkrPool(pThis);

    deinit_tcp_listener(pThis);


    if (pThis->pNS != NULL) netstrms.Destruct(&pThis->pNS);
    free(pThis->pszDrvrName);
    free(pThis->pszDrvrAuthMode);
    free(pThis->pszDrvrPermitExpiredCerts);
    free(pThis->pszDrvrCAFile);
    free(pThis->pszDrvrCRLFile);
    free(pThis->pszDrvrKeyFile);
    free(pThis->pszDrvrCertFile);
    free(pThis->ppLstn);
    free(pThis->ppLstnPort);
    free(pThis->ppioDescrPtr);
    free(pThis->pszOrigin);
ENDobjDestruct(tcpsrv)


/* debugprint for the tcpsrv object */
BEGINobjDebugPrint(tcpsrv) /* be sure to specify the object type also in END and CODESTART macros! */
    CODESTARTobjDebugPrint(tcpsrv);
ENDobjDebugPrint(tcpsrv)

/* set functions */
static rsRetVal ATTR_NONNULL(1)
    SetCBIsPermittedHost(tcpsrv_t *pThis, int (*pCB)(struct sockaddr *addr, char *fromHostFQDN, void *, void *)) {
    DEFiRet;
    pThis->pIsPermittedHost = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1)
    SetCBRcvData(tcpsrv_t *pThis, rsRetVal (*pRcvData)(tcps_sess_t *, char *, size_t, ssize_t *, int *, unsigned *)) {
    DEFiRet;
    pThis->pRcvData = pRcvData;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetCBOnListenDeinit(tcpsrv_t *pThis, rsRetVal (*pCB)(void *)) {
    DEFiRet;
    pThis->pOnListenDeinit = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetCBOnSessAccept(tcpsrv_t *pThis, rsRetVal (*pCB)(tcpsrv_t *, tcps_sess_t *, char *)) {
    DEFiRet;
    pThis->pOnSessAccept = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetCBOnDestruct(tcpsrv_t *pThis, rsRetVal (*pCB)(void *)) {
    DEFiRet;
    pThis->OnDestruct = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetCBOnSessConstructFinalize(tcpsrv_t *pThis, rsRetVal (*pCB)(void *)) {
    DEFiRet;
    pThis->OnSessConstructFinalize = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetCBOnSessDestruct(tcpsrv_t *pThis, rsRetVal (*pCB)(void *)) {
    DEFiRet;
    pThis->pOnSessDestruct = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetCBOnRegularClose(tcpsrv_t *pThis, rsRetVal (*pCB)(tcps_sess_t *)) {
    DEFiRet;
    pThis->pOnRegularClose = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetCBOnErrClose(tcpsrv_t *pThis, rsRetVal (*pCB)(tcps_sess_t *)) {
    DEFiRet;
    pThis->pOnErrClose = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetCBOpenLstnSocks(tcpsrv_t *pThis, rsRetVal (*pCB)(tcpsrv_t *)) {
    DEFiRet;
    pThis->OpenLstnSocks = pCB;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetUsrP(tcpsrv_t *pThis, void *pUsr) {
    DEFiRet;
    pThis->pUsr = pUsr;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetKeepAlive(tcpsrv_t *pThis, const int iVal) {
    DEFiRet;
    DBGPRINTF("tcpsrv: keep-alive set to %d\n", iVal);
    pThis->bUseKeepAlive = iVal;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetKeepAliveIntvl(tcpsrv_t *pThis, const int iVal) {
    DEFiRet;
    DBGPRINTF("tcpsrv: keep-alive interval set to %d\n", iVal);
    pThis->iKeepAliveIntvl = iVal;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetKeepAliveProbes(tcpsrv_t *pThis, int iVal) {
    DEFiRet;
    DBGPRINTF("tcpsrv: keep-alive probes set to %d\n", iVal);
    pThis->iKeepAliveProbes = iVal;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetKeepAliveTime(tcpsrv_t *pThis, int iVal) {
    DEFiRet;
    DBGPRINTF("tcpsrv: keep-alive timeout set to %d\n", iVal);
    pThis->iKeepAliveTime = iVal;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetGnutlsPriorityString(tcpsrv_t *pThis, uchar *iVal) {
    DEFiRet;
    DBGPRINTF("tcpsrv: gnutlsPriorityString set to %s\n", (iVal == NULL) ? "(null)" : (const char *)iVal);
    pThis->gnutlsPriorityString = iVal;
    RETiRet;
}


static rsRetVal ATTR_NONNULL(1)
    SetOnMsgReceive(tcpsrv_t *pThis, rsRetVal (*OnMsgReceive)(tcps_sess_t *, uchar *, int)) {
    DEFiRet;
    assert(OnMsgReceive != NULL);
    pThis->OnMsgReceive = OnMsgReceive;
    RETiRet;
}


/* set enable/disable standard LF frame delimiter (use with care!)
 * -- rgerhards, 2010-01-03
 */
static rsRetVal ATTR_NONNULL(1) SetbDisableLFDelim(tcpsrv_t *pThis, int bVal) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->bDisableLFDelim = bVal;
    RETiRet;
}


/* discard the truncated msg part
 * -- PascalWithopf, 2017-04-20
 */
static rsRetVal ATTR_NONNULL(1) SetDiscardTruncatedMsg(tcpsrv_t *pThis, int discard) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->discardTruncatedMsg = discard;
    RETiRet;
}


/* Set additional framing to use (if any) -- rgerhards, 2008-12-10 */
static rsRetVal ATTR_NONNULL(1) SetAddtlFrameDelim(tcpsrv_t *pThis, int iDelim) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->addtlFrameDelim = iDelim;
    RETiRet;
}


/* Set max frame size for octet counted -- PascalWithopf, 2017-04-20*/
static rsRetVal ATTR_NONNULL(1) SetMaxFrameSize(tcpsrv_t *pThis, int maxFrameSize) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->maxFrameSize = maxFrameSize;
    RETiRet;
}


static rsRetVal ATTR_NONNULL(1) SetDfltTZ(tcpsrv_t *const pThis, uchar *const tz) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    strncpy((char *)pThis->dfltTZ, (char *)tz, sizeof(pThis->dfltTZ));
    pThis->dfltTZ[sizeof(pThis->dfltTZ) - 1] = '\0';
    RETiRet;
}


static rsRetVal ATTR_NONNULL(1) SetbSPFramingFix(tcpsrv_t *pThis, const sbool val) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->bSPFramingFix = val;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetOrigin(tcpsrv_t *pThis, uchar *origin) {
    DEFiRet;
    free(pThis->pszOrigin);
    pThis->pszOrigin = (origin == NULL) ? NULL : ustrdup(origin);
    RETiRet;
}

/* Set the input name to use -- rgerhards, 2008-12-10 */
static rsRetVal ATTR_NONNULL(1)
    SetInputName(tcpsrv_t *const pThis, tcpLstnParams_t *const cnf_params, const uchar *const name) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    if (name == NULL) {
        cnf_params->pszInputName = NULL;
    } else {
        CHKmalloc(cnf_params->pszInputName = ustrdup(name));
        pThis->pszInputName = cnf_params->pszInputName;
    }

    /* we need to create a property */
    CHKiRet(prop.Construct(&cnf_params->pInputName));
    CHKiRet(prop.SetString(cnf_params->pInputName, cnf_params->pszInputName, ustrlen(cnf_params->pszInputName)));
    CHKiRet(prop.ConstructFinalize(cnf_params->pInputName));
finalize_it:
    RETiRet;
}

static rsRetVal SetNetworkNamespace(tcpsrv_t *pThis __attribute__((unused)),
                                    tcpLstnParams_t *const cnf_params,
                                    const char *const networkNamespace) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    free(cnf_params->pszNetworkNamespace);
    if (!networkNamespace || !*networkNamespace) {
        cnf_params->pszNetworkNamespace = NULL;
    } else {
#ifdef HAVE_SETNS
        CHKmalloc(cnf_params->pszNetworkNamespace = strdup(networkNamespace));
#else  // ndef HAVE_SETNS
        LogError(0, RS_RET_VALUE_NOT_SUPPORTED, "Namespaces are not supported");
        ABORT_FINALIZE(RS_RET_VALUE_NOT_SUPPORTED);
#endif  // #else ndef HAVE_SETNS
    }
finalize_it:
    RETiRet;
}

/* Set the linux-like ratelimiter settings */
static rsRetVal ATTR_NONNULL(1)
    SetLinuxLikeRatelimiters(tcpsrv_t *pThis, unsigned int ratelimitInterval, unsigned int ratelimitBurst) {
    DEFiRet;
    pThis->ratelimitInterval = ratelimitInterval;
    pThis->ratelimitBurst = ratelimitBurst;
    RETiRet;
}


/* Set connection open notification */
static rsRetVal ATTR_NONNULL(1) SetNotificationOnRemoteOpen(tcpsrv_t *pThis, const int bNewVal) {
    pThis->bEmitMsgOnOpen = bNewVal;
    return RS_RET_OK;
}
/* Set connection close notification */
static rsRetVal ATTR_NONNULL(1) SetNotificationOnRemoteClose(tcpsrv_t *pThis, const int bNewVal) {
    DEFiRet;
    pThis->bEmitMsgOnClose = bNewVal;
    RETiRet;
}


/* here follows a number of methods that shuffle authentication settings down
 * to the drivers. Drivers not supporting these settings may return an error
 * state.
 * -------------------------------------------------------------------------- */

/* set the driver mode -- rgerhards, 2008-04-30 */
static rsRetVal ATTR_NONNULL(1) SetDrvrMode(tcpsrv_t *pThis, const int iMode) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->iDrvrMode = iMode;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetDrvrName(tcpsrv_t *pThis, uchar *const name) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    free(pThis->pszDrvrName);
    CHKmalloc(pThis->pszDrvrName = ustrdup(name));
finalize_it:
    RETiRet;
}

/* set the driver authentication mode -- rgerhards, 2008-05-19 */
static rsRetVal ATTR_NONNULL(1) SetDrvrAuthMode(tcpsrv_t *pThis, uchar *const mode) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    CHKmalloc(pThis->pszDrvrAuthMode = ustrdup(mode));
finalize_it:
    RETiRet;
}

/* set the driver permitexpiredcerts mode -- alorbach, 2018-12-20
 */
static rsRetVal ATTR_NONNULL(1) SetDrvrPermitExpiredCerts(tcpsrv_t *pThis, uchar *mode) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    if (mode != NULL) {
        CHKmalloc(pThis->pszDrvrPermitExpiredCerts = ustrdup(mode));
    }
finalize_it:
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetDrvrCAFile(tcpsrv_t *const pThis, uchar *const mode) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    if (mode != NULL) {
        CHKmalloc(pThis->pszDrvrCAFile = ustrdup(mode));
    }
finalize_it:
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetDrvrCRLFile(tcpsrv_t *const pThis, uchar *const mode) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    if (mode != NULL) {
        CHKmalloc(pThis->pszDrvrCRLFile = ustrdup(mode));
    }
finalize_it:
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetDrvrKeyFile(tcpsrv_t *pThis, uchar *mode) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    if (mode != NULL) {
        CHKmalloc(pThis->pszDrvrKeyFile = ustrdup(mode));
    }
finalize_it:
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetDrvrCertFile(tcpsrv_t *pThis, uchar *mode) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    if (mode != NULL) {
        CHKmalloc(pThis->pszDrvrCertFile = ustrdup(mode));
    }
finalize_it:
    RETiRet;
}


/* set the driver's permitted peers -- rgerhards, 2008-05-19 */
static rsRetVal ATTR_NONNULL(1) SetDrvrPermPeers(tcpsrv_t *pThis, permittedPeers_t *pPermPeers) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->pPermPeers = pPermPeers;
    RETiRet;
}

/* set the driver cert extended key usage check setting -- jvymazal, 2019-08-16 */
static rsRetVal ATTR_NONNULL(1) SetDrvrCheckExtendedKeyUsage(tcpsrv_t *pThis, int ChkExtendedKeyUsage) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->DrvrChkExtendedKeyUsage = ChkExtendedKeyUsage;
    RETiRet;
}

/* set the driver name checking policy -- jvymazal, 2019-08-16 */
static rsRetVal ATTR_NONNULL(1) SetDrvrPrioritizeSAN(tcpsrv_t *pThis, int prioritizeSan) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->DrvrPrioritizeSan = prioritizeSan;
    RETiRet;
}

/* set the driver Set the driver tls  verifyDepth -- alorbach, 2019-12-20 */
static rsRetVal ATTR_NONNULL(1) SetDrvrTlsVerifyDepth(tcpsrv_t *pThis, int verifyDepth) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->DrvrTlsVerifyDepth = verifyDepth;
    RETiRet;
}

static rsRetVal ATTR_NONNULL(1) SetDrvrTlsRevocationCheck(tcpsrv_t *pThis, int enabled) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->DrvrTlsRevocationCheck = (enabled != 0) ? 1 : 0;
    RETiRet;
}


/* End of methods to shuffle authentication settings to the driver.;

 * -------------------------------------------------------------------------- */


/* set max number of listeners
 * this must be called before ConstructFinalize, or it will have no effect!
 * rgerhards, 2009-08-17
 */
static rsRetVal ATTR_NONNULL(1) SetLstnMax(tcpsrv_t *pThis, int iMax) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->iLstnMax = iMax;
    RETiRet;
}


/* set if flow control shall be supported
 */
static rsRetVal ATTR_NONNULL(1) SetUseFlowControl(tcpsrv_t *pThis, int bUseFlowControl) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->bUseFlowControl = bUseFlowControl;
    RETiRet;
}


/* set max number of sessions
 * this must be called before ConstructFinalize, or it will have no effect!
 * rgerhards, 2009-04-09
 */
static rsRetVal ATTR_NONNULL(1) SetSessMax(tcpsrv_t *pThis, int iMax) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->iSessMax = iMax;
    RETiRet;
}


static rsRetVal ATTR_NONNULL(1) SetPreserveCase(tcpsrv_t *pThis, int bPreserveCase) {
    DEFiRet;
    ISOBJ_TYPE_assert(pThis, tcpsrv);
    pThis->bPreserveCase = bPreserveCase;
    RETiRet;
}


static rsRetVal ATTR_NONNULL(1) SetSynBacklog(tcpsrv_t *pThis, const int iSynBacklog) {
    pThis->iSynBacklog = iSynBacklog;
    return RS_RET_OK;
}


static rsRetVal ATTR_NONNULL(1) SetStarvationMaxReads(tcpsrv_t *pThis, const unsigned int maxReads) {
    pThis->starvationMaxReads = maxReads;
    return RS_RET_OK;
}


static rsRetVal ATTR_NONNULL(1) SetNumWrkr(tcpsrv_t *pThis, const int numWrkr) {
    pThis->workQueue.numWrkr = numWrkr;
    return RS_RET_OK;
}


/* queryInterface function
 * rgerhards, 2008-02-29
 */
BEGINobjQueryInterface(tcpsrv)
    CODESTARTobjQueryInterface(tcpsrv);
    if (pIf->ifVersion != tcpsrvCURR_IF_VERSION) { /* check for current version, increment on each change */
        ABORT_FINALIZE(RS_RET_INTERFACE_NOT_SUPPORTED);
    }

    /* ok, we have the right interface, so let's fill it
     * Please note that we may also do some backwards-compatibility
     * work here (if we can support an older interface version - that,
     * of course, also affects the "if" above).
     */
    pIf->DebugPrint = tcpsrvDebugPrint;
    pIf->Construct = tcpsrvConstruct;
    pIf->ConstructFinalize = tcpsrvConstructFinalize;
    pIf->Destruct = tcpsrvDestruct;

    pIf->configureTCPListen = configureTCPListen;
    pIf->create_tcp_socket = create_tcp_socket;
    pIf->Run = Run;

    pIf->SetNetworkNamespace = SetNetworkNamespace;
    pIf->SetKeepAlive = SetKeepAlive;
    pIf->SetKeepAliveIntvl = SetKeepAliveIntvl;
    pIf->SetKeepAliveProbes = SetKeepAliveProbes;
    pIf->SetKeepAliveTime = SetKeepAliveTime;
    pIf->SetGnutlsPriorityString = SetGnutlsPriorityString;
    pIf->SetUsrP = SetUsrP;
    pIf->SetInputName = SetInputName;
    pIf->SetOrigin = SetOrigin;
    pIf->SetDfltTZ = SetDfltTZ;
    pIf->SetbSPFramingFix = SetbSPFramingFix;
    pIf->SetAddtlFrameDelim = SetAddtlFrameDelim;
    pIf->SetMaxFrameSize = SetMaxFrameSize;
    pIf->SetbDisableLFDelim = SetbDisableLFDelim;
    pIf->SetDiscardTruncatedMsg = SetDiscardTruncatedMsg;
    pIf->SetSessMax = SetSessMax;
    pIf->SetUseFlowControl = SetUseFlowControl;
    pIf->SetLstnMax = SetLstnMax;
    pIf->SetDrvrMode = SetDrvrMode;
    pIf->SetDrvrAuthMode = SetDrvrAuthMode;
    pIf->SetDrvrPermitExpiredCerts = SetDrvrPermitExpiredCerts;
    pIf->SetDrvrCAFile = SetDrvrCAFile;
    pIf->SetDrvrCRLFile = SetDrvrCRLFile;
    pIf->SetDrvrKeyFile = SetDrvrKeyFile;
    pIf->SetDrvrCertFile = SetDrvrCertFile;
    pIf->SetDrvrName = SetDrvrName;
    pIf->SetDrvrPermPeers = SetDrvrPermPeers;
    pIf->SetCBIsPermittedHost = SetCBIsPermittedHost;
    pIf->SetCBOpenLstnSocks = SetCBOpenLstnSocks;
    pIf->SetCBRcvData = SetCBRcvData;
    pIf->SetCBOnListenDeinit = SetCBOnListenDeinit;
    pIf->SetCBOnSessAccept = SetCBOnSessAccept;
    pIf->SetCBOnSessConstructFinalize = SetCBOnSessConstructFinalize;
    pIf->SetCBOnSessDestruct = SetCBOnSessDestruct;
    pIf->SetCBOnDestruct = SetCBOnDestruct;
    pIf->SetCBOnRegularClose = SetCBOnRegularClose;
    pIf->SetCBOnErrClose = SetCBOnErrClose;
    pIf->SetOnMsgReceive = SetOnMsgReceive;
    pIf->SetLinuxLikeRatelimiters = SetLinuxLikeRatelimiters;
    pIf->SetNotificationOnRemoteClose = SetNotificationOnRemoteClose;
    pIf->SetNotificationOnRemoteOpen = SetNotificationOnRemoteOpen;
    pIf->SetPreserveCase = SetPreserveCase;
    pIf->SetDrvrCheckExtendedKeyUsage = SetDrvrCheckExtendedKeyUsage;
    pIf->SetDrvrPrioritizeSAN = SetDrvrPrioritizeSAN;
    pIf->SetDrvrTlsVerifyDepth = SetDrvrTlsVerifyDepth;
    pIf->SetDrvrTlsRevocationCheck = SetDrvrTlsRevocationCheck;
    pIf->SetSynBacklog = SetSynBacklog;
    pIf->SetNumWrkr = SetNumWrkr;
    pIf->SetStarvationMaxReads = SetStarvationMaxReads;

finalize_it:
ENDobjQueryInterface(tcpsrv)


/* exit our class
 * rgerhards, 2008-03-10
 */
BEGINObjClassExit(tcpsrv, OBJ_IS_LOADABLE_MODULE) /* CHANGE class also in END MACRO! */
    CODESTARTObjClassExit(tcpsrv);
    /* release objects we no longer need */
    objRelease(tcps_sess, DONT_LOAD_LIB);
    objRelease(conf, CORE_COMPONENT);
    objRelease(prop, CORE_COMPONENT);
    objRelease(statsobj, CORE_COMPONENT);
    objRelease(ruleset, CORE_COMPONENT);
    objRelease(glbl, CORE_COMPONENT);
    objRelease(netstrms, DONT_LOAD_LIB);
    objRelease(netstrm, LM_NETSTRMS_FILENAME);
    objRelease(net, LM_NET_FILENAME);
    objRelease(regexp, LM_REGEXP_FILENAME);
ENDObjClassExit(tcpsrv)


/* Initialize our class. Must be called as the very first method
 * before anything else is called inside this class.
 * rgerhards, 2008-02-29
 */
BEGINObjClassInit(tcpsrv, 1, OBJ_IS_LOADABLE_MODULE) /* class, version - CHANGE class also in END MACRO! */
    /* request objects we use */
    CHKiRet(objUse(net, LM_NET_FILENAME));
    CHKiRet(objUse(netstrms, LM_NETSTRMS_FILENAME));
    CHKiRet(objUse(netstrm, DONT_LOAD_LIB));
    CHKiRet(objUse(tcps_sess, DONT_LOAD_LIB));
    CHKiRet(objUse(conf, CORE_COMPONENT));
    CHKiRet(objUse(glbl, CORE_COMPONENT));
    CHKiRet(objUse(ruleset, CORE_COMPONENT));
    CHKiRet(objUse(statsobj, CORE_COMPONENT));
    CHKiRet(objUse(prop, CORE_COMPONENT));
    CHKiRet(objUse(regexp, LM_REGEXP_FILENAME));

    /* set our own handlers */
    OBJSetMethodHandler(objMethod_DEBUGPRINT, tcpsrvDebugPrint);
    OBJSetMethodHandler(objMethod_CONSTRUCTION_FINALIZER, tcpsrvConstructFinalize);
ENDObjClassInit(tcpsrv)


/* --------------- here now comes the plumbing that makes as a library module --------------- */

BEGINmodExit
    CODESTARTmodExit;
    /* de-init in reverse order! */
    tcpsrvClassExit();
    tcps_sessClassExit();
ENDmodExit


BEGINqueryEtryPt
    CODESTARTqueryEtryPt;
    CODEqueryEtryPt_STD_LIB_QUERIES;
ENDqueryEtryPt


BEGINmodInit()
    CODESTARTmodInit;
    *ipIFVersProvided = CURR_MOD_IF_VERSION; /* we only support the current interface specification */
    /* Initialize all classes that are in our module - this includes ourselves */
    CHKiRet(tcps_sessClassInit(pModInfo));
    CHKiRet(tcpsrvClassInit(pModInfo)); /* must be done after tcps_sess, as we use it */
ENDmodInit
