Re: [PATCH v5 06/17] virt: acrn: Introduce VM management interfaces

[Greg Kroah-Hartman]

On Thu, Nov 05, 2020 at 03:35:45PM +0800, Shuo A Liu wrote:
> On Thu  5.Nov'20 at  7:29:07 +0100, Greg Kroah-Hartman wrote:
> > On Thu, Nov 05, 2020 at 11:10:29AM +0800, Shuo A Liu wrote:
> > > On Wed  4.Nov'20 at 20:02:35 +0100, Greg Kroah-Hartman wrote:
> > > > On Mon, Oct 19, 2020 at 02:17:52PM +0800, shuo.a.liu@xxxxxxxxx wrote:
> > > > > --- /dev/null
> > > > > +++ b/include/uapi/linux/acrn.h
> > > > > @@ -0,0 +1,56 @@
> > > > > +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
> > > > > +/*
> > > > > + * Userspace interface for /dev/acrn_hsm - ACRN Hypervisor Service Module
> > > > > + *
> > > > > + * This file can be used by applications that need to communicate with the HSM
> > > > > + * via the ioctl interface.
> > > > > + */
> > > > > +
> > > > > +#ifndef _UAPI_ACRN_H
> > > > > +#define _UAPI_ACRN_H
> > > > > +
> > > > > +#include <linux/types.h>
> > > > > +
> > > > > +/**
> > > > > + * struct acrn_vm_creation - Info to create a User VM
> > > > > + * @vmid:		User VM ID returned from the hypervisor
> > > > > + * @reserved0:		Reserved
> > > > > + * @vcpu_num:		Number of vCPU in the VM. Return from hypervisor.
> > > > > + * @reserved1:		Reserved
> > > > > + * @uuid:		UUID of the VM. Pass to hypervisor directly.
> > > > > + * @vm_flag:		Flag of the VM creating. Pass to hypervisor directly.
> > > > > + * @ioreq_buf:		Service VM GPA of I/O request buffer. Pass to
> > > > > + *			hypervisor directly.
> > > > > + * @cpu_affinity:	CPU affinity of the VM. Pass to hypervisor directly.
> > > > > + * @reserved2:		Reserved
> > > >
> > > > Reserved and must be 0?
> > > 
> > > Not a must.
> > 
> > That's guaranteed to come back and bite you in the end.
> 
> OK. I can fill them with zero before passing them to hypervisor.
> 
> > You all have read the "how to write a good api" document, right?
> 
> Is it Documentation/driver-api/ioctl.rst? Or i missed..

That's one good document, but no, not what I was referring to.  I was
thinking of Documentation/process/adding-syscalls.rst, which is what you
are doing here implicitly with these new ioctls (every ioctl is a brand
new syscall.)

> > > > What are they reserved for?
> > > >
> > > > Same for all of the reserved fields, why?
> > > 
> > > Some reserved fields are to map layout in the hypervisor side, others
> > > are for future use.
> > 
> > ioctls should not have these, again, please read the documentation.  If
> > you need something new in the future, just make a new ioctl.
> 
> OK. I will remove some reserved fields for scalability.

"scalability" should have nothing to do with any of this, right?  What
am I missing?

> Though i can
> keep some reserved fields for alignment (and to keep same data structure
> layout with the hypervisor), right?
> Documentation/driver-api/ioctl.rst says that explicit reserved fields
> could be used.

If you need alignment, yes, that is fine, but that's not what you are
saying these are for.  And if you need alignment, why not move things
around so they are properly aligned.

And this structure has nothing to do with the hypervisor structure,
that's a internal-kernel structure, not a userspace-visable thing if you
are doing things correctly.

As an example of all of this type of review and conversation, please
refer to the review of the recent nitro_enclaves code that got merged.
All of the discussions there about ioctls are also relevant here.

thanks,

greg k-h