Received-SPF: pass (google.com: domain of linux-kernel+bounces-6108-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Date: Tue, 19 Dec 2023 15:42:29 -0800
From: Ira Weiny <ira.weiny@intel.com>
To: <dinghao.liu@zju.edu.cn>, Ira Weiny <ira.weiny@intel.com>
CC: Dan Williams <dan.j.williams@intel.com>, Vishal Verma
	<vishal.l.verma@intel.com>, Dave Jiang <dave.jiang@intel.com>,
	<nvdimm@lists.linux.dev>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] [v2] nvdimm-btt: fix several memleaks
Message-ID: <65822a6542ca1_277bd294f3@iweiny-mobl.notmuch>
References: <20231210085817.30161-1-dinghao.liu@zju.edu.cn>
 <657b9cb088175_27db80294d2@iweiny-mobl.notmuch>
 <657c82966e358_2947c22941a@iweiny-mobl.notmuch>
 <13ffb3fd.41cd7.18c7c3b52bf.Coremail.dinghao.liu@zju.edu.cn>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <13ffb3fd.41cd7.18c7c3b52bf.Coremail.dinghao.liu@zju.edu.cn>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?yi8435jcKqdZdsr/z3hf1EAMVJL1f5CRVieY3U9kv3CXP3R0E5wsyrAIY5rN?=
 =?us-ascii?Q?BzDA+6ZwEw2neWyqkqWEE/CM3KvOe4/5R2iYFGy5kUpaYvbBPbC5SkB4sohL?=
 =?us-ascii?Q?OGCrZzYRz+IvfmesA1iLG/94ujYQhzKVcD1P+X0yoM54AVKcWeOcfa519CDw?=
 =?us-ascii?Q?oWb8mHZ3wtcSoHe3hilRqWvU25xT4WfbgszowCEt3xNqBz3h2cxuqjg8ph8a?=
 =?us-ascii?Q?YLFrS4tEY5cb9yNTnVfnxo/H2stCwXfnWEbJRe/OwdNFKP1u92rgmmY3jAK6?=
 =?us-ascii?Q?1lplZVltQwZ3lo7nGDRUJBo6H8PUr1bCIXdNOimkE4OsW+BGJdUmRDjePpUk?=
 =?us-ascii?Q?Bxv2aN7j+LgevctpkjcKhL1ojRdB/ooH9rnZ8TrEmszmBmtaaf5G7TM7UVJm?=
 =?us-ascii?Q?edFv1Ie1VTC3ZG+h2/XXmg6kIsWSgIt3j6DVDWChhAQC/8E2j1KvJtzV9HN8?=
 =?us-ascii?Q?KBwlPpe7CB1v/7ST/HzTfayW+RX8oSr8cZzIHDvdF0/NuIRjPz9x3c53+V4q?=
 =?us-ascii?Q?x2Uu5sZaIG4SzOY6cgyo7uxgM+Lsg4ojDC01KXxro1ezxzQp9QBXjlI+zRBs?=
 =?us-ascii?Q?R3v53n1whsWOnbyT1zt8EGcWsDgCT3vAA0fr255Gn9cJgACcHQRP2Xd8n17g?=
 =?us-ascii?Q?t/jnPYPTMPxrNEoOfjV6r/mKcVOlOkgNOyI/XGiUUKamWoWdjHVw9G3zgeUQ?=
 =?us-ascii?Q?9m3t8W3SIMofT2ZrtvubCqWtM8T7aApxhOe7ux8VSY/khXkAbF80FQT7ai0r?=
 =?us-ascii?Q?zlFhn2oQboZyy1QqrxVU9ZNTvOpeRmfkXlwFRUmkkUpeUYOsKR8cucYOUx9r?=
 =?us-ascii?Q?v31aHZq0uAIT+WGjTKs+yA0LkyUW8wy3xzUVyILKXBuo/o+3C8HemvoCpBTg?=
 =?us-ascii?Q?RVW376oIl0WQ1H3x0jWfSDWHPrg28oM/e+FMd+IqtPzkEbhtEVeFhyyePuF1?=
 =?us-ascii?Q?AsytSJPJqMj5qBMsWyepRjmwzcO0zQxpFR2RflJk8IbYnSqJ2g0hX/DfjEF3?=
 =?us-ascii?Q?MiGtdHhgVll/X/lq+3HBezZY/MGhTaAYbFe8ffJPH0Uf1v4fqCw1XfhkBvd+?=
 =?us-ascii?Q?BUrEwPuN9ltXhjtEa7uFaDjoim4L8VgXrXykrrhmnW1lSt0Ay5SErD77Xnri?=
 =?us-ascii?Q?T8lQaozX7rMH3A744GdsnCgSvBSbTg2PwXfVkgpBQs373vAHWWcu0zl4GMfg?=
 =?us-ascii?Q?tDr8yegMhsTuGNrWYV88fJSJUU6unB+yU1eyMb7nlT1Tzv7dmGX/Z4sE7ilu?=
 =?us-ascii?Q?n32CNM7vL2AihnXTySWjjfpjbbiaVajJfxbY/ldrD6dhT2KXso5U0+GVnzcU?=
 =?us-ascii?Q?Upg9h2rdAZk+oEjtbT734VCTPYAieV8DAGpmXlPkXfc3zipJpKQSczXCOWaJ?=
 =?us-ascii?Q?OTAZBzjVXbL95dZ4DQ/K9Y9ZYHhNGoPBuGQRfNy0wWpucPNB+dDMUlJekXGd?=
 =?us-ascii?Q?71yzF96yGnZf6RsS5loWPG2sXwLBONrMGLrmMTnBVwpxhPM1F5+r5PX/EC+9?=
 =?us-ascii?Q?c4V3N8UKsKfQ7roYUrQXKT2nwQQ6jICeOHp1DXL+MkIbFtLens2UOvYYXTkg?=
 =?us-ascii?Q?2nfHpLCDOIsU1VMDwHuryv1jMt9uCeO8esJ9uAH+h6Udo+GNTBVsXLjZPIkf?=
 =?us-ascii?Q?bazfsREMu7akdwVQawRUKBSdHwCOWAchwaJWSDvdyZoW?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 0f9a8252-2bf1-4fdf-145c-08dc00ec2bf1
X-MS-Exchange-CrossTenant-AuthSource: SA1PR11MB6733.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Dec 2023 23:42:33.3278
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: uqcymVHzvttdEa5MwfRiMEqNpUBak6kFsNM4FymAxiU62cGsgL5X3G6+NalmDG5n/M59UMXy3LPa202AydUM7g==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL1PR11MB5955
X-OriginatorOrg: intel.com

dinghao.liu@ wrote:
> > Ira Weiny wrote:
> > > Dinghao Liu wrote:
> > 
> > [snip]
> > 
> > -static int btt_freelist_init(struct arena_info *arena)
> > +static int btt_freelist_init(struct device *dev, struct arena_info *arena)
> > 
> > Both struct arena_info and struct btt contain references to struct nd_btt
> > which is the device you are passing down this call stack.
> > 
> > Just use the device in the arena/btt rather than passing a device
> > structure.  That makes the code easier to read and ensures that the device
> > associated with this arena or btt is used.
> 
> Thanks for this suggestion! I will fix this in the v3 patch.
> 
> > [snip]
> > > >  
> > > > -static int btt_maplocks_init(struct arena_info *arena)
> > > > +static int btt_maplocks_init(struct device *dev, struct arena_info *arena)
> > > >  {
> > > >  	u32 i;
> > > >  
> > > > -	arena->map_locks = kcalloc(arena->nfree, sizeof(struct aligned_lock),
> > > > +	arena->map_locks = devm_kcalloc(dev, arena->nfree, sizeof(struct aligned_lock),
> > > >  				GFP_KERNEL);
> > > >  	if (!arena->map_locks)
> > > >  		return -ENOMEM;
> > > > @@ -805,9 +805,6 @@ static void free_arenas(struct btt *btt)
> > > >  
> > > >  	list_for_each_entry_safe(arena, next, &btt->arena_list, list) {
> > > >  		list_del(&arena->list);
> > > > -		kfree(arena->rtt);
> > > > -		kfree(arena->map_locks);
> > > > -		kfree(arena->freelist);
> > > 
> > > This does not quite work.
> > > 
> > > free_arenas() is used in the error paths of create_arenas() and
> > > discover_arenas().  In those cases devm_kfree() is probably a better way
> > > to clean up this.
> 
> Here I'm a little confused about when devm_kfree() should be used.

Over all it should be used whenever memory is allocated for the lifetime
of the device.

> Code in btt_init() implies that resources allocated by devm_* could be
> auto freed in both error and success paths of probe/attach (e.g., btt 
> allocated by devm_kzalloc is never freed by devm_kfree).
> Using devm_kfree() in free_arenas() is ok for me, but I want to know
> whether not using devm_kfree() constitutes a bug.

Unfortunately I'm not familiar enough with this code to know for sure.

After my quick checks before I thought it was.  But each time I look at it
I get confused.  This is why I was thinking maybe not using devm_*() and
using no_free_ptr() may be a better solution to make sure things don't
leak without changing the success path (which is likely working fine
because no bugs have been found.)

> 
> > > 
> > > However...
> > > 
> > > >  		debugfs_remove_recursive(arena->debugfs_dir);
> > > >  		kfree(arena);
> > > 
> > > Why can't arena be allocated with devm_*?
> > > 
> > > We need to change this up a bit more to handle the error path vs regular
> > > device shutdown free (automatic devm frees).
> > 
> 
> At first, I think the use of arena is correct. Therefore, allocating arena
> with devm_* should be a code style optimization. However, I rechecked
> discover_arenas and found arena might also be leaked (e.g., if
> alloc_arena() fails in the second loop, the previously allocated
> resources in the loop is leaked). The correct code could be found in
> create_arenas(), where free_arenas is called on failure of
> alloc_arena().
 
Yea I've not reached that level of detail in my analysis.

>
> To fix this issue, I think it's better to change the 'goto out_super'
> tag to 'goto out'. We could also use devm_* for arena to simplify the
> error path in discover_arenas(). 

I think it is your call at this point as I don't have time to dig in more
than I have.  Sorry.

> 
> > We might want to look at using no_free_ptr() in this code.  See this
> > patch[1] for an example of how to inhibit the cleanup and pass the
> > pointer on when the function succeeds.
> > 
> > [1]
> > https://lore.kernel.org/all/170261791914.1714654.6447680285357545638.stgit@dwillia2-xfh.jf.intel.com/
> > 
> > Ira
> 
> Thanks for this example. But it seems that no_free_ptr() is used to
> handle the scope based resource management. Changes in this patch does
> not introduce this feature. Do I understand this correctly?

You do understand but I was thinking that perhaps using no_free_ptr()
rather than devm_*() might be an easier way to fix this bug without trying
to decode the lifetime of everything.

Ira

> 
> Regards,
> Dinghao