Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Dongli Zhang <dongli.zhang@oracle.com>
To:     netdev@vger.kernel.org, bpf@vger.kernel.org
Cc:     linux-kernel@vger.kernel.org, davem@davemloft.net, kuba@kernel.org,
        rostedt@goodmis.org, mingo@redhat.com, ast@kernel.org,
        daniel@iogearbox.net, andrii@kernel.org, imagedong@tencent.com,
        joao.m.martins@oracle.com, joe.jin@oracle.com, dsahern@gmail.com,
        edumazet@google.com
Subject: [PATCH net-next v5 4/4] net: tun: track dropped skb via kfree_skb_reason()
Date:   Thu,  3 Mar 2022 22:33:07 -0800
Message-Id: <20220304063307.1388-5-dongli.zhang@oracle.com>
In-Reply-To: <20220304063307.1388-1-dongli.zhang@oracle.com>
References: <20220304063307.1388-1-dongli.zhang@oracle.com>
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?2/9IdlanHcCm1e4L1hmsMHcgUWPWkRyJEzfvJNKfn2tRNWx6mkMgqoOB+VTG?=
 =?us-ascii?Q?nro73qocQ6t9vZrul8CHltONu9f4LlzYhwZxYNv+RTdeS/7ARAypK7ESj7yP?=
 =?us-ascii?Q?KKdn7LZSyLHT8aQGBc+hOA2I3jVdharlsHqrFL0ZLGJYte/dQu1qcX8h6Aus?=
 =?us-ascii?Q?7YrkH1zLdNTUSbBxKBaprK1P/wA2fPwcyP6Hi1ckYCIcGnhI2GeFSE2aLgNx?=
 =?us-ascii?Q?ihwvvWiq3ratJvyC8Njjf95SkqQMfCC/5CkG717qFZtaRecprBvBmwnuV7lP?=
 =?us-ascii?Q?LA4ngt346TQw0NF+/hywJxtXY8OQeIWIwDoxTrSbZEAy2ABj+e562H+w6j+N?=
 =?us-ascii?Q?1udAoeR7MQ/VtBBuPZN0zXfz5di2Unw81cHUWQU+Y7hcYapNsNoaP3to8e+o?=
 =?us-ascii?Q?WnwN/JTvi+VBR8G58MivYv0w+dQ5ZfnfI67mx3MMj5PhWjG70DZy2vjl8kxb?=
 =?us-ascii?Q?DGxf8XGNG9SEMglX4qcAyjm0pdR4KQGsrBw2MdVa6s34QSxQs0t5O8P7gVJl?=
 =?us-ascii?Q?vdc4FtoIHEgNCzqDVlqjkGiQJjq4TFVLbQ7C2QiD8eUScHKuI1cIUJGtx1EW?=
 =?us-ascii?Q?R7BhriCz9VlM5bDM5XaN2RCZQI7at1N/8dv9fKnjSpZj7RPi5vHOffFv0EGP?=
 =?us-ascii?Q?9ptYHbVUS/u6x4R/psSBJpLACZwz9DxBiT6GWbkosS9ducCWBW+MscY58dZK?=
 =?us-ascii?Q?c4p0CE/s8XneIjSy+pzaYP+scoFPnltL9fpQ/eqTWz6ZI5lIGLn8M13DcOMP?=
 =?us-ascii?Q?bKoCKrpYNmB0mmgNpTL21T+q2+ujh4HJLTUc37c+yFmpqoom8bEgu7iL2anu?=
 =?us-ascii?Q?/K1iP1saB0Xr+tgzUdx09TLXckQAyXqCToVCyMqPrjJlS3eWqC7IdPnA8Ctc?=
 =?us-ascii?Q?yLMoNtfsIQy8BlO/4WiUuJhN3ObCsUFW58vgjOmrOfG4/Jx+5aybPr2B+qGh?=
 =?us-ascii?Q?TRSQxo9yfHts4vyqwFLhW3lh7b5HtXD2gjBTgsLR4j1DYf156jayYK9OY+YO?=
 =?us-ascii?Q?wFcg6dqCkQBD50QFoscTMeGALfyIeeTnco3JTTqtS1GTaOEAsIxGV6AWUZlh?=
 =?us-ascii?Q?k75+kyPQ2KK7EiAcys3R8CPUbtn0jkCmDNoUg5bU45dILUbh52E+NPFbo/UK?=
 =?us-ascii?Q?vweCezjshRpvinGTZPAkaMQF7Hu7YsnK/m89TAH2xqPl3ngXI24HW23SI9kU?=
 =?us-ascii?Q?c8W3FTTh8NTuK3vnaJ1LOkrcXZC3eVF1TedLwuRlG3DPO0AZajcl4Wz7i8jm?=
 =?us-ascii?Q?ey7ua5lm/KIRWqPuDLyRLDxiofyxtwtTVe9nQUzRn+l10JCg7Mb6BJkLn2aD?=
 =?us-ascii?Q?77EaA7acktq06dDUNe0vsizupKXx1sN4X96i2NCqaSrfyZw2W+Ap3Ctb9l0u?=
 =?us-ascii?Q?EU6E4qp1LQZuxJ+35rdXewOR7Hxn5qUzFmVzYNMj1hSz4tcPftVyokcJ7zpG?=
 =?us-ascii?Q?Cr//5rhSswZEnmnfVbovLtRI5FCYfR52zohQ31xtlZmNOU24lruK5bC9xuzR?=
 =?us-ascii?Q?OQnogb9XDouWsWWhP02YfBE+VojKSgBCI5SLW799pexCMTPrqdfdKSvx1KSS?=
 =?us-ascii?Q?3KouYfGnLSM7qTOjcUosdlScNxwby3iZ5NVuBd+be49qcrDzx5DpMWaIJlyn?=
 =?us-ascii?Q?mInE5UncYxySPD5CBKlF79A=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 96bcaa28-a64f-4a2d-fe23-08d9fda8e33c
X-MS-Exchange-CrossTenant-AuthSource: BYAPR10MB2663.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Mar 2022 06:33:26.0112
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: mRfB7xDpJse0cYJxC/aOzwwmH2dxDpY1WAzIteCp7ybDZ46ofj57N+5ryz8nuzkf8TObBwfhDQPyPWTnFa6uqw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA2PR10MB4603
X-Proofpoint-Virus-Version: vendor=nai engine=6300 definitions=10275 signatures=686983
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 adultscore=0 phishscore=0 bulkscore=0
 malwarescore=0 mlxscore=0 spamscore=0 suspectscore=0 mlxlogscore=999
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2202240000
 definitions=main-2203040031
X-Proofpoint-GUID: quM5ieBm3W7nlr0Jt3hbg_D0-29Co6ZI
X-Proofpoint-ORIG-GUID: quM5ieBm3W7nlr0Jt3hbg_D0-29Co6ZI
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,
        RCVD_IN_MSPIKE_H5,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

The TUN can be used as vhost-net backend. E.g, the tun_net_xmit() is the
interface to forward the skb from TUN to vhost-net/virtio-net.

However, there are many "goto drop" in the TUN driver. Therefore, the
kfree_skb_reason() is involved at each "goto drop" to help userspace
ftrace/ebpf to track the reason for the loss of packets.

The below reasons are introduced:

- SKB_DROP_REASON_DEV_READY
- SKB_DROP_REASON_NOMEM
- SKB_DROP_REASON_HDR_TRUNC
- SKB_DROP_REASON_TAP_FILTER
- SKB_DROP_REASON_TAP_TXFILTER

Cc: Joao Martins <joao.m.martins@oracle.com>
Cc: Joe Jin <joe.jin@oracle.com>
Signed-off-by: Dongli Zhang <dongli.zhang@oracle.com>
---
Changed since v1:
  - revise the reason name
Changed since v2:
  - declare drop_reason as type "enum skb_drop_reason"
Changed since v3:
  - rename to TAP_FILTER and TAP_TXFILTER
  - honor reverse xmas tree style declaration for 'drop_reason' in
    tun_net_xmit()
Changed since v4:
  - expand comment on DEV_READY
  - change SKB_TRIM to NOMEM
  - chnage SKB_PULL to HDR_TRUNC

 drivers/net/tun.c          | 37 ++++++++++++++++++++++++++++---------
 include/linux/skbuff.h     | 18 ++++++++++++++++++
 include/trace/events/skb.h |  5 +++++
 3 files changed, 51 insertions(+), 9 deletions(-)

diff --git a/drivers/net/tun.c b/drivers/net/tun.c
index 6e06c846fe82..bab92e489fba 100644
--- a/drivers/net/tun.c
+++ b/drivers/net/tun.c
@@ -1058,6 +1058,7 @@ static unsigned int run_ebpf_filter(struct tun_struct *tun,
 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
 {
 	struct tun_struct *tun = netdev_priv(dev);
+	enum skb_drop_reason drop_reason;
 	int txq = skb->queue_mapping;
 	struct netdev_queue *queue;
 	struct tun_file *tfile;
@@ -1067,8 +1068,10 @@ static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
 	tfile = rcu_dereference(tun->tfiles[txq]);
 
 	/* Drop packet if interface is not attached */
-	if (!tfile)
+	if (!tfile) {
+		drop_reason = SKB_DROP_REASON_DEV_READY;
 		goto drop;
+	}
 
 	if (!rcu_dereference(tun->steering_prog))
 		tun_automq_xmit(tun, skb);
@@ -1078,22 +1081,32 @@ static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
 	/* Drop if the filter does not like it.
 	 * This is a noop if the filter is disabled.
 	 * Filter can be enabled only for the TAP devices. */
-	if (!check_filter(&tun->txflt, skb))
+	if (!check_filter(&tun->txflt, skb)) {
+		drop_reason = SKB_DROP_REASON_TAP_TXFILTER;
 		goto drop;
+	}
 
 	if (tfile->socket.sk->sk_filter &&
-	    sk_filter(tfile->socket.sk, skb))
+	    sk_filter(tfile->socket.sk, skb)) {
+		drop_reason = SKB_DROP_REASON_SOCKET_FILTER;
 		goto drop;
+	}
 
 	len = run_ebpf_filter(tun, skb, len);
-	if (len == 0)
+	if (len == 0) {
+		drop_reason = SKB_DROP_REASON_TAP_FILTER;
 		goto drop;
+	}
 
-	if (pskb_trim(skb, len))
+	if (pskb_trim(skb, len)) {
+		drop_reason = SKB_DROP_REASON_NOMEM;
 		goto drop;
+	}
 
-	if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC)))
+	if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC))) {
+		drop_reason = SKB_DROP_REASON_SKB_UCOPY_FAULT;
 		goto drop;
+	}
 
 	skb_tx_timestamp(skb);
 
@@ -1104,8 +1117,10 @@ static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
 
 	nf_reset_ct(skb);
 
-	if (ptr_ring_produce(&tfile->tx_ring, skb))
+	if (ptr_ring_produce(&tfile->tx_ring, skb)) {
+		drop_reason = SKB_DROP_REASON_FULL_RING;
 		goto drop;
+	}
 
 	/* NETIF_F_LLTX requires to do our own update of trans_start */
 	queue = netdev_get_tx_queue(dev, txq);
@@ -1122,7 +1137,7 @@ static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
 drop:
 	atomic_long_inc(&dev->tx_dropped);
 	skb_tx_error(skb);
-	kfree_skb(skb);
+	kfree_skb_reason(skb, drop_reason);
 	rcu_read_unlock();
 	return NET_XMIT_DROP;
 }
@@ -1720,6 +1735,7 @@ static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
 	u32 rxhash = 0;
 	int skb_xdp = 1;
 	bool frags = tun_napi_frags_enabled(tfile);
+	enum skb_drop_reason drop_reason;
 
 	if (!(tun->flags & IFF_NO_PI)) {
 		if (len < sizeof(pi))
@@ -1823,9 +1839,10 @@ static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
 
 		if (err) {
 			err = -EFAULT;
+			drop_reason = SKB_DROP_REASON_SKB_UCOPY_FAULT;
 drop:
 			atomic_long_inc(&tun->dev->rx_dropped);
-			kfree_skb(skb);
+			kfree_skb_reason(skb, drop_reason);
 			if (frags) {
 				tfile->napi.skb = NULL;
 				mutex_unlock(&tfile->napi_mutex);
@@ -1872,6 +1889,7 @@ static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
 	case IFF_TAP:
 		if (frags && !pskb_may_pull(skb, ETH_HLEN)) {
 			err = -ENOMEM;
+			drop_reason = SKB_DROP_REASON_HDR_TRUNC;
 			goto drop;
 		}
 		skb->protocol = eth_type_trans(skb, tun->dev);
@@ -1925,6 +1943,7 @@ static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
 	if (unlikely(!(tun->dev->flags & IFF_UP))) {
 		err = -EIO;
 		rcu_read_unlock();
+		drop_reason = SKB_DROP_REASON_DEV_READY;
 		goto drop;
 	}
 
diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
index e5d5371a543b..4e5b725302ca 100644
--- a/include/linux/skbuff.h
+++ b/include/linux/skbuff.h
@@ -406,7 +406,25 @@ enum skb_drop_reason {
 	SKB_DROP_REASON_DEV_HDR,	/* device driver specific
 					 * header/metadata is invalid
 					 */
+	/* the device is not ready to xmit/recv due to any of its data
+	 * structure that is not up/ready/initialized, e.g., the IFF_UP is
+	 * not set, or driver specific tun->tfiles[txq] is not initialized
+	 */
+	SKB_DROP_REASON_DEV_READY,
 	SKB_DROP_REASON_FULL_RING,	/* ring buffer is full */
+	SKB_DROP_REASON_NOMEM,		/* error due to OOM */
+	SKB_DROP_REASON_HDR_TRUNC,      /* failed to trunc/extract the header
+					 * from networking data, e.g., failed
+					 * to pull the protocol header from
+					 * frags via pskb_may_pull()
+					 */
+	SKB_DROP_REASON_TAP_FILTER,     /* dropped by (ebpf) filter directly
+					 * attached to tun/tap, e.g., via
+					 * TUNSETFILTEREBPF
+					 */
+	SKB_DROP_REASON_TAP_TXFILTER,	/* dropped by tx filter implemented
+					 * at tun/tap, e.g., check_filter()
+					 */
 	SKB_DROP_REASON_MAX,
 };
 
diff --git a/include/trace/events/skb.h b/include/trace/events/skb.h
index 9d91ec9755b8..e167a6657748 100644
--- a/include/trace/events/skb.h
+++ b/include/trace/events/skb.h
@@ -49,7 +49,12 @@
 	EM(SKB_DROP_REASON_SKB_GSO_SEG, SKB_GSO_SEG)		\
 	EM(SKB_DROP_REASON_SKB_UCOPY_FAULT, SKB_UCOPY_FAULT)	\
 	EM(SKB_DROP_REASON_DEV_HDR, DEV_HDR)			\
+	EM(SKB_DROP_REASON_DEV_READY, DEV_READY)		\
 	EM(SKB_DROP_REASON_FULL_RING, FULL_RING)		\
+	EM(SKB_DROP_REASON_NOMEM, NOMEM)			\
+	EM(SKB_DROP_REASON_HDR_TRUNC, HDR_TRUNC)		\
+	EM(SKB_DROP_REASON_TAP_FILTER, TAP_FILTER)		\
+	EM(SKB_DROP_REASON_TAP_TXFILTER, TAP_TXFILTER)		\
 	EMe(SKB_DROP_REASON_MAX, MAX)
 
 #undef EM
-- 
2.17.1