OBJCOPY(1)
π OBJCOPY(1) β GNU Development Tools π
okay bestie, sit down, hydrate, because we're about to talk about objcopy(1) from the GNU Development Tools manual and it is a lot in the best way. she copies object files. she translates them. she is the moment. π¦
β¨ NAME β¨
objcopy β copy and translate object files. that's it, that's her whole job description, and she EATS. π
πΈ 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]
like. okay. that's the shape of her. long list, no notes, absolutely iconic. π
π DESCRIPTION π
so the GNU objcopy utility literally copies the contents of one object file into another. she uses the GNU BFD Library to read and write her object files, which is how she can write the destination file in a different format than the source. every little thing she does is controlled by command-line options.
now, lowkey important: objcopy should be able to copy a fully linked file between any two formats. but copying a relocatable object file between any two formats? that may not work as expected. no cap. π
she does her translation work by making temporary files and then deleting them afterwards, which is very clean of her. and because she uses BFD for all the translation work, she has access to all the formats described in BFD β meaning she can recognize most formats without you having to tell her. main character energy fr fr. β¨
a few things she's known for:
- you can generate S-records with her by using an output target of
srec(e.g., use-O srec). π - you can generate a raw binary file by using an output target of
binary(e.g., use-O binary). when she does this, she essentially produces a memory dump of the contents of the input object file. all symbols and relocation information get discarded. the memory dump starts at the load address of the lowest section copied into the output file. - when you're generating an S-record or a raw binary file, it may be helpful to use
-Sto remove sections containing debugging information. in some cases-Rwill be useful to remove sections holding info the binary file doesn't need.
β οΈ okay this one matters, bestie:objcopyis not able to change the endianness of its input files. if the input format has an endianness (some formats don't), she can only copy the inputs into file formats that have the same endianness or that have no endianness (e.g.,srec). (howeverβ¦ see the--reverse-bytesoption. π)
π OPTIONS π
the files themselves
infile/outfileβ the input and output files, respectively. if you don't specifyoutfile,objcopycreates a temporary file and destructively renames the result with the name ofinfile. (destructively. she said what she said. π)
formats & targets
-I bfdname,--input-target=bfdnameβ treat the source file's object format asbfdnameinstead of trying to deduce it. stop guessing, tell her directly. π-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., just transfer data from source to destination with no translation. so chill of her. π§-B bfdarch,--binary-architecture=bfdarchβ useful when you're transforming an architecture-less input file into an object file. in that case the output architecture can be set tobfdarch. this option gets ignored if the input file already has a knownbfdarch. you can access this binary data inside a program by referencing the special symbols created by the conversion process. those 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. so girlypop coded. πΌοΈ
picking and choosing sections
-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 an 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'. (yes, "sectinos". we respect the original spelling in this house. π«Ά)
-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. π don't do it bestie.
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.
stripping it down π
-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 the debugging symbols and sections stripped by--strip-debug.
symbol-level surgery β¨
-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.
okay that's where part one wraps, but do NOT go anywhere, there is so much more of her to go, we're literally just getting started. π«Ά
-Gsymbolname,--keep-global-symbol=symbolname β bestie, this one is a filter. It keeps only symbolname global and demotes literally everything else to local, so nothing else is visible externally. It's giving "you, specifically, may stay." You can pass this more than once if you want a lil VIP list. β οΈ heads up though β you cannot use this together with--globalize-symbolor--globalize-symbols. They do NOT get along. π--localize-hiddenβ for ELF objects specifically: any symbol with hidden or internal visibility gets marked local. And it stacks, so it applies on top of the symbol-specific localization options like-L. π-Lsymbolname,--localize-symbol=symbolname β takes a global or weak symbol named symbolname and turns it into a local symbol, so it's not visible externally anymore. Like, "you're staying home now." Repeated as many times as you want. But note: unique symbols are not converted β they simply don't play that game. π ββοΈ-Wsymbolname,--weaken-symbol=symbolname β makes symbolname weak. That's it, that's the whole thing. Pass it as many times as you like. β¨--binary-symbol-prefix=string β when you're rocking--input-target=binary, this sets string as the base name for the symbols generated off the input file. Those symbols are:
<string>_start
<string>_end
<string>_size
Normally (with no flag), the binary input handler just cooks up the prefix from a mangled version of the input file name plus the _binary prefix. This option lets you say it out loud yourself instead. π
--globalize-symbol=symbolname β gives symbolname global scoping so it's visible outside the file it's defined in. Glow-up to main character, honestly. Pass it more than once if you want. β οΈ but no cap: this cannot be used with-Gor--keep-global-symbol. Pick a lane, bestie.-w,--wildcardβ unlocks regular expressions in the symbolnames used by your other command line options. The operators you get are?,*,\and[], and you can drop them anywhere in the symbol name. And plot twist: if the first character of the symbol name is!, it flips the sense of the switch for that symbol. For example:
-w -W !foo -W fo*
would make objcopy weaken everything that starts with "fo" except for the symbol "foo". Obsessed with the drama of that. π
-x,--discard-allβ do not copy non-global symbols from the source file. Bye π-X,--discard-localsβ do not copy compiler-generated local symbols. (Those usually start withLor..) Not me, fr fr.-bbyte,--byte=byte β if interleaving is on (via--interleave), this sets where the range of bytes to keep starts, at the byteth byte. byte can be anything from0to breadth-1, where breadth is whatever you gave to--interleave. π§- *
-i[breadth*],--interleave[=breadth]** β only copies a range out of every *breadth* bytes. (Header data is untouched, so don't worry about that.)--bytepicks which byte in the range kicks off the copy, and--interleave-width` picks how wide the range is.
This is the one for making files to program ROM, and it's typically used with an "srec" output target. Note that objcopy will complain if you don't also specify --byte β so don't ghost it. π
The default interleave breadth is 4, so with --byte set to 0, objcopy would copy the first byte out of every four bytes from input to output.
--interleave-width=width β used alongside--interleave, this copies width bytes at a time.--bytesets the start of the range,--interleavesets the extent.
Default value is 1. And the rule: width plus the byte value from --byte must not exceed the interleave breadth from --interleave. Math check, bestie. βοΈ
Here's the iconic use case β building 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 your input was '12345678', the outputs would be '1256' and '3478' respectively. Slay. π₯
-p,--preserve-datesβ sets the access and modification dates of the output file to match the input file's. Same energy, same timestamps.
It 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 that variable gets used as the date stored in the header, interpreted as the number of seconds since the Unix epoch. π
-D,--enable-deterministic-archivesβ deterministic mode, on. When copying archive members and writing the archive index, it uses zero for UIDs, GIDs, timestamps, and consistent file modes for all files. Very "same every time, no chaos."
If binutils was configured with --enable-deterministic-archives, this mode is on by default, and you can turn it off with -U. π
-U,--disable-deterministic-archivesβ do not operate in deterministic mode. It's the exact inverse of-D: 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.
--debuggingβ converts debugging information, if possible. Not the default, because only certain debugging formats are supported and the conversion process can be time consuming. It's giving "worth it but she's slow." π’--gap-fillval β fills gaps between sections with val. This applies to the load address (LMA) of the sections, and it's done by increasing the size of the section with the lower address, then filling the extra space with val.--pad-toaddress β pads the output file up to the load address address. Done by increasing the size of the last section, and the extra space gets filled with whatever--gap-fillsays (default is zero). π«Ά--set-startval β sets the start address (also known as the entry address) of the new file to val. Just so you know: not all object file formats support setting the start address. π--change-startincr,--adjust-startincr β changes the start address (also known as the entry address) by adding incr to it. Same disclaimer: not all object file formats support setting the start address.--change-addressesincr,--adjust-vmaincr β changes the VMA and LMA addresses of all sections, plus the start address, by adding incr. Some object file formats don't permit section addresses to be changed arbitrarily. β οΈ And note: this does not relocate the sections. So if the program expects its sections at a certain address and you shift them somewhere else with this option, the program may just... fail. Not a vibe.--change-section-addresssectionpattern{=,+,-}val,--adjust-section-vmasectionpattern{=,+,-}val β sets or changes 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-addressesabove.) If sectionpattern doesn't match any sections in the input file, a warning gets issued β unless you're using--no-change-warnings.--change-section-lmasectionpattern{=,+,-}val β sets or changes the LMA address of any section matching sectionpattern. LMA = the address where the section gets loaded into memory at program load time. Normally it's the same as the VMA address (which is the address of the section at program run time), but on some systems β especially ones where a program lives in ROM β the two can differ. If=is used, the section address is set to val; otherwise val is added or subtracted. See the comments under--change-addressesabove. No match on sectionpattern β warning, unless--no-change-warnings.--change-section-vmasectionpattern{=,+,-}val β sets or changes the VMA address of any section matching sectionpattern. VMA = the address where the section sits once the program has started executing. Normally same as the LMA address (where it gets loaded into memory), but again, on some systems β especially ROM-based ones β they can be different.=sets the section address to val; otherwise val is added or subtracted. See the comments under--change-addressesabove. No match β warning, unless--no-change-warnings.
Note β changing the VMA of sections in a fully linked binary can be dangerous, because there may be code that expects the sections to be located at their old address. Proceed with awareness, bestie. π
--change-warnings,--adjust-warningsβ if--change-section-addressor--change-section-lmaor--change-section-vmais used and the section pattern doesn't match anything, issue a warning. This is the default behaviour. π£--no-change-warnings,--no-adjust-warningsβ do not issue a warning if--change-section-addressor--adjust-section-lmaor--adjust-section-vmais used, even when the section pattern matches zero sections. Silence, but make it intentional. π€«--set-section-flagssectionpattern=flags β sets the flags for any sections matching sectionpattern. The flags argument is a comma separated string of flag names, and the recognized ones arealloc,contents,load,noload,readonly,code,data,rom,exclude,share,debug, andlarge. You can set thecontentsflag for a section that doesn't have contents, but it's not meaningful to clear thecontentsflag of a section that does have contents β just remove the section instead. Also, 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. And the ELF x86-64 specific flaglargecorresponds toSHF_X86_64_LARGE. π--set-section-alignmentsectionpattern=align β sets 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.... Sorry to the chaotic ones, no funky numbers allowed. β¨
Okay so real talk before we get into the next batch of flags: setting a section's alignment does not automatically align its LMA or VMA addresses. If those also need to move, you gotta reach for --change-section-lma and/or --change-section-vma yourself.
Also, tiny warning: messing with VMAs can cause problems in fully linked binaries, because there might be code in there that fully expects the contents of the sections to live at their old address. So likeβ¦ proceed with intention, bestie. π«Ά
--add-section sectionname=filenameβ adds a brand new section called sectionname while it's copying the file. β¨ The contents of the new section get taken from the file filename, and the size of the section becomes the size of that file. This one only works on file formats that can support sections with arbitrary names. Note β you may need to use--set-section-flagsto set the attributes of the newly created section. π--dump-section sectionname=filenameβ takes the contents of the section named sectionname and drops them into the file filename, overwriting literally anything that was sitting there before. ποΈ This is the inverse of--add-section. It's kinda like--only-section, except it does not create a formatted file β it just dumps the contents as raw binary data, without applying any relocations. And yes, you can specify this option more than once. π₯--update-section sectionname=filenameβ replaces the existing contents of the section named sectionname with the contents of the file filename. The size of the section gets adjusted to the size of the file. The section flags for sectionname stay unchanged. For ELF format files the section-to-segment mapping stays unchanged too β something that is not possible if you do--remove-sectionfollowed by--add-section. π Can be specified more than once.
Note β you can use --rename-section and --update-section together to both update and rename a section from one command line. In that case, pass the original section name to --update-section, and hand the original and new section names to --rename-section. π
--add-symbol name=[section:]value[,flags]β adds a new symbol named name while copying the file. This option may be specified multiple times. π If a section is given, the symbol gets associated with and made relative to that section; otherwise it's an ABS symbol. Specifying an undefined section results in a fatal error. 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. By default the symbol will be global. The special flagbefore=othersyminserts 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-section oldname=newname[,flags]β renames a section from oldname to newname, optionally changing the section's flags to flags in the process. The advantage 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--set-section-flags.
This one is especially helpful when the input format is binary, since that will always create a section called .data. So like, say you wanted to instead create a section called .rodata holding binary data β you could use this 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, is to preserve 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. Theenableoption will only emit long section names if any are present in the inputs β that's mostly the same askeep, but it's left undefined whetherenablemight force the creation of an empty string table in the output file. π--change-leading-charβ some object file formats use special characters at the start of symbols. The most common one 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. 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 that character. The most common symbol leading character is underscore, so this will remove a leading underscore from all global symbols. Useful if you want to link together objects of different file formats that have 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.--reverse-bytes=numβ reverses the bytes in a section with output contents. A section length must be evenly divisible by the value given for the swap to be able to take place. Reversing takes place before the interleaving is performed. π
This is typically used in generating ROM images for problematic target systems. For example, 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.
Picture a simple file with a section containing these eight bytes: 12345678.
- Using
--reverse-bytes=2for the above example, the bytes in the output file would be ordered21436587. - Using
--reverse-bytes=4for the above example, the bytes in the output file would be ordered43218765. - Using
--reverse-bytes=2for the above example, followed by--reverse-bytes=4on the output file, the bytes in the second output file would be ordered34127856.
--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.--srec-forceS3β meaningful only for srec output. Avoids generation of S1/S2 records, creating S3-only record format. β¨--redefine-sym old=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. π--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. 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.--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.
Note: this option cannot be used in conjunction with the-Gor--keep-global-symboloptions. π«
--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. Useful in case a machine is assigned an official code and the tool-chain adopts the new code, but other applications still depend on the original code being used. 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. βοΈ--readonly-textβ makes the output text write protected. This option isn't meaningful for all object file formats. π--pureβ marks the output file as demand paged. lowkey, this option isn't meaningful for all object file formats. π--impureβ marks the output file as impure. same energy: this option isn't meaningful for all object file formats. π«Ά--prefix-symbols=stringβ every symbol in the output file gets string glued to the front. β¨--prefix-sections=stringβ every section name in the output file gets string glued to the front. π--prefix-alloc-sections=stringβ every name of every allocated section in the output file gets string glued to the front. π¦--add-gnu-debuglink=path-to-fileβ creates a.gnu_debuglinksection that contains a reference to path-to-file and adds it to the output file. Note: the file at path-to-file must exist. part of adding the.gnu_debuglinksection is embedding a checksum of the contents of the debug info file into the section. π₯
if the debug info file is built in one location but it's gonna be installed later into a different location, then do not use the path to the installed location. --add-gnu-debuglink will fail because the installed file does not exist yet. instead, put the debug info file in the current directory and use --add-gnu-debuglink without any directory components, like this:
objcopy --add-gnu-debuglink=foo.debug
at debug time, the debugger will attempt to look for the separate debug info file in a set of known locations. the exact set varies depending on the distribution being used, 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 has been installed into one of these locations before the debugger is run, everything should work correctly. π
--keep-section-symbolsβ when stripping a file, maybe with--strip-debugor--strip-unneeded, keep any symbols that specify section names, which would otherwise get stripped. π--keep-file-symbolsβ when stripping a file, maybe with--strip-debugor--strip-unneeded, keep any symbols that specify source file names, which would otherwise get stripped. π«Ά--only-keep-debugβ strips a file by removing contents of any sections that would not be stripped by--strip-debug, 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, including their sizes, but the contents of the section are discarded. the section headers are preserved so that other tools can match up the debuginfo file with the real executable, even if that executable has been relocated to a different address space.
the intention is that this option gets used together with --add-gnu-debuglink to create a two part executable. one: a stripped binary that takes up less space in RAM and in a distribution. two: a debugging information file that's only needed if debugging abilities are required. the suggested procedure to create these files is:
- link the executable as normal. assuming it's called
"foo"then... - 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 β the choice of.dbgas an extension for the debug info file is arbitrary. also the--only-keep-debugstep is optional. you could instead do this: 1. link the executable as normal. 2. copyfootofoo.full. 3. runobjcopy --strip-debug foo. 4. runobjcopy --add-gnu-debuglink=foo.full foo. i.e., the file pointed to by--add-gnu-debuglinkcan be the full executable. it does not have to be a file created by the--only-keep-debugswitch.
note β this switch is only intended for use on fully linked files. it does not make sense to use it 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.
--strip-dwoβ removes the contents of all DWARF.dwosections, leaving the remaining debugging sections and all symbols intact. this option is intended for use by the compiler as part of the-gsplit-dwarfoption, which splits debug information between the.ofile and a separate.dwofile. the compiler generates all debug information in the same file, then uses--extract-dwoto copy the.dwosections to the.dwofile, then--strip-dwoto remove those sections from the original.ofile. π§--extract-dwoβ extracts the contents of all DWARF.dwosections. see--strip-dwofor more info. πΈ--file-alignment numβ specifies the file alignment. sections in the file will always begin at file offsets that are multiples of this number. defaults to512. [this option is specific to PE targets.] π--heap reserve,--heap reserve,commitβ specifies the number of bytes of memory to reserve (and optionally commit) to be used as heap for this program. [this option is specific to PE targets.] π--image-base valueβ uses value as the base address of your program or dll. this is the lowest memory location that will be used when your program or dll is loaded. to reduce the need to relocate and improve performance of your dlls, each 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-alignment numβ [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 that 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 have not been set via the--set-section-lmaor--set-section-vmaoptions, and the file has been fully relocated, then a warning message will be issued. it's then up to the user to decide if the LMA and VMA need updating.
--stack reserve,--stack reserve,commitβ specifies the number of bytes of memory to reserve (and optionally commit) to be used as stack for this program. [this option is specific to PE targets.] π«Ά--subsystem which,--subsystem which:major,--subsystem which:major.minorβ specifies the subsystem under which your program will execute. the legal values for which are"native","windows","console","posix","efi-app","efi-bsd","efi-rtd","sal-rtd", and"xbox". you may optionally set the subsystem version also. 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, this option:- removes the contents of all sections.
- sets the size of every section to zero.
- 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 useful way of reducing 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 larger, then it is not compressed. β¨--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 options control how DWARF debug sections are 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 are 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 options control whether common symbols should be 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 do not attempt) to reduce the size of anySHT_NOTEtype sections by removing duplicate notes. πΈ-V,--versionβ shows the version number ofobjcopy. β--verilog-data-width=bytesβ for Verilog output, this option 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@fileoption. if file does not exist, or cannot be read, then the option will be 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 copying objects and you're like "what now bestie", here's the squad you go hang with:
ld(1)β the linker, the one who actually puts it all together π«Άobjdump(1)β the nosy bestie who reads your object files back to you, obsessed with her honestly- and the Info entries for binutils β yes ma'am, there's a whole other manual situation going on there, go look π
π COPYRIGHT π
Copyright (c) 1991-2026 Free Software Foundation, Inc.
k so legal moment, but make it cute: you are granted permission to copy, distribute, and/or modify this document, no cap, under the terms of the GNU Free Documentation License, Version 1.3 β or any later version published by the Free Software Foundation, whichever vibe you're on. β¨
the conditions? there are no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. so like, zero of each, we love a clean slate π
and a copy of the license itself is included in the section titled "GNU Free Documentation License", so if you wanna read the whole thing it's right there waiting for you π¦
okay that's literally the whole page bestie, we made it π₯Ή this was binutils-2.47, dated 2026-09-19, and yes that's the OBJCOPY(1) era, iconic, no notes ππ go copy some object files, you're gonna slay π
β¨
π¦ where this page comes from
- ubuntu stonking: binutils-sh-elf 2.47+3build2 Β· GPL-3.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms