├── .gitignore ├── locale ├── LINGUAS ├── meson.build ├── uksmdstats.pot ├── de.po ├── pl.po └── ru.po ├── meson.options ├── 90-uksmd-upgrade.hook ├── uksmd-systemd-restart ├── uksmd.service ├── README.md ├── meson.build ├── uksmdstats ├── uksmd.c └── COPYING /.gitignore: -------------------------------------------------------------------------------- 1 | *.o 2 | uksmd 3 | -------------------------------------------------------------------------------- /locale/LINGUAS: -------------------------------------------------------------------------------- 1 | de 2 | pl 3 | ru 4 | -------------------------------------------------------------------------------- /locale/meson.build: -------------------------------------------------------------------------------- 1 | i18n.gettext(gettext_package, preset: 'glib') 2 | -------------------------------------------------------------------------------- /meson.options: -------------------------------------------------------------------------------- 1 | option( 2 | 'systemd', 3 | type: 'feature', 4 | value: 'auto', 5 | description: 'sd-notify support via libsystemd and install systemd unit files' 6 | ) 7 | 8 | option( 9 | 'libalpm', 10 | type: 'feature', 11 | value: 'auto', 12 | description: 'install pacman hooks' 13 | ) 14 | -------------------------------------------------------------------------------- /90-uksmd-upgrade.hook: -------------------------------------------------------------------------------- 1 | [Trigger] 2 | Type = Path 3 | Operation = Upgrade 4 | Target = usr/bin/uksmdstats 5 | Target = usr/lib/systemd/system/uksmd.service 6 | 7 | [Trigger] 8 | Type = Package 9 | Operation = Upgrade 10 | Target = uksmd* 11 | 12 | [Action] 13 | Description = Checking uksmd... 14 | When = PostTransaction 15 | Exec = /usr/share/libalpm/scripts/uksmd-systemd-restart 16 | NeedsTargets 17 | -------------------------------------------------------------------------------- /uksmd-systemd-restart: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # SPDX-License-Identifier: GPL-2.0-only 3 | 4 | # Check the status of the service 5 | if systemctl is-active --quiet uksmd.service; then 6 | echo "The service is active. Restarting..." 7 | systemctl daemon-reload 8 | systemctl restart uksmd.service 9 | echo "Service has been restarted." 10 | else 11 | echo "The service is not active." 12 | fi 13 | -------------------------------------------------------------------------------- /locale/uksmdstats.pot: -------------------------------------------------------------------------------- 1 | # ======================== 2 | # Powered by CachyOS Team 3 | # ======================== 4 | # uksmdstats - translation 5 | # This file is distributed under the GPL license. 6 | # CachyOS Team 7 | # 8 | #, fuzzy 9 | msgid "" 10 | msgstr "" 11 | "Project-Id-Version: 1.0\n" 12 | "POT-Creation-Date: 2023-07-08 13:00+0100\n" 13 | "PO-Revision-Date: 2023-07-08 13:00+0100\n" 14 | "Last-Translator: YOUR NAME HERE\n" 15 | "Language: LANGUAGE CODE\n" 16 | "MIME-Version: 1.0\n" 17 | "Content-Type: text/plain; charset=UTF-8\n" 18 | "Content-Transfer-Encoding: 8bit\n" 19 | # 20 | #: myscript:10 21 | #, sh-format 22 | 23 | msgid "Full scans" 24 | msgstr "" 25 | 26 | msgid "Interval" 27 | msgstr "" 28 | 29 | msgid "Max page sharing ratio" 30 | msgstr "" 31 | 32 | msgid "Pages to scan" 33 | msgstr "" 34 | 35 | msgid "Pages over ratio" 36 | msgstr "" 37 | 38 | msgid "Duplicated pages" 39 | msgstr "" 40 | 41 | msgid "Use zero pages" 42 | msgstr "" 43 | 44 | msgid "Sharing/shared ratio" 45 | msgstr "" 46 | 47 | msgid "Unshared/sharing ratio" 48 | msgstr "" 49 | 50 | msgid "Pages sharing" 51 | msgstr "" 52 | 53 | msgid "Pages shared" 54 | msgstr "" 55 | 56 | msgid "Pages unshared" 57 | msgstr "" 58 | 59 | msgid "General profit" 60 | msgstr "" 61 | 62 | msgid "The kernel you are using does not support" 63 | msgstr "" 64 | -------------------------------------------------------------------------------- /uksmd.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Userspace KSM helper daemon 3 | Documentation=https://codeberg.org/pf-kernel/uksmd 4 | ConditionPathExists=/sys/kernel/process_ksm/process_ksm_enable 5 | ConditionPathExists=/sys/kernel/process_ksm/process_ksm_disable 6 | ConditionPathExists=/sys/kernel/process_ksm/process_ksm_status 7 | 8 | [Service] 9 | Type=notify 10 | DynamicUser=true 11 | User=uksmd 12 | Group=uksmd 13 | CapabilityBoundingSet=CAP_SYS_PTRACE CAP_DAC_OVERRIDE CAP_SYS_NICE 14 | AmbientCapabilities=CAP_SYS_PTRACE CAP_DAC_OVERRIDE CAP_SYS_NICE 15 | PrivateNetwork=yes 16 | RestrictAddressFamilies=AF_UNIX 17 | RestrictNamespaces=true 18 | PrivateDevices=true 19 | NoNewPrivileges=true 20 | PrivateTmp=true 21 | ProtectClock=true 22 | ProtectControlGroups=true 23 | ProtectHome=true 24 | ProtectKernelLogs=true 25 | ProtectKernelModules=true 26 | ProtectKernelTunables=true 27 | ReadWritePaths=/sys/kernel/mm/ksm/run 28 | ProtectSystem=strict 29 | RestrictSUIDSGID=true 30 | SystemCallArchitectures=native 31 | RestrictRealtime=true 32 | LockPersonality=true 33 | MemoryDenyWriteExecute=true 34 | RemoveIPC=true 35 | TasksMax=1 36 | UMask=0066 37 | ProtectHostname=true 38 | IPAddressDeny=any 39 | SystemCallFilter=~@clock @debug @module @mount @raw-io @reboot @swap @privileged @resources @cpu-emulation @obsolete 40 | SystemCallFilter=setpriority set_mempolicy 41 | WatchdogSec=30 42 | Restart=on-failure 43 | ExecStart=/usr/bin/uksmd 44 | 45 | [Install] 46 | WantedBy=multi-user.target 47 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ### The project will no longer be developed. We recommend using [cachyos-ksm-settings](https://github.com/CachyOS/CachyOS-PKGBUILDS/tree/master/cachyos-ksm-settings) 2 | 3 | uksmd 4 | ===== 5 | 6 | Description 7 | ----------- 8 | 9 | Userspace KSM helper daemon. 10 | 11 | Principles 12 | ---------- 13 | 14 | The daemon goes through the list of userspace tasks regularly and tells them to set `MMF_VM_MERGE_ANY` flag for `struct mm_struct` for `ksmd` kthread to merge memory pages with the same content automatically. Only long-living tasks are processed. The mechanism is wrapped around the per-process KSM API that has been introduced in with the upstream commit `d7597f59d1`. 15 | 16 | This requires `process_ksm_{enable,disable,status}()` syscalls, that are available in [pf-kernel](https://codeberg.org/pf-kernel/linux). 17 | 18 | Building 19 | -------- 20 | 21 | Install `procps-ng` and `libcap-ng`, then use `meson`. 22 | 23 | Configuration 24 | ------------- 25 | 26 | The daemon requires zero configuration. 27 | 28 | Distribution and Contribution 29 | ----------------------------- 30 | 31 | Distributed under terms and conditions of GNU GPL v3 (only). 32 | 33 | Developers: 34 | 35 | * Oleksandr Natalenko <oleksandr@natalenko.name> 36 | 37 | CachyOS branding 38 | ---------------- 39 | 40 | The special version for CachyOS also includes `uksmdstats` . 41 | 42 | Contributors: 43 | 44 | * Piotr Gorski <piotrgorski@cachyos.org> 45 | * Damian N. <nycko123@gmail.com> 46 | -------------------------------------------------------------------------------- /locale/de.po: -------------------------------------------------------------------------------- 1 | # ======================== 2 | # Powered by CachyOS Team 3 | # ======================== 4 | # uksmdstats - polish translation 5 | # This file is distributed under the GPL license. 6 | # CachyOS Team - Damian N. , 08.07.2023 7 | # CachyOS - Peter Jung 8 | # 9 | #, fuzzy 10 | msgid "" 11 | msgstr "" 12 | "Project-Id-Version: 1.0\n" 13 | "POT-Creation-Date: 2023-07-08 17:00+0100\n" 14 | "PO-Revision-Date: 2023-07-08 17:00+0100\n" 15 | "Last-Translator: Damian N. \n" 16 | "Language: de\n" 17 | "MIME-Version: 1.0\n" 18 | "Content-Type: text/plain; charset=UTF-8\n" 19 | "Content-Transfer-Encoding: 8bit\n" 20 | # 21 | #: myscript:10 22 | #, sh-format 23 | 24 | msgid "Full scans" 25 | msgstr "Komplette Scans" 26 | 27 | msgid "Interval" 28 | msgstr "Intervall" 29 | 30 | msgid "Max page sharing ratio" 31 | msgstr "Maximale Rate geteilter Seiten" 32 | 33 | msgid "Pages to scan" 34 | msgstr "Seiten zum Scannen" 35 | 36 | msgid "Pages over ratio" 37 | msgstr "Seiten über Rate" 38 | 39 | msgid "Duplicated pages" 40 | msgstr "Doppelte Seiten" 41 | 42 | msgid "Use zero pages" 43 | msgstr "Verwenden von Nullseiten" 44 | 45 | msgid "Sharing/shared ratio" 46 | msgstr "Teilen/geteilt rate" 47 | 48 | msgid "Unshared/sharing ratio" 49 | msgstr "Ungeteilt/teilen rate" 50 | 51 | msgid "Pages sharing" 52 | msgstr "Seiten teilen" 53 | 54 | msgid "Pages shared" 55 | msgstr "Seiten geteilt " 56 | 57 | msgid "Pages unshared" 58 | msgstr "Seiten ungeteilt" 59 | 60 | msgid "General profit" 61 | msgstr "Allgemeine Ausbeute" 62 | 63 | msgid "The kernel you are using does not support" 64 | msgstr "Der verwendete Kernel unterstützt nicht" 65 | -------------------------------------------------------------------------------- /locale/pl.po: -------------------------------------------------------------------------------- 1 | # ======================== 2 | # Powered by CachyOS Team 3 | # ======================== 4 | # uksmdstats - polish translation 5 | # This file is distributed under the GPL license. 6 | # CachyOS Team - Damian N. , 08.07.2023, updated 08.07.2023 7 | # 8 | #, fuzzy 9 | msgid "" 10 | msgstr "" 11 | "Project-Id-Version: 1.0\n" 12 | "POT-Creation-Date: 2023-07-08 13:00+0100\n" 13 | "PO-Revision-Date: 2023-07-08 13:00+0100\n" 14 | "Last-Translator: Damian N. \n" 15 | "Language: pl\n" 16 | "MIME-Version: 1.0\n" 17 | "Content-Type: text/plain; charset=UTF-8\n" 18 | "Content-Transfer-Encoding: 8bit\n" 19 | # 20 | #: myscript:10 21 | #, sh-format 22 | 23 | msgid "Full scans" 24 | msgstr "Pełne skany" 25 | 26 | msgid "Interval" 27 | msgstr "Interwał" 28 | 29 | msgid "Max page sharing ratio" 30 | msgstr "Maks. wskaźnik stronicowania" 31 | 32 | msgid "Pages to scan" 33 | msgstr "Strony do skanowania" 34 | 35 | msgid "Pages over ratio" 36 | msgstr "Strony ponad wskaźnik" 37 | 38 | msgid "Duplicated pages" 39 | msgstr "Zdublowane strony" 40 | 41 | msgid "Use zero pages" 42 | msgstr "Użycie stron zerowych" 43 | 44 | msgid "Sharing/shared ratio" 45 | msgstr "Wskaźnik stron współdzielonych" 46 | 47 | msgid "Unshared/sharing ratio" 48 | msgstr "Wskaźnik stron niewspółdzielonych" 49 | 50 | msgid "Pages sharing" 51 | msgstr "Strony dost. do współdzielenia" 52 | 53 | msgid "Pages shared" 54 | msgstr "Strony współdzielone" 55 | 56 | msgid "Pages unshared" 57 | msgstr "Strony niewspółdzielone" 58 | 59 | msgid "General profit" 60 | msgstr "Ogólny zysk" 61 | 62 | msgid "The kernel you are using does not support" 63 | msgstr "Używane jądro nie wspiera" 64 | -------------------------------------------------------------------------------- /locale/ru.po: -------------------------------------------------------------------------------- 1 | # ======================== 2 | # Powered by CachyOS Team 3 | # ======================== 4 | # uksmdstats - russian translation 5 | # This file is distributed under the GPL license. 6 | # CachyOS Team 7 | # 8 | msgid "" 9 | msgstr "" 10 | "Project-Id-Version: 1.0\n" 11 | "POT-Creation-Date: 2023-07-08 13:00+0100\n" 12 | "PO-Revision-Date: 2023-07-08 18:04+0400\n" 13 | "Last-Translator: Vladislav Nepogodin \n" 14 | "Language-Team: \n" 15 | "Language: ru\n" 16 | "MIME-Version: 1.0\n" 17 | "Content-Type: text/plain; charset=UTF-8\n" 18 | "Content-Transfer-Encoding: 8bit\n" 19 | "X-Generator: Poedit 3.3.2\n" 20 | 21 | # 22 | #: myscript:10 23 | #, sh-format 24 | msgid "Full scans" 25 | msgstr "Полных сканирований" 26 | 27 | msgid "Interval" 28 | msgstr "Интервал" 29 | 30 | msgid "Max page sharing ratio" 31 | msgstr "Максимальный коэффициент общих страниц" 32 | 33 | msgid "Pages to scan" 34 | msgstr "Страниц для сканирования" 35 | 36 | msgid "Pages over ratio" 37 | msgstr "Соотношение страниц к объему" 38 | 39 | msgid "Duplicated pages" 40 | msgstr "Дублированные страницы" 41 | 42 | msgid "Use zero pages" 43 | msgstr "Использовать нулевые страницы" 44 | 45 | msgid "Sharing/shared ratio" 46 | msgstr "Коэффициент общего/разделеного пользования" 47 | 48 | msgid "Unshared/sharing ratio" 49 | msgstr "Соотношение необщего/общего пользования" 50 | 51 | msgid "Pages sharing" 52 | msgstr "Распределение страниц" 53 | 54 | msgid "Pages shared" 55 | msgstr "Общих страниц" 56 | 57 | msgid "Pages unshared" 58 | msgstr "Необщих страниц" 59 | 60 | msgid "General profit" 61 | msgstr "Общий профит" 62 | 63 | msgid "The kernel you are using does not support" 64 | msgstr "Используемое вами ядро не поддерживает" 65 | -------------------------------------------------------------------------------- /meson.build: -------------------------------------------------------------------------------- 1 | project( 2 | 'uksmd', 3 | 'c', 4 | version: '1.3.0', 5 | license : 'GPLv3', 6 | meson_version : '>= 1.1.0' 7 | ) 8 | 9 | project_source_files = [ 10 | 'uksmd.c' 11 | ] 12 | 13 | project_dependencies = [ 14 | dependency('libproc2', version: '>=4.0.5'), 15 | dependency('libcap-ng'), 16 | ] 17 | 18 | build_args = [ 19 | '-DPROJECT_NAME="' + meson.project_name() + '"', 20 | '-DPROJECT_VERSION="' + meson.project_version() + '"', 21 | ] 22 | 23 | i18n = import('i18n') 24 | systemd = dependency('systemd', required: get_option('systemd')) 25 | gettext_package = 'uksmdstats' 26 | 27 | if systemd.found() 28 | systemd_system_unit_dir = systemd.get_variable(pkgconfig : 'systemdsystemunitdir') 29 | 30 | install_data('uksmd.service', install_dir: systemd_system_unit_dir) 31 | 32 | project_dependencies += [ 33 | dependency('libsystemd') 34 | ] 35 | 36 | build_args += [ 37 | '-DHAVE_SYSTEMD', 38 | ] 39 | endif 40 | 41 | libalpm = dependency('libalpm', required: get_option('libalpm')) 42 | 43 | if libalpm.found() and systemd.found() 44 | install_data('uksmd-systemd-restart', install_dir: '/usr/share/libalpm/scripts') 45 | 46 | install_data('90-uksmd-upgrade.hook', install_dir: '/usr/share/libalpm/hooks') 47 | 48 | project_dependencies += [ 49 | dependency('libsystemd', 'libalpm') 50 | ] 51 | 52 | build_args += [ 53 | '-DHAVE_SYSTEMD', 54 | ] 55 | endif 56 | 57 | install_data('uksmdstats', install_dir: '/usr/bin') 58 | 59 | install_data( 60 | [ 61 | 'COPYING', 62 | ], 63 | rename : 'LICENSE', 64 | install_dir : get_option('datadir') / 'licenses' / 'uksmd' 65 | ) 66 | 67 | subdir('locale') 68 | 69 | project_target = executable( 70 | meson.project_name(), 71 | project_source_files, 72 | dependencies: project_dependencies, 73 | install : true, 74 | c_args : build_args, 75 | ) 76 | -------------------------------------------------------------------------------- /uksmdstats: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | export TEXTDOMAIN='uksmdstats' 3 | export TEXTDOMAINDIR='/usr/share/locale' 4 | 5 | if [ -f /sys/kernel/process_ksm/process_ksm_enable ] && [ -f /sys/kernel/process_ksm/process_ksm_disable ] && [ -f /sys/kernel/process_ksm/process_ksm_status ]; then 6 | echo "======================================================" 7 | echo "uksmd with uksmdstats support. Powered by CachyOS Team" 8 | echo "======================================================" 9 | while true; do 10 | echo "$( gettext "Full scans" ): $(cat /sys/kernel/mm/ksm/full_scans)" 11 | echo "$( gettext "Interval" ): $(cat /sys/kernel/mm/ksm/sleep_millisecs)" ms 12 | echo ":" 13 | echo "$( gettext "Max page sharing ratio" ): $(cat /sys/kernel/mm/ksm/max_page_sharing)" 14 | echo "$( gettext "Pages to scan" ): $(cat /sys/kernel/mm/ksm/pages_to_scan)" 15 | echo "$( gettext "Pages over ratio" ): $(cat /sys/kernel/mm/ksm/stable_node_chains)" 16 | echo "$( gettext "Duplicated pages" ): $(cat /sys/kernel/mm/ksm/stable_node_dups)" 17 | echo "$( gettext "Use zero pages" ): $(cat /sys/kernel/mm/ksm/use_zero_pages)" 18 | if [ "$(cat /sys/kernel/mm/ksm/pages_shared)" -gt 0 ] && [ "$(cat /sys/kernel/mm/ksm/pages_sharing)" -gt 0 ]; then 19 | echo "$( gettext "Sharing/shared ratio" ): $(awk "BEGIN {x=$(cat /sys/kernel/mm/ksm/pages_sharing);y=$(cat /sys/kernel/mm/ksm/pages_shared);print x/y}")" 20 | echo "$( gettext "Unshared/sharing ratio" ): $(awk "BEGIN {x=$(cat /sys/kernel/mm/ksm/pages_unshared);y=$(cat /sys/kernel/mm/ksm/pages_sharing);print x/y}")" 21 | else 22 | echo "$( gettext "Sharing/shared ratio" ): 0" 23 | echo "$( gettext "Unshared/sharing ratio" ): 0" 24 | fi 25 | echo ":" 26 | # formula MiB: $page_value * page size in Bytes / (1024 * 1024) 27 | # = $page_value * 4096 / (1024 / 1024) = $page_value / 256 (MiB) 28 | echo "$( gettext "Pages sharing" ): $(awk '{ print($0 / 256) }' /sys/kernel/mm/ksm/pages_sharing):MiB" 29 | echo "$( gettext "Pages shared" ): $(awk '{ print($0 / 256) }' /sys/kernel/mm/ksm/pages_shared):MiB" 30 | echo "$( gettext "Pages unshared" ): $(awk '{ print($0 / 256) }' /sys/kernel/mm/ksm/pages_unshared):MiB" 31 | echo ":" 32 | # https://www.kernel.org/doc/Documentation/admin-guide/mm/ksm.rst 33 | # general_profit =~ pages_sharing * sizeof(page) - (all_rmap_items) * sizeof(rmap_item); 34 | echo "$( gettext "General profit" ): $(awk '{ print($0 / 1024 / 1024) }' /sys/kernel/mm/ksm/general_profit):MiB" 35 | break 36 | done | column -t -s':' 37 | else 38 | echo -e "$( gettext "The kernel you are using does not support" ) UKSMD." 39 | fi 40 | -------------------------------------------------------------------------------- /uksmd.c: -------------------------------------------------------------------------------- 1 | /* 2 | * uksmd - userspace KSM helper daemon 3 | * Copyright (C) 2019 Oleksandr Natalenko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3 of the License. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #if defined __GLIBC__ 30 | #include 31 | #else 32 | #include 33 | #endif /* __GLIBC__ */ 34 | #include 35 | #if defined HAVE_SYSTEMD 36 | #include 37 | #endif /* HAVE_SYSTEMD */ 38 | #include 39 | #include 40 | 41 | #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0])) 42 | 43 | #define KSM_RUN "/sys/kernel/mm/ksm/run" 44 | #define KSM_FULL_SCANS "/sys/kernel/mm/ksm/full_scans" 45 | #define KSM_PAGES_VOLATILE "/sys/kernel/mm/ksm/pages_volatile" 46 | #if defined HAVE_SYSTEMD 47 | #define KSM_PROFIT "/sys/kernel/mm/ksm/general_profit" 48 | #endif /* HAVE_SYSTEMD */ 49 | #define KSMD_CMD "ksmd" 50 | #define OBSERVE_WINDOW_SECS 30 51 | #define IDLE_SLEEP_SECS 15 52 | 53 | #define __SYSFS_process_ksm_enable "/sys/kernel/process_ksm/process_ksm_enable" 54 | #define __SYSFS_process_ksm_disable "/sys/kernel/process_ksm/process_ksm_disable" 55 | #define __SYSFS_process_ksm_status "/sys/kernel/process_ksm/process_ksm_status" 56 | 57 | enum pksm_action 58 | { 59 | PKSM_ENABLE = 0, 60 | PKSM_DISABLE, 61 | PKSM_STATUS, 62 | }; 63 | 64 | static long __NR_process_ksm_enable = -1; 65 | static long __NR_process_ksm_disable = -1; 66 | static long __NR_process_ksm_status = -1; 67 | 68 | static const char* incompatible_tasks[] = 69 | { 70 | "mariadbd", 71 | "mysqld", 72 | "p2pool", 73 | }; 74 | 75 | static int ksm_ctl(bool _enable) 76 | { 77 | int ret = 0; 78 | 79 | int fd = open(KSM_RUN, O_WRONLY); 80 | if (fd == -1) 81 | { 82 | ret = errno; 83 | goto out; 84 | } 85 | 86 | if (write(fd, _enable ? "1" : "2", 1) == -1) 87 | { 88 | ret = errno; 89 | goto close_fd; 90 | } 91 | 92 | close_fd: 93 | close(fd); 94 | 95 | out: 96 | return ret; 97 | } 98 | 99 | static long process_ksm_enable(int pidfd, unsigned int flags) 100 | { 101 | return syscall(__NR_process_ksm_enable, pidfd, flags); 102 | } 103 | 104 | static long process_ksm_disable(int pidfd, unsigned int flags) 105 | { 106 | return syscall(__NR_process_ksm_disable, pidfd, flags); 107 | } 108 | 109 | static long process_ksm_status(int pidfd, unsigned int flags) 110 | { 111 | return syscall(__NR_process_ksm_status, pidfd, flags); 112 | } 113 | 114 | #if !defined __GLIBC__ 115 | static int pidfd_open(pid_t pid, unsigned int flags) 116 | { 117 | return syscall(__NR_pidfd_open, pid, flags); 118 | } 119 | #endif /* __GLIBC__ */ 120 | 121 | static long process_ksm(pid_t pid, enum pksm_action _action) 122 | { 123 | long ret; 124 | int pidfd; 125 | 126 | pidfd = pidfd_open(pid, 0); 127 | if (pidfd == -1) 128 | { 129 | ret = errno; 130 | goto out; 131 | } 132 | 133 | switch (_action) 134 | { 135 | case PKSM_ENABLE: 136 | ret = process_ksm_enable(pidfd, 0); 137 | break; 138 | case PKSM_DISABLE: 139 | ret = process_ksm_disable(pidfd, 0); 140 | break; 141 | case PKSM_STATUS: 142 | ret = process_ksm_status(pidfd, 0); 143 | break; 144 | } 145 | 146 | if (ret == -1) 147 | { 148 | ret = errno; 149 | /* ignore close() ret value to preserve the one from process_ksm_*() */ 150 | close(pidfd); 151 | goto out; 152 | } 153 | 154 | ret = close(pidfd); 155 | if (ret == -1) 156 | ret = errno; 157 | 158 | out: 159 | return ret; 160 | } 161 | 162 | static size_t pids_index(const enum pids_item _items[], size_t _items_len, int _item) 163 | { 164 | for (size_t i = 0; i < _items_len; i++) 165 | if (_items[i] == _item) 166 | return i; 167 | 168 | /* coding error: no given item was declared in array */ 169 | abort(); 170 | } 171 | 172 | #define PKSM_PIDS_VAL(name, type) \ 173 | (PIDS_VAL(pids_index(items, ARRAY_SIZE(items), name), type, stack)) 174 | 175 | static int kthread_niceness(const char* _name, int *_niceness) 176 | { 177 | int ret; 178 | bool found = false; 179 | struct pids_info *info = NULL; 180 | struct pids_stack *stack; 181 | enum pids_item items[] = 182 | { 183 | PIDS_CMD, 184 | PIDS_NICE, 185 | PIDS_VM_SIZE, 186 | }; 187 | 188 | ret = procps_pids_new(&info, items, ARRAY_SIZE(items)); 189 | if (ret < 0) 190 | return ret; 191 | 192 | while ((stack = procps_pids_get(info, PIDS_FETCH_TASKS_ONLY))) 193 | { 194 | /* skip uthreads */ 195 | if (PKSM_PIDS_VAL(PIDS_VM_SIZE, ul_int)) 196 | continue; 197 | 198 | if (!strcmp(_name, PKSM_PIDS_VAL(PIDS_CMD, str))) 199 | { 200 | *_niceness = PKSM_PIDS_VAL(PIDS_NICE, s_int); 201 | found = true; 202 | break; 203 | } 204 | } 205 | 206 | if (!found) 207 | return -ESRCH; 208 | 209 | ret = procps_pids_unref(&info); 210 | if (ret < 0) 211 | return ret; 212 | 213 | return 0; 214 | } 215 | 216 | static int do_setup_process_ksm(const char* _path, long* _nr) 217 | { 218 | int ret = 0; 219 | char buf[4] = { 0, }; 220 | ssize_t read_len; 221 | long nr; 222 | 223 | int fd = open(_path, O_RDONLY); 224 | if (fd == -1) 225 | { 226 | ret = errno; 227 | goto out; 228 | } 229 | 230 | read_len = read(fd, buf, sizeof buf); 231 | if (read_len == -1) 232 | { 233 | ret = errno; 234 | goto close_fd; 235 | } 236 | 237 | nr = strtol(buf, NULL, 10); 238 | if (nr == LONG_MIN || nr == LONG_MAX) 239 | { 240 | ret = errno; 241 | goto close_fd; 242 | } 243 | 244 | *_nr = nr; 245 | 246 | close_fd: 247 | close(fd); 248 | 249 | out: 250 | return ret; 251 | } 252 | 253 | static int setup_nr_process_ksm(void) 254 | { 255 | int ret = 0; 256 | 257 | ret = do_setup_process_ksm(__SYSFS_process_ksm_enable, &__NR_process_ksm_enable); 258 | if (ret) 259 | goto out; 260 | 261 | ret = do_setup_process_ksm(__SYSFS_process_ksm_disable, &__NR_process_ksm_disable); 262 | if (ret) 263 | goto out; 264 | 265 | ret = do_setup_process_ksm(__SYSFS_process_ksm_status, &__NR_process_ksm_status); 266 | 267 | out: 268 | return ret; 269 | } 270 | 271 | static int get_ksm_gauge(const char *_name, long *_value) 272 | { 273 | int ret = 0; 274 | char buf[21] = { 0, }; 275 | ssize_t read_len; 276 | unsigned long value = 0; 277 | 278 | int fd = open(_name, O_RDONLY); 279 | if (fd == -1) 280 | { 281 | ret = errno; 282 | goto out; 283 | } 284 | 285 | read_len = read(fd, buf, sizeof buf); 286 | if (read_len == -1) 287 | { 288 | ret = errno; 289 | goto close_fd; 290 | } 291 | 292 | value = strtol(buf, NULL, 10); 293 | if (value == LONG_MIN || value == LONG_MAX) 294 | ret = errno; 295 | 296 | close_fd: 297 | close(fd); 298 | 299 | out: 300 | *_value = value; 301 | 302 | return ret; 303 | } 304 | 305 | static bool is_incompatible(const char* _comm) 306 | { 307 | for (size_t i = 0; i < ARRAY_SIZE(incompatible_tasks); i++) 308 | if (!strcmp(incompatible_tasks[i], _comm)) 309 | return true; 310 | 311 | return false; 312 | } 313 | 314 | int main(int _argc, char** _argv) 315 | { 316 | (void)_argc; 317 | (void)_argv; 318 | int ret; 319 | int ksmd_niceness; 320 | pid_t self; 321 | sigset_t sigmask; 322 | sigset_t sigorigmask; 323 | struct pids_info *info = NULL; 324 | struct pids_stack *stack; 325 | enum pids_item items[] = 326 | { 327 | PIDS_CMD, 328 | PIDS_ID_PID, 329 | PIDS_TIME_START, 330 | PIDS_VM_SIZE, 331 | }; 332 | struct timespec now; 333 | struct timespec time_to_sleep; 334 | siginfo_t siginfo; 335 | long full_scans; 336 | long prev_full_scans; 337 | bool first_run; 338 | long pages_volatile; 339 | #if defined HAVE_SYSTEMD 340 | long profit; 341 | #endif /* HAVE_SYSTEMD */ 342 | 343 | if (capng_get_caps_process() == -1) 344 | { 345 | ret = ENODATA; 346 | fprintf(stderr, "Unable to get capabilities\n"); 347 | goto out; 348 | } 349 | 350 | if (!capng_have_capability(CAPNG_EFFECTIVE, CAP_SYS_PTRACE)) 351 | { 352 | ret = EACCES; 353 | fprintf(stderr, "capabilities: CAP_SYS_PTRACE required\n"); 354 | goto out; 355 | } 356 | 357 | if (!capng_have_capability(CAPNG_EFFECTIVE, CAP_DAC_OVERRIDE)) 358 | { 359 | ret = EACCES; 360 | fprintf(stderr, "capabilities: CAP_DAC_OVERRIDE required\n"); 361 | goto out; 362 | } 363 | 364 | if (!capng_have_capability(CAPNG_EFFECTIVE, CAP_SYS_NICE)) 365 | { 366 | ret = EACCES; 367 | fprintf(stderr, "capabilities: CAP_SYS_NICE required\n"); 368 | goto out; 369 | } 370 | 371 | if (setup_nr_process_ksm()) 372 | { 373 | ret = ENODATA; 374 | fprintf(stderr, "Unable to get process_ksm syscall numbers\n"); 375 | goto out; 376 | } 377 | 378 | ret = kthread_niceness("ksmd", &ksmd_niceness); 379 | if (ret < 0) 380 | { 381 | fprintf(stderr, "kthread_niceness: %s\n", strerror(-ret)); 382 | goto out; 383 | } 384 | 385 | ret = setpriority(PRIO_PROCESS, 0, ksmd_niceness); 386 | if (ret == -1 && errno) 387 | { 388 | ret = errno; 389 | fprintf(stderr, "setpriority: %s\n", strerror(ret)); 390 | goto out; 391 | } 392 | 393 | #if !defined HAVE_SYSTEMD 394 | ret = daemon(0, 0); 395 | if (ret == -1) 396 | { 397 | ret = errno; 398 | fprintf(stderr, "daemon: %s\n", strerror(ret)); 399 | goto out; 400 | } 401 | #endif /* HAVE_SYSTEMD */ 402 | 403 | self = getpid(); 404 | 405 | ret = ksm_ctl(true); 406 | if (ret) 407 | { 408 | fprintf(stderr, "ksm_ctl: %s\n", strerror(ret)); 409 | goto out; 410 | } 411 | 412 | sigemptyset(&sigmask); 413 | sigaddset(&sigmask, SIGINT); 414 | sigaddset(&sigmask, SIGTERM); 415 | ret = sigprocmask(SIG_BLOCK, &sigmask, &sigorigmask); 416 | if (ret == -1) 417 | { 418 | ret = errno; 419 | fprintf(stderr, "sigprocmask: %s\n", strerror(ret)); 420 | goto ksm_ctl_false; 421 | } 422 | 423 | #if defined HAVE_SYSTEMD 424 | sd_notify(0, "READY=1"); 425 | #endif /* HAVE_SYSTEMD */ 426 | 427 | first_run = true; 428 | full_scans = prev_full_scans = 0; 429 | while (true) 430 | { 431 | #if defined HAVE_SYSTEMD 432 | sd_notify(0, "WATCHDOG=1"); 433 | ret = get_ksm_gauge(KSM_PROFIT, &profit); 434 | if (ret) 435 | { 436 | fprintf(stderr, "get KSM_PROFIT: %s\n", strerror(ret)); 437 | goto unblock_signals; 438 | } 439 | sd_notifyf(0, "STATUS=Profit: %ld MiB", profit / (1L << 20)); 440 | #endif /* HAVE_SYSTEMD */ 441 | 442 | ret = get_ksm_gauge(KSM_FULL_SCANS, &full_scans); 443 | if (ret) 444 | { 445 | fprintf(stderr, "get KSM_FULL_SCANS: %s\n", strerror(ret)); 446 | goto unblock_signals; 447 | } 448 | 449 | ret = get_ksm_gauge(KSM_PAGES_VOLATILE, &pages_volatile); 450 | if (ret) 451 | { 452 | fprintf(stderr, "get KSM_PAGES_VOLATILE: %s\n", strerror(ret)); 453 | goto unblock_signals; 454 | } 455 | 456 | if (first_run || full_scans != prev_full_scans || !pages_volatile) 457 | { 458 | clock_gettime(CLOCK_BOOTTIME, &now); 459 | 460 | ret = procps_pids_new(&info, items, ARRAY_SIZE(items)); 461 | if (ret < 0) 462 | { 463 | fprintf(stderr, "procps_pids_new: %s\n", strerror(-ret)); 464 | goto unblock_signals; 465 | } 466 | 467 | while ((stack = procps_pids_get(info, PIDS_FETCH_TASKS_ONLY))) 468 | { 469 | /* skip kthreads */ 470 | if (!PKSM_PIDS_VAL(PIDS_VM_SIZE, ul_int)) 471 | continue; 472 | 473 | pid_t current_pid = PKSM_PIDS_VAL(PIDS_ID_PID, s_int); 474 | 475 | /* skip ourselves */ 476 | if (current_pid == self) 477 | continue; 478 | 479 | /* skip short-living tasks */ 480 | if (now.tv_sec - PKSM_PIDS_VAL(PIDS_TIME_START, real) < OBSERVE_WINDOW_SECS) 481 | continue; 482 | 483 | /* skip already processed tasks */ 484 | if (process_ksm(current_pid, PKSM_STATUS)) 485 | continue; 486 | 487 | /* explicitly disable incompatible tasks */ 488 | if (is_incompatible(PKSM_PIDS_VAL(PIDS_CMD, str))) 489 | { 490 | process_ksm(current_pid, PKSM_DISABLE); 491 | continue; 492 | } 493 | 494 | if (process_ksm(current_pid, PKSM_ENABLE)) 495 | continue; 496 | } 497 | 498 | ret = procps_pids_unref(&info); 499 | if (ret < 0) 500 | { 501 | fprintf(stderr, "procps_pids_unref: %s\n", strerror(-ret)); 502 | goto unblock_signals; 503 | } 504 | 505 | if (first_run) 506 | first_run = false; 507 | 508 | prev_full_scans = full_scans; 509 | } 510 | 511 | time_to_sleep.tv_sec = IDLE_SLEEP_SECS; 512 | time_to_sleep.tv_nsec = 0; 513 | ret = sigtimedwait(&sigmask, &siginfo, &time_to_sleep); 514 | if (ret == SIGINT || ret == SIGTERM) 515 | { 516 | printf("Caught signal %d, shutting down gracefully...\n", ret); 517 | goto unblock_signals; 518 | } else if (ret == -1) 519 | { 520 | switch (errno) 521 | { 522 | case EINVAL: 523 | ret = errno; 524 | fprintf(stderr, "sigtimedwait: %s\n", strerror(ret)); 525 | goto unblock_signals; 526 | case EINTR: 527 | if (!siginfo.si_signo || siginfo.si_signo == SIGQUIT) 528 | { 529 | printf("Are we being traced?\n"); 530 | continue; 531 | } else 532 | { 533 | fprintf(stderr, "sigtimedwait: EINTR came with si_signo = %d\n", siginfo.si_signo); 534 | continue; 535 | } 536 | break; 537 | case EAGAIN: 538 | /* timeout, just continuing */ 539 | continue; 540 | } 541 | } 542 | } 543 | 544 | unblock_signals: 545 | #if defined HAVE_SYSTEMD 546 | sd_notify(0, "STOPPING=1"); 547 | #endif /* HAVE_SYSTEMD */ 548 | 549 | ret = sigprocmask(SIG_SETMASK, &sigorigmask, NULL); 550 | if (ret == -1) 551 | { 552 | ret = errno; 553 | fprintf(stderr, "sigprocmask: %s\n", strerror(ret)); 554 | goto ksm_ctl_false; 555 | } 556 | 557 | ksm_ctl_false: 558 | ret = ksm_ctl(false); 559 | if (ret) 560 | { 561 | fprintf(stderr, "ksm_ctl: %s\n", strerror(ret)); 562 | goto out; 563 | } 564 | 565 | out: 566 | #if defined HAVE_SYSTEMD 567 | sd_notifyf(0, "ERRNO=%d", ret); 568 | #endif /* HAVE_SYSTEMD */ 569 | 570 | exit(ret); 571 | } 572 | 573 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------