From patchwork Wed Jul 24 22:11:19 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "John B. Wyatt IV" X-Patchwork-Id: 13741413 X-Patchwork-Delegate: shuah@kernel.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6262013B5AE for ; Wed, 24 Jul 2024 22:14:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721859242; cv=none; b=pl6dUb8+6LZshxHTqjVQ8hqQXyvK43weZCPmw3NIlqtuK0qT3PgY6YK6SoNuptexI4crq/OW8hCDcsdl86D9J2JUHUykCrWGh39ZwbPVbgIzcBofCD+TFGotUvK60A8ioaKZlkcwgcMoBTWNGDm+znwoTOGjCn4Uri1eL+rntBc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721859242; c=relaxed/simple; bh=rdxqSma22UUNhO8GRP1xfHjICj9ttsvc4m76NncJc0k=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Q1WZhzOKOkJzV39dv6NFfhmPHkWwfyryGdB8X0Y/keqnk32sDkLB0iwukLaKAOgR4SKZl/3KL2ezVAZDAh6/wbDRQBWZgGldxsJw9GePIxhMhI8aS0Vyl6G4VY708dAkAkKurDgws6zzyn+YNkYw0Cf3VxEbABP/C7CyvmXOk4c= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=TqQf+X1g; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="TqQf+X1g" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1721859239; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ZZDN0EpYdGH4QTVcef68WhZG9zzbZoHSE92tNxLJUpI=; b=TqQf+X1gB9zzACYY4/yWHQPii474gf+wFX9zCu6ywtXvmksoUgE5fbNEOmvt79isV67JWm UUZjpO3Rz4+7YaD9Xhvv1HMa/EGUVyaCCpHDyN87hn4lCKMWs5o2kWrVegHvH70oDM/YXA pkOo0029JDe50+iMsy9doxXPVAOSYDw= Received: from mail-vs1-f70.google.com (mail-vs1-f70.google.com [209.85.217.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-376-bx1wUlTUPWmuYHuLJDn4AA-1; Wed, 24 Jul 2024 18:13:58 -0400 X-MC-Unique: bx1wUlTUPWmuYHuLJDn4AA-1 Received: by mail-vs1-f70.google.com with SMTP id ada2fe7eead31-4929b9c17feso113626137.3 for ; Wed, 24 Jul 2024 15:13:55 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721859234; x=1722464034; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=ZZDN0EpYdGH4QTVcef68WhZG9zzbZoHSE92tNxLJUpI=; b=ZoeWF2y0sJd7t967iNfM/EQmgEoTsIMPqcB4XenCNz16c7IefylgfrXAgLnptG3Q25 yrEhzuZJBCRT+2k17HzcSnXPrSj52a4laEmZtZIcTNTmsYTy9Ya425qhsGUOV+fvoeGF OtSVK3tL2VCm+ujocGNxJL4zY8ezgOZ5tpZYOuTF+91PdTHhJBJRsOkTWP3u5aSLmUaT WTnksQJhfmfQxLT6QnWo2q9h/+3GHNS7t0i+8x4QWv8s2inylsIVPYXJfNCPid4U6u/r 5c/lV4ric4kuYKjnwt6EeQpXk083qe0rSKdCch5ew8cF05q+TJArgyPjP7rQjIXnWAkX g9SQ== X-Gm-Message-State: AOJu0YzM3b6Ocy61AtPviVgrPkj17ogyX9fFt3AXg2LDq49T85YzoF2I rz9lbHtPZqsTZbKrYAoHuJNDl/7/G0urZX8P/TB+DMvPrWF6ujpL9sJ4i+oU+ww5Cs8rCMhaOYd 0yWX0jVe0Ptnrr6t7vh9hCO5o1f/iwEezoqzGYgLfe1CqaIcCoJqWWeQvvuDIfQKxswOG4GroLx pNXJWqljBWkTePS+O2sHshyqBmMzoKz+zYF3xOZeLP X-Received: by 2002:a05:6102:2c86:b0:492:8dbc:c1c with SMTP id ada2fe7eead31-493d9aceda8mr167990137.16.1721859233698; Wed, 24 Jul 2024 15:13:53 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFcd3gUwhhsm4W+Vb5EQ8SWvV970VSd0d0iC1pmnTuNlKfecuyjyVo3PW17Zk2UTrUJmcQwlg== X-Received: by 2002:a05:6102:2c86:b0:492:8dbc:c1c with SMTP id ada2fe7eead31-493d9aceda8mr167960137.16.1721859233335; Wed, 24 Jul 2024 15:13:53 -0700 (PDT) Received: from hatbackup.redhat.com ([71.217.44.209]) by smtp.gmail.com with ESMTPSA id af79cd13be357-7a1d7435227sm7542685a.82.2024.07.24.15.13.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Jul 2024 15:13:53 -0700 (PDT) From: "John B. Wyatt IV" To: linux-pm@vger.kernel.org, "Thomas Renninger" , "Shuah Khan" , "Shuah Khan" Cc: "John B. Wyatt IV" , linux-kernel@vger.kernel.org, "John Kacur" , "Tomas Glozar" , "John B. Wyatt IV" Subject: [PATCH 1/2] Add SWIG bindings files for libcpupower Date: Wed, 24 Jul 2024 18:11:19 -0400 Message-ID: <20240724221122.54601-2-jwyatt@redhat.com> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240724221122.54601-1-jwyatt@redhat.com> References: <20240724221122.54601-1-jwyatt@redhat.com> Precedence: bulk X-Mailing-List: linux-pm@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 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. A latter commit will demonstrate taking a SWIG .i file and the libcpupower object files to generate the bindings. Note that while SWIG itself is GPL v3+ licensed; the resulting output, the bindings code, is permissively licensed. Please see https://swig.org/legal.html for more details. Signed-off-by: John B. Wyatt IV Signed-off-by: John B. Wyatt IV --- .../power/cpupower/bindings/python/.gitignore | 8 ++++ tools/power/cpupower/bindings/python/Makefile | 31 +++++++++++++ tools/power/cpupower/bindings/python/README | 33 ++++++++++++++ .../bindings/python/raw_pylibcpupower.i | 45 +++++++++++++++++++ 4 files changed, 117 insertions(+) create mode 100644 tools/power/cpupower/bindings/python/.gitignore create mode 100644 tools/power/cpupower/bindings/python/Makefile create mode 100644 tools/power/cpupower/bindings/python/README create mode 100644 tools/power/cpupower/bindings/python/raw_pylibcpupower.i diff --git a/tools/power/cpupower/bindings/python/.gitignore b/tools/power/cpupower/bindings/python/.gitignore new file mode 100644 index 000000000000..b83e0f5e26a0 --- /dev/null +++ b/tools/power/cpupower/bindings/python/.gitignore @@ -0,0 +1,8 @@ +# SPDX-License-Identifier: GPL-2.0-only +__pycache__/ +*.c +*.o +*.so +*.py +!test_raw_pylibcpupower.py +!raw_pylibcpupower.i # git keeps ignoring this file diff --git a/tools/power/cpupower/bindings/python/Makefile b/tools/power/cpupower/bindings/python/Makefile new file mode 100644 index 000000000000..a6c779333f8d --- /dev/null +++ b/tools/power/cpupower/bindings/python/Makefile @@ -0,0 +1,31 @@ +# SPDX-License-Identifier: GPL-2.0-only +# Makefile for libcpupower Python bindings +# +# This Makefile expects you have already run the makefile for cpupower to build +# the .o files in the lib directory for the bindings to be created. + +CC=gcc + +LIB_DIR = ../../lib +BIND_DIR = . +PY_INCLUDE := $(firstword $(shell python-config --includes)) +#PY_INCLUDE = $(shell python-config --includes | awk '{ print $1 }') + +OBJECTS_LIB = $(wildcard $(LIB_DIR)/*.o) +OBJECTS_BIND = $(wildcard $(BIND_DIR)/*.o) + +all: _raw_pylibcpupower.so + +_raw_pylibcpupower.so: raw_pylibcpupower_wrap.o + $(CC) -shared $(OBJECTS_LIB) raw_pylibcpupower_wrap.o -o _raw_pylibcpupower.so # raw_pylibcpupower_wrap.o +# $(CC) -shared $(OBJECTS_BIND) $(OBJECTS_LIB) -o _raw_pylibcpupower.so # raw_pylibcpupower_wrap.o + +raw_pylibcpupower_wrap.o: raw_pylibcpupower_wrap.c + $(CC) -fPIC -c raw_pylibcpupower_wrap.c $(PY_INCLUDE) + +raw_pylibcpupower_wrap.c: raw_pylibcpupower.i + swig -python raw_pylibcpupower.i + +# Will only clean the bindings folder; will not clean the actual cpupower folder +clean: + rm -f raw_pylibcpupower.py raw_pylibcpupower_wrap.c raw_pylibcpupower_wrap.o _raw_pylibcpupower.so diff --git a/tools/power/cpupower/bindings/python/README b/tools/power/cpupower/bindings/python/README new file mode 100644 index 000000000000..a2663a2d23d1 --- /dev/null +++ b/tools/power/cpupower/bindings/python/README @@ -0,0 +1,33 @@ + +This folder contains the necessary files to build Python bindings for libcpupower. + +To begin, first build the object files for libcpupower by running make in +the cpupower directory. + +Next you will need to install SWIG. Using Fedora: + +sudo dnf install swig + +Please check that your version of SWIG is compatible with the version of +Python installed on your machine by checking the SWIG changelog on their +website. https://swig.org/ + +Then return to the directory this README is in to run: + +make + +To run the test script: + +python test_raw_pylibcpupower.py + +Note that while SWIG itself is GPL v3+ licensed; the resulting output, +the bindings code, is permissively licensed. Please see +https://swig.org/legal.html for more details. + +Original Bindings Author: +John B. Wyatt IV +jwyatt@redhat.com +sageofredondo@gmail.com + +Copyright (C) 2024 Red Hat + diff --git a/tools/power/cpupower/bindings/python/raw_pylibcpupower.i b/tools/power/cpupower/bindings/python/raw_pylibcpupower.i new file mode 100644 index 000000000000..9a920ecf1f47 --- /dev/null +++ b/tools/power/cpupower/bindings/python/raw_pylibcpupower.i @@ -0,0 +1,45 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ + +%module raw_pylibcpupower +%{ +#include "../../lib/cpupower_intern.h" +#include "../../lib/acpi_cppc.h" +#include "../../lib/cpufreq.h" +#include "../../lib/cpuidle.h" +#include "../../lib/cpupower.h" +#include "../../lib/powercap.h" +%} + +/* + * cpuidle.h + */ + +unsigned int cpuidle_state_count(unsigned int cpu); +int cpuidle_state_disable(unsigned int cpu, unsigned int idlestate, unsigned int disable); + +/* + * cpupower.h + */ + +struct cpupower_topology { + /* Amount of CPU cores, packages and threads per core in the system */ + unsigned int cores; + unsigned int pkgs; + unsigned int threads; /* per core */ + + /* Array gets mallocated with cores entries, holding per core info */ + struct cpuid_core_info *core_info; +}; + +struct cpuid_core_info { + int pkg; + int core; + int cpu; + + /* flags */ + unsigned int is_online:1; +}; + +int get_cpu_topology(struct cpupower_topology *cpu_top); +void cpu_topology_release(struct cpupower_topology cpu_top); +int cpupower_is_cpu_online(unsigned int cpu); From patchwork Wed Jul 24 22:11:20 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "John B. Wyatt IV" X-Patchwork-Id: 13741412 X-Patchwork-Delegate: shuah@kernel.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A237813CA97 for ; Wed, 24 Jul 2024 22:13:59 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721859241; cv=none; b=UVkgaEmx4Y1SmD+CBNVqRSFT5xcmbcdoOa0m4722371Lk1owBDsinV4Jbahd6Q4nZAaTFDKaHLo+Xrlkk528FxKeNBv9tv0Ad2JdjvH5PzBdLsRYsXbbBMiCPnHLpV76+uWotN8Mh9JI3ljof7Uv62OwixjcQ7FTIe/D/jhAqYA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721859241; c=relaxed/simple; bh=gNmWzbPCwsNn3iBECMmvE1pa/3xdm645kUt+trqbGcc=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=QhwbNcGKqMusfyuQCKJzGZn0ZvG0/+HEf3aMZWonwu0ZmF7qZ42zRyZbGwthwlV4gM1l5EobF+oRQ9ueP7VfEn8mju35NEmw2t+XxmhjNXCZ4zMD8V/k0M7ZZcy1We6GBcoyXjsY6Bt1ZxlpwAYN/SeqyuGpc0orT5gMCgQjMX8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=arbF3inG; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="arbF3inG" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1721859238; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=1oDlIFLL5CHDliwMOUVKHCIO32QiYYQzCXXQNVqBa5o=; b=arbF3inG6LF6vrqTDNZU73E+EAsZnpTEXJn32lEYzbonfHwZQNy0lyTs/rkNC+JslvfyfT c7ct3fBIe2Zp1sPe2V2AvFdmnvAL7jiuhWGKQGOWJoYsKMpGT0i441jIgxx3V5NU9b//TM lTvywpez78Ije+VDziitsnPVvSd+mPQ= Received: from mail-oo1-f70.google.com (mail-oo1-f70.google.com [209.85.161.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-256-4Y2hU7ycMpKhUdNFcJsE3Q-1; Wed, 24 Jul 2024 18:13:57 -0400 X-MC-Unique: 4Y2hU7ycMpKhUdNFcJsE3Q-1 Received: by mail-oo1-f70.google.com with SMTP id 006d021491bc7-5c44c86c4a8so312276eaf.0 for ; Wed, 24 Jul 2024 15:13:57 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721859235; x=1722464035; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=1oDlIFLL5CHDliwMOUVKHCIO32QiYYQzCXXQNVqBa5o=; b=ccLXliD+UttTJP4xof6CbmEYFxqoMvVMeU+an2Iqsm6+cEtbqrtCSxFzAxm7kEALEN j3zlWqt5mg3LOGuEFZFxn76ZZRxvCmfCRuJk9ETSYeRLW0/GUhEw2NaqP152iwv3Oc+H vuF7M0kSa3nOCjABpEvZNDO9TaN8t3XXHQqOSC5SaXCWeB58cP3fSv/5UaNyBmGFBYfH tg7X29h4+Jk+Phoo08N13UpZI5Yhk8OtMIR2ZvCSjkPm5sPq9AJes3ppWb9ux0KY1r+W ZmoRAXh+v4+3n+4C+jqNq7cbwZHHJ5kh6neRlqxJ/6SUkEnYMozYlmw77iDoLAODeIkX 8eeA== X-Gm-Message-State: AOJu0YzLBje1DJkYvBdGYr04wcjTU8c5kNE/ZfaUF/VNfcgnZc5oLsZ1 pPHkrebfALuUFGmw36zM/rWmvaCx1x7avR4iaeV1qAnhFC0eXMUduPIKLd9OZkG4SJ1UV7NzDmn zro+4QeXr7QPQInH2xkIut9gFD4ggbTYsbJ9nUNm0HafGlUvC0Da+Rk5J2RZVPQmfFFNEI9bDAp JYCDTocDBrlNYC12JdZcEyEl2pMRpjkNTmVVaIzBk1 X-Received: by 2002:a05:6359:4595:b0:1a8:c0fd:cf2d with SMTP id e5c5f4694b2df-1acf8869b8fmr161040755d.9.1721859235558; Wed, 24 Jul 2024 15:13:55 -0700 (PDT) X-Google-Smtp-Source: AGHT+IF8XXO039xnVzDHimc3GzVZUVBr2GcfRiEvX7FSDvCGjlyRhlzijS5vlgD8K63bsxdP19pT4Q== X-Received: by 2002:a05:6359:4595:b0:1a8:c0fd:cf2d with SMTP id e5c5f4694b2df-1acf8869b8fmr161037355d.9.1721859235139; Wed, 24 Jul 2024 15:13:55 -0700 (PDT) Received: from hatbackup.redhat.com ([71.217.44.209]) by smtp.gmail.com with ESMTPSA id af79cd13be357-7a1d7435227sm7542685a.82.2024.07.24.15.13.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Jul 2024 15:13:54 -0700 (PDT) From: "John B. Wyatt IV" To: linux-pm@vger.kernel.org, "Thomas Renninger" , "Shuah Khan" , "Shuah Khan" Cc: "John B. Wyatt IV" , linux-kernel@vger.kernel.org, "John Kacur" , "Tomas Glozar" , "John B. Wyatt IV" Subject: [PATCH 2/2] Include test_raw_pylibcpupower.py Date: Wed, 24 Jul 2024 18:11:20 -0400 Message-ID: <20240724221122.54601-3-jwyatt@redhat.com> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240724221122.54601-1-jwyatt@redhat.com> References: <20240724221122.54601-1-jwyatt@redhat.com> Precedence: bulk X-Mailing-List: linux-pm@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This script demonstrates how to make use of, and tests, the bindings. The .i file currently only binds a limited subsection of functionality with the bindings. Signed-off-by: John B. Wyatt IV Signed-off-by: John B. Wyatt IV --- .../bindings/python/test_raw_pylibcpupower.py | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100755 tools/power/cpupower/bindings/python/test_raw_pylibcpupower.py diff --git a/tools/power/cpupower/bindings/python/test_raw_pylibcpupower.py b/tools/power/cpupower/bindings/python/test_raw_pylibcpupower.py new file mode 100755 index 000000000000..3d6f62b9556a --- /dev/null +++ b/tools/power/cpupower/bindings/python/test_raw_pylibcpupower.py @@ -0,0 +1,42 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0-only + +import raw_pylibcpupower as p + +# Simple function call + +""" +Get cstate count +""" +cpu_cstates_count = p.cpuidle_state_count(0) +if cpu_cstates_count > -1: + print(f"CPU 0 has {cpu_cstates_count} c-states") +else: + print(f"cstate count error: return code: {cpu_cstates_count}") + +""" +Disable cstate (will fail if the above is 0, ex: a virtual machine) +""" +cstate_disabled = p.cpuidle_state_disable(0, 0, 1) +if cpu_cstates_count == 0: + print(f"CPU 0 has {cpu_cstates_count} c-states") +else: + print(f"cstate count error: return code: {cpu_cstates_count}") + +match cstate_disabled: + case 0: + print(f"CPU state disabled") + case -1: + print(f"Idlestate not available") + case _: + print(f"Not documented") + + +# Pointer example + +topo = p.cpupower_topology() +total_cpus = p.get_cpu_topology(topo) +if total_cpus > 0: + print(f"Number of total cpus: {total_cpus} and number of cores: {topo.cores}") +else: + print(f"Error: could not get cpu topology")