Re: [PATCH] soc: renesas: rcar-sysc: fix memory leak in rcar_sysc_pd_init

[Geert Uytterhoeven]

On Thu, Sep 26, 2019 at 10:23 AM Simon Horman <horms@xxxxxxxxxxxx> wrote:
> On Wed, Sep 25, 2019 at 04:03:53PM -0500, Navid Emamdoost wrote:
> > In rcar_sysc_pd_init when looping over info->areas errors may happen but
> > the error handling path does not clean up the intermediate allocated
> > memories.
> >
> > This patch changes the error handling path in major and a little the loop
> >  itself. Inside the loop if an error happens the current pd will be
> > released and then it goes to error handling path where it releases any
> >  previously allocated domains.
> >
> > Signed-off-by: Navid Emamdoost <navid.emamdoost@xxxxxxxxx>

> > @@ -382,6 +382,7 @@ static int __init rcar_sysc_pd_init(void)
> >               pd = kzalloc(sizeof(*pd) + strlen(area->name) + 1, GFP_KERNEL);
> >               if (!pd) {
> >                       error = -ENOMEM;
> > +                     num_areas = i;
> >                       goto out_put;
> >               }
> >
> > @@ -393,8 +394,11 @@ static int __init rcar_sysc_pd_init(void)
> >               pd->flags = area->flags;
> >
> >               error = rcar_sysc_pd_setup(pd);
> > -             if (error)
> > +             if (error) {
> > +                     kfree(pd);
> > +                     num_areas = i;
> >                       goto out_put;
> > +             }
> >
> >               domains->domains[area->isr_bit] = &pd->genpd;
> >
> > @@ -406,13 +410,30 @@ static int __init rcar_sysc_pd_init(void)
> >               if (error) {
> >                       pr_warn("Failed to add PM subdomain %s to parent %u\n",
> >                               area->name, area->parent);
> > +                     kfree(pd);
> > +                     num_areas = i;
> >                       goto out_put;
> >               }
> >       }
> >
> >       error = of_genpd_add_provider_onecell(np, &domains->onecell_data);
> > +     of_node_put(np);
> > +
> > +     return error;
> >
> >  out_put:
> > +     if (domains) {
> > +             for (i = 0; i < num_areas; i++) {
> > +                     const struct rcar_sysc_area *area = &info->areas[i];
> > +
> > +                     if (!area->name) {
> > +                             /* Skip NULLified area */
> > +                             continue;
> > +                     }
> > +                     kfree(domains->domains[area->isr_bit]);
>
> This cleanup doesn't feel correct to me.
>
> For one I think the allocated memory is at
> to_rcar_pd(domains->domains[area->isr_bit]);
>
> And for antoher I wonder if it is also necessary to unwind initialisation done
> by rcar_sysc_pd_setup() and pm_genpd_add_subdomain();

Indeed.

> I think this leads us to the heart of why such unwinding is not present
> and that is, I suspect, that its reasonably complex and in the event of
> failure the system is very likely unusable. So leaking a bit of memory,
> while unpleasent, doesn't effect the user experience.

Exactly. These can fail only on Out-Of-Memory, or when the programmer
did something stupid and the power area topology in the SoC-specific
driver part is wrong.

Hence it's futile to try to clean up, as the system won't work anyway.
So the current code just aborts, and hopes for the best.

Gr{oetje,eeting}s,

                        Geert

-- 
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@xxxxxxxxxxxxxx

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds