2 * Copyright (C) 2001 Lennert Buytenhek (buytenh@gnu.org)
3 * Copyright (C) 2001 - 2003 Jeff Dike (jdike@addtoit.com)
4 * Licensed under the GPL
7 #include "linux/kernel.h"
8 #include "linux/slab.h"
9 #include "linux/init.h"
10 #include "linux/notifier.h"
11 #include "linux/reboot.h"
12 #include "linux/utsname.h"
13 #include "linux/ctype.h"
14 #include "linux/interrupt.h"
15 #include "linux/sysrq.h"
16 #include "linux/workqueue.h"
17 #include "linux/module.h"
18 #include "linux/file.h"
20 #include "linux/namei.h"
21 #include "linux/proc_fs.h"
22 #include "linux/syscalls.h"
23 #include "linux/list.h"
25 #include "linux/console.h"
27 #include "asm/uaccess.h"
28 #include "user_util.h"
29 #include "kern_util.h"
32 #include "mconsole_kern.h"
37 #include "choose-mode.h"
39 static int do_unlink_socket(struct notifier_block *notifier,
40 unsigned long what, void *data)
42 return(mconsole_unlink_socket());
46 static struct notifier_block reboot_notifier = {
47 .notifier_call = do_unlink_socket,
51 /* Safe without explicit locking for now. Tasklets provide their own
52 * locking, and the interrupt handler is safe because it can't interrupt
53 * itself and it can only happen on CPU 0.
56 static LIST_HEAD(mc_requests);
58 static void mc_work_proc(struct work_struct *unused)
60 struct mconsole_entry *req;
63 while(!list_empty(&mc_requests)){
64 local_irq_save(flags);
65 req = list_entry(mc_requests.next, struct mconsole_entry,
68 local_irq_restore(flags);
69 req->request.cmd->handler(&req->request);
74 static DECLARE_WORK(mconsole_work, mc_work_proc);
76 static irqreturn_t mconsole_interrupt(int irq, void *dev_id)
78 /* long to avoid size mismatch warnings from gcc */
80 struct mconsole_entry *new;
81 static struct mc_request req; /* that's OK */
84 while (mconsole_get_request(fd, &req)){
85 if(req.cmd->context == MCONSOLE_INTR)
86 (*req.cmd->handler)(&req);
88 new = kmalloc(sizeof(*new), GFP_NOWAIT);
90 mconsole_reply(&req, "Out of memory", 1, 0);
93 new->request.regs = get_irq_regs()->regs;
94 list_add(&new->list, &mc_requests);
98 if(!list_empty(&mc_requests))
99 schedule_work(&mconsole_work);
100 reactivate_fd(fd, MCONSOLE_IRQ);
104 void mconsole_version(struct mc_request *req)
108 sprintf(version, "%s %s %s %s %s", utsname()->sysname,
109 utsname()->nodename, utsname()->release,
110 utsname()->version, utsname()->machine);
111 mconsole_reply(req, version, 0, 0);
114 void mconsole_log(struct mc_request *req)
117 char *ptr = req->request.data;
119 ptr += strlen("log ");
121 len = req->len - (ptr - req->request.data);
122 printk("%.*s", len, ptr);
123 mconsole_reply(req, "", 0, 0);
126 /* This is a more convoluted version of mconsole_proc, which has some stability
127 * problems; however, we need it fixed, because it is expected that UML users
128 * mount HPPFS instead of procfs on /proc. And we want mconsole_proc to still
129 * show the real procfs content, not the ones from hppfs.*/
131 void mconsole_proc(struct mc_request *req)
134 struct file_system_type *proc;
135 struct super_block *super;
138 char *ptr = req->request.data, *buf;
140 ptr += strlen("proc");
141 while(isspace(*ptr)) ptr++;
143 proc = get_fs_type("proc");
145 mconsole_reply(req, "procfs not registered", 1, 0);
149 super = (*proc->get_sb)(proc, 0, NULL, NULL);
150 put_filesystem(proc);
152 mconsole_reply(req, "Failed to get procfs superblock", 1, 0);
155 up_write(&super->s_umount);
157 nd.dentry = super->s_root;
159 nd.flags = O_RDONLY + 1;
160 nd.last_type = LAST_ROOT;
162 /* START: it was experienced that the stability problems are closed
163 * if commenting out these two calls + the below read cycle. To
164 * make UML crash again, it was enough to readd either one.*/
165 err = link_path_walk(ptr, &nd);
167 mconsole_reply(req, "Failed to look up file", 1, 0);
171 file = dentry_open(nd.dentry, nd.mnt, O_RDONLY);
173 mconsole_reply(req, "Failed to open file", 1, 0);
178 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
180 mconsole_reply(req, "Failed to allocate buffer", 1, 0);
184 if((file->f_op != NULL) && (file->f_op->read != NULL)){
186 n = (*file->f_op->read)(file, buf, PAGE_SIZE - 1,
190 mconsole_reply(req, buf, 0, (n > 0));
193 mconsole_reply(req, "Read of file failed",
199 else mconsole_reply(req, "", 0, 0);
206 deactivate_super(super);
211 void mconsole_proc(struct mc_request *req)
218 char *ptr = req->request.data;
220 ptr += strlen("proc");
221 while(isspace(*ptr)) ptr++;
222 snprintf(path, sizeof(path), "/proc/%s", ptr);
224 fd = sys_open(path, 0, 0);
226 mconsole_reply(req, "Failed to open file", 1, 0);
227 printk("open %s: %d\n",path,fd);
231 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
233 mconsole_reply(req, "Failed to allocate buffer", 1, 0);
238 len = sys_read(fd, buf, PAGE_SIZE-1);
240 mconsole_reply(req, "Read of file failed", 1, 0);
243 /*Begin the file content on his own line.*/
245 mconsole_reply(req, "\n", 0, 1);
248 if (len == PAGE_SIZE-1) {
250 mconsole_reply(req, buf, 0, 1);
253 mconsole_reply(req, buf, 0, 0);
266 #define UML_MCONSOLE_HELPTEXT \
268 version - Get kernel version \n\
269 help - Print this message \n\
271 reboot - Reboot UML \n\
272 config <dev>=<config> - Add a new device to UML; \n\
273 same syntax as command line \n\
274 config <dev> - Query the configuration of a device \n\
275 remove <dev> - Remove a device from UML \n\
276 sysrq <letter> - Performs the SysRq action controlled by the letter \n\
277 cad - invoke the Ctrl-Alt-Del handler \n\
278 stop - pause the UML; it will do nothing until it receives a 'go' \n\
279 go - continue the UML after a 'stop' \n\
280 log <string> - make UML enter <string> into the kernel log\n\
281 proc <file> - returns the contents of the UML's /proc/<file>\n\
282 stack <pid> - returns the stack of the specified pid\n\
285 void mconsole_help(struct mc_request *req)
287 mconsole_reply(req, UML_MCONSOLE_HELPTEXT, 0, 0);
290 void mconsole_halt(struct mc_request *req)
292 mconsole_reply(req, "", 0, 0);
296 void mconsole_reboot(struct mc_request *req)
298 mconsole_reply(req, "", 0, 0);
299 machine_restart(NULL);
302 void mconsole_cad(struct mc_request *req)
304 mconsole_reply(req, "", 0, 0);
308 void mconsole_go(struct mc_request *req)
310 mconsole_reply(req, "Not stopped", 1, 0);
313 void mconsole_stop(struct mc_request *req)
315 deactivate_fd(req->originating_fd, MCONSOLE_IRQ);
316 os_set_fd_block(req->originating_fd, 1);
317 mconsole_reply(req, "stopped", 0, 0);
318 while (mconsole_get_request(req->originating_fd, req)) {
319 if (req->cmd->handler == mconsole_go)
321 if (req->cmd->handler == mconsole_stop) {
322 mconsole_reply(req, "Already stopped", 1, 0);
325 if (req->cmd->handler == mconsole_sysrq) {
326 struct pt_regs *old_regs;
327 old_regs = set_irq_regs((struct pt_regs *)&req->regs);
329 set_irq_regs(old_regs);
332 (*req->cmd->handler)(req);
334 os_set_fd_block(req->originating_fd, 0);
335 reactivate_fd(req->originating_fd, MCONSOLE_IRQ);
336 mconsole_reply(req, "", 0, 0);
339 static DEFINE_SPINLOCK(mc_devices_lock);
340 static LIST_HEAD(mconsole_devices);
342 void mconsole_register_dev(struct mc_device *new)
344 spin_lock(&mc_devices_lock);
345 BUG_ON(!list_empty(&new->list));
346 list_add(&new->list, &mconsole_devices);
347 spin_unlock(&mc_devices_lock);
350 static struct mc_device *mconsole_find_dev(char *name)
352 struct list_head *ele;
353 struct mc_device *dev;
355 list_for_each(ele, &mconsole_devices){
356 dev = list_entry(ele, struct mc_device, list);
357 if(!strncmp(name, dev->name, strlen(dev->name)))
363 #define UNPLUGGED_PER_PAGE \
364 ((PAGE_SIZE - sizeof(struct list_head)) / sizeof(unsigned long))
366 struct unplugged_pages {
367 struct list_head list;
368 void *pages[UNPLUGGED_PER_PAGE];
371 static DECLARE_MUTEX(plug_mem_mutex);
372 static unsigned long long unplugged_pages_count = 0;
373 static LIST_HEAD(unplugged_pages);
374 static int unplug_index = UNPLUGGED_PER_PAGE;
376 static int mem_config(char *str, char **error_out)
378 unsigned long long diff;
379 int err = -EINVAL, i, add;
383 *error_out = "Expected '=' after 'mem'";
390 else if(str[0] == '+'){
394 *error_out = "Expected increment to start with '-' or '+'";
399 diff = memparse(str, &ret);
401 *error_out = "Failed to parse memory increment";
407 down(&plug_mem_mutex);
408 for(i = 0; i < diff; i++){
409 struct unplugged_pages *unplugged;
413 if(list_empty(&unplugged_pages))
416 unplugged = list_entry(unplugged_pages.next,
417 struct unplugged_pages, list);
419 addr = unplugged->pages[--unplug_index];
421 list_del(&unplugged->list);
423 unplug_index = UNPLUGGED_PER_PAGE;
426 free_page((unsigned long) addr);
427 unplugged_pages_count--;
432 page = alloc_page(GFP_ATOMIC);
436 unplugged = page_address(page);
437 if(unplug_index == UNPLUGGED_PER_PAGE){
438 list_add(&unplugged->list, &unplugged_pages);
442 struct list_head *entry = unplugged_pages.next;
445 unplugged = list_entry(entry,
446 struct unplugged_pages,
448 err = os_drop_memory(addr, PAGE_SIZE);
450 printk("Failed to release memory - "
451 "errno = %d\n", err);
452 *error_out = "Failed to release memory";
455 unplugged->pages[unplug_index++] = addr;
458 unplugged_pages_count++;
469 static int mem_get_config(char *name, char *str, int size, char **error_out)
471 char buf[sizeof("18446744073709551615")];
474 sprintf(buf, "%ld", uml_physmem);
475 CONFIG_CHUNK(str, size, len, buf, 1);
480 static int mem_id(char **str, int *start_out, int *end_out)
488 static int mem_remove(int n, char **error_out)
490 *error_out = "Memory doesn't support the remove operation";
494 static struct mc_device mem_mc = {
495 .list = LIST_HEAD_INIT(mem_mc.list),
497 .config = mem_config,
498 .get_config = mem_get_config,
500 .remove = mem_remove,
503 static int mem_mc_init(void)
505 if(can_drop_memory())
506 mconsole_register_dev(&mem_mc);
507 else printk("Can't release memory to the host - memory hotplug won't "
512 __initcall(mem_mc_init);
514 #define CONFIG_BUF_SIZE 64
516 static void mconsole_get_config(int (*get_config)(char *, char *, int,
518 struct mc_request *req, char *name)
520 char default_buf[CONFIG_BUF_SIZE], *error, *buf;
523 if(get_config == NULL){
524 mconsole_reply(req, "No get_config routine defined", 1, 0);
529 size = ARRAY_SIZE(default_buf);
533 n = (*get_config)(name, buf, size, &error);
535 mconsole_reply(req, error, 1, 0);
540 mconsole_reply(req, buf, 0, 0);
544 if(buf != default_buf)
548 buf = kmalloc(size, GFP_KERNEL);
550 mconsole_reply(req, "Failed to allocate buffer", 1, 0);
555 if(buf != default_buf)
559 void mconsole_config(struct mc_request *req)
561 struct mc_device *dev;
562 char *ptr = req->request.data, *name, *error_string = "";
565 ptr += strlen("config");
566 while(isspace(*ptr)) ptr++;
567 dev = mconsole_find_dev(ptr);
569 mconsole_reply(req, "Bad configuration option", 1, 0);
573 name = &ptr[strlen(dev->name)];
575 while((*ptr != '=') && (*ptr != '\0'))
579 err = (*dev->config)(name, &error_string);
580 mconsole_reply(req, error_string, err, 0);
582 else mconsole_get_config(dev->get_config, req, name);
585 void mconsole_remove(struct mc_request *req)
587 struct mc_device *dev;
588 char *ptr = req->request.data, *err_msg = "";
590 int err, start, end, n;
592 ptr += strlen("remove");
593 while(isspace(*ptr)) ptr++;
594 dev = mconsole_find_dev(ptr);
596 mconsole_reply(req, "Bad remove option", 1, 0);
600 ptr = &ptr[strlen(dev->name)];
603 n = (*dev->id)(&ptr, &start, &end);
605 err_msg = "Couldn't parse device number";
608 else if((n < start) || (n > end)){
609 sprintf(error, "Invalid device number - must be between "
610 "%d and %d", start, end);
616 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];
641 static int console_index = 0;
643 static void console_write(struct console *console, const char *string,
646 struct list_head *ele;
649 if(list_empty(&clients))
653 n = min((size_t) len, ARRAY_SIZE(console_buf) - console_index);
654 strncpy(&console_buf[console_index], string, n);
661 list_for_each(ele, &clients){
662 struct mconsole_output *entry;
664 entry = list_entry(ele, struct mconsole_output, list);
665 mconsole_reply_len(entry->req, console_buf,
666 console_index, 0, 1);
673 static struct console mc_console = { .name = "mc",
674 .write = console_write,
675 .flags = CON_ENABLED,
678 static int mc_add_console(void)
680 register_console(&mc_console);
684 late_initcall(mc_add_console);
686 static void with_console(struct mc_request *req, void (*proc)(void *),
689 struct mconsole_output entry;
693 spin_lock_irqsave(&client_lock, flags);
694 list_add(&entry.list, &clients);
695 spin_unlock_irqrestore(&client_lock, flags);
699 mconsole_reply_len(req, console_buf, console_index, 0, 0);
702 spin_lock_irqsave(&client_lock, flags);
703 list_del(&entry.list);
704 spin_unlock_irqrestore(&client_lock, flags);
707 #ifdef CONFIG_MAGIC_SYSRQ
708 static void sysrq_proc(void *arg)
711 handle_sysrq(*op, NULL);
714 void mconsole_sysrq(struct mc_request *req)
716 char *ptr = req->request.data;
718 ptr += strlen("sysrq");
719 while(isspace(*ptr)) ptr++;
721 /* With 'b', the system will shut down without a chance to reply,
722 * so in this case, we reply first.
725 mconsole_reply(req, "", 0, 0);
727 with_console(req, sysrq_proc, ptr);
730 void mconsole_sysrq(struct mc_request *req)
732 mconsole_reply(req, "Sysrq not compiled in", 1, 0);
736 #ifdef CONFIG_MODE_SKAS
738 static void stack_proc(void *arg)
740 struct task_struct *from = current, *to = arg;
742 to->thread.saved_task = from;
743 switch_to(from, to, from);
746 /* Mconsole stack trace
747 * Added by Allan Graves, Jeff Dike
748 * Dumps a stacks registers to the linux console.
751 static void do_stack_trace(struct mc_request *req)
753 char *ptr = req->request.data;
754 int pid_requested= -1;
755 struct task_struct *from = NULL;
756 struct task_struct *to = NULL;
759 * 1) Send showregs output to mconsole.
760 * 2) Add a way to stack dump all pids.
763 ptr += strlen("stack");
764 while(isspace(*ptr)) ptr++;
766 /* Should really check for multiple pids or reject bad args here */
767 /* What do the arguments in mconsole_reply mean? */
768 if(sscanf(ptr, "%d", &pid_requested) == 0){
769 mconsole_reply(req, "Please specify a pid", 1, 0);
775 to = find_task_by_pid(pid_requested);
776 if((to == NULL) || (pid_requested == 0)) {
777 mconsole_reply(req, "Couldn't find that pid", 1, 0);
780 with_console(req, stack_proc, to);
782 #endif /* CONFIG_MODE_SKAS */
784 void mconsole_stack(struct mc_request *req)
786 /* This command doesn't work in TT mode, so let's check and then
789 CHOOSE_MODE(mconsole_reply(req, "Sorry, this doesn't work in TT mode",
791 do_stack_trace(req));
794 /* Changed by mconsole_setup, which is __setup, and called before SMP is
797 static char *notify_socket = NULL;
799 static int mconsole_init(void)
801 /* long to avoid size mismatch warnings from gcc */
806 if(umid_file_name("mconsole", file, sizeof(file))) return(-1);
807 snprintf(mconsole_socket_name, sizeof(file), "%s", file);
809 sock = os_create_unix_socket(file, sizeof(file), 1);
811 printk("Failed to initialize management console\n");
815 register_reboot_notifier(&reboot_notifier);
817 err = um_request_irq(MCONSOLE_IRQ, sock, IRQ_READ, mconsole_interrupt,
818 IRQF_DISABLED | IRQF_SHARED | IRQF_SAMPLE_RANDOM,
819 "mconsole", (void *)sock);
821 printk("Failed to get IRQ for management console\n");
825 if(notify_socket != NULL){
826 notify_socket = kstrdup(notify_socket, GFP_KERNEL);
827 if(notify_socket != NULL)
828 mconsole_notify(notify_socket, MCONSOLE_SOCKET,
829 mconsole_socket_name,
830 strlen(mconsole_socket_name) + 1);
831 else printk(KERN_ERR "mconsole_setup failed to strdup "
835 printk("mconsole (version %d) initialized on %s\n",
836 MCONSOLE_VERSION, mconsole_socket_name);
840 __initcall(mconsole_init);
842 static int write_proc_mconsole(struct file *file, const char __user *buffer,
843 unsigned long count, void *data)
847 buf = kmalloc(count + 1, GFP_KERNEL);
851 if(copy_from_user(buf, buffer, count)){
858 mconsole_notify(notify_socket, MCONSOLE_USER_NOTIFY, buf, count);
864 static int create_proc_mconsole(void)
866 struct proc_dir_entry *ent;
868 if(notify_socket == NULL) return(0);
870 ent = create_proc_entry("mconsole", S_IFREG | 0200, NULL);
872 printk(KERN_INFO "create_proc_mconsole : create_proc_entry failed\n");
876 ent->read_proc = NULL;
877 ent->write_proc = write_proc_mconsole;
881 static DEFINE_SPINLOCK(notify_spinlock);
883 void lock_notify(void)
885 spin_lock(¬ify_spinlock);
888 void unlock_notify(void)
890 spin_unlock(¬ify_spinlock);
893 __initcall(create_proc_mconsole);
895 #define NOTIFY "=notify:"
897 static int mconsole_setup(char *str)
899 if(!strncmp(str, NOTIFY, strlen(NOTIFY))){
900 str += strlen(NOTIFY);
903 else printk(KERN_ERR "mconsole_setup : Unknown option - '%s'\n", str);
907 __setup("mconsole", mconsole_setup);
909 __uml_help(mconsole_setup,
910 "mconsole=notify:<socket>\n"
911 " Requests that the mconsole driver send a message to the named Unix\n"
912 " socket containing the name of the mconsole socket. This also serves\n"
913 " to notify outside processes when UML has booted far enough to respond\n"
914 " to mconsole requests.\n\n"
917 static int notify_panic(struct notifier_block *self, unsigned long unused1,
922 if(notify_socket == NULL) return(0);
924 mconsole_notify(notify_socket, MCONSOLE_PANIC, message,
925 strlen(message) + 1);
929 static struct notifier_block panic_exit_notifier = {
930 .notifier_call = notify_panic,
935 static int add_notifier(void)
937 atomic_notifier_chain_register(&panic_notifier_list,
938 &panic_exit_notifier);
942 __initcall(add_notifier);
944 char *mconsole_notify_socket(void)
946 return(notify_socket);
949 EXPORT_SYMBOL(mconsole_notify_socket);