Software:dd (Unix)

From HandWiki

Short description: Command-line utility for Unix and Unix-like operating systems
dd
Original author(s)Ken Thompson
(AT&T Bell Laboratories)
Developer(s)Various open-source and commercial developers
Initial releaseJune 1974; 50 years ago (1974-06)
Repositorycoreutils: git.savannah.gnu.org/cgit/coreutils.git/
Written inPlan 9: C
Operating systemUnix, Unix-like, Plan 9, Inferno, Windows
PlatformCross-platform
TypeCommand
Licensecoreutils: GPLv3+
Plan 9: MIT License

dd is a command-line utility for Unix, Plan 9, Inferno, and Unix-like operating systems and beyond, the primary purpose of which is to convert and copy files.[1] On Unix, device drivers for hardware (such as hard disk drives) and special device files (such as /dev/zero and /dev/random) appear in the file system just like normal files; dd can also read and/or write from/to these files, provided that function is implemented in their respective driver. As a result, dd can be used for tasks such as backing up the boot sector of a hard drive, and obtaining a fixed amount of random data. The dd program can also perform conversions on the data as it is copied, including byte order swapping and conversion to and from the ASCII and EBCDIC text encodings.[2]

History

In 1974, the dd command appeared as part of Version 5 Unix. According to Dennis Ritchie, the name is an allusion to the DD statement found in IBM's Job Control Language (JCL),[3][4] in which it is an abbreviation for "Data Definition".[5][6] According to Douglas McIlroy, dd was "originally intended for converting files between the ASCII, little-endian, byte-stream world of DEC computers and the EBCDIC, big-endian, blocked world of IBM"; thus, explaining the cultural context of its syntax.[7] Eric S. Raymond believes "the interface design was clearly a prank", due to the command's syntax resembling a JCL statement more than other Unix commands do.[4]

In 1987, the dd command is specified in the X/Open Portability Guide issue 2 of 1987. This is inherited by IEEE Std 1003.1-2008 (POSIX), which is part of the Single UNIX Specification.[8]

In 1990, David MacKenzie announces GNU fileutils (now part of coreutils) which includes the dd command;[9] it was written by Paul Rubin, David MacKenzie, and Stuart Kemp.[10] Since 1991, Jim Meyering is its maintainer.[11]

In 1995, Plan 9 2nd edition is released; its dd command interface is redesigned to use a traditional command-line option style instead of a JCL statement style.[12]

Since at least 1999,[13] there's UnxUtils, a native Win32 port for Microsoft Windows using GNU fileutils.[14]

dd is sometimes humorously called "Disk Destroyer", due to its drive-erasing capabilities involving typos.[15]

Usage

The command line syntax of dd differs from many other Unix programs. It uses the syntax option=value for its command-line options rather than the more standard -option value or --option=value formats. By default, dd reads from stdin and writes to stdout, but these can be changed by using the if (input file) and of (output file) options.[8]

Certain features of dd will depend on the computer system capabilities, such as dd's ability to implement an option for direct memory access. Sending a SIGINFO signal (or a USR1 signal on Linux) to a running dd process makes it print I/O statistics to standard error once and then continue copying. dd can read standard input from the keyboard. When end-of-file (EOF) is reached, dd will exit. Signals and EOF are determined by the software. For example, Unix tools ported to Windows vary as to the EOF: Cygwin uses (the usual Unix EOF) and MKS Toolkit uses (the usual Windows EOF).

The non-standardized parts of dd invocation vary among implementations.

Output messages

On completion, dd prints to the stderr stream about statistics of the data transfer. The format is standardized in POSIX.[8](STDERR) The manual page for GNU dd does not describe this format, but the BSD manuals do.

Each of the "Records in" and "Records out" lines shows the number of complete blocks transferred + the number of partial blocks, e.g. because the physical medium ended before a complete block was read, or a physical error prevented reading the complete block.

Block size

A block is a unit measuring the number of bytes that are read, written, or converted at one time. Command-line options can specify a different block size for input/reading (ibs) compared to output/writing (obs), though the block size (bs) option will override both ibs and obs. The default value for both input and output block sizes is 512 bytes (the traditional block size of disks, and POSIX-mandated size of "a block"). The count option for copying is measured in blocks, as are both the skip count for reading and seek count for writing. Conversion operations are also affected by the "conversion block size" (cbs).[8](OPERANDS)

The value provided for block size options is interpreted as a decimal (base 10) integer number of bytes. It can also contain suffixes to indicate that the block size is an integer number of larger units than bytes. POSIX only specifies the suffixes b (blocks) for 512 and k (kibibytes) for 1024.[8](OPERANDS) Implementation differ on the additional suffixes they support: (Free) BSD uses lowercase m (mebibytes), g (gibibytes), and so on for tebibytes, exbibytes, pebibytes, zebibytes, and yobibytes,[16] while GNU uses M and G for the same units, with kB, MB, and GB used for their SI unit counterparts (kilobytes).[10] For example, for GNU dd, bs=16M indicates a blocksize of 16 mebibytes (16777216 bytes) and bs=3kB specifies 3000 bytes.

Additionally, some implementations understand the x character as a multiplication operator for both block size and count parameters. For example, bs=2x80x18b is interpreted as 2 × 80 × 18 × 512 = 1474560 bytes, the exact size of a 1440 KiB floppy disk. This is required in POSIX.[8](OPERANDS) For implementations that do not support this feature, the POSIX shell arithmetic syntax of bs=$((2*80*18))b may be used.

Block size has an effect on the performance of copying dd commands. Doing many small reads or writes is often slower than doing fewer large ones. Using large blocks requires more RAM and can complicate error recovery. When dd is used with variable-block-size devices such as tape drives or networks, the block size may determine the tape record size or packet size, depending on the network protocol used.

Uses

The dd command can be used for a variety of purposes. For plain-copying commands it tends to be slower than the domain-specific alternatives, but it excels at its unique ability to "overwrite or truncate a file at any point or seek in a file", a fairly low-level interface to the Unix file API.[17]

The examples below assume the use of GNU dd, mainly in the block size argument. To make them portable, replace e.g. bs=64M with the shell arithmetic expression bs=$((64*1024*1024)) or bs=$((64 << 20)) (written equivalently with a bit shift).

Data transfer

dd can duplicate data across files, devices, partitions and volumes. The data may be input or output to and from any of these; but there are important differences concerning the output when going to a partition. Also, during the transfer, the data can be modified using the conv options to suit the medium. (For this purpose, however, dd is slower than cat.)[17]

Data transfer forms of dd
blocks=$(isosize -d 2048 /dev/sr0)
dd if=/dev/sr0 of=isoimage.iso bs=2048 count=$blocks status=progress
Creates an ISO disk image from a CD-ROM, DVD or Blu-ray disc.[18]
dd if=system.img of=/dev/sdc bs=64M conv=noerror
Restores a hard disk drive (or an SD card, for example) from a previously created image.
dd if=/dev/sdb2 of=partition.image bs=64M conv=noerror
Create an image of the partition sdb2, using a 64 MiB block size.
dd if=/dev/sda2 of=/dev/sdb2 bs=64M conv=noerror
Clones one partition to another.
dd if=/dev/ad0 of=/dev/ad1 bs=64M conv=noerror
Clones a hard disk drive "ad0" to "ad1".

The noerror option means to keep going if there is an error, while the sync option causes output blocks to be padded.

In-place modification

dd can modify data in place. For example, this overwrites the first 512 bytes of a file with null bytes:

dd if=/dev/zero of=path/to/file bs=512 count=1 conv=notrunc

The notrunc conversion option means do not truncate the output file — that is, if the output file already exists, just replace the specified bytes and leave the rest of the output file alone. Without this option, dd would create an output file 512 bytes long.

Master boot record backup and restore

The example above can also be used to back up and restore any region of a device to a file, such as a master boot record.

To duplicate the first two sectors of a floppy disk:

dd if=/dev/fd0 of=MBRboot.img bs=512 count=2

Disk wipe

Main page: Data erasure

For security reasons, it is sometimes necessary to have a disk wipe of a discarded device. This can be achieved by a "data transfer" from the Unix special files.

  • To write zeros to a disk, use dd if=/dev/zero of=/dev/sda bs=16M.
  • To write random data to a disk, use dd if=/dev/urandom of=/dev/sda bs=16M.

When compared to the data modification example above, notrunc conversion option is not required as it has no effect when the dd's output file is a block device.[19]

The bs=16M option makes dd read and write 16 mebibytes at a time. For modern systems, an even greater block size may be faster. Note that filling the drive with random data may take longer than zeroing the drive, because the random data must be created by the CPU, while creating zeroes is very fast. On modern hard-disk drives, zeroing the drive will render most data it contains permanently irrecoverable.[20] However, with other kinds of drives such as flash memories, much data may still be recoverable by data remanence.

Modern hard disk drives contain a Secure Erase command designed to permanently and securely erase every accessible and inaccessible portion of a drive. It may also work for some solid-state drives (flash drives). As of 2017, it does not work on USB flash drives nor on Secure Digital flash memories.[citation needed] When available, this is both faster than using dd, and more secure.[citation needed] On Linux machines it is accessible via the hdparm command's --security-erase-enhanced option.

The shred program offers multiple overwrites, as well as more secure deletion of individual files.

Data recovery

Data recovery involves reading from a drive with some parts potentially inaccessible. dd is a good fit with this job with its flexible skipping (seek) and other low-level settings. The vanilla dd, however, is clumsy to use as the user has to read the error messages and manually calculate the regions that can be read. The single block size also limits the granuarity of the recovery, as a trade-off has to be made: either use a small one for more data recovered or use a large one for speed.

A C program called dd_rescue[21] was written in October 1999. It did away with the conversion functionality of dd, and supports two block sizes to deal with the dilemma. If a read using a large size fails, it falls back to the smaller size to gather as much as data possible. It can also run backwards. In 2003, a dd_rhelp script was written to automate the process of using dd_rescue, keeping track of what areas have been read on its own.[22]

In 2004, GNU wrote a separate utility, unrelated to dd, called ddrescue. It has a more sophisticated dynamic block-size algorithm and keeps track of what has been read internally. The authors of both dd_rescue and dd_rhelp consider it superior to their implementation.[23] To help distinguish the newer GNU program from the older script, alternate names are sometimes used for GNU's ddrescue, including addrescue (the name on freecode.com and freshmeat.net), gddrescue (Debian package name), and gnu_ddrescue (openSUSE package name).

Another open-source program called savehd7 uses a sophisticated algorithm, but it also requires the installation of its own programming-language interpreter.

Benchmarking drive performance

To make drive benchmark test and analyze the sequential (and usually single-threaded) system read and write performance for 1024-byte blocks:

  • Write performance: dd if=/dev/zero bs=1024 count=1000000 of=1GB_file_to_write
  • Read performance: dd if=1GB_file_to_read of=/dev/null bs=1024

Generating a file with random data

To make a file of 100 random bytes using the kernel random driver:

dd if=/dev/urandom of=myrandom bs=100 count=1

Converting a file to upper case

To convert a file to uppercase:

dd if=filename of=filename1 conv=ucase,notrunc

Progress indicator

Being a program mainly designed as a filter, dd normally does not provide any progress indication. This can be overcome by sending an USR1 signal to the running GNU dd process (INFO on BSD systems), resulting in dd printing the current number of transferred blocks.

The following one-liner results in continuous output of progress every 10 seconds until the transfer is finished, when dd-pid is replaced by the process-id of dd:

while kill -USR1 dd-pid ; do sleep 10 ; done

Newer versions of GNU dd support the status=progress option, which enables periodic printing of transfer statistics to stderr.[24]

Forks

dcfldd

dcfldd is a fork of GNU dd that is an enhanced version developed by Nick Harbour, who at the time was working for the United States' Department of Defense Computer Forensics Lab.[25][26][27] Compared to dd, dcfldd allows more than one output file, supports simultaneous multiple checksum calculations, provides a verification mode for file matching, and can display the percentage progress of an operation. The last release was in 2021.[28]

dc3dd

dc3dd is another enhanced GNU dd from the United States Department of Defense Cyber Crime Center (DC3). It can be seen as a continuation of the dcfldd, with a stated aim of updating whenever the GNU upstream is updated. (As of June 2023), the last release was 7.3.1 from April 2023.[29]

See also

References

  1. Austin Group. "POSIX standard: dd invocation". http://www.opengroup.org/onlinepubs/9699919799/utilities/dd.html. 
  2. Chessman, Sam. "How and when to use the dd command?". CodeCoffee. http://www.codecoffee.com/tipsforlinux/articles/036.html. 
  3. Ritchie, Dennis (Feb 17, 2004). "Re: origin of the UNIX dd command". Newsgroupalt.folklore.computers. Usenet: c0s1he$1atuh9$1@ID-156882.news.uni-berlin.de. Archived from the original on January 22, 2011. Retrieved January 10, 2016. dd was always named after JCL dd cards.
  4. 4.0 4.1 Raymond, Eric S.. "dd". http://www.catb.org/jargon/html/D/dd.html. 
  5. Struble, George (1969). Assembler language programming: the IBM System/360. Reading, Mass., Addison-Wesley Pub. Co. p. 123. https://archive.org/details/assemblerlanguag00stru/page/122/mode/2up?q=%22DD+statement%22+%22data+definition%22. 
  6. Shein, Barry (Apr 22, 1990). "Re: etymology of the Unix "dd" command". Newsgroupalt.folklore.computers. Usenet: 1990Apr22.191928.11180@world.std.com. Archived from the original on 2023-10-24. Retrieved 2016-07-14.
  7. Template:Cite tech report
  8. 8.0 8.1 8.2 8.3 8.4 8.5 dd – Commands & Utilities Reference, The Single UNIX Specification, Issue 7 from The Open Group
  9. "GNU file utilities release 1.0". https://groups.google.com/g/gnu.utils.bug/c/CviP42X_hCY/m/YssXFn-JrX4J. 
  10. 10.0 10.1 dd(1) – Linux User's Manual – User Commands
  11. "GNU's Who". https://www.gnu.org/people/people.html#j. 
  12. dd(1) – Plan 9 Programmer's Manual, Volume 1
  13. "Native Win32 ports of some GNU utilities". 15 August 2000. http://www.weihenstephan.de:80/~syring/win32/UnxUtils.html. 
  14. "Native Win32 ports of some GNU utilities". http://unxutils.sourceforge.net/. 
  15. "How to use dd in Linux without destroying your disk" (in en). 2018-07-05. https://opensource.com/article/18/7/how-use-dd-linux. 
  16. dd(1) – FreeBSD General Commands Manual
  17. 17.0 17.1 Gilles (2011). "cloning - dd vs cat – is dd still relevant these days?". https://unix.stackexchange.com/a/12538. 
  18. "Creating an ISO image from a CD, DVD, or BD". ArchWiki. https://wiki.archlinux.org/title/Optical_disc_drive#Creating_an_ISO_image_from_a_CD,_DVD,_or_BD. Retrieved April 18, 2022. 
  19. "linux - Why using conv=notrunc when cloning a disk with dd?". Stack Overflow. 2013-12-11. https://stackoverflow.com/questions/20526198/why-using-conv-notrunc-when-cloning-a-disk-with-dd. 
  20. Wright, Craig S.; Kleiman, Dave; S., Shyaam Sundhar R. (2008). "Information Systems Security, 4th International Conference, ICISS 2008, Hyderabad, India, December 16-20, 2008. Proceedings". in Sekar, R.; Pujari, Arun K.. 5352. Springer. pp. 243–257. doi:10.1007/978-3-540-89862-7_21. 
  21. "dd_rescue". garloff.de. http://www.garloff.de/kurt/linux/ddrescue/. 
  22. LAB Valentin (19 September 2011). "dd_rhelp author's repository". http://www.kalysto.org/utilities/dd_rhelp/index.en.html. "Important note : For some times, dd_rhelp was the only tool (AFAIK) that did this type of job, but since a few years, it is not true anymore: Antonio Diaz did write a ideal replacement for my tool: GNU 'ddrescue'." 
  23. "Ddrescue - GNU Project - Free Software Foundation (FSF)". gnu.org. https://www.gnu.org/software/ddrescue/ddrescue.html. 
  24. "GNU Coreutils: dd invocation". https://www.gnu.org/software/coreutils/manual/html_node/dd-invocation.html. 
  25. "DCFLDD at Source Forge". Source Forge. http://dcfldd.sourceforge.net/. 
  26. Jeremy Faircloth, Chris Hurley (2007). Penetration Tester's Open Source Toolkit. Syngress. pp. 470–472. ISBN 9780080556079. 
  27. Jack Wiles, Anthony Reyes (2011). The Best Damn Cybercrime and Digital Forensics Book Period. Syngress. pp. 408–411. ISBN 9780080556086. 
  28. "dcfldd: Enhanced version of dd for forensics and security". GitHub. https://github.com/resurrecting-open-source-projects/dcfldd. 
  29. "dc3dd" (in en). 25 April 2023. https://sourceforge.net/projects/dc3dd/. 

External links