ocs_session.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015, Emulex
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

/**
 * @file
 * Defines the iSCSI session managment functions.
 * This code should be OS independant.
 */

#ifndef _OCS_SESSION_H
#define _OCS_SESSION_H

#include "ocs_os.h"

/* Initialization and Configuration */
int32_t ocs_session_initialize(ocs_iscsi_t *);
void ocs_session_teardown(ocs_iscsi_t *);

int32_t ocs_session_cxn_new(ocs_cxn_t *cxn,
                char *tgt_name,
                char *ini_name,
                uint64_t isid,
                uint16_t tsih,
                uint16_t cid,
                uint32_t cmd_sn);

int32_t ocs_session_cxn_del(ocs_cxn_t *cxn);

ocs_cxn_t *ocs_session_cxn_find(ocs_session_t *session,
                uint16_t cid);

void ocs_session_close(ocs_session_t *session, uint8_t reset);

void ocs_session_max_cmd_sn_upd(ocs_session_t *session);

int32_t ocs_session_tgt_unsol_pdu_recv(ocs_cxn_t *cxn,
                       ocs_hal_rq_buffer_t *hdr,
                       uint32_t   hdr_len,
                       ocs_hal_rq_buffer_t *data,
                       uint32_t   data_len,
                       uint8_t    code);

int32_t ocs_session_abort_itt(ocs_session_t *session,
                  uint32_t       itt);

void ocs_session_abort_cmdsn(ocs_session_t *session,
                 uint32_t       cmdsn);

void ocs_session_all_abort_cmdsn(ocs_iscsi_t *iscsi,
                 uint32_t     cmdsn);

void ocs_ddump_sessions(ocs_textbuf_t *textbuf, ocs_iscsi_t *iscsi);

/* Helper functions for routines building commands on connections */

static inline uint32_t
ocs_session_is_window_open(ocs_cxn_t *cxn)
{
    ocs_session_t *session = cxn->session;
    uint32_t rc = FALSE;

    if (session != NULL &&
        !GT_NOTWRAPPED(session->exp_cmd_sn + session->cmd_window,
               session->cmd_sn)) {
        rc = TRUE;
    }

    return rc;
}

static inline uint64_t
ocs_session_isid_get(ocs_cxn_t *cxn)
{
    ocs_session_t *session = cxn->session;

    return (session == NULL ? 0 : session->isid);
}

static inline uint32_t
ocs_session_cmd_sn_get(ocs_cxn_t *cxn, uint32_t inc)
{
    ocs_session_t *session = cxn->session;
    uint32_t rc = 0;

    if (session != NULL) {
        rc = session->cmd_sn;
        session->cmd_sn += inc;
    }
    return rc;
}

static inline uint32_t
ocs_session_exp_cmd_sn_get(ocs_cxn_t *cxn)
{
    ocs_session_t *session = cxn->session;

    return (session == NULL ? 0 : session->exp_cmd_sn);
}

static inline uint32_t
ocs_session_max_cmd_sn_get(ocs_cxn_t *cxn)
{
    ocs_session_t *session = cxn->session;

    return (session == NULL ? 0 : session->max_cmd_sn);
}

static inline uint32_t
ocs_session_cmd_window_get(ocs_cxn_t *cxn)
{
    ocs_session_t *session = cxn->session;

    return (session == NULL ? 0 : session->cmd_window);
}

static inline uint16_t
ocs_session_tsih_get(ocs_cxn_t *cxn)
{
    ocs_session_t *session = cxn->session;

    return (session == NULL ? 0 : session->tsih);
}

static inline void
ocs_session_cmd_sn_set(ocs_cxn_t *cxn, uint32_t cmd_sn)
{
    ocs_session_t *session = cxn->session;

    if (session != NULL) {
        session->cmd_sn = cmd_sn;
    }
}

static inline void
ocs_session_exp_cmd_sn_set(ocs_cxn_t *cxn, uint32_t exp_cmd_sn)
{
    ocs_session_t *session = cxn->session;

    if (session != NULL) {
        session->exp_cmd_sn = exp_cmd_sn;
    }
}

static inline void
ocs_session_max_cmd_sn_set(ocs_cxn_t *cxn, uint32_t max_cmd_sn)
{
    ocs_session_t *session = cxn->session;

    if (session != NULL) {
        session->max_cmd_sn = max_cmd_sn;
    }
}

static inline void
ocs_session_cmd_window_set(ocs_cxn_t *cxn, uint32_t cmd_window)
{
    ocs_session_t *session = cxn->session;

    if (session != NULL) {
        session->cmd_window = cmd_window;
    }
}

static inline void
ocs_session_calc_cmd_window(ocs_cxn_t *cxn)
{
    ocs_session_t *session = cxn->session;

    if (session != NULL) {
        if (GT_NOTWRAPPED(session->max_cmd_sn, session->exp_cmd_sn)) {
            session->cmd_window = session->max_cmd_sn - session->exp_cmd_sn;
        } else {
            session->cmd_window = (0xFFFFFFFF - session->exp_cmd_sn) + session->max_cmd_sn;
        }
    }
}

static inline void
ocs_session_tsih_set(ocs_cxn_t *cxn, uint16_t tsih)
{
    ocs_session_t *session = cxn->session;

    if (session != NULL) {
        session->tsih = tsih;
    }
}

#endif /* !_OCS_SESSION_H */

/* vim: set noexpandtab textwidth=120: */