Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19;
From:   Stephen Brennan <stephen.s.brennan@oracle.com>
To:     Andrew Morton <akpm@linux-foundation.org>
Cc:     linux-kernel@vger.kernel.org, David Howells <dhowells@redhat.com>,
        Len Baker <len.baker@gmx.com>,
        "Gustavo A. R. Silva" <gustavoars@kernel.org>
Subject: Re: [PATCH] assoc_array: Fix BUG_ON during garbage collect
In-Reply-To: <20220511225517.407935-1-stephen.s.brennan@oracle.com>
References: <20220511225517.407935-1-stephen.s.brennan@oracle.com>
Date:   Thu, 12 May 2022 14:49:54 -0700
Message-ID: <87ee0ys9od.fsf@stepbren-lnx.us.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?GiIMmhzJvweWcpUn5RA/Bq8COgtP2VDD/6duiu25M3pYqsTHtvt80twKLg/T?=
 =?us-ascii?Q?VQtOh4WSLUOPkkrnyLXTp6PgSMj+nHLEpyDkcezAQIPR+RBwLxsWhGaQNE2d?=
 =?us-ascii?Q?VpsYG2p1Go32Gs/d6YSWyApLutQMq6DHrYAk65T01KYCNIACLDbBfB32prjF?=
 =?us-ascii?Q?MPn1y6+pYCcISXWhhrUZ2WbT84ZYFWZTFs+pfWNZAXvc8lVCzQOcbcBwzzDX?=
 =?us-ascii?Q?1eBV4PG5NINsNI3ixX82KbKIgSMLbIZwgomct6X0YpBSg2bQbBs4qgAsRj6s?=
 =?us-ascii?Q?F5pdsh9nFcoNa0ACS4lFCCUd82GLlvfjjgZJcaNKmQo94yPQN3CuHIRZCYcM?=
 =?us-ascii?Q?S8ti3l8LijGN8+IegYiP12zNuQvmt+dEOkMyrWr+tyBIlZWXgKYH0Vt/OJIg?=
 =?us-ascii?Q?1KOadgswmMEjpc5hvu2ZZ8Qsuoqabv6PzHQnx+deh1OQ/hhUl6u5hnZmzc4E?=
 =?us-ascii?Q?d+9LSd16ZSRgaX4Pco0UrOIgMxpT9tw8jIxKDlecHleSPw/VvwoD9mwA0Sb6?=
 =?us-ascii?Q?XHgsx4J1R04dJHvKerQRJ8y3ZgOsp7N6MFa7X2edXDqoOYK8IZavWveBLaLu?=
 =?us-ascii?Q?J84TGhwM2drmPBkaVteI8EXsgasyyF9LSB44efrz1nVLReEVK9KdgnsngIhP?=
 =?us-ascii?Q?YLD/fDHQJDmOyCcoGPHFt4ug1768y8v++XG9J7yponUwHsMAaEOmua4ZwqDi?=
 =?us-ascii?Q?FdAPERJ3DrPMBtRouJ2dYQwzciG4hPHwbNQ2+AXw86O+enDKUv2YXOdj3OLt?=
 =?us-ascii?Q?H3lcUah+5EpSY91XAKXSqXwzc8zEi7+iCXpJ42wTtfaZsi6+5MGR1PIRck5U?=
 =?us-ascii?Q?VbMdkpe1P+J2x/9kaT1rQmgOdCS2rN7RUJWHm3hYJFxmFMgqoTCJIFsDGT1s?=
 =?us-ascii?Q?sHgIOOSTzS4D5vyINeR2nVmXZaQt9Lw/PWwFM2/5z8O1rPD7x3ZSRQjW5QDD?=
 =?us-ascii?Q?Mt0+FHFqdlBowHN6484CMmw/88poC55ZtJx/rzFk+ljMPFdul1o93KmY5ocx?=
 =?us-ascii?Q?bv8UsA+sVoTrv5ezlOnpLY2LmTpSCOUSkC/W3OtiPi8WV2Higj0VVvXDE5hY?=
 =?us-ascii?Q?Egaka/+GWUXObOOCsKKUCtUwa2TuP39QX7WLuMFt4rwiN/pFhXr0QfmnH3Gp?=
 =?us-ascii?Q?hLKbeqmrO25cfjYgqyX14KaLbGFbAOOjHmkztwRWDyxvfU1v9WTrqjt5gdSs?=
 =?us-ascii?Q?Ap6+szIb2JDMfPA42auc6arNYy4e5pvqGFJlj1/4ZgQjpLV7ftk/fpcFczXZ?=
 =?us-ascii?Q?WpOd+4WTmotpOAqvyTr/hcfIaMFI2SOweh0n7iwRC5HJfQaOjivbplbrhXpj?=
 =?us-ascii?Q?AuecA3eDsWoJcAZeB2JwYI27Q5VnXHVMD8DVO2LtPmbfvJTCHNB2unpzp5nl?=
 =?us-ascii?Q?+YzfAozqKadmg+893ytG87oYRLdFpsl4ZcQ3U2DEPOUC4YyQonn5nDbZJK/t?=
 =?us-ascii?Q?2cI3mIYsvF6iuxQeAicqrScjVv+S8DvOeKAINx26Vc+daEk10j0TljHl+y9p?=
 =?us-ascii?Q?3RG0kcvcle5VmbBDG8t2qHLiNZsMNVoHKAZPvhWCp2PxnsMhAae4+sEb0EKu?=
 =?us-ascii?Q?p3koUmfzYvh3g1k2WFUQhk7pchb1GpAWM3+xFONwQiktIf1NhPJp3rUj9PJ2?=
 =?us-ascii?Q?qPgmdybhCCUfF1DogEp1jVRe6sE4b7HVUHXsmah2p61ygHnrHPZISgt475jx?=
 =?us-ascii?Q?XIAIJfyuAKPIT1iASa7mgxc+Ds2ZgcKNZuieWGb4w7cT2x8Sc0Htx7xFTa7H?=
 =?us-ascii?Q?aaFYm53LH0DJJ+swXm4lyBjzC/Kx898=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1fd8f6d8-e694-4437-766b-08da34615b31
X-MS-Exchange-CrossTenant-AuthSource: CH2PR10MB4166.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 May 2022 21:49:57.4661
 (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: o0FXL7ulaiD94ut8iUEMns11X8Pg537grASk0fn+9XFcbEN+a9qyRMWeSbjBNIRsnrg9AoD1uOaU5k2o5uAvx5V7jjmTV33ODUTPsBDE4eQ=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR10MB1564
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.486,18.0.858
 definitions=2022-05-12_13:2022-05-12,2022-05-12 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxlogscore=999 malwarescore=0
 suspectscore=0 phishscore=0 spamscore=0 bulkscore=0 mlxscore=0
 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2202240000 definitions=main-2205120091
X-Proofpoint-GUID: KhyFBkw0CGN4jKlK8-jz5KVN4hH0i9m9
X-Proofpoint-ORIG-GUID: KhyFBkw0CGN4jKlK8-jz5KVN4hH0i9m9
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,RDNS_NONE,SPF_HELO_NONE,T_SCC_BODY_TEXT_LINE
	autolearn=no 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

Stephen Brennan <stephen.s.brennan@oracle.com> writes:
> A rare BUG_ON triggered in assoc_array_gc:
>
>     [3430308.818153] kernel BUG at lib/assoc_array.c:1609!
>
> Which corresponded to the statement currently at line 1593 upstream:
>
>     BUG_ON(assoc_array_ptr_is_meta(p));
>
> Using the data from the core dump, I was able to generate a userspace
> reproducer[1] and determine the cause of the bug.
>
> [1]: https://github.com/brenns10/kernel_stuff/tree/master/assoc_array_gc
>
> After running the iterator on the entire branch, an internal tree node
> looked like the following:
>
>     NODE (nr_leaves_on_branch: 3)
>       SLOT [0] NODE (2 leaves)
>       SLOT [1] NODE (1 leaf)
>       SLOT [2..f] NODE (empty)
>
> In the userspace reproducer, the pr_devel output when compressing this
> node was:
>
>     -- compress node 0x5607cc089380 --
>     free=0, leaves=0
>     [0] retain node 2/1 [nx 0]
>     [1] fold node 1/1 [nx 0]
>     [2] fold node 0/1 [nx 2]
>     [3] fold node 0/2 [nx 2]
>     [4] fold node 0/3 [nx 2]
>     [5] fold node 0/4 [nx 2]
>     [6] fold node 0/5 [nx 2]
>     [7] fold node 0/6 [nx 2]
>     [8] fold node 0/7 [nx 2]
>     [9] fold node 0/8 [nx 2]
>     [10] fold node 0/9 [nx 2]
>     [11] fold node 0/10 [nx 2]
>     [12] fold node 0/11 [nx 2]
>     [13] fold node 0/12 [nx 2]
>     [14] fold node 0/13 [nx 2]
>     [15] fold node 0/14 [nx 2]
>     after: 3
>
> At slot 0, an internal node with 2 leaves could not be folded into the
> node, because there was only one available slot (slot 0). Thus, the
> internal node was retained. At slot 1, the node had one leaf, and was
> able to be folded in successfully. The remaining nodes had no leaves,
> and so were removed. By the end of the compression stage, there were 14
> free slots, and only 3 leaf nodes. The tree was ascended and then its
> parent node was compressed. When this node was seen, it could not be
> folded, due to the internal node it contained.
>
> The invariant for compression in this function is: whenever
> nr_leaves_on_branch < ASSOC_ARRAY_FAN_OUT, the node should contain all
> leaf nodes. The compression step currently cannot guarantee this, given
> the corner case shown above.
>
> To fix this issue, retry compression whenever we have retained a node,
> and yet nr_leaves_on_branch < ASSOC_ARRAY_FAN_OUT. This second
> compression will then allow the node in slot 1 to be folded in,
> satisfying the invariant. Below is the output of the reproducer once the
> fix is applied:
>
>     -- compress node 0x560e9c562380 --
>     free=0, leaves=0
>     [0] retain node 2/1 [nx 0]
>     [1] fold node 1/1 [nx 0]
>     [2] fold node 0/1 [nx 2]
>     [3] fold node 0/2 [nx 2]
>     [4] fold node 0/3 [nx 2]
>     [5] fold node 0/4 [nx 2]
>     [6] fold node 0/5 [nx 2]
>     [7] fold node 0/6 [nx 2]
>     [8] fold node 0/7 [nx 2]
>     [9] fold node 0/8 [nx 2]
>     [10] fold node 0/9 [nx 2]
>     [11] fold node 0/10 [nx 2]
>     [12] fold node 0/11 [nx 2]
>     [13] fold node 0/12 [nx 2]
>     [14] fold node 0/13 [nx 2]
>     [15] fold node 0/14 [nx 2]
>     internal nodes remain despite enough space, retrying
>     -- compress node 0x560e9c562380 --
>     free=14, leaves=1
>     [0] fold node 2/15 [nx 0]
>     after: 3
>
> Fixes: 3cb989501c26 ("Add a generic associative array implementation.")
> Cc: <stable@vger.kernel.org>
> Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com>
> ---
>
> Hi Andrew,
>
> As far as I can tell, lib/assoc_array.c has no maintainer, so I'm
> sending this bugfix to you. Hopefully David can take a look at this and
> verify sure it's all sane. I tested it on my userspace reproducer, and
> also by booting it and exercising the keyring_gc functions a bit.
>
> Thanks,
> Stephen
>
>  lib/assoc_array.c | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/lib/assoc_array.c b/lib/assoc_array.c
> index 079c72e26493..7ed20233a770 100644
> --- a/lib/assoc_array.c
> +++ b/lib/assoc_array.c
> @@ -1462,6 +1462,7 @@ int assoc_array_gc(struct assoc_array *array,
>  	struct assoc_array_ptr *new_root, *new_parent, **new_ptr_pp;
>  	unsigned long nr_leaves_on_tree;
>  	int keylen, slot, nr_free, next_slot, i;
> +	bool retained;
>  
>  	pr_devel("-->%s()\n", __func__);
>  
> @@ -1536,6 +1537,7 @@ int assoc_array_gc(struct assoc_array *array,
>  		goto descend;
>  	}
>  
> +retry_compress:
>  	pr_devel("-- compress node %p --\n", new_n);
>  
>  	/* Count up the number of empty slots in this node and work out the
> @@ -1554,6 +1556,7 @@ int assoc_array_gc(struct assoc_array *array,
>  
>  	/* See what we can fold in */
>  	next_slot = 0;
> +	retained = 0;
>  	for (slot = 0; slot < ASSOC_ARRAY_FAN_OUT; slot++) {
>  		struct assoc_array_shortcut *s;
>  		struct assoc_array_node *child;
> @@ -1602,9 +1605,14 @@ int assoc_array_gc(struct assoc_array *array,
>  			pr_devel("[%d] retain node %lu/%d [nx %d]\n",
>  				 slot, child->nr_leaves_on_branch, nr_free + 1,
>  				 next_slot);
> +			retained = true;
>  		}
>  	}
>  
> +	if (retained && new_n->nr_leaves_on_branch < ASSOC_ARRAY_FAN_OUT) {

Hi Andrew,

I'm sorry to ask this of you - but would you be willing to yank this
patch out and replace it with the v2 I'll send in reply to this? The
above test should be a "<=" condition, not a "<". And of course you
caught my spelling mistake on the line below. Both will be corrected in
the v2.

thanks,
Stephen

> +		pr_devel("internal nodes remain despite neough space, retrying\n");
> +		goto retry_compress;
> +	}
>  	pr_devel("after: %lu\n", new_n->nr_leaves_on_branch);
>  
>  	nr_leaves_on_tree = new_n->nr_leaves_on_branch;
> -- 
> 2.30.2