;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2016 Jan Nieuwenhuizen <janneke@gnu.org>
;;; Copyright © 2016-2023 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2020 Brice Waegeneire <brice@waegenei.re>
;;; Copyright © 2023 Giacomo Leidi <goodoldpaul@autistici.org>
;;; Copyright © 2024 Gabriel Wicki <gabriel@erlikon.ch>
;;; Copyright © 2024 Richard Sent <richard@freakingpenguin.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu services admin)
  #:use-module (gnu system file-systems)
  #:use-module (gnu packages admin)
  #:use-module ((gnu packages base)
                #:select (canonical-package findutils coreutils sed))
  #:use-module (gnu packages file-systems)
  #:use-module (gnu packages certs)
  #:use-module (gnu packages disk)
  #:use-module (gnu packages package-management)
  #:use-module (gnu packages linux)
  #:use-module (gnu services)
  #:use-module (gnu services configuration)
  #:use-module (gnu services mcron)
  #:use-module (gnu services shepherd)
  #:use-module (gnu system accounts)
  #:use-module ((gnu system shadow) #:select (account-service-type))
  #:use-module ((guix store) #:select (%store-prefix))
  #:use-module (guix gexp)
  #:use-module (guix modules)
  #:use-module (guix packages)
  #:use-module (guix records)
  #:use-module (srfi srfi-1)
  #:use-module (ice-9 match)
  #:use-module (ice-9 vlist)
  #:export (%default-rotations
            %rotated-files

            log-rotation
            log-rotation?
            log-rotation-frequency
            log-rotation-files
            log-rotation-options
            log-rotation-post-rotate
            %default-log-rotation-options

            rottlog-configuration
            rottlog-configuration?
            rottlog-configuration-rottlog
            rottlog-configuration-rc-file
            rottlog-configuration-rotations
            rottlog-configuration-jobs
            rottlog-service
            rottlog-service-type

            log-cleanup-service-type
            log-cleanup-configuration
            log-cleanup-configuration?
            log-cleanup-configuration-directory
            log-cleanup-configuration-expiry
            log-cleanup-configuration-schedule

            file-database-service-type
            file-database-configuration
            file-database-configuration?
            file-database-configuration-package
            file-database-configuration-schedule
            file-database-configuration-excluded-directories
            %default-file-database-update-schedule
            %default-file-database-excluded-directories

            package-database-service-type
            package-database-configuration
            package-database-configuration?
            package-database-configuration-package
            package-database-configuration-schedule
            package-database-configuration-method
            package-database-configuration-channels

            unattended-upgrade-service-type
            unattended-upgrade-configuration
            unattended-upgrade-configuration?
            unattended-upgrade-configuration-operating-system-file
            unattended-upgrade-configuration-operating-system-expression
            unattended-upgrade-configuration-channels
            unattended-upgrade-configuration-schedule
            unattended-upgrade-configuration-services-to-restart
            unattended-upgrade-configuration-system-expiration
            unattended-upgrade-configuration-maximum-duration
            unattended-upgrade-configuration-log-file

            resize-file-system-service-type
            resize-file-system-configuration
            resize-file-system-configuration?
            resize-file-system-configuration-file-system
            resize-file-system-configuration-cloud-utils
            resize-file-system-configuration-e2fsprogs
            resize-file-system-configuration-btrfs-progs
            resize-file-system-configuration-bcachefs-tools))

;;; Commentary:
;;;
;;; This module implements configuration of rottlog by writing
;;; /etc/rottlog/{rc,hourly|daily|weekly}.  Example usage
;;;
;;;     (mcron-service)
;;;     (service rottlog-service-type)
;;;
;;; Code:

(define-record-type* <log-rotation> log-rotation make-log-rotation
  log-rotation?
  (files       log-rotation-files)                ;list of strings
  (frequency   log-rotation-frequency             ;symbol
               (default 'weekly))
  (post-rotate log-rotation-post-rotate           ;#f | gexp
               (default #f))
  (options     log-rotation-options               ;list of strings
               (default %default-log-rotation-options)))

(define %default-log-rotation-options
  ;; Default log rotation options: append ".gz" to file names.
  '("storefile @FILENAME.@COMP_EXT"
    "notifempty"))

(define %rotated-files
  ;; Syslog files subject to rotation.
  '("/var/log/messages" "/var/log/secure" "/var/log/debug"
    "/var/log/maillog" "/var/log/mcron.log"))

(define %default-rotations
  (list (log-rotation                             ;syslog files
         (files %rotated-files)

         (frequency 'weekly)
         (options `(;; These files are worth keeping for a few weeks.
                    "rotate 16"
                    ;; Run post-rotate once per rotation
                    "sharedscripts"

                    ,@%default-log-rotation-options))
         ;; Restart syslogd after rotation.
         (post-rotate #~(let ((pid (call-with-input-file "/var/run/syslog.pid"
                                     read)))
                          (kill pid SIGHUP))))
        (log-rotation
         (files '("/var/log/guix-daemon.log"))
         (options `("rotate 4"                    ;don't keep too many of them
                    ,@%default-log-rotation-options)))))

(define (log-rotation->config rotation)
  "Return a string-valued gexp representing the rottlog configuration snippet
for ROTATION."
  (define post-rotate
    (let ((post (log-rotation-post-rotate rotation)))
      (and post
           (program-file "rottlog-post-rotate.scm" post))))

  #~(let ((post #$post-rotate))
      (string-append (string-join '#$(log-rotation-files rotation) ",")
                     " {"
                     #$(string-join (log-rotation-options rotation)
                                    "\n  " 'prefix)
                     (if post
                         (string-append "\n  postrotate\n    " post
                                        "\n  endscript\n")
                         "")
                     "\n}\n")))

(define (log-rotations->/etc-entries rotations)
  "Return the list of /etc entries for ROTATIONS, a list of <log-rotation>."
  (define (frequency-file frequency rotations)
    (computed-file (string-append "rottlog." (symbol->string frequency))
                   #~(call-with-output-file #$output
                       (lambda (port)
                         (for-each (lambda (str)
                                     (display str port))
                                   (list #$@(map log-rotation->config
                                                 rotations)))))))

  (let* ((frequencies (delete-duplicates
                       (map log-rotation-frequency rotations)))
         (table       (fold (lambda (rotation table)
                              (vhash-consq (log-rotation-frequency rotation)
                                           rotation table))
                            vlist-null
                            rotations)))
    (map (lambda (frequency)
           `(,(symbol->string frequency)
             ,(frequency-file frequency
                              (vhash-foldq* cons '() frequency table))))
         frequencies)))

(define (default-jobs rottlog)
  (list #~(job '(next-hour '(0))                  ;midnight
               #$(file-append rottlog "/sbin/rottlog"))
        #~(job '(next-hour '(12))                 ;noon
               #$(file-append rottlog "/sbin/rottlog"))))

(define-record-type* <rottlog-configuration>
  rottlog-configuration make-rottlog-configuration
  rottlog-configuration?
  (rottlog            rottlog-configuration-rottlog             ;file-like
                      (default rottlog))
  (rc-file            rottlog-configuration-rc-file             ;file-like
                      (default (file-append rottlog "/etc/rc")))
  (rotations          rottlog-configuration-rotations           ;list of <log-rotation>
                      (default %default-rotations))
  (jobs               rottlog-configuration-jobs                ;list of <mcron-job>
                      (default #f)))

(define (rottlog-etc config)
  `(("rottlog"
     ,(file-union "rottlog"
                  (cons `("rc" ,(rottlog-configuration-rc-file config))
                        (log-rotations->/etc-entries
                         (rottlog-configuration-rotations config)))))))

(define (rottlog-jobs-or-default config)
  (or (rottlog-configuration-jobs config)
      (default-jobs (rottlog-configuration-rottlog config))))

(define rottlog-service-type
  (service-type
   (name 'rottlog)
   (description
    "Periodically rotate log files using GNU@tie{}Rottlog and GNU@tie{}mcron.
Old log files are removed or compressed according to the configuration.")
   (extensions (list (service-extension etc-service-type rottlog-etc)
                     (service-extension mcron-service-type
                                        rottlog-jobs-or-default)

                     ;; Add Rottlog to the global profile so users can access
                     ;; the documentation.
                     (service-extension profile-service-type
                                        (compose list rottlog-configuration-rottlog))))
   (compose concatenate)
   (extend (lambda (config rotations)
             (rottlog-configuration
              (inherit config)
              (rotations (append (rottlog-configuration-rotations config)
                                 rotations)))))
   (default-value (rottlog-configuration))))


;;;
;;; Build log removal.
;;;

(define-record-type* <log-cleanup-configuration>
  log-cleanup-configuration make-log-cleanup-configuration
  log-cleanup-configuration?
  (directory log-cleanup-configuration-directory) ;string
  (expiry    log-cleanup-configuration-expiry     ;integer (seconds)
             (default (* 6 30 24 3600)))
  (schedule  log-cleanup-configuration-schedule   ;string or gexp
             (default "30 12 01,08,15,22 * *")))

(define (log-cleanup-program directory expiry)
  (program-file "delete-old-logs"
                (with-imported-modules '((guix build utils))
                  #~(begin
                      (use-modules (guix build utils))

                      (let* ((now  (car (gettimeofday)))
                             (logs (find-files #$directory
					       (lambda (file stat)
					         (> (- now (stat:mtime stat))
						    #$expiry)))))
                        (format #t "deleting ~a log files from '~a'...~%"
                                (length logs) #$directory)
                        (for-each delete-file logs))))))

(define (log-cleanup-mcron-jobs configuration)
  (match-record configuration <log-cleanup-configuration>
    (directory expiry schedule)
    (list #~(job #$schedule
                 #$(log-cleanup-program directory expiry)))))

(define log-cleanup-service-type
  (service-type
   (name 'log-cleanup)
   (extensions
    (list (service-extension mcron-service-type
                             log-cleanup-mcron-jobs)))
   (description
    "Periodically delete old log files.")))


;;;
;;; File databases.
;;;

(define %default-file-database-update-schedule
  ;; Default mcron schedule for the periodic 'updatedb' job: once every
  ;; Sunday.
  "10 23 * * 0")

(define %default-file-database-excluded-directories
  ;; Regexps of directories excluded from the 'locate' database.
  (list (%store-prefix)
        "/tmp" "/var/tmp" "/var/cache" ".*/\\.cache"
        "/run/udev"))

(define (string-or-gexp? obj)
  (or (string? obj) (gexp? obj)))

(define string-list?
  (match-lambda
    (((? string?) ...) #t)
    (_ #f)))

(define-configuration/no-serialization file-database-configuration
  (package
    (file-like (let-system (system target)
                 ;; Unless we're cross-compiling, avoid pulling a second copy
                 ;; of findutils.
                 (if target
                     findutils
                     (canonical-package findutils))))
    "The GNU@tie{}Findutils package from which the @command{updatedb} command
is taken.")
  (schedule
   (string-or-gexp %default-file-database-update-schedule)
   "String or G-exp denoting an mcron schedule for the periodic
@command{updatedb} job (@pxref{Guile Syntax,,, mcron, GNU@tie{}mcron}).")
  (excluded-directories
   (string-list %default-file-database-excluded-directories)
   "List of regular expressions of directories to ignore when building the
file database.  By default, this includes @file{/tmp} and @file{/gnu/store};
the latter should instead be indexed by @command{guix locate} (@pxref{Invoking
guix locate}).  This list is passed to the @option{--prunepaths} option of
@command{updatedb} (@pxref{Invoking updatedb,,, find, GNU@tie{}Findutils})."))

(define (file-database-mcron-jobs configuration)
  (match-record configuration <file-database-configuration>
    (package schedule excluded-directories)
    (let ((updatedb (program-file
                     "updatedb"
                     #~(begin
                         ;; 'updatedb' is a shell script that expects various
                         ;; commands in $PATH.
                         (setenv "PATH"
                                 (string-append #$package "/bin:"
                                                #$(canonical-package coreutils)
                                                "/bin:"
                                                #$(canonical-package sed)
                                                "/bin"))
                         (execl #$(file-append package "/bin/updatedb")
                                "updatedb"
                                #$(string-append "--prunepaths="
                                                 (string-join
                                                  excluded-directories)))))))
      (list #~(job #$schedule #$updatedb)))))

(define file-database-service-type
  (service-type
   (name 'file-database)
   (extensions (list (service-extension mcron-service-type
                                        file-database-mcron-jobs)))
   (description
    "Periodically update the file database used by the @command{locate} command,
which lets you search for files by name.  The database is created by running
the @command{updatedb} command.")
   (default-value (file-database-configuration))))

(define %default-package-database-update-schedule
  ;; Default mcron schedule for the periodic 'guix locate --update' job: once
  ;; every Monday.
  "10 23 * * 1")

(define-configuration/no-serialization package-database-configuration
  (package (file-like guix)
           "The Guix package to use.")
  (schedule (string-or-gexp
             %default-package-database-update-schedule)
            "String or G-exp denoting an mcron schedule for the periodic
@command{guix locate --update} job (@pxref{Guile Syntax,,, mcron,
GNU@tie{}mcron}).")
  (method    (symbol 'store)
             "Indexing method for @command{guix locate}.  The default value,
@code{'store}, yields a more complete database but is relatively expensive in
terms of CPU and input/output.")
  (channels (gexp #~%default-channels)
            "G-exp denoting the channels to use when updating the database
(@pxref{Channels})."))

(define (package-database-mcron-jobs configuration)
  (match-record configuration <package-database-configuration>
    (package schedule method channels)
    (let ((channels (scheme-file "channels.scm" channels)))
      (list #~(job #$schedule
                   ;; XXX: The whole thing's running as "root" just because it
                   ;; needs write access to /var/cache/guix/locate.
                   (string-append #$(file-append package "/bin/guix")
                                  " time-machine -C " #$channels
                                  " -- locate --update --method="
                                  #$(symbol->string method)))))))

(define package-database-service-type
  (service-type
   (name 'package-database)
   (extensions (list (service-extension mcron-service-type
                                        package-database-mcron-jobs)))
   (description
    "Periodically update the package database used by the @code{guix locate} command,
which lets you search for packages that provide a given file.")
   (default-value (package-database-configuration))))


;;;
;;; Unattended upgrade.
;;;

(define-record-type* <unattended-upgrade-configuration>
  unattended-upgrade-configuration make-unattended-upgrade-configuration
  unattended-upgrade-configuration?
  (operating-system-file unattended-upgrade-operating-system-file
                         (default "/run/current-system/configuration.scm"))
  (operating-system-expression unattended-upgrade-operating-system-expression
                               (default #f))
  (schedule             unattended-upgrade-configuration-schedule
                        (default "30 01 * * 0"))
  (channels             unattended-upgrade-configuration-channels
                        (default #~%default-channels))
  (reboot?              unattended-upgrade-configuration-reboot?
                        (default #f))
  (services-to-restart  unattended-upgrade-configuration-services-to-restart
                        (default '(mcron)))
  (system-expiration    unattended-upgrade-system-expiration
                        (default (* 3 30 24 3600)))
  (maximum-duration     unattended-upgrade-maximum-duration
                        (default 3600))
  (log-file             unattended-upgrade-configuration-log-file
                        (default %unattended-upgrade-log-file)))

(define %unattended-upgrade-log-file
  "/var/log/unattended-upgrade.log")

(define (unattended-upgrade-mcron-jobs config)
  (define channels
    (scheme-file "channels.scm"
                 (unattended-upgrade-configuration-channels config)))

  (define log
    (unattended-upgrade-configuration-log-file config))

  (define services
    (unattended-upgrade-configuration-services-to-restart config))

  (define reboot?
    (unattended-upgrade-configuration-reboot? config))

  (define expiration
    (unattended-upgrade-system-expiration config))

  (define config-file
    (unattended-upgrade-operating-system-file config))

  (define expression
    (unattended-upgrade-operating-system-expression config))

  (define arguments
    (if expression
        #~(list "-e" (object->string '#$expression))
        #~(list #$config-file)))

  (define code
    (with-imported-modules (source-module-closure '((guix build utils)
                                                    (gnu services herd)))
      #~(begin
          (use-modules (guix build utils)
                       (gnu services herd)
                       (srfi srfi-19)
                       (srfi srfi-34))

          (define log
            (open-file #$log "a0"))

          (define (timestamp)
            (date->string (time-utc->date (current-time time-utc))
                          "[~4]"))

          (define (alarm-handler . _)
            (format #t "~a time is up, aborting upgrade~%"
                    (timestamp))
            (exit 1))

          ;; 'guix time-machine' needs X.509 certificates to authenticate the
          ;; Git host.
          (setenv "SSL_CERT_DIR"
                  #$(file-append nss-certs "/etc/ssl/certs"))

          ;; Make sure the upgrade doesn't take too long.
          (sigaction SIGALRM alarm-handler)
          (alarm #$(unattended-upgrade-maximum-duration config))

          ;; Redirect stdout/stderr to LOG to save the output of 'guix' below.
          (redirect-port log (current-output-port))
          (redirect-port log (current-error-port))

          (format #t "~a starting upgrade...~%" (timestamp))
          (guard (c ((invoke-error? c)
                     (report-invoke-error c)))
            (apply invoke #$(file-append guix "/bin/guix")
                   "time-machine" "-C" #$channels
                   "--" "system" "reconfigure" #$arguments)

            ;; 'guix system delete-generations' fails when there's no
            ;; matching generation.  Thus, catch 'invoke-error?'.
            (guard (c ((invoke-error? c)
                       (report-invoke-error c)))
              (invoke #$(file-append guix "/bin/guix")
                      "system" "delete-generations"
                      #$(string-append (number->string expiration)
                                       "s")))

            (unless #$reboot?
              ;; Rebooting effectively restarts services anyway and execution
              ;; would be halted here if mcron is restarted.
              (format #t "~a restarting services...~%" (timestamp))
              (for-each restart-service '#$services))

            ;; XXX: If 'mcron' has been restarted, this is not reached.
            (format #t "~a upgrade complete~%" (timestamp))

            ;; Stopping the root shepherd service triggers a reboot.
            (when #$reboot?
              (format #t "~a rebooting system~%" (timestamp))
              (force-output) ;ensure the entire log is written.
              (stop-service 'root))))))

  (define upgrade
    (program-file "unattended-upgrade" code))

  (list #~(job #$(unattended-upgrade-configuration-schedule config)
               #$upgrade)))

(define (unattended-upgrade-log-rotations config)
  (list (log-rotation
         (files
          (list (unattended-upgrade-configuration-log-file config))))))

(define unattended-upgrade-service-type
  (service-type
   (name 'unattended-upgrade)
   (extensions
    (list (service-extension mcron-service-type
                             unattended-upgrade-mcron-jobs)
          (service-extension rottlog-service-type
                             unattended-upgrade-log-rotations)))
   (description
    "Periodically upgrade the system from the current configuration.")
   (default-value (unattended-upgrade-configuration))))

;;;
;;; Resize file system.
;;;

(define-record-type* <resize-file-system-configuration>
  resize-file-system-configuration make-resize-file-system-configuration
  resize-file-system-configuration?
  (file-system    resize-file-system-file-system
                  (default #f))
  (cloud-utils    resize-file-system-cloud-utils
                  (default cloud-utils))
  (e2fsprogs      resize-file-system-e2fsprogs
                  (default e2fsprogs))
  (btrfs-progs    resize-file-system-btrfs-progs
                  (default btrfs-progs))
  (bcachefs-tools resize-file-system-bcachefs-tools
                  (default bcachefs-tools)))

(define (resize-file-system-shepherd-service config)
  "Returns a <shepherd-service> for resize-file-system-service for CONFIG."
  (match-record config <resize-file-system-configuration>
                (file-system cloud-utils e2fsprogs btrfs-progs
                             bcachefs-tools)
    (let ((fs-spec (file-system->spec file-system)))
      (shepherd-service
       (documentation "Resize a file system. Intended for Guix Systems that
are booted from a system image flashed onto a larger medium.")
       ;; XXX: This could be extended with file-system info.
       (provision '(resize-file-system))
       (requirement '(user-processes))
       (one-shot? #t)
       (respawn? #f)
       (modules '((guix build utils)
                  (gnu build file-systems)
                  (gnu system file-systems)
                  (ice-9 control)
                  (ice-9 match)
                  (ice-9 ftw)
                  (ice-9 rdelim)
                  (srfi srfi-34)))
       (start (with-imported-modules (source-module-closure
                                      '((guix build utils)
                                        (gnu build file-systems)
                                        (gnu system file-systems)))
                #~(lambda _
                    (use-modules (guix build utils)
                                 (gnu build file-systems)
                                 (gnu system file-systems)
                                 (ice-9 control)
                                 (ice-9 match)
                                 (ice-9 ftw)
                                 (ice-9 rdelim)
                                 (srfi srfi-34))

                    (define file-system
                      (spec->file-system '#$fs-spec))

                    ;; Shepherd recommends the start constructor takes <1
                    ;; minute, canonicalize-device-spec will hang for up to
                    ;; max-trials seconds (20 seconds) if an invalid device is
                    ;; connected. Revisit this if max-trials increases.
                    (define device (canonicalize-device-spec
                                    (file-system-device file-system)))

                    (define grow-partition-command
                      (let* ((sysfs-device
                              (string-append "/sys/class/block/"
                                             (basename device)))
                             (partition-number
                              (with-input-from-file
                                  (string-append sysfs-device
                                                 "/partition")
                                read-line))
                             (parent (string-append
                                      "/dev/"
                                      (basename (dirname (readlink sysfs-device))))))
                        (list #$(file-append cloud-utils "/bin/growpart")
                              parent partition-number)))

                    (define grow-filesystem-command
                      (match (file-system-type file-system)
                        ((or "ext2" "ext3" "ext4")
                         (list #$(file-append e2fsprogs "/sbin/resize2fs") device))
                        ("btrfs"
                         (list #$(file-append btrfs-progs "/bin/btrfs")
                               "filesystem" "resize" device))
                        ("bcachefs"
                         (list #$(file-append bcachefs-tools "/sbin/bcachefs")
                               "device" "resize" device))
                        (e (error "Unsupported filesystem type" e))))

                    (let/ec return
                      (guard (c ((and (invoke-error? c)
                                      ;; growpart NOCHANGE exits with 1. It is
                                      ;; unlikely the partition was resized
                                      ;; while the file system was not. Just
                                      ;; exit.
                                      (equal? (invoke-error-exit-status c) 1))
                                 (format (current-error-port)
                                         "The device ~a is already resized.~%" device)
                                 ;; Must return something or Shepherd considers
                                 ;; the service perpetually starting.
                                 (return 0)))
                        (apply invoke grow-partition-command))
                      (apply invoke grow-filesystem-command)))))))))

(define resize-file-system-service-type
  (service-type
   (name 'resize-file-system)
   (description "Resize a partition and the underlying file system during boot.")
   (extensions
    (list
     (service-extension shepherd-root-service-type
                        (compose list resize-file-system-shepherd-service))))
   (default-value (resize-file-system-configuration))))

;;; admin.scm ends here
generated by cgit
(((string-append "\"lib" layer-name ".so\"")) (string-append "\"" out "/lib/lib" layer-name ".so\""))))))) (for-each fix-layer-path '("VkLayer_MESA_device_select" "VkLayer_MESA_overlay")))))))) (native-search-paths (list (search-path-specification ;; Ensure the Mesa VDPAU drivers can be found. (variable "VDPAU_DRIVER_PATH") (separator #f) (files '("lib/vdpau"))))) (home-page "https://mesa3d.org/") (synopsis "OpenGL and Vulkan implementations") (description "Mesa is a free implementation of the OpenGL and Vulkan specifications - systems for rendering interactive 3D graphics. A variety of device drivers allows Mesa to be used in many different environments ranging from software emulation to complete hardware acceleration for modern GPUs.") (license license:x11))) (define-public mesa-opencl (package/inherit mesa (name "mesa-opencl") (source (origin (inherit (package-source mesa)))) (arguments (substitute-keyword-arguments (package-arguments mesa) ((#:configure-flags flags) #~(cons "-Dgallium-opencl=standalone" #$flags)))))) (define-public mesa-opencl-icd (package/inherit mesa-opencl (name "mesa-opencl-icd") (arguments (substitute-keyword-arguments (package-arguments mesa) ((#:configure-flags flags) #~(cons "-Dgallium-opencl=icd" (delete "-Dgallium-opencl=standalone" #$flags))) ((#:phases phases) #~(modify-phases #$phases (add-after 'install 'mesa-icd-absolute-path (lambda _ ;; Use absolute path for OpenCL platform library. ;; Otherwise we would have to set LD_LIBRARY_PATH=LIBRARY_PATH ;; for ICD in our applications to find OpenCL platform. (use-modules (guix build utils) (ice-9 textual-ports)) (let* ((out #$output) (mesa-icd (string-append out "/etc/OpenCL/vendors/mesa.icd")) (old-path (call-with-input-file mesa-icd get-string-all)) (new-path (string-append out "/lib/" (string-trim-both old-path)))) (if (file-exists? new-path) (call-with-output-file mesa-icd (lambda (port) (format port "~a\n" new-path))))))))))))) (define-public mesa-headers (package/inherit mesa (name "mesa-headers") (propagated-inputs '()) (inputs '()) (native-inputs '()) (outputs '("out")) (arguments '(#:phases (modify-phases %standard-phases (delete 'configure) (delete 'build) (delete 'check) (replace 'install (lambda* (#:key outputs #:allow-other-keys) (copy-recursively "include" (string-append (assoc-ref outputs "out") "/include"))))))))) ;;; The mesa-demos distribution contains non-free files, many files with no ;;; clear license information, and many demos that aren't useful for most ;;; people, so we just use this for the mesa-utils package below, and possibly ;;; other packages in the future. This is modeled after Debian's solution. (define (mesa-demos-source version) (origin (method url-fetch) (uri (string-append "ftp://ftp.freedesktop.org/pub/mesa/demos" "/mesa-demos-" version ".tar.bz2")) (sha256 (base32 "0zgzbz55a14hz83gbmm0n9gpjnf5zadzi2kjjvkn6khql2a9rs81")))) (define-public mesa-utils (package (name "mesa-utils") (version "8.4.0") (source (mesa-demos-source version)) (build-system gnu-build-system) (inputs (list mesa freeglut glew)) (native-inputs (list pkg-config)) (arguments (list #:phases #~(modify-phases %standard-phases (replace 'install (lambda* (#:key outputs #:allow-other-keys) (let ((out #$output)) (mkdir-p (string-append out "/bin")) (for-each (lambda (file) (copy-file file (string-append out "/bin/" (basename file)))) '("src/xdemos/glxdemo" "src/xdemos/glxgears" "src/egl/opengl/eglinfo" "src/xdemos/glxinfo" "src/xdemos/glxheads")))))))) (home-page "https://mesa3d.org/") (synopsis "Utility tools for Mesa") (description "The mesa-utils package contains several utility tools for Mesa: eglinfo, glxdemo, glxgears, glxheads, and glxinfo.") ;; glxdemo is public domain; others expat. (license (list license:expat license:public-domain)))) (define-public glew (package (name "glew") (version "2.2.0") (source (origin (method url-fetch) (uri (string-append "mirror://sourceforge/glew/glew/" version "/glew-" version ".tgz")) (sha256 (base32 "1qak8f7g1iswgswrgkzc7idk7jmqgwrs58fhg2ai007v7j4q5z6l")) (modules '((guix build utils))) (snippet '(begin (substitute* "config/Makefile.linux" (("= cc") "= gcc") (("/lib64") "/lib")) #t)))) (build-system gnu-build-system) (arguments (list #:make-flags #~(list #$@(if (%current-target-system) #~((string-append "CC=" #$(cc-for-target)) (string-append "LD=" #$(cc-for-target)) (string-append "STRIP=" #$(strip-for-target))) #~()) (string-append "GLEW_PREFIX=" #$output) (string-append "GLEW_DEST=" #$output)) #:phases #~(modify-phases %standard-phases (delete 'configure) (add-after 'install 'delete-static (lambda _ (delete-file (string-append #$output "/lib/libGLEW.a"))))) #:tests? #f)) ;no 'check' target (inputs (list libxi libxmu libx11 mesa)) ;; <GL/glew.h> includes <GL/glu.h>. (propagated-inputs (list glu)) (home-page "http://glew.sourceforge.net/") (synopsis "OpenGL extension loading library for C and C++") (description "The OpenGL Extension Wrangler Library (GLEW) is a C/C++ extension loading library. GLEW provides efficient run-time mechanisms for determining which OpenGL extensions are supported on the target platform. OpenGL core and extension functionality is exposed in a single header file.") (license license:bsd-3))) (define-public guile-opengl (package (name "guile-opengl") (version "0.2.0") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/guile-opengl/guile-opengl-" version ".tar.gz")) (sha256 (base32 "0rbc2wf9x63ilj3n85h8wyllzc2b22abmhs2p2ghjgc253n8gw5q")))) (build-system gnu-build-system) (native-inputs (list pkg-config)) (inputs (list guile-2.2 mesa glu freeglut)) (arguments '(#:phases (modify-phases %standard-phases (add-before 'build 'patch-dynamic-link (lambda* (#:key inputs outputs #:allow-other-keys) (substitute* "gl/runtime.scm" (("\\(dynamic-link\\)") (string-append "(dynamic-link \"" (assoc-ref inputs "mesa") "/lib/libGL.so" "\")"))) (define (dynamic-link-substitute file lib input) (substitute* file (("dynamic-link \"lib([a-zA-Z]+)\"" _ lib) (string-append "dynamic-link \"" (assoc-ref inputs input) "/lib/lib" lib "\"")))) ;; Replace dynamic-link calls for libGL, libGLU, and ;; libglut with absolute paths to the store. (dynamic-link-substitute "glx/runtime.scm" "GL" "mesa") (dynamic-link-substitute "glu/runtime.scm" "GLU" "glu") (dynamic-link-substitute "glut/runtime.scm" "glut" "freeglut")))))) (home-page "https://gnu.org/s/guile-opengl") (synopsis "Guile binding for the OpenGL graphics API") (description "Guile-OpenGL is a library for Guile that provides bindings to the OpenGL graphics API.") (license license:lgpl3+))) (define-public guile3.0-opengl (package (inherit guile-opengl) (name "guile3.0-opengl") (inputs (list guile-3.0 mesa glu freeglut)))) (define-public libepoxy (package (name "libepoxy") (version "1.5.10") (home-page "https://github.com/anholt/libepoxy") (source (origin (method git-fetch) (uri (git-reference (url home-page) (commit version))) (file-name (git-file-name name version)) (sha256 (base32 "0jw02bzdwynyrwsn5rhcacv92h9xx928j3xp436f8gdnwlyb5641")))) (arguments (list #:phases #~(modify-phases %standard-phases (add-before 'configure 'patch-paths (lambda* (#:key inputs #:allow-other-keys) (let ((mesa-lib (lambda (file) (search-input-file inputs (string-append "lib/" file))))) (substitute* (find-files "." "\\.[ch]$") (("libGL.so.1") (mesa-lib "libGL.so.1")) (("libEGL.so.1") (mesa-lib "libEGL.so.1")) (("libGLESv1_CM.so.1") (mesa-lib "libGLESv1_CM.so.1")) (("libGLESv2.so.2") (mesa-lib "libGLESv2.so.2"))))))))) (build-system meson-build-system) (native-inputs (list pkg-config python)) (propagated-inputs ;; epoxy.pc: 'Requires.private: gl egl' (list mesa)) (synopsis "Library for handling OpenGL function pointer management") (description "A library for handling OpenGL function pointer management.") (license license:x11))) (define-public libglvnd (package (name "libglvnd") (version "1.7.0") (home-page "https://gitlab.freedesktop.org/glvnd/libglvnd") (source (origin (method git-fetch) (uri (git-reference (url home-page) (commit (string-append "v" version)))) (file-name (git-file-name name version)) (sha256 (base32 "07v3bmwzmg0d4g2zp835v1g7j22j8vz7hjfmqrdqjgxjj6v4jkyr")))) (build-system meson-build-system) (arguments '(#:configure-flags '("-Dx11=enabled") #:phases (modify-phases %standard-phases (add-after 'unpack 'disable-glx-tests (lambda _ ;; This package is meant to be used alongside Mesa. ;; To avoid a circular dependency, disable tests that ;; require a running Xorg server. (substitute* "tests/meson.build" (("if with_glx") "if false"))))))) (native-inputs (list pkg-config)) (inputs (list libx11 libxext xorgproto)) (synopsis "Vendor-neutral OpenGL dispatch library") (description "libglvnd is a vendor-neutral dispatch layer for arbitrating OpenGL API calls between multiple vendors. It allows multiple drivers from different vendors to coexist on the same file system, and determines which vendor to dispatch each API call to at runtime. Both GLX and EGL are supported, in any combination with OpenGL and OpenGL ES.") ;; libglvnd is available under a custom X11-style license, and incorporates ;; code with various other licenses. See README.md for details. (license (list (license:x11-style "file://README.md") license:x11 license:expat)))) (define-public libopenglrecorder (package (name "libopenglrecorder") (version "0.1.0") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/Benau/libopenglrecorder") (commit (string-append "v" version)))) (file-name (git-file-name name version)) (sha256 (base32 "0sfx2kdw2mca3mx4fnk1yy74pilp2i9npcpyj894qkngz5aaz2wl")))) (build-system cmake-build-system) (arguments (list #:tests? #f)) ;no test suite (native-inputs (list pkg-config)) (inputs (list libjpeg-turbo)) (home-page "https://github.com/Benau/libopenglrecorder") (synopsis "Async readback OpenGL frame buffer with audio recording") (description "libopenglrecorder is a library allowing optional async readback OpenGL frame buffer with optional audio recording. It will do video and audio encoding together.") (license license:bsd-3))) (define-public soil (package (name "soil") (version "1.0.7") (source (origin (method url-fetch) ;; No versioned archive available. (uri "http://www.lonesock.net/files/soil.zip") (sha256 (base32 "00gpwp9dldzhsdhksjvmbhsd2ialraqbv6v6dpikdmpncj6mnc52")))) (build-system gnu-build-system) (arguments '(#:tests? #f ; no tests #:phases (modify-phases %standard-phases (delete 'configure) (add-before 'build 'init-build (lambda* (#:key outputs #:allow-other-keys) (let ((out (assoc-ref outputs "out"))) (setenv "CFLAGS" "-fPIC") ; needed for shared library ;; Use alternate Makefile (copy-file "projects/makefile/alternate Makefile.txt" "src/Makefile") (chdir "src") (substitute* '("Makefile") (("INCLUDEDIR = /usr/include/SOIL") (string-append "INCLUDEDIR = " out "/include/SOIL")) (("LIBDIR = /usr/lib") (string-append "LIBDIR = " out "/lib")) ;; Remove these flags from 'install' commands. (("-o root -g root") "")))))))) (native-inputs (list unzip)) (inputs (list mesa)) (home-page "https://www.lonesock.net/soil.html") (synopsis "OpenGL texture loading library") (description "SOIL is a tiny C library used primarily for uploading textures into OpenGL.") (license license:public-domain))) (define-public glfw (package (name "glfw") (version "3.3.10") (source (origin (method url-fetch) (uri (string-append "https://github.com/glfw/glfw" "/releases/download/" version "/glfw-" version ".zip")) (sha256 (base32 "1f5xs4cj1y5wk1jimv1mylk6n6vh7433js28mfd1kf7p2zw3whz8")))) (build-system cmake-build-system) (arguments (list #:modules '((guix build cmake-build-system) (guix build utils) (ice-9 format)) #:tests? #f ;no test target #:configure-flags #~(list "-DBUILD_SHARED_LIBS=ON") #:phases #~(modify-phases %standard-phases (add-after 'unpack 'patch-sonames (lambda* (#:key inputs #:allow-other-keys) (let-syntax ((patch-sonames (syntax-rules () ((_ (file ...) soname ...) (substitute* (list file ...) (((format #f "(~@{~a~^|~})" soname ...) lib) (search-input-file inputs (string-append "lib/" lib)))))))) ;; Avoid looking in LD_LIBRARY_PATH for dlopen calls. (patch-sonames ("src/egl_context.c" "src/glx_context.c" "src/vulkan.c" "src/wl_init.c" "src/x11_init.c") "libEGL.so.1" "libGL.so" "libGL.so.1" "libGLESv1_CM.so.1" "libGLESv2.so.2" "libvulkan.so.1" "libwayland-cursor.so.0" "libwayland-egl.so.1" "libwayland-client.so.0" "libxkbcommon.so.0" "libXxf86vm.so.1" "libXi.so.6" "libXrandr.so.2" "libXcursor.so.1" "libXinerama.so.1" "libX11-xcb.so.1" "libXrender.so.1"))))))) (native-inputs (list doxygen unzip)) (inputs (list libxkbcommon wayland vulkan-loader)) (propagated-inputs (list mesa ;included in public headers ;; These are in 'Requires.private' of 'glfw3.pc'. libx11 libxrandr libxi libxinerama libxcursor libxxf86vm)) (home-page "https://www.glfw.org") (synopsis "OpenGL application development library") (description "GLFW is a library for OpenGL, OpenGL ES and Vulkan development for desktop computers. It provides a simple API for creating windows, contexts and surfaces, receiving input and events.") (license license:zlib))) (define-public glfw-3.4 (package (inherit glfw) (version "3.4") (source (origin (method url-fetch) (uri (string-append "https://github.com/glfw/glfw" "/releases/download/" version "/glfw-" version ".zip")) (sha256 (base32 "1sd396kkn53myp61kxrd18h7b1q4ix173hhxhvl0iz8j4x5h1v5m")))) (native-inputs (modify-inputs (package-native-inputs glfw) (prepend pkg-config))) ;; When building out of source, the install phase fails with: ;; file INSTALL cannot find "/tmp/guix-build-glfw-3.4.drv-0/build/docs/html": ;; No such file or directory (arguments (substitute-keyword-arguments (package-arguments glfw) ((#:out-of-source? _ #f) #f))))) (define-public nanovg-for-extempore (let ((version "0.7.1") (revision "0") (commit "3c60175fcc2e5fe305b04355cdce35d499c80310")) (package (name "nanovg-for-extempore") (version (git-version version revision commit)) (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/extemporelang/nanovg") (commit commit))) (file-name (git-file-name name version)) (sha256 (base32 "0ddn3d3mxqn8hj9967v3pss7lz1wn08pcdnqzc118g7yjkq7hxzy")))) (build-system cmake-build-system) (arguments `(#:tests? #f)) ; no tests included (inputs (list mesa)) ;; Extempore refuses to build on architectures other than x86_64 (supported-systems '("x86_64-linux")) (home-page "https://github.com/extemporelang/nanovg") (synopsis "2D vector drawing library on top of OpenGL") (description "NanoVG is small antialiased vector graphics rendering library for OpenGL. It has lean API modeled after HTML5 canvas API. It is aimed to be a practical and fun toolset for building scalable user interfaces and visualizations.") (license license:zlib)))) (define-public gl2ps (package (name "gl2ps") (version "1.4.2") (source (origin (method url-fetch) (uri (string-append "http://geuz.org/gl2ps/src/gl2ps-" version ".tgz")) (sha256 (base32 "1sgzv547h7hrskb9qd0x5yp45kmhvibjwj2mfswv95lg070h074d")))) (build-system cmake-build-system) (inputs (list libpng mesa zlib)) (arguments `(#:tests? #f)) ; no tests (home-page "https://www.geuz.org/gl2ps/") (synopsis "OpenGL to PostScript printing library") (description "GL2PS is a C library providing high quality vector output for any OpenGL application. GL2PS uses sorting algorithms capable of handling intersecting and stretched polygons, as well as non-manifold objects. GL2PS provides many features including advanced smooth shading and text rendering, culling of invisible primitives and mixed vector/bitmap output.") ;; GL2PS is dual-licenced and can be used under the terms of either. (license (list license:lgpl2.0+ (license:fsf-free "http://www.geuz.org/gl2ps/COPYING.GL2PS" "GPL-incompatible copyleft license"))))) (define-public virtualgl (package (name "virtualgl") (version "2.6.2") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/VirtualGL/virtualgl") (commit version))) (file-name (git-file-name name version)) (sha256 (base32 "0yyc553xsb5n0rx7jp9p4wdbd7md07b3qrkf3ssyjavqqg908qg9")))) (arguments `(#:tests? #f ; no tests are available #:configure-flags (list (string-append "-DCMAKE_INSTALL_LIBDIR=" (assoc-ref %outputs "out") "/lib") "-DVGL_USESSL=1"))) ; use OpenSSL (build-system cmake-build-system) (inputs (list glu libjpeg-turbo libxtst mesa openssl)) (native-inputs (list pkg-config)) (home-page "https://www.virtualgl.org") (synopsis "Redirects 3D commands from an OpenGL application onto a 3D graphics card") (description "VirtualGL redirects the 3D rendering commands from OpenGL applications to 3D accelerator hardware in a dedicated server and displays the rendered output interactively to a thin client located elsewhere on the network.") (license license:wxwindows3.1+))) (define-public mojoshader (let ((changeset "5887634ea695")) (package (name "mojoshader") (version (string-append "20190825" "-" changeset)) (source (origin (method hg-fetch) (uri (hg-reference (url "https://hg.icculus.org/icculus/mojoshader/") (changeset changeset))) (file-name (git-file-name name version)) (sha256 (base32 "0ibl4z1696jiifv9j5drir7jm0b5px0vwkwckbi7cfd46p7p6wcy")))) (arguments ;; Tests only for COMPILER_SUPPORT=ON. `(#:tests? #f #:configure-flags '("-DBUILD_SHARED=ON" "-DFLIP_VIEWPORT=ON" "-DDEPTH_CLIPPING=ON") #:phases (modify-phases %standard-phases (replace 'install (lambda* (#:key outputs #:allow-other-keys) (let* ((out (assoc-ref outputs "out")) (lib (string-append out "/lib")) (header (string-append out "/include"))) (install-file "libmojoshader.so" lib) (for-each (lambda (f) (install-file f header)) (find-files "../source" "mojoshader.*\\.h$")) (let ((profiles-header (string-append header "/profiles"))) (mkdir-p profiles-header) (rename-file (string-append header "/mojoshader_profile.h") (string-append profiles-header "/mojoshader_profile.h")))) #t))))) (build-system cmake-build-system) (home-page "https://www.icculus.org/mojoshader/") (synopsis "Work with Direct3D shaders on alternate 3D APIs") (description "MojoShader is a library to work with Direct3D shaders on alternate 3D APIs and non-Windows platforms. The primary motivation is moving shaders to OpenGL languages on the fly. The developer deals with \"profiles\" that represent various target languages, such as GLSL or ARB_*_program. This allows a developer to manage one set of shaders, presumably written in Direct3D HLSL, and use them across multiple rendering backends. This also means that the developer only has to worry about one (offline) compiler to manage program complexity, while MojoShader itself deals with the reduced complexity of the bytecode at runtime. MojoShader provides both a simple API to convert bytecode to various profiles, and (optionally) basic glue to rendering APIs to abstract the management of the shaders at runtime.") (license license:zlib)))) (define-public mojoshader-with-viewport-flip ;; Changeset c586d4590241 replaced glProgramViewportFlip with ;; glProgramViewportInfo. ;; https://hg.icculus.org/icculus/mojoshader/rev/c586d4590241 (let ((changeset "2e37299b13d8")) (package (inherit mojoshader) (name "mojoshader-with-viewport-flip") (version (string-append "20190725" "-" changeset)) (source (origin (method hg-fetch) (uri (hg-reference (url "https://hg.icculus.org/icculus/mojoshader/") (changeset changeset))) (file-name (git-file-name name version)) (sha256 (base32 "0ffws7cqbskxwc3hjsnnzq4r2bbf008kdr3b11pa3kr7dsi50y6i")))) (synopsis "Work with Direct3D shaders on alternate 3D APIs (with viewport flip)") (description "This is the last version of the mojoshader library with the glProgramViewportFlip before it was replaced with glProgramViewportInfo.") (license license:zlib)))) (define-public glmark2 (package (name "glmark2") (version "2023.01") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/glmark2/glmark2") (commit version))) (file-name (git-file-name name version)) (sha256 (base32 "094dr0ljg1hq6wymw2hb3369p4g91sn5c2qf554dl0dbdbjdqasq")))) (build-system meson-build-system) (arguments '(#:tests? #f ; no check target #:configure-flags (list (string-append "-Dflavors=" (string-join '("x11-gl" "x11-glesv2" "drm-gl" "drm-glesv2" "wayland-gl" "wayland-glesv2") ","))) #:phases (modify-phases %standard-phases (add-after 'unpack 'patch-paths (lambda* (#:key inputs #:allow-other-keys) (let ((mesa (assoc-ref inputs "mesa"))) (substitute* (find-files "src" "gl-state-.*\\.cpp$") (("libGL.so") (string-append mesa "/lib/libGL.so")) (("libEGL.so") (string-append mesa "/lib/libEGL.so")) (("libGLESv2.so") (string-append mesa "/lib/libGLESv2.so"))) #t)))))) (native-inputs (list pkg-config)) (inputs (list eudev libdrm libjpeg-turbo libpng libx11 libxcb mesa wayland wayland-protocols)) (home-page "https://github.com/glmark2/glmark2") (synopsis "OpenGL 2.0 and OpenGL ES 2.0 benchmark") (description "glmark2 is an OpenGL 2.0 and OpenGL ES 2.0 benchmark based on the original glmark benchmark by Ben Smith.") (license license:gpl3+))) (define-public waffle (package (name "waffle") (version "1.8.0") (source (origin (method git-fetch) (uri (git-reference (url "https://gitlab.freedesktop.org/mesa/waffle") (commit (string-append "v" version)))) (file-name (git-file-name name version)) (sha256 (base32 "1mrw0arlrpm83cwaz7rnimkkjv3a134rcmi1h512y2g4yjzhnm8r")) (modules '((ice-9 ftw) (guix build utils))) (snippet #~(with-directory-excursion "third_party" (let ((keep '("." ".." "meson.build" "threads"))) (for-each (lambda (f) (unless (member f keep) (delete-file-recursively f))) (scandir "."))))))) (build-system meson-build-system) (propagated-inputs (list mesa wayland)) (native-inputs (list cmocka pkg-config)) (home-page "https://waffle.freedesktop.org/") (synopsis "Choose OpenGL API at runtime") (description "Waffle is a library that allows one to defer selection of an OpenGL API and a window system until runtime.") (license license:bsd-2))) (define-public piglit (let ((revision "1") (commit "814046fe6942eac660ee4a6cc5fcc54011a49945")) (package (name "piglit") (version (git-version "0.0.0" revision commit)) (source (origin (method git-fetch) (uri (git-reference (url "https://gitlab.freedesktop.org/mesa/piglit") (commit commit))) (file-name (git-file-name name version)) (sha256 (base32 "1bzaalcxskckfnwprw77sbbmfqi59by2j8imaq8ghnlzhlxv7mk7")))) (build-system cmake-build-system) (arguments (list #:configure-flags #~(list "-DPIGLIT_SSE2=OFF") ;; Tests are not invoked through cmake. Instead, there are ;; pytest/tox-based tests for the framework, but they require ;; unpackaged plugins. #:tests? #f #:phases #~(modify-phases %standard-phases (add-after 'unpack 'patch-source (lambda* (#:key inputs #:allow-other-keys) (substitute* (find-files "framework/" "\\.py$") (("'wflinfo'") (string-append "'" (search-input-file inputs "/bin/wflinfo") "'"))))) (add-after 'install 'wrap (lambda* (#:key outputs #:allow-other-keys) (wrap-script (string-append (assoc-ref outputs "out") "/bin/piglit") `("GUIX_PYTHONPATH" prefix (,(getenv "GUIX_PYTHONPATH"))))))))) (inputs (list guile-3.0 ; for wrap-script libxkbcommon python python-lxml python-mako python-numpy glslang vulkan-headers vulkan-loader waffle)) (native-inputs (list pkg-config)) (home-page "https://piglit.freedesktop.org/") (synopsis "Test OpenGL implementations") (description "Piglit is a collection of automated tests for OpenGL and OpenCL implementations.") ;; A mix of licenses for various tests (license (list license:expat license:bsd-3 license:gpl2+ license:gpl3+)))))
generated by cgit