mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
310b0433a9
This ireapplies commit 255c52de9f.
Original commit message:
Serialize debug scope and location info in the SIL assembler language.
At the moment it is only possible to test the effects that SIL
optimization passes have on debug information by observing the
effects of a full .swift -> LLVM IR compilation. This change enable us
to write targeted testcases for single SIL optimization passes.
The new syntax is as follows:
sil-scope-ref ::= 'scope' [0-9]+
sil-scope ::= 'sil_scope' [0-9]+ '{'
sil-loc
'parent' scope-parent
('inlined_at' sil-scope-ref )?
'}'
scope-parent ::= sil-function-name ':' sil-type
scope-parent ::= sil-scope-ref
sil-loc ::= 'loc' string-literal ':' [0-9]+ ':' [0-9]+
Each instruction may have a debug location and a SIL scope reference
at the end. Debug locations consist of a filename, a line number, and
a column number. If the debug location is omitted, it defaults to the
location in the SIL source file. SIL scopes describe the position
inside the lexical scope structure that the Swift expression a SIL
instruction was generated from had originally. SIL scopes also hold
inlining information.
<rdar://problem/22706994>
253 lines
9.9 KiB
EmacsLisp
253 lines
9.9 KiB
EmacsLisp
;;===--- sil-mode.el ------------------------------------------------------===;;
|
|
;;
|
|
;; This source file is part of the Swift.org open source project
|
|
;;
|
|
;; Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
|
|
;; Licensed under Apache License v2.0 with Runtime Library Exception
|
|
;;
|
|
;; See http://swift.org/LICENSE.txt for license information
|
|
;; See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
;;
|
|
;;===----------------------------------------------------------------------===;;
|
|
|
|
;; Create mode-specific tables.
|
|
(defvar sil-mode-syntax-table nil
|
|
"Syntax table used while in SIL mode.")
|
|
|
|
(defvar sil-font-lock-keywords
|
|
(list
|
|
;; Comments
|
|
'("^#!.*" . font-lock-comment-face)
|
|
;; Types
|
|
'("\\b[A-Z][a-zA-Z_0-9]*\\b" . font-lock-type-face)
|
|
;; Floating point constants
|
|
'("\\b[-+]?[0-9]+\.[0-9]+\\b" . font-lock-preprocessor-face)
|
|
;; Integer literals
|
|
'("\\b[-]?[0-9]+\\b" . font-lock-preprocessor-face)
|
|
;; Decl and type keywords
|
|
`(,(regexp-opt '("class" "init" "deinit" "extension" "func"
|
|
"import" "protocol" "static" "struct" "subscript"
|
|
"typealias" "enum" "var" "let" "where" "sil_vtable"
|
|
"sil_global" "private" "public" "internal" "override"
|
|
"sil_witness_table" "sil_scope")
|
|
'words) . font-lock-keyword-face)
|
|
;; SIL Types
|
|
'("\\b[$][*]?[A-Z][z-aA-Z_[0-9]*\\b" . font-lock-type-face)
|
|
|
|
;; SIL Stage
|
|
'("sil_stage" . font-lock-keyword-face)
|
|
|
|
;; SIL Function
|
|
`(,(regexp-opt '("sil" "internal" "thunk")
|
|
'words) . font-lock-keyword-face)
|
|
;; SIL Linkage
|
|
`(,(regexp-opt '("public" "hidden" "private" "shared" "public_external"
|
|
"hidden_external" "shared_external" "private_external")
|
|
'words) . font-lock-keyword-face)
|
|
|
|
;; SIL Declaration
|
|
`(,(regexp-opt '("getter" "setter" "allocator" "initializer" "enumelt"
|
|
"destroyer" "globalaccessor" "objc") 'words) .
|
|
font-lock-keyword-face)
|
|
|
|
;; SIL Instructions - Allocation/Deallocation.
|
|
`(,(regexp-opt '("alloc_stack" "alloc_ref" "alloc_ref_dynamic" "alloc_box"
|
|
"alloc_value_buffer" "alloc_global"
|
|
"dealloc_stack" "dealloc_box" "project_box" "dealloc_ref"
|
|
"dealloc_partial_ref" "dealloc_value_buffer"
|
|
"project_value_buffer")
|
|
'words) . font-lock-keyword-face)
|
|
|
|
;; SIL Instructions - Debug Information.
|
|
`(,(regexp-opt '("debug_value" "debug_value_addr")
|
|
'words) . font-lock-keyword-face)
|
|
|
|
;; SIL Instructions - Accessing Memory.
|
|
`(,(regexp-opt '("load" "store" "assign" "mark_uninitialized"
|
|
"mark_function_escape" "copy_addr" "destroy_addr"
|
|
"index_addr" "index_raw_pointer" "to")
|
|
'words) . font-lock-keyword-face)
|
|
|
|
;; SIL Instructions - Reference Counting.
|
|
`(,(regexp-opt '("strong_retain"
|
|
"strong_release" "strong_retain_unowned"
|
|
"unowned_retain" "unowned_release"
|
|
"load_weak" "store_weak"
|
|
"load_unowned" "store_unowned"
|
|
"fix_lifetime" "mark_dependence"
|
|
"is_unique" "is_unique_or_pinned"
|
|
"copy_block"
|
|
"strong_unpin" "strong_pin" "is_unique" "is_unique_or_pinned")
|
|
'words) . font-lock-keyword-face)
|
|
;; Literals
|
|
`(,(regexp-opt '("function_ref"
|
|
"integer_literal" "float_literal" "string_literal"
|
|
"global_addr"
|
|
) 'words) . font-lock-keyword-face)
|
|
;; Dynamic Dispatch
|
|
`(,(regexp-opt '("class_method" "super_method" "witness_method"
|
|
"dynamic_method")
|
|
'words) . font-lock-keyword-face)
|
|
;; Function Application
|
|
`(,(regexp-opt '("apply" "partial_apply" "builtin" "try_apply")
|
|
'words) . font-lock-keyword-face)
|
|
;; Metatypes
|
|
`(,(regexp-opt '("metatype" "value_metatype"
|
|
"existential_metatype" "init_existential_metatype")
|
|
'words) . font-lock-keyword-face)
|
|
;; Aggregate Types
|
|
`(,(regexp-opt '("retain_value" "release_value" "tuple" "tuple_extract"
|
|
"tuple_element_addr" "struct" "struct_extract"
|
|
"struct_element_addr" "ref_element_addr"
|
|
"autorelease_value")
|
|
'words) . font-lock-keyword-face)
|
|
;; Enums. *NOTE* We do not include enum itself here since enum is a
|
|
;; swift declaration as well handled at the top.
|
|
`(,(regexp-opt '("init_enum_data_addr" "unchecked_enum_data"
|
|
"unchecked_take_enum_data_addr" "inject_enum_addr"
|
|
"select_enum" "select_value" "select_enum_addr")
|
|
'words) . font-lock-keyword-face)
|
|
;; Protocol and Protocol Composition Types
|
|
`(,(regexp-opt '("init_existential_addr" "deinit_existential_addr"
|
|
"open_existential_addr"
|
|
"init_existential_ref"
|
|
"open_existential_ref")
|
|
'words) . font-lock-keyword-face)
|
|
;; Unchecked Conversions
|
|
`(,(regexp-opt '("upcast"
|
|
"address_to_pointer" "pointer_to_address"
|
|
"unchecked_addr_cast"
|
|
"unchecked_ref_cast"
|
|
"unchecked_trivial_bit_cast"
|
|
"unchecked_bitwise_cast"
|
|
"ref_to_raw_pointer" "raw_pointer_to_ref"
|
|
"unowned_to_ref" "ref_to_unowned"
|
|
"convert_function"
|
|
"ref_to_unmanaged" "unmanaged_to_ref"
|
|
"thin_function_to_pointer" "pointer_to_thin_function"
|
|
"ref_to_bridge_object"
|
|
"bridge_object_to_word" "bridge_object_to_ref"
|
|
"thin_to_thick_function"
|
|
"thick_to_objc_metatype" "objc_to_thick_metatype"
|
|
"objc_metatype_to_object"
|
|
"objc_existential_metatype_to_object"
|
|
"word_to_bridge_object"
|
|
"is_nonnull"
|
|
|
|
)
|
|
'words) . font-lock-keyword-face)
|
|
|
|
;; Checked Conversions
|
|
`(,(regexp-opt '("unconditional_checked_cast" "unconditional_checked_cast_addr")
|
|
'words) . font-lock-keyword-face)
|
|
;; Runtime Failures
|
|
`(,(regexp-opt '("cond_fail")
|
|
'words) . font-lock-keyword-face)
|
|
;; Terminators
|
|
`(,(regexp-opt '("unreachable" "return" "br"
|
|
"cond_br" "switch_value" "switch_enum"
|
|
"switch_enum_addr" "dynamic_method_br"
|
|
"checked_cast_br" "throw" "checked_cast_addr_br" "case")
|
|
'words) . font-lock-keyword-face)
|
|
;; Blocks
|
|
`(,(regexp-opt '("project_block_storage" "init_block_storage_header"
|
|
"copy_block")
|
|
'words) . font-lock-keyword-face)
|
|
;; Debug Info
|
|
`(,(regexp-opt '("loc" "scope" "parent" "inlined_at")
|
|
'words) . font-lock-keyword-face)
|
|
;; SIL Value
|
|
'("\\b[%][A-Za-z_0-9]+\\([#][0-9]+\\)?\\b" . font-lock-variable-name-face)
|
|
;; Variables
|
|
'("[a-zA-Z_][a-zA-Z_0-9]*" . font-lock-variable-name-face)
|
|
;; Unnamed variables
|
|
'("$[0-9]+" . font-lock-variable-name-face)
|
|
|
|
)
|
|
"Syntax highlighting for SIL"
|
|
)
|
|
|
|
;; ---------------------- Syntax table ---------------------------
|
|
|
|
(unless sil-mode-syntax-table
|
|
(progn
|
|
(setq sil-mode-syntax-table (make-syntax-table))
|
|
(mapc (function (lambda (n)
|
|
(modify-syntax-entry (aref n 0)
|
|
(aref n 1)
|
|
sil-mode-syntax-table)))
|
|
'(
|
|
;; whitespace (` ')
|
|
[?\f " "]
|
|
[?\t " "]
|
|
[?\ " "]
|
|
;; word constituents (`w')
|
|
;; comments
|
|
[?/ ". 124"]
|
|
[?* ". 23b"]
|
|
[?\n ">"]
|
|
[?\^m ">"]
|
|
;; symbol constituents (`_')
|
|
[?_ "w"]
|
|
;; punctuation (`.')
|
|
;; open paren (`(')
|
|
[?\( "())"]
|
|
[?\[ "(]"]
|
|
[?\{ "(}"]
|
|
;; close paren (`)')
|
|
[?\) ")("]
|
|
[?\] ")["]
|
|
[?\} "){"]
|
|
;; string quote ('"')
|
|
[?\" "\""]
|
|
;; escape-syntax characters ('\\')
|
|
[?\\ "\\"]
|
|
;; character quote ('"')
|
|
[?\' "\""]
|
|
))))
|
|
|
|
;; --------------------- Abbrev table -----------------------------
|
|
|
|
(defvar sil-mode-abbrev-table nil
|
|
"Abbrev table used while in SIL mode.")
|
|
(define-abbrev-table 'sil-mode-abbrev-table ())
|
|
|
|
(defvar sil-mode-hook nil)
|
|
(defvar sil-mode-map nil) ; Create a mode-specific keymap.
|
|
|
|
(unless sil-mode-map
|
|
(setq sil-mode-map (make-sparse-keymap))
|
|
(define-key sil-mode-map "\t" 'tab-to-tab-stop)
|
|
(define-key sil-mode-map "\es" 'center-line)
|
|
(define-key sil-mode-map "\eS" 'center-paragraph))
|
|
|
|
(defun sil-mode ()
|
|
"Major mode for editing SIL source files.
|
|
\\{sil-mode-map}
|
|
Runs sil-mode-hook on startup."
|
|
(interactive)
|
|
(kill-all-local-variables)
|
|
(use-local-map sil-mode-map) ; Provides the local keymap.
|
|
(setq major-mode 'sil-mode)
|
|
|
|
(make-local-variable 'font-lock-defaults)
|
|
(setq major-mode 'sil-mode ; This is how describe-mode
|
|
; finds the doc string to print.
|
|
mode-name "SIL" ; This name goes into the modeline.
|
|
font-lock-defaults `(sil-font-lock-keywords))
|
|
|
|
(setq local-abbrev-table sil-mode-abbrev-table)
|
|
(set-syntax-table sil-mode-syntax-table)
|
|
(setq comment-start "//")
|
|
(setq tab-stop-list (number-sequence 2 120 2))
|
|
(setq tab-width 2)
|
|
(run-hooks 'sil-mode-hook)) ; Finally, this permits the user to
|
|
; customize the mode with a hook.
|
|
|
|
;; Associate .sil files with sil-mode
|
|
(setq auto-mode-alist
|
|
(append '(("\\.sil$" . sil-mode)) auto-mode-alist))
|
|
|
|
(provide 'sil-mode)
|
|
;; end of sil-mode.el
|