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 "kern_util.h"
31 #include "mconsole_kern.h"
36 #include "choose-mode.h"
38 static int do_unlink_socket(struct notifier_block *notifier,
39 unsigned long what, void *data)
41 return(mconsole_unlink_socket());
45 static struct notifier_block reboot_notifier = {
46 .notifier_call = do_unlink_socket,
50 /* Safe without explicit locking for now. Tasklets provide their own
51 * locking, and the interrupt handler is safe because it can't interrupt
52 * itself and it can only happen on CPU 0.
55 static LIST_HEAD(mc_requests);
57 static void mc_work_proc(struct work_struct *unused)
59 struct mconsole_entry *req;
62 while(!list_empty(&mc_requests)){
63 local_irq_save(flags);
64 req = list_entry(mc_requests.next, struct mconsole_entry,
67 local_irq_restore(flags);
68 req->request.cmd->handler(&req->request);
73 static DECLARE_WORK(mconsole_work, mc_work_proc);
75 static irqreturn_t mconsole_interrupt(int irq, void *dev_id)
77 /* long to avoid size mismatch warnings from gcc */
79 struct mconsole_entry *new;
80 static struct mc_request req; /* that's OK */
83 while (mconsole_get_request(fd, &req)){
84 if(req.cmd->context == MCONSOLE_INTR)
85 (*req.cmd->handler)(&req);
87 new = kmalloc(sizeof(*new), GFP_NOWAIT);
89 mconsole_reply(&req, "Out of memory", 1, 0);
92 new->request.regs = get_irq_regs()->regs;
93 list_add(&new->list, &mc_requests);
97 if(!list_empty(&mc_requests))
98 schedule_work(&mconsole_work);
99 reactivate_fd(fd, MCONSOLE_IRQ);
103 void mconsole_version(struct mc_request *req)
107 sprintf(version, "%s %s %s %s %s", utsname()->sysname,
108 utsname()->nodename, utsname()->release,
109 utsname()->version, utsname()->machine);
110 mconsole_reply(req, version, 0, 0);
113 void mconsole_log(struct mc_request *req)
116 char *ptr = req->request.data;
118 ptr += strlen("log ");
120 len = req->len - (ptr - req->request.data);
121 printk("%.*s", len, ptr);
122 mconsole_reply(req, "", 0, 0);
125 /* This is a more convoluted version of mconsole_proc, which has some stability
126 * problems; however, we need it fixed, because it is expected that UML users
127 * mount HPPFS instead of procfs on /proc. And we want mconsole_proc to still
128 * show the real procfs content, not the ones from hppfs.*/
130 void mconsole_proc(struct mc_request *req)
133 struct file_system_type *proc;
134 struct super_block *super;
137 char *ptr = req->request.data, *buf;
139 ptr += strlen("proc");
140 while(isspace(*ptr)) ptr++;
142 proc = get_fs_type("proc");
144 mconsole_reply(req, "procfs not registered", 1, 0);
148 super = (*proc->get_sb)(proc, 0, NULL, NULL);
149 put_filesystem(proc);
151 mconsole_reply(req, "Failed to get procfs superblock", 1, 0);
154 up_write(&super->s_umount);
156 nd.dentry = super->s_root;
158 nd.flags = O_RDONLY + 1;
159 nd.last_type = LAST_ROOT;
161 /* START: it was experienced that the stability problems are closed
162 * if commenting out these two calls + the below read cycle. To
163 * make UML crash again, it was enough to readd either one.*/
164 err = link_path_walk(ptr, &nd);
166 mconsole_reply(req, "Failed to look up file", 1, 0);
170 file = dentry_open(nd.dentry, nd.mnt, O_RDONLY);
172 mconsole_reply(req, "Failed to open file", 1, 0);
177 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
179 mconsole_reply(req, "Failed to allocate buffer", 1, 0);
183 if((file->f_op != NULL) && (file->f_op->read != NULL)){
185 n = (*file->f_op->read)(file, buf, PAGE_SIZE - 1,
189 mconsole_reply(req, buf, 0, (n > 0));
192 mconsole_reply(req, "Read of file failed",
198 else mconsole_reply(req, "", 0, 0);
205 deactivate_super(super);
210 void mconsole_proc(struct mc_request *req)
217 char *ptr = req->request.data;
219 ptr += strlen("proc");
220 while(isspace(*ptr)) ptr++;
221 snprintf(path, sizeof(path), "/proc/%s", ptr);
223 fd = sys_open(path, 0, 0);
225 mconsole_reply(req, "Failed to open file", 1, 0);
226 printk("open %s: %d\n",path,fd);
230 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
232 mconsole_reply(req, "Failed to allocate buffer", 1, 0);
237 len = sys_read(fd, buf, PAGE_SIZE-1);
239 mconsole_reply(req, "Read of file failed", 1, 0);
242 /*Begin the file content on his own line.*/
244 mconsole_reply(req, "\n", 0, 1);
247 if (len == PAGE_SIZE-1) {
249 mconsole_reply(req, buf, 0, 1);
252 mconsole_reply(req, buf, 0, 0);
265 #define UML_MCONSOLE_HELPTEXT \
267 version - Get kernel version \n\
268 help - Print this message \n\
270 reboot - Reboot UML \n\
271 config <dev>=<config> - Add a new device to UML; \n\
272 same syntax as command line \n\
273 config <dev> - Query the configuration of a device \n\
274 remove <dev> - Remove a device from UML \n\
275 sysrq <letter> - Performs the SysRq action controlled by the letter \n\
276 cad - invoke the Ctrl-Alt-Del handler \n\
277 stop - pause the UML; it will do nothing until it receives a 'go' \n\
278 go - continue the UML after a 'stop' \n\
279 log <string> - make UML enter <string> into the kernel log\n\
280 proc <file> - returns the contents of the UML's /proc/<file>\n\
281 stack <pid> - returns the stack of the specified pid\n\
284 void mconsole_help(struct mc_request *req)
286 mconsole_reply(req, UML_MCONSOLE_HELPTEXT, 0, 0);
289 void mconsole_halt(struct mc_request *req)
291 mconsole_reply(req, "", 0, 0);
295 void mconsole_reboot(struct mc_request *req)
297 mconsole_reply(req, "", 0, 0);
298 machine_restart(NULL);
301 void mconsole_cad(struct mc_request *req)
303 mconsole_reply(req, "", 0, 0);
307 void mconsole_go(struct mc_request *req)
309 mconsole_reply(req, "Not stopped", 1, 0);
312 void mconsole_stop(struct mc_request *req)
314 deactivate_fd(req->originating_fd, MCONSOLE_IRQ);
315 os_set_fd_block(req->originating_fd, 1);
316 mconsole_reply(req, "stopped", 0, 0);
317 while (mconsole_get_request(req->originating_fd, req)) {
318 if (req->cmd->handler == mconsole_go)
320 if (req->cmd->handler == mconsole_stop) {
321 mconsole_reply(req, "Already stopped", 1, 0);
324 if (req->cmd->handler == mconsole_sysrq) {
325 struct pt_regs *old_regs;
326 old_regs = set_irq_regs((struct pt_regs *)&req->regs);
328 set_irq_regs(old_regs);
331 (*req->cmd->handler)(req);
333 os_set_fd_block(req->originating_fd, 0);
334 reactivate_fd(req->originating_fd, MCONSOLE_IRQ);
335 mconsole_reply(req, "", 0, 0);
338 static DEFINE_SPINLOCK(mc_devices_lock);
339 static LIST_HEAD(mconsole_devices);
341 void mconsole_register_dev(struct mc_device *new)
343 spin_lock(&mc_devices_lock);
344 BUG_ON(!list_empty(&new->list));
345 list_add(&new->list, &mconsole_devices);
346 spin_unlock(&mc_devices_lock);
349 static struct mc_device *mconsole_find_dev(char *name)
351 struct list_head *ele;
352 struct mc_device *dev;
354 list_for_each(ele, &mconsole_devices){
355 dev = list_entry(ele, struct mc_device, list);
356 if(!strncmp(name, dev->name, strlen(dev->name)))
362 #define UNPLUGGED_PER_PAGE \
363 ((PAGE_SIZE - sizeof(struct list_head)) / sizeof(unsigned long))
365 struct unplugged_pages {
366 struct list_head list;
367 void *pages[UNPLUGGED_PER_PAGE];
370 static DECLARE_MUTEX(plug_mem_mutex);
371 static unsigned long long unplugged_pages_count = 0;
372 static LIST_HEAD(unplugged_pages);
373 static int unplug_index = UNPLUGGED_PER_PAGE;
375 static int mem_config(char *str, char **error_out)
377 unsigned long long diff;
378 int err = -EINVAL, i, add;
382 *error_out = "Expected '=' after 'mem'";
389 else if(str[0] == '+'){
393 *error_out = "Expected increment to start with '-' or '+'";
398 diff = memparse(str, &ret);
400 *error_out = "Failed to parse memory increment";
406 down(&plug_mem_mutex);
407 for(i = 0; i < diff; i++){
408 struct unplugged_pages *unplugged;
412 if(list_empty(&unplugged_pages))
415 unplugged = list_entry(unplugged_pages.next,
416 struct unplugged_pages, list);
418 addr = unplugged->pages[--unplug_index];
420 list_del(&unplugged->list);
422 unplug_index = UNPLUGGED_PER_PAGE;
425 free_page((unsigned long) addr);
426 unplugged_pages_count--;
431 page = alloc_page(GFP_ATOMIC);
435 unplugged = page_address(page);
436 if(unplug_index == UNPLUGGED_PER_PAGE){
437 list_add(&unplugged->list, &unplugged_pages);
441 struct list_head *entry = unplugged_pages.next;
444 unplugged = list_entry(entry,
445 struct unplugged_pages,
447 err = os_drop_memory(addr, PAGE_SIZE);
449 printk("Failed to release memory - "
450 "errno = %d\n", err);
451 *error_out = "Failed to release memory";
454 unplugged->pages[unplug_index++] = addr;
457 unplugged_pages_count++;
468 static int mem_get_config(char *name, char *str, int size, char **error_out)
470 char buf[sizeof("18446744073709551615")];
473 sprintf(buf, "%ld", uml_physmem);
474 CONFIG_CHUNK(str, size, len, buf, 1);
479 static int mem_id(char **str, int *start_out, int *end_out)
487 static int mem_remove(int n, char **error_out)
489 *error_out = "Memory doesn't support the remove operation";
493 static struct mc_device mem_mc = {
494 .list = LIST_HEAD_INIT(mem_mc.list),
496 .config = mem_config,
497 .get_config = mem_get_config,
499 .remove = mem_remove,
502 static int mem_mc_init(void)
504 if(can_drop_memory())
505 mconsole_register_dev(&mem_mc);
506 else printk("Can't release memory to the host - memory hotplug won't "
511 __initcall(mem_mc_init);
513 #define CONFIG_BUF_SIZE 64
515 static void mconsole_get_config(int (*get_config)(char *, char *, int,
517 struct mc_request *req, char *name)
519 char default_buf[CONFIG_BUF_SIZE], *error, *buf;
522 if(get_config == NULL){
523 mconsole_reply(req, "No get_config routine defined", 1, 0);
528 size = ARRAY_SIZE(default_buf);
532 n = (*get_config)(name, buf, size, &error);
534 mconsole_reply(req, error, 1, 0);
539 mconsole_reply(req, buf, 0, 0);
543 if(buf != default_buf)
547 buf = kmalloc(size, GFP_KERNEL);
549 mconsole_reply(req, "Failed to allocate buffer", 1, 0);
554 if(buf != default_buf)
558 void mconsole_config(struct mc_request *req)
560 struct mc_device *dev;
561 char *ptr = req->request.data, *name, *error_string = "";
564 ptr += strlen("config");
565 while(isspace(*ptr)) ptr++;
566 dev = mconsole_find_dev(ptr);
568 mconsole_reply(req, "Bad configuration option", 1, 0);
572 name = &ptr[strlen(dev->name)];
574 while((*ptr != '=') && (*ptr != '\0'))
578 err = (*dev->config)(name, &error_string);
579 mconsole_reply(req, error_string, err, 0);
581 else mconsole_get_config(dev->get_config, req, name);
584 void mconsole_remove(struct mc_request *req)
586 struct mc_device *dev;
587 char *ptr = req->request.data, *err_msg = "";
589 int err, start, end, n;
591 ptr += strlen("remove");
592 while(isspace(*ptr)) ptr++;
593 dev = mconsole_find_dev(ptr);
595 mconsole_reply(req, "Bad remove option", 1, 0);
599 ptr = &ptr[strlen(dev->name)];
602 n = (*dev->id)(&ptr, &start, &end);
604 err_msg = "Couldn't parse device number";
607 else if((n < start) || (n > end)){
608 sprintf(error, "Invalid device number - must be between "
609 "%d and %d", start, end);
615 err = (*dev->remove)(n, &err_msg);
622 err_msg = "Device doesn't exist";
626 err_msg = "Device is currently open";
632 mconsole_reply(req, err_msg, err, 0);
635 struct mconsole_output {
636 struct list_head list;
637 struct mc_request *req;
640 static DEFINE_SPINLOCK(client_lock);
641 static LIST_HEAD(clients);
642 static char console_buf[MCONSOLE_MAX_DATA];
643 static int console_index = 0;
645 static void console_write(struct console *console, const char *string,
648 struct list_head *ele;
651 if(list_empty(&clients))
655 n = min((size_t) len, ARRAY_SIZE(console_buf) - console_index);
656 strncpy(&console_buf[console_index], string, n);
663 list_for_each(ele, &clients){
664 struct mconsole_output *entry;
666 entry = list_entry(ele, struct mconsole_output, list);
667 mconsole_reply_len(entry->req, console_buf,
668 console_index, 0, 1);
675 static struct console mc_console = { .name = "mc",
676 .write = console_write,
677 .flags = CON_ENABLED,
680 static int mc_add_console(void)
682 register_console(&mc_console);
686 late_initcall(mc_add_console);
688 static void with_console(struct mc_request *req, void (*proc)(void *),
691 struct mconsole_output entry;
695 spin_lock_irqsave(&client_lock, flags);
696 list_add(&entry.list, &clients);
697 spin_unlock_irqrestore(&client_lock, flags);
701 mconsole_reply_len(req, console_buf, console_index, 0, 0);
704 spin_lock_irqsave(&client_lock, flags);
705 list_del(&entry.list);
706 spin_unlock_irqrestore(&client_lock, flags);
709 #ifdef CONFIG_MAGIC_SYSRQ
710 static void sysrq_proc(void *arg)
713 handle_sysrq(*op, NULL);
716 void mconsole_sysrq(struct mc_request *req)
718 char *ptr = req->request.data;
720 ptr += strlen("sysrq");
721 while(isspace(*ptr)) ptr++;
723 /* With 'b', the system will shut down without a chance to reply,
724 * so in this case, we reply first.
727 mconsole_reply(req, "", 0, 0);
729 with_console(req, sysrq_proc, ptr);
732 void mconsole_sysrq(struct mc_request *req)
734 mconsole_reply(req, "Sysrq not compiled in", 1, 0);
738 #ifdef CONFIG_MODE_SKAS
740 static void stack_proc(void *arg)
742 struct task_struct *from = current, *to = arg;
744 to->thread.saved_task = from;
745 switch_to(from, to, from);
748 /* Mconsole stack trace
749 * Added by Allan Graves, Jeff Dike
750 * Dumps a stacks registers to the linux console.
753 static void do_stack_trace(struct mc_request *req)
755 char *ptr = req->request.data;
756 int pid_requested= -1;
757 struct task_struct *from = NULL;
758 struct task_struct *to = NULL;
761 * 1) Send showregs output to mconsole.
762 * 2) Add a way to stack dump all pids.
765 ptr += strlen("stack");
766 while(isspace(*ptr)) ptr++;
768 /* Should really check for multiple pids or reject bad args here */
769 /* What do the arguments in mconsole_reply mean? */
770 if(sscanf(ptr, "%d", &pid_requested) == 0){
771 mconsole_reply(req, "Please specify a pid", 1, 0);
777 to = find_task_by_pid(pid_requested);
778 if((to == NULL) || (pid_requested == 0)) {
779 mconsole_reply(req, "Couldn't find that pid", 1, 0);
782 with_console(req, stack_proc, to);
784 #endif /* CONFIG_MODE_SKAS */
786 void mconsole_stack(struct mc_request *req)
788 /* This command doesn't work in TT mode, so let's check and then
791 CHOOSE_MODE(mconsole_reply(req, "Sorry, this doesn't work in TT mode",
793 do_stack_trace(req));
796 /* Changed by mconsole_setup, which is __setup, and called before SMP is
799 static char *notify_socket = NULL;
801 static int mconsole_init(void)
803 /* long to avoid size mismatch warnings from gcc */
808 if(umid_file_name("mconsole", file, sizeof(file))) return(-1);
809 snprintf(mconsole_socket_name, sizeof(file), "%s", file);
811 sock = os_create_unix_socket(file, sizeof(file), 1);
813 printk("Failed to initialize management console\n");
817 register_reboot_notifier(&reboot_notifier);
819 err = um_request_irq(MCONSOLE_IRQ, sock, IRQ_READ, mconsole_interrupt,
820 IRQF_DISABLED | IRQF_SHARED | IRQF_SAMPLE_RANDOM,
821 "mconsole", (void *)sock);
823 printk("Failed to get IRQ for management console\n");
827 if(notify_socket != NULL){
828 notify_socket = kstrdup(notify_socket, GFP_KERNEL);
829 if(notify_socket != NULL)
830 mconsole_notify(notify_socket, MCONSOLE_SOCKET,
831 mconsole_socket_name,
832 strlen(mconsole_socket_name) + 1);
833 else printk(KERN_ERR "mconsole_setup failed to strdup "
837 printk("mconsole (version %d) initialized on %s\n",
838 MCONSOLE_VERSION, mconsole_socket_name);
842 __initcall(mconsole_init);
844 static int write_proc_mconsole(struct file *file, const char __user *buffer,
845 unsigned long count, void *data)
849 buf = kmalloc(count + 1, GFP_KERNEL);
853 if(copy_from_user(buf, buffer, count)){
860 mconsole_notify(notify_socket, MCONSOLE_USER_NOTIFY, buf, count);
866 static int create_proc_mconsole(void)
868 struct proc_dir_entry *ent;
870 if(notify_socket == NULL) return(0);
872 ent = create_proc_entry("mconsole", S_IFREG | 0200, NULL);
874 printk(KERN_INFO "create_proc_mconsole : create_proc_entry failed\n");
878 ent->read_proc = NULL;
879 ent->write_proc = write_proc_mconsole;
883 static DEFINE_SPINLOCK(notify_spinlock);
885 void lock_notify(void)
887 spin_lock(¬ify_spinlock);
890 void unlock_notify(void)
892 spin_unlock(¬ify_spinlock);
895 __initcall(create_proc_mconsole);
897 #define NOTIFY "=notify:"
899 static int mconsole_setup(char *str)
901 if(!strncmp(str, NOTIFY, strlen(NOTIFY))){
902 str += strlen(NOTIFY);
905 else printk(KERN_ERR "mconsole_setup : Unknown option - '%s'\n", str);
909 __setup("mconsole", mconsole_setup);
911 __uml_help(mconsole_setup,
912 "mconsole=notify:<socket>\n"
913 " Requests that the mconsole driver send a message to the named Unix\n"
914 " socket containing the name of the mconsole socket. This also serves\n"
915 " to notify outside processes when UML has booted far enough to respond\n"
916 " to mconsole requests.\n\n"
919 static int notify_panic(struct notifier_block *self, unsigned long unused1,
924 if(notify_socket == NULL) return(0);
926 mconsole_notify(notify_socket, MCONSOLE_PANIC, message,
927 strlen(message) + 1);
931 static struct notifier_block panic_exit_notifier = {
932 .notifier_call = notify_panic,
937 static int add_notifier(void)
939 atomic_notifier_chain_register(&panic_notifier_list,
940 &panic_exit_notifier);
944 __initcall(add_notifier);
946 char *mconsole_notify_socket(void)
948 return(notify_socket);
951 EXPORT_SYMBOL(mconsole_notify_socket);