3 # Tool for analyzing suspend/resume timing
4 # Copyright (c) 2013, Intel Corporation.
6 # This program is free software; you can redistribute it and/or modify it
7 # under the terms and conditions of the GNU General Public License,
8 # version 2, as published by the Free Software Foundation.
10 # This program is distributed in the hope it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 # You should have received a copy of the GNU General Public License along with
16 # this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
20 # Todd Brandt <todd.e.brandt@linux.intel.com>
23 # This tool is designed to assist kernel and OS developers in optimizing
24 # their linux stack's suspend/resume time. Using a kernel image built
25 # with a few extra options enabled, the tool will execute a suspend and
26 # will capture dmesg and ftrace data until resume is complete. This data
27 # is transformed into a device timeline and a callgraph to give a quick
28 # and detailed view of which devices and callbacks are taking the most
29 # time in suspend/resume. The output is a single html file which can be
30 # viewed in firefox or chrome.
32 # The following kernel build options are required:
34 # CONFIG_PM_SLEEP_DEBUG=y
36 # CONFIG_FUNCTION_TRACER=y
37 # CONFIG_FUNCTION_GRAPH_TRACER=y
39 # The following additional kernel parameters are required:
40 # (e.g. in file /etc/default/grub)
41 # GRUB_CMDLINE_LINUX_DEFAULT="... initcall_debug log_buf_len=16M ..."
58 tpath
= "/sys/kernel/debug/tracing/"
60 powerfile
= "/sys/power/state"
68 def setOutputFile(self
):
69 if((self
.htmlfile
== "") and (self
.dmesgfile
!= "")):
70 m
= re
.match(r
"(?P<name>.*)_dmesg\.txt$", self
.dmesgfile
)
72 self
.htmlfile
= m
.group("name")+".html"
73 if((self
.htmlfile
== "") and (self
.ftracefile
!= "")):
74 m
= re
.match(r
"(?P<name>.*)_ftrace\.txt$", self
.ftracefile
)
76 self
.htmlfile
= m
.group("name")+".html"
77 if(self
.htmlfile
== ""):
78 self
.htmlfile
= "output.html"
79 def initTestOutput(self
):
80 hostname
= platform
.node()
82 self
.prefix
= hostname
83 v
= os
.popen("cat /proc/version").read().strip()
84 kver
= string
.split(v
)[2]
85 self
.testdir
= os
.popen("date \"+suspend-%m%d%y-%H%M%S\"").read().strip()
86 self
.teststamp
= "# "+self
.testdir
+" "+self
.prefix
+" "+self
.suspendmode
+" "+kver
87 self
.dmesgfile
= self
.testdir
+"/"+self
.prefix
+"_"+self
.suspendmode
+"_dmesg.txt"
88 self
.ftracefile
= self
.testdir
+"/"+self
.prefix
+"_"+self
.suspendmode
+"_ftrace.txt"
89 self
.htmlfile
= self
.testdir
+"/"+self
.prefix
+"_"+self
.suspendmode
+".html"
90 os
.mkdir(self
.testdir
)
99 dmesg
= {} # root data structure
102 stamp
= {'time': "", 'host': "", 'mode': ""}
108 def initialize(self
):
109 self
.dmesg
= { # dmesg log data
110 'suspend_general': {'list': dict(), 'start': -1.0, 'end': -1.0,
111 'row': 0, 'color': "#CCFFCC", 'order': 0},
112 'suspend_early': {'list': dict(), 'start': -1.0, 'end': -1.0,
113 'row': 0, 'color': "green", 'order': 1},
114 'suspend_noirq': {'list': dict(), 'start': -1.0, 'end': -1.0,
115 'row': 0, 'color': "#00FFFF", 'order': 2},
116 'suspend_cpu': {'list': dict(), 'start': -1.0, 'end': -1.0,
117 'row': 0, 'color': "blue", 'order': 3},
118 'resume_cpu': {'list': dict(), 'start': -1.0, 'end': -1.0,
119 'row': 0, 'color': "red", 'order': 4},
120 'resume_noirq': {'list': dict(), 'start': -1.0, 'end': -1.0,
121 'row': 0, 'color': "orange", 'order': 5},
122 'resume_early': {'list': dict(), 'start': -1.0, 'end': -1.0,
123 'row': 0, 'color': "yellow", 'order': 6},
124 'resume_general': {'list': dict(), 'start': -1.0, 'end': -1.0,
125 'row': 0, 'color': "#FFFFCC", 'order': 7}
127 self
.phases
= self
.sortedPhases()
128 def normalizeTime(self
):
129 tSus
= tRes
= self
.tSuspended
131 tSus
-= -self
.fwSuspend
/ 1000000000.0
132 tRes
-= self
.fwResume
/ 1000000000.0
133 self
.tSuspended
= 0.0
136 for phase
in self
.phases
:
138 if "suspend" in phase
:
140 p
= self
.dmesg
[phase
]
155 fws
= -self
.fwSuspend
/ 1000000000.0
156 fwr
= self
.fwResume
/ 1000000000.0
159 devid
= "dc%d" % self
.id
160 list["firmware-suspend"] = \
161 {'start': fws
, 'end': 0, 'pid': 0, 'par': "",
162 'length': -fws
, 'row': 0, 'id': devid
};
164 devid
= "dc%d" % self
.id
165 list["firmware-resume"] = \
166 {'start': 0, 'end': fwr
, 'pid': 0, 'par': "",
167 'length': fwr
, 'row': 0, 'id': devid
};
168 self
.dmesg
['BIOS'] = \
169 {'list': list, 'start': fws
, 'end': fwr
,
170 'row': 0, 'color': "purple", 'order': 4}
171 self
.dmesg
['resume_cpu']['order'] += 1
172 self
.dmesg
['resume_noirq']['order'] += 1
173 self
.dmesg
['resume_early']['order'] += 1
174 self
.dmesg
['resume_general']['order'] += 1
175 self
.phases
= self
.sortedPhases()
176 def vprint(self
, msg
):
179 def dmesgSortVal(self
, phase
):
180 return self
.dmesg
[phase
]['order']
181 def sortedPhases(self
):
182 return sorted(self
.dmesg
, key
=self
.dmesgSortVal
)
183 def sortedDevices(self
, phase
):
184 list = self
.dmesg
[phase
]['list']
189 tmp
[dev
['start']] = devname
190 for t
in sorted(tmp
):
193 def fixupInitcalls(self
, phase
, end
):
194 # if any calls never returned, clip them at system resume end
195 phaselist
= self
.dmesg
[phase
]['list']
196 for devname
in phaselist
:
197 dev
= phaselist
[devname
]
200 self
.vprint("%s (%s): callback didn't return" % (devname
, phase
))
201 def fixupInitcallsThatDidntReturn(self
):
202 # if any calls never returned, clip them at system resume end
203 for phase
in self
.phases
:
204 self
.fixupInitcalls(phase
, self
.dmesg
['resume_general']['end'])
205 if(phase
== "resume_general"):
207 def newAction(self
, phase
, name
, pid
, parent
, start
, end
):
209 devid
= "dc%d" % self
.id
210 list = self
.dmesg
[phase
]['list']
212 if(start
>= 0 and end
>= 0):
214 list[name
] = {'start': start
, 'end': end
, 'pid': pid
, 'par': parent
,
215 'length': length
, 'row': 0, 'id': devid
}
216 def deviceIDs(self
, devlist
, phase
):
218 for p
in self
.phases
:
219 if(p
[0] != phase
[0]):
221 list = data
.dmesg
[p
]['list']
223 if devname
in devlist
:
224 idlist
.append(list[devname
]['id'])
226 def deviceParentID(self
, devname
, phase
):
229 for p
in self
.phases
:
230 if(p
[0] != phase
[0]):
232 list = data
.dmesg
[p
]['list']
234 pdev
= list[devname
]['par']
235 for p
in self
.phases
:
236 if(p
[0] != phase
[0]):
238 list = data
.dmesg
[p
]['list']
240 return list[pdev
]['id']
242 def deviceChildrenIDs(self
, devname
, phase
):
244 for p
in self
.phases
:
245 if(p
[0] != phase
[0]):
247 list = data
.dmesg
[p
]['list']
249 if(list[child
]['par'] == devname
):
250 devlist
.append(child
)
251 return self
.deviceIDs(devlist
, phase
)
261 def __init__(self
, t
, m
, d
):
263 # check to see if this is a trace event
264 em
= re
.match(r
"^ *\/\* *(?P<msg>.*) \*\/ *$", m
)
266 self
.name
= em
.group("msg")
269 # convert the duration to seconds
271 self
.length
= float(d
)/1000000
272 # the indentation determines the depth
273 match
= re
.match(r
"^(?P<d> *)(?P<o>.*)$", m
)
276 self
.depth
= self
.getDepth(match
.group('d'))
282 # includes comment with function name
283 match
= re
.match(r
"^} *\/\* *(?P<n>.*) *\*\/$", m
)
285 self
.name
= match
.group('n')
289 # function call with children
291 match
= re
.match(r
"^(?P<n>.*) *\(.*", m
)
293 self
.name
= match
.group('n')
294 # function call with no children (leaf)
297 match
= re
.match(r
"^(?P<n>.*) *\(.*", m
)
299 self
.name
= match
.group('n')
300 # something else (possibly a trace marker)
303 def getDepth(self
, str):
306 class FTraceCallGraph
:
317 def setDepth(self
, line
):
318 if(line
.fcall
and not line
.freturn
):
319 line
.depth
= self
.depth
321 elif(line
.freturn
and not line
.fcall
):
323 line
.depth
= self
.depth
325 line
.depth
= self
.depth
326 def addLine(self
, line
, match
):
327 if(not self
.invalid
):
329 if(line
.depth
== 0 and line
.freturn
):
331 self
.list.append(line
)
335 if(len(self
.list) >= 1000000 or self
.depth
< 0):
338 self
.list.append(first
)
340 id = "task %s cpu %s" % (match
.group("pid"), match
.group("cpu"))
341 window
= "(%f - %f)" % (self
.start
, line
.time
)
342 data
.vprint("Too much data for "+id+" "+window
+", ignoring this callback")
344 self
.list.append(line
)
346 self
.start
= line
.time
348 def sanityCheck(self
):
352 if(l
.fcall
and not l
.freturn
):
355 elif(l
.freturn
and not l
.fcall
):
356 if(not stack
[l
.depth
]):
358 stack
[l
.depth
].length
= l
.length
365 def debugPrint(self
, filename
):
366 if(filename
== "stdout"):
367 print("[%f - %f]") % (self
.start
, self
.end
)
369 if(l
.freturn
and l
.fcall
):
370 print("%f (%02d): %s(); (%.3f us)" % (l
.time
, l
.depth
, l
.name
, l
.length
*1000000))
372 print("%f (%02d): %s} (%.3f us)" % (l
.time
, l
.depth
, l
.name
, l
.length
*1000000))
374 print("%f (%02d): %s() { (%.3f us)" % (l
.time
, l
.depth
, l
.name
, l
.length
*1000000))
377 fp
= open(filename
, 'w')
380 if(l
.freturn
and l
.fcall
):
381 fp
.write("%f (%02d): %s(); (%.3f us)\n" % (l
.time
, l
.depth
, l
.name
, l
.length
*1000000))
383 fp
.write("%f (%02d): %s} (%.3f us)\n" % (l
.time
, l
.depth
, l
.name
, l
.length
*1000000))
385 fp
.write("%f (%02d): %s() { (%.3f us)\n" % (l
.time
, l
.depth
, l
.name
, l
.length
*1000000))
390 scaleH
= 0.0 # height of the timescale row as a percent of the timeline height
391 rowH
= 0.0 # height of each row in percent of the timeline height
392 row_height_pixels
= 30
401 def setRows(self
, rows
):
402 self
.maxrows
= int(rows
)
403 self
.scaleH
= 100.0/float(self
.maxrows
)
404 self
.height
= self
.maxrows
*self
.row_height_pixels
405 r
= float(self
.maxrows
- 1)
408 self
.rowH
= (100.0 - self
.scaleH
)/r
410 # -- global objects --
412 sysvals
= SystemValues()
417 # Function: initFtrace
419 # Configure ftrace to capture a function trace during suspend/resume
423 print("INITIALIZING FTRACE...")
425 os
.system("echo 0 > "+sysvals
.tpath
+"tracing_on")
426 # set the trace clock to global
427 os
.system("echo global > "+sysvals
.tpath
+"trace_clock")
428 # set trace buffer to a huge value
429 os
.system("echo nop > "+sysvals
.tpath
+"current_tracer")
430 os
.system("echo 100000 > "+sysvals
.tpath
+"buffer_size_kb")
431 # clear the trace buffer
432 os
.system("echo \"\" > "+sysvals
.tpath
+"trace")
434 os
.system("echo function_graph > "+sysvals
.tpath
+"current_tracer")
435 os
.system("echo \"\" > "+sysvals
.tpath
+"set_ftrace_filter")
436 # set trace format options
437 os
.system("echo funcgraph-abstime > "+sysvals
.tpath
+"trace_options")
438 os
.system("echo funcgraph-proc > "+sysvals
.tpath
+"trace_options")
439 # focus only on device suspend and resume
440 os
.system("cat "+sysvals
.tpath
+"available_filter_functions | grep dpm_run_callback > "+sysvals
.tpath
+"set_graph_function")
442 # Function: verifyFtrace
444 # Check that ftrace is working on the system
447 files
= ["available_filter_functions", "buffer_size_kb",
448 "current_tracer", "set_ftrace_filter",
449 "trace", "trace_marker"]
451 if(os
.path
.exists(sysvals
.tpath
+f
) == False):
455 def parseStamp(line
):
457 stampfmt
= r
"# suspend-(?P<m>[0-9]{2})(?P<d>[0-9]{2})(?P<y>[0-9]{2})-"+\
458 "(?P<H>[0-9]{2})(?P<M>[0-9]{2})(?P<S>[0-9]{2})"+\
459 " (?P<host>.*) (?P<mode>.*) (?P<kernel>.*)$"
460 m
= re
.match(stampfmt
, line
)
462 dt
= datetime
.datetime(int(m
.group("y"))+2000, int(m
.group("m")),
463 int(m
.group("d")), int(m
.group("H")), int(m
.group("M")),
465 data
.stamp
['time'] = dt
.strftime("%B %d %Y, %I:%M:%S %p")
466 data
.stamp
['host'] = m
.group("host")
467 data
.stamp
['mode'] = m
.group("mode")
468 data
.stamp
['kernel'] = m
.group("kernel")
469 sysvals
.suspendmode
= data
.stamp
['mode']
471 # Function: analyzeTraceLog
473 # Analyse an ftrace log output file generated from this app during
474 # the execution phase. Create an "ftrace" structure in memory for
475 # subsequent formatting in the html output file
476 def analyzeTraceLog():
479 # the ftrace data is tied to the dmesg data
480 if(not data
.usedmesg
):
483 # read through the ftrace and parse the data
484 data
.vprint("Analyzing the ftrace data...")
485 ftrace_line_fmt
= r
"^ *(?P<time>[0-9\.]*) *\| *(?P<cpu>[0-9]*)\)"+\
486 " *(?P<proc>.*)-(?P<pid>[0-9]*) *\|"+\
487 "[ +!]*(?P<dur>[0-9\.]*) .*\| (?P<msg>.*)"
490 tf
= open(sysvals
.ftracefile
, 'r')
494 # grab the time stamp if it's valid
498 # parse only valid lines
499 m
= re
.match(ftrace_line_fmt
, line
)
502 m_time
= m
.group("time")
503 m_pid
= m
.group("pid")
504 m_msg
= m
.group("msg")
505 m_dur
= m
.group("dur")
506 if(m_time
and m_pid
and m_msg
):
507 t
= FTraceLine(m_time
, m_msg
, m_dur
)
511 # the line should be a call, return, or event
512 if(not t
.fcall
and not t
.freturn
and not t
.fevent
):
514 # only parse the ftrace data during suspend/resume
516 # look for the suspend start marker
518 if(t
.name
== "SUSPEND START"):
519 data
.vprint("SUSPEND START %f %s:%d" % (t
.time
, sysvals
.ftracefile
, count
))
523 # look for the resume end marker
525 if(t
.name
== "RESUME COMPLETE"):
526 data
.vprint("RESUME COMPLETE %f %s:%d" % (t
.time
, sysvals
.ftracefile
, count
))
530 # create a callgraph object for the data
531 if(pid
not in ftemp
):
532 ftemp
[pid
] = FTraceCallGraph()
533 # when the call is finished, see which device matches it
534 if(ftemp
[pid
].addLine(t
, m
)):
535 if(not ftemp
[pid
].sanityCheck()):
536 id = "task %s cpu %s" % (pid
, m
.group("cpu"))
537 data
.vprint("Sanity check failed for "+id+", ignoring this callback")
539 callstart
= ftemp
[pid
].start
540 callend
= ftemp
[pid
].end
541 for p
in data
.phases
:
542 if(data
.dmesg
[p
]['start'] <= callstart
and callstart
<= data
.dmesg
[p
]['end']):
543 list = data
.dmesg
[p
]['list']
546 if(pid
== dev
['pid'] and callstart
<= dev
['start'] and callend
>= dev
['end']):
547 data
.vprint("%15s [%f - %f] %s(%d)" % (p
, callstart
, callend
, devname
, pid
))
548 dev
['ftrace'] = ftemp
[pid
]
550 ftemp
[pid
] = FTraceCallGraph()
553 # Function: sortKernelLog
555 # The dmesg output log sometimes comes with with lines that have
556 # timestamps out of order. This could cause issues since a call
557 # could accidentally end up in the wrong phase
560 lf
= open(sysvals
.dmesgfile
, 'r')
564 line
= line
.replace("\r\n", "")
568 m
= re
.match(r
"# fwsuspend (?P<s>[0-9]*) fwresume (?P<r>[0-9]*)$", line
)
570 data
.fwSuspend
= int(m
.group("s"))
571 data
.fwResume
= int(m
.group("r"))
572 if(data
.fwSuspend
> 0 or data
.fwResume
> 0):
574 if(re
.match(r
".*(\[ *)(?P<ktime>[0-9\.]*)(\]) (?P<msg>.*)", line
)):
575 dmesglist
.append(line
)
580 # fix lines with the same time stamp and function with the call and return swapped
581 for line
in dmesglist
:
582 mc
= re
.match(r
".*(\[ *)(?P<t>[0-9\.]*)(\]) calling (?P<f>.*)\+ @ .*, parent: .*", line
)
583 mr
= re
.match(r
".*(\[ *)(?P<t>[0-9\.]*)(\]) call (?P<f>.*)\+ returned .* after (?P<dt>.*) usecs", last
)
584 if(mc
and mr
and (mc
.group("t") == mr
.group("t")) and (mc
.group("f") == mr
.group("f"))):
585 i
= dmesglist
.index(last
)
586 j
= dmesglist
.index(line
)
592 # Function: analyzeKernelLog
594 # Analyse a dmesg log output file generated from this app during
595 # the execution phase. Create a set of device structures in memory
596 # for subsequent formatting in the html output file
597 def analyzeKernelLog():
600 print("PROCESSING DATA")
601 data
.vprint("Analyzing the dmesg data...")
602 if(os
.path
.exists(sysvals
.dmesgfile
) == False):
603 print("ERROR: %s doesn't exist") % sysvals
.dmesgfile
607 phase
= "suspend_runtime"
610 'suspend_general': r
"PM: Syncing filesystems.*",
611 'suspend_early': r
"PM: suspend of devices complete after.*",
612 'suspend_noirq': r
"PM: late suspend of devices complete after.*",
613 'suspend_cpu': r
"PM: noirq suspend of devices complete after.*",
614 'resume_cpu': r
"ACPI: Low-level resume complete.*",
615 'resume_noirq': r
"ACPI: Waking up from system sleep state.*",
616 'resume_early': r
"PM: noirq resume of devices complete after.*",
617 'resume_general': r
"PM: early resume of devices complete after.*",
618 'resume_complete': r
".*Restarting tasks \.\.\..*",
620 if(sysvals
.suspendmode
== "standby"):
621 dm
['resume_cpu'] = r
"PM: Restoring platform NVS memory"
622 elif(sysvals
.suspendmode
== "disk"):
623 dm
['suspend_early'] = r
"PM: freeze of devices complete after.*"
624 dm
['suspend_noirq'] = r
"PM: late freeze of devices complete after.*"
625 dm
['suspend_cpu'] = r
"PM: noirq freeze of devices complete after.*"
626 dm
['resume_cpu'] = r
"PM: Restoring platform NVS memory"
627 dm
['resume_early'] = r
"PM: noirq restore of devices complete after.*"
628 dm
['resume_general'] = r
"PM: early restore of devices complete after.*"
632 # -- preprocessing --
633 # parse each dmesg line into the time and message
634 m
= re
.match(r
".*(\[ *)(?P<ktime>[0-9\.]*)(\]) (?P<msg>.*)", line
)
636 ktime
= float(m
.group("ktime"))
642 # -- phase changes --
643 # suspend_general start
644 if(re
.match(dm
['suspend_general'], msg
)):
645 phase
= "suspend_general"
646 data
.dmesg
[phase
]['start'] = ktime
648 # action start: syncing filesystems
650 # suspend_early start
651 elif(re
.match(dm
['suspend_early'], msg
)):
652 data
.dmesg
["suspend_general"]['end'] = ktime
653 phase
= "suspend_early"
654 data
.dmesg
[phase
]['start'] = ktime
655 # suspend_noirq start
656 elif(re
.match(dm
['suspend_noirq'], msg
)):
657 data
.dmesg
["suspend_early"]['end'] = ktime
658 phase
= "suspend_noirq"
659 data
.dmesg
[phase
]['start'] = ktime
661 elif(re
.match(dm
['suspend_cpu'], msg
)):
662 data
.dmesg
["suspend_noirq"]['end'] = ktime
663 phase
= "suspend_cpu"
664 data
.dmesg
[phase
]['start'] = ktime
666 elif(re
.match(dm
['resume_cpu'], msg
)):
667 data
.tSuspended
= ktime
668 data
.dmesg
["suspend_cpu"]['end'] = ktime
670 data
.dmesg
[phase
]['start'] = ktime
672 elif(re
.match(dm
['resume_noirq'], msg
)):
673 data
.dmesg
["resume_cpu"]['end'] = ktime
674 phase
= "resume_noirq"
675 data
.dmesg
[phase
]['start'] = ktime
676 # action end: ACPI resume
677 data
.newAction("resume_cpu", "ACPI", -1, "", action_start
, ktime
)
679 elif(re
.match(dm
['resume_early'], msg
)):
680 data
.dmesg
["resume_noirq"]['end'] = ktime
681 phase
= "resume_early"
682 data
.dmesg
[phase
]['start'] = ktime
683 # resume_general start
684 elif(re
.match(dm
['resume_general'], msg
)):
685 data
.dmesg
["resume_early"]['end'] = ktime
686 phase
= "resume_general"
687 data
.dmesg
[phase
]['start'] = ktime
688 # resume complete start
689 elif(re
.match(dm
['resume_complete'], msg
)):
690 data
.dmesg
["resume_general"]['end'] = ktime
692 phase
= "resume_runtime"
695 # -- device callbacks --
696 if(phase
in data
.phases
):
698 if(re
.match(r
"calling (?P<f>.*)\+ @ .*, parent: .*", msg
)):
699 sm
= re
.match(r
"calling (?P<f>.*)\+ @ (?P<n>.*), parent: (?P<p>.*)", msg
);
704 data
.newAction(phase
, f
, int(n
), p
, ktime
, -1)
706 elif(re
.match(r
"call (?P<f>.*)\+ returned .* after (?P<t>.*) usecs", msg
)):
707 sm
= re
.match(r
"call (?P<f>.*)\+ returned .* after (?P<t>.*) usecs(?P<a>.*)", msg
);
710 list = data
.dmesg
[phase
]['list']
713 dev
['length'] = int(t
)
715 data
.vprint("%15s [%f - %f] %s(%d) %s" %
716 (phase
, dev
['start'], dev
['end'], f
, dev
['pid'], dev
['par']))
718 # -- phase specific actions --
719 if(phase
== "suspend_general"):
720 if(re
.match(r
"PM: Preparing system for mem sleep.*", msg
)):
721 data
.newAction(phase
, "filesystem-sync", -1, "", action_start
, ktime
)
722 elif(re
.match(r
"Freezing user space processes .*", msg
)):
724 elif(re
.match(r
"Freezing remaining freezable tasks.*", msg
)):
725 data
.newAction(phase
, "freeze-user-processes", -1, "", action_start
, ktime
)
727 elif(re
.match(r
"PM: Entering (?P<mode>[a-z,A-Z]*) sleep.*", msg
)):
728 data
.newAction(phase
, "freeze-tasks", -1, "", action_start
, ktime
)
729 elif(phase
== "suspend_cpu"):
730 m
= re
.match(r
"smpboot: CPU (?P<cpu>[0-9]*) is now offline", msg
)
732 cpu
= "CPU"+m
.group("cpu")
733 data
.newAction(phase
, cpu
, -1, "", action_start
, ktime
)
735 elif(re
.match(r
"ACPI: Preparing to enter system sleep state.*", msg
)):
737 elif(re
.match(r
"Disabling non-boot CPUs .*", msg
)):
738 data
.newAction(phase
, "ACPI", -1, "", action_start
, ktime
)
740 elif(phase
== "resume_cpu"):
741 m
= re
.match(r
"CPU(?P<cpu>[0-9]*) is up", msg
)
743 cpu
= "CPU"+m
.group("cpu")
744 data
.newAction(phase
, cpu
, -1, "", action_start
, ktime
)
746 elif(re
.match(r
"Enabling non-boot CPUs .*", msg
)):
749 # fill in any missing phases
750 lp
= "suspend_general"
751 for p
in data
.phases
:
752 if(p
== "suspend_general"):
754 if(data
.dmesg
[p
]['start'] < 0):
755 data
.dmesg
[p
]['start'] = data
.dmesg
[lp
]['end']
756 if(p
== "resume_cpu"):
757 data
.tSuspended
= data
.dmesg
[lp
]['end']
758 if(data
.dmesg
[p
]['end'] < 0):
759 data
.dmesg
[p
]['end'] = data
.dmesg
[p
]['start']
762 data
.fixupInitcallsThatDidntReturn()
765 # Function: setTimelineRows
767 # Organize the device or thread lists into the smallest
768 # number of rows possible, with no entry overlapping
770 # list: the list to sort (dmesg or ftrace)
771 # sortedkeys: sorted key list to use
772 def setTimelineRows(list, sortedkeys
):
775 # clear all rows and set them to undefined
776 remaining
= len(list)
780 list[item
]['row'] = -1
782 # try to pack each row with as many ranges as possible
783 while(remaining
> 0):
784 if(row
not in rowdata
):
786 for item
in sortedkeys
:
787 if(list[item
]['row'] < 0):
788 s
= list[item
]['start']
789 e
= list[item
]['end']
791 for ritem
in rowdata
[row
]:
794 if(not (((s
<= rs
) and (e
<= rs
)) or ((s
>= re
) and (e
>= re
)))):
798 rowdata
[row
].append(list[item
])
799 list[item
]['row'] = row
804 # Function: createTimeScale
806 # Create timescale lines for the dmesg and ftrace timelines
808 # t0: start time (suspend begin)
809 # tMax: end time (resume end)
810 # tSuspend: time when suspend occurs
811 def createTimeScale(t0
, tMax
, tSuspended
):
813 timescale
= "<div class=\"t\" style=\"right:{0}%\">{1}</div>\n"
814 output
= '<div id="timescale">\n'
816 # set scale for timeline
824 for i
in range(int(tTotal
/tS
)+1):
825 pos
= "%0.3f" % (100 - ((float(i
)*tS
*100)/tTotal
))
827 val
= "%0.f" % (float(i
)*tS
*1000)
830 output
+= timescale
.format(pos
, val
)
832 tSuspend
= tSuspended
- t0
833 divTotal
= int(tTotal
/tS
) + 1
834 divSuspend
= int(tSuspend
/tS
)
835 s0
= (tSuspend
- tS
*divSuspend
)*100/tTotal
836 for i
in range(divTotal
):
837 pos
= "%0.3f" % (100 - ((float(i
)*tS
*100)/tTotal
) - s0
)
838 if((i
== 0) and (s0
< 3)):
840 elif(i
== divSuspend
):
843 val
= "%0.f" % (float(i
-divSuspend
)*tS
*1000)
844 output
+= timescale
.format(pos
, val
)
848 # Function: createHTML
850 # Create the output html file.
856 # html function templates
857 headline_stamp
= '<div class="stamp">{0} {1} {2} {3}</div>\n'
858 html_zoombox
= '<center><button id="zoomin">ZOOM IN</button><button id="zoomout">ZOOM OUT</button><button id="zoomdef">ZOOM 1:1</button></center>\n<div id="dmesgzoombox" class="zoombox">\n'
859 html_timeline
= '<div id="{0}" class="timeline" style="height:{1}px">\n'
860 html_device
= '<div id="{0}" title="{1}" class="thread" style="left:{2}%;top:{3}%;height:{4}%;width:{5}%;">{6}</div>\n'
861 html_phase
= '<div class="phase" style="left:{0}%;width:{1}%;top:{2}%;height:{3}%;background-color:{4}">{5}</div>\n'
862 html_legend
= '<div class="square" style="left:{0}%;background-color:{1}"> {2}</div>\n'
863 html_timetotal
= '<table class="time1">\n<tr>'\
864 '<td class="gray">{2} Suspend Time: <b>{0} ms</b></td>'\
865 '<td class="gray">{2} Resume Time: <b>{1} ms</b></td>'\
867 html_timegroups
= '<table class="time2">\n<tr>'\
868 '<td class="green">Kernel Suspend: {0} ms</td>'\
869 '<td class="purple">Firmware Suspend: {1} ms</td>'\
870 '<td class="purple">Firmware Resume: {2} ms</td>'\
871 '<td class="yellow">Kernel Resume: {3} ms</td>'\
874 # device timeline (dmesg)
876 data
.vprint("Creating Device Timeline...")
879 # Generate the header for this timeline
884 print("ERROR: No timeline data")
886 suspend_time
= "%.0f"%(-data
.start
*1000)
887 resume_time
= "%.0f"%(data
.end
*1000)
889 devtl
.html
['timeline'] = html_timetotal
.format(suspend_time
, resume_time
, "Total")
890 sktime
= "%.3f"%((data
.dmesg
['suspend_cpu']['end'] - data
.dmesg
['suspend_general']['start'])*1000)
891 sftime
= "%.3f"%(data
.fwSuspend
/ 1000000.0)
892 rftime
= "%.3f"%(data
.fwResume
/ 1000000.0)
893 rktime
= "%.3f"%((data
.dmesg
['resume_general']['end'] - data
.dmesg
['resume_cpu']['start'])*1000)
894 devtl
.html
['timeline'] += html_timegroups
.format(sktime
, sftime
, rftime
, rktime
)
896 devtl
.html
['timeline'] = html_timetotal
.format(suspend_time
, resume_time
, "Kernel")
898 # determine the maximum number of rows we need to draw
900 for phase
in data
.dmesg
:
901 list = data
.dmesg
[phase
]['list']
902 rows
= setTimelineRows(list, list)
903 data
.dmesg
[phase
]['row'] = rows
904 if(rows
> timelinerows
):
907 # calculate the timeline height and create its bounding box
908 devtl
.setRows(timelinerows
+ 1)
909 devtl
.html
['timeline'] += html_zoombox
;
910 devtl
.html
['timeline'] += html_timeline
.format("dmesg", devtl
.height
);
912 # draw the colored boxes for each of the phases
914 phase
= data
.dmesg
[b
]
915 left
= "%.3f" % (((phase
['start']-data
.start
)*100)/tTotal
)
916 width
= "%.3f" % (((phase
['end']-phase
['start'])*100)/tTotal
)
917 devtl
.html
['timeline'] += html_phase
.format(left
, width
, "%.3f"%devtl
.scaleH
, "%.3f"%(100-devtl
.scaleH
), data
.dmesg
[b
]['color'], "")
919 # draw the time scale, try to make the number of labels readable
920 devtl
.html
['scale'] = createTimeScale(t0
, tMax
, data
.tSuspended
)
921 devtl
.html
['timeline'] += devtl
.html
['scale']
923 phaselist
= data
.dmesg
[b
]['list']
926 if(d
in data
.altdevname
):
927 name
= data
.altdevname
[d
]
929 height
= (100.0 - devtl
.scaleH
)/data
.dmesg
[b
]['row']
930 top
= "%.3f" % ((dev
['row']*height
) + devtl
.scaleH
)
931 left
= "%.3f" % (((dev
['start']-data
.start
)*100)/tTotal
)
932 width
= "%.3f" % (((dev
['end']-dev
['start'])*100)/tTotal
)
933 len = " (%0.3f ms) " % ((dev
['end']-dev
['start'])*1000)
934 color
= "rgba(204,204,204,0.5)"
935 devtl
.html
['timeline'] += html_device
.format(dev
['id'], name
+len+b
, left
, top
, "%.3f"%height
, width
, name
)
937 # timeline is finished
938 devtl
.html
['timeline'] += "</div>\n</div>\n"
940 # draw a legend which describes the phases by color
941 devtl
.html
['legend'] = "<div class=\"legend\">\n"
942 pdelta
= 100.0/data
.phases
.__len
__()
943 pmargin
= pdelta
/ 4.0
944 for phase
in data
.phases
:
945 order
= "%.2f" % ((data
.dmesg
[phase
]['order'] * pdelta
) + pmargin
)
946 name
= string
.replace(phase
, "_", " ")
947 devtl
.html
['legend'] += html_legend
.format(order
, data
.dmesg
[phase
]['color'], name
)
948 devtl
.html
['legend'] += "</div>\n"
950 hf
= open(sysvals
.htmlfile
, 'w')
953 # write the html header first (html head, css code, everything up to the start of body)
954 html_header
= "<!DOCTYPE html>\n<html>\n<head>\n\
955 <meta http-equiv=\"content-type\" content=\"text/html; charset=UTF-8\">\n\
956 <title>AnalyzeSuspend</title>\n\
957 <style type='text/css'>\n\
958 body {overflow-y: scroll;}\n\
959 .stamp {width: 100%;text-align:center;background-color:gray;line-height:30px;color:white;font: 25px Arial;}\n\
960 .callgraph {margin-top: 30px;box-shadow: 5px 5px 20px black;}\n\
961 .callgraph article * {padding-left: 28px;}\n\
962 h1 {color:black;font: bold 30px Times;}\n\
963 table {width:100%;}\n\
964 .gray {background-color:rgba(80,80,80,0.1);}\n\
965 .green {background-color:rgba(204,255,204,0.4);}\n\
966 .purple {background-color:rgba(128,0,128,0.2);}\n\
967 .yellow {background-color:rgba(255,255,204,0.4);}\n\
968 .time1 {font: 22px Arial;border:1px solid;}\n\
969 .time2 {font: 15px Arial;border-bottom:1px solid;border-left:1px solid;border-right:1px solid;}\n\
970 td {text-align: center;}\n\
971 .tdhl {color: red;}\n\
972 .hide {display: none;}\n\
973 .pf {display: none;}\n\
974 .pf:checked + label {background: url(\'data:image/svg+xml;utf,<?xml version=\"1.0\" standalone=\"no\"?><svg xmlns=\"http://www.w3.org/2000/svg\" height=\"18\" width=\"18\" version=\"1.1\"><circle cx=\"9\" cy=\"9\" r=\"8\" stroke=\"black\" stroke-width=\"1\" fill=\"white\"/><rect x=\"4\" y=\"8\" width=\"10\" height=\"2\" style=\"fill:black;stroke-width:0\"/><rect x=\"8\" y=\"4\" width=\"2\" height=\"10\" style=\"fill:black;stroke-width:0\"/></svg>\') no-repeat left center;}\n\
975 .pf:not(:checked) ~ label {background: url(\'data:image/svg+xml;utf,<?xml version=\"1.0\" standalone=\"no\"?><svg xmlns=\"http://www.w3.org/2000/svg\" height=\"18\" width=\"18\" version=\"1.1\"><circle cx=\"9\" cy=\"9\" r=\"8\" stroke=\"black\" stroke-width=\"1\" fill=\"white\"/><rect x=\"4\" y=\"8\" width=\"10\" height=\"2\" style=\"fill:black;stroke-width:0\"/></svg>\') no-repeat left center;}\n\
976 .pf:checked ~ *:not(:nth-child(2)) {display: none;}\n\
977 .zoombox {position: relative; width: 100%; overflow-x: scroll;}\n\
978 .timeline {position: relative; font-size: 14px;cursor: pointer;width: 100%; overflow: hidden; background-color:#dddddd;}\n\
979 .thread {position: absolute; height: "+"%.3f"%thread_height
+"%; overflow: hidden; line-height: 30px; border:1px solid;text-align:center;white-space:nowrap;background-color:rgba(204,204,204,0.5);}\n\
980 .thread:hover {background-color:white;border:1px solid red;z-index:10;}\n\
981 .phase {position: absolute;overflow: hidden;border:0px;text-align:center;}\n\
982 .t {position: absolute; top: 0%; height: 100%; border-right:1px solid black;}\n\
983 .legend {position: relative; width: 100%; height: 40px; text-align: center;margin-bottom:20px}\n\
984 .legend .square {position:absolute;top:10px; width: 0px;height: 20px;border:1px solid;padding-left:20px;}\n\
985 button {height:40px;width:200px;margin-bottom:20px;margin-top:20px;font-size:24px;}\n\
986 </style>\n</head>\n<body>\n"
987 hf
.write(html_header
)
989 # write the test title and general info header
990 if(data
.stamp
['time'] != ""):
991 hf
.write(headline_stamp
.format(data
.stamp
['host'],
992 data
.stamp
['kernel'], data
.stamp
['mode'], data
.stamp
['time']))
994 # write the dmesg data (device timeline)
996 hf
.write(devtl
.html
['timeline'])
997 hf
.write(devtl
.html
['legend'])
998 hf
.write('<div id="devicedetail"></div>\n')
999 hf
.write('<div id="devicetree"></div>\n')
1001 # write the ftrace data (callgraph)
1003 hf
.write('<section id="callgraphs" class="callgraph">\n')
1004 # write out the ftrace data converted to html
1005 html_func_top
= '<article id="{0}" class="atop" style="background-color:{1}">\n<input type="checkbox" class="pf" id="f{2}" checked/><label for="f{2}">{3} {4}</label>\n'
1006 html_func_start
= '<article>\n<input type="checkbox" class="pf" id="f{0}" checked/><label for="f{0}">{1} {2}</label>\n'
1007 html_func_end
= '</article>\n'
1008 html_func_leaf
= '<article>{0} {1}</article>\n'
1010 for p
in data
.phases
:
1011 list = data
.dmesg
[p
]['list']
1012 for devname
in data
.sortedDevices(p
):
1013 if('ftrace' not in list[devname
]):
1016 if(devname
in data
.altdevname
):
1017 name
= data
.altdevname
[devname
]
1018 devid
= list[devname
]['id']
1019 cg
= list[devname
]['ftrace']
1020 flen
= "(%.3f ms)" % ((cg
.end
- cg
.start
)*1000)
1021 hf
.write(html_func_top
.format(devid
, data
.dmesg
[p
]['color'], num
, name
+" "+p
, flen
))
1023 for line
in cg
.list:
1024 if(line
.length
< 0.000000001):
1027 flen
= "(%.3f ms)" % (line
.length
*1000)
1028 if(line
.freturn
and line
.fcall
):
1029 hf
.write(html_func_leaf
.format(line
.name
, flen
))
1031 hf
.write(html_func_end
)
1033 hf
.write(html_func_start
.format(num
, line
.name
, flen
))
1035 hf
.write(html_func_end
)
1036 hf
.write("\n\n </section>\n")
1037 # write the footer and close
1039 hf
.write("</body>\n</html>\n")
1043 def addScriptCode(hf
):
1046 t0
= (data
.start
- data
.tSuspended
) * 1000
1047 tMax
= (data
.end
- data
.tSuspended
) * 1000
1048 # create an array in javascript memory with the device details
1049 detail
= ' var bounds = [%f,%f];\n' % (t0
, tMax
)
1050 detail
+= ' var d = [];\n'
1051 dfmt
= ' d["%s"] = { n:"%s", p:"%s", c:[%s] };\n';
1052 for p
in data
.dmesg
:
1053 list = data
.dmesg
[p
]['list']
1055 parent
= data
.deviceParentID(d
, p
)
1056 idlist
= data
.deviceChildrenIDs(d
, p
)
1062 idstr
+= ', '+'"'+i
+'"'
1063 detail
+= dfmt
% (list[d
]['id'], d
, parent
, idstr
)
1065 # add the code which will manipulate the data in the browser
1067 '<script type="text/javascript">\n'+detail
+\
1068 ' var filter = [];\n'\
1069 ' var table = [];\n'\
1070 ' function deviceParent(devid) {\n'\
1071 ' var devlist = [];\n'\
1072 ' if(filter.indexOf(devid) < 0) filter[filter.length] = devid;\n'\
1073 ' if(d[devid].p in d)\n'\
1074 ' devlist = deviceParent(d[devid].p);\n'\
1075 ' else if(d[devid].p != "")\n'\
1076 ' devlist = [d[devid].p];\n'\
1077 ' devlist[devlist.length] = d[devid].n;\n'\
1078 ' return devlist;\n'\
1080 ' function deviceChildren(devid, column, row) {\n'\
1081 ' if(!(devid in d)) return;\n'\
1082 ' if(filter.indexOf(devid) < 0) filter[filter.length] = devid;\n'\
1083 ' var cell = {name: d[devid].n, span: 1};\n'\
1085 ' if(column >= table.length) table[column] = [];\n'\
1086 ' table[column][row] = cell;\n'\
1087 ' for(var i = 0; i < d[devid].c.length; i++) {\n'\
1088 ' var cid = d[devid].c[i];\n'\
1089 ' span += deviceChildren(cid, column+1, row+span);\n'\
1091 ' if(span == 0) span = 1;\n'\
1092 ' table[column][row].span = span;\n'\
1095 ' function deviceTree(devid, resume) {\n'\
1096 ' var html = "<table border=1>";\n'\
1099 ' plist = deviceParent(devid);\n'\
1100 ' var devidx = plist.length - 1;\n'\
1101 ' for(var i = 0; i < devidx; i++)\n'\
1102 ' table[i] = [{name: plist[i], span: 1}];\n'\
1103 ' deviceChildren(devid, devidx, 0);\n'\
1104 ' for(var i = 0; i < devidx; i++)\n'\
1105 ' table[i][0].span = table[devidx][0].span;\n'\
1106 ' for(var row = 0; row < table[0][0].span; row++) {\n'\
1107 ' html += "<tr>";\n'\
1108 ' for(var col = 0; col < table.length; col++)\n'\
1109 ' if(row in table[col]) {\n'\
1110 ' var cell = table[col][row];\n'\
1111 ' var args = "";\n'\
1112 ' if(cell.span > 1)\n'\
1113 ' args += " rowspan="+cell.span;\n'\
1114 ' if((col == devidx) && (row == 0))\n'\
1115 ' args += " class=tdhl";\n'\
1117 ' html += "<td"+args+">"+cell.name+" →</td>";\n'\
1119 ' html += "<td"+args+">← "+cell.name+"</td>";\n'\
1121 ' html += "</tr>";\n'\
1123 ' html += "</table>";\n'\
1126 ' function zoomTimeline() {\n'\
1127 ' var timescale = document.getElementById("timescale");\n'\
1128 ' var dmesg = document.getElementById("dmesg");\n'\
1129 ' var zoombox = document.getElementById("dmesgzoombox");\n'\
1130 ' var val = parseFloat(dmesg.style.width);\n'\
1131 ' var newval = 100;\n'\
1132 ' var sh = window.outerWidth / 2;\n'\
1133 ' if(this.id == "zoomin") {\n'\
1134 ' newval = val * 1.2;\n'\
1135 ' if(newval > 40000) newval = 40000;\n'\
1136 ' dmesg.style.width = newval+"%";\n'\
1137 ' zoombox.scrollLeft = ((zoombox.scrollLeft + sh) * newval / val) - sh;\n'\
1138 ' } else if (this.id == "zoomout") {\n'\
1139 ' newval = val / 1.2;\n'\
1140 ' if(newval < 100) newval = 100;\n'\
1141 ' dmesg.style.width = newval+"%";\n'\
1142 ' zoombox.scrollLeft = ((zoombox.scrollLeft + sh) * newval / val) - sh;\n'\
1144 ' zoombox.scrollLeft = 0;\n'\
1145 ' dmesg.style.width = "100%";\n'\
1147 ' var html = "";\n'\
1148 ' var t0 = bounds[0];\n'\
1149 ' var tMax = bounds[1];\n'\
1150 ' var tTotal = tMax - t0;\n'\
1151 ' var wTotal = tTotal * 100.0 / newval;\n'\
1152 ' for(var tS = 1000; (wTotal / tS) < 3; tS /= 10);\n'\
1153 ' if(tS < 1) tS = 1;\n'\
1154 ' for(var s = ((t0 / tS)|0) * tS; s < tMax; s += tS) {\n'\
1155 ' var pos = (tMax - s) * 100.0 / tTotal;\n'\
1156 ' var name = (s == 0)?"S/R":(s+"ms");\n'\
1157 ' html += \"<div class=\\\"t\\\" style=\\\"right:\"+pos+\"%\\\">\"+name+\"</div>\";\n'\
1159 ' timescale.innerHTML = html;\n'\
1161 ' function deviceDetail() {\n'\
1162 ' var devtitle = document.getElementById("devicedetail");\n'\
1163 ' devtitle.innerHTML = "<h1>"+this.title+"</h1>";\n'\
1164 ' var devtree = document.getElementById("devicetree");\n'\
1165 ' devtree.innerHTML = deviceTree(this.id, (this.title.indexOf("resume") >= 0));\n'\
1166 ' var cglist = document.getElementById("callgraphs");\n'\
1167 ' if(!cglist) return;\n'\
1168 ' var cg = cglist.getElementsByClassName("atop");\n'\
1169 ' for (var i = 0; i < cg.length; i++) {\n'\
1170 ' if(filter.indexOf(cg[i].id) >= 0) {\n'\
1171 ' cg[i].style.display = "block";\n'\
1173 ' cg[i].style.display = "none";\n'\
1177 ' window.addEventListener("load", function () {\n'\
1178 ' var dmesg = document.getElementById("dmesg");\n'\
1179 ' dmesg.style.width = "100%"\n'\
1180 ' document.getElementById("zoomin").onclick = zoomTimeline;\n'\
1181 ' document.getElementById("zoomout").onclick = zoomTimeline;\n'\
1182 ' document.getElementById("zoomdef").onclick = zoomTimeline;\n'\
1183 ' var dev = dmesg.getElementsByClassName("thread");\n'\
1184 ' for (var i = 0; i < dev.length; i++) {\n'\
1185 ' dev[i].onclick = deviceDetail;\n'\
1187 ' zoomTimeline();\n'\
1190 hf
.write(script_code
);
1192 # Function: executeSuspend
1194 # Execute system suspend through the sysfs interface
1195 def executeSuspend():
1196 global sysvals
, data
1199 pf
= open(sysvals
.powerfile
, 'w')
1200 # clear the kernel ring buffer just as we start
1201 os
.system("dmesg -C")
1204 print("START TRACING")
1205 os
.system("echo 1 > "+sysvals
.tpath
+"tracing_on")
1206 os
.system("echo SUSPEND START > "+sysvals
.tpath
+"trace_marker")
1208 if(sysvals
.rtcwake
):
1209 print("SUSPEND START")
1210 os
.system("rtcwake -s 10 -m "+sysvals
.suspendmode
)
1212 print("SUSPEND START (press a key to resume)")
1213 pf
.write(sysvals
.suspendmode
)
1214 # execution will pause here
1216 # return from suspend
1217 print("RESUME COMPLETE")
1220 os
.system("echo RESUME COMPLETE > "+sysvals
.tpath
+"trace_marker")
1221 os
.system("echo 0 > "+sysvals
.tpath
+"tracing_on")
1222 print("CAPTURING FTRACE")
1223 os
.system("echo \""+sysvals
.teststamp
+"\" > "+sysvals
.ftracefile
)
1224 os
.system("cat "+sysvals
.tpath
+"trace >> "+sysvals
.ftracefile
)
1225 # grab a copy of the dmesg output
1226 print("CAPTURING DMESG")
1227 os
.system("echo \""+sysvals
.teststamp
+"\" > "+sysvals
.dmesgfile
)
1228 os
.system("dmesg -c >> "+sysvals
.dmesgfile
)
1230 # Function: detectUSB
1232 # Detect all the USB hosts and devices currently connected
1234 global sysvals
, data
1236 for dirname
, dirnames
, filenames
in os
.walk("/sys/devices"):
1237 if(re
.match(r
".*/usb[0-9]*.*", dirname
) and
1238 "idVendor" in filenames
and "idProduct" in filenames
):
1239 vid
= os
.popen("cat %s/idVendor 2>/dev/null" % dirname
).read().replace('\n', '')
1240 pid
= os
.popen("cat %s/idProduct 2>/dev/null" % dirname
).read().replace('\n', '')
1241 product
= os
.popen("cat %s/product 2>/dev/null" % dirname
).read().replace('\n', '')
1242 name
= dirname
.split('/')[-1]
1243 if(len(product
) > 0):
1244 data
.altdevname
[name
] = "%s [%s]" % (product
, name
)
1246 data
.altdevname
[name
] = "%s:%s [%s]" % (vid
, pid
, name
)
1251 if(os
.path
.exists(sysvals
.powerfile
)):
1252 fp
= open(sysvals
.powerfile
, 'r')
1253 modes
= string
.split(fp
.read())
1257 # Function: statusCheck
1259 # Verify that the requested command and options will work
1260 def statusCheck(dryrun
):
1261 global sysvals
, data
1265 print("SUCCESS: The command should run!")
1268 # check we have root access
1270 if(os
.environ
['USER'] != "root"):
1272 doError("root access is required", False)
1274 res
[" have root access: "] = check
1276 # check sysfs is mounted
1278 if(not os
.path
.exists(sysvals
.powerfile
)):
1280 doError("sysfs must be mounted", False)
1282 res
[" is sysfs mounted: "] = check
1284 # check target mode is a valid mode
1287 if(sysvals
.suspendmode
not in modes
):
1289 doError("%s is not a value power mode" % sysvals
.suspendmode
, False)
1291 res
[" is "+sysvals
.suspendmode
+" a power mode: "] = check
1293 # check if ftrace is available
1296 if(not verifyFtrace()):
1298 doError("ftrace is not configured", False)
1300 res
[" is ftrace usable: "] = check
1303 if(sysvals
.rtcwake
):
1305 version
= os
.popen("rtcwake -V 2>/dev/null").read()
1306 if(not version
.startswith("rtcwake")):
1308 doError("rtcwake is not installed", False)
1310 res
[" is rtcwake usable: "] = check
1314 print("Checking if system can run the current command:")
1316 print("%s\t%s" % (r
, res
[r
]))
1317 if(res
[r
] != "YES"):
1320 print("SUCCESS: The command should run!")
1322 print("FAILURE: The command won't run!")
1329 print("AnalyzeSuspend")
1330 print("Usage: sudo analyze_suspend.py <options>")
1332 print("Description:")
1333 print(" Initiates a system suspend/resume while capturing dmesg")
1334 print(" and (optionally) ftrace data to analyze device timing")
1336 print(" Generates output files in subdirectory: suspend-mmddyy-HHMMSS")
1337 print(" HTML output: <hostname>_<mode>.html")
1338 print(" raw dmesg output: <hostname>_<mode>_dmesg.txt")
1339 print(" raw ftrace output (with -f): <hostname>_<mode>_ftrace.txt")
1343 print(" -h Print this help text")
1344 print(" -verbose Print extra information during execution and analysis")
1345 print(" -status Test to see if the system is enabled to run this tool")
1346 print(" -modes List available suspend modes")
1347 print(" -m mode Mode to initiate for suspend %s (default: %s)") % (modes
, sysvals
.suspendmode
)
1348 print(" -rtcwake Use rtcwake to autoresume after 10 seconds (default: disabled)")
1349 print(" -f Use ftrace to create device callgraphs (default: disabled)")
1350 print(" [re-analyze data from previous runs]")
1351 print(" -dmesg dmesgfile Create HTML timeline from dmesg file")
1352 print(" -ftrace ftracefile Create HTML callgraph from ftrace file")
1356 def doError(msg
, help):
1357 print("ERROR: %s") % msg
1363 # loop through the command line arguments
1365 args
= iter(sys
.argv
[1:])
1371 doError("No mode supplied", True)
1372 sysvals
.suspendmode
= val
1374 data
.useftrace
= True
1375 elif(arg
== "-modes"):
1377 elif(arg
== "-status"):
1379 elif(arg
== "-verbose"):
1381 elif(arg
== "-rtcwake"):
1382 sysvals
.rtcwake
= True
1383 elif(arg
== "-dmesg"):
1387 doError("No dmesg file supplied", True)
1388 data
.notestrun
= True
1389 data
.usedmesg
= True
1390 sysvals
.dmesgfile
= val
1391 elif(arg
== "-ftrace"):
1395 doError("No ftrace file supplied", True)
1396 data
.notestrun
= True
1397 data
.useftrace
= True
1398 sysvals
.ftracefile
= val
1403 doError("Invalid argument: "+arg
, True)
1405 # just run a utility command and exit
1407 if(cmd
== "status"):
1409 elif(cmd
== "modes"):
1416 # if instructed, re-analyze existing data files
1418 sysvals
.setOutputFile()
1419 data
.vprint("Output file: %s" % sysvals
.htmlfile
)
1420 if(sysvals
.dmesgfile
!= ""):
1422 if(sysvals
.ftracefile
!= ""):
1427 # verify that we can run a test
1428 data
.usedmesg
= True
1431 # prepare for the test
1434 sysvals
.initTestOutput()
1436 data
.vprint("Output files:\n %s" % sysvals
.dmesgfile
)
1438 data
.vprint(" %s" % sysvals
.ftracefile
)
1439 data
.vprint(" %s" % sysvals
.htmlfile
)