tcp_stats.h revision 721fffe35d40e548a5a58dc53a2ec9c6762172d9
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * CDDL HEADER START
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * The contents of this file are subject to the terms of the
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * Common Development and Distribution License (the "License").
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * You may not use this file except in compliance with the License.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * See the License for the specific language governing permissions
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * and limitations under the License.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * When distributing Covered Code, include this CDDL HEADER in each
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * If applicable, add the following below this CDDL HEADER, with the
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * fields enclosed by brackets "[]" replaced with your own identifying
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * information: Portions Copyright [yyyy] [name of copyright owner]
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * CDDL HEADER END
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * Use is subject to license terms.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * TCP private kernel statistics declarations.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * TCP Statistics.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * How TCP statistics work.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * There are two types of statistics invoked by two macros.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * TCP_STAT(name) does non-atomic increment of a named stat counter. It is
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * supposed to be used in non MT-hot paths of the code.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * TCP_DBGSTAT(name) does atomic increment of a named stat counter. It is
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * supposed to be used for DEBUG purposes and may be used on a hot path.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * These counters are only available in a debugged kerel. They are grouped
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * under the TCP_DEBUG_COUNTER C pre-processor condition.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * Both TCP_STAT and TCP_DBGSTAT counters are available using kstat
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * (use "kstat tcp" to get them).
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * How to add new counters.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * 1) Add a field in the tcp_stat structure describing your counter.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * 2) Add a line in the template in tcp_kstat2_init() with the name
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * of the counter.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * 3) Update tcp_clr_stats() and tcp_cp_stats() with the new counters.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * IMPORTANT!! - make sure that all the above functions are in sync !!
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * 4) Use either TCP_STAT or TCP_DBGSTAT with the name.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * Please avoid using private counters which are not kstat-exported.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * Implementation note.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * Both the MIB2 and tcp_stat_t counters are kept per CPU in the array
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * tcps_sc in tcp_stack_t. Each array element is a pointer to a
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * tcp_stats_cpu_t struct. Once allocated, the tcp_stats_cpu_t struct is
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * not freed until the tcp_stack_t is going away. So there is no need to
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon * acquire a lock before accessing the stats counters.
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poontypedef struct tcp_stat {
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poontypedef struct tcp_g_stat {
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon/* Per CPU stats: TCP MIB2, TCP kstat and connection counter. */
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poontypedef struct {
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon BUMP_MIB(&(tcps)->tcps_sc[CPU->cpu_seqid]->tcp_sc_mib, x)
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon UPDATE_MIB(&(tcps)->tcps_sc[CPU->cpu_seqid]->tcp_sc_mib, x, y)
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon &((tcps)->tcps_sc[CPU->cpu_seqid]->tcp_sc_stats.x.value.ui64))
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon atomic_inc_64(&(tcp_g_statistics.x.value.ui64))
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon#define TCP_G_STAT(x) (tcp_g_statistics.x.value.ui64++)
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon ((tcps)->tcps_sc[CPU->cpu_seqid]->tcp_sc_stats.x.value.ui64++)
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon ((tcps)->tcps_sc[CPU->cpu_seqid]->tcp_sc_stats.x.value.ui64 += (n))
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon ((tcps)->tcps_sc[CPU->cpu_seqid]->tcp_sc_stats.x.value.ui64 = (n))
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poonextern void tcp_kstat_fini(netstackid_t, kstat_t *);
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poonextern void tcp_kstat2_fini(netstackid_t, kstat_t *);
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon#endif /* _KERNEL */
721fffe35d40e548a5a58dc53a2ec9c6762172d9Kacheong Poon#endif /* _INET_TCP_STATS_H */