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;
MIME-Version: 1.0
References: <20220606141051.285823-1-tzungbi@kernel.org> <20220606141051.285823-3-tzungbi@kernel.org>
 <CABXOdTdT0EtVoO6JmD0RdsmGvAXF3ERRwJATO01dU8+CtO7ofg@mail.gmail.com> <Yp6h08cYtUgat1cQ@google.com>
In-Reply-To: <Yp6h08cYtUgat1cQ@google.com>
From:   Guenter Roeck <groeck@google.com>
Date:   Tue, 7 Jun 2022 07:41:01 -0700
Message-ID: <CABXOdTd+J9oX68RMJBe9hAJShMHm=vf73Zx2pq10YDbGpAUaow@mail.gmail.com>
Subject: Re: [PATCH 02/13] platform/chrome: cros_ec_proto: add Kunit tests for cros_ec_query_all()
To:     Tzung-Bi Shih <tzungbi@kernel.org>
Cc:     Benson Leung <bleung@chromium.org>,
        Guenter Roeck <groeck@chromium.org>,
        "open list:CHROME HARDWARE PLATFORM SUPPORT" 
        <chrome-platform@lists.linux.dev>,
        linux-kernel <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, Jun 6, 2022 at 5:54 PM Tzung-Bi Shih <tzungbi@kernel.org> wrote:
>
> On Mon, Jun 06, 2022 at 08:18:41AM -0700, Guenter Roeck wrote:
> > On Mon, Jun 6, 2022 at 7:12 AM Tzung-Bi Shih <tzungbi@kernel.org> wrote:
> > > +static void cros_ec_proto_test_query_all_pretest(struct kunit *test)
> > > +{
> > > +       struct cros_ec_proto_test_priv *priv = test->priv;
> > > +       struct cros_ec_device *ec_dev = &priv->ec_dev;
> > > +
> > > +       /*
> > > +        * cros_ec_query_all() will free din and dout and allocate them again to fit the usage by
> > > +        * calling devm_kfree() and devm_kzalloc().  Set them to NULL as they aren't managed by
> > > +        * ec_dev->dev.
> > > +        */
> > > +       ec_dev->din = NULL;
> > > +       ec_dev->dout = NULL;
> > > +}
> > > +
> > > +static void cros_ec_proto_test_query_all_normal(struct kunit *test)
> > > +{
> [...]
> > > +       cros_ec_proto_test_query_all_pretest(test);
> > > +       ret = cros_ec_query_all(ec_dev);
> >
> > Wouldn't it be better to implement a post_test function and have it
> > call devm_kfree() if it is really necessary to release ->din and
> > ->dout here ?
> >
> > Either case, I am not convinced that clearing / releasing din and dout
> > is really needed. The device pointer should not change, after all, and
> > either the next call to cros_ec_query_all() will release the pointers,
> > or unloading the driver will do it.
>
> The `din` and `dout` are not managed by `ec_dev->dev` but statically
> initializing in cros_ec_proto_test_init()(see below).
>

Good point. Still I think it would be better to have a _post function
and clear ->din and ->dout after the call instead of clearing it
before the next call.

Thanks,
Guenter

> cros_ec_proto_test_query_all_pretest() sets them to NULL to get rid of the
> following warning (as devres_destroy() in devm_kfree() returns -ENOENT):
> WARNING: CPU: 0 PID: 27 at drivers/base/devres.c:1058 devm_kfree
>
> Oops, I just realized qemu still generated yet another warning:
> Device '(null)' does not have a release() function, it is broken and ...
> Will fix it in next version.
>
> [...]
> > >  static int cros_ec_proto_test_init(struct kunit *test)
> > >  {
> > >         struct cros_ec_proto_test_priv *priv;
> > > @@ -188,24 +902,48 @@ static int cros_ec_proto_test_init(struct kunit *test)
> > >         ec_dev->din = (u8 *)priv->din;
> > >         ec_dev->din_size = ARRAY_SIZE(priv->din);
> > >         ec_dev->proto_version = EC_HOST_REQUEST_VERSION;
> > > +       ec_dev->dev = kunit_kzalloc(test, sizeof(*ec_dev->dev), GFP_KERNEL);
> > > +       if (!ec_dev->dev)
> > > +               return -ENOMEM;
> > > +       device_initialize(ec_dev->dev);
> > > +       ec_dev->cmd_xfer = cros_kunit_ec_xfer_mock;
> > > +       ec_dev->pkt_xfer = cros_kunit_ec_xfer_mock;
> > >
> > >         priv->msg = (struct cros_ec_command *)priv->_msg;
> > >
> > > +       cros_kunit_mock_reset();
> > > +
> > >         return 0;
> > >  }