[libvirt] [RFC PATCH 1/5] doc: schema: Add basic documentation for the ivshmem support

[Maxime Leroy]

On Wed, Aug 6, 2014 at 11:41 AM, Wang Rui <moon.wangrui at huawei.com> wrote:
> On 2014/8/6 0:48, Maxime Leroy wrote:
>> This patch documents XML elements used for support of ivshmem
>> devices.
>>
>> About ivshmem, please see the following documentation:
>> http://git.qemu.org/?p=qemu.git;a=blob;f=docs/specs/ivshmem_device_spec.txt
>> (Ivshmem documentation for qemu will be updated soon:
>> https://lists.nongnu.org/archive/html/qemu-devel/2014-07/msg02974.html)
>>
>> In the devices section in the domain XML users may specify:
>>
>> - For ivshmem device using an ivshmem server:
>>
>>  <ivshmem use_server='yes' role='master'/>
>>    <source file='/tmp/socket-ivshmem0'/>
>
> I prefer to use <source mode='connect' path='/tmp/socket-ivshmem0'/> .
> So when ParesXML and Format functions are needed, we can use
> virDomainChrSourceDef*(), like vmchannel device.
> What do you think about it ?

First, thanks for the review.

I was thinking of using virDomainChrSourceDef to
improve this patch.

So the format of the xml needs to be updated accordingly:

- For ivshmem device using an ivshmem server:

<ivshmem type='unix'>
  <source mode='connect' path='/tmp/socket-ivshmem0'/>
  <size unit='M'>32</size>
  <msi vectors='32' ioeventfd='on'/>
</ivshmem>

- For ivshmem device using directly a shared memory

<ivshmem type='file'>
  <source path='ivshmem0'>
  <size unit='M'>32</size>
</ivshmem>

Thus, 'use_server' attribute will be replaced  by 'type' attribute
(unix or file).
Are you ok with that ?