Editing Swappolube

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

The SWAPPOLUBE is a user interface to the configuration of several parameters of the [[Nokia N900|N900]] kernel with the aim to make it faster.

It provides the ability to change a number of parameters while in operation and if chosen will make them persistent by adding a script to event.d to set them after each boot.

It has been created with PyQT (PyQt v4.7.5 for Python v2.6) and the functionality is provided by Python.

The configuration options have been discussed in (at least) two talk.maemo.org threads:
[http://talk.maemo.org/showthread.php?p=815333 "How to set swappiness"] and 
[http://talk.maemo.org/showthread.php?t=62312 "Swappolube to lubricate your gui"].

==Installation==

The application can be installed directly by the Application Manager (HAM) from the [[Extras]] repositories (check [http://maemo.org/packages/view/swappolube/ here] for its status).

You can also find the latest version in the [https://garage.maemo.org/projects/swappolube/ garage project page].

===Dependencies===

The editor depends on:

* python2.5
* python2.5-qt4-gui
* python2.5-qt4-core 
* python2.5-qt4-maemo5

==Usage==

When the application loads it reads and displays the current configuration and the options already used by the system and displays them in the appropriate sections of the GUI.

===Main configuration===

* The first row of checkboxes is to enable the setting. 
**If unchecked it will not write anything for that option.

* The second row can offer either string entry or a checkbox.
** String: is an integer value up to 4 digits.
** Checkbox: if checked will propagate a "1", if not checked it will be a "0" , i.e. set True or False for this option.

''note'': since version [[Swappolube#1.4-1]] the application supports rotation depending the orientation of the device.
  
[[Image:swappolubeMain.png|400px|Main View]] [[Image:swappolubeMain_rotated.png|280px|Main View - rotated]]

The centre part of the UI is a scrollable list. 
Scrolling to the bottom will show all available options as well as the button to store a custom version of the settings.

[[Image:swappolubeMain2.png|400px]] 
[[Image:swappolubeMain2_rotated.png|280px]]

====Current Button====
 
Pressing the "Current" button will read and display the current configuration the system uses.
 
[[Image:swappolubeMain_current.png|300px]]
 
====Proposed Button====
 
[[Image:swappolubeMain_proposed.png|300px]]

====Custom Button====
 
[[Image:swappolubeMain_custom.png|300px]]

===Drop down menu===
 
The drop down menu, aka Menubar, will offer the following options:
* Button: '''Delete Tuning File''' (will appear only if a tuning file exists)
* Button: '''Restore Default Values'''
* Button: '''Add PowerKey entry''' or '''Remove PowerKey entry''' 
* Button: '''About''' 
* Button: '''Quit'''
 
[[Image:swappolubeDropdown.png|400px]]
[[Image:swappolubeDropdown2.png|400px]]

If a tuning file exists, the option to delete it will appear:

[[Image:swappolubeDropdown3.png|400px]]

Adding a application start button in the Power key menu entry:

[[Image:swappolubePowerKeyMenu.png|400px]]

===Popup Menu===
 
Several popups inform the user on the action taken.
 
====New Config Applied====
 
[[Image:swappolube_newConfigApplied.png|300px]]
 
====New Config Created====
 
[[Image:swappolube_newConfigCreated.png|300px]]
 
====Delete Tuning File====
 
[[Image:swappolube_deleteTuning.png|300px]]
 
===About===

In the about window one can find the version of the application running as well as buttons to connect to additional documentation 
(like all the rest of the windows it supports rotation).
 
[[Image:swappolube_about1.png|360px]]
[[Image:swappolube_about2.png|360px]]

==Explanation of options==

Here is a short description of settings and the actual commands that will be used to set them. A further reading is suggested to understand better the implications involved and finding the appropriate values for your type of use of the device.

===Swappiness===

* Description: The swappiness parameter controls the tendency of the kernel to move processes out of physical memory and onto the swap disk. Because disks are much slower than RAM, this can lead to slower response times for system and applications if processes are too aggressively moved out of memory. [https://help.ubuntu.com/community/SwapFaq]
* Default: "100"
* Suggested: "30"
* Code:<pre>echo "30" > /proc/sys/vm/swappiness</pre>

===Page Cluster===

* Description: page-cluster controls the number of pages which are written to swap in a single attempt. The swap I/O size.It is a logarithmic value - setting it to zero means "1 page", setting it to 1 means "2 pages", setting it to 2 means "4 pages", etc. The default value is three (eight pages at a time). There may be some small benefits in tuning this to a different value if your workload is swap-intensive. [http://www.linuxinsight.com/proc_sys_vm_page_cluster.html]
* Default: "5"
* Suggested: "0"
* Code: <pre>echo "0" > /proc/sys/vm/page-cluster</pre>

===Laptop Mode===

* Description: laptop_mode is a knob that controls "laptop mode". When the knob is set, any physical disk I/O (that might have caused the hard disk to spin up, see <code>/proc/sys/vm/block_dump</code>) causes Linux to flush all dirty blocks. The result of this is that after a disk has spun down, it will not be spun up anymore to write dirty blocks, because those blocks had already been written immediately after the most recent read operation. The value of the laptop_mode knob determines the time between the occurrence of disk I/O and when the flush is triggered. A sensible value for the knob is 5 seconds. Setting the knob to 0 disables laptop mode.
* Default: "0"
* Suggested: "1"
* Code: <pre>echo "1" > /proc/sys/vm/laptop_mode</pre>

===oom_kill_allocating_task===

* Description: This enables or disables killing the OOM-triggering task in out-of-memory situations. If this is set to zero, the OOM killer will scan through the entire tasklist and select a task based on heuristics to kill. This normally selects a rogue memory-hogging task that frees up a large amount of memory when killed. If this is set to non-zero, the OOM killer simply kills the task that triggered the out-of-memory condition. This avoids the expensive tasklist scan. If panic_on_oom is selected, it takes precedence over whatever value is used in oom_kill_allocating_task. Taken from: [http://www.linuxinsight.com/proc_sys_vm_oom_kill_allocating_task.html]
* Default: "0"
* Suggested: "1"
* Code: <pre>echo "1" > /proc/sys/vm/oom_kill_allocating_task</pre>

===dirty_expire_centisecs===

* Description: This tunable is used to define when dirty data is old enough to be eligible for writeout by the pdflush daemons. It is expressed in 100'ths of a second. Data which has been dirty in memory for longer than this interval will be written out next time a pdflush daemon wakes up. [http://www.linuxinsight.com/proc_sys_vm_dirty_expire_centisecs.html]
* Default: "500"
* Suggested: "0"
* Code: <pre>echo "0" > /proc/sys/vm/dirty_expire_centisecs</pre>

===dirty_writeback_centisecs===

* Description: The pdflush writeback daemons will periodically wake up and write "old" data out to disk. This tunable expresses the interval between those wakeups, in 100'ths of a second. Setting this to zero disables periodic writeback altogether. [http://www.linuxinsight.com/proc_sys_vm_dirty_writeback_centisecs.html]
* Default: "500"
* Suggested: "0"
* Code: <pre>echo "0" > /proc/sys/vm/dirty_writeback_centisecs</pre>

===dirty_background_ratio===

* Description: Contains, as a percentage of total system memory, the number of pages at which the pdflush background writeback daemon will start writing out dirty data. [http://www.linuxinsight.com/proc_sys_vm_dirty_background_ratio.html]
* Default: "10"
* Suggested: "60"
* Code: <pre>echo "60" > /proc/sys/vm/dirty_background_ratio</pre>

===dirty_ratio===

* Description: Contains, as a percentage of total system memory, the number of pages at which a process which is generating disk writes will itself start writing out dirty data. [http://www.linuxinsight.com/proc_sys_vm_dirty_ratio.html]
* Default: "40"
* Suggested: "95"
* Code: <pre>echo "95" > /proc/sys/vm/dirty_ratio</pre>

===tcp_timestamps===

* Description: Enable timestamps as defined in RFC1323. [http://www.linuxinsight.com/proc_sys_net_ipv4_tcp_timestamps.html]
* Default: "1"
* Suggested: "0"
* Code: <pre>echo "0" > /proc/sys/net/ipv4/tcp_timestamps</pre>

===tcp_no_metrics_save===

* Description: Normally, TCP will remember some characteristics about the last connection in the flow cache. If tcp_no_metrics_save is set, then it doesn't. Useful for benchmarks or other tests. [http://www.linuxinsight.com/proc_sys_net_ipv4_tcp_no_metrics_save.html]
* Default: "0"
* Suggested: "1"
* Code: <pre>echo "1" > /proc/sys/net/ipv4/tcp_no_metrics_save</pre>

===VFS Cache Pressure===

* Description: Controls the tendency of the kernel to reclaim the memory which is used for caching of directory and inode objects. At the default value of vfs_cache_pressure = 100 the kernel will attempt to reclaim dentries and inodes at a "fair" rate with respect to pagecache and swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer to retain dentry and inode caches. Increasing vfs_cache_pressure beyond 100 causes the kernel to prefer to reclaim dentries and inodes.
* Default: "100"
* Suggested: "100" (in search)
* Code: <pre>echo "100" > /proc/sys/vm/vfs_cache_pressure</pre>

==Versions==

===1.4-2  ([http://maemo.org/downloads/product/Maemo5/swappolube/ current])===

====Changelog====
* Modification of the UI to expand on all the available screen estate.

====Issues====

* none known/reported.

===1.4-1===

====Changelog====
* Modifications in the postrm and the postinstall script.
* Installation triggers compilation of the code and removal of not needed files.
* Added simple file to start the UI.
* Modification of the UI to support rotation.

===1.1-6===

====Changelog====
* Added a dynamic button in the application menu to add/remove the entry in the Power Key menu.
* Modified the application menu entry for deleting the tuning file to appear only when file exists.
* Added a postrm script to remove settings made by the application when uninstalled.
* Added new entries in the update script.
* Renamed a few files and methods to have understandable descriptions.

===1.1-3===

====Changelog====

* Added new options to support modifications for interactivity improvement under high I/O load (as discussed in [http://talk.maemo.org/showthread.php?t=69973 this maemo talk] thread).
* Changes in the postinstall script to compile the code.

===1.0-1===

====Changelog====

* Added new option to store and display a custom configuration.
* Several GUI improvements (buttons moved to the left, description includes default values, ...).
* Clean-up of code; better naming of variables.
* Changes in the postinstall script to include the custom settings file.
* Bump version number - the application is now feature complete.

===0.4-1===

====Changelog====

* Restructure of the GUI to have a scrollable list and the buttons on the right.
* Added better information messages on several actions.

===0.3-4 ===

====Changelog====

* Added signals to show only the enabled options.
* Added better information messages on several actions.
* Added check if the Delete Tuning option really deleted the file.

===0.3-3===

====Changelog====

* Fix typo in the About window.

===0.3-2===

====Changelog====

* Added new menu button to restore default values.
* Code cleanup and some better comments.
* New About window with connection to the wiki page and rotation support.
* Removed Credits window (it is included in the About).
* Some small UI beatifications and better ordering of the entry fields.

===0.3-1===

====Changelog====
 
* Removed indirect dependency to the rootsh package (i.e. root command).
* Update in sudoers.
* Added new script to update, store and delete the configuration values.
* Restricted privileges of companion files.

====Issues====

* none known/reported.

===0.2.0-3===

====Changelog====
 
* Fix in the update of the VFSCachePressure value. Previous version did not store this correctly.
* Fix in the reading of values from the system. A hiden linebreak (shown as space) was added in all values after hitting "Current" which blocked their later update.

====Issues====

* depends indirectly on rootsh package.

===0.2.0-2===

====Changelog====

* Change of the Laptop Mode setting to string.
* Updated description.
* Some UI changes - beautifications.

===0.2.0-1===

====Changelog====

* Added two new buttons (current & proposed) to set the settings in the GUI. 
* Added icons for the application manager and the desktop.
* Many code changes/splits in methods.
* Added several protections when handling updates.
* Fixed in GUI directional errors.
* Constrained the entry values to 4 digits.

===0.1.0-8===

====Changelog====

* New button to update the settings. 
* Transformed several fields from boolean to strings.

''NOTE:'' For older versions please see the changelogs in the [https://garage.maemo.org/projects/swappolube/ project's garage page]

==Future Development==

''Note'': Just add your thoughts (username)..
* <strike>Read the current configuration stored in the tuning script and automatically display it.</strike>
* <strike>Provide a button to show the default configuration.</strike>
* <strike>Store/Read the configuration from a file (easy for sharing).</strike>

==Swappolube-nogui==

For those who don't want to tinker too much with kernel parameters, the package swappolube-nogui provides a fixed tuning profile "known to work".
Kernel parameters are modified at installation time, and the modification persist at the next boots. Package removal reverts parameters to the default values.
The swappolube-nogui package conflicts with the swappolube package because both use the same script /etc/event.d/tuning for persistence. The common application managers should prompt for removal of one when trying to install the other.

* [http://maemo.org/packages/view/swappolube-nogui/ swappolube-nogui package status]   
* [https://garage.maemo.org/projects/swappolube/ Garage project page].

==License==

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 only.

==Disclaimer==

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

[[Category:Software]]
[[Category:N900]]

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Retrieved from "http://wiki.maemo.org/Swappolube"

Personal tools

Navigation

Views

Editing Swappolube

@@ Line 37: / Line 37: @@
 ** Checkbox: if checked will propagate a "1", if not checked it will be a "0" , i.e. set True or False for this option.
-[[Image:swappolubeMain.png|400px|Main View]]
+''note'': since version [[Swappolube#1.4-1]] the application supports rotation depending the orientation of the device.
+[[Image:swappolubeMain.png|400px|Main View]] [[Image:swappolubeMain_rotated.png|280px|Main View - rotated]]
 The centre part of the UI is a scrollable list.
@@ Line 43: / Line 45: @@
 [[Image:swappolubeMain2.png|400px]]
-''note'': since version [[Swappolube#1.4-1|1.4]] the application supports rotation depending the orientation of the device.
-[[Image:swappolubeMain_rotated.png|280px|Main View - rotated]]
 [[Image:swappolubeMain2_rotated.png|280px]]
@@ Line 104: / Line 102: @@
 (like all the rest of the windows it supports rotation).
-[[Image:swappolube_about1.png|280px]]
+[[Image:swappolube_about1.png|360px]]
-[[Image:swappolube_about2.png|280px]]
+[[Image:swappolube_about2.png|360px]]
 ==Explanation of options==
@@ Line 127: / Line 125: @@
 ===Laptop Mode===
-* Description: When the value for laptop_mode is set to be something other than zero, any physical disk I/O (that might have caused the hard disk to spin up, see <code>/proc/sys/vm/block_dump</code>) causes Linux to flush all dirty blocks after the value in seconds. The result of this is that after a disk has spun down, it will not be spun up anymore to write dirty blocks, because those blocks had already been written immediately after the most recent read operation. The value of the laptop_mode knob determines the time between the occurrence of disk I/O and when the flush is triggered. A sensible value for the knob is 5 seconds. Setting the knob to 0 disables laptop mode. Since this mode has been designed with mechanical hard drives in mind to maximize the time between spin-ups that the flash memory in a cellphone does not need to worry itself with, it might actually be better to set this to zero.
+* Description: laptop_mode is a knob that controls "laptop mode". When the knob is set, any physical disk I/O (that might have caused the hard disk to spin up, see <code>/proc/sys/vm/block_dump</code>) causes Linux to flush all dirty blocks. The result of this is that after a disk has spun down, it will not be spun up anymore to write dirty blocks, because those blocks had already been written immediately after the most recent read operation. The value of the laptop_mode knob determines the time between the occurrence of disk I/O and when the flush is triggered. A sensible value for the knob is 5 seconds. Setting the knob to 0 disables laptop mode.
 * Default: "0"
 * Suggested: "1"
@@ Line 134: / Line 132: @@
 ===oom_kill_allocating_task===
-* Description: This enables or disables killing the OOM-triggering task in out-of-memory situations. If this is set to zero, the OOM killer will scan through the entire tasklist and select a task based on heuristics to kill. This normally selects a rogue memory-hogging task that frees up a large amount of memory when killed. If this is set to non-zero, the OOM killer simply kills the task that triggered the out-of-memory condition. This avoids the expensive tasklist scan and the potential randomness of the task that the manager picked to kill. If panic_on_oom is selected, it takes precedence over whatever value is used in oom_kill_allocating_task. Taken from: [http://www.linuxinsight.com/proc_sys_vm_oom_kill_allocating_task.html]
+* Description: This enables or disables killing the OOM-triggering task in out-of-memory situations. If this is set to zero, the OOM killer will scan through the entire tasklist and select a task based on heuristics to kill. This normally selects a rogue memory-hogging task that frees up a large amount of memory when killed. If this is set to non-zero, the OOM killer simply kills the task that triggered the out-of-memory condition. This avoids the expensive tasklist scan. If panic_on_oom is selected, it takes precedence over whatever value is used in oom_kill_allocating_task. Taken from: [http://www.linuxinsight.com/proc_sys_vm_oom_kill_allocating_task.html]
 * Default: "0"
 * Suggested: "1"
@@ Line 169: / Line 167: @@
 ===tcp_timestamps===
-* Description: Enable timestamps as defined in RFC1323. [http://www.linuxinsight.com/proc_sys_net_ipv4_tcp_timestamps.html] Turning off TCP timestamps can be counterproductive, since timestamps are used to estimate data packet round-trip times and transmission timeouts. Disabling RFC1323 timestamps may then result in poor performance in conditions of frequent packet losses. The Swappolube suggested default is to turn them off, but it may not in fact be optimal.
+* Description: Enable timestamps as defined in RFC1323. [http://www.linuxinsight.com/proc_sys_net_ipv4_tcp_timestamps.html]
 * Default: "1"
 * Suggested: "0"
@@ Line 190: / Line 188: @@
 ==Versions==
-===1.4-2  ([http://maemo.org/downloads/product/Maemo5/swappolube/ stable version])===
+===1.4-2  ([http://maemo.org/downloads/product/Maemo5/swappolube/ current])===
 ====Changelog====