[bug#68012] [PATCH] services: Add thinkfan service.

[bug#68012] [PATCH] services: Add thinkfan service.

[lgcoelho--- via Guix-patches via]

[-- Attachment #1.1: Type: text/plain, Size: 58 bytes --]

This patch add thinkfan-service-type to (gnu services pm).

[-- Attachment #1.2: Type: text/html, Size: 245 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-services-Add-thinkfan-service.patch --]
[-- Type: text/x-diff; name=0001-services-Add-thinkfan-service.patch, Size: 3078 bytes --]

From 92bf99099f91c0f1dae71b0cf9e5f8e6799a3679 Mon Sep 17 00:00:00 2001
From: Luis Guilherme Coelho <lgcoelho@disroot.org>
Date: Sun, 24 Dec 2023 15:52:04 -0300
Subject: [PATCH] services: Add thinkfan service.

---
 gnu/services/pm.scm | 59 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

diff --git a/gnu/services/pm.scm b/gnu/services/pm.scm
index 3daf484cc1..baded5c43e 100644
--- a/gnu/services/pm.scm
+++ b/gnu/services/pm.scm
@@ -31,7 +31,10 @@ (define-module (gnu services pm)
             tlp-configuration
 
             thermald-configuration
-            thermald-service-type))
+            thermald-service-type
+
+            thinkfan-configuration
+            thinkfan-service-type))
 
 (define (uglify-field-name field-name)
   (let ((str (symbol->string field-name)))
@@ -466,3 +469,57 @@ (define thermald-service-type
    (default-value (thermald-configuration))
    (description "Run thermald, a CPU frequency scaling service that helps
 prevent overheating.")))
+
+(define-configuration/no-serialization thinkfan-configuration
+  (pid-file
+   (string "/var/run/thinkfan.pid")
+   "Where to store the PID file.")
+  (config-file
+   (string "/etc/thinkfan.conf")
+   "Configuration file to use.")
+  (log-file
+   (string "/var/log/thinkfan.log")
+    "File where ‘thinkfan’ writes its log to.")
+  (extra-options
+   (list-of-strings '())
+   "This option provides an “escape hatch” for the user to provide
+arbitrary command-line arguments to ‘thinkfan’ as a list of strings."))
+
+(define thinkfan-shepherd-service
+  (match-record-lambda <thinkfan-configuration>
+    (pid-file config-file log-file extra-options)
+    (list (shepherd-service
+           (provision '(thinkfan))
+           (documentation
+            "Adjust fan level according to configured temperature limits.")
+           (requirement '(user-processes))
+           (start #~(make-forkexec-constructor
+                      (list (string-append #$thinkfan-next
+                                           "/sbin/thinkfan")
+                             "-n" #$@extra-options
+                             "-c" #$config-file)
+                     #:log-file #$log-file
+                     #:pid-file #$pid-file))
+           (stop #~(make-kill-destructor))
+           (one-shot? #t)
+           (respawn? #t)))))
+
+(define thinkfan-modprobe-config
+  (plain-file "thinkfan.conf"
+              "options thinkpad_acpi experimental=1 fan_control=1"))
+
+(define (thinkfan-modprobe-etc-service config)
+  `(("modprobe.d/thinkfan.conf" ,thinkfan-modprobe-config)))
+
+(define thinkfan-service-type
+  (service-type
+   (name 'thinkfan)
+   (extensions
+    (list (service-extension shepherd-root-service-type
+                             thinkfan-shepherd-service)
+          (service-extension etc-service-type
+                             thinkfan-modprobe-etc-service)))
+  (default-value (thinkfan-configuration))
+  (description
+   "Adjust fan level according to configured temperature limits.")))
+
-- 
2.41.0

[bug#68012] [PATCH] thinkfan-service-type: Place config-file in /etc/thinkfan.conf if file-like

[lgcoelho--- via Guix-patches via]

[-- Attachment #1: Type: text/html, Size: 193 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0002-thinkfan-service-type-Place-config-file-in-etc-think.patch --]
[-- Type: text/x-diff; name=0002-thinkfan-service-type-Place-config-file-in-etc-think.patch, Size: 2107 bytes --]

From 0160f08bb315ee297b0ad8b861f9e3b5bd7eedfb Mon Sep 17 00:00:00 2001
From: Luis Guilherme Coelho <lgcoelho@disroot.org>
Date: Mon, 25 Dec 2023 20:48:35 -0300
Subject: [PATCH 2/2] thinkfan-service-type: Place config-file in
 /etc/thinkfan.conf if file-like

---
 gnu/services/pm.scm | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/gnu/services/pm.scm b/gnu/services/pm.scm
index baded5c43e..2d02476d20 100644
--- a/gnu/services/pm.scm
+++ b/gnu/services/pm.scm
@@ -470,12 +470,16 @@ (define thermald-service-type
    (description "Run thermald, a CPU frequency scaling service that helps
 prevent overheating.")))
 
+(define (string-or-file-like? x)
+  (or (string? x)
+      (file-like? x)))
+
 (define-configuration/no-serialization thinkfan-configuration
   (pid-file
    (string "/var/run/thinkfan.pid")
    "Where to store the PID file.")
   (config-file
-   (string "/etc/thinkfan.conf")
+   (string-or-file-like "/etc/thinkfan.conf")
    "Configuration file to use.")
   (log-file
    (string "/var/log/thinkfan.log")
@@ -511,15 +515,25 @@ (define thinkfan-modprobe-config
 (define (thinkfan-modprobe-etc-service config)
   `(("modprobe.d/thinkfan.conf" ,thinkfan-modprobe-config)))
 
+(define thinkfan-activation
+  (match-record-lambda <thinkfan-configuration>
+    (config-file)
+    (when (file-like? config-file)
+      (with-imported-modules '((guix build utils))
+        #~(begin
+            (use-modules (guix build utils))
+            (copy-file #$config-file "/etc/thinkfan.conf"))))))
+
 (define thinkfan-service-type
   (service-type
    (name 'thinkfan)
    (extensions
     (list (service-extension shepherd-root-service-type
                              thinkfan-shepherd-service)
+          (service-extension activation-service-type
+                             thinkfan-activation)
           (service-extension etc-service-type
                              thinkfan-modprobe-etc-service)))
   (default-value (thinkfan-configuration))
   (description
    "Adjust fan level according to configured temperature limits.")))
-
-- 
2.41.0

[bug#68012] [PATCH] thinkfan-service-type: Place config-file in /etc/thinkfan.conf if file-like

[Josselin Poiret via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 537 bytes --]


lgcoelho--- via Guix-patches via <guix-patches@gnu.org> writes:

> +(define thinkfan-activation
> +  (match-record-lambda <thinkfan-configuration>
> +    (config-file)
> +    (when (file-like? config-file)
> +      (with-imported-modules '((guix build utils))
> +        #~(begin
> +            (use-modules (guix build utils))
> +            (copy-file #$config-file "/etc/thinkfan.conf"))))))
> +

This is not needed as you already specify the config file to use to
thinkfan with the -c option.

-- 
Josselin Poiret

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 682 bytes --]

[bug#68012] [PATCH] thinkfan-service-type: Add thinkfan entry to thinkfan-configuration.

[lgcoelho--- via Guix-patches via]

[-- Attachment #1: Type: text/html, Size: 193 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0003-thinkfan-service-type-Add-thinkfan-entry-to-thinkfan.patch --]
[-- Type: text/x-diff; name=0003-thinkfan-service-type-Add-thinkfan-entry-to-thinkfan.patch, Size: 1902 bytes --]

From ff38662f5d5512b2f656cd3daed9c3ee32cd60ae Mon Sep 17 00:00:00 2001
From: Luis Guilherme Coelho <lgcoelho@disroot.org>
Date: Wed, 27 Dec 2023 14:02:04 -0300
Subject: [PATCH 3/3] thinkfan-service-type: Add thinkfan entry to
 thinkfan-configuration

---
 gnu/services/pm.scm | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/gnu/services/pm.scm b/gnu/services/pm.scm
index 2d02476d20..5b96d4265a 100644
--- a/gnu/services/pm.scm
+++ b/gnu/services/pm.scm
@@ -475,6 +475,9 @@ (define (string-or-file-like? x)
       (file-like? x)))
 
 (define-configuration/no-serialization thinkfan-configuration
+  (thinkfan
+   (package thinkfan)
+   "Thinkfan package to be used.")
   (pid-file
    (string "/var/run/thinkfan.pid")
    "Where to store the PID file.")
@@ -491,17 +494,16 @@ (define-configuration/no-serialization thinkfan-configuration
 
 (define thinkfan-shepherd-service
   (match-record-lambda <thinkfan-configuration>
-    (pid-file config-file log-file extra-options)
+    (thinkfan pid-file config-file log-file extra-options)
     (list (shepherd-service
            (provision '(thinkfan))
            (documentation
             "Adjust fan level according to configured temperature limits.")
            (requirement '(user-processes))
            (start #~(make-forkexec-constructor
-                      (list (string-append #$thinkfan-next
-                                           "/sbin/thinkfan")
-                             "-n" #$@extra-options
-                             "-c" #$config-file)
+                      (list (string-append #$thinkfan "/sbin/thinkfan")
+                                           "-n" #$@extra-options
+                                           "-c" #$config-file)
                      #:log-file #$log-file
                      #:pid-file #$pid-file))
            (stop #~(make-kill-destructor))
-- 
2.41.0

[bug#68012] [PATCH] thinkfan-service-type: Add thinkfan entry to thinkfan-configuration.

[Josselin Poiret via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 1438 bytes --]


lgcoelho--- via Guix-patches via <guix-patches@gnu.org> writes:

>  (define-configuration/no-serialization thinkfan-configuration
> +  (thinkfan
> +   (package thinkfan)
> +   "Thinkfan package to be used.")
>    (pid-file
>     (string "/var/run/thinkfan.pid")
>     "Where to store the PID file.")
> @@ -491,17 +494,16 @@ (define-configuration/no-serialization thinkfan-configuration
>  
>  (define thinkfan-shepherd-service
>    (match-record-lambda <thinkfan-configuration>
> -    (pid-file config-file log-file extra-options)
> +    (thinkfan pid-file config-file log-file extra-options)
>      (list (shepherd-service
>             (provision '(thinkfan))
>             (documentation
>              "Adjust fan level according to configured temperature limits.")
>             (requirement '(user-processes))
>             (start #~(make-forkexec-constructor
> -                      (list (string-append #$thinkfan-next
> -                                           "/sbin/thinkfan")
> -                             "-n" #$@extra-options
> -                             "-c" #$config-file)
> +                      (list (string-append #$thinkfan "/sbin/thinkfan")
> +                                           "-n" #$@extra-options
> +                                           "-c" #$config-file)

That's a good idea, but can you squash this with the first commit?

Best,
-- 
Josselin Poiret

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 682 bytes --]

[bug#68012] [PATCH] services: Add thinkfan service.

[Josselin Poiret via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 851 bytes --]

Hi Luis,

lgcoelho--- via Guix-patches via <guix-patches@gnu.org> writes:

> This patch add thinkfan-service-type to (gnu services pm).
> From 92bf99099f91c0f1dae71b0cf9e5f8e6799a3679 Mon Sep 17 00:00:00 2001
> From: Luis Guilherme Coelho <lgcoelho@disroot.org>
> Date: Sun, 24 Dec 2023 15:52:04 -0300
> Subject: [PATCH] services: Add thinkfan service.
>
> ---

Please add a commit message following the ChangeLog convention.  You can
take inspiration from other commits in the repo, and read up on it at [0].

> +  (config-file
> +   (string "/etc/thinkfan.conf")
> +   "Configuration file to use.")

This should not refer to an absolute path.  Please use a file-like
instead, users can still use (local-file ...) to give external files.

[0] https://www.gnu.org/prep/standards/html_node/Change-Logs.html
-- 
Josselin Poiret

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 682 bytes --]