From owner-svn-src-head@freebsd.org Sun May 27 18:43:16 2018 Return-Path: Delivered-To: svn-src-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id D656AF7CE2C; Sun, 27 May 2018 18:43:15 +0000 (UTC) (envelope-from dteske@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 880D6694A7; Sun, 27 May 2018 18:43:15 +0000 (UTC) (envelope-from dteske@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 6923922523; Sun, 27 May 2018 18:43:15 +0000 (UTC) (envelope-from dteske@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w4RIhFvK066964; Sun, 27 May 2018 18:43:15 GMT (envelope-from dteske@FreeBSD.org) Received: (from dteske@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w4RIhFXQ066963; Sun, 27 May 2018 18:43:15 GMT (envelope-from dteske@FreeBSD.org) Message-Id: <201805271843.w4RIhFXQ066963@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: dteske set sender to dteske@FreeBSD.org using -f From: Devin Teske Date: Sun, 27 May 2018 18:43:15 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r334257 - head/share/man/man4 X-SVN-Group: head X-SVN-Commit-Author: dteske X-SVN-Commit-Paths: head/share/man/man4 X-SVN-Commit-Revision: 334257 X-SVN-Commit-Repository: base MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-head@freebsd.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: SVN commit messages for the src tree for head/-current List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 27 May 2018 18:43:16 -0000 Author: dteske Date: Sun May 27 18:43:14 2018 New Revision: 334257 URL: https://svnweb.freebsd.org/changeset/base/334257 Log: Add manual page for the sctp DTrace provider. Sponsored by: Smule, Inc. Added: head/share/man/man4/dtrace_sctp.4 (contents, props changed) Modified: head/share/man/man4/Makefile Modified: head/share/man/man4/Makefile ============================================================================== --- head/share/man/man4/Makefile Sun May 27 17:49:27 2018 (r334256) +++ head/share/man/man4/Makefile Sun May 27 18:43:14 2018 (r334257) @@ -910,6 +910,7 @@ _dtrace_provs= dtrace_io.4 \ dtrace_lockstat.4 \ dtrace_proc.4 \ dtrace_sched.4 \ + dtrace_sctp.4 \ dtrace_tcp.4 \ dtrace_udp.4 .endif Added: head/share/man/man4/dtrace_sctp.4 ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/share/man/man4/dtrace_sctp.4 Sun May 27 18:43:14 2018 (r334257) @@ -0,0 +1,131 @@ +.\" Copyright (c) 2018 Devin Teske +.\" 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. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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. +.\" +.\" $FreeBSD$ +.\" +.Dd April 22, 2018 +.Dt DTRACE_SCTP 4 +.Os +.Sh NAME +.Nm dtrace_sctp +.Nd a DTrace provider for tracing events related to the +.Xr sctp 4 +protocol +.Sh SYNOPSIS +.Fn sctp:cwnd::init uint32_t uint32_t uintptr_t int int +.Fn sctp:cwnd::ack uint32_t uint32_t uintptr_t int int +.Fn sctp:cwnd::rttvar uint64_t uint64_t uint64_t uint64_t uint64_t +.Fn sctp:cwnd::rttstep uint64_t uint64_t uint64_t uint64_t uint64_t +.Fn sctp:cwnd::fr uint32_t uint32_t uintptr_t int int +.Fn sctp:cwnd::to uint32_t uint32_t uintptr_t int int +.Fn sctp:cwnd::bl uint32_t uint32_t uintptr_t int int +.Fn sctp:cwnd::ecn uint32_t uint32_t uintptr_t int int +.Fn sctp:cwnd::pd uint32_t uint32_t uintptr_t int int +.Fn sctp:rwnd:assoc:val uint32_t uint32_t int int +.Fn sctp:flightsize:net:val uint32_t uint32_t uintptr_t int int +.Fn sctp:flightsize:assoc:val uint32_t uint32_t int int +.Sh DESCRIPTION +The DTrace +.Nm sctp +provider allows users to trace events in the +.Xr sctp 4 +protocol implementation. +This provider is similar to the +.Xr dtrace_ip 4 +and +.Xr dtrace_udp 4 +providers, +but additionally contains probes corresponding to protocol events at a level +higher than packet reception and transmission. +.Pp +The +.Fn sctp:cwnd:: +probes track changes in the congestion window on a netp. +The +.Fn sctp:rwnd:: +probes track changes in the receiver window for an assoc. +The +.Fn sctp:flightsize:net:val +probe tracks changes in the flight size on a net or assoc and the +.Fn sctp:flightsize:assoc:val +probe provides the total flight version. +.Pp +The arguments of all +.Nm sctp +probes except for +.Fn sctp:cwnd::rtt* +and +.Fn sctp::assoc:val +are the Vtag for this end, +the port number of the local side, +the pointer to +.Dv struct sctp_nets *changing , +the old value of the cwnd, +and the new value of the cwnd. +.Pp +The arguments of +.Fn sctp:::val +are similar to the above except the fourth argument is the up/down amount. +.Pp +The +.Fn sctp:cwnd::rtt* +probe arguments are a bitmap of +.Dv Vtag << 32 | localport << 16 | remoteport , +a bitmap of +.Dv obw | nbw , +a bitmap of +.Dv bwrtt | newrtt , +.Dv flight , +and a bitmap of +.Dv (cwnd << 32) | point << 16 | retval(0/1) . +.Pp +The +.Fn sctp:cwnd::init +probe fires when a remotely-initiated active SCTP open succeeds. +At this point the new connection is in the ESTABLISHED state, and the probe +arguments expose the headers associated with the final ACK of the four-way +handshake. +.\" .Sh ARGUMENTS +.\" .Sh FILES +.\" .Sh EXAMPLES +.\" .Sh COMPATIBILITY +.\" This provider has not been tested for compatiblity with the +.\" .Nm sctp +.\" provider in Solaris +.\" .Pq if one exists . +.Sh SEE ALSO +.Xr dtrace 1 , +.Xr dtrace_ip 4 , +.Xr dtrace_udp 4 , +.Xr sctp 4 , +.Xr SDT 9 +.\" .Sh HISTORY +.\" The +.\" .Nm sctp +.\" provider first appeared in +.\" .Fx +.\" UNKNOWN. +.Sh AUTHORS +This manual page was written by +.An Devin Teske Aq Mt dteske@FreeBSD.org .