OBJCOPY(1)
OBJCOPY(1) β GNU Development Tools β¨
okay bestie, welcome to the objcopy manual, but make it cute π
. We are keeping every flag, every warning, every little detail. No cap.
πΈ NAME πΈ
objcopy β copy and translate object files π¦
π SYNOPSIS π
objcopy [-F bfdname|--target=bfdname]
[-I bfdname|--input-target=bfdname]
[-O bfdname|--output-target=bfdname]
[-B bfdarch|--binary-architecture=bfdarch]
[-S|--strip-all]
[-g|--strip-debug]
[--strip-unneeded]
[-K symbolname|--keep-symbol=symbolname]
[--keep-file-symbols]
[--keep-section-symbols]
[-N symbolname|--strip-symbol=symbolname]
[--strip-unneeded-symbol=symbolname]
[-G symbolname|--keep-global-symbol=symbolname]
[--localize-hidden]
[-L symbolname|--localize-symbol=symbolname]
[--globalize-symbol=symbolname]
[--globalize-symbols=filename]
[-W symbolname|--weaken-symbol=symbolname]
[-w|--wildcard]
[-x|--discard-all]
[-X|--discard-locals]
[-b byte|--byte=byte]
[-i [breadth]|--interleave[=breadth]]
[--interleave-width=width]
[-j sectionpattern|--only-section=sectionpattern]
[-R sectionpattern|--remove-section=sectionpattern]
[--keep-section=sectionpattern]
[--remove-relocations=sectionpattern]
[--strip-section-headers]
[-p|--preserve-dates]
[-D|--enable-deterministic-archives]
[-U|--disable-deterministic-archives]
[--debugging]
[--gap-fill=val]
[--pad-to=address]
[--set-start=val]
[--adjust-start=incr]
[--change-addresses=incr]
[--change-section-address sectionpattern{=,+,-}val]
[--change-section-lma sectionpattern{=,+,-}val]
[--change-section-vma sectionpattern{=,+,-}val]
[--change-warnings] [--no-change-warnings]
[--set-section-flags sectionpattern=flags]
[--set-section-alignment sectionpattern=align]
[--add-section sectionname=filename]
[--dump-section sectionname=filename]
[--update-section sectionname=filename]
[--rename-section oldname=newname[,flags]]
[--long-section-names {enable,disable,keep}]
[--change-leading-char] [--remove-leading-char]
[--reverse-bytes=num]
[--srec-len=ival] [--srec-forceS3]
[--redefine-sym old=new]
[--redefine-syms=filename]
[--weaken]
[--keep-symbols=filename]
[--strip-symbols=filename]
[--strip-unneeded-symbols=filename]
[--keep-global-symbols=filename]
[--localize-symbols=filename]
[--weaken-symbols=filename]
[--binary-symbol-prefixstring]
[--add-symbol name=[section:]value[,flags]]
[--alt-machine-code=index]
[--prefix-symbols=string]
[--prefix-sections=string]
[--prefix-alloc-sections=string]
[--add-gnu-debuglink=path-to-file]
[--only-keep-debug]
[--strip-dwo]
[--extract-dwo]
[--extract-symbol]
[--writable-text]
[--readonly-text]
[--pure]
[--impure]
[--file-alignment=num]
[--heap=reserve[,commit]]
[--image-base=address]
[--section-alignment=num]
[--stack=reserve[,commit]]
[--subsystem=which:major.minor]
[--compress-debug-sections]
[--decompress-debug-sections]
[--elf-stt-common=val]
[--merge-notes]
[--no-merge-notes]
[--verilog-data-width=val]
[-v|--verbose]
[-V|--version]
[--help] [--info]
infile [outfile]
π¦ DESCRIPTION π¦
okay so the GNU objcopy utility is literally the copy-paste queen of object files π. It copies the contents of an object file to another. objcopy uses the GNU BFD Library to read and write the object files. It can write the destination object file in a format different from that of the source object file. The exact behavior of objcopy is controlled by command-line options. Note that objcopy should be able to copy a fully linked file between any two formats. However, copying a relocatable object file between any two formats may not work as expected π.
objcopy creates temporary files to do its translations and deletes them afterward. objcopy uses BFD to do all its translation work; it has access to all the formats described in BFD and thus is able to recognize most formats without being told explicitly. Iconic.
objcopy can be used to generate S-records by using an output target of srec (e.g., use -O srec). β¨
objcopy can be used to generate a raw binary file by using an output target of binary (e.g., use -O binary). When objcopy generates a raw binary file, it will essentially produce a memory dump of the contents of the input object file. All symbols and relocation information will be discarded. The memory dump will start at the load address of the lowest section copied into the output file. πΎ
When generating an S-record or a raw binary file, it may be helpful to use -S to remove sections containing debugging information. In some cases -R will be useful to remove sections which contain information that is not needed by the binary file. π§
Note---objcopyis not able to change the endianness of its input files. If the input format has an endianness (some formats do not),objcopycan only copy the inputs into file formats that have the same endianness or which have no endianness (e.g.,srec). (However, see the--reverse-bytesoption.) β οΈ
π OPTIONS π
infileβ the input file.outfileβ the output file. The input and output files are respectivelyinfileandoutfile. If you do not specifyoutfile,objcopycreates a temporary file and destructively renames the result with the name ofinfile. π«Ά-I bfdname,--input-target=bfdnameβ consider the source file's object format to bebfdname, rather than attempting to deduce it. π-O bfdname,--output-target=bfdnameβ write the output file using the object formatbfdname. πΎ-F bfdname,--target=bfdnameβ usebfdnameas the object format for both the input and the output file; i.e., simply transfer data from source to destination with no translation. β¨-B bfdarch,--binary-architecture=bfdarchβ useful when transforming a architecture-less input file into an object file. In this case the output architecture can be set tobfdarch. This option will be ignored if the input file has a knownbfdarch. You can access this binary data inside a program by referencing the special symbols that are created by the conversion process. These symbols are called_binary_objfile_start,_binary_objfile_endand_binary_objfile_size. e.g. you can transform a picture file into an object file and then access it in your code using these symbols. πΌοΈ-j sectionpattern,--only-section=sectionpatternβ copy only the indicated sections from the input file to the output file. This option may be given more than once. Note that using this option inappropriately may make the output file unusable. Wildcard characters are accepted insectionpattern.
If the first character of sectionpattern is the exclamation point (!) then matching sections will not be copied, even if earlier use of --only-section on the same command line would otherwise copy it. For example:
--only-section=.text.* --only-section=!.text.foo
will copy all sectinos matching .text.* but not the section .text.foo.
-R sectionpattern,--remove-section=sectionpatternβ remove any section matchingsectionpatternfrom the output file. This option may be given more than once. Note that using this option inappropriately may make the output file unusable. Wildcard characters are accepted insectionpattern. Using both the-jand-Roptions together results in undefined behaviour. π¨
If the first character of sectionpattern is the exclamation point (!) then matching sections will not be removed even if an earlier use of --remove-section on the same command line would otherwise remove it. For example:
--remove-section=.text.* --remove-section=!.text.foo
will remove all sections matching the pattern .text.*, but will not remove the section .text.foo.
--keep-section=sectionpatternβ when removing sections from the output file, keep sections that matchsectionpattern. π--remove-relocations=sectionpatternβ remove non-dynamic relocations from the output file for any section matchingsectionpattern. This option may be given more than once. Note that using this option inappropriately may make the output file unusable, and attempting to remove a dynamic relocation section such as.rela.pltfrom an executable or shared library with--remove-relocations=.pltwill not work. Wildcard characters are accepted insectionpattern. For example:
--remove-relocations=.text.*
will remove the relocations for all sections matching the pattern .text.*.
If the first character of sectionpattern is the exclamation point (!) then matching sections will not have their relocation removed even if an earlier use of --remove-relocations on the same command line would otherwise cause the relocations to be removed. For example:
--remove-relocations=.text.* --remove-relocations=!.text.foo
will remove all relocations for sections matching the pattern .text.*, but will not remove relocations for the section .text.foo.
--strip-section-headersβ strip section header. This option is specific to ELF files. Implies--strip-alland--merge-notes. π-S,--strip-allβ do not copy relocation and symbol information from the source file. Also deletes debug sections. π₯-g,--strip-debugβ do not copy debugging symbols or sections from the source file. π--strip-unneededβ remove all symbols that are not needed for relocation processing in addition to debugging symbols and sections stripped by--strip-debug. π§Ή-K symbolname,--keep-symbol=symbolnameβ when stripping symbols, keep symbolsymbolnameeven if it would normally be stripped. This option may be given more than once. π₯Ί-N symbolname,--strip-symbol=symbolnameβ do not copy symbolsymbolnamefrom the source file. This option may be given more than once. βοΈ--strip-unneeded-symbol=symbolnameβ do not copy symbolsymbolnamefrom the source file unless it is needed by a relocation. This option may be given more than once. π«Ά-G symbolname,--keep-global-symbol=symbolnameβ Okay so keep only the symbol symbolname global, bestie. Everything else gets made local to the file so it's not visible externally. You can drop this option more than once if you're feeling extra. > π« But ngl, this one literally cannot be used with the--globalize-symbolor--globalize-symbolsoptions. Periodt.--localize-hiddenβ In an ELF object, this marks all symbols that have hidden or internal visibility as local. It stacks on top of symbol-specific localization options like-L. It's giving layered.-L symbolname,--localize-symbol=symbolnameβ Convert a global or weak symbol called symbolname into a local symbol so it's not visible externally. You can use this more than once. Note β unique symbols are not converted. π-W symbolname,--weaken-symbol=symbolnameβ Make symbol symbolname weak. This option may be given more than once. Slay.--binary-symbol-prefix=stringβ When you use it with--input-target=binary, this sets string as the base name for the symbols generated for the input file. Those symbols are:
<string>_start
<string>_end
<string>_size
By default, the binary input handler derives the prefix symbol name from a mangled version of the input file name and _binary prefix. This option lets you specify it explicitly. Iconic.
--globalize-symbol=symbolnameβ Give symbol symbolname global scoping so it's visible outside the file where it's defined. You can give this more than once. > π« Note: this option cannot be used in conjunction with the-Gor--keep-global-symboloptions. No cap.-w,--wildcardβ Permit regular expressions in symbolnames used in other command line options. The question mark (?), asterisk (*), backslash (\) and square brackets ([]) operators can be used anywhere in the symbol name. If the first character of the symbol name is the exclamation point (!) then the sense of the switch is reversed for that symbol. For example:
-w -W !foo -W fo*
would cause objcopy to weaken all symbols that start with "fo" except for the symbol "foo". Obsessed with this.
-x,--discard-allβ Do not copy non-global symbols from the source file. Bye π.-X,--discard-localsβ Do not copy compiler-generated local symbols. (These usually start withLor..) Clean.-b byte,--byte=byteβ If interleaving has been enabled via the--interleaveoption then start the range of bytes to keep at the byteth byte. byte can be in the range from0tobreadth-1, where breadth is the value given by the--interleaveoption. Math but make it cute.-i [breadth],--interleave[=breadth]β Only copy a range out of every breadth bytes. (Header data is not affected). Select which byte in the range begins the copy with the--byteoption. Select the width of the range with the--interleave-widthoption.
This option is useful for creating files to program ROM. It is typically used with an "srec" output target. Note that objcopy will complain if you do not specify the --byte option as well.
The default interleave breadth is 4, so with --byte set to 0, objcopy would copy the first byte out of every four bytes from the input to the output. Bestie that's literally the default.
--interleave-width=widthβ When used with the--interleaveoption, copy width bytes at a time. The start of the range of bytes to be copied is set by the--byteoption, and the extent of the range is set with the--interleaveoption.
The default value for this option is 1. The value of width plus the byte value set by the --byte option must not exceed the interleave breadth set by the --interleave option.
This option can be used to create images for two 16-bit flashes interleaved in a 32-bit bus by passing -b 0 -i 4 --interleave-width=2 and -b 2 -i 4 --interleave-width=2 to two objcopy commands. If the input was '12345678' then the outputs would be '1256' and '3478' respectively. Cute.
-p,--preserve-datesβ Set the access and modification dates of the output file to be the same as those of the input file.
This option also copies the date stored in a PE format file's header, unless the SOURCE_DATE_EPOCH environment variable is defined. If it is defined then this variable will be used as the date stored in the header, interpreted as the number of seconds since the Unix epoch. Time travel vibes.
-D,--enable-deterministic-archivesβ Operate in deterministic mode. When copying archive members and writing the archive index, use zero for UIDs, GIDs, timestamps, and use consistent file modes for all files.
If binutils was configured with --enable-deterministic-archives, then this mode is on by default. It can be disabled with the -U option, below. Consistent queen.
-U,--disable-deterministic-archivesβ Do not operate in deterministic mode. This is the inverse of the-Doption, above: when copying archive members and writing the archive index, use their actual UID, GID, timestamp, and file mode values.
This is the default unless binutils was configured with --enable-deterministic-archives. Fr fr.
--debuggingβ Convert debugging information, if possible. This is not the default because only certain debugging formats are supported, and the conversion process can be time consuming. It's giving patience.--gap-fill valβ Fill gaps between sections with val. This operation applies to the load address (LMA) of the sections. It is done by increasing the size of the section with the lower address, and filling in the extra space created with val. Gap filler.--pad-to addressβ Pad the output file up to the load address address. This is done by increasing the size of the last section. The extra space is filled in with the value specified by--gap-fill(default zero). Pad it out.--set-start valβ Set the start address (also known as the entry address) of the new file to val. Not all object file formats support setting the start address. Sad for them.--change-start incr,--adjust-start incrβ Change the start address (also known as the entry address) by adding incr. Not all object file formats support setting the start address. Same energy.--change-addresses incr,--adjust-vma incrβ Change the VMA and LMA addresses of all sections, as well as the start address, by adding incr. Some object file formats do not permit section addresses to be changed arbitrarily. Note that this does not relocate the sections; if the program expects sections to be loaded at a certain address, and this option is used to change the sections such that they are loaded at a different address, the program may fail. β οΈ Dangerous if you're not careful, bestie.--change-section-address sectionpattern{=,+,-}val,--adjust-section-vma sectionpattern{=,+,-}valβ Set or change both the VMA address and the LMA address of any section matching sectionpattern. If=is used, the section address is set to val. Otherwise, val is added to or subtracted from the section address. See the comments under--change-addresses, above. If sectionpattern does not match any sections in the input file, a warning will be issued, unless--no-change-warningsis used. Pattern matching but make it address-y.--change-section-lma sectionpattern{=,+,-}valβ Set or change the LMA address of any sections matching sectionpattern. The LMA address is the address where the section will be loaded into memory at program load time. Normally this is the same as the VMA address, which is the address of the section at program run time, but on some systems, especially those where a program is held in ROM, the two can be different. If=is used, the section address is set to val. Otherwise, val is added to or subtracted from the section address. See the comments under--change-addresses, above. If sectionpattern does not match any sections in the input file, a warning will be issued, unless--no-change-warningsis used. ROM girlies know.--change-section-vma sectionpattern{=,+,-}valβ Set or change the VMA address of any section matching sectionpattern. The VMA address is the address where the section will be located once the program has started executing. Normally this is the same as the LMA address, which is the address where the section will be loaded into memory, but on some systems, especially those where a program is held in ROM, the two can be different. If=is used, the section address is set to val. Otherwise, val is added to or subtracted from the section address. See the comments under--change-addresses, above. If sectionpattern does not match any sections in the input file, a warning will be issued, unless--no-change-warningsis used.
Note β changing the VMA of sections in a fully linked binary can be dangerous since there may be code that expects the sections to be located at their old address. β οΈ Red flag.
--change-warnings,--adjust-warningsβ If--change-section-addressor--change-section-lmaor--change-section-vmais used, and the section pattern does not match any sections, issue a warning. This is the default. Warning queen.--no-change-warnings,--no-adjust-warningsβ Do not issue a warning if--change-section-addressor--adjust-section-lmaor--adjust-section-vmais used, even if the section pattern does not match any sections. Silent but deadly.--set-section-flags sectionpattern=flagsβ Set the flags for any sections matching sectionpattern. The flags argument is a comma separated string of flag names. The recognized names arealloc,contents,load,noload,readonly,code,data,rom,exclude,share,debug, andlarge. You can set thecontentsflag for a section which does not have contents, but it is not meaningful to clear thecontentsflag of a section which does have contents--just remove the section instead. Not all flags are meaningful for all object file formats. In particular theshareflag is only meaningful for COFF format files and not for ELF format files. The ELF x86-64 specific flaglargecorresponds toSHF_X86_64_LARGE. Flags for days.--set-section-alignment sectionpattern=alignβ Set the alignment for any sections matching sectionpattern. align specifies the alignment in bytes and must be a power of two, i.e.1,2,4,8.... Power of two only, bestie.
Quick heads-up bestie π β setting a section's alignment does NOT auto-magically line up its LMA or VMA addresses. Those are a whole separate thing. If you need those moved too, you gotta reach for--change-section-lmaand/or--change-section-vma. And also?? changing VMAs can cause problems in fully linked binaries, because there might be code in there that expects the contents of the sections to live at their old address. So likeβ¦ be careful, okay? π
--add-sectionsectionname=filename β adds a brand new section called sectionname while it's copying the file π. The contents of the new section come straight from the file filename, and the size of the section = the size of the file. This only works on file formats that can actually support sections with arbitrary names, so no cap, check your format first. Also note β you may need to use--set-section-flagsto set the attributes of the freshly created section, otherwise it's just kindaβ¦ sitting there with no vibes.--dump-sectionsectionname=filename β takes the contents of the section named sectionname and drops them into the file filename, overwriting whatever was in there before (sorry to that file π). This is literally the inverse of--add-section. It's similar to--only-sectionexcept it does not create a formatted file β it just dumps the contents as raw binary data, no relocations applied, none of that. You can specify this option more than once, slay. π--update-sectionsectionname=filename β swaps out the existing contents of a section named sectionname with the contents of file filename. The section size gets adjusted to match the size of the file. The section flags for sectionname stay unchanged. For ELF format files, the section-to-segment mapping also stays unchanged β which is a thing you literally cannot do with--remove-sectionfollowed by--add-section, so this is the moment. β¨ You can specify this option more than once.
PSA: you can use--rename-sectionand--update-sectiontogether to both update and rename a section from one single command line. When you do that: pass the original section name to--update-section, and pass the original and new section names to--rename-section. Iykyk. π«Ά
--add-symbolname=[section:]value[,flags] β adds a new symbol named name while copying the file. This option may be specified multiple times. If the section is given, the symbol gets associated with and is relative to that section β otherwise it's anABSsymbol. Specifying an undefined section = fatal error, do not do it bestie. There is no check for the value, it will be taken exactly as specified. Symbol flags can be specified, and not all flags will be meaningful for all object file formats (so don't come crying to me if a flag does nothing for your format π). By default, the symbol will be global. And the special flagbefore=othersymwill insert the new symbol in front of the specified othersym β otherwise the symbol(s) get added at the end of the symbol table, in the order they appear.--rename-sectionoldname=newname[,flags] β renames a section from oldname to newname, optionally changing the section's flags to flags in the process. The glow-up here over using a linker script to do the rename is that the output stays as an object file and does not become a linked executable. π This option accepts the same set of flags as the--set-section-flagsoption.
This one is especially iconic when your input format is binary, because that will always create a section called .data. So say you wanted to create a section called .rodata containing binary data instead β you could use the following command line to achieve it:
objcopy -I binary -O <output_format> -B <architecture> \
--rename-section .data=.rodata,alloc,load,readonly,data,contents \
<input_binary_file> <output_object_file>
--long-section-names {enable,disable,keep}β controls how long section names are handled when processing"COFF"and"PE-COFF"object formats. The default behaviour,keep, preserves long section names if any are present in the input file.enableanddisableforcibly enable or disable the use of long section names in the output object. Whendisableis in effect, any long section names in the input object get truncated (rip to the rest of the name βοΈ). Theenableoption will only emit long section names if any are present in the inputs β mostly the same askeep, but it is left undefined whetherenablemight force the creation of an empty string table in the output file. Spooky. πΈ--change-leading-charβ some object file formats use special characters at the start of symbols. The most common such character is underscore, which compilers often add before every symbol. This option tellsobjcopyto change the leading character of every symbol when it converts between object file formats. If the object file formats use the same leading character, this option has no effect (it's giving nothing, honestly). Otherwise it will add a character, or remove a character, or change a character, as appropriate. π¦--remove-leading-charβ if the first character of a global symbol is a special symbol leading character used by the object file format, remove the character. The most common symbol leading character is underscore, so this option will remove a leading underscore from all global symbols. Super useful if you wanna link together objects of different file formats with different conventions for symbol names. This is different from--change-leading-charbecause it always changes the symbol name when appropriate, regardless of the object file format of the output file. Periodt. π--reverse-bytes=num β reverses the bytes in a section with output contents. A section length must be evenly divisible by the value given in order for the swap to be able to take place. Reversing takes place **before the interleaving is performed. π₯
This option is used typically in generating ROM images for problematic target systems. Like, on some target boards, the 32-bit words fetched from 8-bit ROMs get re-assembled in little-endian byte order regardless of the CPU byte order. Depending on the programming model, the endianness of the ROM may need to be modified.
Consider a simple file with a section containing the following eight bytes: 12345678.
Using --reverse-bytes=2 for the above example, the bytes in the output file would be ordered 21436587.
Using --reverse-bytes=4 for the above example, the bytes in the output file would be ordered 43218765.
By using --reverse-bytes=2 for the above example, followed by --reverse-bytes=4 on the output file, the bytes in the second output file would be ordered 34127856. Math is mathing. β¨
- *
--srec-len=ival* β meaningful only for srec output. Sets the maximum length of the Srecords being produced to ival. This length covers both address, data and crc fields. All of them. π --srec-forceS3β meaningful only for srec output. Avoids generation of S1/S2 records, creating S3-only record format. S3 or nothing bestie. π--redefine-symold=new β changes the name of a symbol old to new. This can be useful when you're trying to link two things together for which you have no source, and there are name collisions. Classic situation, honestly. π- *
--redefine-syms=filename* β applies--redefine-symto each symbol pair"old new"listed in the file filename. filename is simply a flat file, with one symbol pair per line. Line comments may be introduced by the hash character. This option may be given more than once. π«Ά --weakenβ changes all global symbols in the file to be weak. This can be useful when building an object which will be linked against other objects using the-Roption to the linker. This option is only effective when using an object file format which supports weak symbols. No support, no effect, no notes. π¦- *
--keep-symbols=filename* β applies--keep-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once. - *
--strip-symbols=filename* β applies--strip-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once. - *
--strip-unneeded-symbols=filename* β applies--strip-unneeded-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once. - *
--keep-global-symbols=filename* β applies--keep-global-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once. - *
--localize-symbols=filename* β applies--localize-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once. - *
--globalize-symbols=filename* β applies--globalize-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once.
Important: this option cannot be used in conjunction with the-Gor--keep-global-symboloptions. Pick a lane bestie. π
- *
--weaken-symbols=filename* β applies--weaken-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once. --alt-machine-code=index β if the output architecture has alternate machine codes, use the index-th code instead of the default one. This is useful in case a machine gets assigned an official code and the tool-chain adopts the new code, but other applications still depend on the original code being used. (Old apps stay winning, lowkey.) For ELF based architectures, if the index alternative does not exist, then the value is treated as an **absolute number to be stored in thee_machinefield of the ELF header. β--writable-textβ marks the output text as writable. This option isn't meaningful for all object file formats, so vibe check your format first. βοΈ--readonly-textβ makes the output text write protected. This option isn't meaningful for all object file formats either. π--pureβ marks the output file as demand paged π«§ heads up bestie, this one literally does nothing on some object file formats, it's not meaningful for all of them.--impureβ marks the output file as impure π same deal: not meaningful for every object file format out there.--prefix-symbols=string β slaps string onto the front of every single symbol in the output file β¨--prefix-sections=string β same energy but for section names: every section in the output file gets string glued to the front π--prefix-alloc-sections=string β and this one is the picky cousin: it only prefixes the names of the allocated sections with string π--add-gnu-debuglink=path-to-file β makes a.gnu_debuglinksection that points at path-to-file, then drops it into the output file π
real talk: the file at path-to-file must exist. no file, no vibes. part of building that .gnu_debuglink section means embedding a checksum of the debug info file's contents right into the section.
ok so here's the trap πͺ€ if the debug info file gets built in one place but installed somewhere else later, do not use the path to the installed location. --add-gnu-debuglink will fail because that installed file doesn't exist yet. instead, put the debug info file in the current directory and call the option with no directory components at all, like this:
objcopy --add-gnu-debuglink=foo.debug
at debug time the debugger goes hunting for the separate debug info file in a known set of locations. the exact set depends on your distribution, but it typically includes:
- the same directory as the executable.
- a sub-directory of the directory containing the executable called
.debug - a global debug directory such as
/usr/lib/debug.
as long as the debug info file is installed into one of those spots before the debugger runs, everything should work correctly π
--keep-section-symbolsβ when you're stripping a file, maybe with--strip-debugor--strip-unneeded, this keeps any symbols that specify section names β the ones that would otherwise get yeeted.--keep-file-symbolsβ same situation (stripping, maybe with--strip-debugor--strip-unneeded) but this one retains the symbols specifying source file names, which would otherwise get stripped too π₯Ί--only-keep-debugβ strips a file by removing the contents of any sections that--strip-debugwouldn't strip, and leaves the debugging sections intact. in ELF files this preserves all note sections in the output π
note β the section headers of the stripped sections are preserved, sizes and all, but the contents get discarded. why keep the headers? so other tools can match the debuginfo file up with the real executable, even if that executable has been relocated to a different address space. iconic behaviour honestly.
the whole intention here is that you use this alongside --add-gnu-debuglink to build a two-part executable: one stripped binary that takes up less space in RAM and in a distribution, and a second debugging information file that's only needed when you actually want debugging abilities. the suggested procedure to create these files is:
- Link the executable as normal. Assuming that it is called
foothen... - Run
objcopy --only-keep-debug foo foo.dbgto create a file containing the debugging info. - Run
objcopy --strip-debug footo create a stripped executable. - Run
objcopy --add-gnu-debuglink=foo.dbg footo add a link to the debugging info into the stripped executable.
note β picking.dbgas the extension for the debug info file is completely arbitrary, bestie. also the--only-keep-debugstep is optional! you could do this instead:
- Link the executable as normal.
- Copy
footofoo.full - Run
objcopy --strip-debug foo - Run
objcopy --add-gnu-debuglink=foo.full foo
i.e., the file pointed to by --add-gnu-debuglink can be the full executable. it does not have to be a file created by the --only-keep-debug switch. periodt.
note β this switch is only intended for use on fully linked files. it does not make sense on object files where the debugging information may be incomplete. besides, the gnu_debuglink feature currently only supports the presence of one filename containing debugging information β not multiple filenames on a one-per-object-file basis. so don't try it π
--strip-dwoβ removes the contents of all DWARF.dwosections, leaving the remaining debugging sections and all symbols intact. this one is meant for the compiler, as part of the-gsplit-dwarfoption, which splits debug info between the.ofile and a separate.dwofile. the compiler generates all the debug information in the same file, then uses--extract-dwoto copy the.dwosections over to the.dwofile, then--strip-dwoto remove those sections from the original.ofile π§Ή--extract-dwoβ extracts the contents of all DWARF.dwosections. peep the--strip-dwooption above for the full lore.--file-alignmentnum β sets the file alignment. sections in the file will always start at file offsets that are multiples of this number. defaults to512. [this option is specific to PE targets.] π―--heapreserve /--heapreserve,commit β says how many bytes of memory to reserve (and optionally commit) for use as the heap for this program. [this option is specific to PE targets.]--image-basevalue β uses value as the base address of your program or dll. that's the lowest memory location used when your program or dll gets loaded. to cut down on relocation and make your dlls faster, each one should have a unique base address and not overlap any other dlls. the default is0x400000for executables, and0x10000000for dlls. [this option is specific to PE targets.] π--section-alignmentnum β [this option is specific to PE targets.]
sets the section alignment field in the PE header β if one is present in the binary. sections in memory will always begin at addresses which are a multiple of this number. defaults to 0x1000.
note β if a section's LMA or VMA addresses are no longer aligned, and those addresses were not set via the--set-section-lmaor--set-section-vmaoptions, and the file has been fully relocated, then a warning message will be issued. after that it's on you, bestie, to decide if the LMA and VMA need updating π¬
--stackreserve /--stackreserve,commit β how many bytes of memory to reserve (and optionally commit) for use as the stack for this program. [this option is specific to PE targets.]--subsystemwhich /--subsystemwhich:major /--subsystemwhich:major.minor β specifies the subsystem your program will execute under. the legal values for which are"native","windows","console","posix","efi-app","efi-bsd","efi-rtd","sal-rtd", and"xbox". you can optionally set the subsystem version too. numeric values are also accepted for which. [this option is specific to PE targets.] π--extract-symbolβ keeps the file's section flags and symbols but removes all section data. specifically, the option:- removes the contents of all sections;
- sets the size of every section to zero; and
- sets the file's start address to zero.
this option is used to build a .sym file for a VxWorks kernel. it can also be a handy way of shrinking the size of a --just-symbols linker input file π
--compress-debug-sectionsβ compresses DWARF debug sections using zlib withSHF_COMPRESSEDfrom the ELF ABI.
note β if compression would actually make a section bigger, then it doesn't get compressed. no glow-up, no change π
--compress-debug-sections=none/--compress-debug-sections=zlib/--compress-debug-sections=zlib-gnu/--compress-debug-sections=zlib-gabi/--compress-debug-sections=zstdβ for ELF files, these control how DWARF debug sections get compressed:--compress-debug-sections=noneis equivalent to--decompress-debug-sections.--compress-debug-sections=zliband--compress-debug-sections=zlib-gabiare equivalent to--compress-debug-sections.--compress-debug-sections=zlib-gnucompresses DWARF debug sections using the obsoleted zlib-gnu format. the debug sections get renamed to begin with.zdebug.--compress-debug-sections=zstdcompresses DWARF debug sections using zstd.
note β if compression would actually make a section larger, then it is not compressed nor renamed π«
--decompress-debug-sectionsβ decompresses DWARF debug sections. for a.zdebugsection, the original name is restored π¦--elf-stt-common=yes/--elf-stt-common=noβ for ELF files, these control whether common symbols get converted to the"STT_COMMON"or"STT_OBJECT"type.--elf-stt-common=yesconverts common symbol type to"STT_COMMON".--elf-stt-common=noconverts common symbol type to"STT_OBJECT".--merge-notes/--no-merge-notesβ for ELF files, attempt (or don't attempt) to shrink anySHT_NOTEtype sections by removing duplicate notes π§-V,--versionβ shows the version number ofobjcopy.--verilog-data-width=bytes β for Verilog output, this controls the number of bytes converted for each output data element. the input target controls the endianness of the conversion.-v,--verboseβ verbose output: lists all object files modified. in the case of archives,objcopy -Vlists all members of the archive π--helpβ shows a summary of the options toobjcopy.--infoβ displays a list showing all architectures and object formats available π@file β reads command-line options from file. the options read are inserted in place of the original@file option. if file doesn't exist, or can't be read, then the option is treated literally, and not removed.
options in file are separated by whitespace. a whitespace character may be included in an option by surrounding the entire option in either single or double quotes. any character (including a backslash) may be included by prefixing the character to be included with a backslash. the file may itself contain additional @file options; any such options will be processed recursively π
π SEE ALSO π
okay so when you're done vibing with objcopy, bestie, you are literally gonna want the rest of the squad:
ld(1)β the linker, the main character who actually puts your stuff together π«Άobjdump(1)β the nosy bestie who reads your object files back to you, iconic π- and the Info entries for binutils β the deep lore, the extended universe, the director's cut β¨
πΈ COPYRIGHT πΈ
ngl, the legal girlies were here first:
Copyright (c) 1991-2025 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation β with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. fr fr that's the whole deal. π
A copy of the license is included in the section entitled "GNU Free Documentation License" β so if you wanna read it, it's right there, no cap. πβ¨
bestie that's the whole page π you made it to the end, I'm so proud of you π go copy some object files, you absolute legend π
this was binutils-2.45.50 vibing from 2025-12-09 β OBJCOPY(1), periodt ππ¦
π¦ where this page comes from
- ubuntu resolute: binutils-xtensa-lx106 2.45.50.20251209-1ubuntu1+6build1
- ubuntu stonking: binutils-xtensa-lx106 2.45.50.20251209-1ubuntu1+6build1
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms