Skip to contentSkip to conversation

export Xen Hypervisor attributes to sysfs

PATCH In review Mike D. Day 3 participants 6 messages Mar 20, 2006 – Mar 24, 2006

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 export Xen Hypervisor attributes to sysfs

Creates a module that exports Xen Hypervisor attributes to sysfs. The module has a tri-state configuration so it can be a loadable module.

Views the hypervisor as hardware device, uses sysfs as a scripting interface for user space tools that need these attributes.

Some user space apps, particularly for systems management, need to know if their kernel is running in a virtual machine and if so in what type of virtual machine. This property is contained in the file /sys/hypervisor/type.

The file hypervisor_sysfs.c creates a generic hypervisor subsystem that can be linked to by any hypervisor. The file xen_sysfs.c exports the xen-specific attributes.

---
Initial directory = /sys/hypervisor

+---compilation
|   >---compile_date
|   >---compiled_by
|   >---compiler
+---properties
|   >---capabilities
|   >---changeset
|   >---virtual_start
|   >---writable_pt
Quoted 1 line

---type

+---version
|   >---extra
|   >---major
|   >---minor

Some examples:
[mdday@athlon64 ~]$ cat /sys/hypervisor/type
xen

[mdday@athlon64 ~]$ cat /sys/hypervisor/version/major 3

[mdday@athlon64 ~]$ cat /sys/hypervisor/properties/changeset Sun Mar 19 09:17:50 2006 +0100 9322:768936b2800a

[mdday@athlon64 ~]$ cat /sys/hypervisor/properties/capabilities xen-3.0-x86_64

 b/linux-2.6-xen-sparse/drivers/xen/core/hypervisor_sysfs.c |   58 ++
 b/linux-2.6-xen-sparse/drivers/xen/core/xen_sysfs.c        |  314 +++++++++++++
 b/linux-2.6-xen-sparse/include/xen/hypervisor_sysfs.h      |   34 +
 linux-2.6-xen-sparse/drivers/xen/Kconfig                   |    8
 linux-2.6-xen-sparse/drivers/xen/core/Makefile             |    2
 5 files changed, 416 insertions(+)

# HG changeset patch
# User [email protected]
# Node ID 508bf03c36ab88226378d5e2621ec065ca04d7c6 # Parent a8b1d4fad72d2b0bba1b121bc250b4ac80fcf9ac export xen attributes to sysfs

linux-2.6-xen-sparse/drivers/xen/Kconfig +8 -0
diff -r a8b1d4fad72d -r 508bf03c36ab linux-2.6-xen-sparse/drivers/xen/Kconfig
@@ -189,6 +189,14 @@ config XEN_DISABLE_SERIAL
 	  Disable serial port drivers, allowing the Xen console driver
 	  to provide a serial console at ttyS0.
 
+config XEN_SYSFS
+	tristate "Export Xen attributes in sysfs"
+	depends on XEN
+	depends on SYSFS
+	default y
+	help
+		Xen hypervisor attributes will show up under /sys/hypervisor/.
+
 endmenu
 
 config HAVE_ARCH_ALLOC_SKB
linux-2.6-xen-sparse/drivers/xen/core/Makefile +2 -0
diff -r a8b1d4fad72d -r 508bf03c36ab linux-2.6-xen-sparse/drivers/xen/core/Makefile
@@ -7,3 +7,5 @@ obj-$(CONFIG_PROC_FS) += xen_proc.o
 obj-$(CONFIG_PROC_FS) += xen_proc.o
 obj-$(CONFIG_NET)     += skbuff.o
 obj-$(CONFIG_SMP)     += smpboot.o
+obj-$(CONFIG_SYSFS)   += hypervisor_sysfs.o
+obj-$(CONFIG_XEN_SYSFS) += xen_sysfs.o
linux-2.6-xen-sparse/drivers/xen/core/hypervisor_sysfs.c new file +58 -0

58 lines not on this page · raw message

linux-2.6-xen-sparse/drivers/xen/core/xen_sysfs.c new file +310 -0

310 lines not on this page · raw message

linux-2.6-xen-sparse/include/xen/hypervisor_sysfs.h new file +34 -0
diff -r a8b1d4fad72d -r 508bf03c36ab linux-2.6-xen-sparse/include/xen/hypervisor_sysfs.h
@@ -0,0 +1,34 @@
+/*
+    copyright (c) 2006 IBM Corporation
+    Authored by: Mike D. Day <[email protected]>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License version 2 as
+    published by the Free Software Foundation.
+*/
+
+
+
+#ifndef _HYP_SYSFS_H_
+#define _HYP_SYSFS_H_
+
+#include <linux/kobject.h>
+#include <linux/sysfs.h>
+
+#define HYPERVISOR_ATTR_RO(_name) \
+static struct hyp_sysfs_attr  _name##_attr = __ATTR_RO(_name)
+
+#define HYPERVISOR_ATTR_RW(_name) \
+static struct hyp_sysfs_attr _name##_attr = \
+	__ATTR(_name, 0644, _name##_show, _name##_store)
+
+extern struct subsystem hypervisor_subsys;
+
+struct hyp_sysfs_attr {
+	struct attribute attr;
+	ssize_t (*show)(struct hyp_sysfs_attr *, char *);
+	ssize_t (*store)(struct hyp_sysfs_attr *, const char *, size_t);
+	void *hyp_attr_data;
+};
+
+#endif /* _HYP_SYSFS_H_ */
#1 lore raw
Quoted 19 lines · Mike D. Day

Creates a module that exports Xen Hypervisor attributes to sysfs. The module has a tri-state configuration so it can be a loadable module.

Views the hypervisor as hardware device, uses sysfs as a scripting interface for user space tools that need these attributes.

Some user space apps, particularly for systems management, need to know if their kernel is running in a virtual machine and if so in what type of virtual machine. This property is contained in the file /sys/hypervisor/type.

The file hypervisor_sysfs.c creates a generic hypervisor subsystem that can be linked to by any hypervisor. The file xen_sysfs.c exports the xen-specific attributes.

---
Initial directory = /sys/hypervisor

Quoted 7 lines
+---compilation
|   >---compile_date
|   >---compiled_by
|   >---compiler
+---properties
|   >---capabilities
|   >---changeset

how is this a property and not part of version?

Quoted 8 lines
|   >---virtual_start
|   >---writable_pt
Quoted 1 line

---type

+---version
|   >---extra
|   >---major
|   >---minor

again what is the justification of putting this in the kernel? I though everyone here was agreed that since the management tools that need this talk to the hypervisor ANYWAY, they might as well just ask this information as well....

#2 lore raw
Quoted 5 lines · Arjan van de Ven
Quoted 3 lines
+---properties
|   >---capabilities
|   >---changeset

how is this a property and not part of version?

Agree, changeset should be part of version

Quoted 4 lines

again what is the justification of putting this in the kernel? I though everyone here was agreed that since the management tools that need this talk to the hypervisor ANYWAY, they might as well just ask this information as well....

I think we had a good discussion but short of agreement. Some tools want to read a file from /sys/hypervisor/ rather than call a c lib. (In other words, not all tools will talk to the hypervisor.) It is appropriate to view the hypervisor as a hardware device so it is appropriate to have some information in sysfs.

I appreciate the counter argument as well, but think this should be a configurable option.

thanks,

Mike

#3 lore raw
Quoted 14 lines · Mike D. Day
Quoted 5 lines · Arjan van de Ven
Quoted 3 lines
+---properties
|   >---capabilities
|   >---changeset

how is this a property and not part of version?

Agree, changeset should be part of version

Quoted 4 lines

again what is the justification of putting this in the kernel? I though everyone here was agreed that since the management tools that need this talk to the hypervisor ANYWAY, they might as well just ask this information as well....

Quoted 5 lines

I think we had a good discussion but short of agreement. Some tools want to read a file from /sys/hypervisor/ rather than call a c lib. (In other words, not all tools will talk to the hypervisor.) It is appropriate to view the hypervisor as a hardware device so it is appropriate to have some information in sysfs.

then make a simple tool that gives the info to stdout

Quoted 2 lines

I appreciate the counter argument as well, but think this should be a configurable option.

"a config option" is a cop-out. By proposing a config option you even admit it's not essential for userspace. The last thing this should be is a config option; it either is needed and important, and should be there always, or it's redundant and should be done in userspace. "A config option" is just admitting that it is the later, but that you need to justify the time you spent on the kernel patch somewhere ;-)

#4 lore raw
Quoted 8 lines · Arjan van de Ven
Quoted 1 line

I appreciate the counter argument as well, but think this should be a configurable option.

"a config option" is a cop-out. By proposing a config option you even admit it's not essential for userspace. The last thing this should be is a config option; it either is needed and important, and should be there always, or it's redundant and should be done in userspace. "A config option" is just admitting that it is the later, but that you need to justify the time you spent on the kernel patch somewhere ;-)

No, not at all. There are two types of Xen kernels: privileged and non-privileged. A privileged kernel has access to real hardware devices. This patch is intended for privileged xen kernel. That's why it needs to be a configurable option.

Mike

#5 lore raw
In reply to Mike D. Day
Quoted 6 lines · Mike D. Day

Creates a module that exports Xen Hypervisor attributes to sysfs. The module has a tri-state configuration so it can be a loadable module.

Views the hypervisor as hardware device, uses sysfs as a scripting interface for user space tools that need these attributes.

Quoted 8 lines

Some user space apps, particularly for systems management, need to know if their kernel is running in a virtual machine and if so in what type of virtual machine. This property is contained in the file /sys/hypervisor/type.

The file hypervisor_sysfs.c creates a generic hypervisor subsystem that can be linked to by any hypervisor. The file xen_sysfs.c exports the xen-specific attributes.

Why put the file hypervisor_sysfs.c in a xen specific directory then if you expect to share it with all hypervisors?

Also, if you want to make this generic and force everyone to have the same public interface (a good idea), you need to make callbacks to this file to provide the needed information, don't just create whatever file you want in the xen specific file. Otherwise it is guaranteed that we will not have a uniform interface.

Quoted 13 lines

---
Initial directory = /sys/hypervisor

+---compilation
|   >---compile_date
|   >---compiled_by
|   >---compiler
+---properties
|   >---capabilities
|   >---changeset
|   >---virtual_start
|   >---writable_pt
Quoted 5 lines
Quoted 1 line

---type

+---version
|   >---extra
|   >---major
|   >---minor

Hint, 'tree' shows things a bit nicer :)

Quoted 10 lines

Some examples:
[mdday@athlon64 ~]$ cat /sys/hypervisor/type
xen

[mdday@athlon64 ~]$ cat /sys/hypervisor/version/major 3

[mdday@athlon64 ~]$ cat /sys/hypervisor/properties/changeset Sun Mar 19 09:17:50 2006 +0100 9322:768936b2800a

That seems crazy to export, but hey, if you really think it's useful (and what are you going to do when it becomes a git changeset, not a hg one?)

Quoted 5 lines

diff -r a8b1d4fad72d -r 508bf03c36ab linux-2.6-xen-sparse/drivers/xen/Kconfig

linux-2.6-xen-sparse/drivers/xen/Kconfig +0 -0
@@ -189,6 +189,14 @@ config XEN_DISABLE_SERIAL
 	  Disable serial port drivers, allowing the Xen console driver

linux-2.6-xen-sparse/drivers/xen/Kconfig config XEN_DISABLE_SERIAL · line 199

Quoted 10 lines
linux-2.6-xen-sparse/drivers/xen/Kconfig +8 -0
 	  to provide a serial console at ttyS0.
 
+config XEN_SYSFS
+	tristate "Export Xen attributes in sysfs"
+	depends on XEN
+	depends on SYSFS
+	default y
+	help
+		Xen hypervisor attributes will show up under /sys/hypervisor/.
+

You told Arjan that it is different depending on which type of kernel you are running. This config option does not show it.

Also, you don't need to depend on SYSFS, your code should build just fine without that option enabled (it will not do anything, but that's a different story...) If not, please let me know.

linux-2.6-xen-sparse/drivers/xen/core/Makefile obj-$(CONFIG_PROC_FS) += xen_proc.o · line 10

Quoted 9 lines
linux-2.6-xen-sparse/drivers/xen/Kconfig +0 -0
 config HAVE_ARCH_ALLOC_SKB

diff -r a8b1d4fad72d -r 508bf03c36ab linux-2.6-xen-sparse/drivers/xen/core/Makefile

linux-2.6-xen-sparse/drivers/xen/core/Makefile +1 -0
@@ -7,3 +7,5 @@ obj-$(CONFIG_PROC_FS) += xen_proc.o
 obj-$(CONFIG_PROC_FS) += xen_proc.o
 obj-$(CONFIG_NET)     += skbuff.o
 obj-$(CONFIG_SMP)     += smpboot.o
+obj-$(CONFIG_SYSFS)   += hypervisor_sysfs.o

Again, no, you don't need to depend on CONFIG_SYSFS

Quoted 10 lines
linux-2.6-xen-sparse/drivers/xen/core/Makefile +1 -0
+obj-$(CONFIG_XEN_SYSFS) += xen_sysfs.o

diff -r a8b1d4fad72d -r 508bf03c36ab linux-2.6-xen-sparse/drivers/xen/core/hypervisor_sysfs.c

linux-2.6-xen-sparse/drivers/xen/core/hypervisor_sysfs.c new file +5 -0
@@ -0,0 +1,58 @@
+/*
+    copyright (c) 2006 IBM Corporation
+    Authored by: Mike D. Day <[email protected]>
+
+    This program is free software; you can redistribute it and/or modify

linux-2.6-xen-sparse/drivers/xen/core/hypervisor_sysfs.c line 15

Quoted 10 lines
linux-2.6-xen-sparse/drivers/xen/core/hypervisor_sysfs.c new file +10 -0
+    it under the terms of the GNU General Public License version 2 as
+    published by the Free Software Foundation.
+*/
+
+
+#include <linux/config.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/kobject.h>
+#include <xen/hypervisor_sysfs.h>

Why a xen specific file in a "generic" file? That will break the build for sure...

I don't think it's even needed here, do you?

Quoted 28 lines

diff -r a8b1d4fad72d -r 508bf03c36ab linux-2.6-xen-sparse/include/xen/hypervisor_sysfs.h

linux-2.6-xen-sparse/include/xen/hypervisor_sysfs.h new file +24 -0
@@ -0,0 +1,34 @@
+/*
+    copyright (c) 2006 IBM Corporation
+    Authored by: Mike D. Day <[email protected]>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License version 2 as
+    published by the Free Software Foundation.
+*/
+
+
+
+#ifndef _HYP_SYSFS_H_
+#define _HYP_SYSFS_H_
+
+#include <linux/kobject.h>
+#include <linux/sysfs.h>
+
+#define HYPERVISOR_ATTR_RO(_name) \
+static struct hyp_sysfs_attr  _name##_attr = __ATTR_RO(_name)
+
+#define HYPERVISOR_ATTR_RW(_name) \
+static struct hyp_sysfs_attr _name##_attr = \
+	__ATTR(_name, 0644, _name##_show, _name##_store)
+

linux-2.6-xen-sparse/include/xen/hypervisor_sysfs.h line 34

Quoted 10 lines
linux-2.6-xen-sparse/include/xen/hypervisor_sysfs.h new file +10 -0
+extern struct subsystem hypervisor_subsys;
+
+struct hyp_sysfs_attr {
+	struct attribute attr;
+	ssize_t (*show)(struct hyp_sysfs_attr *, char *);
+	ssize_t (*store)(struct hyp_sysfs_attr *, const char *, size_t);
+	void *hyp_attr_data;
+};
+
+#endif /* _HYP_SYSFS_H_ */

Why is a .h file needed for this?

Is someone else going to include it? I can see exporting the hypervisor_subsys variable, but again, that better not be in a xen specific file...

But those #defines and structure are not needed here.

thanks,

greg k-h