4 * Copyright IBM Corp. 1999, 2012
6 * Author(s): Michael Holzheu (holzheu@de.ibm.com),
7 * Holger Smolinski (Holger.Smolinski@de.ibm.com)
9 * Bugreports to: <Linux390@de.ibm.com>
12 #define KMSG_COMPONENT "s390dbf"
13 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
15 #include <linux/stddef.h>
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/slab.h>
19 #include <linux/ctype.h>
20 #include <linux/string.h>
21 #include <linux/sysctl.h>
22 #include <asm/uaccess.h>
23 #include <linux/module.h>
24 #include <linux/init.h>
26 #include <linux/debugfs.h>
28 #include <asm/debug.h>
30 #define DEBUG_PROLOG_ENTRY -1
32 #define ALL_AREAS 0 /* copy all debug areas */
33 #define NO_AREAS 1 /* copy no debug areas */
37 typedef struct file_private_info {
38 loff_t offset; /* offset of last read in file */
39 int act_area; /* number of last formated area */
40 int act_page; /* act page in given area */
41 int act_entry; /* last formated entry (offset */
42 /* relative to beginning of last */
44 size_t act_entry_offset; /* up to this offset we copied */
45 /* in last read the last formated */
46 /* entry to userland */
47 char temp_buf[2048]; /* buffer for output */
48 debug_info_t *debug_info_org; /* original debug information */
49 debug_info_t *debug_info_snap; /* snapshot of debug information */
50 struct debug_view *view; /* used view of debug info */
51 } file_private_info_t;
57 * This assumes that all args are converted into longs
58 * on L/390 this is the case for all types of parameter
59 * except of floats, and long long (32 bit)
63 } debug_sprintf_entry_t;
66 /* internal function prototyes */
68 static int debug_init(void);
69 static ssize_t debug_output(struct file *file, char __user *user_buf,
70 size_t user_len, loff_t * offset);
71 static ssize_t debug_input(struct file *file, const char __user *user_buf,
72 size_t user_len, loff_t * offset);
73 static int debug_open(struct inode *inode, struct file *file);
74 static int debug_close(struct inode *inode, struct file *file);
75 static debug_info_t *debug_info_create(const char *name, int pages_per_area,
76 int nr_areas, int buf_size, umode_t mode);
77 static void debug_info_get(debug_info_t *);
78 static void debug_info_put(debug_info_t *);
79 static int debug_prolog_level_fn(debug_info_t * id,
80 struct debug_view *view, char *out_buf);
81 static int debug_input_level_fn(debug_info_t * id, struct debug_view *view,
82 struct file *file, const char __user *user_buf,
83 size_t user_buf_size, loff_t * offset);
84 static int debug_prolog_pages_fn(debug_info_t * id,
85 struct debug_view *view, char *out_buf);
86 static int debug_input_pages_fn(debug_info_t * id, struct debug_view *view,
87 struct file *file, const char __user *user_buf,
88 size_t user_buf_size, loff_t * offset);
89 static int debug_input_flush_fn(debug_info_t * id, struct debug_view *view,
90 struct file *file, const char __user *user_buf,
91 size_t user_buf_size, loff_t * offset);
92 static int debug_hex_ascii_format_fn(debug_info_t * id, struct debug_view *view,
93 char *out_buf, const char *in_buf);
94 static int debug_raw_format_fn(debug_info_t * id,
95 struct debug_view *view, char *out_buf,
97 static int debug_raw_header_fn(debug_info_t * id, struct debug_view *view,
98 int area, debug_entry_t * entry, char *out_buf);
100 static int debug_sprintf_format_fn(debug_info_t * id, struct debug_view *view,
101 char *out_buf, debug_sprintf_entry_t *curr_event);
105 struct debug_view debug_raw_view = {
108 &debug_raw_header_fn,
109 &debug_raw_format_fn,
114 struct debug_view debug_hex_ascii_view = {
117 &debug_dflt_header_fn,
118 &debug_hex_ascii_format_fn,
123 static struct debug_view debug_level_view = {
125 &debug_prolog_level_fn,
128 &debug_input_level_fn,
132 static struct debug_view debug_pages_view = {
134 &debug_prolog_pages_fn,
137 &debug_input_pages_fn,
141 static struct debug_view debug_flush_view = {
146 &debug_input_flush_fn,
150 struct debug_view debug_sprintf_view = {
153 &debug_dflt_header_fn,
154 (debug_format_proc_t*)&debug_sprintf_format_fn,
159 /* used by dump analysis tools to determine version of debug feature */
160 static unsigned int __used debug_feature_version = __DEBUG_FEATURE_VERSION;
164 static debug_info_t *debug_area_first = NULL;
165 static debug_info_t *debug_area_last = NULL;
166 static DEFINE_MUTEX(debug_mutex);
168 static int initialized;
169 static int debug_critical;
171 static const struct file_operations debug_file_ops = {
172 .owner = THIS_MODULE,
173 .read = debug_output,
174 .write = debug_input,
176 .release = debug_close,
180 static struct dentry *debug_debugfs_root_entry;
186 * - Debug areas are implemented as a threedimensonal array:
187 * areas[areanumber][pagenumber][pageoffset]
190 static debug_entry_t***
191 debug_areas_alloc(int pages_per_area, int nr_areas)
193 debug_entry_t*** areas;
196 areas = kmalloc(nr_areas *
197 sizeof(debug_entry_t**),
200 goto fail_malloc_areas;
201 for (i = 0; i < nr_areas; i++) {
202 areas[i] = kmalloc(pages_per_area *
203 sizeof(debug_entry_t*),GFP_KERNEL);
205 goto fail_malloc_areas2;
207 for(j = 0; j < pages_per_area; j++) {
208 areas[i][j] = kzalloc(PAGE_SIZE, GFP_KERNEL);
210 for(j--; j >=0 ; j--) {
214 goto fail_malloc_areas2;
221 for(i--; i >= 0; i--){
222 for(j=0; j < pages_per_area;j++){
236 * - alloc new debug-info
240 debug_info_alloc(const char *name, int pages_per_area, int nr_areas,
241 int buf_size, int level, int mode)
245 /* alloc everything */
247 rc = kmalloc(sizeof(debug_info_t), GFP_KERNEL);
250 rc->active_entries = kcalloc(nr_areas, sizeof(int), GFP_KERNEL);
251 if(!rc->active_entries)
252 goto fail_malloc_active_entries;
253 rc->active_pages = kcalloc(nr_areas, sizeof(int), GFP_KERNEL);
254 if(!rc->active_pages)
255 goto fail_malloc_active_pages;
256 if((mode == ALL_AREAS) && (pages_per_area != 0)){
257 rc->areas = debug_areas_alloc(pages_per_area, nr_areas);
259 goto fail_malloc_areas;
264 /* initialize members */
266 spin_lock_init(&rc->lock);
267 rc->pages_per_area = pages_per_area;
268 rc->nr_areas = nr_areas;
271 rc->buf_size = buf_size;
272 rc->entry_size = sizeof(debug_entry_t) + buf_size;
273 strlcpy(rc->name, name, sizeof(rc->name));
274 memset(rc->views, 0, DEBUG_MAX_VIEWS * sizeof(struct debug_view *));
275 memset(rc->debugfs_entries, 0 ,DEBUG_MAX_VIEWS *
276 sizeof(struct dentry*));
277 atomic_set(&(rc->ref_count), 0);
282 kfree(rc->active_pages);
283 fail_malloc_active_pages:
284 kfree(rc->active_entries);
285 fail_malloc_active_entries:
293 * - free all debug areas
297 debug_areas_free(debug_info_t* db_info)
303 for (i = 0; i < db_info->nr_areas; i++) {
304 for(j = 0; j < db_info->pages_per_area; j++) {
305 kfree(db_info->areas[i][j]);
307 kfree(db_info->areas[i]);
309 kfree(db_info->areas);
310 db_info->areas = NULL;
315 * - free memory debug-info
319 debug_info_free(debug_info_t* db_info){
320 debug_areas_free(db_info);
321 kfree(db_info->active_entries);
322 kfree(db_info->active_pages);
328 * - create new debug-info
332 debug_info_create(const char *name, int pages_per_area, int nr_areas,
333 int buf_size, umode_t mode)
337 rc = debug_info_alloc(name, pages_per_area, nr_areas, buf_size,
338 DEBUG_DEFAULT_LEVEL, ALL_AREAS);
342 rc->mode = mode & ~S_IFMT;
344 /* create root directory */
345 rc->debugfs_root_entry = debugfs_create_dir(rc->name,
346 debug_debugfs_root_entry);
348 /* append new element to linked list */
349 if (!debug_area_first) {
350 /* first element in list */
351 debug_area_first = rc;
354 /* append element to end of list */
355 debug_area_last->next = rc;
356 rc->prev = debug_area_last;
358 debug_area_last = rc;
372 debug_info_copy(debug_info_t* in, int mode)
378 /* get a consistent copy of the debug areas */
380 rc = debug_info_alloc(in->name, in->pages_per_area,
381 in->nr_areas, in->buf_size, in->level, mode);
382 spin_lock_irqsave(&in->lock, flags);
385 /* has something changed in the meantime ? */
386 if((rc->pages_per_area == in->pages_per_area) &&
387 (rc->nr_areas == in->nr_areas)) {
390 spin_unlock_irqrestore(&in->lock, flags);
394 if (mode == NO_AREAS)
397 for(i = 0; i < in->nr_areas; i++){
398 for(j = 0; j < in->pages_per_area; j++) {
399 memcpy(rc->areas[i][j], in->areas[i][j],PAGE_SIZE);
403 spin_unlock_irqrestore(&in->lock, flags);
409 * - increments reference count for debug-info
413 debug_info_get(debug_info_t * db_info)
416 atomic_inc(&db_info->ref_count);
421 * - decreases reference count for debug-info and frees it if necessary
425 debug_info_put(debug_info_t *db_info)
431 if (atomic_dec_and_test(&db_info->ref_count)) {
432 for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
433 if (!db_info->views[i])
435 debugfs_remove(db_info->debugfs_entries[i]);
437 debugfs_remove(db_info->debugfs_root_entry);
438 if(db_info == debug_area_first)
439 debug_area_first = db_info->next;
440 if(db_info == debug_area_last)
441 debug_area_last = db_info->prev;
442 if(db_info->prev) db_info->prev->next = db_info->next;
443 if(db_info->next) db_info->next->prev = db_info->prev;
444 debug_info_free(db_info);
449 * debug_format_entry:
450 * - format one debug entry and return size of formated data
454 debug_format_entry(file_private_info_t *p_info)
456 debug_info_t *id_snap = p_info->debug_info_snap;
457 struct debug_view *view = p_info->view;
458 debug_entry_t *act_entry;
460 if(p_info->act_entry == DEBUG_PROLOG_ENTRY){
462 if (view->prolog_proc)
463 len += view->prolog_proc(id_snap,view,p_info->temp_buf);
466 if (!id_snap->areas) /* this is true, if we have a prolog only view */
467 goto out; /* or if 'pages_per_area' is 0 */
468 act_entry = (debug_entry_t *) ((char*)id_snap->areas[p_info->act_area]
469 [p_info->act_page] + p_info->act_entry);
471 if (act_entry->id.stck == 0LL)
472 goto out; /* empty entry */
473 if (view->header_proc)
474 len += view->header_proc(id_snap, view, p_info->act_area,
475 act_entry, p_info->temp_buf + len);
476 if (view->format_proc)
477 len += view->format_proc(id_snap, view, p_info->temp_buf + len,
478 DEBUG_DATA(act_entry));
485 * - goto next entry in p_info
489 debug_next_entry(file_private_info_t *p_info)
493 id = p_info->debug_info_snap;
494 if(p_info->act_entry == DEBUG_PROLOG_ENTRY){
495 p_info->act_entry = 0;
496 p_info->act_page = 0;
501 p_info->act_entry += id->entry_size;
502 /* switch to next page, if we reached the end of the page */
503 if (p_info->act_entry > (PAGE_SIZE - id->entry_size)){
505 p_info->act_entry = 0;
506 p_info->act_page += 1;
507 if((p_info->act_page % id->pages_per_area) == 0) {
512 if(p_info->act_area >= id->nr_areas)
521 * - called for user read()
522 * - copies formated debug entries to the user buffer
526 debug_output(struct file *file, /* file descriptor */
527 char __user *user_buf, /* user buffer */
528 size_t len, /* length of buffer */
529 loff_t *offset) /* offset in the file */
533 file_private_info_t *p_info;
535 p_info = ((file_private_info_t *) file->private_data);
536 if (*offset != p_info->offset)
538 if(p_info->act_area >= p_info->debug_info_snap->nr_areas)
540 entry_offset = p_info->act_entry_offset;
542 int formatted_line_size;
543 int formatted_line_residue;
544 int user_buf_residue;
547 formatted_line_size = debug_format_entry(p_info);
548 formatted_line_residue = formatted_line_size - entry_offset;
549 user_buf_residue = len-count;
550 copy_size = min(user_buf_residue, formatted_line_residue);
552 if (copy_to_user(user_buf + count, p_info->temp_buf
553 + entry_offset, copy_size))
556 entry_offset += copy_size;
558 if(copy_size == formatted_line_residue){
560 if(debug_next_entry(p_info))
565 p_info->offset = *offset + count;
566 p_info->act_entry_offset = entry_offset;
567 *offset = p_info->offset;
573 * - called for user write()
574 * - calls input function of view
578 debug_input(struct file *file, const char __user *user_buf, size_t length,
582 file_private_info_t *p_info;
584 mutex_lock(&debug_mutex);
585 p_info = ((file_private_info_t *) file->private_data);
586 if (p_info->view->input_proc)
587 rc = p_info->view->input_proc(p_info->debug_info_org,
588 p_info->view, file, user_buf,
592 mutex_unlock(&debug_mutex);
593 return rc; /* number of input characters */
598 * - called for user open()
599 * - copies formated output to private_data area of the file
604 debug_open(struct inode *inode, struct file *file)
607 file_private_info_t *p_info;
608 debug_info_t *debug_info, *debug_info_snapshot;
610 mutex_lock(&debug_mutex);
611 debug_info = file->f_path.dentry->d_inode->i_private;
612 /* find debug view */
613 for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
614 if (!debug_info->views[i])
616 else if (debug_info->debugfs_entries[i] ==
617 file->f_path.dentry) {
618 goto found; /* found view ! */
627 /* Make snapshot of current debug areas to get it consistent. */
628 /* To copy all the areas is only needed, if we have a view which */
629 /* formats the debug areas. */
631 if(!debug_info->views[i]->format_proc &&
632 !debug_info->views[i]->header_proc){
633 debug_info_snapshot = debug_info_copy(debug_info, NO_AREAS);
635 debug_info_snapshot = debug_info_copy(debug_info, ALL_AREAS);
638 if(!debug_info_snapshot){
642 p_info = kmalloc(sizeof(file_private_info_t),
645 debug_info_free(debug_info_snapshot);
650 p_info->debug_info_snap = debug_info_snapshot;
651 p_info->debug_info_org = debug_info;
652 p_info->view = debug_info->views[i];
653 p_info->act_area = 0;
654 p_info->act_page = 0;
655 p_info->act_entry = DEBUG_PROLOG_ENTRY;
656 p_info->act_entry_offset = 0;
657 file->private_data = p_info;
658 debug_info_get(debug_info);
659 nonseekable_open(inode, file);
661 mutex_unlock(&debug_mutex);
667 * - called for user close()
668 * - deletes private_data area of the file handle
672 debug_close(struct inode *inode, struct file *file)
674 file_private_info_t *p_info;
675 p_info = (file_private_info_t *) file->private_data;
676 if(p_info->debug_info_snap)
677 debug_info_free(p_info->debug_info_snap);
678 debug_info_put(p_info->debug_info_org);
679 kfree(file->private_data);
680 return 0; /* success */
684 * debug_register_mode:
685 * - Creates and initializes debug area for the caller
686 * The mode parameter allows to specify access rights for the s390dbf files
687 * - Returns handle for debug area
690 debug_info_t *debug_register_mode(const char *name, int pages_per_area,
691 int nr_areas, int buf_size, umode_t mode,
692 uid_t uid, gid_t gid)
694 debug_info_t *rc = NULL;
696 /* Since debugfs currently does not support uid/gid other than root, */
697 /* we do not allow gid/uid != 0 until we get support for that. */
698 if ((uid != 0) || (gid != 0))
699 pr_warning("Root becomes the owner of all s390dbf files "
701 BUG_ON(!initialized);
702 mutex_lock(&debug_mutex);
704 /* create new debug_info */
706 rc = debug_info_create(name, pages_per_area, nr_areas, buf_size, mode);
709 debug_register_view(rc, &debug_level_view);
710 debug_register_view(rc, &debug_flush_view);
711 debug_register_view(rc, &debug_pages_view);
714 pr_err("Registering debug feature %s failed\n", name);
716 mutex_unlock(&debug_mutex);
719 EXPORT_SYMBOL(debug_register_mode);
723 * - creates and initializes debug area for the caller
724 * - returns handle for debug area
727 debug_info_t *debug_register(const char *name, int pages_per_area,
728 int nr_areas, int buf_size)
730 return debug_register_mode(name, pages_per_area, nr_areas, buf_size,
731 S_IRUSR | S_IWUSR, 0, 0);
736 * - give back debug area
740 debug_unregister(debug_info_t * id)
744 mutex_lock(&debug_mutex);
746 mutex_unlock(&debug_mutex);
754 * - set area size (number of pages) and number of areas
757 debug_set_size(debug_info_t* id, int nr_areas, int pages_per_area)
760 debug_entry_t *** new_areas;
763 if(!id || (nr_areas <= 0) || (pages_per_area < 0))
765 if(pages_per_area > 0){
766 new_areas = debug_areas_alloc(pages_per_area, nr_areas);
768 pr_info("Allocating memory for %i pages failed\n",
776 spin_lock_irqsave(&id->lock,flags);
777 debug_areas_free(id);
778 id->areas = new_areas;
779 id->nr_areas = nr_areas;
780 id->pages_per_area = pages_per_area;
782 memset(id->active_entries,0,sizeof(int)*id->nr_areas);
783 memset(id->active_pages, 0, sizeof(int)*id->nr_areas);
784 spin_unlock_irqrestore(&id->lock,flags);
785 pr_info("%s: set new size (%i pages)\n" ,id->name, pages_per_area);
792 * - set actual debug level
796 debug_set_level(debug_info_t* id, int new_level)
801 spin_lock_irqsave(&id->lock,flags);
802 if(new_level == DEBUG_OFF_LEVEL){
803 id->level = DEBUG_OFF_LEVEL;
804 pr_info("%s: switched off\n",id->name);
805 } else if ((new_level > DEBUG_MAX_LEVEL) || (new_level < 0)) {
806 pr_info("%s: level %i is out of range (%i - %i)\n",
807 id->name, new_level, 0, DEBUG_MAX_LEVEL);
809 id->level = new_level;
811 spin_unlock_irqrestore(&id->lock,flags);
816 * proceed_active_entry:
817 * - set active entry to next in the ring buffer
821 proceed_active_entry(debug_info_t * id)
823 if ((id->active_entries[id->active_area] += id->entry_size)
824 > (PAGE_SIZE - id->entry_size)){
825 id->active_entries[id->active_area] = 0;
826 id->active_pages[id->active_area] =
827 (id->active_pages[id->active_area] + 1) %
833 * proceed_active_area:
834 * - set active area to next in the ring buffer
838 proceed_active_area(debug_info_t * id)
841 id->active_area = id->active_area % id->nr_areas;
848 static inline debug_entry_t*
849 get_active_entry(debug_info_t * id)
851 return (debug_entry_t *) (((char *) id->areas[id->active_area]
852 [id->active_pages[id->active_area]]) +
853 id->active_entries[id->active_area]);
857 * debug_finish_entry:
858 * - set timestamp, caller address, cpu number etc.
862 debug_finish_entry(debug_info_t * id, debug_entry_t* active, int level,
865 active->id.stck = get_clock();
866 active->id.fields.cpuid = smp_processor_id();
867 active->caller = __builtin_return_address(0);
868 active->id.fields.exception = exception;
869 active->id.fields.level = level;
870 proceed_active_entry(id);
872 proceed_active_area(id);
875 static int debug_stoppable=1;
876 static int debug_active=1;
878 #define CTL_S390DBF_STOPPABLE 5678
879 #define CTL_S390DBF_ACTIVE 5679
882 * proc handler for the running debug_active sysctl
883 * always allow read, allow write only if debug_stoppable is set or
884 * if debug_active is already off
887 s390dbf_procactive(ctl_table *table, int write,
888 void __user *buffer, size_t *lenp, loff_t *ppos)
890 if (!write || debug_stoppable || !debug_active)
891 return proc_dointvec(table, write, buffer, lenp, ppos);
897 static struct ctl_table s390dbf_table[] = {
899 .procname = "debug_stoppable",
900 .data = &debug_stoppable,
901 .maxlen = sizeof(int),
902 .mode = S_IRUGO | S_IWUSR,
903 .proc_handler = proc_dointvec,
906 .procname = "debug_active",
907 .data = &debug_active,
908 .maxlen = sizeof(int),
909 .mode = S_IRUGO | S_IWUSR,
910 .proc_handler = s390dbf_procactive,
915 static struct ctl_table s390dbf_dir_table[] = {
917 .procname = "s390dbf",
919 .mode = S_IRUGO | S_IXUGO,
920 .child = s390dbf_table,
925 static struct ctl_table_header *s390dbf_sysctl_header;
935 void debug_set_critical(void)
941 * debug_event_common:
942 * - write debug entry with given size
946 debug_event_common(debug_info_t * id, int level, const void *buf, int len)
949 debug_entry_t *active;
951 if (!debug_active || !id->areas)
953 if (debug_critical) {
954 if (!spin_trylock_irqsave(&id->lock, flags))
957 spin_lock_irqsave(&id->lock, flags);
958 active = get_active_entry(id);
959 memset(DEBUG_DATA(active), 0, id->buf_size);
960 memcpy(DEBUG_DATA(active), buf, min(len, id->buf_size));
961 debug_finish_entry(id, active, level, 0);
962 spin_unlock_irqrestore(&id->lock, flags);
968 * debug_exception_common:
969 * - write debug entry with given size and switch to next debug area
973 *debug_exception_common(debug_info_t * id, int level, const void *buf, int len)
976 debug_entry_t *active;
978 if (!debug_active || !id->areas)
980 if (debug_critical) {
981 if (!spin_trylock_irqsave(&id->lock, flags))
984 spin_lock_irqsave(&id->lock, flags);
985 active = get_active_entry(id);
986 memset(DEBUG_DATA(active), 0, id->buf_size);
987 memcpy(DEBUG_DATA(active), buf, min(len, id->buf_size));
988 debug_finish_entry(id, active, level, 1);
989 spin_unlock_irqrestore(&id->lock, flags);
995 * counts arguments in format string for sprintf view
999 debug_count_numargs(char *string)
1011 * debug_sprintf_event:
1015 debug_sprintf_event(debug_info_t* id, int level,char *string,...)
1019 unsigned long flags;
1020 debug_sprintf_entry_t *curr_event;
1021 debug_entry_t *active;
1023 if((!id) || (level > id->level))
1025 if (!debug_active || !id->areas)
1027 numargs=debug_count_numargs(string);
1029 if (debug_critical) {
1030 if (!spin_trylock_irqsave(&id->lock, flags))
1033 spin_lock_irqsave(&id->lock, flags);
1034 active = get_active_entry(id);
1035 curr_event=(debug_sprintf_entry_t *) DEBUG_DATA(active);
1036 va_start(ap,string);
1037 curr_event->string=string;
1038 for(idx=0;idx<min(numargs,(int)(id->buf_size / sizeof(long))-1);idx++)
1039 curr_event->args[idx]=va_arg(ap,long);
1041 debug_finish_entry(id, active, level, 0);
1042 spin_unlock_irqrestore(&id->lock, flags);
1048 * debug_sprintf_exception:
1052 debug_sprintf_exception(debug_info_t* id, int level,char *string,...)
1056 unsigned long flags;
1057 debug_sprintf_entry_t *curr_event;
1058 debug_entry_t *active;
1060 if((!id) || (level > id->level))
1062 if (!debug_active || !id->areas)
1065 numargs=debug_count_numargs(string);
1067 if (debug_critical) {
1068 if (!spin_trylock_irqsave(&id->lock, flags))
1071 spin_lock_irqsave(&id->lock, flags);
1072 active = get_active_entry(id);
1073 curr_event=(debug_sprintf_entry_t *)DEBUG_DATA(active);
1074 va_start(ap,string);
1075 curr_event->string=string;
1076 for(idx=0;idx<min(numargs,(int)(id->buf_size / sizeof(long))-1);idx++)
1077 curr_event->args[idx]=va_arg(ap,long);
1079 debug_finish_entry(id, active, level, 1);
1080 spin_unlock_irqrestore(&id->lock, flags);
1087 * - is called exactly once to initialize the debug feature
1091 __init debug_init(void)
1095 s390dbf_sysctl_header = register_sysctl_table(s390dbf_dir_table);
1096 mutex_lock(&debug_mutex);
1097 debug_debugfs_root_entry = debugfs_create_dir(DEBUG_DIR_ROOT,NULL);
1099 mutex_unlock(&debug_mutex);
1105 * debug_register_view:
1109 debug_register_view(debug_info_t * id, struct debug_view *view)
1113 unsigned long flags;
1119 mode = (id->mode | S_IFREG) & ~S_IXUGO;
1120 if (!(view->prolog_proc || view->format_proc || view->header_proc))
1121 mode &= ~(S_IRUSR | S_IRGRP | S_IROTH);
1122 if (!view->input_proc)
1123 mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
1124 pde = debugfs_create_file(view->name, mode, id->debugfs_root_entry,
1125 id , &debug_file_ops);
1127 pr_err("Registering view %s/%s failed due to out of "
1128 "memory\n", id->name,view->name);
1132 spin_lock_irqsave(&id->lock, flags);
1133 for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
1137 if (i == DEBUG_MAX_VIEWS) {
1138 pr_err("Registering view %s/%s would exceed the maximum "
1139 "number of views %i\n", id->name, view->name, i);
1140 debugfs_remove(pde);
1143 id->views[i] = view;
1144 id->debugfs_entries[i] = pde;
1146 spin_unlock_irqrestore(&id->lock, flags);
1152 * debug_unregister_view:
1156 debug_unregister_view(debug_info_t * id, struct debug_view *view)
1160 unsigned long flags;
1164 spin_lock_irqsave(&id->lock, flags);
1165 for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
1166 if (id->views[i] == view)
1169 if (i == DEBUG_MAX_VIEWS)
1172 debugfs_remove(id->debugfs_entries[i]);
1173 id->views[i] = NULL;
1175 spin_unlock_irqrestore(&id->lock, flags);
1180 static inline char *
1181 debug_get_user_string(const char __user *user_buf, size_t user_len)
1185 buffer = kmalloc(user_len + 1, GFP_KERNEL);
1187 return ERR_PTR(-ENOMEM);
1188 if (copy_from_user(buffer, user_buf, user_len) != 0) {
1190 return ERR_PTR(-EFAULT);
1192 /* got the string, now strip linefeed. */
1193 if (buffer[user_len - 1] == '\n')
1194 buffer[user_len - 1] = 0;
1196 buffer[user_len] = 0;
1201 debug_get_uint(char *buf)
1205 buf = skip_spaces(buf);
1206 rc = simple_strtoul(buf, &buf, 10);
1214 * functions for debug-views
1215 ***********************************
1219 * prints out actual debug level
1223 debug_prolog_pages_fn(debug_info_t * id,
1224 struct debug_view *view, char *out_buf)
1226 return sprintf(out_buf, "%i\n", id->pages_per_area);
1230 * reads new size (number of pages per debug area)
1234 debug_input_pages_fn(debug_info_t * id, struct debug_view *view,
1235 struct file *file, const char __user *user_buf,
1236 size_t user_len, loff_t * offset)
1241 if (user_len > 0x10000)
1247 str = debug_get_user_string(user_buf,user_len);
1252 new_pages = debug_get_uint(str);
1257 rc = debug_set_size(id,id->nr_areas, new_pages);
1266 *offset += user_len;
1267 return rc; /* number of input characters */
1271 * prints out actual debug level
1275 debug_prolog_level_fn(debug_info_t * id, struct debug_view *view, char *out_buf)
1279 if(id->level == DEBUG_OFF_LEVEL) {
1280 rc = sprintf(out_buf,"-\n");
1283 rc = sprintf(out_buf, "%i\n", id->level);
1289 * reads new debug level
1293 debug_input_level_fn(debug_info_t * id, struct debug_view *view,
1294 struct file *file, const char __user *user_buf,
1295 size_t user_len, loff_t * offset)
1300 if (user_len > 0x10000)
1306 str = debug_get_user_string(user_buf,user_len);
1312 debug_set_level(id, DEBUG_OFF_LEVEL);
1316 new_level = debug_get_uint(str);
1319 pr_warning("%s is not a valid level for a debug "
1323 debug_set_level(id, new_level);
1329 *offset += user_len;
1330 return rc; /* number of input characters */
1335 * flushes debug areas
1338 static void debug_flush(debug_info_t* id, int area)
1340 unsigned long flags;
1343 if(!id || !id->areas)
1345 spin_lock_irqsave(&id->lock,flags);
1346 if(area == DEBUG_FLUSH_ALL){
1347 id->active_area = 0;
1348 memset(id->active_entries, 0, id->nr_areas * sizeof(int));
1349 for (i = 0; i < id->nr_areas; i++) {
1350 id->active_pages[i] = 0;
1351 for(j = 0; j < id->pages_per_area; j++) {
1352 memset(id->areas[i][j], 0, PAGE_SIZE);
1355 } else if(area >= 0 && area < id->nr_areas) {
1356 id->active_entries[area] = 0;
1357 id->active_pages[area] = 0;
1358 for(i = 0; i < id->pages_per_area; i++) {
1359 memset(id->areas[area][i],0,PAGE_SIZE);
1362 spin_unlock_irqrestore(&id->lock,flags);
1366 * view function: flushes debug areas
1370 debug_input_flush_fn(debug_info_t * id, struct debug_view *view,
1371 struct file *file, const char __user *user_buf,
1372 size_t user_len, loff_t * offset)
1377 if (user_len > 0x10000)
1383 if (copy_from_user(input_buf, user_buf, 1)){
1387 if(input_buf[0] == '-') {
1388 debug_flush(id, DEBUG_FLUSH_ALL);
1391 if (isdigit(input_buf[0])) {
1392 int area = ((int) input_buf[0] - (int) '0');
1393 debug_flush(id, area);
1397 pr_info("Flushing debug data failed because %c is not a valid "
1398 "area\n", input_buf[0]);
1401 *offset += user_len;
1402 return rc; /* number of input characters */
1406 * prints debug header in raw format
1410 debug_raw_header_fn(debug_info_t * id, struct debug_view *view,
1411 int area, debug_entry_t * entry, char *out_buf)
1415 rc = sizeof(debug_entry_t);
1416 memcpy(out_buf,entry,sizeof(debug_entry_t));
1421 * prints debug data in raw format
1425 debug_raw_format_fn(debug_info_t * id, struct debug_view *view,
1426 char *out_buf, const char *in_buf)
1431 memcpy(out_buf, in_buf, id->buf_size);
1436 * prints debug data in hex/ascii format
1440 debug_hex_ascii_format_fn(debug_info_t * id, struct debug_view *view,
1441 char *out_buf, const char *in_buf)
1445 for (i = 0; i < id->buf_size; i++) {
1446 rc += sprintf(out_buf + rc, "%02x ",
1447 ((unsigned char *) in_buf)[i]);
1449 rc += sprintf(out_buf + rc, "| ");
1450 for (i = 0; i < id->buf_size; i++) {
1451 unsigned char c = in_buf[i];
1452 if (isascii(c) && isprint(c))
1453 rc += sprintf(out_buf + rc, "%c", c);
1455 rc += sprintf(out_buf + rc, ".");
1457 rc += sprintf(out_buf + rc, "\n");
1462 * prints header for debug entry
1466 debug_dflt_header_fn(debug_info_t * id, struct debug_view *view,
1467 int area, debug_entry_t * entry, char *out_buf)
1469 struct timespec time_spec;
1471 unsigned long caller;
1475 level = entry->id.fields.level;
1476 stck_to_timespec(entry->id.stck, &time_spec);
1478 if (entry->id.fields.exception)
1482 caller = ((unsigned long) entry->caller) & PSW_ADDR_INSN;
1483 rc += sprintf(out_buf, "%02i %011lu:%06lu %1u %1s %02i %p ",
1484 area, time_spec.tv_sec, time_spec.tv_nsec / 1000, level,
1485 except_str, entry->id.fields.cpuid, (void *) caller);
1490 * prints debug data sprintf-formated:
1491 * debug_sprinf_event/exception calls must be used together with this view
1494 #define DEBUG_SPRINTF_MAX_ARGS 10
1497 debug_sprintf_format_fn(debug_info_t * id, struct debug_view *view,
1498 char *out_buf, debug_sprintf_entry_t *curr_event)
1500 int num_longs, num_used_args = 0,i, rc = 0;
1501 int index[DEBUG_SPRINTF_MAX_ARGS];
1503 /* count of longs fit into one entry */
1504 num_longs = id->buf_size / sizeof(long);
1507 goto out; /* bufsize of entry too small */
1508 if(num_longs == 1) {
1509 /* no args, we use only the string */
1510 strcpy(out_buf, curr_event->string);
1511 rc = strlen(curr_event->string);
1515 /* number of arguments used for sprintf (without the format string) */
1516 num_used_args = min(DEBUG_SPRINTF_MAX_ARGS, (num_longs - 1));
1518 memset(index,0, DEBUG_SPRINTF_MAX_ARGS * sizeof(int));
1520 for(i = 0; i < num_used_args; i++)
1523 rc = sprintf(out_buf, curr_event->string, curr_event->args[index[0]],
1524 curr_event->args[index[1]], curr_event->args[index[2]],
1525 curr_event->args[index[3]], curr_event->args[index[4]],
1526 curr_event->args[index[5]], curr_event->args[index[6]],
1527 curr_event->args[index[7]], curr_event->args[index[8]],
1528 curr_event->args[index[9]]);
1538 static void __exit debug_exit(void)
1540 debugfs_remove(debug_debugfs_root_entry);
1541 unregister_sysctl_table(s390dbf_sysctl_header);
1546 * module definitions
1548 postcore_initcall(debug_init);
1549 module_exit(debug_exit);
1550 MODULE_LICENSE("GPL");
1552 EXPORT_SYMBOL(debug_register);
1553 EXPORT_SYMBOL(debug_unregister);
1554 EXPORT_SYMBOL(debug_set_level);
1555 EXPORT_SYMBOL(debug_stop_all);
1556 EXPORT_SYMBOL(debug_register_view);
1557 EXPORT_SYMBOL(debug_unregister_view);
1558 EXPORT_SYMBOL(debug_event_common);
1559 EXPORT_SYMBOL(debug_exception_common);
1560 EXPORT_SYMBOL(debug_hex_ascii_view);
1561 EXPORT_SYMBOL(debug_raw_view);
1562 EXPORT_SYMBOL(debug_dflt_header_fn);
1563 EXPORT_SYMBOL(debug_sprintf_view);
1564 EXPORT_SYMBOL(debug_sprintf_exception);
1565 EXPORT_SYMBOL(debug_sprintf_event);