DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Stefan Hajnoczi <stefanha@redhat.com>,
	"Kovacevic, Marko" <marko.kovacevic@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>,
	Maxime Coquelin <maxime.coquelin@redhat.com>,
	Yuanhan Liu <yliu@fridaylinux.org>
Subject: Re: [dpdk-dev] [PATCH 1/8] vhost: add security model documentation to	vhost_user.c
Date: Wed, 7 Feb 2018 16:10:55 +0000	[thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EEAA4F7@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <20180206142235.GB13343@stefanha-x1.localdomain>



> -----Original Message-----
> From: Stefan Hajnoczi [mailto:stefanha@redhat.com]
> Sent: Tuesday, February 6, 2018 2:23 PM
> To: Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Maxime Coquelin <maxime.coquelin@redhat.com>; Yuanhan
> Liu <yliu@fridaylinux.org>; Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH 1/8] vhost: add security model
> documentation to vhost_user.c
> 
> On Tue, Feb 06, 2018 at 01:26:13PM +0000, Kovacevic, Marko wrote:
> > > Input validation is not applied consistently in vhost_user.c.  This
> > > suggests that not everyone has the same security model in mind when
> > > working on the code.
> > >
> > > Make the security model explicit so that everyone can understand and
> > > follow the same model when modifying the code.
> > >
> > > Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> > > ---
> > >  lib/librte_vhost/vhost_user.c | 17 +++++++++++++++++
> > >  1 file changed, 17 insertions(+)
> > >
> > > diff --git a/lib/librte_vhost/vhost_user.c
> > > b/lib/librte_vhost/vhost_user.c
> >
> > <...>
> >
> > This is a useful comment but I don't know if it makes sense to include
> it in the vhost_user.c file.
> >
> > Particularly at the top where it looks like a general descriptive
> comment for the file.
> >
> > It would probably be better in the vhost-user section of the
> programmer's guide:
> >
> > http://dpdk.org/doc/guides/prog_guide/vhost_lib.html
> 
> That is the public API documentation for users of the library.  They don't
> parse VhostUserMsg so I'm not sure the comment would be relevant there.

Hi,

If it is public API documentation then it should probably be in a .h file
in doxygen format.

I'm in favour of the information being added, and thanks for that, just not
in that position in that file.

John

  parent reply	other threads:[~2018-02-07 16:12 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-02-05 12:16 [dpdk-dev] [PATCH 0/8] vhost: input validation enhancements Stefan Hajnoczi
2018-02-05 12:16 ` [dpdk-dev] [PATCH 1/8] vhost: add security model documentation to vhost_user.c Stefan Hajnoczi
2018-02-06 13:26   ` Kovacevic, Marko
     [not found]     ` <20180206142235.GB13343@stefanha-x1.localdomain>
2018-02-06 15:39       ` Kovacevic, Marko
2018-02-07 16:10       ` Mcnamara, John [this message]
2018-02-07 16:18         ` Maxime Coquelin
2018-02-07 17:23           ` Mcnamara, John
2018-02-05 12:16 ` [dpdk-dev] [PATCH 2/8] vhost: avoid enum fields in VhostUserMsg Stefan Hajnoczi
2018-02-06  9:47   ` Maxime Coquelin
2018-02-05 12:16 ` [dpdk-dev] [PATCH 3/8] vhost: validate untrusted memory.nregions field Stefan Hajnoczi
2018-02-05 12:16 ` [dpdk-dev] [PATCH 4/8] vhost: clear out unused SCM_RIGHTS file descriptors Stefan Hajnoczi
2018-02-05 12:16 ` [dpdk-dev] [PATCH 5/8] vhost: reject invalid log base mmap_offset values Stefan Hajnoczi
2018-02-05 12:16 ` [dpdk-dev] [PATCH 6/8] vhost: fix msg->payload union typo in vhost_user_set_vring_addr() Stefan Hajnoczi
2018-02-05 12:16 ` [dpdk-dev] [PATCH 7/8] vhost: validate virtqueue size Stefan Hajnoczi
2018-02-05 12:16 ` [dpdk-dev] [PATCH 8/8] vhost: check for memory_size + mmap_offset overflow Stefan Hajnoczi
2018-02-06  9:32 ` [dpdk-dev] [PATCH 0/8] vhost: input validation enhancements Maxime Coquelin
2018-02-06 10:01 ` Maxime Coquelin
2018-02-19 13:52 ` Maxime Coquelin

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=B27915DBBA3421428155699D51E4CFE23EEAA4F7@IRSMSX103.ger.corp.intel.com \
    --to=john.mcnamara@intel.com \
    --cc=dev@dpdk.org \
    --cc=marko.kovacevic@intel.com \
    --cc=maxime.coquelin@redhat.com \
    --cc=stefanha@redhat.com \
    --cc=yliu@fridaylinux.org \
    /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;
as well as URLs for NNTP newsgroup(s).