stellar-stellar/src/session/session.cpp

#include <assert.h>

#include "session_private.h"

#define EX_KEY_MAX_LEN 64

struct ex_schema
{
    char key[EX_KEY_MAX_LEN];
    session_ex_free_cb *free_cb;
    void *args;
};

struct ex_manager
{
    struct ex_schema schemas[EX_DATA_MAX_COUNT];
    uint8_t count;
};

static struct ex_manager g_ex_manager = {0};

/******************************************************************************
 * session
 ******************************************************************************/

void session_init(struct session *sess)
{
    memset(sess, 0, sizeof(struct session));
}

// session id
void session_set_id(struct session *sess, uint64_t id)
{
    sess->id = id;
}

uint64_t session_get_id(const struct session *sess)
{
    return sess->id;
}

// session tuple6
void session_set_key(struct session *sess, const struct tuple6 *tuple)
{
    memcpy(&sess->tuple, tuple, sizeof(struct tuple6));
}

const struct tuple6 *session_get0_key(const struct session *sess)
{
    return &sess->tuple;
}

void session_set_key_dir(struct session *sess, enum session_dir dir)
{
    sess->tuple_dir = dir;
}

enum session_dir session_get_key_dir(const struct session *sess)
{
    return sess->tuple_dir;
}

// session state
void session_set_state(struct session *sess, enum session_state state)
{
    sess->state = state;
}

enum session_state session_get_state(const struct session *sess)
{
    return sess->state;
}

// session type
void session_set_type(struct session *sess, enum session_type type)
{
    sess->type = type;
}

enum session_type session_get_type(const struct session *sess)
{
    return sess->type;
}

// session dup traffic flag
void session_set_dup_traffic_flag(struct session *sess, enum dup_traffic_flag flag)
{
    sess->dup_flag = flag;
}

enum dup_traffic_flag session_get_dup_traffic_flag(const struct session *sess)
{
    return sess->dup_flag;
}

// closing reason
void session_set_closing_reason(struct session *sess, enum closing_reason reason)
{
    sess->closing_reason = reason;
}

enum closing_reason session_get_closing_reason(const struct session *sess)
{
    return sess->closing_reason;
}

// session metrics
void session_inc_c2s_metrics(struct session *sess, uint64_t packets, uint64_t bytes)
{
    sess->c2s_bytes += bytes;
    sess->c2s_packets += packets;
}

void session_inc_s2c_metrics(struct session *sess, uint64_t packets, uint64_t bytes)
{
    sess->s2c_bytes += bytes;
    sess->s2c_packets += packets;
}

uint64_t session_get_c2s_bytes(const struct session *sess)
{
    return sess->c2s_bytes;
}

uint64_t session_get_s2c_bytes(const struct session *sess)
{
    return sess->s2c_bytes;
}

uint64_t session_get_c2s_packets(const struct session *sess)
{
    return sess->c2s_packets;
}

uint64_t session_get_s2c_packets(const struct session *sess)
{
    return sess->s2c_packets;
}

// session timestamp
void session_set_new_time(struct session *sess, uint64_t timestamp)
{
    sess->create_time = timestamp;
}

void session_set_last_time(struct session *sess, uint64_t timestamp)
{
    sess->last_time = timestamp;
}

uint64_t session_get_new_time(const struct session *sess)
{
    return sess->create_time;
}

uint64_t session_get_last_time(const struct session *sess)
{
    return sess->last_time;
}

// session user data
void session_set_user_data(struct session *sess, void *user_data)
{
    sess->user_data = user_data;
}

void *session_get_user_data(const struct session *sess)
{
    return sess->user_data;
}

/******************************************************************************
 * session packet
 ******************************************************************************/

void session_set_c2s_1st_pkt(struct session *sess, const struct packet *pkt)
{
    if (sess->c2s_1st_pkt)
    {
        return;
    }
    sess->c2s_1st_pkt = packet_dup(pkt);
}

void session_set_s2c_1st_pkt(struct session *sess, const struct packet *pkt)
{
    if (sess->s2c_1st_pkt)
    {
        return;
    }
    sess->s2c_1st_pkt = packet_dup(pkt);
}

const struct packet *session_get0_c2s_1st_pkt(const struct session *sess)
{
    return sess->c2s_1st_pkt;
}

const struct packet *session_get0_s2c_1st_pkt(const struct session *sess)
{
    return sess->s2c_1st_pkt;
}

const struct packet *session_get0_1st_pkt(const struct session *sess)
{
    const struct packet *c2s_1st_pkt = session_get0_c2s_1st_pkt(sess);
    if (c2s_1st_pkt)
    {
        return c2s_1st_pkt;
    }
    else
    {
        return session_get0_s2c_1st_pkt(sess);
    }
}

// session current packet
void session_set0_cur_pkt(struct session *sess, const struct packet *pkt)
{
    sess->cur_pkt = pkt;
}

const struct packet *session_get0_cur_pkt(const struct session *sess)
{
    return sess->cur_pkt;
}

// session current dir
void session_set_cur_dir(struct session *sess, enum session_dir dir)
{
    sess->cur_dir = dir;
}

enum session_dir session_get_cur_dir(const struct session *sess)
{
    return sess->cur_dir;
}

/******************************************************************************
 * session tcp reassembly
 ******************************************************************************/

int session_new_tcp_reassembly(struct session *sess, struct tcp_reassembly_options *opts)
{
    sess->c2s_reassembly = tcp_reassembly_new(opts);
    if (sess->c2s_reassembly == NULL)
    {
        return -1;
    }
    sess->s2c_reassembly = tcp_reassembly_new(opts);
    if (sess->s2c_reassembly == NULL)
    {
        tcp_reassembly_free(sess->c2s_reassembly);
        return -1;
    }

    return 0;
}

void session_free_tcp_reassembly(struct session *sess)
{
    tcp_reassembly_free(sess->c2s_reassembly);
    tcp_reassembly_free(sess->s2c_reassembly);
}

void session_init_tcp_seq(struct session *sess, uint32_t syn_seq)
{
    if (sess->type != SESSION_TYPE_TCP)
    {
        assert(0);
        return;
    }

    if (sess->cur_dir == SESSION_DIR_C2S)
    {
        sess->c2s_seq = syn_seq;
        tcp_reassembly_init(sess->c2s_reassembly, syn_seq);
    }
    else
    {
        sess->s2c_seq = syn_seq;
        tcp_reassembly_init(sess->s2c_reassembly, syn_seq);
    }
}

void session_set_tcp_seq_ack(struct session *sess, uint32_t seq, uint32_t ack)
{
    if (sess->type != SESSION_TYPE_TCP)
    {
        assert(0);
        return;
    }

    if (sess->cur_dir == SESSION_DIR_C2S)
    {
        sess->c2s_seq = seq;
        sess->c2s_ack = ack;
    }
    else
    {
        sess->s2c_seq = seq;
        sess->s2c_ack = ack;
    }
}

void session_insert_tcp_payload(struct session *sess, uint32_t seq, const char *payload, uint32_t len, uint64_t now)
{
    if (sess->type != SESSION_TYPE_TCP)
    {
        assert(0);
        return;
    }

    if (sess->cur_dir == SESSION_DIR_C2S)
    {
        tcp_reassembly_insert(sess->c2s_reassembly, seq, payload, len, now);
    }
    else
    {
        tcp_reassembly_insert(sess->s2c_reassembly, seq, payload, len, now);
    }
}

void session_expire_tcp_payload(struct session *sess, uint64_t now)
{
    if (sess->type != SESSION_TYPE_TCP)
    {
        assert(0);
        return;
    }

    tcp_reassembly_expire(sess->c2s_reassembly, now);
    tcp_reassembly_expire(sess->s2c_reassembly, now);
}

const char *session_peek_tcp_payload(struct session *sess, uint32_t *len)
{
    if (sess->type != SESSION_TYPE_TCP)
    {
        *len = 0;
        assert(0);
        return NULL;
    }

    if (sess->cur_dir == SESSION_DIR_C2S)
    {
        return tcp_reassembly_peek(sess->c2s_reassembly, len);
    }
    else
    {
        return tcp_reassembly_peek(sess->s2c_reassembly, len);
    }
}

void session_consume_tcp_payload(struct session *sess, uint32_t len)
{
    if (sess->type != SESSION_TYPE_TCP)
    {
        assert(0);
        return;
    }

    if (sess->cur_dir == SESSION_DIR_C2S)
    {
        tcp_reassembly_consume(sess->c2s_reassembly, len);
    }
    else
    {
        tcp_reassembly_consume(sess->s2c_reassembly, len);
    }
}

/******************************************************************************
 * session ex data
 ******************************************************************************/

/*
 * the exdata prodoced by user, and comsumed by same user.
 * so, the exdata is not shared by different user.
 * otherwise, the exdata need dup by refer count, and free by refer count.
 *
 * if key exist, not allow update, return original index.
 */
uint8_t session_get_ex_new_index(const char *key, session_ex_free_cb *free_cb, void *args)
{
    if (g_ex_manager.count >= EX_DATA_MAX_COUNT)
    {
        abort();
        return EX_DATA_MAX_COUNT;
    }

    for (uint8_t i = 0; i < g_ex_manager.count; i++)
    {
        if (strcmp(g_ex_manager.schemas[i].key, key) == 0)
        {
            return i;
        }
    }

    uint8_t idx = g_ex_manager.count;
    g_ex_manager.count++;

    struct ex_schema *schema = &g_ex_manager.schemas[idx];
    strncpy(schema->key, key, EX_KEY_MAX_LEN);
    schema->free_cb = free_cb;
    schema->args = args;

    return idx;
}

/*
 * Support update ex_data.
 *
 * if key exist: run free_cb free old value, then set new value.
 *     if not run free_cb, old value will be memory leak.
 *     if not allow update, new value will be memory leak.
 * if key not exist: set new value.
 */
void session_set_ex_data(struct session *sess, uint8_t idx, void *val)
{
    if (idx >= g_ex_manager.count)
    {
        assert(0);
        return;
    }

    session_free_ex_data(sess, idx);
    sess->ex_data[idx] = val;
}

void *session_get0_ex_data(const struct session *sess, uint8_t idx)
{
    if (idx >= g_ex_manager.count)
    {
        assert(0);
        return NULL;
    }

    return sess->ex_data[idx];
}

/*
 * after set ex_data, the owner of ex_data is session, so user should not free it directly.
 * if user want to free ex_data, should use session_free_ex_data.
 */
void session_free_ex_data(struct session *sess, uint8_t idx)
{
    if (idx >= g_ex_manager.count)
    {
        assert(0);
        return;
    }

    struct ex_schema *schema = &g_ex_manager.schemas[idx];
    if (schema->free_cb != NULL && sess->ex_data[idx] != NULL)
    {
        printf("free ex_data, idx: %d, key: %s, val: %p\n", idx, schema->key, sess->ex_data[idx]);
        schema->free_cb(sess, idx, sess->ex_data[idx], schema->args);
    }

    sess->ex_data[idx] = NULL;
}

void session_free_all_ex_data(struct session *sess)
{
    if (sess)
    {
        for (uint8_t i = 0; i < g_ex_manager.count; i++)
        {
            session_free_ex_data(sess, i);
        }
    }
}

/******************************************************************************
 * session dump
 ******************************************************************************/

const char *session_closing_reason_to_str(enum closing_reason reason)
{
    switch (reason)
    {
    case CLOSING_BY_TIMEOUT:
        return "closing by timeout";
    case CLOSING_BY_EVICTED:
        return "closing by evicted";
    case CLOSING_BY_CLIENT_FIN:
        return "closing by client FIN";
    case CLOSING_BY_CLIENT_RST:
        return "closing by client RST";
    case CLOSING_BY_SERVER_FIN:
        return "closing by server FIN";
    case CLOSING_BY_SERVER_RST:
        return "closing by server RST";
    default:
        return "unknown";
    }
}

const char *session_state_to_str(enum session_state state)
{
    switch (state)
    {
    case SESSION_STATE_INIT:
        return "init";
    case SESSION_STATE_OPENING:
        return "opening";
    case SESSION_STATE_ACTIVE:
        return "active";
    case SESSION_STATE_CLOSING:
        return "closing";
    case SESSION_STATE_DISCARD:
        return "discard";
    case SESSION_STATE_CLOSED:
        return "closed";
    default:
        return "unknown";
    }
}

const char *session_type_to_str(enum session_type type)
{
    switch (type)
    {
    case SESSION_TYPE_TCP:
        return "TCP";
    case SESSION_TYPE_UDP:
        return "UDP";
    default:
        return "unknown";
    }
}

const char *session_dir_to_str(enum session_dir dir)
{
    switch (dir)
    {
    case SESSION_DIR_C2S:
        return "C2S";
    case SESSION_DIR_S2C:
        return "S2C";
    default:
        return "unknown";
    }
}

const char *dup_traffic_flag_to_str(enum dup_traffic_flag flag)
{
    switch (flag)
    {
    case DUP_TRAFFIC_YES:
        return "YES";
    case DUP_TRAFFIC_NO:
        return "NO";
    default:
        return "unknown";
    }
}

void session_dump(struct session *sess)
{
    char buffer[1024] = {0};
    tuple6_to_str(session_get0_key(sess), buffer, sizeof(buffer));

    printf("session id                 : %" PRIu64 "\n", session_get_id(sess));
    printf("session key                : %s\n", buffer);
    printf("session key dir            : %s\n", session_dir_to_str(session_get_key_dir(sess)));
    printf("session state              : %s\n", session_state_to_str(session_get_state(sess)));
    printf("session type               : %s\n", session_type_to_str(session_get_type(sess)));
    printf("session dup traffic flag   : %s\n", dup_traffic_flag_to_str(session_get_dup_traffic_flag(sess)));
    printf("session closing reason     : %s\n", session_closing_reason_to_str(session_get_closing_reason(sess)));
    printf("session C2S packets        : %" PRIu64 "\n", session_get_c2s_packets(sess));
    printf("session C2S bytes          : %" PRIu64 "\n", session_get_c2s_bytes(sess));
    printf("session S2C packets        : %" PRIu64 "\n", session_get_s2c_packets(sess));
    printf("session S2C bytes          : %" PRIu64 "\n", session_get_s2c_bytes(sess));
    printf("session create time        : %" PRIu64 "\n", session_get_new_time(sess));
    printf("session last time          : %" PRIu64 "\n", session_get_last_time(sess));
    printf("session current packet ptr : %p\n", (void *)session_get0_cur_pkt(sess));
    printf("session current packet dir : %s\n", session_dir_to_str(session_get_cur_dir(sess)));
    printf("session ex data: \n");
    for (uint8_t i = 0; i < g_ex_manager.count; i++)
    {
        printf("    ex_idx: %d, ex_key: %s, ex_data: %p\n", i, g_ex_manager.schemas[i].key, sess->ex_data[i]);
    }
}