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/workqueue.h>
20 #include <linux/mutex.h>
21 #include <asm/uaccess.h>
26 #include "kern_util.h"
28 #include "mconsole_kern.h"
31 static int do_unlink_socket(struct notifier_block
*notifier
,
32 unsigned long what
, void *data
)
34 return mconsole_unlink_socket();
38 static struct notifier_block reboot_notifier
= {
39 .notifier_call
= do_unlink_socket
,
43 /* Safe without explicit locking for now. Tasklets provide their own
44 * locking, and the interrupt handler is safe because it can't interrupt
45 * itself and it can only happen on CPU 0.
48 static LIST_HEAD(mc_requests
);
50 static void mc_work_proc(struct work_struct
*unused
)
52 struct mconsole_entry
*req
;
55 while (!list_empty(&mc_requests
)) {
56 local_irq_save(flags
);
57 req
= list_entry(mc_requests
.next
, struct mconsole_entry
, list
);
59 local_irq_restore(flags
);
60 req
->request
.cmd
->handler(&req
->request
);
65 static DECLARE_WORK(mconsole_work
, mc_work_proc
);
67 static irqreturn_t
mconsole_interrupt(int irq
, void *dev_id
)
69 /* long to avoid size mismatch warnings from gcc */
71 struct mconsole_entry
*new;
72 static struct mc_request req
; /* that's OK */
75 while (mconsole_get_request(fd
, &req
)) {
76 if (req
.cmd
->context
== MCONSOLE_INTR
)
77 (*req
.cmd
->handler
)(&req
);
79 new = kmalloc(sizeof(*new), GFP_NOWAIT
);
81 mconsole_reply(&req
, "Out of memory", 1, 0);
84 new->request
.regs
= get_irq_regs()->regs
;
85 list_add(&new->list
, &mc_requests
);
89 if (!list_empty(&mc_requests
))
90 schedule_work(&mconsole_work
);
91 reactivate_fd(fd
, MCONSOLE_IRQ
);
95 void mconsole_version(struct mc_request
*req
)
99 sprintf(version
, "%s %s %s %s %s", utsname()->sysname
,
100 utsname()->nodename
, utsname()->release
, utsname()->version
,
102 mconsole_reply(req
, version
, 0, 0);
105 void mconsole_log(struct mc_request
*req
)
108 char *ptr
= req
->request
.data
;
110 ptr
+= strlen("log ");
112 len
= req
->len
- (ptr
- req
->request
.data
);
113 printk(KERN_WARNING
"%.*s", len
, ptr
);
114 mconsole_reply(req
, "", 0, 0);
117 /* This is a more convoluted version of mconsole_proc, which has some stability
118 * problems; however, we need it fixed, because it is expected that UML users
119 * mount HPPFS instead of procfs on /proc. And we want mconsole_proc to still
120 * show the real procfs content, not the ones from hppfs.*/
122 void mconsole_proc(struct mc_request
*req
)
125 struct file_system_type
*proc
;
126 struct super_block
*super
;
129 char *ptr
= req
->request
.data
, *buf
;
131 ptr
+= strlen("proc");
132 while (isspace(*ptr
)) ptr
++;
134 proc
= get_fs_type("proc");
136 mconsole_reply(req
, "procfs not registered", 1, 0);
140 super
= (*proc
->get_sb
)(proc
, 0, NULL
, NULL
);
141 put_filesystem(proc
);
143 mconsole_reply(req
, "Failed to get procfs superblock", 1, 0);
146 up_write(&super
->s_umount
);
148 nd
.path
.dentry
= super
->s_root
;
150 nd
.flags
= O_RDONLY
+ 1;
151 nd
.last_type
= LAST_ROOT
;
153 /* START: it was experienced that the stability problems are closed
154 * if commenting out these two calls + the below read cycle. To
155 * make UML crash again, it was enough to readd either one.*/
156 err
= link_path_walk(ptr
, &nd
);
158 mconsole_reply(req
, "Failed to look up file", 1, 0);
162 file
= dentry_open(nd
.path
.dentry
, nd
.path
.mnt
, O_RDONLY
,
165 mconsole_reply(req
, "Failed to open file", 1, 0);
170 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
172 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
176 if ((file
->f_op
!= NULL
) && (file
->f_op
->read
!= NULL
)) {
178 n
= (*file
->f_op
->read
)(file
, buf
, PAGE_SIZE
- 1,
182 mconsole_reply(req
, buf
, 0, (n
> 0));
185 mconsole_reply(req
, "Read of file failed",
191 else mconsole_reply(req
, "", 0, 0);
198 deactivate_super(super
);
203 void mconsole_proc(struct mc_request
*req
)
210 char *ptr
= req
->request
.data
;
212 ptr
+= strlen("proc");
213 while (isspace(*ptr
))
215 snprintf(path
, sizeof(path
), "/proc/%s", ptr
);
217 fd
= sys_open(path
, 0, 0);
219 mconsole_reply(req
, "Failed to open file", 1, 0);
220 printk(KERN_ERR
"open %s: %d\n",path
,fd
);
224 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
226 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
231 len
= sys_read(fd
, buf
, PAGE_SIZE
-1);
233 mconsole_reply(req
, "Read of file failed", 1, 0);
236 /* Begin the file content on his own line. */
238 mconsole_reply(req
, "\n", 0, 1);
241 if (len
== PAGE_SIZE
-1) {
243 mconsole_reply(req
, buf
, 0, 1);
246 mconsole_reply(req
, buf
, 0, 0);
259 #define UML_MCONSOLE_HELPTEXT \
261 version - Get kernel version \n\
262 help - Print this message \n\
264 reboot - Reboot UML \n\
265 config <dev>=<config> - Add a new device to UML; \n\
266 same syntax as command line \n\
267 config <dev> - Query the configuration of a device \n\
268 remove <dev> - Remove a device from UML \n\
269 sysrq <letter> - Performs the SysRq action controlled by the letter \n\
270 cad - invoke the Ctrl-Alt-Del handler \n\
271 stop - pause the UML; it will do nothing until it receives a 'go' \n\
272 go - continue the UML after a 'stop' \n\
273 log <string> - make UML enter <string> into the kernel log\n\
274 proc <file> - returns the contents of the UML's /proc/<file>\n\
275 stack <pid> - returns the stack of the specified pid\n\
278 void mconsole_help(struct mc_request
*req
)
280 mconsole_reply(req
, UML_MCONSOLE_HELPTEXT
, 0, 0);
283 void mconsole_halt(struct mc_request
*req
)
285 mconsole_reply(req
, "", 0, 0);
289 void mconsole_reboot(struct mc_request
*req
)
291 mconsole_reply(req
, "", 0, 0);
292 machine_restart(NULL
);
295 void mconsole_cad(struct mc_request
*req
)
297 mconsole_reply(req
, "", 0, 0);
301 void mconsole_go(struct mc_request
*req
)
303 mconsole_reply(req
, "Not stopped", 1, 0);
306 void mconsole_stop(struct mc_request
*req
)
308 deactivate_fd(req
->originating_fd
, MCONSOLE_IRQ
);
309 os_set_fd_block(req
->originating_fd
, 1);
310 mconsole_reply(req
, "stopped", 0, 0);
312 if (!mconsole_get_request(req
->originating_fd
, req
))
314 if (req
->cmd
->handler
== mconsole_go
)
316 if (req
->cmd
->handler
== mconsole_stop
) {
317 mconsole_reply(req
, "Already stopped", 1, 0);
320 if (req
->cmd
->handler
== mconsole_sysrq
) {
321 struct pt_regs
*old_regs
;
322 old_regs
= set_irq_regs((struct pt_regs
*)&req
->regs
);
324 set_irq_regs(old_regs
);
327 (*req
->cmd
->handler
)(req
);
329 os_set_fd_block(req
->originating_fd
, 0);
330 reactivate_fd(req
->originating_fd
, MCONSOLE_IRQ
);
331 mconsole_reply(req
, "", 0, 0);
334 static DEFINE_SPINLOCK(mc_devices_lock
);
335 static LIST_HEAD(mconsole_devices
);
337 void mconsole_register_dev(struct mc_device
*new)
339 spin_lock(&mc_devices_lock
);
340 BUG_ON(!list_empty(&new->list
));
341 list_add(&new->list
, &mconsole_devices
);
342 spin_unlock(&mc_devices_lock
);
345 static struct mc_device
*mconsole_find_dev(char *name
)
347 struct list_head
*ele
;
348 struct mc_device
*dev
;
350 list_for_each(ele
, &mconsole_devices
) {
351 dev
= list_entry(ele
, struct mc_device
, list
);
352 if (!strncmp(name
, dev
->name
, strlen(dev
->name
)))
358 #define UNPLUGGED_PER_PAGE \
359 ((PAGE_SIZE - sizeof(struct list_head)) / sizeof(unsigned long))
361 struct unplugged_pages
{
362 struct list_head list
;
363 void *pages
[UNPLUGGED_PER_PAGE
];
366 static DEFINE_MUTEX(plug_mem_mutex
);
367 static unsigned long long unplugged_pages_count
= 0;
368 static LIST_HEAD(unplugged_pages
);
369 static int unplug_index
= UNPLUGGED_PER_PAGE
;
371 static int mem_config(char *str
, char **error_out
)
373 unsigned long long diff
;
374 int err
= -EINVAL
, i
, add
;
378 *error_out
= "Expected '=' after 'mem'";
385 else if (str
[0] == '+') {
389 *error_out
= "Expected increment to start with '-' or '+'";
394 diff
= memparse(str
, &ret
);
396 *error_out
= "Failed to parse memory increment";
402 mutex_lock(&plug_mem_mutex
);
403 for (i
= 0; i
< diff
; i
++) {
404 struct unplugged_pages
*unplugged
;
408 if (list_empty(&unplugged_pages
))
411 unplugged
= list_entry(unplugged_pages
.next
,
412 struct unplugged_pages
, list
);
413 if (unplug_index
> 0)
414 addr
= unplugged
->pages
[--unplug_index
];
416 list_del(&unplugged
->list
);
418 unplug_index
= UNPLUGGED_PER_PAGE
;
421 free_page((unsigned long) addr
);
422 unplugged_pages_count
--;
427 page
= alloc_page(GFP_ATOMIC
);
431 unplugged
= page_address(page
);
432 if (unplug_index
== UNPLUGGED_PER_PAGE
) {
433 list_add(&unplugged
->list
, &unplugged_pages
);
437 struct list_head
*entry
= unplugged_pages
.next
;
440 unplugged
= list_entry(entry
,
441 struct unplugged_pages
,
443 err
= os_drop_memory(addr
, PAGE_SIZE
);
445 printk(KERN_ERR
"Failed to release "
446 "memory - errno = %d\n", err
);
447 *error_out
= "Failed to release memory";
450 unplugged
->pages
[unplug_index
++] = addr
;
453 unplugged_pages_count
++;
459 mutex_unlock(&plug_mem_mutex
);
464 static int mem_get_config(char *name
, char *str
, int size
, char **error_out
)
466 char buf
[sizeof("18446744073709551615")];
469 sprintf(buf
, "%ld", uml_physmem
);
470 CONFIG_CHUNK(str
, size
, len
, buf
, 1);
475 static int mem_id(char **str
, int *start_out
, int *end_out
)
483 static int mem_remove(int n
, char **error_out
)
485 *error_out
= "Memory doesn't support the remove operation";
489 static struct mc_device mem_mc
= {
490 .list
= LIST_HEAD_INIT(mem_mc
.list
),
492 .config
= mem_config
,
493 .get_config
= mem_get_config
,
495 .remove
= mem_remove
,
498 static int __init
mem_mc_init(void)
500 if (can_drop_memory())
501 mconsole_register_dev(&mem_mc
);
502 else printk(KERN_ERR
"Can't release memory to the host - memory "
503 "hotplug won't be supported\n");
507 __initcall(mem_mc_init
);
509 #define CONFIG_BUF_SIZE 64
511 static void mconsole_get_config(int (*get_config
)(char *, char *, int,
513 struct mc_request
*req
, char *name
)
515 char default_buf
[CONFIG_BUF_SIZE
], *error
, *buf
;
518 if (get_config
== NULL
) {
519 mconsole_reply(req
, "No get_config routine defined", 1, 0);
524 size
= ARRAY_SIZE(default_buf
);
528 n
= (*get_config
)(name
, buf
, size
, &error
);
530 mconsole_reply(req
, error
, 1, 0);
535 mconsole_reply(req
, buf
, 0, 0);
539 if (buf
!= default_buf
)
543 buf
= kmalloc(size
, GFP_KERNEL
);
545 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
550 if (buf
!= default_buf
)
554 void mconsole_config(struct mc_request
*req
)
556 struct mc_device
*dev
;
557 char *ptr
= req
->request
.data
, *name
, *error_string
= "";
560 ptr
+= strlen("config");
561 while (isspace(*ptr
))
563 dev
= mconsole_find_dev(ptr
);
565 mconsole_reply(req
, "Bad configuration option", 1, 0);
569 name
= &ptr
[strlen(dev
->name
)];
571 while ((*ptr
!= '=') && (*ptr
!= '\0'))
575 err
= (*dev
->config
)(name
, &error_string
);
576 mconsole_reply(req
, error_string
, err
, 0);
578 else mconsole_get_config(dev
->get_config
, req
, name
);
581 void mconsole_remove(struct mc_request
*req
)
583 struct mc_device
*dev
;
584 char *ptr
= req
->request
.data
, *err_msg
= "";
586 int err
, start
, end
, n
;
588 ptr
+= strlen("remove");
589 while (isspace(*ptr
)) ptr
++;
590 dev
= mconsole_find_dev(ptr
);
592 mconsole_reply(req
, "Bad remove option", 1, 0);
596 ptr
= &ptr
[strlen(dev
->name
)];
599 n
= (*dev
->id
)(&ptr
, &start
, &end
);
601 err_msg
= "Couldn't parse device number";
604 else if ((n
< start
) || (n
> end
)) {
605 sprintf(error
, "Invalid device number - must be between "
606 "%d and %d", start
, end
);
612 err
= (*dev
->remove
)(n
, &err_msg
);
619 err_msg
= "Device doesn't exist";
623 err_msg
= "Device is currently open";
629 mconsole_reply(req
, err_msg
, err
, 0);
632 struct mconsole_output
{
633 struct list_head list
;
634 struct mc_request
*req
;
637 static DEFINE_SPINLOCK(client_lock
);
638 static LIST_HEAD(clients
);
639 static char console_buf
[MCONSOLE_MAX_DATA
];
641 static void console_write(struct console
*console
, const char *string
,
644 struct list_head
*ele
;
647 if (list_empty(&clients
))
651 n
= min((size_t) len
, ARRAY_SIZE(console_buf
));
652 strncpy(console_buf
, string
, n
);
656 list_for_each(ele
, &clients
) {
657 struct mconsole_output
*entry
;
659 entry
= list_entry(ele
, struct mconsole_output
, list
);
660 mconsole_reply_len(entry
->req
, console_buf
, n
, 0, 1);
665 static struct console mc_console
= { .name
= "mc",
666 .write
= console_write
,
667 .flags
= CON_ENABLED
,
670 static int mc_add_console(void)
672 register_console(&mc_console
);
676 late_initcall(mc_add_console
);
678 static void with_console(struct mc_request
*req
, void (*proc
)(void *),
681 struct mconsole_output entry
;
685 spin_lock_irqsave(&client_lock
, flags
);
686 list_add(&entry
.list
, &clients
);
687 spin_unlock_irqrestore(&client_lock
, flags
);
691 mconsole_reply_len(req
, "", 0, 0, 0);
693 spin_lock_irqsave(&client_lock
, flags
);
694 list_del(&entry
.list
);
695 spin_unlock_irqrestore(&client_lock
, flags
);
698 #ifdef CONFIG_MAGIC_SYSRQ
700 #include <linux/sysrq.h>
702 static void sysrq_proc(void *arg
)
705 handle_sysrq(*op
, NULL
);
708 void mconsole_sysrq(struct mc_request
*req
)
710 char *ptr
= req
->request
.data
;
712 ptr
+= strlen("sysrq");
713 while (isspace(*ptr
)) ptr
++;
716 * With 'b', the system will shut down without a chance to reply,
717 * so in this case, we reply first.
720 mconsole_reply(req
, "", 0, 0);
722 with_console(req
, sysrq_proc
, ptr
);
725 void mconsole_sysrq(struct mc_request
*req
)
727 mconsole_reply(req
, "Sysrq not compiled in", 1, 0);
731 static void stack_proc(void *arg
)
733 struct task_struct
*from
= current
, *to
= arg
;
735 to
->thread
.saved_task
= from
;
736 switch_to(from
, to
, from
);
740 * Mconsole stack trace
741 * Added by Allan Graves, Jeff Dike
742 * Dumps a stacks registers to the linux console.
745 void mconsole_stack(struct mc_request
*req
)
747 char *ptr
= req
->request
.data
;
748 int pid_requested
= -1;
749 struct task_struct
*to
= NULL
;
753 * 1) Send showregs output to mconsole.
754 * 2) Add a way to stack dump all pids.
757 ptr
+= strlen("stack");
758 while (isspace(*ptr
))
762 * Should really check for multiple pids or reject bad args here
764 /* What do the arguments in mconsole_reply mean? */
765 if (sscanf(ptr
, "%d", &pid_requested
) == 0) {
766 mconsole_reply(req
, "Please specify a pid", 1, 0);
770 to
= find_task_by_pid_ns(pid_requested
, &init_pid_ns
);
771 if ((to
== NULL
) || (pid_requested
== 0)) {
772 mconsole_reply(req
, "Couldn't find that pid", 1, 0);
775 with_console(req
, stack_proc
, to
);
779 * Changed by mconsole_setup, which is __setup, and called before SMP is
782 static char *notify_socket
= NULL
;
784 static int __init
mconsole_init(void)
786 /* long to avoid size mismatch warnings from gcc */
791 if (umid_file_name("mconsole", file
, sizeof(file
)))
793 snprintf(mconsole_socket_name
, sizeof(file
), "%s", file
);
795 sock
= os_create_unix_socket(file
, sizeof(file
), 1);
797 printk(KERN_ERR
"Failed to initialize management console\n");
800 if (os_set_fd_block(sock
, 0))
803 register_reboot_notifier(&reboot_notifier
);
805 err
= um_request_irq(MCONSOLE_IRQ
, sock
, IRQ_READ
, mconsole_interrupt
,
806 IRQF_DISABLED
| IRQF_SHARED
| IRQF_SAMPLE_RANDOM
,
807 "mconsole", (void *)sock
);
809 printk(KERN_ERR
"Failed to get IRQ for management console\n");
813 if (notify_socket
!= NULL
) {
814 notify_socket
= kstrdup(notify_socket
, GFP_KERNEL
);
815 if (notify_socket
!= NULL
)
816 mconsole_notify(notify_socket
, MCONSOLE_SOCKET
,
817 mconsole_socket_name
,
818 strlen(mconsole_socket_name
) + 1);
819 else printk(KERN_ERR
"mconsole_setup failed to strdup "
823 printk(KERN_INFO
"mconsole (version %d) initialized on %s\n",
824 MCONSOLE_VERSION
, mconsole_socket_name
);
832 __initcall(mconsole_init
);
834 static int write_proc_mconsole(struct file
*file
, const char __user
*buffer
,
835 unsigned long count
, void *data
)
839 buf
= kmalloc(count
+ 1, GFP_KERNEL
);
843 if (copy_from_user(buf
, buffer
, count
)) {
850 mconsole_notify(notify_socket
, MCONSOLE_USER_NOTIFY
, buf
, count
);
856 static int create_proc_mconsole(void)
858 struct proc_dir_entry
*ent
;
860 if (notify_socket
== NULL
)
863 ent
= create_proc_entry("mconsole", S_IFREG
| 0200, NULL
);
865 printk(KERN_INFO
"create_proc_mconsole : create_proc_entry "
870 ent
->read_proc
= NULL
;
871 ent
->write_proc
= write_proc_mconsole
;
875 static DEFINE_SPINLOCK(notify_spinlock
);
877 void lock_notify(void)
879 spin_lock(¬ify_spinlock
);
882 void unlock_notify(void)
884 spin_unlock(¬ify_spinlock
);
887 __initcall(create_proc_mconsole
);
889 #define NOTIFY "notify:"
891 static int mconsole_setup(char *str
)
893 if (!strncmp(str
, NOTIFY
, strlen(NOTIFY
))) {
894 str
+= strlen(NOTIFY
);
897 else printk(KERN_ERR
"mconsole_setup : Unknown option - '%s'\n", str
);
901 __setup("mconsole=", mconsole_setup
);
903 __uml_help(mconsole_setup
,
904 "mconsole=notify:<socket>\n"
905 " Requests that the mconsole driver send a message to the named Unix\n"
906 " socket containing the name of the mconsole socket. This also serves\n"
907 " to notify outside processes when UML has booted far enough to respond\n"
908 " to mconsole requests.\n\n"
911 static int notify_panic(struct notifier_block
*self
, unsigned long unused1
,
916 if (notify_socket
== NULL
)
919 mconsole_notify(notify_socket
, MCONSOLE_PANIC
, message
,
920 strlen(message
) + 1);
924 static struct notifier_block panic_exit_notifier
= {
925 .notifier_call
= notify_panic
,
930 static int add_notifier(void)
932 atomic_notifier_chain_register(&panic_notifier_list
,
933 &panic_exit_notifier
);
937 __initcall(add_notifier
);
939 char *mconsole_notify_socket(void)
941 return notify_socket
;
944 EXPORT_SYMBOL(mconsole_notify_socket
);