From patchwork Wed Oct 25 00:13:30 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: yupeng X-Patchwork-Id: 830072 X-Patchwork-Delegate: shemminger@vyatta.com Return-Path: X-Original-To: patchwork-incoming@ozlabs.org Delivered-To: patchwork-incoming@ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="b5o5mwZP"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 3yM9bP25JCz9s5L for ; Wed, 25 Oct 2017 11:13:37 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751711AbdJYANd (ORCPT ); Tue, 24 Oct 2017 20:13:33 -0400 Received: from mail-it0-f52.google.com ([209.85.214.52]:48894 "EHLO mail-it0-f52.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751591AbdJYANb (ORCPT ); Tue, 24 Oct 2017 20:13:31 -0400 Received: by mail-it0-f52.google.com with SMTP id c3so12111234itc.3 for ; Tue, 24 Oct 2017 17:13:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to:cc; bh=vFM6gpufC9IU2JNNdAgRDdtbi0RM86U074dHQ/W6jh8=; b=b5o5mwZPXhzUhhLP75w5vJPeGPHPlArUPDa/kSQyIPFepW4MHquKqZbUYgfGoKDg8U xB66BEWiJlhp8zZt6+FFwoPh3kbRc8IsgwAUNjhQGGZAqn4JcKrVieYZWJfenQZjzPxh qsYwl/+CnOEvwOuVy3T8Z7seeDNYwztaCIyW53oVRmd0zKn7fBJp4CHE/Q9kvuTO2FJ5 CkT2mw8MTkUFMqiko1oUfsSgJYk0c//MGNOuMnbtFXQW73M0EZ7lrXSdtQvD3/nuW53I lHSn7WJi2OF1yy3EGlVU7GaG1xwWDQOpFtqsAzixuLJxRhLBVmA+fGOdmVdg0le/GXDp zMgg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to:cc; bh=vFM6gpufC9IU2JNNdAgRDdtbi0RM86U074dHQ/W6jh8=; b=GspnTfoej25Wso4jQAY5CqKBa2bHB3EaofgAJmJs80P+EdCt4M4tiis3YJMj7dcU+g IXoR6GUzybzFg5Rs2eL7fLRQAl/0WL2iL/4abvXHOyR3eoAJobEwdKTpObQefSwlo/57 PtPCOHDUW9sfs0HJFWEpEP5UwQDeUR+VURRLeJqM2CUr/fbEJyotiauCctoC3OxM30+T ebjTQ0yfJsfNajU0i876XQ+Q/Y+vDG4P6BkXjhMobcnUD2MQMAzhp/0IFDoS6LqgoMw5 fTKwjEEiprOlkcD1IBBHsLjbu7GuhabdxmgJH4EvPBbSWVs9QFeWeD6TFhks2qIhb+Yn ri7w== X-Gm-Message-State: AMCzsaWxBm8wA40trRqq/M2lr8ucw4SglM1m+boRWl4FTJNc1x03v96E tvO3oGaZZb91xHTKGgO8b6ryWzfYHcDcm909F9bpKQ== X-Google-Smtp-Source: ABhQp+Q10wb8gJOpObxafQhNMJyrQ2vMHdIC71u5H3yoznS2OqTmT64FR+7Bg/c39ySwueC8do4rl2BtfTGnLjMm1Ds= X-Received: by 10.36.204.70 with SMTP id x67mr353753itf.133.1508890410854; Tue, 24 Oct 2017 17:13:30 -0700 (PDT) MIME-Version: 1.0 Received: by 10.107.134.234 with HTTP; Tue, 24 Oct 2017 17:13:30 -0700 (PDT) From: peng yu Date: Tue, 24 Oct 2017 17:13:30 -0700 Message-ID: Subject: [iproute PATCH] ss: add detail explains of -m, -o, -e and -i options in ss man page To: netdev@vger.kernel.org Cc: stephen@networkplumber.org, phil@nwl.cc Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org commit 340a45f79395144bd14fdf9be1904c0036456b6e Author: yupeng Date: Tue Oct 24 23:55:29 2017 +0000 add additional explain in ss man page Add detail explains of -m, -o, -e and -i options, which are not documented anywhere Signed-off-by: Peng Yu +how long time since the last ack received, the unit is millisecond + +.B pacing_rate bps/bps +the pacing rate and max pacing rate + +.B rcv_space: +a helper variable for TCP internal auto tunning socket receive buffer + .SH USAGE EXAMPLES .TP .B ss -t -a diff --git a/man/man8/ss.8 b/man/man8/ss.8 index 3bec97f..4597733 100644 --- a/man/man8/ss.8 +++ b/man/man8/ss.8 @@ -176,6 +176,147 @@ states except for - opposite to .B bucket +.SH Additional explain of -m, -o, -e and -i options +Some fields may have different meanings if the netowrk protocl is different. Below explain focus on tcp protocol. +.TP +.B -m option +skmem:(r,rb,t,tb,f,w,o,bl) + +.B +the memory allocated for receiving package + +.B +the total memory can be allocated for receiving package + +.B +the memory used for sending package (which has been sent to layer 3) + +.B +the total memory can be allocated for sending package + +.B +the memory allocated by the socket as cache, but not used for receiving/sending pacakge yet. If need memory to send/receive package, the memory in this cache will be used before allocate additional memory. + +.B +The memory allocated for sending package (which has not been sent to layer 3) + +.B +The memory used for storing socket option, e.g., the key for TCP MD5 signature + +.B +The memory used for the sk backlog queue. On a process context, if the process is receving package, and a new package is received, it will be put into the sk backlog queue, so it can be received by the process immediately +.TP +.B -o option +timer:(,,) + +.B +the name of the timer, there are five kind of timer names: + +.BR on ": means one of these timers: tcp retrans timer, tcp early retrans timer and tail loss probe timer" + +.BR keepalive ": tcp keep alive timer" + +.BR timewait ": timewait stage timer" + +.BR persist ": zero window probe timer" + +.BR unknown ": none of the above timers" + +.B +how long time the timer will expire + +.B +how many times the retran occurs +.TP + +.B -e option +uid: ino: sk: + +.B +the user id the socket belongs to + +.B +the socket's inode number in VFS + +.B +an uuid of the socket + +.TP +.B -i option +show tcp internal information + +.B ts +show string "ts" if the timestamp option is set + +.B sack +show string "sack" if the sack option is set + +.B ecn +show string "ecn" if the explicit congestion notification option is set + +.B ecnseen +show string "ecnseen" if the saw ecn flag is found in received packages + +.B fastopen +show string "fastopen" if the fastopen option is set + +.B cong_alg +the congestion algorithm name, the default congestion algorithm is "cubic" + +.B wscale:: +if window scale option is used, this field shows the send scale factory and receive scale factory + +.B rto: +tcp retransmission timeout value, the unit is millisecond + +.B backoff: +used for exponential backoff retransmission, the actual retransmission timeout vaule is icsk_rto << icsk_backoff + +.B rtt:/ +rtt is the average round trip time, rttvar is the mean deviation of rtt, their units are millisecond + +.B ato: +ack timeout, unit is millisecond, used for delay ack mode + +.B mss: +max segment size + +.B cwnd: +congestion window size + +.B ssthresh: +tcp congestion window slow start threshold + +.B bytes_acked: +bytes acked + +.B bytes_received: +bytes received + +.B segs_out: +segments sent out + +.B segs_in: +segments received + +.B send bps +egress bps + +.B lastsnd: +how long time since the last package sent, the unit is millisecond + +.B lastrcv: +how long time since the last package received, the unit is millisecond + +.B lastack: