2 * arch/s390/kernel/debug.c
5 * Copyright IBM Corp. 1999, 2012
7 * Author(s): Michael Holzheu (holzheu@de.ibm.com),
8 * Holger Smolinski (Holger.Smolinski@de.ibm.com)
10 * Bugreports to: <Linux390@de.ibm.com>
13 #define KMSG_COMPONENT "s390dbf"
14 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
16 #include <linux/stddef.h>
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/slab.h>
20 #include <linux/ctype.h>
21 #include <linux/string.h>
22 #include <linux/sysctl.h>
23 #include <asm/uaccess.h>
24 #include <linux/module.h>
25 #include <linux/init.h>
27 #include <linux/debugfs.h>
29 #include <asm/debug.h>
31 #define DEBUG_PROLOG_ENTRY -1
33 #define ALL_AREAS 0 /* copy all debug areas */
34 #define NO_AREAS 1 /* copy no debug areas */
38 typedef struct file_private_info {
39 loff_t offset; /* offset of last read in file */
40 int act_area; /* number of last formated area */
41 int act_page; /* act page in given area */
42 int act_entry; /* last formated entry (offset */
43 /* relative to beginning of last */
45 size_t act_entry_offset; /* up to this offset we copied */
46 /* in last read the last formated */
47 /* entry to userland */
48 char temp_buf[2048]; /* buffer for output */
49 debug_info_t *debug_info_org; /* original debug information */
50 debug_info_t *debug_info_snap; /* snapshot of debug information */
51 struct debug_view *view; /* used view of debug info */
52 } file_private_info_t;
58 * This assumes that all args are converted into longs
59 * on L/390 this is the case for all types of parameter
60 * except of floats, and long long (32 bit)
64 } debug_sprintf_entry_t;
67 /* internal function prototyes */
69 static int debug_init(void);
70 static ssize_t debug_output(struct file *file, char __user *user_buf,
71 size_t user_len, loff_t * offset);
72 static ssize_t debug_input(struct file *file, const char __user *user_buf,
73 size_t user_len, loff_t * offset);
74 static int debug_open(struct inode *inode, struct file *file);
75 static int debug_close(struct inode *inode, struct file *file);
76 static debug_info_t *debug_info_create(const char *name, int pages_per_area,
77 int nr_areas, int buf_size, umode_t mode);
78 static void debug_info_get(debug_info_t *);
79 static void debug_info_put(debug_info_t *);
80 static int debug_prolog_level_fn(debug_info_t * id,
81 struct debug_view *view, char *out_buf);
82 static int debug_input_level_fn(debug_info_t * id, struct debug_view *view,
83 struct file *file, const char __user *user_buf,
84 size_t user_buf_size, loff_t * offset);
85 static int debug_prolog_pages_fn(debug_info_t * id,
86 struct debug_view *view, char *out_buf);
87 static int debug_input_pages_fn(debug_info_t * id, struct debug_view *view,
88 struct file *file, const char __user *user_buf,
89 size_t user_buf_size, loff_t * offset);
90 static int debug_input_flush_fn(debug_info_t * id, struct debug_view *view,
91 struct file *file, const char __user *user_buf,
92 size_t user_buf_size, loff_t * offset);
93 static int debug_hex_ascii_format_fn(debug_info_t * id, struct debug_view *view,
94 char *out_buf, const char *in_buf);
95 static int debug_raw_format_fn(debug_info_t * id,
96 struct debug_view *view, char *out_buf,
98 static int debug_raw_header_fn(debug_info_t * id, struct debug_view *view,
99 int area, debug_entry_t * entry, char *out_buf);
101 static int debug_sprintf_format_fn(debug_info_t * id, struct debug_view *view,
102 char *out_buf, debug_sprintf_entry_t *curr_event);
106 struct debug_view debug_raw_view = {
109 &debug_raw_header_fn,
110 &debug_raw_format_fn,
115 struct debug_view debug_hex_ascii_view = {
118 &debug_dflt_header_fn,
119 &debug_hex_ascii_format_fn,
124 static struct debug_view debug_level_view = {
126 &debug_prolog_level_fn,
129 &debug_input_level_fn,
133 static struct debug_view debug_pages_view = {
135 &debug_prolog_pages_fn,
138 &debug_input_pages_fn,
142 static struct debug_view debug_flush_view = {
147 &debug_input_flush_fn,
151 struct debug_view debug_sprintf_view = {
154 &debug_dflt_header_fn,
155 (debug_format_proc_t*)&debug_sprintf_format_fn,
160 /* used by dump analysis tools to determine version of debug feature */
161 static unsigned int __used debug_feature_version = __DEBUG_FEATURE_VERSION;
165 static debug_info_t *debug_area_first = NULL;
166 static debug_info_t *debug_area_last = NULL;
167 static DEFINE_MUTEX(debug_mutex);
169 static int initialized;
170 static int debug_critical;
172 static const struct file_operations debug_file_ops = {
173 .owner = THIS_MODULE,
174 .read = debug_output,
175 .write = debug_input,
177 .release = debug_close,
181 static struct dentry *debug_debugfs_root_entry;
187 * - Debug areas are implemented as a threedimensonal array:
188 * areas[areanumber][pagenumber][pageoffset]
191 static debug_entry_t***
192 debug_areas_alloc(int pages_per_area, int nr_areas)
194 debug_entry_t*** areas;
197 areas = kmalloc(nr_areas *
198 sizeof(debug_entry_t**),
201 goto fail_malloc_areas;
202 for (i = 0; i < nr_areas; i++) {
203 areas[i] = kmalloc(pages_per_area *
204 sizeof(debug_entry_t*),GFP_KERNEL);
206 goto fail_malloc_areas2;
208 for(j = 0; j < pages_per_area; j++) {
209 areas[i][j] = kzalloc(PAGE_SIZE, GFP_KERNEL);
211 for(j--; j >=0 ; j--) {
215 goto fail_malloc_areas2;
222 for(i--; i >= 0; i--){
223 for(j=0; j < pages_per_area;j++){
237 * - alloc new debug-info
241 debug_info_alloc(const char *name, int pages_per_area, int nr_areas,
242 int buf_size, int level, int mode)
246 /* alloc everything */
248 rc = kmalloc(sizeof(debug_info_t), GFP_KERNEL);
251 rc->active_entries = kcalloc(nr_areas, sizeof(int), GFP_KERNEL);
252 if(!rc->active_entries)
253 goto fail_malloc_active_entries;
254 rc->active_pages = kcalloc(nr_areas, sizeof(int), GFP_KERNEL);
255 if(!rc->active_pages)
256 goto fail_malloc_active_pages;
257 if((mode == ALL_AREAS) && (pages_per_area != 0)){
258 rc->areas = debug_areas_alloc(pages_per_area, nr_areas);
260 goto fail_malloc_areas;
265 /* initialize members */
267 spin_lock_init(&rc->lock);
268 rc->pages_per_area = pages_per_area;
269 rc->nr_areas = nr_areas;
272 rc->buf_size = buf_size;
273 rc->entry_size = sizeof(debug_entry_t) + buf_size;
274 strlcpy(rc->name, name, sizeof(rc->name));
275 memset(rc->views, 0, DEBUG_MAX_VIEWS * sizeof(struct debug_view *));
276 memset(rc->debugfs_entries, 0 ,DEBUG_MAX_VIEWS *
277 sizeof(struct dentry*));
278 atomic_set(&(rc->ref_count), 0);
283 kfree(rc->active_pages);
284 fail_malloc_active_pages:
285 kfree(rc->active_entries);
286 fail_malloc_active_entries:
294 * - free all debug areas
298 debug_areas_free(debug_info_t* db_info)
304 for (i = 0; i < db_info->nr_areas; i++) {
305 for(j = 0; j < db_info->pages_per_area; j++) {
306 kfree(db_info->areas[i][j]);
308 kfree(db_info->areas[i]);
310 kfree(db_info->areas);
311 db_info->areas = NULL;
316 * - free memory debug-info
320 debug_info_free(debug_info_t* db_info){
321 debug_areas_free(db_info);
322 kfree(db_info->active_entries);
323 kfree(db_info->active_pages);
329 * - create new debug-info
333 debug_info_create(const char *name, int pages_per_area, int nr_areas,
334 int buf_size, umode_t mode)
338 rc = debug_info_alloc(name, pages_per_area, nr_areas, buf_size,
339 DEBUG_DEFAULT_LEVEL, ALL_AREAS);
343 rc->mode = mode & ~S_IFMT;
345 /* create root directory */
346 rc->debugfs_root_entry = debugfs_create_dir(rc->name,
347 debug_debugfs_root_entry);
349 /* append new element to linked list */
350 if (!debug_area_first) {
351 /* first element in list */
352 debug_area_first = rc;
355 /* append element to end of list */
356 debug_area_last->next = rc;
357 rc->prev = debug_area_last;
359 debug_area_last = rc;
373 debug_info_copy(debug_info_t* in, int mode)
379 /* get a consistent copy of the debug areas */
381 rc = debug_info_alloc(in->name, in->pages_per_area,
382 in->nr_areas, in->buf_size, in->level, mode);
383 spin_lock_irqsave(&in->lock, flags);
386 /* has something changed in the meantime ? */
387 if((rc->pages_per_area == in->pages_per_area) &&
388 (rc->nr_areas == in->nr_areas)) {
391 spin_unlock_irqrestore(&in->lock, flags);
395 if (mode == NO_AREAS)
398 for(i = 0; i < in->nr_areas; i++){
399 for(j = 0; j < in->pages_per_area; j++) {
400 memcpy(rc->areas[i][j], in->areas[i][j],PAGE_SIZE);
404 spin_unlock_irqrestore(&in->lock, flags);
410 * - increments reference count for debug-info
414 debug_info_get(debug_info_t * db_info)
417 atomic_inc(&db_info->ref_count);
422 * - decreases reference count for debug-info and frees it if necessary
426 debug_info_put(debug_info_t *db_info)
432 if (atomic_dec_and_test(&db_info->ref_count)) {
433 for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
434 if (!db_info->views[i])
436 debugfs_remove(db_info->debugfs_entries[i]);
438 debugfs_remove(db_info->debugfs_root_entry);
439 if(db_info == debug_area_first)
440 debug_area_first = db_info->next;
441 if(db_info == debug_area_last)
442 debug_area_last = db_info->prev;
443 if(db_info->prev) db_info->prev->next = db_info->next;
444 if(db_info->next) db_info->next->prev = db_info->prev;
445 debug_info_free(db_info);
450 * debug_format_entry:
451 * - format one debug entry and return size of formated data
455 debug_format_entry(file_private_info_t *p_info)
457 debug_info_t *id_snap = p_info->debug_info_snap;
458 struct debug_view *view = p_info->view;
459 debug_entry_t *act_entry;
461 if(p_info->act_entry == DEBUG_PROLOG_ENTRY){
463 if (view->prolog_proc)
464 len += view->prolog_proc(id_snap,view,p_info->temp_buf);
467 if (!id_snap->areas) /* this is true, if we have a prolog only view */
468 goto out; /* or if 'pages_per_area' is 0 */
469 act_entry = (debug_entry_t *) ((char*)id_snap->areas[p_info->act_area]
470 [p_info->act_page] + p_info->act_entry);
472 if (act_entry->id.stck == 0LL)
473 goto out; /* empty entry */
474 if (view->header_proc)
475 len += view->header_proc(id_snap, view, p_info->act_area,
476 act_entry, p_info->temp_buf + len);
477 if (view->format_proc)
478 len += view->format_proc(id_snap, view, p_info->temp_buf + len,
479 DEBUG_DATA(act_entry));
486 * - goto next entry in p_info
490 debug_next_entry(file_private_info_t *p_info)
494 id = p_info->debug_info_snap;
495 if(p_info->act_entry == DEBUG_PROLOG_ENTRY){
496 p_info->act_entry = 0;
497 p_info->act_page = 0;
502 p_info->act_entry += id->entry_size;
503 /* switch to next page, if we reached the end of the page */
504 if (p_info->act_entry > (PAGE_SIZE - id->entry_size)){
506 p_info->act_entry = 0;
507 p_info->act_page += 1;
508 if((p_info->act_page % id->pages_per_area) == 0) {
513 if(p_info->act_area >= id->nr_areas)
522 * - called for user read()
523 * - copies formated debug entries to the user buffer
527 debug_output(struct file *file, /* file descriptor */
528 char __user *user_buf, /* user buffer */
529 size_t len, /* length of buffer */
530 loff_t *offset) /* offset in the file */
534 file_private_info_t *p_info;
536 p_info = ((file_private_info_t *) file->private_data);
537 if (*offset != p_info->offset)
539 if(p_info->act_area >= p_info->debug_info_snap->nr_areas)
541 entry_offset = p_info->act_entry_offset;
543 int formatted_line_size;
544 int formatted_line_residue;
545 int user_buf_residue;
548 formatted_line_size = debug_format_entry(p_info);
549 formatted_line_residue = formatted_line_size - entry_offset;
550 user_buf_residue = len-count;
551 copy_size = min(user_buf_residue, formatted_line_residue);
553 if (copy_to_user(user_buf + count, p_info->temp_buf
554 + entry_offset, copy_size))
557 entry_offset += copy_size;
559 if(copy_size == formatted_line_residue){
561 if(debug_next_entry(p_info))
566 p_info->offset = *offset + count;
567 p_info->act_entry_offset = entry_offset;
568 *offset = p_info->offset;
574 * - called for user write()
575 * - calls input function of view
579 debug_input(struct file *file, const char __user *user_buf, size_t length,
583 file_private_info_t *p_info;
585 mutex_lock(&debug_mutex);
586 p_info = ((file_private_info_t *) file->private_data);
587 if (p_info->view->input_proc)
588 rc = p_info->view->input_proc(p_info->debug_info_org,
589 p_info->view, file, user_buf,
593 mutex_unlock(&debug_mutex);
594 return rc; /* number of input characters */
599 * - called for user open()
600 * - copies formated output to private_data area of the file
605 debug_open(struct inode *inode, struct file *file)
608 file_private_info_t *p_info;
609 debug_info_t *debug_info, *debug_info_snapshot;
611 mutex_lock(&debug_mutex);
612 debug_info = file->f_path.dentry->d_inode->i_private;
613 /* find debug view */
614 for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
615 if (!debug_info->views[i])
617 else if (debug_info->debugfs_entries[i] ==
618 file->f_path.dentry) {
619 goto found; /* found view ! */
628 /* Make snapshot of current debug areas to get it consistent. */
629 /* To copy all the areas is only needed, if we have a view which */
630 /* formats the debug areas. */
632 if(!debug_info->views[i]->format_proc &&
633 !debug_info->views[i]->header_proc){
634 debug_info_snapshot = debug_info_copy(debug_info, NO_AREAS);
636 debug_info_snapshot = debug_info_copy(debug_info, ALL_AREAS);
639 if(!debug_info_snapshot){
643 p_info = kmalloc(sizeof(file_private_info_t),
646 debug_info_free(debug_info_snapshot);
651 p_info->debug_info_snap = debug_info_snapshot;
652 p_info->debug_info_org = debug_info;
653 p_info->view = debug_info->views[i];
654 p_info->act_area = 0;
655 p_info->act_page = 0;
656 p_info->act_entry = DEBUG_PROLOG_ENTRY;
657 p_info->act_entry_offset = 0;
658 file->private_data = p_info;
659 debug_info_get(debug_info);
660 nonseekable_open(inode, file);
662 mutex_unlock(&debug_mutex);
668 * - called for user close()
669 * - deletes private_data area of the file handle
673 debug_close(struct inode *inode, struct file *file)
675 file_private_info_t *p_info;
676 p_info = (file_private_info_t *) file->private_data;
677 if(p_info->debug_info_snap)
678 debug_info_free(p_info->debug_info_snap);
679 debug_info_put(p_info->debug_info_org);
680 kfree(file->private_data);
681 return 0; /* success */
685 * debug_register_mode:
686 * - Creates and initializes debug area for the caller
687 * The mode parameter allows to specify access rights for the s390dbf files
688 * - Returns handle for debug area
691 debug_info_t *debug_register_mode(const char *name, int pages_per_area,
692 int nr_areas, int buf_size, umode_t mode,
693 uid_t uid, gid_t gid)
695 debug_info_t *rc = NULL;
697 /* Since debugfs currently does not support uid/gid other than root, */
698 /* we do not allow gid/uid != 0 until we get support for that. */
699 if ((uid != 0) || (gid != 0))
700 pr_warning("Root becomes the owner of all s390dbf files "
702 BUG_ON(!initialized);
703 mutex_lock(&debug_mutex);
705 /* create new debug_info */
707 rc = debug_info_create(name, pages_per_area, nr_areas, buf_size, mode);
710 debug_register_view(rc, &debug_level_view);
711 debug_register_view(rc, &debug_flush_view);
712 debug_register_view(rc, &debug_pages_view);
715 pr_err("Registering debug feature %s failed\n", name);
717 mutex_unlock(&debug_mutex);
720 EXPORT_SYMBOL(debug_register_mode);
724 * - creates and initializes debug area for the caller
725 * - returns handle for debug area
728 debug_info_t *debug_register(const char *name, int pages_per_area,
729 int nr_areas, int buf_size)
731 return debug_register_mode(name, pages_per_area, nr_areas, buf_size,
732 S_IRUSR | S_IWUSR, 0, 0);
737 * - give back debug area
741 debug_unregister(debug_info_t * id)
745 mutex_lock(&debug_mutex);
747 mutex_unlock(&debug_mutex);
755 * - set area size (number of pages) and number of areas
758 debug_set_size(debug_info_t* id, int nr_areas, int pages_per_area)
761 debug_entry_t *** new_areas;
764 if(!id || (nr_areas <= 0) || (pages_per_area < 0))
766 if(pages_per_area > 0){
767 new_areas = debug_areas_alloc(pages_per_area, nr_areas);
769 pr_info("Allocating memory for %i pages failed\n",
777 spin_lock_irqsave(&id->lock,flags);
778 debug_areas_free(id);
779 id->areas = new_areas;
780 id->nr_areas = nr_areas;
781 id->pages_per_area = pages_per_area;
783 memset(id->active_entries,0,sizeof(int)*id->nr_areas);
784 memset(id->active_pages, 0, sizeof(int)*id->nr_areas);
785 spin_unlock_irqrestore(&id->lock,flags);
786 pr_info("%s: set new size (%i pages)\n" ,id->name, pages_per_area);
793 * - set actual debug level
797 debug_set_level(debug_info_t* id, int new_level)
802 spin_lock_irqsave(&id->lock,flags);
803 if(new_level == DEBUG_OFF_LEVEL){
804 id->level = DEBUG_OFF_LEVEL;
805 pr_info("%s: switched off\n",id->name);
806 } else if ((new_level > DEBUG_MAX_LEVEL) || (new_level < 0)) {
807 pr_info("%s: level %i is out of range (%i - %i)\n",
808 id->name, new_level, 0, DEBUG_MAX_LEVEL);
810 id->level = new_level;
812 spin_unlock_irqrestore(&id->lock,flags);
817 * proceed_active_entry:
818 * - set active entry to next in the ring buffer
822 proceed_active_entry(debug_info_t * id)
824 if ((id->active_entries[id->active_area] += id->entry_size)
825 > (PAGE_SIZE - id->entry_size)){
826 id->active_entries[id->active_area] = 0;
827 id->active_pages[id->active_area] =
828 (id->active_pages[id->active_area] + 1) %
834 * proceed_active_area:
835 * - set active area to next in the ring buffer
839 proceed_active_area(debug_info_t * id)
842 id->active_area = id->active_area % id->nr_areas;
849 static inline debug_entry_t*
850 get_active_entry(debug_info_t * id)
852 return (debug_entry_t *) (((char *) id->areas[id->active_area]
853 [id->active_pages[id->active_area]]) +
854 id->active_entries[id->active_area]);
858 * debug_finish_entry:
859 * - set timestamp, caller address, cpu number etc.
863 debug_finish_entry(debug_info_t * id, debug_entry_t* active, int level,
866 active->id.stck = get_clock();
867 active->id.fields.cpuid = smp_processor_id();
868 active->caller = __builtin_return_address(0);
869 active->id.fields.exception = exception;
870 active->id.fields.level = level;
871 proceed_active_entry(id);
873 proceed_active_area(id);
876 static int debug_stoppable=1;
877 static int debug_active=1;
879 #define CTL_S390DBF_STOPPABLE 5678
880 #define CTL_S390DBF_ACTIVE 5679
883 * proc handler for the running debug_active sysctl
884 * always allow read, allow write only if debug_stoppable is set or
885 * if debug_active is already off
888 s390dbf_procactive(ctl_table *table, int write,
889 void __user *buffer, size_t *lenp, loff_t *ppos)
891 if (!write || debug_stoppable || !debug_active)
892 return proc_dointvec(table, write, buffer, lenp, ppos);
898 static struct ctl_table s390dbf_table[] = {
900 .procname = "debug_stoppable",
901 .data = &debug_stoppable,
902 .maxlen = sizeof(int),
903 .mode = S_IRUGO | S_IWUSR,
904 .proc_handler = proc_dointvec,
907 .procname = "debug_active",
908 .data = &debug_active,
909 .maxlen = sizeof(int),
910 .mode = S_IRUGO | S_IWUSR,
911 .proc_handler = s390dbf_procactive,
916 static struct ctl_table s390dbf_dir_table[] = {
918 .procname = "s390dbf",
920 .mode = S_IRUGO | S_IXUGO,
921 .child = s390dbf_table,
926 static struct ctl_table_header *s390dbf_sysctl_header;
936 void debug_set_critical(void)
942 * debug_event_common:
943 * - write debug entry with given size
947 debug_event_common(debug_info_t * id, int level, const void *buf, int len)
950 debug_entry_t *active;
952 if (!debug_active || !id->areas)
954 if (debug_critical) {
955 if (!spin_trylock_irqsave(&id->lock, flags))
958 spin_lock_irqsave(&id->lock, flags);
959 active = get_active_entry(id);
960 memset(DEBUG_DATA(active), 0, id->buf_size);
961 memcpy(DEBUG_DATA(active), buf, min(len, id->buf_size));
962 debug_finish_entry(id, active, level, 0);
963 spin_unlock_irqrestore(&id->lock, flags);
969 * debug_exception_common:
970 * - write debug entry with given size and switch to next debug area
974 *debug_exception_common(debug_info_t * id, int level, const void *buf, int len)
977 debug_entry_t *active;
979 if (!debug_active || !id->areas)
981 if (debug_critical) {
982 if (!spin_trylock_irqsave(&id->lock, flags))
985 spin_lock_irqsave(&id->lock, flags);
986 active = get_active_entry(id);
987 memset(DEBUG_DATA(active), 0, id->buf_size);
988 memcpy(DEBUG_DATA(active), buf, min(len, id->buf_size));
989 debug_finish_entry(id, active, level, 1);
990 spin_unlock_irqrestore(&id->lock, flags);
996 * counts arguments in format string for sprintf view
1000 debug_count_numargs(char *string)
1012 * debug_sprintf_event:
1016 debug_sprintf_event(debug_info_t* id, int level,char *string,...)
1020 unsigned long flags;
1021 debug_sprintf_entry_t *curr_event;
1022 debug_entry_t *active;
1024 if((!id) || (level > id->level))
1026 if (!debug_active || !id->areas)
1028 numargs=debug_count_numargs(string);
1030 if (debug_critical) {
1031 if (!spin_trylock_irqsave(&id->lock, flags))
1034 spin_lock_irqsave(&id->lock, flags);
1035 active = get_active_entry(id);
1036 curr_event=(debug_sprintf_entry_t *) DEBUG_DATA(active);
1037 va_start(ap,string);
1038 curr_event->string=string;
1039 for(idx=0;idx<min(numargs,(int)(id->buf_size / sizeof(long))-1);idx++)
1040 curr_event->args[idx]=va_arg(ap,long);
1042 debug_finish_entry(id, active, level, 0);
1043 spin_unlock_irqrestore(&id->lock, flags);
1049 * debug_sprintf_exception:
1053 debug_sprintf_exception(debug_info_t* id, int level,char *string,...)
1057 unsigned long flags;
1058 debug_sprintf_entry_t *curr_event;
1059 debug_entry_t *active;
1061 if((!id) || (level > id->level))
1063 if (!debug_active || !id->areas)
1066 numargs=debug_count_numargs(string);
1068 if (debug_critical) {
1069 if (!spin_trylock_irqsave(&id->lock, flags))
1072 spin_lock_irqsave(&id->lock, flags);
1073 active = get_active_entry(id);
1074 curr_event=(debug_sprintf_entry_t *)DEBUG_DATA(active);
1075 va_start(ap,string);
1076 curr_event->string=string;
1077 for(idx=0;idx<min(numargs,(int)(id->buf_size / sizeof(long))-1);idx++)
1078 curr_event->args[idx]=va_arg(ap,long);
1080 debug_finish_entry(id, active, level, 1);
1081 spin_unlock_irqrestore(&id->lock, flags);
1088 * - is called exactly once to initialize the debug feature
1092 __init debug_init(void)
1096 s390dbf_sysctl_header = register_sysctl_table(s390dbf_dir_table);
1097 mutex_lock(&debug_mutex);
1098 debug_debugfs_root_entry = debugfs_create_dir(DEBUG_DIR_ROOT,NULL);
1100 mutex_unlock(&debug_mutex);
1106 * debug_register_view:
1110 debug_register_view(debug_info_t * id, struct debug_view *view)
1114 unsigned long flags;
1120 mode = (id->mode | S_IFREG) & ~S_IXUGO;
1121 if (!(view->prolog_proc || view->format_proc || view->header_proc))
1122 mode &= ~(S_IRUSR | S_IRGRP | S_IROTH);
1123 if (!view->input_proc)
1124 mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
1125 pde = debugfs_create_file(view->name, mode, id->debugfs_root_entry,
1126 id , &debug_file_ops);
1128 pr_err("Registering view %s/%s failed due to out of "
1129 "memory\n", id->name,view->name);
1133 spin_lock_irqsave(&id->lock, flags);
1134 for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
1138 if (i == DEBUG_MAX_VIEWS) {
1139 pr_err("Registering view %s/%s would exceed the maximum "
1140 "number of views %i\n", id->name, view->name, i);
1141 debugfs_remove(pde);
1144 id->views[i] = view;
1145 id->debugfs_entries[i] = pde;
1147 spin_unlock_irqrestore(&id->lock, flags);
1153 * debug_unregister_view:
1157 debug_unregister_view(debug_info_t * id, struct debug_view *view)
1161 unsigned long flags;
1165 spin_lock_irqsave(&id->lock, flags);
1166 for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
1167 if (id->views[i] == view)
1170 if (i == DEBUG_MAX_VIEWS)
1173 debugfs_remove(id->debugfs_entries[i]);
1174 id->views[i] = NULL;
1176 spin_unlock_irqrestore(&id->lock, flags);
1181 static inline char *
1182 debug_get_user_string(const char __user *user_buf, size_t user_len)
1186 buffer = kmalloc(user_len + 1, GFP_KERNEL);
1188 return ERR_PTR(-ENOMEM);
1189 if (copy_from_user(buffer, user_buf, user_len) != 0) {
1191 return ERR_PTR(-EFAULT);
1193 /* got the string, now strip linefeed. */
1194 if (buffer[user_len - 1] == '\n')
1195 buffer[user_len - 1] = 0;
1197 buffer[user_len] = 0;
1202 debug_get_uint(char *buf)
1206 buf = skip_spaces(buf);
1207 rc = simple_strtoul(buf, &buf, 10);
1215 * functions for debug-views
1216 ***********************************
1220 * prints out actual debug level
1224 debug_prolog_pages_fn(debug_info_t * id,
1225 struct debug_view *view, char *out_buf)
1227 return sprintf(out_buf, "%i\n", id->pages_per_area);
1231 * reads new size (number of pages per debug area)
1235 debug_input_pages_fn(debug_info_t * id, struct debug_view *view,
1236 struct file *file, const char __user *user_buf,
1237 size_t user_len, loff_t * offset)
1242 if (user_len > 0x10000)
1248 str = debug_get_user_string(user_buf,user_len);
1253 new_pages = debug_get_uint(str);
1258 rc = debug_set_size(id,id->nr_areas, new_pages);
1267 *offset += user_len;
1268 return rc; /* number of input characters */
1272 * prints out actual debug level
1276 debug_prolog_level_fn(debug_info_t * id, struct debug_view *view, char *out_buf)
1280 if(id->level == DEBUG_OFF_LEVEL) {
1281 rc = sprintf(out_buf,"-\n");
1284 rc = sprintf(out_buf, "%i\n", id->level);
1290 * reads new debug level
1294 debug_input_level_fn(debug_info_t * id, struct debug_view *view,
1295 struct file *file, const char __user *user_buf,
1296 size_t user_len, loff_t * offset)
1301 if (user_len > 0x10000)
1307 str = debug_get_user_string(user_buf,user_len);
1313 debug_set_level(id, DEBUG_OFF_LEVEL);
1317 new_level = debug_get_uint(str);
1320 pr_warning("%s is not a valid level for a debug "
1324 debug_set_level(id, new_level);
1330 *offset += user_len;
1331 return rc; /* number of input characters */
1336 * flushes debug areas
1339 static void debug_flush(debug_info_t* id, int area)
1341 unsigned long flags;
1344 if(!id || !id->areas)
1346 spin_lock_irqsave(&id->lock,flags);
1347 if(area == DEBUG_FLUSH_ALL){
1348 id->active_area = 0;
1349 memset(id->active_entries, 0, id->nr_areas * sizeof(int));
1350 for (i = 0; i < id->nr_areas; i++) {
1351 id->active_pages[i] = 0;
1352 for(j = 0; j < id->pages_per_area; j++) {
1353 memset(id->areas[i][j], 0, PAGE_SIZE);
1356 } else if(area >= 0 && area < id->nr_areas) {
1357 id->active_entries[area] = 0;
1358 id->active_pages[area] = 0;
1359 for(i = 0; i < id->pages_per_area; i++) {
1360 memset(id->areas[area][i],0,PAGE_SIZE);
1363 spin_unlock_irqrestore(&id->lock,flags);
1367 * view function: flushes debug areas
1371 debug_input_flush_fn(debug_info_t * id, struct debug_view *view,
1372 struct file *file, const char __user *user_buf,
1373 size_t user_len, loff_t * offset)
1378 if (user_len > 0x10000)
1384 if (copy_from_user(input_buf, user_buf, 1)){
1388 if(input_buf[0] == '-') {
1389 debug_flush(id, DEBUG_FLUSH_ALL);
1392 if (isdigit(input_buf[0])) {
1393 int area = ((int) input_buf[0] - (int) '0');
1394 debug_flush(id, area);
1398 pr_info("Flushing debug data failed because %c is not a valid "
1399 "area\n", input_buf[0]);
1402 *offset += user_len;
1403 return rc; /* number of input characters */
1407 * prints debug header in raw format
1411 debug_raw_header_fn(debug_info_t * id, struct debug_view *view,
1412 int area, debug_entry_t * entry, char *out_buf)
1416 rc = sizeof(debug_entry_t);
1417 memcpy(out_buf,entry,sizeof(debug_entry_t));
1422 * prints debug data in raw format
1426 debug_raw_format_fn(debug_info_t * id, struct debug_view *view,
1427 char *out_buf, const char *in_buf)
1432 memcpy(out_buf, in_buf, id->buf_size);
1437 * prints debug data in hex/ascii format
1441 debug_hex_ascii_format_fn(debug_info_t * id, struct debug_view *view,
1442 char *out_buf, const char *in_buf)
1446 for (i = 0; i < id->buf_size; i++) {
1447 rc += sprintf(out_buf + rc, "%02x ",
1448 ((unsigned char *) in_buf)[i]);
1450 rc += sprintf(out_buf + rc, "| ");
1451 for (i = 0; i < id->buf_size; i++) {
1452 unsigned char c = in_buf[i];
1453 if (isascii(c) && isprint(c))
1454 rc += sprintf(out_buf + rc, "%c", c);
1456 rc += sprintf(out_buf + rc, ".");
1458 rc += sprintf(out_buf + rc, "\n");
1463 * prints header for debug entry
1467 debug_dflt_header_fn(debug_info_t * id, struct debug_view *view,
1468 int area, debug_entry_t * entry, char *out_buf)
1470 struct timespec time_spec;
1472 unsigned long caller;
1476 level = entry->id.fields.level;
1477 stck_to_timespec(entry->id.stck, &time_spec);
1479 if (entry->id.fields.exception)
1483 caller = ((unsigned long) entry->caller) & PSW_ADDR_INSN;
1484 rc += sprintf(out_buf, "%02i %011lu:%06lu %1u %1s %02i %p ",
1485 area, time_spec.tv_sec, time_spec.tv_nsec / 1000, level,
1486 except_str, entry->id.fields.cpuid, (void *) caller);
1491 * prints debug data sprintf-formated:
1492 * debug_sprinf_event/exception calls must be used together with this view
1495 #define DEBUG_SPRINTF_MAX_ARGS 10
1498 debug_sprintf_format_fn(debug_info_t * id, struct debug_view *view,
1499 char *out_buf, debug_sprintf_entry_t *curr_event)
1501 int num_longs, num_used_args = 0,i, rc = 0;
1502 int index[DEBUG_SPRINTF_MAX_ARGS];
1504 /* count of longs fit into one entry */
1505 num_longs = id->buf_size / sizeof(long);
1508 goto out; /* bufsize of entry too small */
1509 if(num_longs == 1) {
1510 /* no args, we use only the string */
1511 strcpy(out_buf, curr_event->string);
1512 rc = strlen(curr_event->string);
1516 /* number of arguments used for sprintf (without the format string) */
1517 num_used_args = min(DEBUG_SPRINTF_MAX_ARGS, (num_longs - 1));
1519 memset(index,0, DEBUG_SPRINTF_MAX_ARGS * sizeof(int));
1521 for(i = 0; i < num_used_args; i++)
1524 rc = sprintf(out_buf, curr_event->string, curr_event->args[index[0]],
1525 curr_event->args[index[1]], curr_event->args[index[2]],
1526 curr_event->args[index[3]], curr_event->args[index[4]],
1527 curr_event->args[index[5]], curr_event->args[index[6]],
1528 curr_event->args[index[7]], curr_event->args[index[8]],
1529 curr_event->args[index[9]]);
1539 static void __exit debug_exit(void)
1541 debugfs_remove(debug_debugfs_root_entry);
1542 unregister_sysctl_table(s390dbf_sysctl_header);
1547 * module definitions
1549 postcore_initcall(debug_init);
1550 module_exit(debug_exit);
1551 MODULE_LICENSE("GPL");
1553 EXPORT_SYMBOL(debug_register);
1554 EXPORT_SYMBOL(debug_unregister);
1555 EXPORT_SYMBOL(debug_set_level);
1556 EXPORT_SYMBOL(debug_stop_all);
1557 EXPORT_SYMBOL(debug_register_view);
1558 EXPORT_SYMBOL(debug_unregister_view);
1559 EXPORT_SYMBOL(debug_event_common);
1560 EXPORT_SYMBOL(debug_exception_common);
1561 EXPORT_SYMBOL(debug_hex_ascii_view);
1562 EXPORT_SYMBOL(debug_raw_view);
1563 EXPORT_SYMBOL(debug_dflt_header_fn);
1564 EXPORT_SYMBOL(debug_sprintf_view);
1565 EXPORT_SYMBOL(debug_sprintf_exception);
1566 EXPORT_SYMBOL(debug_sprintf_event);