tools/telemetry/docs/pydoc/telemetry.internal.platform.linux_platform_backend.html - Issue 1647513002: Delete tools/telemetry.

Side by Side Diff: tools/telemetry/docs/pydoc/telemetry.internal.platform.linux_platform_backend.html

Issue 1647513002: Delete tools/telemetry. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Created 4 years, 11 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

« no previous file with comments | « tools/telemetry/docs/pydoc/telemetry.internal.platform.linux_based_platform_backend.html ('k') | tools/telemetry/docs/pydoc/telemetry.internal.platform.mac_platform_backend.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
	(Empty)
1

2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

3 <html><head><title>Python: module telemetry.internal.platform.linux_platform_bac kend</title>

4 <meta charset="utf-8">

5 </head><body bgcolor="#f0f0f8">

6

7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

8 <tr bgcolor="#7799ee">

9 <td valign=bottom> <br>

10 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.int ernal.platform.html"><font color="#ffffff">platform</font></a>.linux_platform_ba ckend</strong></big></big></font></td

11 ><td align=right valign=bottom

12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/internal/platform/linux_platform_backend.py">telemetry/internal/pl atform/linux_platform_backend.py</a></font></td></tr></table>

13 <p><tt># Copyright 2013 The Chromium Authors.  All rights reserved.<br>

14 # Use of this source code is governed by  a BSD-style license that can be<br>

15 # found in the LICENSE file.</tt></p>

16 <p>

17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

18 <tr bgcolor="#aa55cc">

19 <td colspan=3 valign=bottom> <br>

20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>

21

22 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>

23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.internal.util.binary_manager.html">telemetry.internal.util .binary_manager</a><br>

24 <a href="catapult_base.cloud_storage.html">catapult_base.cloud_storage</a><br>

25 <a href="telemetry.decorators.html">telemetry.decorators</a><br>

26 <a href="telemetry.internal.platform.linux_based_platform_backend.html">telemetr y.internal.platform.linux_based_platform_backend</a><br>

27 </td><td width="25%" valign=top><a href="logging.html">logging</a><br>

28 <a href="telemetry.internal.platform.power_monitor.msr_power_monitor.html">telem etry.internal.platform.power_monitor.msr_power_monitor</a><br>

29 <a href="os.html">os</a><br>

30 <a href="telemetry.core.os_version.html">telemetry.core.os_version</a><br>

31 </td><td width="25%" valign=top><a href="platform.html">platform</a><br>

32 <a href="telemetry.internal.platform.posix_platform_backend.html">telemetry.inte rnal.platform.posix_platform_backend</a><br>

33 <a href="subprocess.html">subprocess</a><br>

34 <a href="sys.html">sys</a><br>

35 </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.cor e.util</a><br>

36 </td></tr></table></td></tr></table><p>

37 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

38 <tr bgcolor="#ee77aa">

39 <td colspan=3 valign=bottom> <br>

40 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

41

42 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

43 <td width="100%"><dl>

44 <dt><font face="helvetica, arial"><a href="telemetry.internal.platform.linux_bas ed_platform_backend.html#LinuxBasedPlatformBackend">telemetry.internal.platform. linux_based_platform_backend.LinuxBasedPlatformBackend</a>(<a href="telemetry.in ternal.platform.platform_backend.html#PlatformBackend">telemetry.internal.platfo rm.platform_backend.PlatformBackend</a>)

45 </font></dt><dd>

46 <dl>

47 <dt><font face="helvetica, arial"><a href="telemetry.internal.platform.linux_pla tform_backend.html#LinuxPlatformBackend">LinuxPlatformBackend</a>(<a href="telem etry.internal.platform.posix_platform_backend.html#PosixPlatformBackend">telemet ry.internal.platform.posix_platform_backend.PosixPlatformBackend</a>, <a href="t elemetry.internal.platform.linux_based_platform_backend.html#LinuxBasedPlatformB ackend">telemetry.internal.platform.linux_based_platform_backend.LinuxBasedPlatf ormBackend</a>)

48 </font></dt></dl>

49 </dd>

50 <dt><font face="helvetica, arial"><a href="telemetry.internal.platform.posix_pla tform_backend.html#PosixPlatformBackend">telemetry.internal.platform.posix_platf orm_backend.PosixPlatformBackend</a>(<a href="telemetry.internal.platform.deskto p_platform_backend.html#DesktopPlatformBackend">telemetry.internal.platform.desk top_platform_backend.DesktopPlatformBackend</a>)

51 </font></dt><dd>

52 <dl>

53 <dt><font face="helvetica, arial"><a href="telemetry.internal.platform.linux_pla tform_backend.html#LinuxPlatformBackend">LinuxPlatformBackend</a>(<a href="telem etry.internal.platform.posix_platform_backend.html#PosixPlatformBackend">telemet ry.internal.platform.posix_platform_backend.PosixPlatformBackend</a>, <a href="t elemetry.internal.platform.linux_based_platform_backend.html#LinuxBasedPlatformB ackend">telemetry.internal.platform.linux_based_platform_backend.LinuxBasedPlatf ormBackend</a>)

54 </font></dt></dl>

55 </dd>

56 </dl>

57 <p>

58 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

59 <tr bgcolor="#ffc8d8">

60 <td colspan=3 valign=bottom> <br>

61 <font color="#000000" face="helvetica, arial"><a name="LinuxPlatformBackend">cla ss <strong>LinuxPlatformBackend</strong></a>(<a href="telemetry.internal.platfor m.posix_platform_backend.html#PosixPlatformBackend">telemetry.internal.platform. posix_platform_backend.PosixPlatformBackend</a>, <a href="telemetry.internal.pla tform.linux_based_platform_backend.html#LinuxBasedPlatformBackend">telemetry.int ernal.platform.linux_based_platform_backend.LinuxBasedPlatformBackend</a>)</font ></td></tr>

62

63 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

64 <td width="100%"><dl><dt>Method resolution order:</dt>

65 <dd><a href="telemetry.internal.platform.linux_platform_backend.html#LinuxPlatfo rmBackend">LinuxPlatformBackend</a></dd>

66 <dd><a href="telemetry.internal.platform.posix_platform_backend.html#PosixPlatfo rmBackend">telemetry.internal.platform.posix_platform_backend.PosixPlatformBacke nd</a></dd>

67 <dd><a href="telemetry.internal.platform.desktop_platform_backend.html#DesktopPl atformBackend">telemetry.internal.platform.desktop_platform_backend.DesktopPlatf ormBackend</a></dd>

68 <dd><a href="telemetry.internal.platform.linux_based_platform_backend.html#Linux BasedPlatformBackend">telemetry.internal.platform.linux_based_platform_backend.L inuxBasedPlatformBackend</a></dd>

69 <dd><a href="telemetry.internal.platform.platform_backend.html#PlatformBackend"> telemetry.internal.platform.platform_backend.PlatformBackend</a></dd>

70 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

71 </dl>

72 <hr>

73 Methods defined here:<br>

74 <dl><dt><a name="LinuxPlatformBackend-CanFlushIndividualFilesFromSystemCache"><s trong>CanFlushIndividualFilesFromSystemCache</strong></a>(self)</dt></dl>

75

76 <dl><dt><a name="LinuxPlatformBackend-CanLaunchApplication"><strong>CanLaunchApp lication</strong></a>(self, application)</dt></dl>

77

78 <dl><dt><a name="LinuxPlatformBackend-CanMeasurePerApplicationPower"><strong>Can MeasurePerApplicationPower</strong></a>(self)</dt></dl>

79

80 <dl><dt><a name="LinuxPlatformBackend-CanMonitorPower"><strong>CanMonitorPower</ strong></a>(self)</dt></dl>

81

82 <dl><dt><a name="LinuxPlatformBackend-FlushEntireSystemCache"><strong>FlushEntir eSystemCache</strong></a>(self)</dt></dl>

83

84 <dl><dt><a name="LinuxPlatformBackend-GetArchName"><strong>GetArchName</strong>< /a>(args, *kwargs)</dt></dl>

85

86 <dl><dt><a name="LinuxPlatformBackend-GetOSName"><strong>GetOSName</strong></a>( self)</dt></dl>

87

88 <dl><dt><a name="LinuxPlatformBackend-GetOSVersionName"><strong>GetOSVersionName </strong></a>(args, *kwargs)</dt></dl>

89

90 <dl><dt><a name="LinuxPlatformBackend-HasBeenThermallyThrottled"><strong>HasBeen ThermallyThrottled</strong></a>(self)</dt></dl>

91

92 <dl><dt><a name="LinuxPlatformBackend-InstallApplication"><strong>InstallApplica tion</strong></a>(self, application)</dt></dl>

93

94 <dl><dt><a name="LinuxPlatformBackend-IsThermallyThrottled"><strong>IsThermallyT hrottled</strong></a>(self)</dt></dl>

95

96 <dl><dt><a name="LinuxPlatformBackend-ReadMsr"><strong>ReadMsr</strong></a>(self , msr_number, start<font color="#909090">=0</font>, length<font color="#909090"> =64</font>)</dt></dl>

97

98 <dl><dt><a name="LinuxPlatformBackend-StartMonitoringPower"><strong>StartMonitor ingPower</strong></a>(self, browser)</dt></dl>

99

100 <dl><dt><a name="LinuxPlatformBackend-StopMonitoringPower"><strong>StopMonitorin gPower</strong></a>(self)</dt></dl>

101

102 <dl><dt><a name="LinuxPlatformBackend-__init__"><strong>__init__</strong></a>(se lf)</dt></dl>

103

104 <hr>

105 Class methods defined here:<br>

106 <dl><dt><a name="LinuxPlatformBackend-IsPlatformBackendForHost"><strong>IsPlatfo rmBackendForHost</strong></a>(cls)<font color="#909090"><font face="helvetica, a rial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></ dt></dl>

107

108 <hr>

109 Methods inherited from <a href="telemetry.internal.platform.posix_platform_backe nd.html#PosixPlatformBackend">telemetry.internal.platform.posix_platform_backend .PosixPlatformBackend</a>:<br>

110 <dl><dt><a name="LinuxPlatformBackend-GetChildPids"><strong>GetChildPids</strong ></a>(self, pid)</dt><dd><tt>Returns a list of child pi ds of \|pid\|.</tt></dd></dl>

111

112 <dl><dt><a name="LinuxPlatformBackend-GetCommandLine"><strong>GetCommandLine</st rong></a>(self, pid)</dt></dl>

113

114 <dl><dt><a name="LinuxPlatformBackend-GetFileContents"><strong>GetFileContents</ strong></a>(self, path)</dt></dl>

115

116 <dl><dt><a name="LinuxPlatformBackend-GetPsOutput"><strong>GetPsOutput</strong>< /a>(self, columns, pid<font color="#909090">=None</font>)</dt><dd><tt>Returns&nb sp;output of the 'ps' command as a list  of lines.<br>

117 Subclass should override this function.<br>

118  <br>

119 Args:<br>

120   columns: A list of require columns, e. g., ['pid', 'pss'].<br>

121   pid: If not None, returns only the&nbs p;information of the process<br>

122      with the pid.</tt></dd></dl>

123

124 <dl><dt><a name="LinuxPlatformBackend-IsApplicationRunning"><strong>IsApplicatio nRunning</strong></a>(self, application)</dt></dl>

125

126 <dl><dt><a name="LinuxPlatformBackend-LaunchApplication"><strong>LaunchApplicati on</strong></a>(self, application, parameters<font color="#909090">=None</font>, elevate_privilege<font color="#909090">=False</font>)</dt></dl>

127

128 <dl><dt><a name="LinuxPlatformBackend-RunCommand"><strong>RunCommand</strong></a >(self, args)</dt></dl>

129

130 <hr>

131 Methods inherited from <a href="telemetry.internal.platform.desktop_platform_bac kend.html#DesktopPlatformBackend">telemetry.internal.platform.desktop_platform_b ackend.DesktopPlatformBackend</a>:<br>

132 <dl><dt><a name="LinuxPlatformBackend-FlushSystemCacheForDirectory"><strong>Flus hSystemCacheForDirectory</strong></a>(self, directory)</dt></dl>

133

134 <dl><dt><a name="LinuxPlatformBackend-GetDeviceTypeName"><strong>GetDeviceTypeNa me</strong></a>(self)</dt></dl>

135

136 <hr>

137 Methods inherited from <a href="telemetry.internal.platform.linux_based_platform _backend.html#LinuxBasedPlatformBackend">telemetry.internal.platform.linux_based _platform_backend.LinuxBasedPlatformBackend</a>:<br>

138 <dl><dt><a name="LinuxPlatformBackend-GetClockTicks"><strong>GetClockTicks</stro ng></a>(args, *kwargs)</dt><dd><tt>Returns the number of c lock ticks per second.<br>

139  <br>

140 The proper way is to call os.sysconf('SC_CLK_TCK')  but that is not easy to<br>

141 do on Android/CrOS. In practice, nearly all L inux machines have a USER_HZ<br>

142 of 100, so just return that.</tt></dd></dl>

143

144 <dl><dt><a name="LinuxPlatformBackend-GetCpuStats"><strong>GetCpuStats</strong>< /a>(self, pid)</dt></dl>

145

146 <dl><dt><a name="LinuxPlatformBackend-GetCpuTimestamp"><strong>GetCpuTimestamp</ strong></a>(self)</dt></dl>

147

148 <dl><dt><a name="LinuxPlatformBackend-GetMemoryStats"><strong>GetMemoryStats</st rong></a>(self, pid)</dt></dl>

149

150 <dl><dt><a name="LinuxPlatformBackend-GetSystemCommitCharge"><strong>GetSystemCo mmitCharge</strong></a>(self)</dt><dd><tt># Get the commit c harge in kB.</tt></dd></dl>

151

152 <dl><dt><a name="LinuxPlatformBackend-GetSystemTotalPhysicalMemory"><strong>GetS ystemTotalPhysicalMemory</strong></a>(args, *kwargs)</dt></dl>

153

154 <hr>

155 Static methods inherited from <a href="telemetry.internal.platform.linux_based_p latform_backend.html#LinuxBasedPlatformBackend">telemetry.internal.platform.linu x_based_platform_backend.LinuxBasedPlatformBackend</a>:<br>

156 <dl><dt><a name="LinuxPlatformBackend-ParseCStateSample"><strong>ParseCStateSamp le</strong></a>(sample)</dt><dd><tt>Parse a single c-state r esidency sample.<br>

157  <br>

158     Args:<br>

159         sample: A sample  of c-state residency times to be parsed. Orga nized as<br>

160             a d ictionary mapping CPU name to a string contai ning all c-state<br>

161             names,&n bsp;the times in each state, the latency of&n bsp;each state, and the<br>

162             time&nbs p;at which the sample was taken all separated  by newlines.<br>

163             Ex:&nbsp ;{'cpu0': 'C0<br>

164 C1<br>

165 5000<br>

166 2000<br>

167 20<br>

168 30<br>

169 1406673171'}<br>

170  <br>

171     Returns:<br>

172         Dictionary associating&nbsp ;a c-state with a time.</tt></dd></dl>

173

174 <hr>

175 Methods inherited from <a href="telemetry.internal.platform.platform_backend.htm l#PlatformBackend">telemetry.internal.platform.platform_backend.PlatformBackend< /a>:<br>

176 <dl><dt><a name="LinuxPlatformBackend-CanCaptureVideo"><strong>CanCaptureVideo</ strong></a>(self)</dt></dl>

177

178 <dl><dt><a name="LinuxPlatformBackend-CanMonitorNetworkData"><strong>CanMonitorN etworkData</strong></a>(self)</dt></dl>

179

180 <dl><dt><a name="LinuxPlatformBackend-CanMonitorThermalThrottling"><strong>CanMo nitorThermalThrottling</strong></a>(self)</dt></dl>

181

182 <dl><dt><a name="LinuxPlatformBackend-CanTakeScreenshot"><strong>CanTakeScreensh ot</strong></a>(self)</dt></dl>

183

184 <dl><dt><a name="LinuxPlatformBackend-CooperativelyShutdown"><strong>Cooperative lyShutdown</strong></a>(self, proc, app_name)</dt><dd><tt>Cooperatively shu t down the given process from subprocess.Popen.<br >

185  <br>

186 Currently this is only implemented on Windows.&nbs p;See<br>

187 crbug.com/424024 for background on why it was&nbsp ;added.<br>

188  <br>

189 Args:<br>

190   proc: a process object returned from s ubprocess.Popen.<br>

191   app_name: on Windows, is the prefix of  the application's window<br>

192       class name that should b e searched for. This helps ensure<br>

193       that only the application's&n bsp;windows are closed.<br>

194  <br>

195 Returns True if it is believed the attempt&nb sp;succeeded.</tt></dd></dl>

196

197 <dl><dt><a name="LinuxPlatformBackend-DidCreateBrowser"><strong>DidCreateBrowser </strong></a>(self, browser, browser_backend)</dt></dl>

198

199 <dl><dt><a name="LinuxPlatformBackend-DidStartBrowser"><strong>DidStartBrowser</ strong></a>(self, browser, browser_backend)</dt></dl>

200

201 <dl><dt><a name="LinuxPlatformBackend-FlushDnsCache"><strong>FlushDnsCache</stro ng></a>(self)</dt></dl>

202

203 <dl><dt><a name="LinuxPlatformBackend-GetNetworkData"><strong>GetNetworkData</st rong></a>(self, browser)</dt></dl>

204

205 <dl><dt><a name="LinuxPlatformBackend-GetRemotePort"><strong>GetRemotePort</stro ng></a>(self, port)</dt></dl>

206

207 <dl><dt><a name="LinuxPlatformBackend-InitPlatformBackend"><strong>InitPlatformB ackend</strong></a>(self)</dt></dl>

208

209 <dl><dt><a name="LinuxPlatformBackend-IsCooperativeShutdownSupported"><strong>Is CooperativeShutdownSupported</strong></a>(self)</dt><dd><tt>Indicates wheth er CooperativelyShutdown, below, is supported.<br>

210 It is not necessary to implement it on a ll platforms.</tt></dd></dl>

211

212 <dl><dt><a name="LinuxPlatformBackend-IsDisplayTracingSupported"><strong>IsDispl ayTracingSupported</strong></a>(self)</dt></dl>

213

214 <dl><dt><a name="LinuxPlatformBackend-PathExists"><strong>PathExists</strong></a >(self, path, timeout<font color="#909090">=None</font>, retries<font color="#90 9090">=None</font>)</dt><dd><tt>Tests whether the given path  exists on the target platform.<br>

215 Args:<br>

216   path: path in request.<br>

217   timeout: timeout.<br>

218   retries: num of retries.<br>

219 Return:<br>

220   Whether the path exists on the target& nbsp;platform.</tt></dd></dl>

221

222 <dl><dt><a name="LinuxPlatformBackend-PurgeUnpinnedMemory"><strong>PurgeUnpinned Memory</strong></a>(self)</dt></dl>

223

224 <dl><dt><a name="LinuxPlatformBackend-SetFullPerformanceModeEnabled"><strong>Set FullPerformanceModeEnabled</strong></a>(self, enabled)</dt></dl>

225

226 <dl><dt><a name="LinuxPlatformBackend-SetPlatform"><strong>SetPlatform</strong>< /a>(self, platform)</dt></dl>

227

228 <dl><dt><a name="LinuxPlatformBackend-StartDisplayTracing"><strong>StartDisplayT racing</strong></a>(self)</dt><dd><tt>Start gathering a trace&nbs p;with frame timestamps close to physical<br>

229 display.</tt></dd></dl>

230

231 <dl><dt><a name="LinuxPlatformBackend-StartVideoCapture"><strong>StartVideoCaptu re</strong></a>(self, min_bitrate_mbps)</dt></dl>

232

233 <dl><dt><a name="LinuxPlatformBackend-StopDisplayTracing"><strong>StopDisplayTra cing</strong></a>(self)</dt><dd><tt>Stop gathering a trace w ith frame timestamps close to physical display.<br >

234  <br>

235 Returns a raw tracing events that contains th e timestamps of physical<br>

236 display.</tt></dd></dl>

237

238 <dl><dt><a name="LinuxPlatformBackend-StopVideoCapture"><strong>StopVideoCapture </strong></a>(self)</dt></dl>

239

240 <dl><dt><a name="LinuxPlatformBackend-TakeScreenshot"><strong>TakeScreenshot</st rong></a>(self, file_path)</dt></dl>

241

242 <dl><dt><a name="LinuxPlatformBackend-WillCloseBrowser"><strong>WillCloseBrowser </strong></a>(self, browser, browser_backend)</dt></dl>

243

244 <hr>

245 Class methods inherited from <a href="telemetry.internal.platform.platform_backe nd.html#PlatformBackend">telemetry.internal.platform.platform_backend.PlatformBa ckend</a>:<br>

246 <dl><dt><a name="LinuxPlatformBackend-CreatePlatformForDevice"><strong>CreatePla tformForDevice</strong></a>(cls, device, finder_options)<font color="#909090"><f ont face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.ty pe</a></font></font></dt></dl>

247

248 <dl><dt><a name="LinuxPlatformBackend-SupportsDevice"><strong>SupportsDevice</st rong></a>(cls, device)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>R eturns whether this platform backend supports inti alization from the<br>

249 device.</tt></dd></dl>

250

251 <hr>

252 Data descriptors inherited from <a href="telemetry.internal.platform.platform_ba ckend.html#PlatformBackend">telemetry.internal.platform.platform_backend.Platfor mBackend</a>:<br>

253 <dl><dt><strong>__dict__</strong></dt>

254 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

255 </dl>

256 <dl><dt><strong>__weakref__</strong></dt>

257 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

258 </dl>

259 <dl><dt><strong>forwarder_factory</strong></dt>

260 </dl>

261 <dl><dt><strong>is_host_platform</strong></dt>

262 </dl>

263 <dl><dt><strong>is_video_capture_running</strong></dt>

264 </dl>

265 <dl><dt><strong>network_controller_backend</strong></dt>

266 </dl>

267 <dl><dt><strong>platform</strong></dt>

268 </dl>

269 <dl><dt><strong>running_browser_backends</strong></dt>

270 </dl>

271 <dl><dt><strong>tracing_controller_backend</strong></dt>

272 </dl>

273 <dl><dt><strong>wpr_ca_cert_path</strong></dt>

274 </dl>

275 <dl><dt><strong>wpr_http_device_port</strong></dt>

276 </dl>

277 <dl><dt><strong>wpr_https_device_port</strong></dt>

278 </dl>

279 </td></tr></table></td></tr></table>

280 </body></html>

OLD	NEW