From: Miroslav Benes <mbenes@suse.cz>
To: Josh Poimboeuf <jpoimboe@redhat.com>
Cc: Joe Lawrence <joe.lawrence@redhat.com>,
live-patching@vger.kernel.org, linux-kernel@vger.kernel.org,
Jessica Yu <jeyu@redhat.com>, Jiri Kosina <jikos@kernel.org>,
Petr Mladek <pmladek@suse.com>
Subject: Re: [PATCH v2 1/2] livepatch: introduce shadow variable API
Date: Mon, 17 Jul 2017 17:35:38 +0200 (CEST) [thread overview]
Message-ID: <alpine.LSU.2.20.1707171732150.22628@pobox.suse.cz> (raw)
In-Reply-To: <20170714004149.6jgg4vxmjsotlkus@treble>
On Thu, 13 Jul 2017, Josh Poimboeuf wrote:
> On Wed, Jun 28, 2017 at 11:37:26AM -0400, Joe Lawrence wrote:
>
> > +Brief API summary
> > +-----------------
> > +
> > +See the full API usage docbook notes in the livepatch/shadow.c
> > +implementation.
> > +
> > +An in-kernel hashtable references all of the shadow variables. These
> > +references are stored/retrieved through a <obj, num> key pair.
>
> "num" is rather vague, how about "key"?
>
> (And note, this and some of the other comments also apply to the code as
> well)
>
> > +* The klp_shadow variable data structure encapsulates both tracking
> > +meta-data and shadow-data:
> > + - meta-data
> > + - obj - pointer to original data
>
> Instead of "original data", how about calling it the "parent object"?
> That describes it better to me at least. "Original data" sounds like
> some of the data might be replaced.
I agree that "original data" does not sound right. However, we use "parent
object" for vmlinux or a module in our code. But I don't have a better
name and "parent object" sounds good.
> > + - num - numerical description of new data
>
> "numerical description of new data" sounds a little confusing, how about
> "unique identifier for new data"?
>
> I'm also not sure about the phrase "new data". Maybe something like
> "new data field" would be more descriptive? Or just "new field"? I
> view it kind of like adding a field to a struct. Not a big deal either
> way.
>
> > +void *klp_shadow_attach(void *obj, unsigned long num, void *new_data,
> > + size_t new_size, gfp_t gfp_flags);
>
> It could be just me, but the "new_" prefixes threw me off a little bit.
> The new is implied anyway. How about just "data" and "size"?
>
> And the same comment for the klp_shadow struct.
I agree with Josh on all of this.
Miroslav
next prev parent reply other threads:[~2017-07-17 15:35 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-28 15:37 [PATCH v2 0/2] livepatch: add " Joe Lawrence
2017-06-28 15:37 ` [PATCH v2 1/2] livepatch: introduce " Joe Lawrence
2017-06-30 13:49 ` kbuild test robot
2017-07-07 18:05 ` Joe Lawrence
2017-07-14 0:41 ` Josh Poimboeuf
2017-07-17 15:35 ` Miroslav Benes [this message]
2017-07-18 13:00 ` Petr Mladek
2017-07-18 19:36 ` Joe Lawrence
2017-07-19 15:19 ` Petr Mladek
2017-07-19 18:50 ` Miroslav Benes
2017-07-17 15:29 ` Miroslav Benes
2017-07-18 20:21 ` Joe Lawrence
2017-07-19 2:28 ` Josh Poimboeuf
2017-07-19 19:01 ` Miroslav Benes
2017-07-20 14:45 ` Miroslav Benes
2017-07-20 15:48 ` Joe Lawrence
2017-07-20 20:23 ` Josh Poimboeuf
2017-07-21 8:42 ` Petr Mladek
2017-07-21 8:59 ` Miroslav Benes
2017-07-18 12:45 ` Petr Mladek
2017-07-20 20:30 ` Joe Lawrence
2017-07-21 9:12 ` Miroslav Benes
2017-07-21 9:27 ` Petr Mladek
2017-07-21 9:13 ` Petr Mladek
2017-07-21 13:55 ` Joe Lawrence
2017-07-24 15:04 ` Josh Poimboeuf
2017-06-28 15:37 ` [PATCH v2 2/2] livepatch: add shadow variable sample programs Joe Lawrence
2017-07-18 14:47 ` Petr Mladek
2017-07-18 19:15 ` Joe Lawrence
2017-07-19 14:44 ` Petr Mladek
2017-07-19 15:06 ` Petr Mladek
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=alpine.LSU.2.20.1707171732150.22628@pobox.suse.cz \
--to=mbenes@suse.cz \
--cc=jeyu@redhat.com \
--cc=jikos@kernel.org \
--cc=joe.lawrence@redhat.com \
--cc=jpoimboe@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=live-patching@vger.kernel.org \
--cc=pmladek@suse.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®