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"
38 #include "choose-mode.h"
40 static int do_unlink_socket(struct notifier_block
*notifier
,
41 unsigned long what
, void *data
)
43 return(mconsole_unlink_socket());
47 static struct notifier_block reboot_notifier
= {
48 .notifier_call
= do_unlink_socket
,
52 /* Safe without explicit locking for now. Tasklets provide their own
53 * locking, and the interrupt handler is safe because it can't interrupt
54 * itself and it can only happen on CPU 0.
57 static LIST_HEAD(mc_requests
);
59 static void mc_work_proc(void *unused
)
61 struct mconsole_entry
*req
;
64 while(!list_empty(&mc_requests
)){
65 local_save_flags(flags
);
66 req
= list_entry(mc_requests
.next
, struct mconsole_entry
,
69 local_irq_restore(flags
);
70 req
->request
.cmd
->handler(&req
->request
);
75 static DECLARE_WORK(mconsole_work
, mc_work_proc
, NULL
);
77 static irqreturn_t
mconsole_interrupt(int irq
, void *dev_id
,
80 /* long to avoid size mismatch warnings from gcc */
82 struct mconsole_entry
*new;
83 struct mc_request req
;
86 while (mconsole_get_request(fd
, &req
)){
87 if(req
.cmd
->context
== MCONSOLE_INTR
)
88 (*req
.cmd
->handler
)(&req
);
90 new = kmalloc(sizeof(*new), GFP_ATOMIC
);
92 mconsole_reply(&req
, "Out of memory", 1, 0);
95 list_add(&new->list
, &mc_requests
);
99 if(!list_empty(&mc_requests
))
100 schedule_work(&mconsole_work
);
101 reactivate_fd(fd
, MCONSOLE_IRQ
);
105 void mconsole_version(struct mc_request
*req
)
109 sprintf(version
, "%s %s %s %s %s", system_utsname
.sysname
,
110 system_utsname
.nodename
, system_utsname
.release
,
111 system_utsname
.version
, system_utsname
.machine
);
112 mconsole_reply(req
, version
, 0, 0);
115 void mconsole_log(struct mc_request
*req
)
118 char *ptr
= req
->request
.data
;
120 ptr
+= strlen("log ");
122 len
= req
->len
- (ptr
- req
->request
.data
);
123 printk("%.*s", len
, ptr
);
124 mconsole_reply(req
, "", 0, 0);
127 /* This is a more convoluted version of mconsole_proc, which has some stability
128 * problems; however, we need it fixed, because it is expected that UML users
129 * mount HPPFS instead of procfs on /proc. And we want mconsole_proc to still
130 * show the real procfs content, not the ones from hppfs.*/
132 void mconsole_proc(struct mc_request
*req
)
135 struct file_system_type
*proc
;
136 struct super_block
*super
;
139 char *ptr
= req
->request
.data
, *buf
;
141 ptr
+= strlen("proc");
142 while(isspace(*ptr
)) ptr
++;
144 proc
= get_fs_type("proc");
146 mconsole_reply(req
, "procfs not registered", 1, 0);
150 super
= (*proc
->get_sb
)(proc
, 0, NULL
, NULL
);
151 put_filesystem(proc
);
153 mconsole_reply(req
, "Failed to get procfs superblock", 1, 0);
156 up_write(&super
->s_umount
);
158 nd
.dentry
= super
->s_root
;
160 nd
.flags
= O_RDONLY
+ 1;
161 nd
.last_type
= LAST_ROOT
;
163 /* START: it was experienced that the stability problems are closed
164 * if commenting out these two calls + the below read cycle. To
165 * make UML crash again, it was enough to readd either one.*/
166 err
= link_path_walk(ptr
, &nd
);
168 mconsole_reply(req
, "Failed to look up file", 1, 0);
172 file
= dentry_open(nd
.dentry
, nd
.mnt
, O_RDONLY
);
174 mconsole_reply(req
, "Failed to open file", 1, 0);
179 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
181 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
185 if((file
->f_op
!= NULL
) && (file
->f_op
->read
!= NULL
)){
187 n
= (*file
->f_op
->read
)(file
, buf
, PAGE_SIZE
- 1,
191 mconsole_reply(req
, buf
, 0, (n
> 0));
194 mconsole_reply(req
, "Read of file failed",
200 else mconsole_reply(req
, "", 0, 0);
207 deactivate_super(super
);
212 void mconsole_proc(struct mc_request
*req
)
219 char *ptr
= req
->request
.data
;
221 ptr
+= strlen("proc");
222 while(isspace(*ptr
)) ptr
++;
223 snprintf(path
, sizeof(path
), "/proc/%s", ptr
);
225 fd
= sys_open(path
, 0, 0);
227 mconsole_reply(req
, "Failed to open file", 1, 0);
228 printk("open %s: %d\n",path
,fd
);
232 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
234 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
239 len
= sys_read(fd
, buf
, PAGE_SIZE
-1);
241 mconsole_reply(req
, "Read of file failed", 1, 0);
244 /*Begin the file content on his own line.*/
246 mconsole_reply(req
, "\n", 0, 1);
249 if (len
== PAGE_SIZE
-1) {
251 mconsole_reply(req
, buf
, 0, 1);
254 mconsole_reply(req
, buf
, 0, 0);
267 #define UML_MCONSOLE_HELPTEXT \
269 version - Get kernel version \n\
270 help - Print this message \n\
272 reboot - Reboot UML \n\
273 config <dev>=<config> - Add a new device to UML; \n\
274 same syntax as command line \n\
275 config <dev> - Query the configuration of a device \n\
276 remove <dev> - Remove a device from UML \n\
277 sysrq <letter> - Performs the SysRq action controlled by the letter \n\
278 cad - invoke the Ctrl-Alt-Del handler \n\
279 stop - pause the UML; it will do nothing until it receives a 'go' \n\
280 go - continue the UML after a 'stop' \n\
281 log <string> - make UML enter <string> into the kernel log\n\
282 proc <file> - returns the contents of the UML's /proc/<file>\n\
283 stack <pid> - returns the stack of the specified pid\n\
286 void mconsole_help(struct mc_request
*req
)
288 mconsole_reply(req
, UML_MCONSOLE_HELPTEXT
, 0, 0);
291 void mconsole_halt(struct mc_request
*req
)
293 mconsole_reply(req
, "", 0, 0);
297 void mconsole_reboot(struct mc_request
*req
)
299 mconsole_reply(req
, "", 0, 0);
300 machine_restart(NULL
);
303 extern void ctrl_alt_del(void);
305 void mconsole_cad(struct mc_request
*req
)
307 mconsole_reply(req
, "", 0, 0);
311 void mconsole_go(struct mc_request
*req
)
313 mconsole_reply(req
, "Not stopped", 1, 0);
316 void mconsole_stop(struct mc_request
*req
)
318 deactivate_fd(req
->originating_fd
, MCONSOLE_IRQ
);
319 os_set_fd_block(req
->originating_fd
, 1);
320 mconsole_reply(req
, "", 0, 0);
321 while(mconsole_get_request(req
->originating_fd
, req
)){
322 if(req
->cmd
->handler
== mconsole_go
) break;
323 (*req
->cmd
->handler
)(req
);
325 os_set_fd_block(req
->originating_fd
, 0);
326 reactivate_fd(req
->originating_fd
, MCONSOLE_IRQ
);
327 mconsole_reply(req
, "", 0, 0);
330 /* This list is populated by __initcall routines. */
332 static LIST_HEAD(mconsole_devices
);
334 void mconsole_register_dev(struct mc_device
*new)
336 list_add(&new->list
, &mconsole_devices
);
339 static struct mc_device
*mconsole_find_dev(char *name
)
341 struct list_head
*ele
;
342 struct mc_device
*dev
;
344 list_for_each(ele
, &mconsole_devices
){
345 dev
= list_entry(ele
, struct mc_device
, list
);
346 if(!strncmp(name
, dev
->name
, strlen(dev
->name
)))
352 #define UNPLUGGED_PER_PAGE \
353 ((PAGE_SIZE - sizeof(struct list_head)) / sizeof(unsigned long))
355 struct unplugged_pages
{
356 struct list_head list
;
357 void *pages
[UNPLUGGED_PER_PAGE
];
360 static unsigned long long unplugged_pages_count
= 0;
361 static struct list_head unplugged_pages
= LIST_HEAD_INIT(unplugged_pages
);
362 static int unplug_index
= UNPLUGGED_PER_PAGE
;
364 static int mem_config(char *str
)
366 unsigned long long diff
;
367 int err
= -EINVAL
, i
, add
;
376 else if(str
[0] == '+'){
382 diff
= memparse(str
, &ret
);
388 for(i
= 0; i
< diff
; i
++){
389 struct unplugged_pages
*unplugged
;
393 if(list_empty(&unplugged_pages
))
396 unplugged
= list_entry(unplugged_pages
.next
,
397 struct unplugged_pages
, list
);
399 addr
= unplugged
->pages
[--unplug_index
];
401 list_del(&unplugged
->list
);
403 unplug_index
= UNPLUGGED_PER_PAGE
;
406 free_page((unsigned long) addr
);
407 unplugged_pages_count
--;
412 page
= alloc_page(GFP_ATOMIC
);
416 unplugged
= page_address(page
);
417 if(unplug_index
== UNPLUGGED_PER_PAGE
){
418 INIT_LIST_HEAD(&unplugged
->list
);
419 list_add(&unplugged
->list
, &unplugged_pages
);
423 struct list_head
*entry
= unplugged_pages
.next
;
426 unplugged
= list_entry(entry
,
427 struct unplugged_pages
,
429 unplugged
->pages
[unplug_index
++] = addr
;
430 err
= os_drop_memory(addr
, PAGE_SIZE
);
432 printk("Failed to release memory - "
433 "errno = %d\n", err
);
436 unplugged_pages_count
++;
445 static int mem_get_config(char *name
, char *str
, int size
, char **error_out
)
447 char buf
[sizeof("18446744073709551615")];
450 sprintf(buf
, "%ld", uml_physmem
);
451 CONFIG_CHUNK(str
, size
, len
, buf
, 1);
456 static int mem_id(char **str
, int *start_out
, int *end_out
)
464 static int mem_remove(int n
)
469 static struct mc_device mem_mc
= {
471 .config
= mem_config
,
472 .get_config
= mem_get_config
,
474 .remove
= mem_remove
,
477 static int mem_mc_init(void)
479 if(can_drop_memory())
480 mconsole_register_dev(&mem_mc
);
481 else printk("Can't release memory to the host - memory hotplug won't "
486 __initcall(mem_mc_init
);
488 #define CONFIG_BUF_SIZE 64
490 static void mconsole_get_config(int (*get_config
)(char *, char *, int,
492 struct mc_request
*req
, char *name
)
494 char default_buf
[CONFIG_BUF_SIZE
], *error
, *buf
;
497 if(get_config
== NULL
){
498 mconsole_reply(req
, "No get_config routine defined", 1, 0);
503 size
= sizeof(default_buf
)/sizeof(default_buf
[0]);
507 n
= (*get_config
)(name
, buf
, size
, &error
);
509 mconsole_reply(req
, error
, 1, 0);
514 mconsole_reply(req
, buf
, 0, 0);
518 if(buf
!= default_buf
)
522 buf
= kmalloc(size
, GFP_KERNEL
);
524 mconsole_reply(req
, "Failed to allocate buffer", 1, 0);
529 if(buf
!= default_buf
)
533 void mconsole_config(struct mc_request
*req
)
535 struct mc_device
*dev
;
536 char *ptr
= req
->request
.data
, *name
;
539 ptr
+= strlen("config");
540 while(isspace(*ptr
)) ptr
++;
541 dev
= mconsole_find_dev(ptr
);
543 mconsole_reply(req
, "Bad configuration option", 1, 0);
547 name
= &ptr
[strlen(dev
->name
)];
549 while((*ptr
!= '=') && (*ptr
!= '\0'))
553 err
= (*dev
->config
)(name
);
554 mconsole_reply(req
, "", err
, 0);
556 else mconsole_get_config(dev
->get_config
, req
, name
);
559 void mconsole_remove(struct mc_request
*req
)
561 struct mc_device
*dev
;
562 char *ptr
= req
->request
.data
, *err_msg
= "";
564 int err
, start
, end
, n
;
566 ptr
+= strlen("remove");
567 while(isspace(*ptr
)) ptr
++;
568 dev
= mconsole_find_dev(ptr
);
570 mconsole_reply(req
, "Bad remove option", 1, 0);
574 ptr
= &ptr
[strlen(dev
->name
)];
577 n
= (*dev
->id
)(&ptr
, &start
, &end
);
579 err_msg
= "Couldn't parse device number";
582 else if((n
< start
) || (n
> end
)){
583 sprintf(error
, "Invalid device number - must be between "
584 "%d and %d", start
, end
);
589 err
= (*dev
->remove
)(n
);
592 err_msg
= "Device doesn't exist";
595 err_msg
= "Device is currently open";
601 mconsole_reply(req
, err_msg
, err
, 0);
604 static DEFINE_SPINLOCK(console_lock
);
605 static LIST_HEAD(clients
);
606 static char console_buf
[MCONSOLE_MAX_DATA
];
607 static int console_index
= 0;
609 static void console_write(struct console
*console
, const char *string
,
612 struct list_head
*ele
;
615 if(list_empty(&clients
))
619 n
= min((size_t)len
, ARRAY_SIZE(console_buf
) - console_index
);
620 strncpy(&console_buf
[console_index
], string
, n
);
627 list_for_each(ele
, &clients
){
628 struct mconsole_entry
*entry
;
630 entry
= list_entry(ele
, struct mconsole_entry
, list
);
631 mconsole_reply_len(&entry
->request
, console_buf
,
632 console_index
, 0, 1);
639 static struct console mc_console
= { .name
= "mc",
640 .write
= console_write
,
641 .flags
= CON_ENABLED
,
644 static int mc_add_console(void)
646 register_console(&mc_console
);
650 late_initcall(mc_add_console
);
652 static void with_console(struct mc_request
*req
, void (*proc
)(void *),
655 struct mconsole_entry entry
;
658 INIT_LIST_HEAD(&entry
.list
);
659 entry
.request
= *req
;
660 list_add(&entry
.list
, &clients
);
661 spin_lock_irqsave(&console_lock
, flags
);
665 mconsole_reply_len(req
, console_buf
, console_index
, 0, 0);
668 spin_unlock_irqrestore(&console_lock
, flags
);
669 list_del(&entry
.list
);
672 #ifdef CONFIG_MAGIC_SYSRQ
673 static void sysrq_proc(void *arg
)
677 handle_sysrq(*op
, ¤t
->thread
.regs
, NULL
);
680 void mconsole_sysrq(struct mc_request
*req
)
682 char *ptr
= req
->request
.data
;
684 ptr
+= strlen("sysrq");
685 while(isspace(*ptr
)) 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 #ifdef CONFIG_MODE_SKAS
704 static void stack_proc(void *arg
)
706 struct task_struct
*from
= current
, *to
= arg
;
708 to
->thread
.saved_task
= from
;
709 switch_to(from
, to
, from
);
712 /* Mconsole stack trace
713 * Added by Allan Graves, Jeff Dike
714 * Dumps a stacks registers to the linux console.
717 static void do_stack_trace(struct mc_request
*req
)
719 char *ptr
= req
->request
.data
;
720 int pid_requested
= -1;
721 struct task_struct
*from
= NULL
;
722 struct task_struct
*to
= NULL
;
725 * 1) Send showregs output to mconsole.
726 * 2) Add a way to stack dump all pids.
729 ptr
+= strlen("stack");
730 while(isspace(*ptr
)) ptr
++;
732 /* Should really check for multiple pids or reject bad args here */
733 /* What do the arguments in mconsole_reply mean? */
734 if(sscanf(ptr
, "%d", &pid_requested
) == 0){
735 mconsole_reply(req
, "Please specify a pid", 1, 0);
741 to
= find_task_by_pid(pid_requested
);
742 if((to
== NULL
) || (pid_requested
== 0)) {
743 mconsole_reply(req
, "Couldn't find that pid", 1, 0);
746 with_console(req
, stack_proc
, to
);
748 #endif /* CONFIG_MODE_SKAS */
750 void mconsole_stack(struct mc_request
*req
)
752 /* This command doesn't work in TT mode, so let's check and then
755 CHOOSE_MODE(mconsole_reply(req
, "Sorry, this doesn't work in TT mode",
757 do_stack_trace(req
));
760 /* Changed by mconsole_setup, which is __setup, and called before SMP is
763 static char *notify_socket
= NULL
;
765 static int mconsole_init(void)
767 /* long to avoid size mismatch warnings from gcc */
772 if(umid_file_name("mconsole", file
, sizeof(file
))) return(-1);
773 snprintf(mconsole_socket_name
, sizeof(file
), "%s", file
);
775 sock
= os_create_unix_socket(file
, sizeof(file
), 1);
777 printk("Failed to initialize management console\n");
781 register_reboot_notifier(&reboot_notifier
);
783 err
= um_request_irq(MCONSOLE_IRQ
, sock
, IRQ_READ
, mconsole_interrupt
,
784 SA_INTERRUPT
| SA_SHIRQ
| SA_SAMPLE_RANDOM
,
785 "mconsole", (void *)sock
);
787 printk("Failed to get IRQ for management console\n");
791 if(notify_socket
!= NULL
){
792 notify_socket
= kstrdup(notify_socket
, GFP_KERNEL
);
793 if(notify_socket
!= NULL
)
794 mconsole_notify(notify_socket
, MCONSOLE_SOCKET
,
795 mconsole_socket_name
,
796 strlen(mconsole_socket_name
) + 1);
797 else printk(KERN_ERR
"mconsole_setup failed to strdup "
801 printk("mconsole (version %d) initialized on %s\n",
802 MCONSOLE_VERSION
, mconsole_socket_name
);
806 __initcall(mconsole_init
);
808 static int write_proc_mconsole(struct file
*file
, const char __user
*buffer
,
809 unsigned long count
, void *data
)
813 buf
= kmalloc(count
+ 1, GFP_KERNEL
);
817 if(copy_from_user(buf
, buffer
, count
)){
824 mconsole_notify(notify_socket
, MCONSOLE_USER_NOTIFY
, buf
, count
);
830 static int create_proc_mconsole(void)
832 struct proc_dir_entry
*ent
;
834 if(notify_socket
== NULL
) return(0);
836 ent
= create_proc_entry("mconsole", S_IFREG
| 0200, NULL
);
838 printk(KERN_INFO
"create_proc_mconsole : create_proc_entry failed\n");
842 ent
->read_proc
= NULL
;
843 ent
->write_proc
= write_proc_mconsole
;
847 static DEFINE_SPINLOCK(notify_spinlock
);
849 void lock_notify(void)
851 spin_lock(¬ify_spinlock
);
854 void unlock_notify(void)
856 spin_unlock(¬ify_spinlock
);
859 __initcall(create_proc_mconsole
);
861 #define NOTIFY "=notify:"
863 static int mconsole_setup(char *str
)
865 if(!strncmp(str
, NOTIFY
, strlen(NOTIFY
))){
866 str
+= strlen(NOTIFY
);
869 else printk(KERN_ERR
"mconsole_setup : Unknown option - '%s'\n", str
);
873 __setup("mconsole", mconsole_setup
);
875 __uml_help(mconsole_setup
,
876 "mconsole=notify:<socket>\n"
877 " Requests that the mconsole driver send a message to the named Unix\n"
878 " socket containing the name of the mconsole socket. This also serves\n"
879 " to notify outside processes when UML has booted far enough to respond\n"
880 " to mconsole requests.\n\n"
883 static int notify_panic(struct notifier_block
*self
, unsigned long unused1
,
888 if(notify_socket
== NULL
) return(0);
890 mconsole_notify(notify_socket
, MCONSOLE_PANIC
, message
,
891 strlen(message
) + 1);
895 static struct notifier_block panic_exit_notifier
= {
896 .notifier_call
= notify_panic
,
901 static int add_notifier(void)
903 atomic_notifier_chain_register(&panic_notifier_list
,
904 &panic_exit_notifier
);
908 __initcall(add_notifier
);
910 char *mconsole_notify_socket(void)
912 return(notify_socket
);
915 EXPORT_SYMBOL(mconsole_notify_socket
);