From: Or Idgar <[email protected]>
This patch is a driver which expose the Virtual Machine Generation ID
via sysfs. The ID is a UUID value used to differentiate between virtual
machines.
The VM-Generation ID is a feature defined by Microsoft (paper:
http://go.microsoft.com/fwlink/?LinkId=260709) and supported by multiple
hypervisor vendors.
Signed-off-by: Or Idgar <[email protected]>
---
Documentation/ABI/testing/sysfs-hypervisor | 13 +++
drivers/misc/Kconfig | 6 ++
drivers/misc/Makefile | 1 +
drivers/misc/vmgenid.c | 140 +++++++++++++++++++++++++++++
4 files changed, 160 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-hypervisor
create mode 100644 drivers/misc/vmgenid.c
diff --git a/Documentation/ABI/testing/sysfs-hypervisor b/Documentation/ABI/testing/sysfs-hypervisor
new file mode 100644
index 000000000000..2f9a7b8eab70
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-hypervisor
@@ -0,0 +1,13 @@
+What: /sys/hypervisor/vm_gen_counter
+Date: February 2018
+Contact: Or Idgar <[email protected]>
+ Gal Hammer <[email protected]>
+Description: Expose the virtual machine generation ID. The directory
+ contains two files: "generation_id" and "raw". Both files
+ represent the same information.
+
+ "generation_id" file is a UUID string
+ representation.
+
+ "raw" file is a 128-bit integer
+ representation (binary).
diff --git a/drivers/misc/Kconfig b/drivers/misc/Kconfig
index 03605f8fc0dc..5a74802bdfb4 100644
--- a/drivers/misc/Kconfig
+++ b/drivers/misc/Kconfig
@@ -500,6 +500,12 @@ config MISC_RTSX
tristate
default MISC_RTSX_PCI || MISC_RTSX_USB
+config VMGENID
+ tristate "Virtual Machine Generation ID driver"
+ help
+ This is a Virtual Machine Generation ID driver which provides
+ a virtual machine unique identifier.
+
source "drivers/misc/c2port/Kconfig"
source "drivers/misc/eeprom/Kconfig"
source "drivers/misc/cb710/Kconfig"
diff --git a/drivers/misc/Makefile b/drivers/misc/Makefile
index c3c8624f4d95..067aa666bb6a 100644
--- a/drivers/misc/Makefile
+++ b/drivers/misc/Makefile
@@ -57,6 +57,7 @@ obj-$(CONFIG_ASPEED_LPC_SNOOP) += aspeed-lpc-snoop.o
obj-$(CONFIG_PCI_ENDPOINT_TEST) += pci_endpoint_test.o
obj-$(CONFIG_OCXL) += ocxl/
obj-$(CONFIG_MISC_RTSX) += cardreader/
+obj-$(CONFIG_VMGENID) += vmgenid.o
lkdtm-$(CONFIG_LKDTM) += lkdtm_core.o
lkdtm-$(CONFIG_LKDTM) += lkdtm_bugs.o
diff --git a/drivers/misc/vmgenid.c b/drivers/misc/vmgenid.c
new file mode 100644
index 000000000000..6b7ec9bd45e8
--- /dev/null
+++ b/drivers/misc/vmgenid.c
@@ -0,0 +1,140 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Virtual Machine Generation ID driver
+ *
+ * Copyright (C) 2018 Red Hat, Inc. All rights reserved.
+ * Authors:
+ * Or Idgar <[email protected]>
+ * Gal Hammer <[email protected]>
+ *
+ */
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/kernel.h>
+#include <linux/kobject.h>
+#include <linux/acpi.h>
+#include <linux/uuid.h>
+
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("Or Idgar <[email protected]>");
+MODULE_AUTHOR("Gal Hammer <[email protected]>");
+MODULE_DESCRIPTION("Virtual Machine Generation ID");
+MODULE_VERSION("0.1");
+
+ACPI_MODULE_NAME("vmgenid");
+
+static u64 phy_addr;
+
+static ssize_t generation_id_show(struct device *_d,
+ struct device_attribute *attr, char *buf)
+{
+ uuid_t *uuidp;
+ ssize_t result;
+
+ uuidp = acpi_os_map_memory(phy_addr, sizeof(uuid_t));
+ if (!uuidp)
+ return -EFAULT;
+
+ result = sprintf(buf, "%pUl\n", uuidp);
+ acpi_os_unmap_memory(uuidp, sizeof(uuid_t));
+ return result;
+}
+static DEVICE_ATTR_RO(generation_id);
+
+static ssize_t raw_show(struct device *_d,
+ struct device_attribute *attr,
+ char *buf)
+{
+ uuid_t *uuidp;
+
+ uuidp = acpi_os_map_memory(phy_addr, sizeof(uuid_t));
+ if (!uuidp)
+ return -EFAULT;
+ memcpy(buf, uuidp, sizeof(uuid_t));
+ acpi_os_unmap_memory(uuidp, sizeof(uuid_t));
+ return sizeof(uuid_t);
+}
+static DEVICE_ATTR_RO(raw);
+
+static struct attribute *vmgenid_attrs[] = {
+ &dev_attr_generation_id.attr,
+ &dev_attr_raw.attr,
+ NULL,
+};
+static const struct attribute_group vmgenid_group = {
+ .name = "vm_gen_counter",
+ .attrs = vmgenid_attrs,
+};
+
+static int get_vmgenid(acpi_handle handle)
+{
+ int i;
+ struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
+ acpi_status status;
+ union acpi_object *pss;
+ union acpi_object *element;
+
+ status = acpi_evaluate_object(handle, "ADDR", NULL, &buffer);
+ if (ACPI_FAILURE(status)) {
+ ACPI_EXCEPTION((AE_INFO, status, "Evaluating _ADDR"));
+ return -ENODEV;
+ }
+ pss = buffer.pointer;
+ if (!pss || pss->type != ACPI_TYPE_PACKAGE || pss->package.count != 2)
+ return -EFAULT;
+
+ phy_addr = 0;
+ for (i = 0; i < pss->package.count; i++) {
+ element = &(pss->package.elements[i]);
+ if (element->type != ACPI_TYPE_INTEGER)
+ return -EFAULT;
+ phy_addr |= element->integer.value << i*32;
+ }
+ return 0;
+}
+
+static int acpi_vmgenid_add(struct acpi_device *device)
+{
+ int retval;
+
+ if (!device)
+ return -EINVAL;
+ retval = get_vmgenid(device->handle);
+ if (retval < 0)
+ return retval;
+ return sysfs_create_group(hypervisor_kobj, &vmgenid_group);
+}
+
+static int acpi_vmgenid_remove(struct acpi_device *device)
+{
+ sysfs_remove_group(hypervisor_kobj, &vmgenid_group);
+ return 0;
+}
+
+static const struct acpi_device_id vmgenid_ids[] = {
+ {"QEMUVGID", 0},
+ {"", 0},
+};
+
+static struct acpi_driver acpi_vmgenid_driver = {
+ .name = "vm_gen_counter",
+ .ids = vmgenid_ids,
+ .owner = THIS_MODULE,
+ .ops = {
+ .add = acpi_vmgenid_add,
+ .remove = acpi_vmgenid_remove,
+ }
+};
+
+static int __init vmgenid_init(void)
+{
+ return acpi_bus_register_driver(&acpi_vmgenid_driver);
+}
+
+static void __exit vmgenid_exit(void)
+{
+ acpi_bus_unregister_driver(&acpi_vmgenid_driver);
+}
+
+module_init(vmgenid_init);
+module_exit(vmgenid_exit);
--
2.14.3
On Sun, Feb 25, 2018 at 02:26:31PM +0200, Or Idgar wrote:
> From: Or Idgar <[email protected]>
>
> This patch is a driver which expose the Virtual Machine Generation ID
> via sysfs. The ID is a UUID value used to differentiate between virtual
> machines.
>
> The VM-Generation ID is a feature defined by Microsoft (paper:
> http://go.microsoft.com/fwlink/?LinkId=260709) and supported by multiple
> hypervisor vendors.
>
> Signed-off-by: Or Idgar <[email protected]>
> ---
> Documentation/ABI/testing/sysfs-hypervisor | 13 +++
> drivers/misc/Kconfig | 6 ++
> drivers/misc/Makefile | 1 +
> drivers/misc/vmgenid.c | 140 +++++++++++++++++++++++++++++
> 4 files changed, 160 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-hypervisor
> create mode 100644 drivers/misc/vmgenid.c
What changed from v1? Always put that below the --- line like
Documentation/SubmittingPatches describes how to do.
v3?
thanks,
greg k-h
Hi Or,
Thank you for the patch! Yet something to improve:
[auto build test ERROR on char-misc/char-misc-testing]
[also build test ERROR on v4.16-rc3 next-20180228]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]
url: https://github.com/0day-ci/linux/commits/Or-Idgar/drivers-virt-vm_gen_counter-initial-driver-implementation/20180227-050111
config: sh-allmodconfig (attached as .config)
compiler: sh4-linux-gnu-gcc (Debian 7.2.0-11) 7.2.0
reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# save the attached .config to linux build tree
make.cross ARCH=sh
All errors (new ones prefixed by >>):
drivers/misc/vmgenid.c: In function 'acpi_vmgenid_add':
>> drivers/misc/vmgenid.c:102:29: error: dereferencing pointer to incomplete type 'struct acpi_device'
retval = get_vmgenid(device->handle);
^~
drivers/misc/vmgenid.c: At top level:
>> drivers/misc/vmgenid.c:114:36: error: array type has incomplete element type 'struct acpi_device_id'
static const struct acpi_device_id vmgenid_ids[] = {
^~~~~~~~~~~
>> drivers/misc/vmgenid.c:119:15: error: variable 'acpi_vmgenid_driver' has initializer but incomplete type
static struct acpi_driver acpi_vmgenid_driver = {
^~~~~~~~~~~
>> drivers/misc/vmgenid.c:120:3: error: 'struct acpi_driver' has no member named 'name'
.name = "vm_gen_counter",
^~~~
drivers/misc/vmgenid.c:120:10: warning: excess elements in struct initializer
.name = "vm_gen_counter",
^~~~~~~~~~~~~~~~
drivers/misc/vmgenid.c:120:10: note: (near initialization for 'acpi_vmgenid_driver')
>> drivers/misc/vmgenid.c:121:3: error: 'struct acpi_driver' has no member named 'ids'
.ids = vmgenid_ids,
^~~
drivers/misc/vmgenid.c:121:9: warning: excess elements in struct initializer
.ids = vmgenid_ids,
^~~~~~~~~~~
drivers/misc/vmgenid.c:121:9: note: (near initialization for 'acpi_vmgenid_driver')
>> drivers/misc/vmgenid.c:122:3: error: 'struct acpi_driver' has no member named 'owner'
.owner = THIS_MODULE,
^~~~~
In file included from include/linux/linkage.h:7:0,
from include/linux/kernel.h:7,
from include/linux/list.h:9,
from include/linux/module.h:9,
from drivers/misc/vmgenid.c:12:
include/linux/export.h:35:21: warning: excess elements in struct initializer
#define THIS_MODULE (&__this_module)
^
drivers/misc/vmgenid.c:122:11: note: in expansion of macro 'THIS_MODULE'
.owner = THIS_MODULE,
^~~~~~~~~~~
include/linux/export.h:35:21: note: (near initialization for 'acpi_vmgenid_driver')
#define THIS_MODULE (&__this_module)
^
drivers/misc/vmgenid.c:122:11: note: in expansion of macro 'THIS_MODULE'
.owner = THIS_MODULE,
^~~~~~~~~~~
>> drivers/misc/vmgenid.c:123:3: error: 'struct acpi_driver' has no member named 'ops'
.ops = {
^~~
>> drivers/misc/vmgenid.c:123:9: error: extra brace group at end of initializer
.ops = {
^
drivers/misc/vmgenid.c:123:9: note: (near initialization for 'acpi_vmgenid_driver')
drivers/misc/vmgenid.c:123:9: warning: excess elements in struct initializer
drivers/misc/vmgenid.c:123:9: note: (near initialization for 'acpi_vmgenid_driver')
drivers/misc/vmgenid.c: In function 'vmgenid_init':
>> drivers/misc/vmgenid.c:131:9: error: implicit declaration of function 'acpi_bus_register_driver'; did you mean 'acpi_nvs_register'? [-Werror=implicit-function-declaration]
return acpi_bus_register_driver(&acpi_vmgenid_driver);
^~~~~~~~~~~~~~~~~~~~~~~~
acpi_nvs_register
drivers/misc/vmgenid.c: In function 'vmgenid_exit':
>> drivers/misc/vmgenid.c:136:2: error: implicit declaration of function 'acpi_bus_unregister_driver'; did you mean 'bus_unregister_notifier'? [-Werror=implicit-function-declaration]
acpi_bus_unregister_driver(&acpi_vmgenid_driver);
^~~~~~~~~~~~~~~~~~~~~~~~~~
bus_unregister_notifier
drivers/misc/vmgenid.c: At top level:
>> drivers/misc/vmgenid.c:119:27: error: storage size of 'acpi_vmgenid_driver' isn't known
static struct acpi_driver acpi_vmgenid_driver = {
^~~~~~~~~~~~~~~~~~~
drivers/misc/vmgenid.c:114:36: warning: 'vmgenid_ids' defined but not used [-Wunused-variable]
static const struct acpi_device_id vmgenid_ids[] = {
^~~~~~~~~~~
cc1: some warnings being treated as errors
vim +102 drivers/misc/vmgenid.c
95
96 static int acpi_vmgenid_add(struct acpi_device *device)
97 {
98 int retval;
99
100 if (!device)
101 return -EINVAL;
> 102 retval = get_vmgenid(device->handle);
103 if (retval < 0)
104 return retval;
105 return sysfs_create_group(hypervisor_kobj, &vmgenid_group);
106 }
107
108 static int acpi_vmgenid_remove(struct acpi_device *device)
109 {
110 sysfs_remove_group(hypervisor_kobj, &vmgenid_group);
111 return 0;
112 }
113
> 114 static const struct acpi_device_id vmgenid_ids[] = {
115 {"QEMUVGID", 0},
116 {"", 0},
117 };
118
> 119 static struct acpi_driver acpi_vmgenid_driver = {
> 120 .name = "vm_gen_counter",
> 121 .ids = vmgenid_ids,
> 122 .owner = THIS_MODULE,
> 123 .ops = {
124 .add = acpi_vmgenid_add,
125 .remove = acpi_vmgenid_remove,
126 }
127 };
128
129 static int __init vmgenid_init(void)
130 {
> 131 return acpi_bus_register_driver(&acpi_vmgenid_driver);
132 }
133
134 static void __exit vmgenid_exit(void)
135 {
> 136 acpi_bus_unregister_driver(&acpi_vmgenid_driver);
137 }
138
---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation
Hi Or,
Thank you for the patch! Yet something to improve:
[auto build test ERROR on char-misc/char-misc-testing]
[also build test ERROR on v4.16-rc3 next-20180301]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]
url: https://github.com/0day-ci/linux/commits/Or-Idgar/drivers-virt-vm_gen_counter-initial-driver-implementation/20180227-050111
config: openrisc-allyesconfig (attached as .config)
compiler: or1k-linux-gcc (GCC) 6.0.0 20160327 (experimental)
reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# save the attached .config to linux build tree
make.cross ARCH=openrisc
All errors (new ones prefixed by >>):
drivers/misc/vmgenid.c: In function 'acpi_vmgenid_add':
drivers/misc/vmgenid.c:102:29: error: dereferencing pointer to incomplete type 'struct acpi_device'
retval = get_vmgenid(device->handle);
^~
drivers/misc/vmgenid.c: At top level:
drivers/misc/vmgenid.c:114:36: error: array type has incomplete element type 'struct acpi_device_id'
static const struct acpi_device_id vmgenid_ids[] = {
^~~~~~~~~~~
drivers/misc/vmgenid.c:119:15: error: variable 'acpi_vmgenid_driver' has initializer but incomplete type
static struct acpi_driver acpi_vmgenid_driver = {
^~~~~~~~~~~
>> drivers/misc/vmgenid.c:120:2: error: unknown field 'name' specified in initializer
.name = "vm_gen_counter",
^
drivers/misc/vmgenid.c:120:10: warning: excess elements in struct initializer
.name = "vm_gen_counter",
^~~~~~~~~~~~~~~~
drivers/misc/vmgenid.c:120:10: note: (near initialization for 'acpi_vmgenid_driver')
>> drivers/misc/vmgenid.c:121:2: error: unknown field 'ids' specified in initializer
.ids = vmgenid_ids,
^
drivers/misc/vmgenid.c:121:9: warning: excess elements in struct initializer
.ids = vmgenid_ids,
^~~~~~~~~~~
drivers/misc/vmgenid.c:121:9: note: (near initialization for 'acpi_vmgenid_driver')
>> drivers/misc/vmgenid.c:122:2: error: unknown field 'owner' specified in initializer
.owner = THIS_MODULE,
^
In file included from include/linux/linkage.h:7:0,
from include/linux/kernel.h:7,
from include/linux/list.h:9,
from include/linux/module.h:9,
from drivers/misc/vmgenid.c:12:
include/linux/export.h:37:21: warning: excess elements in struct initializer
#define THIS_MODULE ((struct module *)0)
^
drivers/misc/vmgenid.c:122:11: note: in expansion of macro 'THIS_MODULE'
.owner = THIS_MODULE,
^~~~~~~~~~~
include/linux/export.h:37:21: note: (near initialization for 'acpi_vmgenid_driver')
#define THIS_MODULE ((struct module *)0)
^
drivers/misc/vmgenid.c:122:11: note: in expansion of macro 'THIS_MODULE'
.owner = THIS_MODULE,
^~~~~~~~~~~
>> drivers/misc/vmgenid.c:123:2: error: unknown field 'ops' specified in initializer
.ops = {
^
drivers/misc/vmgenid.c:123:9: error: extra brace group at end of initializer
.ops = {
^
drivers/misc/vmgenid.c:123:9: note: (near initialization for 'acpi_vmgenid_driver')
drivers/misc/vmgenid.c:123:9: warning: excess elements in struct initializer
drivers/misc/vmgenid.c:123:9: note: (near initialization for 'acpi_vmgenid_driver')
drivers/misc/vmgenid.c: In function 'vmgenid_init':
>> drivers/misc/vmgenid.c:131:9: error: implicit declaration of function 'acpi_bus_register_driver' [-Werror=implicit-function-declaration]
return acpi_bus_register_driver(&acpi_vmgenid_driver);
^~~~~~~~~~~~~~~~~~~~~~~~
drivers/misc/vmgenid.c: In function 'vmgenid_exit':
>> drivers/misc/vmgenid.c:136:2: error: implicit declaration of function 'acpi_bus_unregister_driver' [-Werror=implicit-function-declaration]
acpi_bus_unregister_driver(&acpi_vmgenid_driver);
^~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/misc/vmgenid.c: At top level:
drivers/misc/vmgenid.c:119:27: error: storage size of 'acpi_vmgenid_driver' isn't known
static struct acpi_driver acpi_vmgenid_driver = {
^~~~~~~~~~~~~~~~~~~
drivers/misc/vmgenid.c:114:36: warning: 'vmgenid_ids' defined but not used [-Wunused-variable]
static const struct acpi_device_id vmgenid_ids[] = {
^~~~~~~~~~~
cc1: some warnings being treated as errors
vim +/name +120 drivers/misc/vmgenid.c
113
> 114 static const struct acpi_device_id vmgenid_ids[] = {
115 {"QEMUVGID", 0},
116 {"", 0},
117 };
118
119 static struct acpi_driver acpi_vmgenid_driver = {
> 120 .name = "vm_gen_counter",
> 121 .ids = vmgenid_ids,
> 122 .owner = THIS_MODULE,
> 123 .ops = {
124 .add = acpi_vmgenid_add,
125 .remove = acpi_vmgenid_remove,
126 }
127 };
128
129 static int __init vmgenid_init(void)
130 {
> 131 return acpi_bus_register_driver(&acpi_vmgenid_driver);
132 }
133
134 static void __exit vmgenid_exit(void)
135 {
> 136 acpi_bus_unregister_driver(&acpi_vmgenid_driver);
137 }
138
---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation