fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * CDDL HEADER START
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * The contents of this file are subject to the terms of the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Common Development and Distribution License (the "License").
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * You may not use this file except in compliance with the License.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * See the License for the specific language governing permissions
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * and limitations under the License.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * When distributing Covered Code, include this CDDL HEADER in each
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * If applicable, add the following below this CDDL HEADER, with the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * fields enclosed by brackets "[]" replaced with your own identifying
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * information: Portions Copyright [yyyy] [name of copyright owner]
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * CDDL HEADER END
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Use is subject to license terms.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * This file contains all the definitions and prototypes relevant to KSTAT.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * It also contains the declaration and initialization of data. When including
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * this file, if _INIT_KSTAT_DATA_ is defined, the data is declared AND
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * initialized. As a consequence, this file should be included only once with
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _INIT_KSTAT_DATA_ defined. Failure to do so will lead to a link error.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Today, iscsi_stats.c is the only file defining _INIT_KSTAT_DATA_.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Four types of KSTAT structures are created for iSCSI.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * sun_iscsi_hba
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * -------------
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * This structure gathers statistics relevant to an HBA. Each HBA or
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * software state structure is given one. It contains the following
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _name iSCSI name of the HBA
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _alias iSCSI alias of the HBA
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cntr_sess Numbers of sessions created
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * sun_iscsi_sess
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * --------------
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * This structure gathers statistics relevant to a session. Each session
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * is given one. It contains the following fields:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _state State of the session
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _oid OID of the session
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _hba HBA the session belongs to. It is the name
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * of the sun_iscsi_hba structure of the HBA
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cntr_conn Number of connections
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cntr_pkt_pending Number of scsi_pkt in the pending queue
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cmd_sn CmdSN
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cmd_sn_exp CmdSNExp,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cmd_sn_max CmdSNMax
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * sun_iscsi_sess_io
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * -----------------
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * This structure is completely defined by the KSTAT frame work of Solaris.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * It contains accumulated time and queue length statistics. It assumes
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * the driver has a pending queue and an active. In our implementation,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * the pending queue is the pending queue defined in the session context.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * The active queue is any queue defined in the connection context.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * If you want more information about the meaning of the fields of this
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * structure you can read the nice explanation contained in the file:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * At any rate, all the sessions are given a sun_iscsi_sess_io structure.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * The fields are:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * nread number of bytes read without iSCSI overhead.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * nwritten number of bytes written without iSCSI overhead.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * reads number of read operations
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * writes number of write operations
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * wtime cumulative wait (pre-service) time
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * wlentime cumulative wait length*time product
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * wlastupdate last time wait queue changed
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * rtime cumulative run (service) time
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * rlentime cumulative run length*time product
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * rlastupdate last time run queue changed
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * wcnt count of elements in wait state
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * rcnt count of elements in run state
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * The time is expressed in nanoseconds.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * sun_iscsi_conn
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * --------------
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * This structure gathers statistics relevant to a connection. Each
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * connection is given one. It contains the following fields:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _state State of the connection
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cid iSCSI CID
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _oid OID of the connection
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _session Session the connection belongs to. It is the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * name of the sun_iscsi_sess structure of the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _err_header_digest Number of header digest errors
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _err_data_digest Number of data digest errors
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _err_connection_reset Number of reset
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _err_protocol_error Number of protocol errors
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cntr_tx_bytes Number of bytes transmitted with iSCSI overhead.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cntr_rx_bytes Number of bytes received with iSCSI overhead.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _cntr_qactive Number of requests in the active queue.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _stat_sn_exp ExpStatusSN
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * _stat_sn_last LastStatusSN (Last one sent to the target)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * The KSTAT frame work of Solaris associates a module name, a instance number
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * a class and a name to every kstat structure. All the kstat structures of
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * iSCSI have the same module name. It is define farther down in this file to
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * "iscsi". Regarding the class, three classes are defined here. Those classes
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * - issci_hba
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * - iscsi_sess
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * - iscsi_conn
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * The instance number is the number returned by ddi_get_instance. Today the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * the driver creates one HBA only. Therefore, all the structures will have
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * zero as instance number.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Each kstat structure can be named. The naming convention is the following:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * KSTAT Struct Class Name
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * sun_iscsi_hba iscsi_hba "sun_iscsi_hba" + instance number
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * sun_iscsi_sess iscsi_sess "sun_iscsi_sess" + session oid
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * sun_iscsi_sess_io iscsi_sess "sun_iscsi_sess_io" + session oid
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * sun_iscsi_conn iscsi_conn "sun_iscsi_conn" + connection oid
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * strings used by kstat (Module name and Class name).
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * ========================= Connection Class Section ======================
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define iSCSI_CONN_BASE_NAME "iscsi_conn_%d_%d_%d"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define ISCSI_CONN_STATE_LOGGED_IN_STR "logged_in"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define ISCSI_CONN_STATE_IN_LOGOUT_STR "in_logout"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define ISCSI_CONN_STATE_CLEANUP_WAIT_STR "cleanup_wait"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * WARNING: The order of this enum important. If you change it you have to
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * reorder the table kstat_items_conn (in the file iscsi_stats.c)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * accordingly.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_icp_->stats.ks_data.kn[KN_CONN_IDX_ERR_HDR_DIGEST].value.ul++)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_icp_->stats.ks_data.kn[KN_CONN_IDX_ERR_DATA_DIGEST].value.ul++)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_icp_->stats.ks_data.kn[KN_CONN_IDX_ERR_PROTOCOL].value.ul++)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_icp_->stats.ks_data.kn[KN_CONN_IDX_ERR_CONN_RESET].value.ul++)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_icp_->stats.ks_data.kn[KN_CONN_IDX_CNTR_TX_BYTES].value.ui64 += \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_icp_->stats.ks_data.kn[KN_CONN_IDX_CNTR_RX_BYTES].value.ui64 += \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * ========================== Session Class Section ========================
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte/* Session Class */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define iSCSI_SESS_IO_BASE_NAME "iscsi_sess_io_%d_%d"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define ISCSI_SESS_STATE_LOGGED_IN_STR "logged_in"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * WARNING: The order of this enum important. If you change it you have to
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * reorder the table kstat_items_sess (in the file iscsi_stats.c)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * accordingly.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_isp_->stats.ks_data.kn[KN_SESS_IDX_CNTR_RESET].value.ul++)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_isp_->stats.ks_data.kn[KN_SESS_IDX_CNTR_CONN].value.ul++)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_isp_->stats.ks_data.kn[KN_SESS_IDX_CNTR_CONN].value.ul--)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define KSTAT_ADD_SESS_CNTR_TX_BYTES(_isp_, _v_) \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define KSTAT_ADD_SESS_CNTR_RX_BYTES(_isp_, _v_) \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * ============================ HBA Class Section ==========================
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * WARNING: The order of this enum important. If you change it you have to
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * reorder the table kstat_items_hba (in iscsi_stats.c) accordingly.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_ihp_->stats.ks_data.kn[KN_HBA_IDX_CNTR_SESS].value.ul++)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte (_ihp_->stats.ks_data.kn[KN_HBA_IDX_CNTR_SESS].value.ul--)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#endif /* _ISCSI_STATS_H */