From 4a4073c3b7ba588ab65c406d018336524a4c29b9 Mon Sep 17 00:00:00 2001
From: "B. Wilson" <elaexuotee@wilsonb.com>
Date: Thu, 28 May 2020 07:32:28 +0900
Subject: [PATCH] gnu: Add xed.
* gnu/packages/assembly.scm (xed): New variable.
---
gnu/packages/assembly.scm | 96 +++++++++++++++++++++++++++++++++++++++
1 file changed, 96 insertions(+)
@@ -8,6 +8,7 @@
;;; Copyright © 2019 Andy Tai <atai@atai.org>
;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net>
;;; Copyright © 2020 Christopher Lemmer Webber <cwebber@dustycloud.org>
+;;; Copyright © 2020 B. Wilson <elaexuotee@wilsonb.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -47,6 +48,7 @@
#:use-module (gnu packages texinfo)
#:use-module (gnu packages python)
#:use-module (gnu packages sphinx)
+ #:use-module (gnu packages shells)
#:use-module (gnu packages xml)
#:use-module ((guix utils)
#:select (%current-system)))
@@ -371,3 +373,97 @@ It understands mnemonics and generates code for NMOS 6502s (such
as 6502A, 6504, 6507, 6510, 7501, 8500, 8501, 8502 ...),
CMOS 6502s (65C02 and Rockwell R65C02) and the 65816.")
(license license:gpl2)))
+
+(define-public xed
+ (package
+ (name "xed")
+ (version "11.2.0")
+ (source
+ (origin
+ (method url-fetch)
+ (uri (string-append "https://github.com/intelxed/xed/archive/"
+ version ".tar.gz"))
+ (sha256
+ (base32 "1dl23wxz0dlkbcw6k78njnz2yc8a8yr4lp979sd9x1lnz74malvi"))
+ (file-name (string-append name "-" version ".tar.gz"))))
+ (build-system gnu-build-system)
+ (native-inputs
+ `(("python-2" ,python-2)
+ ("python-3" ,python-3)
+ ("tcsh" ,tcsh)
+ ("mbuild"
+ ,(let ((name "mbuild")
+ (version "0.2496"))
+ (origin
+ (method git-fetch)
+ (uri (git-reference
+ (url "https://github.com/intelxed/mbuild.git")
+ (commit "5304b94361fccd830c0e2417535a866b79c1c297")))
+ (sha256
+ (base32
+ "0r3avc3035aklqxcnc14rlmmwpj3jp09vbcbwynhvvmcp8srl7dl"))
+ (file-name (git-file-name name version)))))))
+ (outputs '("out" "lib" "src"))
+ (arguments
+ `(#:phases
+ ;; Upstream uses the custom Python build tool `mbuild', so we munge
+ ;; gnu-build-system to fit. The build process for this package is
+ ;; documented at https://intelxed.github.io/build-manual/.
+ (let* ((build-dir "build")
+ (kit-dir "kit"))
+ (modify-phases %standard-phases
+ (delete 'configure)
+ (replace 'build
+ (lambda* (#:key inputs #:allow-other-keys)
+ (let ((mbuild (assoc-ref inputs "mbuild")))
+ ;; The build system requires that `mbuild' be in a sibling
+ ;; directory to the project's source.
+ (symlink mbuild "../mbuild")
+ (invoke "./mfile.py"
+ (string-append "--build-dir=" build-dir)
+ (string-append "--install-dir=" kit-dir)
+ "examples"
+ "doc"
+ "install"))))
+ (replace 'check
+ (lambda _
+ (invoke "tests/run-cmd.py"
+ ;; Skip broken test group `tests/tests-avx512pf'.
+ (string-append "--build-dir=" kit-dir "/bin")
+ "--tests" "tests/tests-base"
+ "--tests" "tests/tests-avx512"
+ "--tests" "tests/tests-cet"
+ "--tests" "tests/tests-via"
+ "--tests" "tests/tests-syntax"
+ "--tests" "tests/tests-xop")))
+ (replace 'install
+ (lambda* (#:key outputs #:allow-other-keys)
+ (let* ((out (assoc-ref outputs "out"))
+ (lib (assoc-ref outputs "lib"))
+ (src (assoc-ref outputs "src"))
+ (pkg (strip-store-file-name out))
+ (src-dir (string-append src "/src/" pkg "/examples")))
+ (copy-recursively (string-append kit-dir "/bin")
+ (string-append out "/bin"))
+ (copy-recursively (string-append kit-dir "/examples") src-dir)
+ (copy-recursively (string-append kit-dir "/include") src-dir)
+ ;; Discard residual build system files.
+ (for-each delete-file (find-files src-dir "\\.py$"))
+ (copy-recursively (string-append kit-dir "/include")
+ (string-append lib "/include"))
+ (copy-recursively (string-append kit-dir "/lib")
+ (string-append lib "/lib")))))))))
+ (home-page "https://intelxed.github.io/")
+ (synopsis "Encoder and decoder for x86 (IA32 and Intel64) instructions")
+ (description "The X86 Encoder Decoder (XED) is a software library and
+for encoding and decoding X86 (IA32 and Intel64) instructions. The decoder
+takes sequences of 1-15 bytes along with machine mode information and produces
+a data structure describing the opcode, operands, and flags. The encoder takes
+a similar data structure and produces a sequence of 1 to 15 bytes. Disassembly
+is essentially a printing pass on the data structure.
+
+The library and development files are under the @code{lib} output, with a
+family of command line utility wrappers in the default output. Each of the cli
+tools is named like @code{xed*}. Documentation for the cli tools is sparse, so
+see the @code{src} output for the corresponding source code.")
+ (license license:asl2.0)))
--
2.26.2