4 * Driver for a little io fencing timer.
6 * Copyright (C) 2002, 2003 Oracle. All rights reserved.
8 * Author: Joel Becker <joel.becker@oracle.com>
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public
12 * License version 2 as published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public
20 * License along with this program; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 021110-1307, USA.
26 * The hangcheck-timer driver uses the TSC to catch delays that
27 * jiffies does not notice. A timer is set. When the timer fires, it
28 * checks whether it was delayed and if that delay exceeds a given
29 * margin of error. The hangcheck_tick module paramter takes the timer
30 * duration in seconds. The hangcheck_margin parameter defines the
31 * margin of error, in seconds. The defaults are 60 seconds for the
32 * timer and 180 seconds for the margin of error. IOW, a timer is set
33 * for 60 seconds. When the timer fires, the callback checks the
34 * actual duration that the timer waited. If the duration exceeds the
35 * alloted time and margin (here 60 + 180, or 240 seconds), the machine
36 * is restarted. A healthy machine will have the duration match the
37 * expected timeout very closely.
40 #include <linux/module.h>
41 #include <linux/moduleparam.h>
42 #include <linux/types.h>
43 #include <linux/kernel.h>
46 #include <linux/reboot.h>
47 #include <linux/smp_lock.h>
48 #include <linux/init.h>
49 #include <linux/delay.h>
50 #include <asm/uaccess.h>
51 #include <linux/sysrq.h>
54 #define VERSION_STR "0.9.0"
56 #define DEFAULT_IOFENCE_MARGIN 60 /* Default fudge factor, in seconds */
57 #define DEFAULT_IOFENCE_TICK 180 /* Default timer timeout, in seconds */
59 static int hangcheck_tick = DEFAULT_IOFENCE_TICK;
60 static int hangcheck_margin = DEFAULT_IOFENCE_MARGIN;
61 static int hangcheck_reboot; /* Defaults to not reboot */
62 static int hangcheck_dump_tasks; /* Defaults to not dumping SysRQ T */
64 /* options - modular */
65 module_param(hangcheck_tick, int, 0);
66 MODULE_PARM_DESC(hangcheck_tick, "Timer delay.");
67 module_param(hangcheck_margin, int, 0);
68 MODULE_PARM_DESC(hangcheck_margin, "If the hangcheck timer has been delayed more than hangcheck_margin seconds, the driver will fire.");
69 module_param(hangcheck_reboot, int, 0);
70 MODULE_PARM_DESC(hangcheck_reboot, "If nonzero, the machine will reboot when the timer margin is exceeded.");
71 module_param(hangcheck_dump_tasks, int, 0);
72 MODULE_PARM_DESC(hangcheck_dump_tasks, "If nonzero, the machine will dump the system task state when the timer margin is exceeded.");
74 MODULE_AUTHOR("Oracle");
75 MODULE_DESCRIPTION("Hangcheck-timer detects when the system has gone out to lunch past a certain margin.");
76 MODULE_LICENSE("GPL");
77 MODULE_VERSION(VERSION_STR);
79 /* options - nonmodular */
82 static int __init hangcheck_parse_tick(char *str)
85 if (get_option(&str,&par))
90 static int __init hangcheck_parse_margin(char *str)
93 if (get_option(&str,&par))
94 hangcheck_margin = par;
98 static int __init hangcheck_parse_reboot(char *str)
101 if (get_option(&str,&par))
102 hangcheck_reboot = par;
106 static int __init hangcheck_parse_dump_tasks(char *str)
109 if (get_option(&str,&par))
110 hangcheck_dump_tasks = par;
114 __setup("hcheck_tick", hangcheck_parse_tick);
115 __setup("hcheck_margin", hangcheck_parse_margin);
116 __setup("hcheck_reboot", hangcheck_parse_reboot);
117 __setup("hcheck_dump_tasks", hangcheck_parse_dump_tasks);
118 #endif /* not MODULE */
120 #if defined(CONFIG_X86)
121 # define HAVE_MONOTONIC
122 # define TIMER_FREQ 1000000000ULL
123 #elif defined(CONFIG_S390)
124 /* FA240000 is 1 Second in the IBM time universe (Page 4-38 Principles of Op for zSeries */
125 # define TIMER_FREQ 0xFA240000ULL
126 #elif defined(CONFIG_IA64)
127 # define TIMER_FREQ ((unsigned long long)local_cpu_data->itc_freq)
128 #elif defined(CONFIG_PPC64)
129 # define TIMER_FREQ (HZ*loops_per_jiffy)
132 #ifdef HAVE_MONOTONIC
133 extern unsigned long long monotonic_clock(void);
135 static inline unsigned long long monotonic_clock(void)
138 /* returns the TOD. see 4-38 Principles of Op of zSeries */
142 # endif /* __s390__ */
144 #endif /* HAVE_MONOTONIC */
147 /* Last time scheduled */
148 static unsigned long long hangcheck_tsc, hangcheck_tsc_margin;
150 static void hangcheck_fire(unsigned long);
152 static DEFINE_TIMER(hangcheck_ticktock, hangcheck_fire, 0, 0);
155 static void hangcheck_fire(unsigned long data)
157 unsigned long long cur_tsc, tsc_diff;
159 cur_tsc = monotonic_clock();
161 if (cur_tsc > hangcheck_tsc)
162 tsc_diff = cur_tsc - hangcheck_tsc;
164 tsc_diff = (cur_tsc + (~0ULL - hangcheck_tsc)); /* or something */
166 if (tsc_diff > hangcheck_tsc_margin) {
167 if (hangcheck_dump_tasks) {
168 printk(KERN_CRIT "Hangcheck: Task state:\n");
169 #ifdef CONFIG_MAGIC_SYSRQ
170 handle_sysrq('t', NULL, NULL);
171 #endif /* CONFIG_MAGIC_SYSRQ */
173 if (hangcheck_reboot) {
174 printk(KERN_CRIT "Hangcheck: hangcheck is restarting the machine.\n");
177 printk(KERN_CRIT "Hangcheck: hangcheck value past margin!\n");
180 mod_timer(&hangcheck_ticktock, jiffies + (hangcheck_tick*HZ));
181 hangcheck_tsc = monotonic_clock();
185 static int __init hangcheck_init(void)
187 printk("Hangcheck: starting hangcheck timer %s (tick is %d seconds, margin is %d seconds).\n",
188 VERSION_STR, hangcheck_tick, hangcheck_margin);
189 #if defined (HAVE_MONOTONIC)
190 printk("Hangcheck: Using monotonic_clock().\n");
191 #elif defined(__s390__)
192 printk("Hangcheck: Using TOD.\n");
194 printk("Hangcheck: Using get_cycles().\n");
195 #endif /* HAVE_MONOTONIC */
196 hangcheck_tsc_margin =
197 (unsigned long long)(hangcheck_margin + hangcheck_tick);
198 hangcheck_tsc_margin *= (unsigned long long)TIMER_FREQ;
200 hangcheck_tsc = monotonic_clock();
201 mod_timer(&hangcheck_ticktock, jiffies + (hangcheck_tick*HZ));
207 static void __exit hangcheck_exit(void)
209 del_timer_sync(&hangcheck_ticktock);
210 printk("Hangcheck: Stopped hangcheck timer.\n");
213 module_init(hangcheck_init);
214 module_exit(hangcheck_exit);