amd-debug-tools 0.2.7__py3-none-any.whl → 0.2.9__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of amd-debug-tools might be problematic. Click here for more details.

@@ -1,184 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: amd-debug-tools
3
- Version: 0.2.7
4
- Summary: debug tools for AMD systems
5
- Author-email: Mario Limonciello <superm1@kernel.org>
6
- License-Expression: MIT
7
- Project-URL: Homepage, https://web.git.kernel.org/pub/scm/linux/kernel/git/superm1/amd-debug-tools.git/
8
- Classifier: Programming Language :: Python :: 3
9
- Classifier: Operating System :: POSIX :: Linux
10
- Requires-Python: >=3.7
11
- Description-Content-Type: text/markdown
12
- License-File: LICENSE
13
- Requires-Dist: pyudev
14
- Requires-Dist: packaging
15
- Requires-Dist: pandas
16
- Requires-Dist: jinja2
17
- Requires-Dist: tabulate
18
- Requires-Dist: seaborn
19
- Requires-Dist: cysystemd
20
- Requires-Dist: Jinja2
21
- Requires-Dist: matplotlib
22
- Requires-Dist: seaborn
23
- Dynamic: license-file
24
-
25
- # Helpful tools for debugging AMD Zen systems
26
- [![codecov](https://codecov.io/github/superm1/amd-debug-tools/graph/badge.svg?token=Z9WTBZADGT)](https://codecov.io/github/superm1/amd-debug-tools)
27
- [![PyPI](https://img.shields.io/pypi/v/amd-debug-tools.svg)](https://pypi.org/project/amd-debug-tools/)
28
-
29
- This repository hosts open tools that are useful for debugging issues on AMD systems.
30
-
31
- ## Installation
32
- It is suggested to install tools in a virtual environment either using
33
- `pipx` or `python3 -m venv`.
34
-
35
- ### From PyPI
36
- `amd-debug-tools` is distributed as a python wheel, which is a
37
- binary package format for Python. To install from PyPI, run the following
38
- command:
39
-
40
- pipx install amd-debug-tools
41
-
42
- ### From source
43
- To build the package from source, you will need to the `python3-build`
44
- package natively installed by your distribution package manager. Then you
45
- can generate and install a wheel by running the following commands:
46
-
47
- python3 -m build
48
- pipx install dist/amd-debug-tools-*.whl
49
-
50
- ### Ensuring path
51
- If you have not used a `pipx` environment before, you may need to run the following command
52
- to set up the environment:
53
-
54
- pipx ensurepath
55
-
56
- This will add the `pipx` environment to your path.
57
-
58
- ### Running in tree
59
- If you want to run the tools in tree, you need to make sure that distro dependencies
60
- that would normally install into a venv are installed. This can be done by running:
61
-
62
- ./install_deps.py
63
-
64
- After dependencies are installed, you can run the tools by running:
65
-
66
- ./amd_s2idle.py
67
- ./amd_bios.py
68
- ./amd_pstate.py
69
-
70
- ## amd-s2idle
71
- `amd-s2idle` is a tool used for analyzing the entry and exit of the s2idle
72
- state of a Linux system.
73
-
74
- It is intended to use with Linux kernel 6.1 or later and works by hooking
75
- into dynamic debugging messages and events that are generated by the kernel.
76
-
77
- For analysis of power consumption issues it can be hooked into `systemd` to
78
- run a command to capture data right before and after the system enters and
79
- exits the s2idle state.
80
-
81
- 4 high level commands are supported.
82
-
83
- ### `amd-s2idle install`
84
- This will install the systemd hook so that data will be captured before and
85
- after the system enters and exits the s2idle state.
86
-
87
- This will also install a bash completion script that can be used for other
88
- commands.
89
-
90
- **NOTE:** This command is only supported when run from a venv.
91
-
92
- ### `amd-s2idle uninstall`
93
- This will uninstall the systemd hook and remove the bash completion script.
94
-
95
- **NOTE:** This command is only supported when run from a venv.
96
-
97
- ### `amd-s2idle test`
98
- This will run a suspend cycle with a timer based wakeup and capture relevant
99
- data into a database and produce a report. This can also be used to run multiple cycles.
100
-
101
- The following optional arguments are supported for this command:
102
-
103
- --count COUNT Number of cycles to run
104
- --duration DURATION Duration of the cycle in seconds
105
- --wait WAIT Time to wait before starting the cycle in seconds
106
- --format FORMAT Format of the report to produce (html, txt or md)
107
- --report-file File to write the report to
108
- --force Run a test cycle even if the system fails to pass prerequisite checks
109
- --random Run sleep cycles for random durations and waits, using the --duration and --wait arguments as an upper bound
110
- --logind Use logind to suspend the system
111
- --tool-debug Enable debug logging
112
- --bios-debug Enable BIOS debug logging instead of notify logging
113
-
114
- If the tool is launched with an environment that can call `xdg-open`, the report
115
- will be opened in a browser.
116
-
117
- ### `amd-s2idle report`
118
- This will produce a report from the data captured by the `test` command
119
- and/or from the systemd hook. The report will default to 60 days of data.
120
-
121
- The following optional arguments are supported for this command:
122
-
123
- --since SINCE Date to start the report from
124
- --until UNTIL Date to end the report at
125
- --format FORMAT Format of the report to produce (html, txt or md)
126
- --report-file File to write the report to
127
- --tool-debug Enable tool debug logging
128
- --report-debug
129
- --no-report-debug
130
- Include debug messages in report (WARNING: can significantly increase report size)
131
- If the tool is launched with an environment that can call `xdg-open`, the report
132
- will be opened in a browser.
133
-
134
- ### `amd-s2idle --version`
135
- This will print the version of the tool and exit.
136
-
137
- ### Debug output
138
- All commands support the `--tool-debug` argument which will enable extra debug output. This is often needed for debugging issues with a particular cycle.
139
-
140
- **NOTE:** enabling debug output significantly increases the size of the report.
141
- It's suggested that you use `--since` and `--until` to focus on the cycles that you are interested in.
142
-
143
- ## amd-bios
144
- `amd-bios` is a a tool that can be used to enable or disable BIOS AML debug logging
145
- -and to parse a kernel log that contains BIOS logs.
146
-
147
- ### `amd-bios trace`
148
- Modify BIOS AML trace debug logging.
149
-
150
- One of the following arguments must be set for this command:
151
-
152
- --enable Enable BIOS AML tracing
153
- --disable Disable BIOS AML tracing
154
-
155
- The following optional arguments are supported for this command:
156
-
157
- --tool-debug Enable tool debug logging
158
-
159
- ### `amd-bios parse`
160
- Parses a kernel log that contains BIOS AML debug logging and produces a report.
161
-
162
- The following optional arguments are supported for this command:
163
-
164
- --input INPUT Optional input file to parse
165
- --tool-debug Enable tool debug logging
166
-
167
- ### `amd-bios --version`
168
- This will print the version of the tool and exit.
169
-
170
- ## amd-pstate
171
- `amd-pstate` is a tool used for identification of issues with amd-pstate.
172
- It will capture some state from the system as well as from the machine specific registers that
173
- amd-pstate uses.
174
-
175
- ## amd-ttm
176
- `amd-ttm` is a tool used for managing the TTM memory settings on AMD systems.
177
-
178
- ## Compatibility scripts
179
-
180
- Compatibility scripts are provided for the previous names the tools went by:
181
- `amd_s2idle.py`, `amd_bios.py` and `amd_pstate.py`.
182
- These allow cloning the repository and running the scripts without installing
183
- the package.
184
-
@@ -1,47 +0,0 @@
1
- launcher.py,sha256=M8kT9DtyZoQgZaKWDbSBu4jsS6tZF1gWko3sovNVyag,947
2
- test_acpi.py,sha256=wtS43Rz95h7YEEJBeFa6Mswaeo4syBZrw4hY8i0YbJY,3117
3
- test_batteries.py,sha256=nN5pfP5El7Whypq3HHEpW8bufdf5EWSTVGbayfNQYP4,3360
4
- test_bios.py,sha256=x_KLmQqGEbQhTugyWCHGXjGp2H1dCdhRz0kgw2Big8w,9276
5
- test_common.py,sha256=EYbyObC9vIXquT3EbgQ_98V4Zw2ebUCY9cfS9VOoywE,19722
6
- test_database.py,sha256=q5ZjI5u20f7ki6iCY5o1iPi0YOvPz1_W0LTDraU8mN4,10040
7
- test_display.py,sha256=hHggv-zBthF1BlwWWSjzAm7BBw1DWcElwil5xAuz87g,5822
8
- test_failures.py,sha256=H1UxXeVjhJs9-j9yas4vwAha676GX1Es7Kz8RN2B590,6845
9
- test_installer.py,sha256=oDMCvaKqqAWjTggltacnasQ-s1gyUvXPDcNrCUGnux4,10216
10
- test_kernel.py,sha256=2EXrLht5ZWdT4N5pb_F3zqZl9NEghjnDpcMGCMw3obI,7917
11
- test_launcher.py,sha256=8g8CBTvLX64Us4RmHtRPSdpV5E2kQFaudBl7VIsxLhE,1733
12
- test_prerequisites.py,sha256=-q6v80QXDMB_Mdek2KZTmKfKcRVZnHf8SBEhcT0RyIY,88498
13
- test_pstate.py,sha256=a9oAJ9-LANX32XNQhplz6Y75VNYc__QqoSBKIrwvANg,6058
14
- test_s2idle.py,sha256=FxsyujgX9Px3m56VzHNeA8yMTHmJiRLWxYt-fh1m5gw,33585
15
- test_sleep_report.py,sha256=ANuxYi_C1oSKAi4xUU2wBu4SwJtcZA7VPpazBe3_WUQ,6922
16
- test_ttm.py,sha256=QrCdRodQ_CD3nyDqKodb6yR158mgE0iIM5f1fV1Axu8,10515
17
- test_validator.py,sha256=RpjyzxDpExhLcSJfQ0UDuonr4sTFAfa7sTtY5g7tc_Q,36410
18
- test_wake.py,sha256=6zi5GVFHQKU1sTWw3O5-aGriB9uu5713QLn4l2wjhpM,7152
19
- amd_debug/__init__.py,sha256=66Ya61av8RCws6bEY_vdujGmjBIZ6_UqfuWHgMNNOJY,1271
20
- amd_debug/acpi.py,sha256=fkD3Sov8cRT5ryPlakRlT7Z9jiCLT9x_MPWxt3xU_tc,3161
21
- amd_debug/battery.py,sha256=WN-6ys9PHCZIwg7PdwyBOa62GjBp8WKG0v1YZt5_W5s,3122
22
- amd_debug/bios.py,sha256=y1iwDqX-mXCkoUtHSi-XO9pN-oLfaqbAMzANGI12zHs,4041
23
- amd_debug/common.py,sha256=fHrmSEVerVAE7KXjspf60eOAetUO7K9s1yhNyE2xi94,11598
24
- amd_debug/database.py,sha256=GkRg3cmaNceyQ2_hy0MBAlMbnTDPHo2co2o4ObWpnQg,10621
25
- amd_debug/display.py,sha256=5L9x9tI_UoulHpIvuxuVASRtdXta7UCW_JjTb5StEB0,953
26
- amd_debug/failures.py,sha256=z4O4Q-akv3xYGssSZFCqE0cDE4P9F_aw1hxil3McoD4,22910
27
- amd_debug/installer.py,sha256=6_Y0oHypW-oh_P8N9JW7fzbqidpsi5jphw9_8s5Qvso,14288
28
- amd_debug/kernel.py,sha256=HpX-QRh8tgkvqKnExfo2JrYqfcbMY8GNgDrC2VVV0Oc,11638
29
- amd_debug/prerequisites.py,sha256=zK-IXL52p_jomA1SsS-6btIHuaapNKW4sD-Fy0wBr68,51399
30
- amd_debug/pstate.py,sha256=AOKCvUb0ngwHU2C59uSKrFwdLzEyn8r1w2DgWhZAMKM,9583
31
- amd_debug/s2idle-hook,sha256=LLiaqPtGd0qetu9n6EYxKHZaIdHpVQDONdOuSc0pfFg,1695
32
- amd_debug/s2idle.py,sha256=4cxHNfmvq11BE-AtkEthIqR-xrWmxW2LTa6oVDtGztY,13284
33
- amd_debug/sleep_report.py,sha256=hhqu711AKtjeYF2xmGcejyCyyPtmq4-gC_hROUCrC0g,17317
34
- amd_debug/ttm.py,sha256=huXDqdcNrn0JIn-UGNTS7pXTBL5YB3gmi_OP9rfXskA,4664
35
- amd_debug/validator.py,sha256=X-cNFVvHWKzFgT4aR0Td3I2kwQRBOK4vQUk6L276VCQ,34153
36
- amd_debug/wake.py,sha256=xT8WrFrN6voCmXWo5dsn4mQ7iR2QJxHrrYBd3EREG-Q,3936
37
- amd_debug/bash/amd-s2idle,sha256=g_cle1ElCJpwE4wcLezL6y-BdasDKTnNMhrtzKLE9ks,1142
38
- amd_debug/templates/html,sha256=JfGhpmHIB2C2GItdGI1kuC8uayqEVgrpQvAWAj35eZ4,14580
39
- amd_debug/templates/md,sha256=r8X2aehnH2gzj0WHYTZ5K9wAqC5y39i_3nkDORSC0uM,787
40
- amd_debug/templates/stdout,sha256=hyoOJ96K2dJfnWRWhyCuariLKbEHXvs9mstV_g5aMdI,469
41
- amd_debug/templates/txt,sha256=nNdsvbPFOhGdL7VA-_4k5aN3nB-6ouGQt6AsWst7T3w,649
42
- amd_debug_tools-0.2.7.dist-info/licenses/LICENSE,sha256=RBlZI6r3MRGzymI2VDX2iW__D2APDbMhu_Xg5t6BWeo,1066
43
- amd_debug_tools-0.2.7.dist-info/METADATA,sha256=02ahxaxXDJf3w6V3xoGItmpby-iDiyJskFc_rhhYNQw,6971
44
- amd_debug_tools-0.2.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
45
- amd_debug_tools-0.2.7.dist-info/entry_points.txt,sha256=hIskDz6k0_6q1qpqWCpVFsca_djxAqkLrUAwzAyEGuE,144
46
- amd_debug_tools-0.2.7.dist-info/top_level.txt,sha256=VvGkkY5I7O3HoLNrc2VfgjCA-to3PUjnnKd7juONaFw,243
47
- amd_debug_tools-0.2.7.dist-info/RECORD,,