Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * drivers/base/power/trace.c
4 *
5 * Copyright (C) 2006 Linus Torvalds
6 *
7 * Trace facility for suspend/resume problems, when none of the
8 * devices may be working.
9 */
10#define pr_fmt(fmt) "PM: " fmt
11
12#include <linux/pm-trace.h>
13#include <linux/export.h>
14#include <linux/rtc.h>
15#include <linux/suspend.h>
16#include <linux/init.h>
17
18#include <linux/mc146818rtc.h>
19
20#include "power.h"
21
22/*
23 * Horrid, horrid, horrid.
24 *
25 * It turns out that the _only_ piece of hardware that actually
26 * keeps its value across a hard boot (and, more importantly, the
27 * POST init sequence) is literally the realtime clock.
28 *
29 * Never mind that an RTC chip has 114 bytes (and often a whole
30 * other bank of an additional 128 bytes) of nice SRAM that is
31 * _designed_ to keep data - the POST will clear it. So we literally
32 * can just use the few bytes of actual time data, which means that
33 * we're really limited.
34 *
35 * It means, for example, that we can't use the seconds at all
36 * (since the time between the hang and the boot might be more
37 * than a minute), and we'd better not depend on the low bits of
38 * the minutes either.
39 *
40 * There are the wday fields etc, but I wouldn't guarantee those
41 * are dependable either. And if the date isn't valid, either the
42 * hw or POST will do strange things.
43 *
44 * So we're left with:
45 * - year: 0-99
46 * - month: 0-11
47 * - day-of-month: 1-28
48 * - hour: 0-23
49 * - min: (0-30)*2
50 *
51 * Giving us a total range of 0-16128000 (0xf61800), ie less
52 * than 24 bits of actual data we can save across reboots.
53 *
54 * And if your box can't boot in less than three minutes,
55 * you're screwed.
56 *
57 * Now, almost 24 bits of data is pitifully small, so we need
58 * to be pretty dense if we want to use it for anything nice.
59 * What we do is that instead of saving off nice readable info,
60 * we save off _hashes_ of information that we can hopefully
61 * regenerate after the reboot.
62 *
63 * In particular, this means that we might be unlucky, and hit
64 * a case where we have a hash collision, and we end up not
65 * being able to tell for certain exactly which case happened.
66 * But that's hopefully unlikely.
67 *
68 * What we do is to take the bits we can fit, and split them
69 * into three parts (16*997*1009 = 16095568), and use the values
70 * for:
71 * - 0-15: user-settable
72 * - 0-996: file + line number
73 * - 0-1008: device
74 */
75#define USERHASH (16)
76#define FILEHASH (997)
77#define DEVHASH (1009)
78
79#define DEVSEED (7919)
80
81bool pm_trace_rtc_abused __read_mostly;
82EXPORT_SYMBOL_GPL(pm_trace_rtc_abused);
83
84static unsigned int dev_hash_value;
85
86static int set_magic_time(unsigned int user, unsigned int file, unsigned int device)
87{
88 unsigned int n = user + USERHASH*(file + FILEHASH*device);
89
90 // June 7th, 2006
91 static struct rtc_time time = {
92 .tm_sec = 0,
93 .tm_min = 0,
94 .tm_hour = 0,
95 .tm_mday = 7,
96 .tm_mon = 5, // June - counting from zero
97 .tm_year = 106,
98 .tm_wday = 3,
99 .tm_yday = 160,
100 .tm_isdst = 1
101 };
102
103 time.tm_year = (n % 100);
104 n /= 100;
105 time.tm_mon = (n % 12);
106 n /= 12;
107 time.tm_mday = (n % 28) + 1;
108 n /= 28;
109 time.tm_hour = (n % 24);
110 n /= 24;
111 time.tm_min = (n % 20) * 3;
112 n /= 20;
113 mc146818_set_time(&time);
114 pm_trace_rtc_abused = true;
115 return n ? -1 : 0;
116}
117
118static unsigned int read_magic_time(void)
119{
120 struct rtc_time time;
121 unsigned int val;
122
123 mc146818_get_time(&time);
124 pr_info("RTC time: %ptRt, date: %ptRd\n", &time, &time);
125 val = time.tm_year; /* 100 years */
126 if (val > 100)
127 val -= 100;
128 val += time.tm_mon * 100; /* 12 months */
129 val += (time.tm_mday-1) * 100 * 12; /* 28 month-days */
130 val += time.tm_hour * 100 * 12 * 28; /* 24 hours */
131 val += (time.tm_min / 3) * 100 * 12 * 28 * 24; /* 20 3-minute intervals */
132 return val;
133}
134
135/*
136 * This is just the sdbm hash function with a user-supplied
137 * seed and final size parameter.
138 */
139static unsigned int hash_string(unsigned int seed, const char *data, unsigned int mod)
140{
141 unsigned char c;
142 while ((c = *data++) != 0) {
143 seed = (seed << 16) + (seed << 6) - seed + c;
144 }
145 return seed % mod;
146}
147
148void set_trace_device(struct device *dev)
149{
150 dev_hash_value = hash_string(DEVSEED, dev_name(dev), DEVHASH);
151}
152EXPORT_SYMBOL(set_trace_device);
153
154/*
155 * We could just take the "tracedata" index into the .tracedata
156 * section instead. Generating a hash of the data gives us a
157 * chance to work across kernel versions, and perhaps more
158 * importantly it also gives us valid/invalid check (ie we will
159 * likely not give totally bogus reports - if the hash matches,
160 * it's not any guarantee, but it's a high _likelihood_ that
161 * the match is valid).
162 */
163void generate_pm_trace(const void *tracedata, unsigned int user)
164{
165 unsigned short lineno = *(unsigned short *)tracedata;
166 const char *file = *(const char **)(tracedata + 2);
167 unsigned int user_hash_value, file_hash_value;
168
169 if (!x86_platform.legacy.rtc)
170 return;
171
172 user_hash_value = user % USERHASH;
173 file_hash_value = hash_string(lineno, file, FILEHASH);
174 set_magic_time(user_hash_value, file_hash_value, dev_hash_value);
175}
176EXPORT_SYMBOL(generate_pm_trace);
177
178extern char __tracedata_start[], __tracedata_end[];
179static int show_file_hash(unsigned int value)
180{
181 int match;
182 char *tracedata;
183
184 match = 0;
185 for (tracedata = __tracedata_start ; tracedata < __tracedata_end ;
186 tracedata += 2 + sizeof(unsigned long)) {
187 unsigned short lineno = *(unsigned short *)tracedata;
188 const char *file = *(const char **)(tracedata + 2);
189 unsigned int hash = hash_string(lineno, file, FILEHASH);
190 if (hash != value)
191 continue;
192 pr_info(" hash matches %s:%u\n", file, lineno);
193 match++;
194 }
195 return match;
196}
197
198static int show_dev_hash(unsigned int value)
199{
200 int match = 0;
201 struct list_head *entry;
202
203 device_pm_lock();
204 entry = dpm_list.prev;
205 while (entry != &dpm_list) {
206 struct device * dev = to_device(entry);
207 unsigned int hash = hash_string(DEVSEED, dev_name(dev), DEVHASH);
208 if (hash == value) {
209 dev_info(dev, "hash matches\n");
210 match++;
211 }
212 entry = entry->prev;
213 }
214 device_pm_unlock();
215 return match;
216}
217
218static unsigned int hash_value_early_read;
219
220int show_trace_dev_match(char *buf, size_t size)
221{
222 unsigned int value = hash_value_early_read / (USERHASH * FILEHASH);
223 int ret = 0;
224 struct list_head *entry;
225
226 /*
227 * It's possible that multiple devices will match the hash and we can't
228 * tell which is the culprit, so it's best to output them all.
229 */
230 device_pm_lock();
231 entry = dpm_list.prev;
232 while (size && entry != &dpm_list) {
233 struct device *dev = to_device(entry);
234 unsigned int hash = hash_string(DEVSEED, dev_name(dev),
235 DEVHASH);
236 if (hash == value) {
237 int len = snprintf(buf, size, "%s\n",
238 dev_driver_string(dev));
239 if (len > size)
240 len = size;
241 buf += len;
242 ret += len;
243 size -= len;
244 }
245 entry = entry->prev;
246 }
247 device_pm_unlock();
248 return ret;
249}
250
251static int
252pm_trace_notify(struct notifier_block *nb, unsigned long mode, void *_unused)
253{
254 switch (mode) {
255 case PM_POST_HIBERNATION:
256 case PM_POST_SUSPEND:
257 if (pm_trace_rtc_abused) {
258 pm_trace_rtc_abused = false;
259 pr_warn("Possible incorrect RTC due to pm_trace, please use 'ntpdate' or 'rdate' to reset it.\n");
260 }
261 break;
262 default:
263 break;
264 }
265 return 0;
266}
267
268static struct notifier_block pm_trace_nb = {
269 .notifier_call = pm_trace_notify,
270};
271
272static int __init early_resume_init(void)
273{
274 if (!x86_platform.legacy.rtc)
275 return 0;
276
277 hash_value_early_read = read_magic_time();
278 register_pm_notifier(&pm_trace_nb);
279 return 0;
280}
281
282static int __init late_resume_init(void)
283{
284 unsigned int val = hash_value_early_read;
285 unsigned int user, file, dev;
286
287 if (!x86_platform.legacy.rtc)
288 return 0;
289
290 user = val % USERHASH;
291 val = val / USERHASH;
292 file = val % FILEHASH;
293 val = val / FILEHASH;
294 dev = val /* % DEVHASH */;
295
296 pr_info(" Magic number: %d:%d:%d\n", user, file, dev);
297 show_file_hash(file);
298 show_dev_hash(dev);
299 return 0;
300}
301
302core_initcall(early_resume_init);
303late_initcall(late_resume_init);
1/*
2 * drivers/base/power/trace.c
3 *
4 * Copyright (C) 2006 Linus Torvalds
5 *
6 * Trace facility for suspend/resume problems, when none of the
7 * devices may be working.
8 */
9
10#include <linux/resume-trace.h>
11#include <linux/rtc.h>
12
13#include <asm/rtc.h>
14
15#include "power.h"
16
17/*
18 * Horrid, horrid, horrid.
19 *
20 * It turns out that the _only_ piece of hardware that actually
21 * keeps its value across a hard boot (and, more importantly, the
22 * POST init sequence) is literally the realtime clock.
23 *
24 * Never mind that an RTC chip has 114 bytes (and often a whole
25 * other bank of an additional 128 bytes) of nice SRAM that is
26 * _designed_ to keep data - the POST will clear it. So we literally
27 * can just use the few bytes of actual time data, which means that
28 * we're really limited.
29 *
30 * It means, for example, that we can't use the seconds at all
31 * (since the time between the hang and the boot might be more
32 * than a minute), and we'd better not depend on the low bits of
33 * the minutes either.
34 *
35 * There are the wday fields etc, but I wouldn't guarantee those
36 * are dependable either. And if the date isn't valid, either the
37 * hw or POST will do strange things.
38 *
39 * So we're left with:
40 * - year: 0-99
41 * - month: 0-11
42 * - day-of-month: 1-28
43 * - hour: 0-23
44 * - min: (0-30)*2
45 *
46 * Giving us a total range of 0-16128000 (0xf61800), ie less
47 * than 24 bits of actual data we can save across reboots.
48 *
49 * And if your box can't boot in less than three minutes,
50 * you're screwed.
51 *
52 * Now, almost 24 bits of data is pitifully small, so we need
53 * to be pretty dense if we want to use it for anything nice.
54 * What we do is that instead of saving off nice readable info,
55 * we save off _hashes_ of information that we can hopefully
56 * regenerate after the reboot.
57 *
58 * In particular, this means that we might be unlucky, and hit
59 * a case where we have a hash collision, and we end up not
60 * being able to tell for certain exactly which case happened.
61 * But that's hopefully unlikely.
62 *
63 * What we do is to take the bits we can fit, and split them
64 * into three parts (16*997*1009 = 16095568), and use the values
65 * for:
66 * - 0-15: user-settable
67 * - 0-996: file + line number
68 * - 0-1008: device
69 */
70#define USERHASH (16)
71#define FILEHASH (997)
72#define DEVHASH (1009)
73
74#define DEVSEED (7919)
75
76static unsigned int dev_hash_value;
77
78static int set_magic_time(unsigned int user, unsigned int file, unsigned int device)
79{
80 unsigned int n = user + USERHASH*(file + FILEHASH*device);
81
82 // June 7th, 2006
83 static struct rtc_time time = {
84 .tm_sec = 0,
85 .tm_min = 0,
86 .tm_hour = 0,
87 .tm_mday = 7,
88 .tm_mon = 5, // June - counting from zero
89 .tm_year = 106,
90 .tm_wday = 3,
91 .tm_yday = 160,
92 .tm_isdst = 1
93 };
94
95 time.tm_year = (n % 100);
96 n /= 100;
97 time.tm_mon = (n % 12);
98 n /= 12;
99 time.tm_mday = (n % 28) + 1;
100 n /= 28;
101 time.tm_hour = (n % 24);
102 n /= 24;
103 time.tm_min = (n % 20) * 3;
104 n /= 20;
105 set_rtc_time(&time);
106 return n ? -1 : 0;
107}
108
109static unsigned int read_magic_time(void)
110{
111 struct rtc_time time;
112 unsigned int val;
113
114 get_rtc_time(&time);
115 pr_info("RTC time: %2d:%02d:%02d, date: %02d/%02d/%02d\n",
116 time.tm_hour, time.tm_min, time.tm_sec,
117 time.tm_mon + 1, time.tm_mday, time.tm_year % 100);
118 val = time.tm_year; /* 100 years */
119 if (val > 100)
120 val -= 100;
121 val += time.tm_mon * 100; /* 12 months */
122 val += (time.tm_mday-1) * 100 * 12; /* 28 month-days */
123 val += time.tm_hour * 100 * 12 * 28; /* 24 hours */
124 val += (time.tm_min / 3) * 100 * 12 * 28 * 24; /* 20 3-minute intervals */
125 return val;
126}
127
128/*
129 * This is just the sdbm hash function with a user-supplied
130 * seed and final size parameter.
131 */
132static unsigned int hash_string(unsigned int seed, const char *data, unsigned int mod)
133{
134 unsigned char c;
135 while ((c = *data++) != 0) {
136 seed = (seed << 16) + (seed << 6) - seed + c;
137 }
138 return seed % mod;
139}
140
141void set_trace_device(struct device *dev)
142{
143 dev_hash_value = hash_string(DEVSEED, dev_name(dev), DEVHASH);
144}
145EXPORT_SYMBOL(set_trace_device);
146
147/*
148 * We could just take the "tracedata" index into the .tracedata
149 * section instead. Generating a hash of the data gives us a
150 * chance to work across kernel versions, and perhaps more
151 * importantly it also gives us valid/invalid check (ie we will
152 * likely not give totally bogus reports - if the hash matches,
153 * it's not any guarantee, but it's a high _likelihood_ that
154 * the match is valid).
155 */
156void generate_resume_trace(const void *tracedata, unsigned int user)
157{
158 unsigned short lineno = *(unsigned short *)tracedata;
159 const char *file = *(const char **)(tracedata + 2);
160 unsigned int user_hash_value, file_hash_value;
161
162 user_hash_value = user % USERHASH;
163 file_hash_value = hash_string(lineno, file, FILEHASH);
164 set_magic_time(user_hash_value, file_hash_value, dev_hash_value);
165}
166EXPORT_SYMBOL(generate_resume_trace);
167
168extern char __tracedata_start, __tracedata_end;
169static int show_file_hash(unsigned int value)
170{
171 int match;
172 char *tracedata;
173
174 match = 0;
175 for (tracedata = &__tracedata_start ; tracedata < &__tracedata_end ;
176 tracedata += 2 + sizeof(unsigned long)) {
177 unsigned short lineno = *(unsigned short *)tracedata;
178 const char *file = *(const char **)(tracedata + 2);
179 unsigned int hash = hash_string(lineno, file, FILEHASH);
180 if (hash != value)
181 continue;
182 pr_info(" hash matches %s:%u\n", file, lineno);
183 match++;
184 }
185 return match;
186}
187
188static int show_dev_hash(unsigned int value)
189{
190 int match = 0;
191 struct list_head *entry;
192
193 device_pm_lock();
194 entry = dpm_list.prev;
195 while (entry != &dpm_list) {
196 struct device * dev = to_device(entry);
197 unsigned int hash = hash_string(DEVSEED, dev_name(dev), DEVHASH);
198 if (hash == value) {
199 dev_info(dev, "hash matches\n");
200 match++;
201 }
202 entry = entry->prev;
203 }
204 device_pm_unlock();
205 return match;
206}
207
208static unsigned int hash_value_early_read;
209
210int show_trace_dev_match(char *buf, size_t size)
211{
212 unsigned int value = hash_value_early_read / (USERHASH * FILEHASH);
213 int ret = 0;
214 struct list_head *entry;
215
216 /*
217 * It's possible that multiple devices will match the hash and we can't
218 * tell which is the culprit, so it's best to output them all.
219 */
220 device_pm_lock();
221 entry = dpm_list.prev;
222 while (size && entry != &dpm_list) {
223 struct device *dev = to_device(entry);
224 unsigned int hash = hash_string(DEVSEED, dev_name(dev),
225 DEVHASH);
226 if (hash == value) {
227 int len = snprintf(buf, size, "%s\n",
228 dev_driver_string(dev));
229 if (len > size)
230 len = size;
231 buf += len;
232 ret += len;
233 size -= len;
234 }
235 entry = entry->prev;
236 }
237 device_pm_unlock();
238 return ret;
239}
240
241static int early_resume_init(void)
242{
243 hash_value_early_read = read_magic_time();
244 return 0;
245}
246
247static int late_resume_init(void)
248{
249 unsigned int val = hash_value_early_read;
250 unsigned int user, file, dev;
251
252 user = val % USERHASH;
253 val = val / USERHASH;
254 file = val % FILEHASH;
255 val = val / FILEHASH;
256 dev = val /* % DEVHASH */;
257
258 pr_info(" Magic number: %d:%d:%d\n", user, file, dev);
259 show_file_hash(file);
260 show_dev_hash(dev);
261 return 0;
262}
263
264core_initcall(early_resume_init);
265late_initcall(late_resume_init);