GNU bug report logs - #73406
[PATCH v2 0/2] SANE: fix a locking bug for plustek backend

Message received at 73406 <at> debbugs.gnu.org:

Received: (at 73406) by debbugs.gnu.org; 21 Sep 2024 08:04:21 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sat Sep 21 04:04:21 2024
Received: from localhost ([127.0.0.1]:37010 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1srv6L-0006W0-9I
	for submit <at> debbugs.gnu.org; Sat, 21 Sep 2024 04:04:21 -0400
Received: from eggs.gnu.org ([209.51.188.92]:58246)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <neox@HIDDEN>) id 1srv6I-0006VW-TL
 for 73406 <at> debbugs.gnu.org; Sat, 21 Sep 2024 04:04:19 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <neox@HIDDEN>)
 id 1srv5t-0007Xh-Mg; Sat, 21 Sep 2024 04:03:53 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
 s=fencepost-gnu-org; h=MIME-Version:References:In-Reply-To:Date:Subject:To:
 From; bh=/5ublfufOcudc9IjBbBZJgcwCwVNsKfI9gGUTgLELzc=; b=JRwuNUuvT5cbO+h0sOP+
 8XDpahv1tavqLBqz9734gZFh2H1zYIt2qkhRSDDNKNUT0mUN/pe2K1dNPQlfKJazoJjyhBlFXVMYW
 l2FP02i1lToNkvfwKBunXs40W8qoDKpgiXACzZiIlgQa0qaubPw/CYTDAfWtiodOiDCfg3QoHBmJz
 swu3tHVte0665wEWj0bLjvGs80rGBfRDg3tA5FjyqCjEY6fLPOg2lzZs36oXOY0m2YBtOye+F/I0t
 khFDp/pjyVkEhHMwHOshCi5oTNq6IW5lJhihSzkCjh6TfKxyHDm1d0LRKLxk2Nxe+NsrnFgSIBNic
 KapARR1YKmlVIg==;
From: Adrien 'neox' Bourmault <neox@HIDDEN>
To: 73406 <at> debbugs.gnu.org
Subject: [PATCH v2 2/2] services: sane-service-type: create lock path for
 plustek backend
Date: Sat, 21 Sep 2024 10:03:48 +0200
Message-ID: <8604617ae2896e2d73d24958aab7ee534c656dfa.1726864525.git.neox@HIDDEN>
X-Mailer: git-send-email 2.46.0
In-Reply-To: <cover.1726864525.git.neox@HIDDEN>
References: <cover.1726864525.git.neox@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: 73406
Cc: Adrien 'neox' Bourmault <neox@HIDDEN>
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

* gnu/services/desktop.scm (sane-service-type): extend with an activation
 service to create the lockpath and give the right permissions

Change-Id: I187886d12b5f0b4fe21b03de178ea2187205387a
Signed-off-by: Adrien 'neox' Bourmault <neox@HIDDEN>
---
 gnu/services/desktop.scm | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/gnu/services/desktop.scm b/gnu/services/desktop.scm
index 274aeeef9b..500527cb50 100644
--- a/gnu/services/desktop.scm
+++ b/gnu/services/desktop.scm
@@ -17,6 +17,7 @@
 ;;; Copyright © 2021, 2022 muradm <mail@HIDDEN>
 ;;; Copyright © 2023 Bruno Victal <mirai@HIDDEN>
 ;;; Copyright © 2023 Zheng Junjie <873216071@HIDDEN>
+;;; Copyright © 2024 Adrien Bourmault <neox@HIDDEN>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -1408,6 +1409,17 @@ (define %sane-accounts
   ;; The '60-libsane.rules' udev rules refers to the "scanner" group.
   (list (user-group (name "scanner") (system? #t))))
 
+(define %sane-activation
+  #~(begin
+      (use-modules (guix build utils))
+      (let ((lockpath "/var/lock/sane")
+            (gid (vector-ref (getgrnam "scanner") 2)))
+        ;; Create the lock directory at runtime and give right perms
+        (mkdir-p lockpath)
+        (chown lockpath -1 gid)
+        (chmod lockpath #o770))
+      #t))
+
 (define sane-service-type
   (service-type
    (name 'sane)
@@ -1418,6 +1430,8 @@ (define sane-service-type
    (default-value sane-backends-minimal)
    (extensions
     (list (service-extension udev-service-type list)
+          (service-extension activation-service-type
+                             (const %sane-activation))
           (service-extension account-service-type
                              (const %sane-accounts))))))
 
-- 
2.46.0

Message received at 73406 <at> debbugs.gnu.org:

Received: (at 73406) by debbugs.gnu.org; 21 Sep 2024 08:04:05 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sat Sep 21 04:04:05 2024
Received: from localhost ([127.0.0.1]:36999 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1srv64-0006VB-KM
	for submit <at> debbugs.gnu.org; Sat, 21 Sep 2024 04:04:05 -0400
Received: from eggs.gnu.org ([209.51.188.92]:58356)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <neox@HIDDEN>) id 1srv62-0006Ub-TA
 for 73406 <at> debbugs.gnu.org; Sat, 21 Sep 2024 04:04:03 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <neox@HIDDEN>)
 id 1srv5d-0007WQ-82; Sat, 21 Sep 2024 04:03:37 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
 s=fencepost-gnu-org; h=MIME-Version:References:In-Reply-To:Date:Subject:To:
 From; bh=SGIX3lKzdvIsn4XzV4xaeCZ/n0iY37uv9n0DhTSWRQw=; b=aYe2oUBKYlvsQStb55PQ
 BxAMqeqeSQDrj8ZsftYi180OXiVMsj/mIhFNSgLyAtlcuDb1jXES+pcowHsMZcI/Dr7AhzfcQb1ne
 7Ind6VhV7g7XCyT6vKCISeyduYHd7UODwaJ8FNBlW4sYufh9+g/BgyV0FdL/jaz4zllldHjW5OG0s
 qLrKNBpBFhldx3v+hxqPyaLxTh8tX5AQBCbCm3DrATRQOLPD2HiheFDnPqK/8vwmmXydpnXciHYjb
 9VqJ0XxD1ESCVIUPK6fktGe4XmoQOFqNYkyhoPJv2GXg/bsaZJUEYxt7jCXbXJ9fV1Btnafe9jobb
 41ZJk/KdmMl05Q==;
From: Adrien 'neox' Bourmault <neox@HIDDEN>
To: 73406 <at> debbugs.gnu.org
Subject: [PATCH v2 1/2] gnu: sane-backends-minimal: fix lock path for plustek
 backend
Date: Sat, 21 Sep 2024 10:03:32 +0200
Message-ID: <bc2d915931bfd53462d5eeac7504b04b94ea2d02.1726864525.git.neox@HIDDEN>
X-Mailer: git-send-email 2.46.0
In-Reply-To: <cover.1726864525.git.neox@HIDDEN>
References: <cover.1726864525.git.neox@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: 73406
Cc: Adrien 'neox' Bourmault <neox@HIDDEN>
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

* gnu/packages/scanner.scm (sane-backends-minimal)
[arguments]<#:configure-flags>: add "--with-lockdir=/var/lock/sane"
[arguments]<#:phases>: add disable-lockdir-creation to prevent creating the
 lockpath during install

Change-Id: I338c16cd4c0bfa0d165c9906b0f1f87ab79a4f75
Signed-off-by: Adrien 'neox' Bourmault <neox@HIDDEN>
---
 gnu/packages/scanner.scm | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/scanner.scm b/gnu/packages/scanner.scm
index a2faaa2728..a346f004ae 100644
--- a/gnu/packages/scanner.scm
+++ b/gnu/packages/scanner.scm
@@ -5,6 +5,7 @@
 ;;; Copyright © 2017, 2019, 2020, 2022 Tobias Geerinckx-Rice <me@HIDDEN>
 ;;; Copyright © 2018 Efraim Flashner <efraim@HIDDEN>
 ;;; Copyright © 2022 João Gabriel <joaog.bastos@HIDDEN>
+;;; Copyright © 2024 Adrien Bourmault <neox@HIDDEN>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -136,7 +137,8 @@ (define-public sane-backends-minimal
     (inputs
      (list libusb))
     (arguments
-     `(#:phases
+     `(#:configure-flags '("--with-lockdir=/var/lock/sane") ;; Avoid errors with plustek
+       #:phases
        (modify-phases %standard-phases
          (add-before 'bootstrap 'zap-unnecessary-git-dependency
            (lambda _
@@ -145,6 +147,12 @@ (define-public sane-backends-minimal
                (("/bin/sh") (which "sh")))
              (with-output-to-file ".tarball-version"
                (lambda _ (format #t ,version)))))
+         (add-before 'configure 'disable-lockdir-creation
+           (lambda _
+             ;; Modify the Makefile.am to prevent the creation of the lock dir
+             (substitute* "backend/Makefile.am"
+               (("^install-lockpath:.*$")
+                "install-lockpath: # pass"))))
          (add-before 'configure 'disable-backends
            (lambda _
              (setenv "BACKENDS" " ")
-- 
2.46.0

Message received at submit <at> debbugs.gnu.org:

Received: (at submit) by debbugs.gnu.org; 21 Sep 2024 08:02:08 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sat Sep 21 04:02:07 2024
Received: from localhost ([127.0.0.1]:36987 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1srv4B-0006Qh-E2
	for submit <at> debbugs.gnu.org; Sat, 21 Sep 2024 04:02:07 -0400
Received: from lists.gnu.org ([209.51.188.17]:42126)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <neox@HIDDEN>) id 1srv49-0006QX-Gp
 for submit <at> debbugs.gnu.org; Sat, 21 Sep 2024 04:02:06 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <neox@HIDDEN>) id 1srv3p-0001nI-Ae
 for guix-patches@HIDDEN; Sat, 21 Sep 2024 04:01:45 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <neox@HIDDEN>)
 id 1srv3n-0007Qf-QF; Sat, 21 Sep 2024 04:01:43 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
 s=fencepost-gnu-org; h=MIME-Version:Date:Subject:To:From:in-reply-to:
 references; bh=TDkffOLoFLNL8/m3nfO/sXsGH9iP37fRGnT18WrYRHc=; b=DkF8gq+IoZ2WeX
 0QWDRoT5E4wM/6aG91fpTB3N8Bs9i/AN7v5C14XC7YjzNbs8m3BmOTMa+7AVAdeO2Zty9S4QktADN
 hqYX0C4OXS2TqJWrFwKNbTUJBXlsMyL4RU0wDYfe8qzAlv3luEvs/nRay3tuaTQMdhgjEulSWbIO/
 ZN0zLbZdFB7RXHn82joWig1z8iM1ZGTh+6x0CM+mWXvmLWSs49b6QlVqMIYELwUdYoE2gW4Hqogew
 KSo2u+m+U2qkLZIyE/MJKAZBmtZEPlw0kFqted9qI1TPCGtw8vSYJRDnWVVvs+PsiQQNk/MYgx5PQ
 1h4WoVTWlTff27cAN4Cw==;
From: Adrien 'neox' Bourmault <neox@HIDDEN>
To: guix-patches@HIDDEN
Subject: [PATCH v2 0/2] SANE: fix a locking bug for plustek backend
Date: Sat, 21 Sep 2024 10:01:31 +0200
Message-ID: <cover.1726864525.git.neox@HIDDEN>
X-Mailer: git-send-email 2.46.0
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: submit
Cc: Adrien 'neox' Bourmault <neox@HIDDEN>
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

Hi.
While attempting to use a Canon LiDE 30 scanner, which is supported by SANE in
its current version, I noticed a malfunction with the plustek backend. No
application seemed capable of detecting the scanner, even though the
`sane-find-scanner` command indicated its presence, and the device IDs matched
those in the plustek backend configuration.

I investigated further using the following command:

  SANE_DEBUG_SANEI_USB=128 SANE_DEBUG_PLUSTEK=255 strace -fye open,openat scanimage -L

Here is a summary of the output:

  [23:00:21.688008] [plustek] usbDev_open(auto,) - 0x1c1e5630
  [pid 1209-20241] openat(AT_FDCWD</home/neox>, "/gnu/store/gzc1m4n79d1fgby8l58dsaq7nrzyhc14-sane-backend>
  [23:00:21.688089] [plustek] sanei_access_lock failed: 11
  [23:00:21.688131] [plustek] open failed: -1

It seems that the issue is the attempt to open a lock file in the store, which
is not possible due to the read-only nature of the file system.

To address this, there were two possible approaches: either move the lock file
to another location or disable the locking mechanism altogether.

After some research, I found that this bug has been resolved in both Debian [1]
and nixOS [2], and it has also been reported to the upstream project [3]. Debian
opted to disable the locking mechanism, while nixOS moved the lock file to a
runtime-generated location using systemd (by patching the install phase to
prevent the creation of the lock directory). However, since the locking
mechanism allows the use of multiple devices simultaneously[4], which can be
useful, nixOS's solution appears to be the better approach. I followed this
method, proposing to create the lock directory during the activation of the
sane service.

I tested these patch with my Canon LiDE 30 and have been able to (finally)
scan with it.

I realized I forgot to add my copyright notice in the files I
modified. This v2 fixes this.

[1] Debian bug report: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=973490
[2] nixOS bug report: https://github.com/NixOS/nixpkgs/issues/273280
[3] Upstream issue: https://gitlab.com/sane-project/backends/-/issues/363
[4] https://gitlab.com/sane-project/backends/-/issues/363#note_443142177

Adrien 'neox' Bourmault (2):
  gnu: sane-backends-minimal: fix lock path for plustek backend
  services: sane-service-type: create lock path for plustek backend

 gnu/packages/scanner.scm | 10 +++++++++-
 gnu/services/desktop.scm | 14 ++++++++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)


base-commit: 1b6ce1796abdf497f61f426d61339318f4f4f23d
-- 
2.46.0