From fcc58db68b2af59dea0cae41bc1e2df47911d588 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= Date: Thu, 18 Jun 2015 00:22:13 +0200 Subject: Add 'guix size'. * guix/scripts/size.scm: New file. * Makefile.am (MODULES): Add it. (SCM_TESTS): Add tests/size.scm. * doc.am (SUBCOMMANDS): Add 'size'. * po/guix/POTFILES.in: Add guix/scripts/size.scm. * tests/size.scm: New file. * doc/guix.texi (Packages with Multiple Outputs): Add xref to "Invoking guix size". (Invoking guix size): New node. (Invoking guix gc): Add index for "closure" and xref to the above. * doc/contributing.texi (Submitting Patches): Use @enumerate for the check list. Add item about 'guix size'. --- guix/scripts/size.scm | 247 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 247 insertions(+) create mode 100644 guix/scripts/size.scm (limited to 'guix/scripts/size.scm') diff --git a/guix/scripts/size.scm b/guix/scripts/size.scm new file mode 100644 index 0000000000..41dd6043a7 --- /dev/null +++ b/guix/scripts/size.scm @@ -0,0 +1,247 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright © 2015 Ludovic Courtès +;;; +;;; 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 . + +(define-module (guix scripts size) + #:use-module (guix ui) + #:use-module (guix store) + #:use-module (guix monads) + #:use-module (guix utils) + #:use-module (guix packages) + #:use-module (guix derivations) + #:use-module (gnu packages) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-9) + #:use-module (srfi srfi-11) + #:use-module (srfi srfi-34) + #:use-module (srfi srfi-37) + #:use-module (ice-9 ftw) + #:use-module (ice-9 match) + #:use-module (ice-9 format) + #:export (profile? + profile-file + profile-self-size + profile-closure-size + store-profile + + guix-size)) + +;; Size profile of a store item. +(define-record-type + (profile file self-size closure-size) + profile? + (file profile-file) ;store item + (self-size profile-self-size) ;size in bytes + (closure-size profile-closure-size)) ;size of dependencies in bytes + +(define (file-size file) + "Return the size of bytes of FILE, entering it if FILE is a directory." + (file-system-fold (const #t) + (lambda (file stat result) ;leaf + (+ (stat:size stat) result)) + (lambda (directory stat result) ;down + (+ (stat:size stat) result)) + (lambda (directory stat result) ;up + result) + (lambda (file stat result) ;skip + result) + (lambda (file stat errno result) + (format (current-error-port) + "file-size: ~a: ~a~%" file + (strerror errno)) + result) + 0 + file + lstat)) + +(define substitutable-path-info* + (store-lift substitutable-path-info)) + +(define (store-item-exists? item) + "Return #t if ITEM is in the store, and protect it from GC. Otherwise +return #f." + (lambda (store) + (add-temp-root store item) + (values (valid-path? store item) store))) + +(define (file-size* item) + "Like 'file-size', but resort to information from substitutes if ITEM is not +in the store." + (mlet %store-monad ((exists? (store-item-exists? item))) + (if exists? + (return (file-size item)) + (mlet %store-monad ((info (substitutable-path-info* (list item)))) + (match info + ((info) + ;; The nar size is an approximation, but a good one. + (return (substitutable-nar-size info))) + (() + (leave (_ "no available substitute information for '~a'~%") + item))))))) + +(define* (display-profile profile #:optional (port (current-output-port))) + "Display PROFILE, a list of PROFILE objects, to PORT." + (define MiB (expt 2 20)) + + (format port "~64a ~8a ~a\n" + (_ "store item") (_ "total") (_ "self")) + (let ((whole (reduce + 0 (map profile-self-size profile)))) + (for-each (match-lambda + (($ name self total) + (format port "~64a ~6,1f ~6,1f ~5,1f%\n" + name (/ total MiB) (/ self MiB) + (* 100. (/ self whole 1.))))) + (sort profile + (match-lambda* + ((($ _ _ total1) ($ _ _ total2)) + (> total1 total2))))))) + +(define display-profile* + (lift display-profile %store-monad)) + +(define (substitutable-requisites store item) + "Return the list of requisites of ITEM based on information available in +substitutes." + (let loop ((items (list item)) + (result '())) + (match items + (() + (delete-duplicates result)) + (items + (let ((info (substitutable-path-info store + (delete-duplicates items)))) + (loop (remove (lambda (item) ;XXX: complexity + (member item result)) + (append-map substitutable-references info)) + (append (append-map substitutable-references info) + result))))))) + +(define (requisites* item) + "Return as a monadic value the requisites of ITEMS, based either on the +information available in the local store or using information about +substitutes." + (lambda (store) + (guard (c ((nix-protocol-error? c) + (values (substitutable-requisites store item) + store))) + (values (requisites store item) store)))) + +(define (store-profile item) + "Return as a monadic value a list of objects representing the +profile of ITEM and its requisites." + (mlet* %store-monad ((refs (>>= (requisites* item) + (lambda (refs) + (return (delete-duplicates + (cons item refs)))))) + (sizes (mapm %store-monad + (lambda (item) + (>>= (file-size* item) + (lambda (size) + (return (cons item size))))) + refs))) + (define (dependency-size item) + (mlet %store-monad ((deps (requisites* item))) + (foldm %store-monad + (lambda (item total) + (return (+ (assoc-ref sizes item) total))) + 0 + (delete-duplicates (cons item deps))))) + + (mapm %store-monad + (match-lambda + ((item . size) + (mlet %store-monad ((dependencies (dependency-size item))) + (return (profile item size dependencies))))) + sizes))) + +(define* (ensure-store-item spec-or-item + #:key dry-run?) + "Return a store file name. If SPEC-OR-ITEM is a store file name, return it +as is. Otherwise, assume SPEC-OR-ITEM is a package output specification such +as \"guile:debug\" or \"gcc-4.8\" and return its store file name." + (with-monad %store-monad + (if (store-path? spec-or-item) + (return spec-or-item) + (let-values (((package output) + (specification->package+output spec-or-item))) + (mlet %store-monad ((drv (package->derivation package))) + ;; Note: we don't try building DRV like 'guix archive' does + ;; because we don't have to since we can instead rely on + ;; substitute meta-data. + (return (derivation->output-path drv output))))))) + + +;;; +;;; Options. +;;; + +(define (show-help) + (display (_ "Usage: guix size [OPTION]... PACKAGE +Report the size of PACKAGE and its dependencies.\n")) + (display (_ " + -s, --system=SYSTEM consider packages for SYSTEM--e.g., \"i686-linux\"")) + (newline) + (display (_ " + -h, --help display this help and exit")) + (display (_ " + -V, --version display version information and exit")) + (newline) + (show-bug-report-information)) + +(define %options + ;; Specifications of the command-line options. + (list (option '(#\s "system") #t #f + (lambda (opt name arg result) + (alist-cons 'system arg + (alist-delete 'system result eq?)))) + (option '(#\h "help") #f #f + (lambda args + (show-help) + (exit 0))) + (option '(#\V "version") #f #f + (lambda args + (show-version-and-exit "guix size"))))) + +(define %default-options + `((system . ,(%current-system)))) + + +;;; +;;; Entry point. +;;; + +(define (guix-size . args) + (with-error-handling + (let* ((opts (parse-command-line args %options (list %default-options))) + (files (filter-map (match-lambda + (('argument . file) file) + (_ #f)) + opts)) + (system (assoc-ref opts 'system)) + (dry-run? (assoc-ref opts 'dry-run?))) + (match files + (() + (leave (_ "missing store item argument\n"))) + ((file) + (with-store store + (run-with-store store + (mlet* %store-monad ((item (ensure-store-item file)) + (profile (store-profile item))) + (display-profile* profile)) + #:system system))) + ((files ...) + (leave (_ "too many arguments\n"))))))) -- cgit v1.2.3