Skip to contentSkip to conversation

virtio-console: wait for console ports

RFC/PATCH New Christian Borntraeger 2 participants 5 messages Sep 21, 2011 – Sep 22, 2011

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

Amit,

can you have a look at the patch below and give feedback or apply if appropriate?

---
On s390 I have seen some random "Warning: unable to open an initial console" boot failure. Turns out that tty_open fails, because the hvc_alloc was not yet done. In former times this could not happen, since the probe function automatically called hvc_alloc. With newer versions (multiport) some host<->guest interaction is required before hvc_alloc is called. This might be too late, especially if an initramfs is involved. Lets use a completion if we have multiport and an early console.

---
 drivers/char/virtio_console.c |   18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
drivers/char/virtio_console.c +18 -0
Index: b/drivers/char/virtio_console.c
===================================================================
@@ -19,6 +19,7 @@
  */
 #include <linux/cdev.h>
 #include <linux/debugfs.h>
+#include <linux/completion.h>
 #include <linux/device.h>
 #include <linux/err.h>
 #include <linux/fs.h>
@@ -73,6 +74,7 @@ struct ports_driver_data {
 static struct ports_driver_data pdrvdata;
 
 DEFINE_SPINLOCK(pdrvdata_lock);
+DECLARE_COMPLETION(port_added);
 
 /* This struct holds information that's relevant only for console ports */
 struct console {
@@ -1352,6 +1354,7 @@ static void handle_control_message(struc
 			break;
 
 		init_port_console(port);
+		complete(&port_added);
 		/*
 		 * Could remove the port here in case init fails - but
 		 * have to notify the host first.
@@ -1648,6 +1651,10 @@ static int __devinit virtcons_probe(stru
 	struct ports_device *portdev;
 	int err;
 	bool multiport;
+	bool early = early_put_chars != 0;
+
+	/* Ensure to read early_put_chars now */
+	barrier();
 
 	portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
 	if (!portdev) {
@@ -1719,6 +1726,17 @@ static int __devinit virtcons_probe(stru
 
 	__send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
 			   VIRTIO_CONSOLE_DEVICE_READY, 1);
+
+	/* If there was an early virtio console, assume that there are no
+	 * other consoles. We need to wait until the hvc_alloc matches the
+	 * hvc_instantiate, otherwise tty_open will complain, resulting in
+	 * a "Warning: unable to open an initial console" boot failure.
+	 * Without multiport this is done in add_port above. With multiport
+	 * this might take some host<->guest communication - thus we have to
+	 * wait. */
+	if (multiport && early)
+		wait_for_completion(&port_added);
+
 	return 0;
 
 free_vqs:
#1 lore raw

Hi Christian,

Quoted 4 lines · Christian Borntraeger

Amit,

can you have a look at the patch below and give feedback or apply if appropriate?

The patch looks good. Just a couple of comments:

Quoted 44 lines

On s390 I have seen some random "Warning: unable to open an initial console" boot failure. Turns out that tty_open fails, because the hvc_alloc was not yet done. In former times this could not happen, since the probe function automatically called hvc_alloc. With newer versions (multiport) some host<->guest interaction is required before hvc_alloc is called. This might be too late, especially if an initramfs is involved. Lets use a completion if we have multiport and an early console.

---
 drivers/char/virtio_console.c |   18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

Index: b/drivers/char/virtio_console.c
===================================================================

drivers/char/virtio_console.c +3 -0
@@ -19,6 +19,7 @@
  */
 #include <linux/cdev.h>
 #include <linux/debugfs.h>
+#include <linux/completion.h>
 #include <linux/device.h>
 #include <linux/err.h>
 #include <linux/fs.h>
@@ -73,6 +74,7 @@ struct ports_driver_data {
 static struct ports_driver_data pdrvdata;
 
 DEFINE_SPINLOCK(pdrvdata_lock);
+DECLARE_COMPLETION(port_added);
 
 /* This struct holds information that's relevant only for console ports */
 struct console {
@@ -1352,6 +1354,7 @@ static void handle_control_message(struc
 			break;
 
 		init_port_console(port);
+		complete(&port_added);
 		/*
 		 * Could remove the port here in case init fails - but
 		 * have to notify the host first.

drivers/char/virtio_console.c static int __devinit virtcons_probe(stru · line 1654

Quoted 4 lines
drivers/char/virtio_console.c +1 -0
@@ -1648,6 +1651,10 @@ static int __devinit virtcons_probe(stru
 	struct ports_device *portdev;
 	int err;
 	bool multiport;
+	bool early = early_put_chars != 0;

Check for NULL instead of 0. Is it necessary to create this variable instead of checking for early_put_chars != NULL below?

Quoted 8 lines
drivers/char/virtio_console.c +3 -0
+
+	/* Ensure to read early_put_chars now */
+	barrier();
 
 	portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
 	if (!portdev) {
@@ -1719,6 +1726,17 @@ static int __devinit virtcons_probe(stru
 

drivers/char/virtio_console.c static int __devinit virtcons_probe(stru · line 1736

Quoted 10 lines
drivers/char/virtio_console.c +8 -0
 	__send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
 			   VIRTIO_CONSOLE_DEVICE_READY, 1);
+
+	/* If there was an early virtio console, assume that there are no
+	 * other consoles. We need to wait until the hvc_alloc matches the
+	 * hvc_instantiate, otherwise tty_open will complain, resulting in
+	 * a "Warning: unable to open an initial console" boot failure.
+	 * Without multiport this is done in add_port above. With multiport
+	 * this might take some host<->guest communication - thus we have to
+	 * wait. */

This file uses comments in the form
/*
* ...
*/

drivers/char/virtio_console.c static int __devinit virtcons_probe(stru · line 1739

Quoted 3 lines
drivers/char/virtio_console.c +3 -0
+	if (multiport && early)
+		wait_for_completion(&port_added);
+

Can there be a problem to not timeout this wait? Maybe it's not a real problem; just thinking out aloud.

Amit

#2 lore raw
Quoted 4 lines · Amit Shah
Quoted 4 lines
drivers/char/virtio_console.c +4 -0
+	/* If there was an early virtio console, assume that there are no
+	 * other consoles. We need to wait until the hvc_alloc matches the
+	 * hvc_instantiate, otherwise tty_open will complain, resulting in
+	 * a "Warning: unable to open an initial console" boot failure.
Quoted 8 lines

drivers/char/virtio_console.c static int __devinit virtcons_probe(stru · line 1736

Quoted 3 lines
drivers/char/virtio_console.c +3 -0
+	 * Without multiport this is done in add_port above. With multiport
+	 * this might take some host<->guest communication - thus we have to
+	 * wait. */

This file uses comments in the form
/*
* ...
*/

Will fix.

Quoted 7 lines

drivers/char/virtio_console.c static int __devinit virtcons_probe(stru · line 1739

Quoted 4 lines
drivers/char/virtio_console.c +3 -0
+	if (multiport && early)
+		wait_for_completion(&port_added);
+

Can there be a problem to not timeout this wait? Maybe it's not a real problem; just thinking out aloud.

I had the same thoughts. I then asked myself, how big the timeout has to be - and the answer was it really depends on the host load. So we can certainly use wait_for_completion_timeout(&port_added, HZ*<x>);
which will work in 99.9% of all cases. It might still cause spurious boot failures, if for some reasons it takes too long.
So the big question is, is there a case were virtio is used as an early console but virtio_console does not register a console during probe. Ideas?

Christian

#3 lore raw
Quoted 24 lines · Christian Borntraeger
Quoted 4 lines · Amit Shah
Quoted 4 lines
drivers/char/virtio_console.c +4 -0
+	/* If there was an early virtio console, assume that there are no
+	 * other consoles. We need to wait until the hvc_alloc matches the
+	 * hvc_instantiate, otherwise tty_open will complain, resulting in
+	 * a "Warning: unable to open an initial console" boot failure.
Quoted 8 lines

drivers/char/virtio_console.c static int __devinit virtcons_probe(stru · line 1736

Quoted 3 lines
drivers/char/virtio_console.c +3 -0
+	 * Without multiport this is done in add_port above. With multiport
+	 * this might take some host<->guest communication - thus we have to
+	 * wait. */

This file uses comments in the form
/*
* ...
*/

Will fix.

Quoted 7 lines

drivers/char/virtio_console.c static int __devinit virtcons_probe(stru · line 1739

Quoted 4 lines
drivers/char/virtio_console.c +3 -0
+	if (multiport && early)
+		wait_for_completion(&port_added);
+

Can there be a problem to not timeout this wait? Maybe it's not a real problem; just thinking out aloud.

Quoted 5 lines

I had the same thoughts. I then asked myself, how big the timeout has to be - and the answer was it really depends on the host load. So we can certainly use wait_for_completion_timeout(&port_added, HZ*<x>);
which will work in 99.9% of all cases. It might still cause spurious boot failures, if for some reasons it takes too long.

Yes; there's no deterministic way.

Quoted 2 lines

So the big question is, is there a case were virtio is used as an early console but virtio_console does not register a console during probe. Ideas?

Currently only ppc and s390 use early_console. And since you're sending this patch now, I guess you've started using multiport in the host recently. So it's really upto you to decide :-) I think this is benign as of now.

Amit

#4 lore raw

PATCH v2 1/1 virtio-console: wait for console ports

On s390 I have seen some random "Warning: unable to open an initial console" boot failure. Turns out that tty_open fails, because the hvc_alloc was not yet done. In former times this could not happen, since the probe function automatically called hvc_alloc. With newer versions (multiport) some host<->guest interaction is required before hvc_alloc is called. This might be too late, especially if an initramfs is involved. Lets use a completion if we have multiport and an early console.

---
 drivers/char/virtio_console.c |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
drivers/char/virtio_console.c +20 -0
Index: b/drivers/char/virtio_console.c
===================================================================
@@ -19,6 +19,7 @@
  */
 #include <linux/cdev.h>
 #include <linux/debugfs.h>
+#include <linux/completion.h>
 #include <linux/device.h>
 #include <linux/err.h>
 #include <linux/fs.h>
@@ -73,6 +74,7 @@ struct ports_driver_data {
 static struct ports_driver_data pdrvdata;
 
 DEFINE_SPINLOCK(pdrvdata_lock);
+DECLARE_COMPLETION(port_added);
 
 /* This struct holds information that's relevant only for console ports */
 struct console {
@@ -1352,6 +1354,7 @@ static void handle_control_message(struc
 			break;
 
 		init_port_console(port);
+		complete(&port_added);
 		/*
 		 * Could remove the port here in case init fails - but
 		 * have to notify the host first.
@@ -1648,6 +1651,10 @@ static int __devinit virtcons_probe(stru
 	struct ports_device *portdev;
 	int err;
 	bool multiport;
+	bool early = early_put_chars != 0;
+
+	/* Ensure to read early_put_chars now */
+	barrier();
 
 	portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
 	if (!portdev) {
@@ -1719,6 +1726,19 @@ static int __devinit virtcons_probe(stru
 
 	__send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
 			   VIRTIO_CONSOLE_DEVICE_READY, 1);
+
+	/*
+	 * If there was an early virtio console, assume that there are no
+	 * other consoles. We need to wait until the hvc_alloc matches the
+	 * hvc_instantiate, otherwise tty_open will complain, resulting in
+	 * a "Warning: unable to open an initial console" boot failure.
+	 * Without multiport this is done in add_port above. With multiport
+	 * this might take some host<->guest communication - thus we have to
+	 * wait.
+	 */
+	if (multiport && early)
+		wait_for_completion(&port_added);
+
 	return 0;
 
 free_vqs: