[PATCH v2 0/2] Add me as the maintainer for ivshmem-pci

[PATCH v2 0/2] Add me as the maintainer for ivshmem-pci

[Gustavo Romero]

Add me as the maintainer for the ivshmem-pci.c device, the ivshmem
server, and the ivshmem client tool. Also, adjust remaining parts left
behind after ivshmem PCI device was renamed from ivshmem.c to
ivshmem-pci.c, like header files, Kconfig, docs, and build scripts.


Cheers,
Gustavo

Gustavo Romero (2):
  hw/misc/ivshmem-pci: Rename remaining parts for consistency
  MAINTAINERS: Add me as the maintainer for ivshmem-pci

 MAINTAINERS                                          | 9 ++++++++-
 contrib/ivshmem-client/ivshmem-client.h              | 2 +-
 contrib/ivshmem-server/ivshmem-server.h              | 2 +-
 docs/system/device-emulation.rst                     | 2 +-
 docs/system/devices/ivshmem-flat.rst                 | 2 +-
 docs/system/devices/{ivshmem.rst => ivshmem-pci.rst} | 4 ++--
 hw/misc/Kconfig                                      | 4 ++--
 hw/misc/ivshmem-pci.c                                | 2 +-
 hw/misc/meson.build                                  | 4 ++--
 include/hw/misc/{ivshmem.h => ivshmem-pci.h}         | 6 +++---
 tests/qtest/meson.build                              | 2 +-
 11 files changed, 23 insertions(+), 16 deletions(-)
 rename docs/system/devices/{ivshmem.rst => ivshmem-pci.rst} (96%)
 rename include/hw/misc/{ivshmem.h => ivshmem-pci.h} (88%)

-- 
2.34.1

[PATCH v2 1/2] hw/misc/ivshmem-pci: Rename remaining parts for consistency

[Gustavo Romero]

For consistency, rename the remaining parts of ivshmem PCI device after
it was renamed from ivshmem to ivshmem-pci.

Signed-off-by: Gustavo Romero <gustavo.romero@linaro.org>
---
 contrib/ivshmem-client/ivshmem-client.h              | 2 +-
 contrib/ivshmem-server/ivshmem-server.h              | 2 +-
 docs/system/device-emulation.rst                     | 2 +-
 docs/system/devices/ivshmem-flat.rst                 | 2 +-
 docs/system/devices/{ivshmem.rst => ivshmem-pci.rst} | 4 ++--
 hw/misc/Kconfig                                      | 4 ++--
 hw/misc/ivshmem-pci.c                                | 2 +-
 hw/misc/meson.build                                  | 4 ++--
 include/hw/misc/{ivshmem.h => ivshmem-pci.h}         | 6 +++---
 tests/qtest/meson.build                              | 2 +-
 10 files changed, 15 insertions(+), 15 deletions(-)
 rename docs/system/devices/{ivshmem.rst => ivshmem-pci.rst} (96%)
 rename include/hw/misc/{ivshmem.h => ivshmem-pci.h} (88%)

diff --git a/contrib/ivshmem-client/ivshmem-client.h b/contrib/ivshmem-client/ivshmem-client.h
index fc45a38060..9b0b24ce69 100644
--- a/contrib/ivshmem-client/ivshmem-client.h
+++ b/contrib/ivshmem-client/ivshmem-client.h
@@ -22,7 +22,7 @@
 #include <sys/select.h>
 
 #include "qemu/queue.h"
-#include "hw/misc/ivshmem.h"
+#include "hw/misc/ivshmem-pci.h"
 
 /**
  * Maximum number of notification vectors supported by the client
diff --git a/contrib/ivshmem-server/ivshmem-server.h b/contrib/ivshmem-server/ivshmem-server.h
index d870adb6a0..a8c1a6d5fb 100644
--- a/contrib/ivshmem-server/ivshmem-server.h
+++ b/contrib/ivshmem-server/ivshmem-server.h
@@ -30,7 +30,7 @@
 
 #include "qemu/event_notifier.h"
 #include "qemu/queue.h"
-#include "hw/misc/ivshmem.h"
+#include "hw/misc/ivshmem-pci.h"
 
 /**
  * Maximum number of notification vectors supported by the server
diff --git a/docs/system/device-emulation.rst b/docs/system/device-emulation.rst
index a1b0d7997e..137371eaf7 100644
--- a/docs/system/device-emulation.rst
+++ b/docs/system/device-emulation.rst
@@ -85,7 +85,7 @@ Emulated Devices
    devices/can.rst
    devices/ccid.rst
    devices/cxl.rst
-   devices/ivshmem.rst
+   devices/ivshmem-pci.rst
    devices/ivshmem-flat.rst
    devices/keyboard.rst
    devices/net.rst
diff --git a/docs/system/devices/ivshmem-flat.rst b/docs/system/devices/ivshmem-flat.rst
index 1f97052804..ccdceef171 100644
--- a/docs/system/devices/ivshmem-flat.rst
+++ b/docs/system/devices/ivshmem-flat.rst
@@ -17,7 +17,7 @@ running Linux), and an arm VM (using the ivshmem-flat device and running Zephyr
 instead).
 
 The ivshmem-flat device does not support the use of a ``memdev`` option (see
-ivshmem.rst for more details). It relies on the ivshmem server to create and
+ivshmem-pci.rst for more details). It relies on the ivshmem server to create and
 distribute the proper shared memory file descriptor and the eventfd(s) to notify
 (interrupt) the peers. Therefore, to use this device, it is always necessary to
 have an ivshmem server up and running for proper device creation.
diff --git a/docs/system/devices/ivshmem.rst b/docs/system/devices/ivshmem-pci.rst
similarity index 96%
rename from docs/system/devices/ivshmem.rst
rename to docs/system/devices/ivshmem-pci.rst
index ce71e25663..4cd434e2db 100644
--- a/docs/system/devices/ivshmem.rst
+++ b/docs/system/devices/ivshmem-pci.rst
@@ -1,5 +1,5 @@
-Inter-VM Shared Memory device
------------------------------
+Inter-VM Shared Memory PCI device
+---------------------------------
 
 On Linux hosts, a shared memory device is available. The basic syntax
 is:
diff --git a/hw/misc/Kconfig b/hw/misc/Kconfig
index 8f9ce2f68c..366c7e295f 100644
--- a/hw/misc/Kconfig
+++ b/hw/misc/Kconfig
@@ -67,12 +67,12 @@ config MACIO
     select MAC_NVRAM
     select MOS6522
 
-config IVSHMEM_DEVICE
+config IVSHMEM_PCI
     bool
     default y if PCI_DEVICES
     depends on PCI && LINUX && IVSHMEM && MSI_NONBROKEN
 
-config IVSHMEM_FLAT_DEVICE
+config IVSHMEM_FLAT
     bool
     default y
     depends on LINUX && IVSHMEM
diff --git a/hw/misc/ivshmem-pci.c b/hw/misc/ivshmem-pci.c
index 900d523334..8f9cd94f42 100644
--- a/hw/misc/ivshmem-pci.c
+++ b/hw/misc/ivshmem-pci.c
@@ -37,7 +37,7 @@
 #include "system/hostmem.h"
 #include "qapi/visitor.h"
 
-#include "hw/misc/ivshmem.h"
+#include "hw/misc/ivshmem-pci.h"
 #include "qom/object.h"
 
 #define PCI_VENDOR_ID_IVSHMEM   PCI_VENDOR_ID_REDHAT_QUMRANET
diff --git a/hw/misc/meson.build b/hw/misc/meson.build
index 55f493521b..0459820332 100644
--- a/hw/misc/meson.build
+++ b/hw/misc/meson.build
@@ -38,8 +38,8 @@ system_ss.add(when: 'CONFIG_SIFIVE_U_PRCI', if_true: files('sifive_u_prci.c'))
 subdir('macio')
 
 # ivshmem devices
-system_ss.add(when: 'CONFIG_IVSHMEM_DEVICE', if_true: files('ivshmem-pci.c'))
-system_ss.add(when: 'CONFIG_IVSHMEM_FLAT_DEVICE', if_true: files('ivshmem-flat.c'))
+system_ss.add(when: 'CONFIG_IVSHMEM_PCI', if_true: files('ivshmem-pci.c'))
+system_ss.add(when: 'CONFIG_IVSHMEM_FLAT', if_true: files('ivshmem-flat.c'))
 
 system_ss.add(when: 'CONFIG_ALLWINNER_SRAMC', if_true: files('allwinner-sramc.c'))
 system_ss.add(when: 'CONFIG_ALLWINNER_A10_CCM', if_true: files('allwinner-a10-ccm.c'))
diff --git a/include/hw/misc/ivshmem.h b/include/hw/misc/ivshmem-pci.h
similarity index 88%
rename from include/hw/misc/ivshmem.h
rename to include/hw/misc/ivshmem-pci.h
index 433ef53d79..c00b39c0cd 100644
--- a/include/hw/misc/ivshmem.h
+++ b/include/hw/misc/ivshmem-pci.h
@@ -17,9 +17,9 @@
  * Contributions after 2012-01-13 are licensed under the terms of the
  * GNU GPL, version 2 or (at your option) any later version.
  */
-#ifndef IVSHMEM_H
-#define IVSHMEM_H
+#ifndef IVSHMEM_PCI_H
+#define IVSHMEM_PCI_H
 
 #define IVSHMEM_PROTOCOL_VERSION 0
 
-#endif /* IVSHMEM_H */
+#endif /* IVSHMEM_PCI_H */
diff --git a/tests/qtest/meson.build b/tests/qtest/meson.build
index 94b28e5a53..80f15185ca 100644
--- a/tests/qtest/meson.build
+++ b/tests/qtest/meson.build
@@ -37,7 +37,7 @@ endif
 
 qtests_pci = \
   (config_all_devices.has_key('CONFIG_VGA') ? ['display-vga-test'] : []) +                  \
-  (config_all_devices.has_key('CONFIG_IVSHMEM_DEVICE') ? ['ivshmem-test'] : [])
+  (config_all_devices.has_key('CONFIG_IVSHMEM_PCI') ? ['ivshmem-test'] : [])
 
 qtests_cxl = \
   (config_all_devices.has_key('CONFIG_CXL') ? ['cxl-test'] : [])
-- 
2.34.1

[PATCH v2 2/2] MAINTAINERS: Add me as the maintainer for ivshmem-pci

[Gustavo Romero]

Add me as the maintainer for the ivshmem-pci device and for the ivshmem
server and client tool.

Signed-off-by: Gustavo Romero <gustavo.romero@linaro.org>
---
 MAINTAINERS | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 846b81e3ec..8327ce9c79 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2789,12 +2789,19 @@ F: hw/hyperv/hv-balloon*.h
 F: include/hw/hyperv/dynmem-proto.h
 F: include/hw/hyperv/hv-balloon.h
 
-ivshmem-flat
+ivshmem
 M: Gustavo Romero <gustavo.romero@linaro.org>
 S: Maintained
+F: hw/misc/ivshmem-pci.c
 F: hw/misc/ivshmem-flat.c
+F: include/hw/misc/ivshmem-pci.h
 F: include/hw/misc/ivshmem-flat.h
+F: docs/system/devices/ivshmem-pci.rst
 F: docs/system/devices/ivshmem-flat.rst
+F: docs/specs/ivshmem-spec.rst
+F: tests/qtest/ivshmem-test.c
+F: contrib/ivshmem-client/
+F: contrib/ivshmem-server/
 
 Subsystems
 ----------
-- 
2.34.1

Re: [PATCH v2 0/2] Add me as the maintainer for ivshmem-pci

[Markus Armbruster]

Gustavo Romero <gustavo.romero@linaro.org> writes:

> Add me as the maintainer for the ivshmem-pci.c device, the ivshmem
> server, and the ivshmem client tool. Also, adjust remaining parts left
> behind after ivshmem PCI device was renamed from ivshmem.c to
> ivshmem-pci.c, like header files, Kconfig, docs, and build scripts.

Thank you!

Acked-by: Markus Armbruster <armbru@redhat.com>

Re: [PATCH v2 0/2] Add me as the maintainer for ivshmem-pci

[Philippe Mathieu-Daudé]

On 23/1/25 02:22, Gustavo Romero wrote:
> Add me as the maintainer for the ivshmem-pci.c device, the ivshmem
> server, and the ivshmem client tool. Also, adjust remaining parts left
> behind after ivshmem PCI device was renamed from ivshmem.c to
> ivshmem-pci.c, like header files, Kconfig, docs, and build scripts.
> 
> 
> Cheers,
> Gustavo
> 
> Gustavo Romero (2):
>    hw/misc/ivshmem-pci: Rename remaining parts for consistency
>    MAINTAINERS: Add me as the maintainer for ivshmem-pci

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>

and queued, thanks for volunteering!

Re: [PATCH v2 0/2] Add me as the maintainer for ivshmem-pci

[Philippe Mathieu-Daudé]

On 24/1/25 17:22, Philippe Mathieu-Daudé wrote:
> On 23/1/25 02:22, Gustavo Romero wrote:
>> Add me as the maintainer for the ivshmem-pci.c device, the ivshmem
>> server, and the ivshmem client tool. Also, adjust remaining parts left
>> behind after ivshmem PCI device was renamed from ivshmem.c to
>> ivshmem-pci.c, like header files, Kconfig, docs, and build scripts.
>>
>>
>> Cheers,
>> Gustavo
>>
>> Gustavo Romero (2):
>>    hw/misc/ivshmem-pci: Rename remaining parts for consistency
>>    MAINTAINERS: Add me as the maintainer for ivshmem-pci
> 
> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
> 
> and queued, thanks for volunteering!

Failing to build:

docs/specs/ivshmem-spec.rst:17:unknown document: '../system/devices/ivshmem'
ninja: build stopped: subcommand failed.

docs/specs/ivshmem-spec.rst only mention PCI, so I could squash in the
first patch:
-- >8 --
diff --git a/docs/specs/ivshmem-spec.rst b/docs/specs/ivshmem-spec.rst
index 2d8e80055b0..e326d024487 100644
--- a/docs/specs/ivshmem-spec.rst
+++ b/docs/specs/ivshmem-spec.rst
@@ -17,3 +17,3 @@ get interrupted by its peers.
  For information on configuring the ivshmem device on the QEMU
-command line, see :doc:`../system/devices/ivshmem`.
+command line, see :doc:`../system/devices/ivshmem-pci`.
---
But then I wonder if this document shouldn't mention the flat
device. Since I'm unsure I'm dropping the series (patch 2
depends on 1).

Regards,

Phil.

Re: [PATCH v2 0/2] Add me as the maintainer for ivshmem-pci

[Markus Armbruster]

Philippe Mathieu-Daudé <philmd@linaro.org> writes:

> On 24/1/25 17:22, Philippe Mathieu-Daudé wrote:
>> On 23/1/25 02:22, Gustavo Romero wrote:
>>> Add me as the maintainer for the ivshmem-pci.c device, the ivshmem
>>> server, and the ivshmem client tool. Also, adjust remaining parts left
>>> behind after ivshmem PCI device was renamed from ivshmem.c to
>>> ivshmem-pci.c, like header files, Kconfig, docs, and build scripts.
>>>
>>>
>>> Cheers,
>>> Gustavo
>>>
>>> Gustavo Romero (2):
>>>    hw/misc/ivshmem-pci: Rename remaining parts for consistency
>>>    MAINTAINERS: Add me as the maintainer for ivshmem-pci
>> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
>> and queued, thanks for volunteering!
>
> Failing to build:
>
> docs/specs/ivshmem-spec.rst:17:unknown document: '../system/devices/ivshmem'
> ninja: build stopped: subcommand failed.
>
> docs/specs/ivshmem-spec.rst only mention PCI, so I could squash in the
> first patch:
> -- >8 --
> diff --git a/docs/specs/ivshmem-spec.rst b/docs/specs/ivshmem-spec.rst
> index 2d8e80055b0..e326d024487 100644
> --- a/docs/specs/ivshmem-spec.rst
> +++ b/docs/specs/ivshmem-spec.rst
> @@ -17,3 +17,3 @@ get interrupted by its peers.
>  For information on configuring the ivshmem device on the QEMU
> -command line, see :doc:`../system/devices/ivshmem`.
> +command line, see :doc:`../system/devices/ivshmem-pci`.
> ---
> But then I wonder if this document shouldn't mention the flat
> device. Since I'm unsure I'm dropping the series (patch 2
> depends on 1).

Simple oversight in PATCH 1.  It renames docs/system/devices/ivshmem.rst
to docs/system/devices/ivshmem-pci.rst without updating the reference in
docs/specs/ivshmem-spec.rst.

Surprisingly, this didn't fail for me in an incremental build, only in a
full one.