Difference between revisions of "Linux-pf"

From ArchWiki
Jump to: navigation, search
(Merge installation section.)
m (Added a note that pfkernel unofficial repo packages are not signed and SigLevel must be set in pacman.conf. Also added notes about generic vs platform optimized binaries.)
(22 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
[[Category:Kernel]]
 
[[Category:Kernel]]
{{Article summary start}}
 
{{Article summary text|'''Linux-pf and linux-pf-headers'''}}
 
* Current version: '''3.4.3-1'''
 
* Kernel version: ''3.4.4''
 
 
{{Article summary heading|Related}}
 
{{Article summary wiki|Tuxonice}}
 
[https://bitbucket.org/nous/linux-pf/ linux-pf mercurial repository]
 
 
[https://aur.archlinux.org/packages.php?ID=50956 AUR linux-pf page]
 
 
[http://pf.natalenko.name/ Patchset homepage]
 
 
[http://pf.natalenko.name/forum Patchset community forum]
 
 
[http://freecode.com/projects/pf-kernel Patchset changelog]
 
 
[https://aur.archlinux.org/packages.php?ID=58913 iptables-pf]
 
{{Article summary end}}
 
 
 
[http://pf.natalenko.name/ Linux-pf] is a kernel package based on the stock -ARCH kernel, patched with a row of significant patches:
 
[http://pf.natalenko.name/ Linux-pf] is a kernel package based on the stock -ARCH kernel, patched with a row of significant patches:
 
* [http://ck-hack.blogspot.com/ The latest Con Kolivas' -ck patchset, including BFS]
 
* [http://ck-hack.blogspot.com/ The latest Con Kolivas' -ck patchset, including BFS]
 
* [[TuxOnIce]]
 
* [[TuxOnIce]]
* [http://algo.ing.unimo.it/people/paolo/disk_sched/ BFQ (as default I/O scheduler)]
+
* [http://algo.ing.unimo.it/people/paolo/disk_sched/ BFQ] (as default I/O scheduler)
 +
* [http://kerneldedup.org/projects/uksm/ UKSM]
 
* [http://aufs.sourceforge.net/ AUFS3]
 
* [http://aufs.sourceforge.net/ AUFS3]
* [http://www.linuximq.net/ LinuxIMQ]
 
* [http://l7-filter.clearfoundation.com/ l7-filter]
 
  
 
== Installation ==
 
== Installation ==
The reference PKGBUILD can be found at the [https://aur.archlinux.org/packages.php?ID=50956 AUR linux-pf page] and at the [https://bitbucket.org/nous/linux-pf bitbucket.org mercurial repository].
 
  
=== From repository ===
+
The reference PKGBUILD can be found at the {{AUR|linux-pf}} and at the [https://bitbucket.org/nous/linux-pf bitbucket.org mercurial repository].
 +
 
 +
=== From the unofficial repository (recommended) ===
 +
 
 
Precompiled packages, generic and CPU-family optimized are uploaded at the [http://dl.dropbox.com/u/11734958/index.html pfkernel unofficial repository], usually within 6 hours of the AUR update for x86_64 and 12 hours for i686. Append the following to {{ic|/etc/pacman.conf}} to activate the pfkernel repo:
 
Precompiled packages, generic and CPU-family optimized are uploaded at the [http://dl.dropbox.com/u/11734958/index.html pfkernel unofficial repository], usually within 6 hours of the AUR update for x86_64 and 12 hours for i686. Append the following to {{ic|/etc/pacman.conf}} to activate the pfkernel repo:
 
:{{bc|<nowiki>
 
:{{bc|<nowiki>
Line 38: Line 19:
 
# linux-pf, kernel26-pf, gdm-old, nvidia-pf, nvidia-96xx, xchat-greek, arora-git
 
# linux-pf, kernel26-pf, gdm-old, nvidia-pf, nvidia-96xx, xchat-greek, arora-git
 
Server = http://dl.dropbox.com/u/11734958/$arch
 
Server = http://dl.dropbox.com/u/11734958/$arch
 +
SigLevel = Optional
 
</nowiki>}}
 
</nowiki>}}
Running '''''pacman -Syyl pfkernel''''' will update all repos and show the available packages from pfkernel. Afterwards, installing linux-pf is as trivial as running '''''pacman -S linux-pf linux-pf-headers''''', but additional configuration steps must be performed; see the [[Linux-pf#Installation|Installation section]] below.
+
Packages in the unofficial repository are not signed, so you will need to set SigLevel to Optional or Never. Running {{ic|$ pacman -Syyl pfkernel}} will update all repos and show the available packages from pfkernel. Afterwards, just install {{Pkg|linux-pf}} {{Pkg|linux-pf-headers}} (for generic binaries - platform-specific binaries are also available and will be listed in the output from the above pacman command), but additional configuration steps must be performed; see the [[#Installation|Installation]] section.
 +
 
 +
=== Manual compilation ===
  
=== Manually compilation ==
 
 
There's a number of options a user is asked to choose from, should he/she select to compile from the PKGBUILD:
 
There's a number of options a user is asked to choose from, should he/she select to compile from the PKGBUILD:
::{{bc|<nowiki>
+
{{bc|<nowiki>
 
==> Hit <Y> to use your running kernel's config
 
==> Hit <Y> to use your running kernel's config
 
     (needs IKCONFIG and IKCONFIG_PROC)
 
     (needs IKCONFIG and IKCONFIG_PROC)
Line 53: Line 36:
 
The <L> option tries some kind of autodetection of the user's hardware: it first tries to use the [[modprobed_db]] module database, then falls back to the linux kernel's '''''make localmodconfig''''' functionality. The last option is self-explanatory.
 
The <L> option tries some kind of autodetection of the user's hardware: it first tries to use the [[modprobed_db]] module database, then falls back to the linux kernel's '''''make localmodconfig''''' functionality. The last option is self-explanatory.
  
::{{bc|<nowiki>
+
{{bc|<nowiki>
 
==> Kernel configuration options before build:
 
==> Kernel configuration options before build:
 
     <M> make menuconfig (console menu)
 
     <M> make menuconfig (console menu)
Line 64: Line 47:
 
Choose one of these to use your favourite user interface for configuring the kernel. Note that the last option might still prompt with unresolved/new configuration options, if you have selected <Y> or <L> in the previous step.
 
Choose one of these to use your favourite user interface for configuring the kernel. Note that the last option might still prompt with unresolved/new configuration options, if you have selected <Y> or <L> in the previous step.
  
::{{bc|<nowiki>
+
{{bc|<nowiki>
 
==> An non-generic CPU was selected for this kernel.
 
==> An non-generic CPU was selected for this kernel.
 
==> Hit <G>    :  to create a generic package named linux-pf
 
==> Hit <G>    :  to create a generic package named linux-pf
Line 75: Line 58:
  
 
==== Install compiled package ====
 
==== Install compiled package ====
 +
 
After the compilation finishes, an additional ''linux-pf-headers[-cpu]'' package will be created. Don't forget to install it too, if you plan on using additional modules like [[nvidia]] or [[virtualbox]].
 
After the compilation finishes, an additional ''linux-pf-headers[-cpu]'' package will be created. Don't forget to install it too, if you plan on using additional modules like [[nvidia]] or [[virtualbox]].
{{bc|<nowiki>
+
 
$ sudo pacman -U linux-pf-core2-3.3.2-1-x86_64.pkg.tar.xz linux-pf-headers-core2-3.3.2-1-x86_64.pkg.tar.xz
+
# pacman -U linux-pf-core2-3.3.2-1-$CPUTYPE.pkg.tar.xz linux-pf-headers-core2-3.3.2-1-$CPUTYPE.pkg.tar.xz
</nowiki>}}
+
 
 
During the kernel installation, [[mkinitcpio]] will be called by the install script to recreate the initramfs.
 
During the kernel installation, [[mkinitcpio]] will be called by the install script to recreate the initramfs.
 
{{Note|If you make any changes to {{ic|/etc/mkinitcpio.conf}} after the installation, you must run '''''mkinitcpio -p linux-pf''''' to have the initial ramdisk recreated.}}
 
{{Note|If you make any changes to {{ic|/etc/mkinitcpio.conf}} after the installation, you must run '''''mkinitcpio -p linux-pf''''' to have the initial ramdisk recreated.}}
  
 
== Configuration ==
 
== Configuration ==
Then, you need to add a boot entry in {{ic|/boot/grub/menu.lst}} (or {{ic|/boot/grub/grub.cfg}}) which points to linux-pf (the following example is from one of the maintainer's boxes):
+
 
 +
Then, you need to add a boot entry in [[Boot Loader#Configuration files|boot loader configuration file]] which points to linux-pf (the following example is from one of the maintainer's boxes):
 
{{bc|<nowiki>
 
{{bc|<nowiki>
 
title  Linux-pf 3.2
 
title  Linux-pf 3.2
Line 94: Line 79:
 
{{bc|<nowiki>
 
{{bc|<nowiki>
 
MODULES="... lzo tuxonice_compress tuxonice_swap tuxonice_userui ..."
 
MODULES="... lzo tuxonice_compress tuxonice_swap tuxonice_userui ..."
HOOKS="... sata userui resume filesystems ..."
+
HOOKS="... block userui resume filesystems ..."
 
</nowiki>}}
 
</nowiki>}}
 
In the example above, TuxOnIce is setup to use a swap partition as the suspended image allocator. The ''resume'' hook must be placed before ''filesystems''. Also, a progress indicator is requested with ''userui''. Please read the [[TuxOnIce]] wiki page for more detailed information.
 
In the example above, TuxOnIce is setup to use a swap partition as the suspended image allocator. The ''resume'' hook must be placed before ''filesystems''. Also, a progress indicator is requested with ''userui''. Please read the [[TuxOnIce]] wiki page for more detailed information.
Line 100: Line 85:
 
Last, you must choose whether you want to suspend using [[pm-utils]] or the [[Suspending_to_Disk_with_hibernate-script#Tuxonice_method|hibernate-script]]. Please, refer to the respective wiki pages for more details. [[TuxOnIce]] offers the option for a text mode or an even nicer [[fbsplash|framebuffer splash]] progress indicator.
 
Last, you must choose whether you want to suspend using [[pm-utils]] or the [[Suspending_to_Disk_with_hibernate-script#Tuxonice_method|hibernate-script]]. Please, refer to the respective wiki pages for more details. [[TuxOnIce]] offers the option for a text mode or an even nicer [[fbsplash|framebuffer splash]] progress indicator.
  
== Tweaks / Tips ==
+
== Tips and tricks ==
* If you notice disk-related performance problems or occational hickups, it might be an I/O scheduler issue. Try a different one than the linux-pf default (BFQ) by echoing to {{ic|/sys/block/sda/queue/scheduler}} ''cfq'', ''noop'' or ''deadline'': '''''echo noop >| /sys/block/sda/queue/scheduler'''''. Note, the aforementioned command only sets the I/O scheduler for the 1st hard drive and additional ''echos'' will be needed if you have more. If the situation improves, then append "''elevator''='''''cfq'''''" (or '''''noop''''' or '''''deadline''''') to the linux-pf command line in {{ic|/boot/grub/menu.lst}}, to make the change permanent.
+
 
 +
* If you notice disk-related performance problems or occational hickups, it might be an I/O scheduler issue. Try a different one than the linux-pf default (BFQ) by echoing to {{ic|/sys/block/sda/queue/scheduler}} ''cfq'', ''noop'' or ''deadline'': {{ic|# echo noop >| /sys/block/sda/queue/scheduler}}. Note, the aforementioned command only sets the I/O scheduler for the 1st hard drive and additional ''echoes'' will be needed if you have more. If the situation improves, then append "''elevator''='''''cfq'''''" (or '''''noop''''' or '''''deadline''''') to the linux-pf command line in {{ic|/boot/grub/menu.lst}}, to make the change permanent.
 
* For people who build their own tailored kernels and compilation aborts with with an error about "missing include/config/dvb/*.h files", setting <M> at ''DVB for Linux'' at ''Device Drivers/Multimedia support'' and leaving everything else out, creates just the necessary dvb.h, which allows the compilation to continue.
 
* For people who build their own tailored kernels and compilation aborts with with an error about "missing include/config/dvb/*.h files", setting <M> at ''DVB for Linux'' at ''Device Drivers/Multimedia support'' and leaving everything else out, creates just the necessary dvb.h, which allows the compilation to continue.
  
 
== Forum thread for linux-pf ==
 
== Forum thread for linux-pf ==
 +
 
There's a [https://bbs.archlinux.org/viewtopic.php?id=103462 discussion thread] at the BBS for reporting errors, impressions, ideas and requests.
 
There's a [https://bbs.archlinux.org/viewtopic.php?id=103462 discussion thread] at the BBS for reporting errors, impressions, ideas and requests.
 +
 +
== See also ==
 +
 +
* [https://bitbucket.org/nous/linux-pf/ linux-pf mercurial repository]
 +
* [http://pf.natalenko.name/ Patchset homepage]
 +
* [http://pf.natalenko.name/forum Patchset community forum]
 +
* [http://freecode.com/projects/pf-kernel Patchset changelog]

Revision as of 00:30, 22 December 2013

Linux-pf is a kernel package based on the stock -ARCH kernel, patched with a row of significant patches:

Installation

The reference PKGBUILD can be found at the linux-pfAUR and at the bitbucket.org mercurial repository.

From the unofficial repository (recommended)

Precompiled packages, generic and CPU-family optimized are uploaded at the pfkernel unofficial repository, usually within 6 hours of the AUR update for x86_64 and 12 hours for i686. Append the following to /etc/pacman.conf to activate the pfkernel repo:

[pfkernel]
# Generic and optimized binaries of the ARCH kernel patched with BFS, TuxOnIce, BFQ, IMQ, Aufs3
# linux-pf, kernel26-pf, gdm-old, nvidia-pf, nvidia-96xx, xchat-greek, arora-git
Server = http://dl.dropbox.com/u/11734958/$arch
SigLevel = Optional

Packages in the unofficial repository are not signed, so you will need to set SigLevel to Optional or Never. Running $ pacman -Syyl pfkernel will update all repos and show the available packages from pfkernel. Afterwards, just install linux-pf linux-pf-headers (for generic binaries - platform-specific binaries are also available and will be listed in the output from the above pacman command), but additional configuration steps must be performed; see the Installation section.

Manual compilation

There's a number of options a user is asked to choose from, should he/she select to compile from the PKGBUILD:

==> Hit <Y> to use your running kernel's config
    (needs IKCONFIG and IKCONFIG_PROC)
==> Hit <L> to run 'make localmodconfig'
==> Hit <N> (or just <ENTER>) to build an all-inclusive kernel like stock -ARCH
    (warning: it can take a looong time)

The <Y> option is for users who have already compiled and are running a custom kernel. The PKGBUILD reads the running kernel's configuration and uses it for the subsequent compilation. The <L> option tries some kind of autodetection of the user's hardware: it first tries to use the modprobed_db module database, then falls back to the linux kernel's make localmodconfig functionality. The last option is self-explanatory.

==> Kernel configuration options before build:
    <M> make menuconfig (console menu)
    <N> make nconfig (newer alternative to menuconfig)
    <G> make gconfig (needs gtk)
    <X> make xconfig (needs qt)
    <O> make oldconfig
    <ENTER> to skip configuration and start compiling

Choose one of these to use your favourite user interface for configuring the kernel. Note that the last option might still prompt with unresolved/new configuration options, if you have selected <Y> or <L> in the previous step.

==> An non-generic CPU was selected for this kernel.
==> Hit <G>     :  to create a generic package named linux-pf
==> Hit <ENTER> :  to create a package named after the selected CPU
                   (e.g. linux-pf-core2 - recommended)
==> This option affects ONLY the package name. Whether or not the
==> kernel is optimized was determined at the previous config step.

If you have selected a specific CPU optimization for your kernel in the previous step, the default action is to append the CPU to the package name. This way, a subsequent package update from the repository will pull the optimized package and not the generic one. This also will help better compatibility with 3rd party precompiled modules (e.g. nvidia-pf), which might break things if loaded on optimized linux-pf kernels.

Install compiled package

After the compilation finishes, an additional linux-pf-headers[-cpu] package will be created. Don't forget to install it too, if you plan on using additional modules like nvidia or virtualbox.

# pacman -U linux-pf-core2-3.3.2-1-$CPUTYPE.pkg.tar.xz linux-pf-headers-core2-3.3.2-1-$CPUTYPE.pkg.tar.xz

During the kernel installation, mkinitcpio will be called by the install script to recreate the initramfs.

Note: If you make any changes to /etc/mkinitcpio.conf after the installation, you must run mkinitcpio -p linux-pf to have the initial ramdisk recreated.

Configuration

Then, you need to add a boot entry in boot loader configuration file which points to linux-pf (the following example is from one of the maintainer's boxes):

title  Linux-pf 3.2
root   (hd0,4)
kernel (hd0,0)/vmlinuz-linux-pf root=/dev/disk/by-label/ROOT ro vga=0x318 lapic resume=/dev/disk/by-label/SWAP video=vesafb:ywrap,mtrr:3 fastboot quiet
initrd (hd0,0)/initramfs-linux-pf.img

If you intend to use TuxOnIce for hibernation, make sure you have added the necessary modules to the MODULES array of /etc/mkinitcpio.conf and at least the resume hook to the HOOKS array:

MODULES="... lzo tuxonice_compress tuxonice_swap tuxonice_userui ..."
HOOKS="... block userui resume filesystems ..."

In the example above, TuxOnIce is setup to use a swap partition as the suspended image allocator. The resume hook must be placed before filesystems. Also, a progress indicator is requested with userui. Please read the TuxOnIce wiki page for more detailed information.

Last, you must choose whether you want to suspend using pm-utils or the hibernate-script. Please, refer to the respective wiki pages for more details. TuxOnIce offers the option for a text mode or an even nicer framebuffer splash progress indicator.

Tips and tricks

  • If you notice disk-related performance problems or occational hickups, it might be an I/O scheduler issue. Try a different one than the linux-pf default (BFQ) by echoing to /sys/block/sda/queue/scheduler cfq, noop or deadline: # echo noop >. Note, the aforementioned command only sets the I/O scheduler for the 1st hard drive and additional echoes will be needed if you have more. If the situation improves, then append "elevator=cfq" (or noop or deadline) to the linux-pf command line in /boot/grub/menu.lst, to make the change permanent.
  • For people who build their own tailored kernels and compilation aborts with with an error about "missing include/config/dvb/*.h files", setting <M> at DVB for Linux at Device Drivers/Multimedia support and leaving everything else out, creates just the necessary dvb.h, which allows the compilation to continue.

Forum thread for linux-pf

There's a discussion thread at the BBS for reporting errors, impressions, ideas and requests.

See also