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
,
113 EXPORT_SYMBOL(debug_raw_view
);
115 struct debug_view debug_hex_ascii_view
= {
118 &debug_dflt_header_fn
,
119 &debug_hex_ascii_format_fn
,
123 EXPORT_SYMBOL(debug_hex_ascii_view
);
125 static struct debug_view debug_level_view
= {
127 &debug_prolog_level_fn
,
130 &debug_input_level_fn
,
134 static struct debug_view debug_pages_view
= {
136 &debug_prolog_pages_fn
,
139 &debug_input_pages_fn
,
143 static struct debug_view debug_flush_view
= {
148 &debug_input_flush_fn
,
152 struct debug_view debug_sprintf_view
= {
155 &debug_dflt_header_fn
,
156 (debug_format_proc_t
*)&debug_sprintf_format_fn
,
160 EXPORT_SYMBOL(debug_sprintf_view
);
162 /* used by dump analysis tools to determine version of debug feature */
163 static unsigned int __used debug_feature_version
= __DEBUG_FEATURE_VERSION
;
167 static debug_info_t
*debug_area_first
= NULL
;
168 static debug_info_t
*debug_area_last
= NULL
;
169 static DEFINE_MUTEX(debug_mutex
);
171 static int initialized
;
172 static int debug_critical
;
174 static const struct file_operations debug_file_ops
= {
175 .owner
= THIS_MODULE
,
176 .read
= debug_output
,
177 .write
= debug_input
,
179 .release
= debug_close
,
183 static struct dentry
*debug_debugfs_root_entry
;
189 * - Debug areas are implemented as a threedimensonal array:
190 * areas[areanumber][pagenumber][pageoffset]
193 static debug_entry_t
***
194 debug_areas_alloc(int pages_per_area
, int nr_areas
)
196 debug_entry_t
*** areas
;
199 areas
= kmalloc(nr_areas
*
200 sizeof(debug_entry_t
**),
203 goto fail_malloc_areas
;
204 for (i
= 0; i
< nr_areas
; i
++) {
205 areas
[i
] = kmalloc(pages_per_area
*
206 sizeof(debug_entry_t
*),GFP_KERNEL
);
208 goto fail_malloc_areas2
;
210 for(j
= 0; j
< pages_per_area
; j
++) {
211 areas
[i
][j
] = kzalloc(PAGE_SIZE
, GFP_KERNEL
);
213 for(j
--; j
>=0 ; j
--) {
217 goto fail_malloc_areas2
;
224 for(i
--; i
>= 0; i
--){
225 for(j
=0; j
< pages_per_area
;j
++){
239 * - alloc new debug-info
243 debug_info_alloc(const char *name
, int pages_per_area
, int nr_areas
,
244 int buf_size
, int level
, int mode
)
248 /* alloc everything */
250 rc
= kmalloc(sizeof(debug_info_t
), GFP_KERNEL
);
253 rc
->active_entries
= kcalloc(nr_areas
, sizeof(int), GFP_KERNEL
);
254 if(!rc
->active_entries
)
255 goto fail_malloc_active_entries
;
256 rc
->active_pages
= kcalloc(nr_areas
, sizeof(int), GFP_KERNEL
);
257 if(!rc
->active_pages
)
258 goto fail_malloc_active_pages
;
259 if((mode
== ALL_AREAS
) && (pages_per_area
!= 0)){
260 rc
->areas
= debug_areas_alloc(pages_per_area
, nr_areas
);
262 goto fail_malloc_areas
;
267 /* initialize members */
269 spin_lock_init(&rc
->lock
);
270 rc
->pages_per_area
= pages_per_area
;
271 rc
->nr_areas
= nr_areas
;
274 rc
->buf_size
= buf_size
;
275 rc
->entry_size
= sizeof(debug_entry_t
) + buf_size
;
276 strlcpy(rc
->name
, name
, sizeof(rc
->name
));
277 memset(rc
->views
, 0, DEBUG_MAX_VIEWS
* sizeof(struct debug_view
*));
278 memset(rc
->debugfs_entries
, 0 ,DEBUG_MAX_VIEWS
*
279 sizeof(struct dentry
*));
280 atomic_set(&(rc
->ref_count
), 0);
285 kfree(rc
->active_pages
);
286 fail_malloc_active_pages
:
287 kfree(rc
->active_entries
);
288 fail_malloc_active_entries
:
296 * - free all debug areas
300 debug_areas_free(debug_info_t
* db_info
)
306 for (i
= 0; i
< db_info
->nr_areas
; i
++) {
307 for(j
= 0; j
< db_info
->pages_per_area
; j
++) {
308 kfree(db_info
->areas
[i
][j
]);
310 kfree(db_info
->areas
[i
]);
312 kfree(db_info
->areas
);
313 db_info
->areas
= NULL
;
318 * - free memory debug-info
322 debug_info_free(debug_info_t
* db_info
){
323 debug_areas_free(db_info
);
324 kfree(db_info
->active_entries
);
325 kfree(db_info
->active_pages
);
331 * - create new debug-info
335 debug_info_create(const char *name
, int pages_per_area
, int nr_areas
,
336 int buf_size
, umode_t mode
)
340 rc
= debug_info_alloc(name
, pages_per_area
, nr_areas
, buf_size
,
341 DEBUG_DEFAULT_LEVEL
, ALL_AREAS
);
345 rc
->mode
= mode
& ~S_IFMT
;
347 /* create root directory */
348 rc
->debugfs_root_entry
= debugfs_create_dir(rc
->name
,
349 debug_debugfs_root_entry
);
351 /* append new element to linked list */
352 if (!debug_area_first
) {
353 /* first element in list */
354 debug_area_first
= rc
;
357 /* append element to end of list */
358 debug_area_last
->next
= rc
;
359 rc
->prev
= debug_area_last
;
361 debug_area_last
= rc
;
375 debug_info_copy(debug_info_t
* in
, int mode
)
381 /* get a consistent copy of the debug areas */
383 rc
= debug_info_alloc(in
->name
, in
->pages_per_area
,
384 in
->nr_areas
, in
->buf_size
, in
->level
, mode
);
385 spin_lock_irqsave(&in
->lock
, flags
);
388 /* has something changed in the meantime ? */
389 if((rc
->pages_per_area
== in
->pages_per_area
) &&
390 (rc
->nr_areas
== in
->nr_areas
)) {
393 spin_unlock_irqrestore(&in
->lock
, flags
);
397 if (mode
== NO_AREAS
)
400 for(i
= 0; i
< in
->nr_areas
; i
++){
401 for(j
= 0; j
< in
->pages_per_area
; j
++) {
402 memcpy(rc
->areas
[i
][j
], in
->areas
[i
][j
],PAGE_SIZE
);
406 spin_unlock_irqrestore(&in
->lock
, flags
);
412 * - increments reference count for debug-info
416 debug_info_get(debug_info_t
* db_info
)
419 atomic_inc(&db_info
->ref_count
);
424 * - decreases reference count for debug-info and frees it if necessary
428 debug_info_put(debug_info_t
*db_info
)
434 if (atomic_dec_and_test(&db_info
->ref_count
)) {
435 for (i
= 0; i
< DEBUG_MAX_VIEWS
; i
++) {
436 if (!db_info
->views
[i
])
438 debugfs_remove(db_info
->debugfs_entries
[i
]);
440 debugfs_remove(db_info
->debugfs_root_entry
);
441 if(db_info
== debug_area_first
)
442 debug_area_first
= db_info
->next
;
443 if(db_info
== debug_area_last
)
444 debug_area_last
= db_info
->prev
;
445 if(db_info
->prev
) db_info
->prev
->next
= db_info
->next
;
446 if(db_info
->next
) db_info
->next
->prev
= db_info
->prev
;
447 debug_info_free(db_info
);
452 * debug_format_entry:
453 * - format one debug entry and return size of formated data
457 debug_format_entry(file_private_info_t
*p_info
)
459 debug_info_t
*id_snap
= p_info
->debug_info_snap
;
460 struct debug_view
*view
= p_info
->view
;
461 debug_entry_t
*act_entry
;
463 if(p_info
->act_entry
== DEBUG_PROLOG_ENTRY
){
465 if (view
->prolog_proc
)
466 len
+= view
->prolog_proc(id_snap
,view
,p_info
->temp_buf
);
469 if (!id_snap
->areas
) /* this is true, if we have a prolog only view */
470 goto out
; /* or if 'pages_per_area' is 0 */
471 act_entry
= (debug_entry_t
*) ((char*)id_snap
->areas
[p_info
->act_area
]
472 [p_info
->act_page
] + p_info
->act_entry
);
474 if (act_entry
->id
.stck
== 0LL)
475 goto out
; /* empty entry */
476 if (view
->header_proc
)
477 len
+= view
->header_proc(id_snap
, view
, p_info
->act_area
,
478 act_entry
, p_info
->temp_buf
+ len
);
479 if (view
->format_proc
)
480 len
+= view
->format_proc(id_snap
, view
, p_info
->temp_buf
+ len
,
481 DEBUG_DATA(act_entry
));
488 * - goto next entry in p_info
492 debug_next_entry(file_private_info_t
*p_info
)
496 id
= p_info
->debug_info_snap
;
497 if(p_info
->act_entry
== DEBUG_PROLOG_ENTRY
){
498 p_info
->act_entry
= 0;
499 p_info
->act_page
= 0;
504 p_info
->act_entry
+= id
->entry_size
;
505 /* switch to next page, if we reached the end of the page */
506 if (p_info
->act_entry
> (PAGE_SIZE
- id
->entry_size
)){
508 p_info
->act_entry
= 0;
509 p_info
->act_page
+= 1;
510 if((p_info
->act_page
% id
->pages_per_area
) == 0) {
515 if(p_info
->act_area
>= id
->nr_areas
)
524 * - called for user read()
525 * - copies formated debug entries to the user buffer
529 debug_output(struct file
*file
, /* file descriptor */
530 char __user
*user_buf
, /* user buffer */
531 size_t len
, /* length of buffer */
532 loff_t
*offset
) /* offset in the file */
536 file_private_info_t
*p_info
;
538 p_info
= ((file_private_info_t
*) file
->private_data
);
539 if (*offset
!= p_info
->offset
)
541 if(p_info
->act_area
>= p_info
->debug_info_snap
->nr_areas
)
543 entry_offset
= p_info
->act_entry_offset
;
545 int formatted_line_size
;
546 int formatted_line_residue
;
547 int user_buf_residue
;
550 formatted_line_size
= debug_format_entry(p_info
);
551 formatted_line_residue
= formatted_line_size
- entry_offset
;
552 user_buf_residue
= len
-count
;
553 copy_size
= min(user_buf_residue
, formatted_line_residue
);
555 if (copy_to_user(user_buf
+ count
, p_info
->temp_buf
556 + entry_offset
, copy_size
))
559 entry_offset
+= copy_size
;
561 if(copy_size
== formatted_line_residue
){
563 if(debug_next_entry(p_info
))
568 p_info
->offset
= *offset
+ count
;
569 p_info
->act_entry_offset
= entry_offset
;
570 *offset
= p_info
->offset
;
576 * - called for user write()
577 * - calls input function of view
581 debug_input(struct file
*file
, const char __user
*user_buf
, size_t length
,
585 file_private_info_t
*p_info
;
587 mutex_lock(&debug_mutex
);
588 p_info
= ((file_private_info_t
*) file
->private_data
);
589 if (p_info
->view
->input_proc
)
590 rc
= p_info
->view
->input_proc(p_info
->debug_info_org
,
591 p_info
->view
, file
, user_buf
,
595 mutex_unlock(&debug_mutex
);
596 return rc
; /* number of input characters */
601 * - called for user open()
602 * - copies formated output to private_data area of the file
607 debug_open(struct inode
*inode
, struct file
*file
)
610 file_private_info_t
*p_info
;
611 debug_info_t
*debug_info
, *debug_info_snapshot
;
613 mutex_lock(&debug_mutex
);
614 debug_info
= file_inode(file
)->i_private
;
615 /* find debug view */
616 for (i
= 0; i
< DEBUG_MAX_VIEWS
; i
++) {
617 if (!debug_info
->views
[i
])
619 else if (debug_info
->debugfs_entries
[i
] ==
620 file
->f_path
.dentry
) {
621 goto found
; /* found view ! */
630 /* Make snapshot of current debug areas to get it consistent. */
631 /* To copy all the areas is only needed, if we have a view which */
632 /* formats the debug areas. */
634 if(!debug_info
->views
[i
]->format_proc
&&
635 !debug_info
->views
[i
]->header_proc
){
636 debug_info_snapshot
= debug_info_copy(debug_info
, NO_AREAS
);
638 debug_info_snapshot
= debug_info_copy(debug_info
, ALL_AREAS
);
641 if(!debug_info_snapshot
){
645 p_info
= kmalloc(sizeof(file_private_info_t
),
648 debug_info_free(debug_info_snapshot
);
653 p_info
->debug_info_snap
= debug_info_snapshot
;
654 p_info
->debug_info_org
= debug_info
;
655 p_info
->view
= debug_info
->views
[i
];
656 p_info
->act_area
= 0;
657 p_info
->act_page
= 0;
658 p_info
->act_entry
= DEBUG_PROLOG_ENTRY
;
659 p_info
->act_entry_offset
= 0;
660 file
->private_data
= p_info
;
661 debug_info_get(debug_info
);
662 nonseekable_open(inode
, file
);
664 mutex_unlock(&debug_mutex
);
670 * - called for user close()
671 * - deletes private_data area of the file handle
675 debug_close(struct inode
*inode
, struct file
*file
)
677 file_private_info_t
*p_info
;
678 p_info
= (file_private_info_t
*) file
->private_data
;
679 if(p_info
->debug_info_snap
)
680 debug_info_free(p_info
->debug_info_snap
);
681 debug_info_put(p_info
->debug_info_org
);
682 kfree(file
->private_data
);
683 return 0; /* success */
687 * debug_register_mode:
688 * - Creates and initializes debug area for the caller
689 * The mode parameter allows to specify access rights for the s390dbf files
690 * - Returns handle for debug area
693 debug_info_t
*debug_register_mode(const char *name
, int pages_per_area
,
694 int nr_areas
, int buf_size
, umode_t mode
,
695 uid_t uid
, gid_t gid
)
697 debug_info_t
*rc
= NULL
;
699 /* Since debugfs currently does not support uid/gid other than root, */
700 /* we do not allow gid/uid != 0 until we get support for that. */
701 if ((uid
!= 0) || (gid
!= 0))
702 pr_warning("Root becomes the owner of all s390dbf files "
704 BUG_ON(!initialized
);
705 mutex_lock(&debug_mutex
);
707 /* create new debug_info */
709 rc
= debug_info_create(name
, pages_per_area
, nr_areas
, buf_size
, mode
);
712 debug_register_view(rc
, &debug_level_view
);
713 debug_register_view(rc
, &debug_flush_view
);
714 debug_register_view(rc
, &debug_pages_view
);
717 pr_err("Registering debug feature %s failed\n", name
);
719 mutex_unlock(&debug_mutex
);
722 EXPORT_SYMBOL(debug_register_mode
);
726 * - creates and initializes debug area for the caller
727 * - returns handle for debug area
730 debug_info_t
*debug_register(const char *name
, int pages_per_area
,
731 int nr_areas
, int buf_size
)
733 return debug_register_mode(name
, pages_per_area
, nr_areas
, buf_size
,
734 S_IRUSR
| S_IWUSR
, 0, 0);
736 EXPORT_SYMBOL(debug_register
);
740 * - give back debug area
744 debug_unregister(debug_info_t
* id
)
748 mutex_lock(&debug_mutex
);
750 mutex_unlock(&debug_mutex
);
755 EXPORT_SYMBOL(debug_unregister
);
759 * - set area size (number of pages) and number of areas
762 debug_set_size(debug_info_t
* id
, int nr_areas
, int pages_per_area
)
765 debug_entry_t
*** new_areas
;
768 if(!id
|| (nr_areas
<= 0) || (pages_per_area
< 0))
770 if(pages_per_area
> 0){
771 new_areas
= debug_areas_alloc(pages_per_area
, nr_areas
);
773 pr_info("Allocating memory for %i pages failed\n",
781 spin_lock_irqsave(&id
->lock
,flags
);
782 debug_areas_free(id
);
783 id
->areas
= new_areas
;
784 id
->nr_areas
= nr_areas
;
785 id
->pages_per_area
= pages_per_area
;
787 memset(id
->active_entries
,0,sizeof(int)*id
->nr_areas
);
788 memset(id
->active_pages
, 0, sizeof(int)*id
->nr_areas
);
789 spin_unlock_irqrestore(&id
->lock
,flags
);
790 pr_info("%s: set new size (%i pages)\n" ,id
->name
, pages_per_area
);
797 * - set actual debug level
801 debug_set_level(debug_info_t
* id
, int new_level
)
806 spin_lock_irqsave(&id
->lock
,flags
);
807 if(new_level
== DEBUG_OFF_LEVEL
){
808 id
->level
= DEBUG_OFF_LEVEL
;
809 pr_info("%s: switched off\n",id
->name
);
810 } else if ((new_level
> DEBUG_MAX_LEVEL
) || (new_level
< 0)) {
811 pr_info("%s: level %i is out of range (%i - %i)\n",
812 id
->name
, new_level
, 0, DEBUG_MAX_LEVEL
);
814 id
->level
= new_level
;
816 spin_unlock_irqrestore(&id
->lock
,flags
);
818 EXPORT_SYMBOL(debug_set_level
);
821 * proceed_active_entry:
822 * - set active entry to next in the ring buffer
826 proceed_active_entry(debug_info_t
* id
)
828 if ((id
->active_entries
[id
->active_area
] += id
->entry_size
)
829 > (PAGE_SIZE
- id
->entry_size
)){
830 id
->active_entries
[id
->active_area
] = 0;
831 id
->active_pages
[id
->active_area
] =
832 (id
->active_pages
[id
->active_area
] + 1) %
838 * proceed_active_area:
839 * - set active area to next in the ring buffer
843 proceed_active_area(debug_info_t
* id
)
846 id
->active_area
= id
->active_area
% id
->nr_areas
;
853 static inline debug_entry_t
*
854 get_active_entry(debug_info_t
* id
)
856 return (debug_entry_t
*) (((char *) id
->areas
[id
->active_area
]
857 [id
->active_pages
[id
->active_area
]]) +
858 id
->active_entries
[id
->active_area
]);
862 * debug_finish_entry:
863 * - set timestamp, caller address, cpu number etc.
867 debug_finish_entry(debug_info_t
* id
, debug_entry_t
* active
, int level
,
870 active
->id
.stck
= get_tod_clock_fast();
871 active
->id
.fields
.cpuid
= smp_processor_id();
872 active
->caller
= __builtin_return_address(0);
873 active
->id
.fields
.exception
= exception
;
874 active
->id
.fields
.level
= level
;
875 proceed_active_entry(id
);
877 proceed_active_area(id
);
880 static int debug_stoppable
=1;
881 static int debug_active
=1;
883 #define CTL_S390DBF_STOPPABLE 5678
884 #define CTL_S390DBF_ACTIVE 5679
887 * proc handler for the running debug_active sysctl
888 * always allow read, allow write only if debug_stoppable is set or
889 * if debug_active is already off
892 s390dbf_procactive(struct ctl_table
*table
, int write
,
893 void __user
*buffer
, size_t *lenp
, loff_t
*ppos
)
895 if (!write
|| debug_stoppable
|| !debug_active
)
896 return proc_dointvec(table
, write
, buffer
, lenp
, ppos
);
902 static struct ctl_table s390dbf_table
[] = {
904 .procname
= "debug_stoppable",
905 .data
= &debug_stoppable
,
906 .maxlen
= sizeof(int),
907 .mode
= S_IRUGO
| S_IWUSR
,
908 .proc_handler
= proc_dointvec
,
911 .procname
= "debug_active",
912 .data
= &debug_active
,
913 .maxlen
= sizeof(int),
914 .mode
= S_IRUGO
| S_IWUSR
,
915 .proc_handler
= s390dbf_procactive
,
920 static struct ctl_table s390dbf_dir_table
[] = {
922 .procname
= "s390dbf",
924 .mode
= S_IRUGO
| S_IXUGO
,
925 .child
= s390dbf_table
,
930 static struct ctl_table_header
*s390dbf_sysctl_header
;
938 EXPORT_SYMBOL(debug_stop_all
);
940 void debug_set_critical(void)
946 * debug_event_common:
947 * - write debug entry with given size
951 debug_event_common(debug_info_t
* id
, int level
, const void *buf
, int len
)
954 debug_entry_t
*active
;
956 if (!debug_active
|| !id
->areas
)
958 if (debug_critical
) {
959 if (!spin_trylock_irqsave(&id
->lock
, flags
))
962 spin_lock_irqsave(&id
->lock
, flags
);
963 active
= get_active_entry(id
);
964 memset(DEBUG_DATA(active
), 0, id
->buf_size
);
965 memcpy(DEBUG_DATA(active
), buf
, min(len
, id
->buf_size
));
966 debug_finish_entry(id
, active
, level
, 0);
967 spin_unlock_irqrestore(&id
->lock
, flags
);
971 EXPORT_SYMBOL(debug_event_common
);
974 * debug_exception_common:
975 * - write debug entry with given size and switch to next debug area
979 *debug_exception_common(debug_info_t
* id
, int level
, const void *buf
, int len
)
982 debug_entry_t
*active
;
984 if (!debug_active
|| !id
->areas
)
986 if (debug_critical
) {
987 if (!spin_trylock_irqsave(&id
->lock
, flags
))
990 spin_lock_irqsave(&id
->lock
, flags
);
991 active
= get_active_entry(id
);
992 memset(DEBUG_DATA(active
), 0, id
->buf_size
);
993 memcpy(DEBUG_DATA(active
), buf
, min(len
, id
->buf_size
));
994 debug_finish_entry(id
, active
, level
, 1);
995 spin_unlock_irqrestore(&id
->lock
, flags
);
999 EXPORT_SYMBOL(debug_exception_common
);
1002 * counts arguments in format string for sprintf view
1006 debug_count_numargs(char *string
)
1018 * debug_sprintf_event:
1022 debug_sprintf_event(debug_info_t
* id
, int level
,char *string
,...)
1026 unsigned long flags
;
1027 debug_sprintf_entry_t
*curr_event
;
1028 debug_entry_t
*active
;
1030 if((!id
) || (level
> id
->level
))
1032 if (!debug_active
|| !id
->areas
)
1034 numargs
=debug_count_numargs(string
);
1036 if (debug_critical
) {
1037 if (!spin_trylock_irqsave(&id
->lock
, flags
))
1040 spin_lock_irqsave(&id
->lock
, flags
);
1041 active
= get_active_entry(id
);
1042 curr_event
=(debug_sprintf_entry_t
*) DEBUG_DATA(active
);
1043 va_start(ap
,string
);
1044 curr_event
->string
=string
;
1045 for(idx
=0;idx
<min(numargs
,(int)(id
->buf_size
/ sizeof(long))-1);idx
++)
1046 curr_event
->args
[idx
]=va_arg(ap
,long);
1048 debug_finish_entry(id
, active
, level
, 0);
1049 spin_unlock_irqrestore(&id
->lock
, flags
);
1053 EXPORT_SYMBOL(debug_sprintf_event
);
1056 * debug_sprintf_exception:
1060 debug_sprintf_exception(debug_info_t
* id
, int level
,char *string
,...)
1064 unsigned long flags
;
1065 debug_sprintf_entry_t
*curr_event
;
1066 debug_entry_t
*active
;
1068 if((!id
) || (level
> id
->level
))
1070 if (!debug_active
|| !id
->areas
)
1073 numargs
=debug_count_numargs(string
);
1075 if (debug_critical
) {
1076 if (!spin_trylock_irqsave(&id
->lock
, flags
))
1079 spin_lock_irqsave(&id
->lock
, flags
);
1080 active
= get_active_entry(id
);
1081 curr_event
=(debug_sprintf_entry_t
*)DEBUG_DATA(active
);
1082 va_start(ap
,string
);
1083 curr_event
->string
=string
;
1084 for(idx
=0;idx
<min(numargs
,(int)(id
->buf_size
/ sizeof(long))-1);idx
++)
1085 curr_event
->args
[idx
]=va_arg(ap
,long);
1087 debug_finish_entry(id
, active
, level
, 1);
1088 spin_unlock_irqrestore(&id
->lock
, flags
);
1092 EXPORT_SYMBOL(debug_sprintf_exception
);
1095 * debug_register_view:
1099 debug_register_view(debug_info_t
* id
, struct debug_view
*view
)
1103 unsigned long flags
;
1109 mode
= (id
->mode
| S_IFREG
) & ~S_IXUGO
;
1110 if (!(view
->prolog_proc
|| view
->format_proc
|| view
->header_proc
))
1111 mode
&= ~(S_IRUSR
| S_IRGRP
| S_IROTH
);
1112 if (!view
->input_proc
)
1113 mode
&= ~(S_IWUSR
| S_IWGRP
| S_IWOTH
);
1114 pde
= debugfs_create_file(view
->name
, mode
, id
->debugfs_root_entry
,
1115 id
, &debug_file_ops
);
1117 pr_err("Registering view %s/%s failed due to out of "
1118 "memory\n", id
->name
,view
->name
);
1122 spin_lock_irqsave(&id
->lock
, flags
);
1123 for (i
= 0; i
< DEBUG_MAX_VIEWS
; i
++) {
1127 if (i
== DEBUG_MAX_VIEWS
) {
1128 pr_err("Registering view %s/%s would exceed the maximum "
1129 "number of views %i\n", id
->name
, view
->name
, i
);
1132 id
->views
[i
] = view
;
1133 id
->debugfs_entries
[i
] = pde
;
1135 spin_unlock_irqrestore(&id
->lock
, flags
);
1137 debugfs_remove(pde
);
1141 EXPORT_SYMBOL(debug_register_view
);
1144 * debug_unregister_view:
1148 debug_unregister_view(debug_info_t
* id
, struct debug_view
*view
)
1150 struct dentry
*dentry
= NULL
;
1151 unsigned long flags
;
1156 spin_lock_irqsave(&id
->lock
, flags
);
1157 for (i
= 0; i
< DEBUG_MAX_VIEWS
; i
++) {
1158 if (id
->views
[i
] == view
)
1161 if (i
== DEBUG_MAX_VIEWS
)
1164 dentry
= id
->debugfs_entries
[i
];
1165 id
->views
[i
] = NULL
;
1166 id
->debugfs_entries
[i
] = NULL
;
1168 spin_unlock_irqrestore(&id
->lock
, flags
);
1169 debugfs_remove(dentry
);
1173 EXPORT_SYMBOL(debug_unregister_view
);
1175 static inline char *
1176 debug_get_user_string(const char __user
*user_buf
, size_t user_len
)
1180 buffer
= kmalloc(user_len
+ 1, GFP_KERNEL
);
1182 return ERR_PTR(-ENOMEM
);
1183 if (copy_from_user(buffer
, user_buf
, user_len
) != 0) {
1185 return ERR_PTR(-EFAULT
);
1187 /* got the string, now strip linefeed. */
1188 if (buffer
[user_len
- 1] == '\n')
1189 buffer
[user_len
- 1] = 0;
1191 buffer
[user_len
] = 0;
1196 debug_get_uint(char *buf
)
1200 buf
= skip_spaces(buf
);
1201 rc
= simple_strtoul(buf
, &buf
, 10);
1209 * functions for debug-views
1210 ***********************************
1214 * prints out actual debug level
1218 debug_prolog_pages_fn(debug_info_t
* id
,
1219 struct debug_view
*view
, char *out_buf
)
1221 return sprintf(out_buf
, "%i\n", id
->pages_per_area
);
1225 * reads new size (number of pages per debug area)
1229 debug_input_pages_fn(debug_info_t
* id
, struct debug_view
*view
,
1230 struct file
*file
, const char __user
*user_buf
,
1231 size_t user_len
, loff_t
* offset
)
1236 if (user_len
> 0x10000)
1242 str
= debug_get_user_string(user_buf
,user_len
);
1247 new_pages
= debug_get_uint(str
);
1252 rc
= debug_set_size(id
,id
->nr_areas
, new_pages
);
1261 *offset
+= user_len
;
1262 return rc
; /* number of input characters */
1266 * prints out actual debug level
1270 debug_prolog_level_fn(debug_info_t
* id
, struct debug_view
*view
, char *out_buf
)
1274 if(id
->level
== DEBUG_OFF_LEVEL
) {
1275 rc
= sprintf(out_buf
,"-\n");
1278 rc
= sprintf(out_buf
, "%i\n", id
->level
);
1284 * reads new debug level
1288 debug_input_level_fn(debug_info_t
* id
, struct debug_view
*view
,
1289 struct file
*file
, const char __user
*user_buf
,
1290 size_t user_len
, loff_t
* offset
)
1295 if (user_len
> 0x10000)
1301 str
= debug_get_user_string(user_buf
,user_len
);
1307 debug_set_level(id
, DEBUG_OFF_LEVEL
);
1311 new_level
= debug_get_uint(str
);
1314 pr_warning("%s is not a valid level for a debug "
1318 debug_set_level(id
, new_level
);
1324 *offset
+= user_len
;
1325 return rc
; /* number of input characters */
1330 * flushes debug areas
1333 static void debug_flush(debug_info_t
* id
, int area
)
1335 unsigned long flags
;
1338 if(!id
|| !id
->areas
)
1340 spin_lock_irqsave(&id
->lock
,flags
);
1341 if(area
== DEBUG_FLUSH_ALL
){
1342 id
->active_area
= 0;
1343 memset(id
->active_entries
, 0, id
->nr_areas
* sizeof(int));
1344 for (i
= 0; i
< id
->nr_areas
; i
++) {
1345 id
->active_pages
[i
] = 0;
1346 for(j
= 0; j
< id
->pages_per_area
; j
++) {
1347 memset(id
->areas
[i
][j
], 0, PAGE_SIZE
);
1350 } else if(area
>= 0 && area
< id
->nr_areas
) {
1351 id
->active_entries
[area
] = 0;
1352 id
->active_pages
[area
] = 0;
1353 for(i
= 0; i
< id
->pages_per_area
; i
++) {
1354 memset(id
->areas
[area
][i
],0,PAGE_SIZE
);
1357 spin_unlock_irqrestore(&id
->lock
,flags
);
1361 * view function: flushes debug areas
1365 debug_input_flush_fn(debug_info_t
* id
, struct debug_view
*view
,
1366 struct file
*file
, const char __user
*user_buf
,
1367 size_t user_len
, loff_t
* offset
)
1372 if (user_len
> 0x10000)
1378 if (copy_from_user(input_buf
, user_buf
, 1)){
1382 if(input_buf
[0] == '-') {
1383 debug_flush(id
, DEBUG_FLUSH_ALL
);
1386 if (isdigit(input_buf
[0])) {
1387 int area
= ((int) input_buf
[0] - (int) '0');
1388 debug_flush(id
, area
);
1392 pr_info("Flushing debug data failed because %c is not a valid "
1393 "area\n", input_buf
[0]);
1396 *offset
+= user_len
;
1397 return rc
; /* number of input characters */
1401 * prints debug header in raw format
1405 debug_raw_header_fn(debug_info_t
* id
, struct debug_view
*view
,
1406 int area
, debug_entry_t
* entry
, char *out_buf
)
1410 rc
= sizeof(debug_entry_t
);
1411 memcpy(out_buf
,entry
,sizeof(debug_entry_t
));
1416 * prints debug data in raw format
1420 debug_raw_format_fn(debug_info_t
* id
, struct debug_view
*view
,
1421 char *out_buf
, const char *in_buf
)
1426 memcpy(out_buf
, in_buf
, id
->buf_size
);
1431 * prints debug data in hex/ascii format
1435 debug_hex_ascii_format_fn(debug_info_t
* id
, struct debug_view
*view
,
1436 char *out_buf
, const char *in_buf
)
1440 for (i
= 0; i
< id
->buf_size
; i
++) {
1441 rc
+= sprintf(out_buf
+ rc
, "%02x ",
1442 ((unsigned char *) in_buf
)[i
]);
1444 rc
+= sprintf(out_buf
+ rc
, "| ");
1445 for (i
= 0; i
< id
->buf_size
; i
++) {
1446 unsigned char c
= in_buf
[i
];
1447 if (isascii(c
) && isprint(c
))
1448 rc
+= sprintf(out_buf
+ rc
, "%c", c
);
1450 rc
+= sprintf(out_buf
+ rc
, ".");
1452 rc
+= sprintf(out_buf
+ rc
, "\n");
1457 * prints header for debug entry
1461 debug_dflt_header_fn(debug_info_t
* id
, struct debug_view
*view
,
1462 int area
, debug_entry_t
* entry
, char *out_buf
)
1464 struct timespec time_spec
;
1466 unsigned long caller
;
1470 level
= entry
->id
.fields
.level
;
1471 stck_to_timespec(entry
->id
.stck
, &time_spec
);
1473 if (entry
->id
.fields
.exception
)
1477 caller
= ((unsigned long) entry
->caller
) & PSW_ADDR_INSN
;
1478 rc
+= sprintf(out_buf
, "%02i %011lu:%06lu %1u %1s %02i %p ",
1479 area
, time_spec
.tv_sec
, time_spec
.tv_nsec
/ 1000, level
,
1480 except_str
, entry
->id
.fields
.cpuid
, (void *) caller
);
1483 EXPORT_SYMBOL(debug_dflt_header_fn
);
1486 * prints debug data sprintf-formated:
1487 * debug_sprinf_event/exception calls must be used together with this view
1490 #define DEBUG_SPRINTF_MAX_ARGS 10
1493 debug_sprintf_format_fn(debug_info_t
* id
, struct debug_view
*view
,
1494 char *out_buf
, debug_sprintf_entry_t
*curr_event
)
1496 int num_longs
, num_used_args
= 0,i
, rc
= 0;
1497 int index
[DEBUG_SPRINTF_MAX_ARGS
];
1499 /* count of longs fit into one entry */
1500 num_longs
= id
->buf_size
/ sizeof(long);
1503 goto out
; /* bufsize of entry too small */
1504 if(num_longs
== 1) {
1505 /* no args, we use only the string */
1506 strcpy(out_buf
, curr_event
->string
);
1507 rc
= strlen(curr_event
->string
);
1511 /* number of arguments used for sprintf (without the format string) */
1512 num_used_args
= min(DEBUG_SPRINTF_MAX_ARGS
, (num_longs
- 1));
1514 memset(index
,0, DEBUG_SPRINTF_MAX_ARGS
* sizeof(int));
1516 for(i
= 0; i
< num_used_args
; i
++)
1519 rc
= sprintf(out_buf
, curr_event
->string
, curr_event
->args
[index
[0]],
1520 curr_event
->args
[index
[1]], curr_event
->args
[index
[2]],
1521 curr_event
->args
[index
[3]], curr_event
->args
[index
[4]],
1522 curr_event
->args
[index
[5]], curr_event
->args
[index
[6]],
1523 curr_event
->args
[index
[7]], curr_event
->args
[index
[8]],
1524 curr_event
->args
[index
[9]]);
1533 * - is called exactly once to initialize the debug feature
1535 static int __init
debug_init(void)
1537 s390dbf_sysctl_header
= register_sysctl_table(s390dbf_dir_table
);
1538 mutex_lock(&debug_mutex
);
1539 debug_debugfs_root_entry
= debugfs_create_dir(DEBUG_DIR_ROOT
, NULL
);
1541 mutex_unlock(&debug_mutex
);
1544 postcore_initcall(debug_init
);