Project

General

Profile

Revision 5b9d5493

View differences:

doc/birq.md
1 1
---
2 2
title: The BIRQ user manual
3 3
author: Sergey Kalichev <serj.kalichev@gmail.com>
4
date: 2015
4
date: 2017
5 5
...
6 6

  
7 7
# Overview
......
89 89

  
90 90
# Usage
91 91

  
92
The current version of birq is 1.3.0.
92
The current version of birq is 1.4.0.
93 93

  
94 94
```
95 95
$ birq [options]
......
100 100
* **-h, --help** - Print help.
101 101
* **-d, --debug** - Debug mode. Don't daemonize.
102 102
* **-v, --verbose** - Be verbose.
103
* **-r, --ht** - Enable Hyper Threading support. The second threads will be considered as a real CPU. Not recommended.
103
* **-c <PATH>, --conf=<PATH>** - Config file. Default is /etc/birq/birq.conf. Implemented since birq-1.4.0. 
104
* **-x <PATH>, --pxm=<PATH>** - Specify proximity config file. Implemented since birq-1.1.0.
104 105
* **-p <path>, --pid=<path>** - File to save daemon's PID to.
105 106
* **-O <facility>, --facility=<facility>** - Syslog facility. Default is DAEMON.
107

  
108
The following options are legacy. Use config file instead command line options:
109

  
110
* **-r, --ht** - Enable Hyper Threading support. The second threads will be considered as a real CPU. Not recommended.
106 111
* **-t <float>, --threshold=<float>** - Threshold to consider CPU is overloaded, in percents. Float value. Default threshold is 99%.
107 112
* **-l <float>, --load-limit=<float>** - Don't move IRQs to CPUs loaded more than this limit, in percents. Default limit is 95%.
108 113
* **-i <sec>, --short-interval=<sec>** - Short iteration interval in seconds. It will be used when the overloaded CPU is found. Default is 2 seconds.
109 114
* **-I <sec>, --long-interval=<sec>** - Long iteration interval in seconds. It will be used when there is no overloaded CPUs. Default is 5 seconds.
110 115
* **-s <strategy>, --strategy=<strategy>** - Strategy for choosing IRQ to move. The possible values are "min", "max", "rnd". The default is "rnd". Note the birq-1.0.0 uses **-c, --choose** option name for the same functionality.
111
* **-x <PATH>, --pxm=<PATH>** - Specify proximity config file. Implemented since birq-1.1.0.
116

  
117
# Configuration file
118

  
119
The default location of config file is /etc/birq/birq.conf. But you can specify another location by '-c' birq command line option.
120

  
121
The config file can be re-read by sending SIGHUP signal to birq daemon.
122

  
123
Options:
124

  
125
* **threshold=<float>** - Threshold to consider CPU is overloaded, in percents. Float value. Default threshold is 99%.
126
* **load-limit=<float>** - Don't move IRQs to CPUs loaded more than this limit, in percents. Default limit is 95%.
127
* **short-interval=<sec>** - Short iteration interval in seconds. It will be used when the overloaded CPU is found. Default is 2 seconds.
128
* **long-interval=<sec>** - Long iteration interval in seconds. It will be used when there is no overloaded CPUs. Default is 5 seconds.
129
* **strategy=<strategy>** - Strategy for choosing IRQ to move. The possible values are "min", "max", "rnd". The default is "rnd".
130
* **exclude-cpus=<cpumap>** - It allows to exclude some CPUs from the list of CPUs that process IRQs. The 'cpumap' is bit-mask in hex format like in /proc/irq/*/smp_affinity files.
112 131

  
113 132
# Proximity
114 133

  

Also available in: Unified diff