debug.c

Go to the documentation of this file.

/* SCTP kernel implementation
 * (C) Copyright IBM Corp. 2001, 2004
 * Copyright (c) 1999-2000 Cisco, Inc.
 * Copyright (c) 1999-2001 Motorola, Inc.
 * Copyright (c) 2001 Intel Corp.
 *
 * This file is part of the SCTP kernel implementation
 *
 * This file converts numerical ID value to alphabetical names for SCTP
 * terms such as chunk type, parameter time, event type, etc.
 *
 * This SCTP implementation is free software;
 * you can redistribute it and/or modify it under the terms of
 * the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This SCTP implementation is distributed in the hope that it
 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
 *                 ************************
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU CC; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Please send any bug reports or fixes you make to the
 * email address(es):
 *    lksctp developers <[email protected]>
 *
 * Or submit a bug report through the following website:
 *    http://www.sf.net/projects/lksctp
 *
 * Written or modified by:
 *    La Monte H.P. Yarroll <[email protected]>
 *    Karl Knutson          <[email protected]>
 *    Xingang Guo           <[email protected]>
 *    Jon Grimm             <[email protected]>
 *    Daisy Chang       <[email protected]>
 *    Sridhar Samudrala     <[email protected]>
 *
 * Any bugs reported given to us we will try to fix... any fixes shared will
 * be incorporated into the next SCTP release.
 */

#include <net/sctp/sctp.h>

#if SCTP_DEBUG
int sctp_debug_flag = 1;    /* Initially enable DEBUG */
#endif  /* SCTP_DEBUG */

/* These are printable forms of Chunk ID's from section 3.1.  */
static const char *const sctp_cid_tbl[SCTP_NUM_BASE_CHUNK_TYPES] = {
    "DATA",
    "INIT",
    "INIT_ACK",
    "SACK",
    "HEARTBEAT",
    "HEARTBEAT_ACK",
    "ABORT",
    "SHUTDOWN",
    "SHUTDOWN_ACK",
    "ERROR",
    "COOKIE_ECHO",
    "COOKIE_ACK",
    "ECN_ECNE",
    "ECN_CWR",
    "SHUTDOWN_COMPLETE",
};

/* Lookup "chunk type" debug name. */
const char *sctp_cname(const sctp_subtype_t cid)
{
    if (cid.chunk <= SCTP_CID_BASE_MAX)
        return sctp_cid_tbl[cid.chunk];

    switch (cid.chunk) {
    case SCTP_CID_ASCONF:
        return "ASCONF";

    case SCTP_CID_ASCONF_ACK:
        return "ASCONF_ACK";

    case SCTP_CID_FWD_TSN:
        return "FWD_TSN";

    case SCTP_CID_AUTH:
        return "AUTH";

    default:
        break;
    }

    return "unknown chunk";
}

/* These are printable forms of the states.  */
const char *const sctp_state_tbl[SCTP_STATE_NUM_STATES] = {
    "STATE_CLOSED",
    "STATE_COOKIE_WAIT",
    "STATE_COOKIE_ECHOED",
    "STATE_ESTABLISHED",
    "STATE_SHUTDOWN_PENDING",
    "STATE_SHUTDOWN_SENT",
    "STATE_SHUTDOWN_RECEIVED",
    "STATE_SHUTDOWN_ACK_SENT",
};

/* Events that could change the state of an association.  */
const char *const sctp_evttype_tbl[] = {
    "EVENT_T_unknown",
    "EVENT_T_CHUNK",
    "EVENT_T_TIMEOUT",
    "EVENT_T_OTHER",
    "EVENT_T_PRIMITIVE"
};

/* Return value of a state function */
const char *const sctp_status_tbl[] = {
    "DISPOSITION_DISCARD",
    "DISPOSITION_CONSUME",
    "DISPOSITION_NOMEM",
    "DISPOSITION_DELETE_TCB",
    "DISPOSITION_ABORT",
    "DISPOSITION_VIOLATION",
    "DISPOSITION_NOT_IMPL",
    "DISPOSITION_ERROR",
    "DISPOSITION_BUG"
};

/* Printable forms of primitives */
static const char *const sctp_primitive_tbl[SCTP_NUM_PRIMITIVE_TYPES] = {
    "PRIMITIVE_ASSOCIATE",
    "PRIMITIVE_SHUTDOWN",
    "PRIMITIVE_ABORT",
    "PRIMITIVE_SEND",
    "PRIMITIVE_REQUESTHEARTBEAT",
    "PRIMITIVE_ASCONF",
};

/* Lookup primitive debug name. */
const char *sctp_pname(const sctp_subtype_t id)
{
    if (id.primitive <= SCTP_EVENT_PRIMITIVE_MAX)
        return sctp_primitive_tbl[id.primitive];
    return "unknown_primitive";
}

static const char *const sctp_other_tbl[] = {
    "NO_PENDING_TSN",
    "ICMP_PROTO_UNREACH",
};

/* Lookup "other" debug name. */
const char *sctp_oname(const sctp_subtype_t id)
{
    if (id.other <= SCTP_EVENT_OTHER_MAX)
        return sctp_other_tbl[id.other];
    return "unknown 'other' event";
}

static const char *const sctp_timer_tbl[] = {
    "TIMEOUT_NONE",
    "TIMEOUT_T1_COOKIE",
    "TIMEOUT_T1_INIT",
    "TIMEOUT_T2_SHUTDOWN",
    "TIMEOUT_T3_RTX",
    "TIMEOUT_T4_RTO",
    "TIMEOUT_T5_SHUTDOWN_GUARD",
    "TIMEOUT_HEARTBEAT",
    "TIMEOUT_SACK",
    "TIMEOUT_AUTOCLOSE",
};

/* Lookup timer debug name. */
const char *sctp_tname(const sctp_subtype_t id)
{
    if (id.timeout <= SCTP_EVENT_TIMEOUT_MAX)
        return sctp_timer_tbl[id.timeout];
    return "unknown_timer";
}