auto-cpufreq/README.md

239 lines
12 KiB
Markdown
Raw Normal View History

2020-01-02 19:12:34 +01:00
# auto-cpufreq
Automatic CPU speed & power optimizer for Linux based on active monitoring of laptop's battery state, CPU usage, CPU temperature and system load. Ultimately allowing you to improve battery life without making any compromises.
2020-01-02 19:12:34 +01:00
For tl;dr folks there's a: [Youtube: auto-cpufreq - tool demo](https://www.youtube.com/watch?v=QkYRpVEEIlg)
2020-01-03 23:23:04 +01:00
2021-10-24 07:21:58 +02:00
[![](http://img.youtube.com/vi/QkYRpVEEIlg/0.jpg)](http://www.youtube.com/watch?v=QkYRpVEEIlg)
2020-01-03 23:23:04 +01:00
## Looking for developers and co-maintainers
auto-cpufreq is looking for [co-maintainers & open source developers to help shape future of the project!](https://github.com/AdnanHodzic/auto-cpufreq/discussions/312)
## Why do I need auto-cpufreq?
2020-01-02 19:12:34 +01:00
One of the problems with Linux today on laptops is that CPU will run in unoptimized manner which will negatively reflect on battery life. For example, CPU will run using "performance" governor with turbo boost enabled regardless if it's plugged in to power or not.
2020-09-15 17:36:00 +02:00
Issue can be mitigated by using tools like [indicator-cpufreq](https://itsfoss.com/cpufreq-ubuntu/) or [cpufreq](https://github.com/konkor/cpufreq), but these still require manual action from your side which can be daunting and cumbersome.
2020-01-02 19:12:34 +01:00
Using tools like [TLP](https://github.com/linrunner/TLP) can help in this situation with extending battery life (which is something I used to do for numerous years), but it also might come with its own set of problems, like losing turbo boost.
2020-01-02 19:12:34 +01:00
2020-01-05 11:33:35 +01:00
With that said, I needed a simple tool which would automatically make "cpufreq" related changes, save battery like TLP, but let Linux kernel do most of the heavy lifting. That's how auto-cpufreq was born.
2020-01-02 19:12:34 +01:00
Please note: auto-cpufreq aims to replace TLP in terms of functionality and after you install auto-cpufreq _it's recommended to remove TLP_. If both are used for same functionality, i.e: to set CPU frequencies it'll lead to unwanted results like overheating. Hence, only use [both tools in tandem](https://github.com/AdnanHodzic/auto-cpufreq/discussions/176) if you know what you're doing.
2020-01-05 00:02:24 +01:00
Tool/daemon that does not conflict with auto-cpufreq in any way and is even recommended to have running alongside is [thermald](https://wiki.debian.org/thermald).
2020-08-06 21:06:04 +02:00
#### Supported architectures and devices
Supported devices must have an Intel, AMD or ARM CPUs. This tool was developed to improve performance and battery life on laptops, but running it on desktop/servers (to lower power consumption) should also be possible.
2020-08-06 21:06:04 +02:00
2020-01-03 16:48:03 +01:00
## Features
2020-01-02 19:12:34 +01:00
* Monitoring
2020-01-02 19:12:34 +01:00
* Basic system information
2020-09-13 21:33:32 +02:00
* CPU frequency (system total & per core)
* CPU usage (system total & per core)
* CPU temperature (total average & per core)
2020-01-02 19:12:34 +01:00
* Battery state
* System load
* CPU frequency scaling, governor and [turbo boost](https://en.wikipedia.org/wiki/Intel_Turbo_Boost) management based on
* Battery state
* CPU usage (total & per core)
* CPU temperature in combination with CPU utilization/load (prevent overheating)
* System load
2020-01-02 19:12:34 +01:00
* Automatic CPU & power optimization (temporary and persistent)
## Installing auto-cpufreq
2020-01-02 19:12:34 +01:00
2020-03-19 22:22:40 +01:00
### Snap store
2020-02-15 11:31:56 +01:00
2020-03-19 22:22:40 +01:00
auto-cpufreq is available on [snap store](https://snapcraft.io/auto-cpufreq), or can be installed using CLI:
2020-03-19 22:22:40 +01:00
```
sudo snap install auto-cpufreq
```
**Please note:**
* Make sure [snapd](https://snapcraft.io/docs/installing-snapd) is installed and `snap version` version is >= 2.44 for `auto-cpufreq` to fully work due to [recent snapd changes](https://github.com/snapcore/snapd/pull/8127).
* Fedora users will [encounter following error](https://twitter.com/killyourfm/status/1291697985236144130). Due to `cgroups v2` [being in development](https://github.com/snapcore/snapd/pull/7825). This problem can be resolved by either running `sudo snap run auto-cpufreq` after snap installation. Or using [auto-cpufreq-installer](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) which doesn't have this issue.
2020-02-15 11:31:56 +01:00
2020-03-19 22:22:40 +01:00
### auto-cpufreq-installer
2020-01-07 17:29:20 +01:00
Get source code, run installer and follow on screen instructions:
2020-01-02 19:12:34 +01:00
```
git clone https://github.com/AdnanHodzic/auto-cpufreq.git
2020-03-19 22:22:40 +01:00
cd auto-cpufreq && sudo ./auto-cpufreq-installer
```
2020-01-07 08:56:47 +01:00
2020-02-15 11:31:56 +01:00
In case you encounter any problems with `auto-cpufreq-installer`, please [submit a bug report](https://github.com/AdnanHodzic/auto-cpufreq/issues/new).
2020-08-12 16:56:42 +02:00
### AUR package (Arch/Manjaro Linux)
2020-01-11 16:36:59 +01:00
2020-08-14 15:45:41 +02:00
[AUR package is available](https://aur.archlinux.org/packages/auto-cpufreq-git/) for install. After which `auto-cpufreq` will be available as a binary and you can refer to [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options).
**Please note:** If you want to install auto-cpufreq daemon, do not run `auto-cpufreq --install` otherwise you'll run into an issue: [#91](https://github.com/AdnanHodzic/auto-cpufreq/issues/91), [#96](https://github.com/AdnanHodzic/auto-cpufreq/issues/96).
2020-08-14 15:45:41 +02:00
Instead run `systemctl start auto-cpufreq` to start the service. Run `systemctl status auto-cpufreq` to see the status of service, and `systemctl enable auto-cpufreq` for service to persist running accross reboots.
2020-01-02 19:12:34 +01:00
## Configuring auto-cpufreq
While auto-cpufreq makes all decisions automatically based on various factors like cpu usage, temperature or system load. It's possible to perform addition configurations in 2 ways:
### 1: power_helper.py script
2022-06-10 07:38:24 +02:00
If detected as running auto-cpufreq will disable [GNOME Power profiles service](https://twitter.com/fooctrl/status/1467469508373884933), which would otherwise cause conflicts and cause problems. By default auto-cpufreq uses `balanced` mode which also works the best on various systems. However, if you're not reaching maximum frequencies your CPU is capable of with auto-cpufreq, you can switch to `performance` mode. Which will result in higher frequencies by default, but also higher use of energy (battery consumption).
This can be done by running: `sudo python3 power_helper.py --gnome_power_disable performance`
After auto-cpufreq git repo has been cloned (`git clone https://github.com/AdnanHodzic/auto-cpufreq.git`), navagiate to directory where `power_helper.py` script resides by running: `cd auto-cpufreq/auto_cpufreq`
After this step, all necessary changes will still be made automatically. However, if you wish to perform additonal "manual" settings this can be done by following instructions explained in next step.
### 2: auto-cpufreq config file
You can configure profiles for battery and power supply. These profiles will let you pick which governor to use and how and when turbo boost is enabled. The possible values for turbo boost behavior are `always`, `auto` and `never`. The default behavior is `auto`, which only kicks in during high load.
By default, auto-cpufreq does not use the config file! If you wish to use it, location where config needs to be placed for it to be read automatically is: `/etc/auto-cpufreq.conf`
#### Example config file contents
```
# settings for when connected to a power source
[charger]
# see available governors by running: cat /sys/devices/system/cpu/cpu0/cpufreq/scaling_available_governors
# preferred governor.
governor = performance
# minimum cpu frequency (in kHz)
# example: for 800 MHz = 800000 kHz --> scaling_min_freq = 800000
# see conversion info: https://www.rapidtables.com/convert/frequency/mhz-to-hz.html
# to use this feature, uncomment the following line and set the value accordingly
# scaling_min_freq = 800000
# maximum cpu frequency (in kHz)
# example: for 1GHz = 1000 MHz = 1000000 kHz -> scaling_max_freq = 1000000
# see conversion info: https://www.rapidtables.com/convert/frequency/mhz-to-hz.html
# to use this feature, uncomment the following line and set the value accordingly
# scaling_max_freq = 1000000
# turbo boost setting. possible values: always, auto, never
turbo = auto
# settings for when using battery power
[battery]
# see available governors by running: cat /sys/devices/system/cpu/cpu0/cpufreq/scaling_available_governors
# preferred governor
governor = powersave
# minimum cpu frequency (in kHz)
# example: for 800 MHz = 800000 kHz --> scaling_min_freq = 800000
# see conversion info: https://www.rapidtables.com/convert/frequency/mhz-to-hz.html
# to use this feature, uncomment the following line and set the value accordingly
# scaling_min_freq = 800000
# maximum cpu frequency (in kHz)
# see conversion info: https://www.rapidtables.com/convert/frequency/mhz-to-hz.html
# example: for 1GHz = 1000 MHz = 1000000 kHz -> scaling_max_freq = 1000000
# to use this feature, uncomment the following line and set the value accordingly
# scaling_max_freq = 1000000
# turbo boost setting. possible values: always, auto, never
turbo = auto
```
## How to run auto-cpufreq
2020-01-02 19:12:34 +01:00
auto-cpufreq can be run by simply running the `auto-cpufreq` and following on screen instructions, i.e:
2020-01-02 19:12:34 +01:00
`sudo auto-cpufreq`
2020-01-02 19:12:34 +01:00
2020-01-03 16:48:03 +01:00
## auto-cpufreq modes and options
2020-01-02 19:12:34 +01:00
### Monitor
2020-01-02 19:12:34 +01:00
`sudo auto-cpufreq --monitor`
2020-01-02 19:12:34 +01:00
No changes are made to the system, and is solely made for demonstration purposes what auto-cpufreq could do differently for your system.
### Live
2020-01-02 19:12:34 +01:00
`sudo auto-cpufreq --live`
2020-01-02 19:12:34 +01:00
Necessary changes are temporarily made to the system which are lost with system reboot. This mode is made to evaluate what the system would behave with auto-cpufreq permanently running on the system.
2020-01-02 19:12:34 +01:00
### Install - auto-cpufreq daemon
Necessary changes are made to the system for auto-cpufreq CPU optimizaton to persist across reboots. Daemon is deployed and then started as a systemd service. Changes are made automatically and live stats are generated for monitoring purposes.
`sudo auto-cpufreq --install`
After daemon is installed, `auto-cpufreq` is available as a binary and is running in the background. Its stats can be viewed by running: `auto-cpufreq --stats`
Since daemon is running as a systemd service, its status can be seen by running:
`systemctl status auto-cpufreq`
If install has been performed as part of snap package, daemon status can be verified by running:
`systemctl status snap.auto-cpufreq.service.service`
### Remove - auto-cpufreq daemon
auto-cpufreq daemon and its systemd service, along with all its persistent changes can be removed by running:
`sudo auto-cpufreq --remove`
### Stats
2020-01-02 19:12:34 +01:00
If daemon has been installed, live stats of CPU/system load monitoring and optimization can be seen by running:
2020-01-02 19:12:34 +01:00
`auto-cpufreq --stats`
2020-01-03 16:39:35 +01:00
## Troubleshooting
**Q:** If after installing auto-cpufreq you're (still) experiencing:
* high CPU temperatures
* CPU is not scaling to minimum/maximum frequencies
* suboptimal CPU peformance
**A:** If you're using `intel_pstate` CPU management driver consider changing it to: `acpi-cpufreq`.
This can be done by editting `/etc/default/grub` file and appending `intel_pstate=disable` to `GRUB_CMDLINE_LINUX_DEFAULT` line, followed by `sudo update-grub`
Example line change:
```
GRUB_CMDLINE_LINUX_DEFAULT="quiet splash intel_pstate=disable"
```
2020-01-03 16:48:03 +01:00
## Discussion:
2020-01-03 16:39:35 +01:00
* Blogpost: [auto-cpufreq - Automatic CPU speed & power optimizer for Linux](http://foolcontrol.org/?p=3124)
2020-05-14 18:10:32 +02:00
## Donate
Showing your support and appreciation for auto-cpufreq project can be done in two ways:
* Financial donation
* Code contribution
### Financial donation
If auto-cpufreq helped you out and you find it useful, show your appreciation by donating (any amount) to the project!
2020-05-14 18:10:32 +02:00
##### PayPal
[![paypal](https://www.paypalobjects.com/en_US/NL/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=7AHCP5PU95S4Y&item_name=Contribution+for+work+on+auto-cpufreq&currency_code=EUR&source=url)
##### BitCoin
[bc1qlncmgdjyqy8pe4gad4k2s6xtyr8f2r3ehrnl87](bitcoin:bc1qlncmgdjyqy8pe4gad4k2s6xtyr8f2r3ehrnl87)
[![bitcoin](https://foolcontrol.org/wp-content/uploads/2019/08/btc-donate-displaylink-debian.png)](bitcoin:bc1qlncmgdjyqy8pe4gad4k2s6xtyr8f2r3ehrnl87)
### Code contribution
Other ways of supporting the project consists of making a code or documentation contribution. If you have an idea for a new features or want to implement some of the existing feature requests or fix some of the [bugs & issues](https://github.com/AdnanHodzic/auto-cpufreq/issues). Please make your changes and submit a [pull request](https://github.com/AdnanHodzic/auto-cpufreq/pulls) which I'll be glad to review. If your changes are accepted you'll be credited as part of [releases page](https://github.com/AdnanHodzic/auto-cpufreq/releases).
2021-12-17 12:01:06 +01:00
**Please note: auto-cpufreq is looking for co-maintainers & open source developers to [help shape future of the project!](https://github.com/AdnanHodzic/auto-cpufreq/discussions/312)**