Compiling cpulimit with spksrc for synology NAS

-

Read the disclaimer

This article discribes how to compile cpulimit for synology devices, package it and install it.

I've set up a forked repository of spksrc at https://github.com/youpla/spksrc
There I publish some tools.

You can get cpulimit sources at https://github.com/opsengine/cpulimit
The package described in this guide is will download the content from that repository.
cpulimit is a simple program which attempts to limit the cpu usage of a process expressed in percentage, not in cpu time.

The apprehensible quality of this software is allowing you to run demanding software without rendering the NAS unusable.

In order to compile the software there are two possibilities.
  • a virtual machine
  • a docker container
In this example I'll rely on a virtual machine running Ubuntu. There are many steps involved in getting a virtual machine ready that are beyond this article scope, here are some basic steps:
  • chose an hypervisor 
  • install Ubuntu
  • install the prerequisites
  • clone a repository
  • for that clone run : "make setup"
  • get your architecture
  • compile the package

Steps detail 

Hypervisor

Hypervisor are software enabling to run virtual machines.

Here you have an example with VirtualBox (free) and Ubuntu:
https://itsfoss.com/install-linux-in-virtualbox/

Hyper-v (Microsoft)

Windows 10 home edition, you can activate it :
https://www.itechtics.com/enable-hyper-v-windows-10-home/

Windows 10 pro, it's a feature you can activate through the gui:

Microsoft offers pre-configured Ubuntu virtual machines for hyper-v:
This one is really : click "create virtual machine" and you are ready.

Install the prerequisites

It's documented here : https://github.com/SynoCommunity/spksrc

On the Ubuntu host in a terminal window :
  • sudo dpkg --add-architecture i386 && sudo apt-get update
  • sudo apt install autogen automake bc bison build-essential check cmake curl cython debootstrap expect flex g++-multilib gettext git gperf imagemagick intltool libbz2-dev libc6-i386 libcppunit-dev libffi-dev libgc-dev libgmp3-dev libltdl-dev libmount-dev libncurses-dev libpcre3-dev libssl-dev libtool libunistring-dev lzip mercurial ncurses-dev php pkg-config python3 python3-distutils scons subversion swig unzip xmlto zlib1g-dev
  • sudo apt install python-pip
  • sudo pip install -U setuptools pip wheel httpie

Clone the repository and make setup


  • on the ubuntu host
  • start a terminal
  • choose a folder for the git clone root
  • git clone https://github.com/youpla/spksrc.git
  • cd spksrc/
  • make setup

Get your architecture



In this case a "Marvel armada 375"
In order to build a package : 
make arch-armada375 
or
make arch-8876720

Compile the (cpulimit) package for your architecture

in a terminal navigate to the cpulimit folder

example:
/home/userprofile/test-git/spksrc/spk/cpulimit

make arch-armada375

Install the package

Go to the file explorer and find the generated file.

example
/home/userprofile/test-git/spksrc/packages/cpulimit_armada375-6.1_0.2-0.spk

The package is a (tar) archive, you can open it with your favorite archive explorer


For test purpose, you can use the synology online demo https://demo.synology.com/

This demo device runs on intel xeon

make arch-x64
It will compile : cpulimit_x64-6.1_0.2-0.spk

Testing

See :
https://dayandnightcoding.blogspot.com/2020/04/testing-package-compiled-with-spksrc.html

The package cpulimit has been tested for install and uninstall on my DS-115 with no noticed problem. The blog  disclaimer still applies.

Cpulimit tweaking

In the latest synology OS version, cpulimit cannot operate on certain process.
This workaround may open a security breach, it's unfortunately the only one I got so far, by adding the s bit : this is not a security best practice. 

cpulimit will be installed in /usr/local/bin/cpulimit

in order to tweak it with s bit :

sudo chmod u+s /usr/local/bin/cpulimit

Popular posts from this blog

cuesplitflac : a mass flac splitting script for synology and ubuntu

-
Image
Read the  disclaimer This bash script searches recursively directories and splits .flac or .ape file in separate tracks, based on the information provided in the .cue files. A text database keeps an inventory of split files, enabling the script to run on a schedule. The original file tree structure is mirrored to the converted file tree structure. You can get the script here :   https://github.com/youpla/bash_cuesplitflac Since DSM 6, synology provides a bash implementation that is close to what you would find on Linux systems, enabling easily bash code porting. This script uses different compiled tools to achieve its goal. There are GUI tools that manage flac files splitting, example : https://flacon.github.io/ Most of those tools achieve what this script does not, they are multi-threaded, optimized for speed and highly customizable. cuesplitflac on the other hand is more of a slow background process you can run on a synology or linux shell. You can generate .f...
Read more

Compiling "file" with spksrc for synology NAS

-
Read the disclaimer This article describes how to compile "file" for synology devices, package it and install it. You can get "file" sources at: https://github.com/file/file ftp://ftp.astron.com/pub/file/ The package described in this guide is will download the content from that repository. The "file" command is "a file type guesser", that is, a command-line tool that tells you in words what kind of data a file contains. The original spksrc already contains a file package, that only compiles the binaries : https://github.com/SynoCommunity/spksrc/tree/master/cross/file This package fills the gap and provides the command line utilities from the shell: file This guide is the same that https://dayandnightcoding.blogspot.com/2020/04/compiling-cpulimit-with-spksrc-for.html You can follow the different steps there. I'll document only the steps referring specifically to "file". Clone the repository and make setup ...
Read more