printf format string

printf is a C standard library function that formats text and writes it to standard output. The function accepts a format c-string argument and a variable number of value arguments that the function serializes per the format string. Mismatch between the format specifiers and count and type of values results in undefined behavior and possibly program crash or other vulnerability.

The format string is encoded as a template language consisting of verbatim text and ''format specifiers'' that each specify how to serialize a value. As the format string is processed left-to-right, a subsequent value is used for each format specifier found. A format specifier starts with a character and has one or more following characters that specify how to serialize a value.

The standard library provides other, similar functions that form a family of ''printf-like'' functions. The functions share the same formatting capabilities but provide different behavior such as output to a different destination or safety measures that limit exposure to vulnerabilities. Functions of the printf-family have been implemented in other programming contexts (i.e. languages) with the same or similar syntax and semantics.

The scanf C standard library function complements printf by providing formatted input (a.k.a. lexing, a.k.a. parsing) via a similar format string syntax.

The name, ''printf'', is short for ''print formatted'' where ''print'' refers to output to a printer although the function is not limited to printer output. Today, print refers to output to any text-based environment such as a terminal or a file.

History

1950s: Fortran

Early programming languages like Fortran used special statements with different syntax from other calculations to build formatting descriptions. (2+51+1 pages) In this example, the format is specified on line , and the command refers to it by line number:

PRINT 601, IA, IB, AREA
601 FORMAT (4H A= ,I5,5H B= ,I5,8H AREA= ,F10.2, 13H SQUARE UNITS)

Hereby:

* indicates a string of 4 characters " A= " ( means Hollerith Field);
* indicates an integer field of width 5;
* indicates a floating-point field of width 10 with 2 digits after the decimal point.

An output with input arguments , , and might look like this:

A= 100 B= 200 AREA= 1500.25 SQUARE UNITS

1960s: BCPL and ALGOL 68

In 1967, BCPL appeared. Its library included the routine. An example application looks like this:

WRITEF("%I2-QUEENS PROBLEM HAS %I5 SOLUTIONS*N", NUMQUEENS, COUNT)

Hereby:

* indicates an integer of width 2 (the order of the format specification's field width and type is reversed compared to C's );
* indicates an integer of width 5;
* is a BCPL ''language'' escape sequence representing a newline character (for which C uses the escape sequence ).

In 1968, ALGOL 68 had a more function-like API, but still used special syntax (the delimiters surround special formatting syntax):

printf(($"Color "g", number1 "6d,", number2 "4zd,", hex "16r2d,", float "-d.2d,", unsigned value"-3d"."l$,
"red", 123456, 89, BIN 255, 3.14, 250));

In contrast to Fortran, using normal function calls and data types simplifies the language and compiler, and allows the implementation of the input/output to be written in the same language.

These advantages were thought to outweigh the disadvantages (such as a complete lack of type safety in many instances) up until the 2000s, and in most newer languages of that era I/O is not part of the syntax.

People have since learned that this potentially results in consequences, ranging from security exploits to hardware failures (e.g., phone's networking capabilities being permanently disabled after trying to connect to an access point named "%p%s%s%s%s%n"). Modern languages, such as C++20 and later, tend to include format specifications as a part of the language syntax, which restore type safety in formatting to an extent, and allow the compiler to detect some invalid combinations of format specifiers and data types at compile time.

1970s: C

In 1973, was included as a C standard library routine as part of Version 4 Unix.

1990s: Shell command

In 1990, the printf shell command, modeled after the C standard library function, was included with 4.3BSD-Reno. In 1991, a command was included with GNU shellutils (now part of GNU Core Utilities).

2000s: -Wformat safety

The need to do something about the range of problems resulting from lack of type safety has prompted attempts to make the C++ compiler -aware.

The option of GCC allows compile-time checks to calls, enabling the compiler to detect a subset of invalid calls (and issue either a warning or an error, stopping the compilation altogether, depending on other flags).

Since the compiler is inspecting format specifiers, enabling this effectively extends the C++ syntax by making formatting a part of it.

2020s: std::print

To address usability issues with the existing C++ input/output support, as well as avoid safety issues of printf the C++ standard library was revised to support a new type-safe formatting starting with C++20. The approach of resulted from incorporating Victor Zverovich's API into the language specification (Zverovich wrote the first draft of the new format proposal); consequently, is an implementation of the C++20 format specification. In C++23, another function, , was introduced that combines formatting and outputting and therefore is a functional replacement for .

As the format specification has become a part of the language syntax, a C++ compiler is able to prevent invalid combinations of types and format specifiers in many cases. Unlike the option, this is not an optional feature.

The format specification of and is, in itself, an extensible "mini-language" (referred to as such in the specification), an example of a domain-specific language. As such, , completes a historical cycle; bringing the state-of-the-art (as of 2024) back to what it was in the case of Fortran's first implementation in the 1950s.

Format specifier

Formatting of a value is specified as markup in the format string. For example, the following outputs Your age is and then the value of the variable in decimal format.

printf("Your age is %d", age);

Syntax

The syntax for a format specifier is:
% 'parameter''''flags''] 'width''.''precision''] 'length'''type''

Parameter field

The parameter field is optional. If included, then matching specifiers to values is sequential. The numeric value selects the n-th value parameter. This is a POSIX extension; not C99.

This field allows for using the same value multiple times in a format string instead of having to pass the value multiple times. If a specifier includes this field, then subsequent specifiers must also.

For example,

printf("%2$d %2$#x; %1$d %1$#x",16,17);

outputs:

This field is particularly useful for localizing messages to different natural languages that use different word orders.

In Windows API, support for this feature is via a different function, .

Flags field

The flags field can be zero or more of (in any order):

Width field

The width field specifies the number of characters to output. If the value can be represented in fewer characters, then the value is left-padded with spaces so that output is the number of characters specified. If the value requires more characters, then the output is longer than the specified width. A value is never truncated.

For example, specifies a width of 3 and outputs with a space on the left to output 3 characters. The call outputs which is 4 characters long since that is the minimum width for that value even though the width specified is 3.

If the width field is omitted, the output is the minimum number of characters for the value.

If the field is specified as , then the width value is read from the list of values in the call. For example, outputs 10 where the second parameter, , is the width (matches with ) and is the value to serialize (matches with ).

Though not part of the width field, a leading zero is interpreted as the zero-padding flag mentioned above, and a negative value is treated as the positive value in conjunction with the left-alignment flag also mentioned above.

The width field can be used to format values as a table (tabulated output). But, columns do not align if any value is larger than fits in the width specified. For example, notice that the last line value () does not fit in the first column of width 3 and therefore the column is not aligned.

1 1
12 12
123 123
1234 123

Precision field

The precision field usually specifies a limit of the output, depending on the particular formatting type. For floating-point numeric types, it specifies the number of digits to the right of the decimal point to which the output should be rounded; for and it specifies the total number of significant digits (before and after the decimal, not including leading or trailing zeroes) to round to. For the string type, it limits the number of characters that should be output, after which the string is truncated.

The precision field may be omitted, or a numeric integer value, or a dynamic value when passed as another argument when indicated by an asterisk (). For example, outputs .

Length field

The length field can be omitted or be any of:

Platform-specific length options came to exist prior to widespread use of the ISO C99 extensions, including:

ISO C99 includes the inttypes.h header file that includes a number of macros for platform-independent coding. For example: specifies decimal format for a 64-bit signed integer. Since the macros evaluate to a string literal, and the compiler concatenates adjacent string literals, the expression compiles to a single string.

Macros include:

Type field

The type field can be any of:

Custom data type formatting

A common way to handle formatting with a custom data type is to format the custom data type value into a string, then use the specifier to include the serialized value in a larger message.

Some printf-like functions allow extensions to the escape-character-based mini-language, thus allowing the programmer to use a specific formatting function for non-builtin types. One is the (now deprecated) glibc'

However, it is rarely used due to the fact that it conflicts with static format string checking. Another i
Vstr custom formatters
which allows adding multi-character format names.

Some applications (like the Apache HTTP Server) include their own printf-like function, and embed extensions into it. However these all tend to have the same problems that has.

The Linux kernel printk function supports a number of ways to display kernel structures using the generic specification, by additional format characters. For example, prints an IPv4 address in dotted-decimal form. This allows static format string checking (of the portion) at the expense of full compatibility with normal printf.

Vulnerabilities

Format string attack

Extra value arguments are ignored, but if the format string has more format specifiers than value arguments passed, the behavior is undefined. For some C compilers, an extra format specifier results in consuming a value even though there isn't one which allows the format string attack. Generally, for C, arguments are passed on the stack. If too few arguments are passed, then printf can read past the end of the stack frame, thus allowing an attacker to read the stack.

Some compilers, like the GNU Compiler Collection, will statically check the format strings of printf-like functions and warn about problems (when using the flags or ). GCC will also warn about user-defined printf-style functions if the non-standard "format" is applied to the function.

Uncontrolled format string exploit

The format string is often a string literal, which allows static analysis of the function call. However, the format string can be the value of a variable, which allows for dynamic formatting but also a security vulnerability known as an uncontrolled format string exploit.

Memory write

Although an output function on the surface, allows writing to a memory location specified by an argument via . This functionality is occasionally used as a part of more elaborate format-string attacks.

The functionality also makes accidentally Turing-complete even with a well-formed set of arguments. A game of tic-tac-toe written in the format string is a winner of the 27th IOCCC.

Related functions

Family

Variants of in the C standard library include:

outputs to a file instead of standard output.

writes to a string buffer instead of standard output.

provides a level of safety over since the caller provides a length ''n'' that is the length of the output buffer in bytes (including space for the trailing nul).

provides for safety by accepting a string handle (char**) argument. The function allocates a buffer of sufficient size to contain the formatted text and outputs the buffer via the handle.

For each function of the family, including printf, there is also a variant that accepts a single argument rather than a variable list of arguments. Typically, these variants start with "v". For example: , , .

Generally, printf-like functions return the number of bytes output or -1 to indicate failure.

Other contexts

The following list includes notable programming languages that provide (directly or via a standard library) functionality that is the same or similar to the C printf-like functions. Excluded are languages that use format strings that deviate from the style in this article (such as AMPL and Elixir), languages that inherit their implementation from the JVM or other environment (such as Clojure and Scala), and languages that do not have a standard native printf implementation but have external libraries which emulate printf behavior (such as JavaScript).

* awk
* C
* C++
* D
* F#
* G
* GNU MathProg
*GNU Octave
* Go
*Haskell
* J
*Java (since version 1.5) and JVM languages
* Julia (via Printf standard library)
* Lua ()
*Maple
*MATLAB
*Max (via the object)
*Objective-C
*OCaml (via the Printf module)
*PARI/GP
*Perl
* PHP
* Python (via operator)
* R
* Raku (via , , and )
* Red/System
*Ruby
* Tcl (via command)
*Transact-SQL (vi


* Vala (via and )

See also

* "Hello, World!" program A basic example program first featured in ''The C Programming Language'' (the "K&R Book"), which in the C example uses printf to output the message "Hello, World!"
*
*
*
*
*
*
*
*
*
*

Notes

References

External links

C++ reference for
*
*Th

in Java 1.5
*GNU Bashbr> builtin

{{Unix commands

Articles with example C code
Articles with example ALGOL 68 code
Articles with example Fortran code
C standard library
Unix software