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/string.h>
10 #include <linux/interrupt.h>
11 #include <linux/list.h>
13 #include <linux/module.h>
14 #include <linux/notifier.h>
15 #include <linux/reboot.h>
16 #include <linux/proc_fs.h>
17 #include <linux/slab.h>
18 #include <linux/syscalls.h>
19 #include <linux/utsname.h>
20 #include <linux/socket.h>
22 #include <linux/workqueue.h>
23 #include <linux/mutex.h>
24 #include <asm/uaccess.h>
29 #include "kern_util.h"
31 #include "mconsole_kern.h"
34 static int do_unlink_socket(struct notifier_block
*notifier
,
35 unsigned long what
, void *data
)
37 return mconsole_unlink_socket();
41 static struct notifier_block reboot_notifier
= {
42 .notifier_call
= do_unlink_socket
,
46 /* Safe without explicit locking for now. Tasklets provide their own
47 * locking, and the interrupt handler is safe because it can't interrupt
48 * itself and it can only happen on CPU 0.
51 static LIST_HEAD(mc_requests
);
53 static void mc_work_proc(struct work_struct
*unused
)
55 struct mconsole_entry
*req
;
58 while (!list_empty(&mc_requests
)) {
59 local_irq_save(flags
);
60 req
= list_entry(mc_requests
.next
, struct mconsole_entry
, list
);
62 local_irq_restore(flags
);
63 req
->request
.cmd
->handler(&req
->request
);
68 static DECLARE_WORK(mconsole_work
, mc_work_proc
);
70 static irqreturn_t
mconsole_interrupt(int irq
, void *dev_id
)
72 /* long to avoid size mismatch warnings from gcc */
74 struct mconsole_entry
*new;
75 static struct mc_request req
; /* that's OK */
78 while (mconsole_get_request(fd
, &req
)) {
79 if (req
.cmd
->context
== MCONSOLE_INTR
)
80 (*req
.cmd
->handler
)(&req
);
82 new = kmalloc(sizeof(*new), GFP_NOWAIT
);
84 mconsole_reply(&req
, "Out of memory", 1, 0);
87 new->request
.regs
= get_irq_regs()->regs
;
88 list_add(&new->list
, &mc_requests
);
92 if (!list_empty(&mc_requests
))
93 schedule_work(&mconsole_work
);
94 reactivate_fd(fd
, MCONSOLE_IRQ
);
98 void mconsole_version(struct mc_request
*req
)
102 sprintf(version
, "%s %s %s %s %s", utsname()->sysname
,
103 utsname()->nodename
, utsname()->release
, utsname()->version
,
105 mconsole_reply(req
, version
, 0, 0);
108 void mconsole_log(struct mc_request
*req
)
111 char *ptr
= req
->request
.data
;
113 ptr
+= strlen("log ");
115 len
= req
->len
- (ptr
- req
->request
.data
);
116 printk(KERN_WARNING
"%.*s", len
, ptr
);
117 mconsole_reply(req
, "", 0, 0);
120 /* This is a more convoluted version of mconsole_proc, which has some stability
121 * problems; however, we need it fixed, because it is expected that UML users
122 * mount HPPFS instead of procfs on /proc. And we want mconsole_proc to still
123 * show the real procfs content, not the ones from hppfs.*/
125 void mconsole_proc(struct mc_request
*req
)
127 struct vfsmount
*mnt
= current
->nsproxy
->pid_ns
->proc_mnt
;
130 char *ptr
= req
->request
.data
, *buf
;
131 mm_segment_t old_fs
= get_fs();
133 ptr
+= strlen("proc");
134 ptr
= skip_spaces(ptr
);
136 file
= file_open_root(mnt
->mnt_root
, mnt
, ptr
, O_RDONLY
);
138 mconsole_reply(req
, "Failed to open file", 1, 0);
142 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
144 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
148 if (file
->f_op
->read
) {
152 n
= vfs_read(file
, buf
, PAGE_SIZE
- 1, &pos
);
153 file_pos_write(file
, pos
);
157 mconsole_reply(req
, buf
, 0, (n
> 0));
160 mconsole_reply(req
, "Read of file failed",
166 else mconsole_reply(req
, "", 0, 0);
176 void mconsole_proc(struct mc_request
*req
)
183 char *ptr
= req
->request
.data
;
185 ptr
+= strlen("proc");
186 ptr
= skip_spaces(ptr
);
187 snprintf(path
, sizeof(path
), "/proc/%s", ptr
);
189 fd
= sys_open(path
, 0, 0);
191 mconsole_reply(req
, "Failed to open file", 1, 0);
192 printk(KERN_ERR
"open %s: %d\n",path
,fd
);
196 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
198 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
203 len
= sys_read(fd
, buf
, PAGE_SIZE
-1);
205 mconsole_reply(req
, "Read of file failed", 1, 0);
208 /* Begin the file content on his own line. */
210 mconsole_reply(req
, "\n", 0, 1);
213 if (len
== PAGE_SIZE
-1) {
215 mconsole_reply(req
, buf
, 0, 1);
218 mconsole_reply(req
, buf
, 0, 0);
231 #define UML_MCONSOLE_HELPTEXT \
233 version - Get kernel version \n\
234 help - Print this message \n\
236 reboot - Reboot UML \n\
237 config <dev>=<config> - Add a new device to UML; \n\
238 same syntax as command line \n\
239 config <dev> - Query the configuration of a device \n\
240 remove <dev> - Remove a device from UML \n\
241 sysrq <letter> - Performs the SysRq action controlled by the letter \n\
242 cad - invoke the Ctrl-Alt-Del handler \n\
243 stop - pause the UML; it will do nothing until it receives a 'go' \n\
244 go - continue the UML after a 'stop' \n\
245 log <string> - make UML enter <string> into the kernel log\n\
246 proc <file> - returns the contents of the UML's /proc/<file>\n\
247 stack <pid> - returns the stack of the specified pid\n\
250 void mconsole_help(struct mc_request
*req
)
252 mconsole_reply(req
, UML_MCONSOLE_HELPTEXT
, 0, 0);
255 void mconsole_halt(struct mc_request
*req
)
257 mconsole_reply(req
, "", 0, 0);
261 void mconsole_reboot(struct mc_request
*req
)
263 mconsole_reply(req
, "", 0, 0);
264 machine_restart(NULL
);
267 void mconsole_cad(struct mc_request
*req
)
269 mconsole_reply(req
, "", 0, 0);
273 void mconsole_go(struct mc_request
*req
)
275 mconsole_reply(req
, "Not stopped", 1, 0);
278 void mconsole_stop(struct mc_request
*req
)
280 deactivate_fd(req
->originating_fd
, MCONSOLE_IRQ
);
281 os_set_fd_block(req
->originating_fd
, 1);
282 mconsole_reply(req
, "stopped", 0, 0);
284 if (!mconsole_get_request(req
->originating_fd
, req
))
286 if (req
->cmd
->handler
== mconsole_go
)
288 if (req
->cmd
->handler
== mconsole_stop
) {
289 mconsole_reply(req
, "Already stopped", 1, 0);
292 if (req
->cmd
->handler
== mconsole_sysrq
) {
293 struct pt_regs
*old_regs
;
294 old_regs
= set_irq_regs((struct pt_regs
*)&req
->regs
);
296 set_irq_regs(old_regs
);
299 (*req
->cmd
->handler
)(req
);
301 os_set_fd_block(req
->originating_fd
, 0);
302 reactivate_fd(req
->originating_fd
, MCONSOLE_IRQ
);
303 mconsole_reply(req
, "", 0, 0);
306 static DEFINE_SPINLOCK(mc_devices_lock
);
307 static LIST_HEAD(mconsole_devices
);
309 void mconsole_register_dev(struct mc_device
*new)
311 spin_lock(&mc_devices_lock
);
312 BUG_ON(!list_empty(&new->list
));
313 list_add(&new->list
, &mconsole_devices
);
314 spin_unlock(&mc_devices_lock
);
317 static struct mc_device
*mconsole_find_dev(char *name
)
319 struct list_head
*ele
;
320 struct mc_device
*dev
;
322 list_for_each(ele
, &mconsole_devices
) {
323 dev
= list_entry(ele
, struct mc_device
, list
);
324 if (!strncmp(name
, dev
->name
, strlen(dev
->name
)))
330 #define UNPLUGGED_PER_PAGE \
331 ((PAGE_SIZE - sizeof(struct list_head)) / sizeof(unsigned long))
333 struct unplugged_pages
{
334 struct list_head list
;
335 void *pages
[UNPLUGGED_PER_PAGE
];
338 static DEFINE_MUTEX(plug_mem_mutex
);
339 static unsigned long long unplugged_pages_count
= 0;
340 static LIST_HEAD(unplugged_pages
);
341 static int unplug_index
= UNPLUGGED_PER_PAGE
;
343 static int mem_config(char *str
, char **error_out
)
345 unsigned long long diff
;
346 int err
= -EINVAL
, i
, add
;
350 *error_out
= "Expected '=' after 'mem'";
357 else if (str
[0] == '+') {
361 *error_out
= "Expected increment to start with '-' or '+'";
366 diff
= memparse(str
, &ret
);
368 *error_out
= "Failed to parse memory increment";
374 mutex_lock(&plug_mem_mutex
);
375 for (i
= 0; i
< diff
; i
++) {
376 struct unplugged_pages
*unplugged
;
380 if (list_empty(&unplugged_pages
))
383 unplugged
= list_entry(unplugged_pages
.next
,
384 struct unplugged_pages
, list
);
385 if (unplug_index
> 0)
386 addr
= unplugged
->pages
[--unplug_index
];
388 list_del(&unplugged
->list
);
390 unplug_index
= UNPLUGGED_PER_PAGE
;
393 free_page((unsigned long) addr
);
394 unplugged_pages_count
--;
399 page
= alloc_page(GFP_ATOMIC
);
403 unplugged
= page_address(page
);
404 if (unplug_index
== UNPLUGGED_PER_PAGE
) {
405 list_add(&unplugged
->list
, &unplugged_pages
);
409 struct list_head
*entry
= unplugged_pages
.next
;
412 unplugged
= list_entry(entry
,
413 struct unplugged_pages
,
415 err
= os_drop_memory(addr
, PAGE_SIZE
);
417 printk(KERN_ERR
"Failed to release "
418 "memory - errno = %d\n", err
);
419 *error_out
= "Failed to release memory";
422 unplugged
->pages
[unplug_index
++] = addr
;
425 unplugged_pages_count
++;
431 mutex_unlock(&plug_mem_mutex
);
436 static int mem_get_config(char *name
, char *str
, int size
, char **error_out
)
438 char buf
[sizeof("18446744073709551615")];
441 sprintf(buf
, "%ld", uml_physmem
);
442 CONFIG_CHUNK(str
, size
, len
, buf
, 1);
447 static int mem_id(char **str
, int *start_out
, int *end_out
)
455 static int mem_remove(int n
, char **error_out
)
457 *error_out
= "Memory doesn't support the remove operation";
461 static struct mc_device mem_mc
= {
462 .list
= LIST_HEAD_INIT(mem_mc
.list
),
464 .config
= mem_config
,
465 .get_config
= mem_get_config
,
467 .remove
= mem_remove
,
470 static int __init
mem_mc_init(void)
472 if (can_drop_memory())
473 mconsole_register_dev(&mem_mc
);
474 else printk(KERN_ERR
"Can't release memory to the host - memory "
475 "hotplug won't be supported\n");
479 __initcall(mem_mc_init
);
481 #define CONFIG_BUF_SIZE 64
483 static void mconsole_get_config(int (*get_config
)(char *, char *, int,
485 struct mc_request
*req
, char *name
)
487 char default_buf
[CONFIG_BUF_SIZE
], *error
, *buf
;
490 if (get_config
== NULL
) {
491 mconsole_reply(req
, "No get_config routine defined", 1, 0);
496 size
= ARRAY_SIZE(default_buf
);
500 n
= (*get_config
)(name
, buf
, size
, &error
);
502 mconsole_reply(req
, error
, 1, 0);
507 mconsole_reply(req
, buf
, 0, 0);
511 if (buf
!= default_buf
)
515 buf
= kmalloc(size
, GFP_KERNEL
);
517 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
522 if (buf
!= default_buf
)
526 void mconsole_config(struct mc_request
*req
)
528 struct mc_device
*dev
;
529 char *ptr
= req
->request
.data
, *name
, *error_string
= "";
532 ptr
+= strlen("config");
533 ptr
= skip_spaces(ptr
);
534 dev
= mconsole_find_dev(ptr
);
536 mconsole_reply(req
, "Bad configuration option", 1, 0);
540 name
= &ptr
[strlen(dev
->name
)];
542 while ((*ptr
!= '=') && (*ptr
!= '\0'))
546 err
= (*dev
->config
)(name
, &error_string
);
547 mconsole_reply(req
, error_string
, err
, 0);
549 else mconsole_get_config(dev
->get_config
, req
, name
);
552 void mconsole_remove(struct mc_request
*req
)
554 struct mc_device
*dev
;
555 char *ptr
= req
->request
.data
, *err_msg
= "";
557 int err
, start
, end
, n
;
559 ptr
+= strlen("remove");
560 ptr
= skip_spaces(ptr
);
561 dev
= mconsole_find_dev(ptr
);
563 mconsole_reply(req
, "Bad remove option", 1, 0);
567 ptr
= &ptr
[strlen(dev
->name
)];
570 n
= (*dev
->id
)(&ptr
, &start
, &end
);
572 err_msg
= "Couldn't parse device number";
575 else if ((n
< start
) || (n
> end
)) {
576 sprintf(error
, "Invalid device number - must be between "
577 "%d and %d", start
, end
);
583 err
= (*dev
->remove
)(n
, &err_msg
);
590 err_msg
= "Device doesn't exist";
594 err_msg
= "Device is currently open";
600 mconsole_reply(req
, err_msg
, err
, 0);
603 struct mconsole_output
{
604 struct list_head list
;
605 struct mc_request
*req
;
608 static DEFINE_SPINLOCK(client_lock
);
609 static LIST_HEAD(clients
);
610 static char console_buf
[MCONSOLE_MAX_DATA
];
612 static void console_write(struct console
*console
, const char *string
,
615 struct list_head
*ele
;
618 if (list_empty(&clients
))
622 n
= min((size_t) len
, ARRAY_SIZE(console_buf
));
623 strncpy(console_buf
, string
, n
);
627 list_for_each(ele
, &clients
) {
628 struct mconsole_output
*entry
;
630 entry
= list_entry(ele
, struct mconsole_output
, list
);
631 mconsole_reply_len(entry
->req
, console_buf
, n
, 0, 1);
636 static struct console mc_console
= { .name
= "mc",
637 .write
= console_write
,
638 .flags
= CON_ENABLED
,
641 static int mc_add_console(void)
643 register_console(&mc_console
);
647 late_initcall(mc_add_console
);
649 static void with_console(struct mc_request
*req
, void (*proc
)(void *),
652 struct mconsole_output entry
;
656 spin_lock_irqsave(&client_lock
, flags
);
657 list_add(&entry
.list
, &clients
);
658 spin_unlock_irqrestore(&client_lock
, flags
);
662 mconsole_reply_len(req
, "", 0, 0, 0);
664 spin_lock_irqsave(&client_lock
, flags
);
665 list_del(&entry
.list
);
666 spin_unlock_irqrestore(&client_lock
, flags
);
669 #ifdef CONFIG_MAGIC_SYSRQ
671 #include <linux/sysrq.h>
673 static void sysrq_proc(void *arg
)
679 void mconsole_sysrq(struct mc_request
*req
)
681 char *ptr
= req
->request
.data
;
683 ptr
+= strlen("sysrq");
684 ptr
= skip_spaces(ptr
);
687 * With 'b', the system will shut down without a chance to reply,
688 * so in this case, we reply first.
691 mconsole_reply(req
, "", 0, 0);
693 with_console(req
, sysrq_proc
, ptr
);
696 void mconsole_sysrq(struct mc_request
*req
)
698 mconsole_reply(req
, "Sysrq not compiled in", 1, 0);
702 static void stack_proc(void *arg
)
704 struct task_struct
*from
= current
, *to
= arg
;
706 to
->thread
.saved_task
= from
;
707 switch_to(from
, to
, from
);
711 * Mconsole stack trace
712 * Added by Allan Graves, Jeff Dike
713 * Dumps a stacks registers to the linux console.
716 void mconsole_stack(struct mc_request
*req
)
718 char *ptr
= req
->request
.data
;
719 int pid_requested
= -1;
720 struct task_struct
*to
= NULL
;
724 * 1) Send showregs output to mconsole.
725 * 2) Add a way to stack dump all pids.
728 ptr
+= strlen("stack");
729 ptr
= skip_spaces(ptr
);
732 * Should really check for multiple pids or reject bad args here
734 /* What do the arguments in mconsole_reply mean? */
735 if (sscanf(ptr
, "%d", &pid_requested
) == 0) {
736 mconsole_reply(req
, "Please specify a pid", 1, 0);
740 to
= find_task_by_pid_ns(pid_requested
, &init_pid_ns
);
741 if ((to
== NULL
) || (pid_requested
== 0)) {
742 mconsole_reply(req
, "Couldn't find that pid", 1, 0);
745 with_console(req
, stack_proc
, to
);
749 * Changed by mconsole_setup, which is __setup, and called before SMP is
752 static char *notify_socket
= NULL
;
754 static int __init
mconsole_init(void)
756 /* long to avoid size mismatch warnings from gcc */
759 char file
[UNIX_PATH_MAX
];
761 if (umid_file_name("mconsole", file
, sizeof(file
)))
763 snprintf(mconsole_socket_name
, sizeof(file
), "%s", file
);
765 sock
= os_create_unix_socket(file
, sizeof(file
), 1);
767 printk(KERN_ERR
"Failed to initialize management console\n");
770 if (os_set_fd_block(sock
, 0))
773 register_reboot_notifier(&reboot_notifier
);
775 err
= um_request_irq(MCONSOLE_IRQ
, sock
, IRQ_READ
, mconsole_interrupt
,
776 IRQF_DISABLED
| IRQF_SHARED
| IRQF_SAMPLE_RANDOM
,
777 "mconsole", (void *)sock
);
779 printk(KERN_ERR
"Failed to get IRQ for management console\n");
783 if (notify_socket
!= NULL
) {
784 notify_socket
= kstrdup(notify_socket
, GFP_KERNEL
);
785 if (notify_socket
!= NULL
)
786 mconsole_notify(notify_socket
, MCONSOLE_SOCKET
,
787 mconsole_socket_name
,
788 strlen(mconsole_socket_name
) + 1);
789 else printk(KERN_ERR
"mconsole_setup failed to strdup "
793 printk(KERN_INFO
"mconsole (version %d) initialized on %s\n",
794 MCONSOLE_VERSION
, mconsole_socket_name
);
802 __initcall(mconsole_init
);
804 static ssize_t
mconsole_proc_write(struct file
*file
,
805 const char __user
*buffer
, size_t count
, loff_t
*pos
)
809 buf
= kmalloc(count
+ 1, GFP_KERNEL
);
813 if (copy_from_user(buf
, buffer
, count
)) {
820 mconsole_notify(notify_socket
, MCONSOLE_USER_NOTIFY
, buf
, count
);
826 static const struct file_operations mconsole_proc_fops
= {
827 .owner
= THIS_MODULE
,
828 .write
= mconsole_proc_write
,
829 .llseek
= noop_llseek
,
832 static int create_proc_mconsole(void)
834 struct proc_dir_entry
*ent
;
836 if (notify_socket
== NULL
)
839 ent
= proc_create("mconsole", 0200, NULL
, &mconsole_proc_fops
);
841 printk(KERN_INFO
"create_proc_mconsole : create_proc_entry "
848 static DEFINE_SPINLOCK(notify_spinlock
);
850 void lock_notify(void)
852 spin_lock(¬ify_spinlock
);
855 void unlock_notify(void)
857 spin_unlock(¬ify_spinlock
);
860 __initcall(create_proc_mconsole
);
862 #define NOTIFY "notify:"
864 static int mconsole_setup(char *str
)
866 if (!strncmp(str
, NOTIFY
, strlen(NOTIFY
))) {
867 str
+= strlen(NOTIFY
);
870 else printk(KERN_ERR
"mconsole_setup : Unknown option - '%s'\n", str
);
874 __setup("mconsole=", mconsole_setup
);
876 __uml_help(mconsole_setup
,
877 "mconsole=notify:<socket>\n"
878 " Requests that the mconsole driver send a message to the named Unix\n"
879 " socket containing the name of the mconsole socket. This also serves\n"
880 " to notify outside processes when UML has booted far enough to respond\n"
881 " to mconsole requests.\n\n"
884 static int notify_panic(struct notifier_block
*self
, unsigned long unused1
,
889 if (notify_socket
== NULL
)
892 mconsole_notify(notify_socket
, MCONSOLE_PANIC
, message
,
893 strlen(message
) + 1);
897 static struct notifier_block panic_exit_notifier
= {
898 .notifier_call
= notify_panic
,
903 static int add_notifier(void)
905 atomic_notifier_chain_register(&panic_notifier_list
,
906 &panic_exit_notifier
);
910 __initcall(add_notifier
);
912 char *mconsole_notify_socket(void)
914 return notify_socket
;
917 EXPORT_SYMBOL(mconsole_notify_socket
);