Skip to content

Commit 338f490

Browse files
John B. Wyatt IVshuahkh
John B. Wyatt IV
authored and
shuahkh
committed
pm:cpupower: Add SWIG bindings files for libcpupower
SWIG is a tool packaged in Fedora and other distros that can generate bindings from C and C++ code for several languages including Python, Perl, and Go. These bindings allows users to easily write scripts that use and extend libcpupower's functionality. Currently, only Python is provided in the makefile, but additional languages may be added if there is demand. Added suggestions from Shuah Khan for the README and license discussion. Note that while SWIG itself is GPL v3+ licensed; the resulting output, the bindings code, is permissively licensed + the license of the .o files. Please see https://swig.org/legal.html and [1] for more details. [1] https://lore.kernel.org/linux-pm/Zqv9BOjxLAgyNP5B@hatbackup/ Suggested-by: Shuah Khan <skhan@linuxfoundation.org> Signed-off-by: John B. Wyatt IV <jwyatt@redhat.com> Signed-off-by: John B. Wyatt IV <sageofredondo@gmail.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
1 parent 4b80294 commit 338f490

File tree

4 files changed

+345
-0
lines changed

4 files changed

+345
-0
lines changed

‎tools/power/cpupower/bindings/python/.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
__pycache__/
2+
raw_pylibcpupower_wrap.c
3+
*.o
4+
*.so
5+
*.py
6+
!test_raw_pylibcpupower.py
7+
# git keeps ignoring this file, use git add -f raw_libcpupower.i
8+
!raw_pylibcpupower.i

‎tools/power/cpupower/bindings/python/Makefile

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# SPDX-License-Identifier: GPL-2.0-only
2+
# Makefile for libcpupower's Python bindings
3+
#
4+
# This Makefile expects you have already run the makefile for cpupower to build
5+
# the .o files in the lib directory for the bindings to be created.
6+
7+
CC=gcc
8+
9+
LIB_DIR = ../../lib
10+
BIND_DIR = .
11+
PY_INCLUDE := $(firstword $(shell python-config --includes))
12+
#PY_INCLUDE = $(shell python-config --includes | awk '{ print $1 }')
13+
14+
OBJECTS_LIB = $(wildcard $(LIB_DIR)/*.o)
15+
OBJECTS_BIND = $(wildcard $(BIND_DIR)/*.o)
16+
17+
all: _raw_pylibcpupower.so
18+
19+
_raw_pylibcpupower.so: raw_pylibcpupower_wrap.o
20+
$(CC) -shared $(OBJECTS_LIB) raw_pylibcpupower_wrap.o -o _raw_pylibcpupower.so # raw_pylibcpupower_wrap.o
21+
# $(CC) -shared $(OBJECTS_BIND) $(OBJECTS_LIB) -o _raw_pylibcpupower.so # raw_pylibcpupower_wrap.o
22+
23+
raw_pylibcpupower_wrap.o: raw_pylibcpupower_wrap.c
24+
$(CC) -fPIC -c raw_pylibcpupower_wrap.c $(PY_INCLUDE)
25+
26+
raw_pylibcpupower_wrap.c: raw_pylibcpupower.i
27+
swig -python raw_pylibcpupower.i
28+
29+
# Will only clean the bindings folder; will not clean the actual cpupower folder
30+
clean:
31+
rm -f raw_pylibcpupower.py raw_pylibcpupower_wrap.c raw_pylibcpupower_wrap.o _raw_pylibcpupower.so

‎tools/power/cpupower/bindings/python/README

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
This folder contains the necessary files to build the Python bindings for
2+
libcpupower (aside from the libcpupower object files).
3+
4+
5+
requirements
6+
------------
7+
8+
* You need the object files in the libcpupower directory compiled by
9+
cpupower's makefile.
10+
* The SWIG program must be installed.
11+
* The Python's development libraries installed.
12+
13+
Please check that your version of SWIG is compatible with the version of Python
14+
installed on your machine by checking the SWIG changelog on their website.
15+
https://swig.org/
16+
17+
Note that while SWIG itself is GPL v3+ licensed; the resulting output,
18+
the bindings code: is permissively licensed + the license of libcpupower's .o
19+
files. For these bindings that means GPL v2.
20+
21+
Please see https://swig.org/legal.html and the discussion [1] for more details.
22+
23+
[1]
24+
https://lore.kernel.org/linux-pm/Zqv9BOjxLAgyNP5B@hatbackup/
25+
26+
27+
build
28+
-----
29+
30+
Install SWIG and the Python development files provided by your distribution.
31+
32+
Build the object files for libcpupower by running make in the cpupower
33+
directory.
34+
35+
Return to the directory this README is in to run:
36+
37+
$ make
38+
39+
40+
testing
41+
-------
42+
43+
Please verify the _raw_pylibcpupower.so and raw_pylibcpupower.py files have
44+
been created.
45+
46+
To run the test script:
47+
48+
$ python test_raw_pylibcpupower.py
49+
50+
51+
credits
52+
-------
53+
54+
Original Bindings Author:
55+
John B. Wyatt IV
56+
jwyatt@redhat.com
57+
sageofredondo@gmail.com
58+
59+
Copyright (C) 2024 Red Hat

‎tools/power/cpupower/bindings/python/raw_pylibcpupower.i

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
/* SPDX-License-Identifier: GPL-2.0-only */
2+
3+
%module raw_pylibcpupower
4+
%{
5+
#include "../../lib/cpupower_intern.h"
6+
#include "../../lib/acpi_cppc.h"
7+
#include "../../lib/cpufreq.h"
8+
#include "../../lib/cpuidle.h"
9+
#include "../../lib/cpupower.h"
10+
#include "../../lib/powercap.h"
11+
%}
12+
13+
/*
14+
* cpupower_intern.h
15+
*/
16+
17+
#define PATH_TO_CPU "/sys/devices/system/cpu/"
18+
#define MAX_LINE_LEN 4096
19+
#define SYSFS_PATH_MAX 255
20+
21+
int is_valid_path(const char *path);
22+
23+
unsigned int cpupower_read_sysfs(const char *path, char *buf, size_t buflen);
24+
25+
unsigned int cpupower_write_sysfs(const char *path, char *buf, size_t buflen);
26+
27+
/*
28+
* acpi_cppc.h
29+
*/
30+
31+
enum acpi_cppc_value {
32+
HIGHEST_PERF,
33+
LOWEST_PERF,
34+
NOMINAL_PERF,
35+
LOWEST_NONLINEAR_PERF,
36+
LOWEST_FREQ,
37+
NOMINAL_FREQ,
38+
REFERENCE_PERF,
39+
WRAPAROUND_TIME,
40+
MAX_CPPC_VALUE_FILES
41+
};
42+
43+
unsigned long acpi_cppc_get_data(unsigned int cpu,
44+
enum acpi_cppc_value which);
45+
46+
/*
47+
* cpufreq.h
48+
*/
49+
50+
struct cpufreq_policy {
51+
unsigned long min;
52+
unsigned long max;
53+
char *governor;
54+
};
55+
56+
struct cpufreq_available_governors {
57+
char *governor;
58+
struct cpufreq_available_governors *next;
59+
struct cpufreq_available_governors *first;
60+
};
61+
62+
struct cpufreq_available_frequencies {
63+
unsigned long frequency;
64+
struct cpufreq_available_frequencies *next;
65+
struct cpufreq_available_frequencies *first;
66+
};
67+
68+
69+
struct cpufreq_affected_cpus {
70+
unsigned int cpu;
71+
struct cpufreq_affected_cpus *next;
72+
struct cpufreq_affected_cpus *first;
73+
};
74+
75+
struct cpufreq_stats {
76+
unsigned long frequency;
77+
unsigned long long time_in_state;
78+
struct cpufreq_stats *next;
79+
struct cpufreq_stats *first;
80+
};
81+
82+
unsigned long cpufreq_get_freq_kernel(unsigned int cpu);
83+
84+
unsigned long cpufreq_get_freq_hardware(unsigned int cpu);
85+
86+
#define cpufreq_get(cpu) cpufreq_get_freq_kernel(cpu);
87+
88+
unsigned long cpufreq_get_transition_latency(unsigned int cpu);
89+
90+
int cpufreq_get_hardware_limits(unsigned int cpu,
91+
unsigned long *min,
92+
unsigned long *max);
93+
94+
char *cpufreq_get_driver(unsigned int cpu);
95+
96+
void cpufreq_put_driver(char *ptr);
97+
98+
struct cpufreq_policy *cpufreq_get_policy(unsigned int cpu);
99+
100+
void cpufreq_put_policy(struct cpufreq_policy *policy);
101+
102+
struct cpufreq_available_governors
103+
*cpufreq_get_available_governors(unsigned int cpu);
104+
105+
void cpufreq_put_available_governors(
106+
struct cpufreq_available_governors *first);
107+
108+
struct cpufreq_available_frequencies
109+
*cpufreq_get_available_frequencies(unsigned int cpu);
110+
111+
void cpufreq_put_available_frequencies(
112+
struct cpufreq_available_frequencies *first);
113+
114+
struct cpufreq_available_frequencies
115+
*cpufreq_get_boost_frequencies(unsigned int cpu);
116+
117+
void cpufreq_put_boost_frequencies(
118+
struct cpufreq_available_frequencies *first);
119+
120+
struct cpufreq_affected_cpus *cpufreq_get_affected_cpus(unsigned
121+
int cpu);
122+
123+
void cpufreq_put_affected_cpus(struct cpufreq_affected_cpus *first);
124+
125+
struct cpufreq_affected_cpus *cpufreq_get_related_cpus(unsigned
126+
int cpu);
127+
128+
void cpufreq_put_related_cpus(struct cpufreq_affected_cpus *first);
129+
130+
struct cpufreq_stats *cpufreq_get_stats(unsigned int cpu,
131+
unsigned long long *total_time);
132+
133+
void cpufreq_put_stats(struct cpufreq_stats *stats);
134+
135+
unsigned long cpufreq_get_transitions(unsigned int cpu);
136+
137+
int cpufreq_set_policy(unsigned int cpu, struct cpufreq_policy *policy);
138+
139+
int cpufreq_modify_policy_min(unsigned int cpu, unsigned long min_freq);
140+
141+
int cpufreq_modify_policy_max(unsigned int cpu, unsigned long max_freq);
142+
143+
int cpufreq_modify_policy_governor(unsigned int cpu, char *governor);
144+
145+
int cpufreq_set_frequency(unsigned int cpu,
146+
unsigned long target_frequency);
147+
148+
unsigned long cpufreq_get_sysfs_value_from_table(unsigned int cpu,
149+
const char **table,
150+
unsigned int index,
151+
unsigned int size);
152+
153+
/*
154+
* cpuidle.h
155+
*/
156+
157+
int cpuidle_is_state_disabled(unsigned int cpu,
158+
unsigned int idlestate);
159+
int cpuidle_state_disable(unsigned int cpu, unsigned int idlestate,
160+
unsigned int disable);
161+
unsigned long cpuidle_state_latency(unsigned int cpu,
162+
unsigned int idlestate);
163+
unsigned long cpuidle_state_usage(unsigned int cpu,
164+
unsigned int idlestate);
165+
unsigned long long cpuidle_state_time(unsigned int cpu,
166+
unsigned int idlestate);
167+
char *cpuidle_state_name(unsigned int cpu,
168+
unsigned int idlestate);
169+
char *cpuidle_state_desc(unsigned int cpu,
170+
unsigned int idlestate);
171+
unsigned int cpuidle_state_count(unsigned int cpu);
172+
173+
char *cpuidle_get_governor(void);
174+
175+
char *cpuidle_get_driver(void);
176+
177+
/*
178+
* cpupower.h
179+
*/
180+
181+
struct cpupower_topology {
182+
/* Amount of CPU cores, packages and threads per core in the system */
183+
unsigned int cores;
184+
unsigned int pkgs;
185+
unsigned int threads; /* per core */
186+
187+
/* Array gets mallocated with cores entries, holding per core info */
188+
struct cpuid_core_info *core_info;
189+
};
190+
191+
struct cpuid_core_info {
192+
int pkg;
193+
int core;
194+
int cpu;
195+
196+
/* flags */
197+
unsigned int is_online:1;
198+
};
199+
200+
int get_cpu_topology(struct cpupower_topology *cpu_top);
201+
202+
void cpu_topology_release(struct cpupower_topology cpu_top);
203+
204+
int cpupower_is_cpu_online(unsigned int cpu);
205+
206+
/*
207+
* powercap.h
208+
*/
209+
210+
struct powercap_zone {
211+
char name[MAX_LINE_LEN];
212+
/*
213+
* sys_name relative to PATH_TO_POWERCAP,
214+
* do not forget the / in between
215+
*/
216+
char sys_name[SYSFS_PATH_MAX];
217+
int tree_depth;
218+
struct powercap_zone *parent;
219+
struct powercap_zone *children[POWERCAP_MAX_CHILD_ZONES];
220+
/* More possible caps or attributes to be added? */
221+
uint32_t has_power_uw:1,
222+
has_energy_uj:1;
223+
224+
};
225+
226+
int powercap_walk_zones(struct powercap_zone *zone,
227+
int (*f)(struct powercap_zone *zone));
228+
229+
struct powercap_zone *powercap_init_zones(void);
230+
231+
int powercap_get_enabled(int *mode);
232+
233+
int powercap_set_enabled(int mode);
234+
235+
int powercap_get_driver(char *driver, int buflen);
236+
237+
int powercap_get_max_energy_range_uj(struct powercap_zone *zone, uint64_t *val);
238+
239+
int powercap_get_energy_uj(struct powercap_zone *zone, uint64_t *val);
240+
241+
int powercap_get_max_power_range_uw(struct powercap_zone *zone, uint64_t *val);
242+
243+
int powercap_get_power_uw(struct powercap_zone *zone, uint64_t *val);
244+
245+
int powercap_zone_get_enabled(struct powercap_zone *zone, int *mode);
246+
247+
int powercap_zone_set_enabled(struct powercap_zone *zone, int mode);

0 commit comments

Comments
 (0)