2 * Copyright (C) 2001 Lennert Buytenhek (buytenh@gnu.org)
3 * Copyright (C) 2001 - 2008 Jeff Dike (jdike@{addtoit,linux.intel}.com)
4 * Licensed under the GPL
7 #include <linux/console.h>
8 #include <linux/ctype.h>
9 #include <linux/interrupt.h>
10 #include <linux/list.h>
12 #include <linux/module.h>
13 #include <linux/notifier.h>
14 #include <linux/reboot.h>
15 #include <linux/proc_fs.h>
16 #include <linux/slab.h>
17 #include <linux/syscalls.h>
18 #include <linux/utsname.h>
19 #include <linux/socket.h>
21 #include <linux/workqueue.h>
22 #include <linux/mutex.h>
23 #include <asm/uaccess.h>
28 #include "kern_util.h"
30 #include "mconsole_kern.h"
33 static int do_unlink_socket(struct notifier_block
*notifier
,
34 unsigned long what
, void *data
)
36 return mconsole_unlink_socket();
40 static struct notifier_block reboot_notifier
= {
41 .notifier_call
= do_unlink_socket
,
45 /* Safe without explicit locking for now. Tasklets provide their own
46 * locking, and the interrupt handler is safe because it can't interrupt
47 * itself and it can only happen on CPU 0.
50 static LIST_HEAD(mc_requests
);
52 static void mc_work_proc(struct work_struct
*unused
)
54 struct mconsole_entry
*req
;
57 while (!list_empty(&mc_requests
)) {
58 local_irq_save(flags
);
59 req
= list_entry(mc_requests
.next
, struct mconsole_entry
, list
);
61 local_irq_restore(flags
);
62 req
->request
.cmd
->handler(&req
->request
);
67 static DECLARE_WORK(mconsole_work
, mc_work_proc
);
69 static irqreturn_t
mconsole_interrupt(int irq
, void *dev_id
)
71 /* long to avoid size mismatch warnings from gcc */
73 struct mconsole_entry
*new;
74 static struct mc_request req
; /* that's OK */
77 while (mconsole_get_request(fd
, &req
)) {
78 if (req
.cmd
->context
== MCONSOLE_INTR
)
79 (*req
.cmd
->handler
)(&req
);
81 new = kmalloc(sizeof(*new), GFP_NOWAIT
);
83 mconsole_reply(&req
, "Out of memory", 1, 0);
86 new->request
.regs
= get_irq_regs()->regs
;
87 list_add(&new->list
, &mc_requests
);
91 if (!list_empty(&mc_requests
))
92 schedule_work(&mconsole_work
);
93 reactivate_fd(fd
, MCONSOLE_IRQ
);
97 void mconsole_version(struct mc_request
*req
)
101 sprintf(version
, "%s %s %s %s %s", utsname()->sysname
,
102 utsname()->nodename
, utsname()->release
, utsname()->version
,
104 mconsole_reply(req
, version
, 0, 0);
107 void mconsole_log(struct mc_request
*req
)
110 char *ptr
= req
->request
.data
;
112 ptr
+= strlen("log ");
114 len
= req
->len
- (ptr
- req
->request
.data
);
115 printk(KERN_WARNING
"%.*s", len
, ptr
);
116 mconsole_reply(req
, "", 0, 0);
119 /* This is a more convoluted version of mconsole_proc, which has some stability
120 * problems; however, we need it fixed, because it is expected that UML users
121 * mount HPPFS instead of procfs on /proc. And we want mconsole_proc to still
122 * show the real procfs content, not the ones from hppfs.*/
124 void mconsole_proc(struct mc_request
*req
)
127 struct file_system_type
*proc
;
128 struct super_block
*super
;
131 char *ptr
= req
->request
.data
, *buf
;
133 ptr
+= strlen("proc");
134 while (isspace(*ptr
)) ptr
++;
136 proc
= get_fs_type("proc");
138 mconsole_reply(req
, "procfs not registered", 1, 0);
142 super
= (*proc
->get_sb
)(proc
, 0, NULL
, NULL
);
143 put_filesystem(proc
);
145 mconsole_reply(req
, "Failed to get procfs superblock", 1, 0);
148 up_write(&super
->s_umount
);
150 nd
.path
.dentry
= super
->s_root
;
152 nd
.flags
= O_RDONLY
+ 1;
153 nd
.last_type
= LAST_ROOT
;
155 /* START: it was experienced that the stability problems are closed
156 * if commenting out these two calls + the below read cycle. To
157 * make UML crash again, it was enough to readd either one.*/
158 err
= link_path_walk(ptr
, &nd
);
160 mconsole_reply(req
, "Failed to look up file", 1, 0);
164 file
= dentry_open(nd
.path
.dentry
, nd
.path
.mnt
, O_RDONLY
);
166 mconsole_reply(req
, "Failed to open file", 1, 0);
171 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
173 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
177 if ((file
->f_op
!= NULL
) && (file
->f_op
->read
!= NULL
)) {
179 n
= (*file
->f_op
->read
)(file
, buf
, PAGE_SIZE
- 1,
183 mconsole_reply(req
, buf
, 0, (n
> 0));
186 mconsole_reply(req
, "Read of file failed",
192 else mconsole_reply(req
, "", 0, 0);
199 deactivate_super(super
);
204 void mconsole_proc(struct mc_request
*req
)
211 char *ptr
= req
->request
.data
;
213 ptr
+= strlen("proc");
214 while (isspace(*ptr
))
216 snprintf(path
, sizeof(path
), "/proc/%s", ptr
);
218 fd
= sys_open(path
, 0, 0);
220 mconsole_reply(req
, "Failed to open file", 1, 0);
221 printk(KERN_ERR
"open %s: %d\n",path
,fd
);
225 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
227 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
232 len
= sys_read(fd
, buf
, PAGE_SIZE
-1);
234 mconsole_reply(req
, "Read of file failed", 1, 0);
237 /* Begin the file content on his own line. */
239 mconsole_reply(req
, "\n", 0, 1);
242 if (len
== PAGE_SIZE
-1) {
244 mconsole_reply(req
, buf
, 0, 1);
247 mconsole_reply(req
, buf
, 0, 0);
260 #define UML_MCONSOLE_HELPTEXT \
262 version - Get kernel version \n\
263 help - Print this message \n\
265 reboot - Reboot UML \n\
266 config <dev>=<config> - Add a new device to UML; \n\
267 same syntax as command line \n\
268 config <dev> - Query the configuration of a device \n\
269 remove <dev> - Remove a device from UML \n\
270 sysrq <letter> - Performs the SysRq action controlled by the letter \n\
271 cad - invoke the Ctrl-Alt-Del handler \n\
272 stop - pause the UML; it will do nothing until it receives a 'go' \n\
273 go - continue the UML after a 'stop' \n\
274 log <string> - make UML enter <string> into the kernel log\n\
275 proc <file> - returns the contents of the UML's /proc/<file>\n\
276 stack <pid> - returns the stack of the specified pid\n\
279 void mconsole_help(struct mc_request
*req
)
281 mconsole_reply(req
, UML_MCONSOLE_HELPTEXT
, 0, 0);
284 void mconsole_halt(struct mc_request
*req
)
286 mconsole_reply(req
, "", 0, 0);
290 void mconsole_reboot(struct mc_request
*req
)
292 mconsole_reply(req
, "", 0, 0);
293 machine_restart(NULL
);
296 void mconsole_cad(struct mc_request
*req
)
298 mconsole_reply(req
, "", 0, 0);
302 void mconsole_go(struct mc_request
*req
)
304 mconsole_reply(req
, "Not stopped", 1, 0);
307 void mconsole_stop(struct mc_request
*req
)
309 deactivate_fd(req
->originating_fd
, MCONSOLE_IRQ
);
310 os_set_fd_block(req
->originating_fd
, 1);
311 mconsole_reply(req
, "stopped", 0, 0);
313 if (!mconsole_get_request(req
->originating_fd
, req
))
315 if (req
->cmd
->handler
== mconsole_go
)
317 if (req
->cmd
->handler
== mconsole_stop
) {
318 mconsole_reply(req
, "Already stopped", 1, 0);
321 if (req
->cmd
->handler
== mconsole_sysrq
) {
322 struct pt_regs
*old_regs
;
323 old_regs
= set_irq_regs((struct pt_regs
*)&req
->regs
);
325 set_irq_regs(old_regs
);
328 (*req
->cmd
->handler
)(req
);
330 os_set_fd_block(req
->originating_fd
, 0);
331 reactivate_fd(req
->originating_fd
, MCONSOLE_IRQ
);
332 mconsole_reply(req
, "", 0, 0);
335 static DEFINE_SPINLOCK(mc_devices_lock
);
336 static LIST_HEAD(mconsole_devices
);
338 void mconsole_register_dev(struct mc_device
*new)
340 spin_lock(&mc_devices_lock
);
341 BUG_ON(!list_empty(&new->list
));
342 list_add(&new->list
, &mconsole_devices
);
343 spin_unlock(&mc_devices_lock
);
346 static struct mc_device
*mconsole_find_dev(char *name
)
348 struct list_head
*ele
;
349 struct mc_device
*dev
;
351 list_for_each(ele
, &mconsole_devices
) {
352 dev
= list_entry(ele
, struct mc_device
, list
);
353 if (!strncmp(name
, dev
->name
, strlen(dev
->name
)))
359 #define UNPLUGGED_PER_PAGE \
360 ((PAGE_SIZE - sizeof(struct list_head)) / sizeof(unsigned long))
362 struct unplugged_pages
{
363 struct list_head list
;
364 void *pages
[UNPLUGGED_PER_PAGE
];
367 static DEFINE_MUTEX(plug_mem_mutex
);
368 static unsigned long long unplugged_pages_count
= 0;
369 static LIST_HEAD(unplugged_pages
);
370 static int unplug_index
= UNPLUGGED_PER_PAGE
;
372 static int mem_config(char *str
, char **error_out
)
374 unsigned long long diff
;
375 int err
= -EINVAL
, i
, add
;
379 *error_out
= "Expected '=' after 'mem'";
386 else if (str
[0] == '+') {
390 *error_out
= "Expected increment to start with '-' or '+'";
395 diff
= memparse(str
, &ret
);
397 *error_out
= "Failed to parse memory increment";
403 mutex_lock(&plug_mem_mutex
);
404 for (i
= 0; i
< diff
; i
++) {
405 struct unplugged_pages
*unplugged
;
409 if (list_empty(&unplugged_pages
))
412 unplugged
= list_entry(unplugged_pages
.next
,
413 struct unplugged_pages
, list
);
414 if (unplug_index
> 0)
415 addr
= unplugged
->pages
[--unplug_index
];
417 list_del(&unplugged
->list
);
419 unplug_index
= UNPLUGGED_PER_PAGE
;
422 free_page((unsigned long) addr
);
423 unplugged_pages_count
--;
428 page
= alloc_page(GFP_ATOMIC
);
432 unplugged
= page_address(page
);
433 if (unplug_index
== UNPLUGGED_PER_PAGE
) {
434 list_add(&unplugged
->list
, &unplugged_pages
);
438 struct list_head
*entry
= unplugged_pages
.next
;
441 unplugged
= list_entry(entry
,
442 struct unplugged_pages
,
444 err
= os_drop_memory(addr
, PAGE_SIZE
);
446 printk(KERN_ERR
"Failed to release "
447 "memory - errno = %d\n", err
);
448 *error_out
= "Failed to release memory";
451 unplugged
->pages
[unplug_index
++] = addr
;
454 unplugged_pages_count
++;
460 mutex_unlock(&plug_mem_mutex
);
465 static int mem_get_config(char *name
, char *str
, int size
, char **error_out
)
467 char buf
[sizeof("18446744073709551615")];
470 sprintf(buf
, "%ld", uml_physmem
);
471 CONFIG_CHUNK(str
, size
, len
, buf
, 1);
476 static int mem_id(char **str
, int *start_out
, int *end_out
)
484 static int mem_remove(int n
, char **error_out
)
486 *error_out
= "Memory doesn't support the remove operation";
490 static struct mc_device mem_mc
= {
491 .list
= LIST_HEAD_INIT(mem_mc
.list
),
493 .config
= mem_config
,
494 .get_config
= mem_get_config
,
496 .remove
= mem_remove
,
499 static int __init
mem_mc_init(void)
501 if (can_drop_memory())
502 mconsole_register_dev(&mem_mc
);
503 else printk(KERN_ERR
"Can't release memory to the host - memory "
504 "hotplug won't be supported\n");
508 __initcall(mem_mc_init
);
510 #define CONFIG_BUF_SIZE 64
512 static void mconsole_get_config(int (*get_config
)(char *, char *, int,
514 struct mc_request
*req
, char *name
)
516 char default_buf
[CONFIG_BUF_SIZE
], *error
, *buf
;
519 if (get_config
== NULL
) {
520 mconsole_reply(req
, "No get_config routine defined", 1, 0);
525 size
= ARRAY_SIZE(default_buf
);
529 n
= (*get_config
)(name
, buf
, size
, &error
);
531 mconsole_reply(req
, error
, 1, 0);
536 mconsole_reply(req
, buf
, 0, 0);
540 if (buf
!= default_buf
)
544 buf
= kmalloc(size
, GFP_KERNEL
);
546 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
551 if (buf
!= default_buf
)
555 void mconsole_config(struct mc_request
*req
)
557 struct mc_device
*dev
;
558 char *ptr
= req
->request
.data
, *name
, *error_string
= "";
561 ptr
+= strlen("config");
562 while (isspace(*ptr
))
564 dev
= mconsole_find_dev(ptr
);
566 mconsole_reply(req
, "Bad configuration option", 1, 0);
570 name
= &ptr
[strlen(dev
->name
)];
572 while ((*ptr
!= '=') && (*ptr
!= '\0'))
576 err
= (*dev
->config
)(name
, &error_string
);
577 mconsole_reply(req
, error_string
, err
, 0);
579 else mconsole_get_config(dev
->get_config
, req
, name
);
582 void mconsole_remove(struct mc_request
*req
)
584 struct mc_device
*dev
;
585 char *ptr
= req
->request
.data
, *err_msg
= "";
587 int err
, start
, end
, n
;
589 ptr
+= strlen("remove");
590 while (isspace(*ptr
)) ptr
++;
591 dev
= mconsole_find_dev(ptr
);
593 mconsole_reply(req
, "Bad remove option", 1, 0);
597 ptr
= &ptr
[strlen(dev
->name
)];
600 n
= (*dev
->id
)(&ptr
, &start
, &end
);
602 err_msg
= "Couldn't parse device number";
605 else if ((n
< start
) || (n
> end
)) {
606 sprintf(error
, "Invalid device number - must be between "
607 "%d and %d", start
, end
);
613 err
= (*dev
->remove
)(n
, &err_msg
);
620 err_msg
= "Device doesn't exist";
624 err_msg
= "Device is currently open";
630 mconsole_reply(req
, err_msg
, err
, 0);
633 struct mconsole_output
{
634 struct list_head list
;
635 struct mc_request
*req
;
638 static DEFINE_SPINLOCK(client_lock
);
639 static LIST_HEAD(clients
);
640 static char console_buf
[MCONSOLE_MAX_DATA
];
642 static void console_write(struct console
*console
, const char *string
,
645 struct list_head
*ele
;
648 if (list_empty(&clients
))
652 n
= min((size_t) len
, ARRAY_SIZE(console_buf
));
653 strncpy(console_buf
, string
, n
);
657 list_for_each(ele
, &clients
) {
658 struct mconsole_output
*entry
;
660 entry
= list_entry(ele
, struct mconsole_output
, list
);
661 mconsole_reply_len(entry
->req
, console_buf
, n
, 0, 1);
666 static struct console mc_console
= { .name
= "mc",
667 .write
= console_write
,
668 .flags
= CON_ENABLED
,
671 static int mc_add_console(void)
673 register_console(&mc_console
);
677 late_initcall(mc_add_console
);
679 static void with_console(struct mc_request
*req
, void (*proc
)(void *),
682 struct mconsole_output entry
;
686 spin_lock_irqsave(&client_lock
, flags
);
687 list_add(&entry
.list
, &clients
);
688 spin_unlock_irqrestore(&client_lock
, flags
);
692 mconsole_reply_len(req
, "", 0, 0, 0);
694 spin_lock_irqsave(&client_lock
, flags
);
695 list_del(&entry
.list
);
696 spin_unlock_irqrestore(&client_lock
, flags
);
699 #ifdef CONFIG_MAGIC_SYSRQ
701 #include <linux/sysrq.h>
703 static void sysrq_proc(void *arg
)
706 handle_sysrq(*op
, NULL
);
709 void mconsole_sysrq(struct mc_request
*req
)
711 char *ptr
= req
->request
.data
;
713 ptr
+= strlen("sysrq");
714 while (isspace(*ptr
)) ptr
++;
717 * With 'b', the system will shut down without a chance to reply,
718 * so in this case, we reply first.
721 mconsole_reply(req
, "", 0, 0);
723 with_console(req
, sysrq_proc
, ptr
);
726 void mconsole_sysrq(struct mc_request
*req
)
728 mconsole_reply(req
, "Sysrq not compiled in", 1, 0);
732 static void stack_proc(void *arg
)
734 struct task_struct
*from
= current
, *to
= arg
;
736 to
->thread
.saved_task
= from
;
737 switch_to(from
, to
, from
);
741 * Mconsole stack trace
742 * Added by Allan Graves, Jeff Dike
743 * Dumps a stacks registers to the linux console.
746 void mconsole_stack(struct mc_request
*req
)
748 char *ptr
= req
->request
.data
;
749 int pid_requested
= -1;
750 struct task_struct
*to
= NULL
;
754 * 1) Send showregs output to mconsole.
755 * 2) Add a way to stack dump all pids.
758 ptr
+= strlen("stack");
759 while (isspace(*ptr
))
763 * Should really check for multiple pids or reject bad args here
765 /* What do the arguments in mconsole_reply mean? */
766 if (sscanf(ptr
, "%d", &pid_requested
) == 0) {
767 mconsole_reply(req
, "Please specify a pid", 1, 0);
771 to
= find_task_by_pid_ns(pid_requested
, &init_pid_ns
);
772 if ((to
== NULL
) || (pid_requested
== 0)) {
773 mconsole_reply(req
, "Couldn't find that pid", 1, 0);
776 with_console(req
, stack_proc
, to
);
780 * Changed by mconsole_setup, which is __setup, and called before SMP is
783 static char *notify_socket
= NULL
;
785 static int __init
mconsole_init(void)
787 /* long to avoid size mismatch warnings from gcc */
790 char file
[UNIX_PATH_MAX
];
792 if (umid_file_name("mconsole", file
, sizeof(file
)))
794 snprintf(mconsole_socket_name
, sizeof(file
), "%s", file
);
796 sock
= os_create_unix_socket(file
, sizeof(file
), 1);
798 printk(KERN_ERR
"Failed to initialize management console\n");
801 if (os_set_fd_block(sock
, 0))
804 register_reboot_notifier(&reboot_notifier
);
806 err
= um_request_irq(MCONSOLE_IRQ
, sock
, IRQ_READ
, mconsole_interrupt
,
807 IRQF_DISABLED
| IRQF_SHARED
| IRQF_SAMPLE_RANDOM
,
808 "mconsole", (void *)sock
);
810 printk(KERN_ERR
"Failed to get IRQ for management console\n");
814 if (notify_socket
!= NULL
) {
815 notify_socket
= kstrdup(notify_socket
, GFP_KERNEL
);
816 if (notify_socket
!= NULL
)
817 mconsole_notify(notify_socket
, MCONSOLE_SOCKET
,
818 mconsole_socket_name
,
819 strlen(mconsole_socket_name
) + 1);
820 else printk(KERN_ERR
"mconsole_setup failed to strdup "
824 printk(KERN_INFO
"mconsole (version %d) initialized on %s\n",
825 MCONSOLE_VERSION
, mconsole_socket_name
);
833 __initcall(mconsole_init
);
835 static int write_proc_mconsole(struct file
*file
, const char __user
*buffer
,
836 unsigned long count
, void *data
)
840 buf
= kmalloc(count
+ 1, GFP_KERNEL
);
844 if (copy_from_user(buf
, buffer
, count
)) {
851 mconsole_notify(notify_socket
, MCONSOLE_USER_NOTIFY
, buf
, count
);
857 static int create_proc_mconsole(void)
859 struct proc_dir_entry
*ent
;
861 if (notify_socket
== NULL
)
864 ent
= create_proc_entry("mconsole", S_IFREG
| 0200, NULL
);
866 printk(KERN_INFO
"create_proc_mconsole : create_proc_entry "
871 ent
->read_proc
= NULL
;
872 ent
->write_proc
= write_proc_mconsole
;
876 static DEFINE_SPINLOCK(notify_spinlock
);
878 void lock_notify(void)
880 spin_lock(¬ify_spinlock
);
883 void unlock_notify(void)
885 spin_unlock(¬ify_spinlock
);
888 __initcall(create_proc_mconsole
);
890 #define NOTIFY "notify:"
892 static int mconsole_setup(char *str
)
894 if (!strncmp(str
, NOTIFY
, strlen(NOTIFY
))) {
895 str
+= strlen(NOTIFY
);
898 else printk(KERN_ERR
"mconsole_setup : Unknown option - '%s'\n", str
);
902 __setup("mconsole=", mconsole_setup
);
904 __uml_help(mconsole_setup
,
905 "mconsole=notify:<socket>\n"
906 " Requests that the mconsole driver send a message to the named Unix\n"
907 " socket containing the name of the mconsole socket. This also serves\n"
908 " to notify outside processes when UML has booted far enough to respond\n"
909 " to mconsole requests.\n\n"
912 static int notify_panic(struct notifier_block
*self
, unsigned long unused1
,
917 if (notify_socket
== NULL
)
920 mconsole_notify(notify_socket
, MCONSOLE_PANIC
, message
,
921 strlen(message
) + 1);
925 static struct notifier_block panic_exit_notifier
= {
926 .notifier_call
= notify_panic
,
931 static int add_notifier(void)
933 atomic_notifier_chain_register(&panic_notifier_list
,
934 &panic_exit_notifier
);
938 __initcall(add_notifier
);
940 char *mconsole_notify_socket(void)
942 return notify_socket
;
945 EXPORT_SYMBOL(mconsole_notify_socket
);