binutils-gdb/gas
H.J. Lu e379e5f385 i386: Align branches within a fixed boundary
Add 3 command-line options to align branches within a fixed boundary
with segment prefixes or NOPs:

1. -malign-branch-boundary=NUM aligns branches within NUM byte boundary.
2. -malign-branch=TYPE[+TYPE...] specifies types of branches to align.
The supported branches are:
  a. Conditional jump.
  b. Fused conditional jump.
  c. Unconditional jump.
  d. Call.
  e. Ret.
  f. Indirect jump and call.
3. -malign-branch-prefix-size=NUM aligns branches with NUM segment
prefixes per instruction.

3 new rs_machine_dependent frag types are added:

1. BRANCH_PADDING.  The variable size frag to insert NOP before branch.
2. BRANCH_PREFIX.  The variable size frag to insert segment prefixes to
an instruction.  The choices of prefixes are:
   a. Use the existing segment prefix if there is one.
   b. Use CS segment prefix in 64-bit mode.
   c. In 32-bit mode, use SS segment prefix with ESP/EBP base register
   and use DS segment prefix without ESP/EBP base register.
3. FUSED_JCC_PADDING.  The variable size frag to insert NOP before fused
conditional jump.

The new rs_machine_dependent frags aren't inserted if the previous item
is a prefix or a constant directive, which may be used to hardcode an
instruction, since there is no clear instruction boundary.  Segment
prefixes and NOP padding are disabled before relaxable TLS relocations
and tls_get_addr calls to keep TLS instruction sequence unchanged.

md_estimate_size_before_relax() and i386_generic_table_relax_frag() are
used to handled BRANCH_PADDING, BRANCH_PREFIX and FUSED_JCC_PADDING frags.
i386_generic_table_relax_frag() grows or shrinks sizes of segment prefix
and NOP to align the next branch frag:

1. First try to add segment prefixes to instructions before a branch.
2. If there is no sufficient room to add segment prefixes, NOP will be
inserted before a branch.

	* config/tc-i386.c (_i386_insn): Add has_gotpc_tls_reloc.
	(tls_get_addr): New.
	(last_insn): New.
	(align_branch_power): New.
	(align_branch_kind): New.
	(align_branch_bit): New.
	(align_branch): New.
	(MAX_FUSED_JCC_PADDING_SIZE): New.
	(align_branch_prefix_size): New.
	(BRANCH_PADDING): New.
	(BRANCH_PREFIX): New.
	(FUSED_JCC_PADDING): New.
	(i386_generate_nops): Support BRANCH_PADDING and FUSED_JCC_PADDING.
	(md_begin): Abort if align_branch_prefix_size <
	MAX_FUSED_JCC_PADDING_SIZE.
	(md_assemble): Set last_insn.
	(maybe_fused_with_jcc_p): New.
	(add_fused_jcc_padding_frag_p): New.
	(add_branch_prefix_frag_p): New.
	(add_branch_padding_frag_p): New.
	(output_insn): Generate a BRANCH_PADDING, FUSED_JCC_PADDING or
	BRANCH_PREFIX frag and terminate each frag to align branches.
	(output_disp): Set i.has_gotpc_tls_reloc to TRUE for GOTPC and
	relaxable TLS relocations.
	(output_imm): Likewise.
	(i386_next_non_empty_frag): New.
	(i386_next_jcc_frag): New.
	(i386_classify_machine_dependent_frag): New.
	(i386_branch_padding_size): New.
	(i386_generic_table_relax_frag): New.
	(md_estimate_size_before_relax): Handle COND_JUMP_PADDING,
	FUSED_JCC_PADDING and COND_JUMP_PREFIX frags.
	(md_convert_frag): Handle BRANCH_PADDING, BRANCH_PREFIX and
	FUSED_JCC_PADDING frags.
	(OPTION_MALIGN_BRANCH_BOUNDARY): New.
	(OPTION_MALIGN_BRANCH_PREFIX_SIZE): New.
	(OPTION_MALIGN_BRANCH): New.
	(md_longopts): Add -malign-branch-boundary=,
	-malign-branch-prefix-size= and -malign-branch=.
	(md_parse_option): Handle -malign-branch-boundary=,
	-malign-branch-prefix-size= and -malign-branch=.
	(md_show_usage): Display -malign-branch-boundary=,
	-malign-branch-prefix-size= and -malign-branch=.
	(i386_target_format): Set tls_get_addr.
	(i386_cons_align): New.
	* config/tc-i386.h (i386_cons_align): New.
	(md_cons_align): New.
	(i386_generic_table_relax_frag): New.
	(md_generic_table_relax_frag): New.
	(i386_tc_frag_data): Add u, padding_address, length,
	max_prefix_length, prefix_length, default_prefix, cmp_size,
	classified and branch_type.
	(TC_FRAG_INIT): Initialize u, padding_address, length,
	max_prefix_length, prefix_length, default_prefix, cmp_size,
	classified and branch_type.
	* doc/c-i386.texi: Document -malign-branch-boundary=,
	-malign-branch= and -malign-branch-prefix-size=.
2019-12-12 12:03:45 -08:00
..
config i386: Align branches within a fixed boundary 2019-12-12 12:03:45 -08:00
doc i386: Align branches within a fixed boundary 2019-12-12 12:03:45 -08:00
po Updated Swedish translation for the gas sub-directory. 2019-08-23 10:46:46 +01:00
testsuite [gas][arm] Add -mwarn-restrict-it 2019-12-11 15:53:26 +00:00
.gitignore
acinclude.m4
aclocal.m4 Bump to autoconf 2.69 and automake 1.15.1 2018-06-19 16:55:06 -04:00
app.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
as.c gas/riscv: Produce version 3 DWARF CIE by default 2019-11-28 00:03:05 +00:00
as.h Introduce new section flag: SEC_ELF_OCTETS 2019-11-25 14:32:19 +10:30
asintl.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
atof-generic.c PR24944, gas doesn't read enough digits when parsing a floating point number 2019-11-20 21:59:33 +10:30
bignum.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
bit_fix.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
cgen.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
cgen.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
ChangeLog i386: Align branches within a fixed boundary 2019-12-12 12:03:45 -08:00
ChangeLog-0001
ChangeLog-0203
ChangeLog-2004
ChangeLog-2005
ChangeLog-2006
ChangeLog-2007
ChangeLog-2008
ChangeLog-2009
ChangeLog-2010
ChangeLog-2011
ChangeLog-2012
ChangeLog-2013
ChangeLog-2014
ChangeLog-2015
ChangeLog-2016
ChangeLog-2017
ChangeLog-2018 ChangeLog rotation 2019-01-01 21:25:40 +10:30
ChangeLog-9295
ChangeLog-9697
ChangeLog-9899
compress-debug.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
compress-debug.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
cond.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
config.in Fix a potential deadlock in some older Loongson 3A1000 MIPS processors. 2019-02-19 17:57:16 +00:00
configure Re-generate many configure and Makefile.in files 2019-09-18 09:09:15 -04:00
configure.ac gas: add support for eBPF 2019-05-23 19:34:04 +02:00
configure.com Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
configure.tgt gas: add support for eBPF 2019-05-23 19:34:04 +02:00
CONTRIBUTORS Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
COPYING
debug.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
dep-in.sed
depend.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
dw2gencfi.c [gas] Implement .cfi_negate_ra_state directive 2019-12-06 10:46:32 +00:00
dw2gencfi.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
dwarf2dbg.c gas/riscv: Produce version 3 DWARF CIE by default 2019-11-28 00:03:05 +00:00
dwarf2dbg.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
ecoff.c bfd_section_* macros 2019-09-19 09:40:13 +09:30
ecoff.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
ehopt.c Optimise away eh_frame advance_loc 0 2019-10-26 20:19:28 +10:30
emul-target.h Remove strip_underscore from struct emulation 2019-03-21 08:50:24 +10:30
emul.h Remove strip_underscore from struct emulation 2019-03-21 08:50:24 +10:30
expr.c GAS: Replace macro LITERAL_PREFIXDOLLAR_HEX with a runtime value. 2019-05-21 10:29:15 +02:00
expr.h GAS: Replace macro LITERAL_PREFIXDOLLAR_HEX with a runtime value. 2019-05-21 10:29:15 +02:00
flonum-copy.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
flonum-konst.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
flonum-mult.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
flonum.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
frags.c Introduce new section flag: SEC_ELF_OCTETS 2019-11-25 14:32:19 +10:30
frags.h Speed up locview resolution with relaxable frags 2019-04-25 08:35:13 +09:30
gdbinit.in
hash.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
hash.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
input-file.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
input-file.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
input-scrub.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
itbl-lex-wrapper.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
itbl-lex.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
itbl-lex.l Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
itbl-ops.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
itbl-ops.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
itbl-parse.y Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
listing.c Make frag fr_fix unsigned 2019-04-16 17:12:09 +09:30
listing.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
literal.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
macro.c A series of fixes to addres problems detected by compiling the assembler with address sanitization enabled. 2019-05-14 10:42:25 +01:00
macro.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
MAINTAINERS Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
Makefile.am gas: add support for eBPF 2019-05-23 19:34:04 +02:00
Makefile.in Re-generate many configure and Makefile.in files 2019-09-18 09:09:15 -04:00
makefile.vms Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
messages.c PowerPC D-form prefixed loads and stores 2019-05-24 10:27:49 +09:30
NEWS gas: Add --gdwarf-cie-version command line flag 2019-11-18 10:30:21 +00:00
obj.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
output-file.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
output-file.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
read.c bfd_section_* macros 2019-09-19 09:40:13 +09:30
read.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
README Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
remap.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
sb.c Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
sb.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
stabs.c bfd_section_* macros 2019-09-19 09:40:13 +09:30
stamp-h.in
subsegs.c bfd_section_* macros 2019-09-19 09:40:13 +09:30
subsegs.h bfd_section_* macros 2019-09-19 09:40:13 +09:30
symbols.c Reverts patches providing octet support in dwarf 2019-11-25 14:32:20 +10:30
symbols.h Reverts patches providing octet support in dwarf 2019-11-25 14:32:20 +10:30
tc.h Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
write.c gas: Add md_generic_table_relax_frag 2019-12-12 12:03:45 -08:00
write.h Move fixup fx_bit_fixP and fx_im_disp fields to TC_FIX_TYPE 2019-04-16 17:39:28 +09:30

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

		README for GAS

A number of things have changed since version 1 and the wonderful
world of gas looks very different.  There's still a lot of irrelevant
garbage lying around that will be cleaned up in time.  Documentation
is scarce, as are logs of the changes made since the last gas release.
My apologies, and I'll try to get something useful.

Unpacking and Installation - Summary
====================================

See ../binutils/README.

To build just the assembler, make the target all-gas.

Documentation
=============

The GAS release includes texinfo source for its manual, which can be processed
into `info' or `dvi' forms.

The DVI form is suitable for printing or displaying; the commands for doing
this vary from system to system.  On many systems, `lpr -d' will print a DVI
file.  On others, you may need to run a program such as `dvips' to convert the
DVI file into a form your system can print.

If you wish to build the DVI file, you will need to have TeX installed on your
system.  You can rebuild it by typing:

	cd gas/doc
	make as.dvi

The Info form is viewable with the GNU Emacs `info' subsystem, or the
stand-alone `info' program, available as part of the GNU Texinfo distribution.
To build the info files, you will need the `makeinfo' program.  Type:

	cd gas/doc
	make info

Specifying names for hosts and targets
======================================

   The specifications used for hosts and targets in the `configure'
script are based on a three-part naming scheme, but some short
predefined aliases are also supported.  The full naming scheme encodes
three pieces of information in the following pattern:

     ARCHITECTURE-VENDOR-OS

   For example, you can use the alias `sun4' as a HOST argument or in a
`--target=TARGET' option.  The equivalent full name is
`sparc-sun-sunos4'.

   The `configure' script accompanying GAS does not provide any query
facility to list all supported host and target names or aliases.
`configure' calls the Bourne shell script `config.sub' to map
abbreviations to full names; you can read the script, if you wish, or
you can use it to test your guesses on abbreviations--for example:

     % sh config.sub i386v
     i386-unknown-sysv
     % sh config.sub i786v
     Invalid configuration `i786v': machine `i786v' not recognized


`configure' options
===================

   Here is a summary of the `configure' options and arguments that are
most often useful for building GAS.  `configure' also has several other
options not listed here.

     configure [--help]
               [--prefix=DIR]
               [--srcdir=PATH]
               [--host=HOST]
               [--target=TARGET]
               [--with-OPTION]
               [--enable-OPTION]

You may introduce options with a single `-' rather than `--' if you
prefer; but you may abbreviate option names if you use `--'.

`--help'
     Print a summary of the options to `configure', and exit.

`-prefix=DIR'
     Configure the source to install programs and files under directory
     `DIR'.

`--srcdir=PATH'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

`--host=HOST'
     Configure GAS to run on the specified HOST.  Normally the
     configure script can figure this out automatically.

     There is no convenient way to generate a list of all available
     hosts.

`--target=TARGET'
     Configure GAS for cross-assembling programs for the specified
     TARGET.  Without this option, GAS is configured to assemble .o files
     that run on the same machine (HOST) as GAS itself.

     There is no convenient way to generate a list of all available
     targets.

`--enable-OPTION'
     These flags tell the program or library being configured to
     configure itself differently from the default for the specified
     host/target combination.  See below for a list of `--enable'
     options recognized in the gas distribution.

`configure' accepts other options, for compatibility with configuring
other GNU tools recursively; but these are the only options that affect
GAS or its supporting libraries.

The `--enable' options recognized by software in the gas distribution are:

`--enable-targets=...'
     This causes one or more specified configurations to be added to those for
     which BFD support is compiled.  Currently gas cannot use any format other
     than its compiled-in default, so this option is not very useful.

`--enable-bfd-assembler'
     This causes the assembler to use the new code being merged into it to use
     BFD data structures internally, and use BFD for writing object files.
     For most targets, this isn't supported yet.  For most targets where it has
     been done, it's already the default.  So generally you won't need to use
     this option.

Compiler Support Hacks
======================

On a few targets, the assembler has been modified to support a feature
that is potentially useful when assembling compiler output, but which
may confuse assembly language programmers.  If assembler encounters a
.word pseudo-op of the form symbol1-symbol2 (the difference of two
symbols), and the difference of those two symbols will not fit in 16
bits, the assembler will create a branch around a long jump to
symbol1, and insert this into the output directly before the next
label: The .word will (instead of containing garbage, or giving an
error message) contain (the address of the long jump)-symbol2.  This
allows the assembler to assemble jump tables that jump to locations
very far away into code that works properly.  If the next label is
more than 32K away from the .word, you lose (silently); RMS claims
this will never happen.  If the -K option is given, you will get a
warning message when this happens.


REPORTING BUGS IN GAS
=====================

Bugs in gas should be reported to:

   bug-binutils@gnu.org.

They may be cross-posted to gcc-bugs@gnu.org if they affect the use of
gas with gcc.  They should not be reported just to gcc-bugs, since not
all of the maintainers read that list.

See ../binutils/README for what we need in a bug report.

Copyright (C) 2012-2019 Free Software Foundation, Inc.

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.