diff --git a/libc/config/linux/x86_64/entrypoints.txt b/libc/config/linux/x86_64/entrypoints.txt --- a/libc/config/linux/x86_64/entrypoints.txt +++ b/libc/config/linux/x86_64/entrypoints.txt @@ -280,6 +280,7 @@ libc.src.stdio.sprintf libc.src.stdio.snprintf libc.src.stdio.fprintf + libc.src.stdio.printf libc.src.stdio.stderr libc.src.stdio.stdout diff --git a/libc/src/stdio/CMakeLists.txt b/libc/src/stdio/CMakeLists.txt --- a/libc/src/stdio/CMakeLists.txt +++ b/libc/src/stdio/CMakeLists.txt @@ -258,8 +258,20 @@ HDRS fprintf.h DEPENDS - libc.include.stdio - libc.src.stdio.printf_core.printf_main - libc.src.stdio.printf_core.file_writer - libc.src.stdio.printf_core.writer + libc.src.__support.arg_list + libc.src.stdio.printf_core.vfprintf_internal +) + + +add_entrypoint_object( + printf + SRCS + printf.cpp + HDRS + printf.h + DEPENDS + libc.src.__support.File.file + libc.src.__support.File.platform_file + libc.src.__support.arg_list + libc.src.stdio.printf_core.vfprintf_internal ) diff --git a/libc/src/stdio/fprintf.cpp b/libc/src/stdio/fprintf.cpp --- a/libc/src/stdio/fprintf.cpp +++ b/libc/src/stdio/fprintf.cpp @@ -8,14 +8,11 @@ #include "src/stdio/fprintf.h" +#include "src/__support/File/file.h" #include "src/__support/arg_list.h" -#include "src/stdio/ferror.h" -#include "src/stdio/printf_core/file_writer.h" -#include "src/stdio/printf_core/printf_main.h" -#include "src/stdio/printf_core/writer.h" +#include "src/stdio/printf_core/vfprintf_internal.h" #include -#include namespace __llvm_libc { @@ -28,12 +25,7 @@ // and pointer semantics, as well as handling // destruction automatically. va_end(vlist); - printf_core::Writer writer(reinterpret_cast(stream), - printf_core::write_to_file); - - int ret_val = printf_core::printf_main(&writer, format, args); - if (__llvm_libc::ferror(stream)) - return -1; + int ret_val = printf_core::vfprintf_internal(stream, format, args); return ret_val; } diff --git a/libc/src/stdio/printf.h b/libc/src/stdio/printf.h new file mode 100644 --- /dev/null +++ b/libc/src/stdio/printf.h @@ -0,0 +1,20 @@ +//===-- Implementation header of printf -------------------------*- C++ -*-===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_LIBC_SRC_STDIO_PRINTF_H +#define LLVM_LIBC_SRC_STDIO_PRINTF_H + +#include + +namespace __llvm_libc { + +int printf(const char *__restrict format, ...); + +} // namespace __llvm_libc + +#endif // LLVM_LIBC_SRC_STDIO_PRINTF_H diff --git a/libc/src/stdio/fprintf.cpp b/libc/src/stdio/printf.cpp copy from libc/src/stdio/fprintf.cpp copy to libc/src/stdio/printf.cpp --- a/libc/src/stdio/fprintf.cpp +++ b/libc/src/stdio/printf.cpp @@ -1,4 +1,4 @@ -//===-- Implementation of fprintf -------------------------------*- C++ -*-===// +//===-- Implementation of printf --------------------------------*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. @@ -6,34 +6,25 @@ // //===----------------------------------------------------------------------===// -#include "src/stdio/fprintf.h" +#include "src/stdio/printf.h" +#include "src/__support/File/file.h" #include "src/__support/arg_list.h" -#include "src/stdio/ferror.h" -#include "src/stdio/printf_core/file_writer.h" -#include "src/stdio/printf_core/printf_main.h" -#include "src/stdio/printf_core/writer.h" +#include "src/stdio/printf_core/vfprintf_internal.h" #include -#include namespace __llvm_libc { -LLVM_LIBC_FUNCTION(int, fprintf, - (::FILE *__restrict stream, const char *__restrict format, - ...)) { +LLVM_LIBC_FUNCTION(int, printf, (const char *__restrict format, ...)) { va_list vlist; va_start(vlist, format); internal::ArgList args(vlist); // This holder class allows for easier copying // and pointer semantics, as well as handling // destruction automatically. va_end(vlist); - printf_core::Writer writer(reinterpret_cast(stream), - printf_core::write_to_file); - - int ret_val = printf_core::printf_main(&writer, format, args); - if (__llvm_libc::ferror(stream)) - return -1; + int ret_val = printf_core::vfprintf_internal( + reinterpret_cast<::FILE *>(__llvm_libc::stdout), format, args); return ret_val; } diff --git a/libc/src/stdio/printf_core/CMakeLists.txt b/libc/src/stdio/printf_core/CMakeLists.txt --- a/libc/src/stdio/printf_core/CMakeLists.txt +++ b/libc/src/stdio/printf_core/CMakeLists.txt @@ -79,3 +79,19 @@ .core_structs libc.src.__support.arg_list ) + +add_object_library( + vfprintf_internal + SRCS + vfprintf_internal.cpp + HDRS + vfprintf_internal.h + DEPENDS + libc.include.stdio + libc.src.__support.File.file + libc.src.__support.File.platform_file + libc.src.__support.arg_list + libc.src.stdio.printf_core.printf_main + libc.src.stdio.printf_core.file_writer + libc.src.stdio.printf_core.writer +) diff --git a/libc/src/stdio/printf_core/file_writer.h b/libc/src/stdio/printf_core/file_writer.h --- a/libc/src/stdio/printf_core/file_writer.h +++ b/libc/src/stdio/printf_core/file_writer.h @@ -17,8 +17,8 @@ // write_to_file treats raw_pointer as a File and calls its write // function. -void write_to_file(void *raw_pointer, const char *__restrict to_write, - size_t len); +int write_to_file(void *raw_pointer, const char *__restrict to_write, + size_t len); } // namespace printf_core } // namespace __llvm_libc diff --git a/libc/src/stdio/printf_core/file_writer.cpp b/libc/src/stdio/printf_core/file_writer.cpp --- a/libc/src/stdio/printf_core/file_writer.cpp +++ b/libc/src/stdio/printf_core/file_writer.cpp @@ -13,10 +13,11 @@ namespace __llvm_libc { namespace printf_core { -void write_to_file(void *raw_pointer, const char *__restrict to_write, - size_t len) { +int write_to_file(void *raw_pointer, const char *__restrict to_write, + size_t len) { __llvm_libc::File *file = reinterpret_cast<__llvm_libc::File *>(raw_pointer); - file->write(to_write, len); + size_t written = file->write_unlocked(to_write, len); + return written == len ? 0 : -1; } } // namespace printf_core diff --git a/libc/src/stdio/printf_core/printf_main.cpp b/libc/src/stdio/printf_core/printf_main.cpp --- a/libc/src/stdio/printf_core/printf_main.cpp +++ b/libc/src/stdio/printf_core/printf_main.cpp @@ -29,6 +29,9 @@ convert(writer, cur_section); else writer->write(cur_section.raw_string, cur_section.raw_len); + + if (writer->get_chars_written() < 0) + break; } return writer->get_chars_written(); diff --git a/libc/src/stdio/printf_core/string_writer.h b/libc/src/stdio/printf_core/string_writer.h --- a/libc/src/stdio/printf_core/string_writer.h +++ b/libc/src/stdio/printf_core/string_writer.h @@ -36,8 +36,8 @@ // write_to_string treats raw_pointer as a StringWriter and calls its write // function. -void write_to_string(void *raw_pointer, const char *__restrict to_write, - size_t len); +int write_to_string(void *raw_pointer, const char *__restrict to_write, + size_t len); } // namespace printf_core } // namespace __llvm_libc diff --git a/libc/src/stdio/printf_core/string_writer.cpp b/libc/src/stdio/printf_core/string_writer.cpp --- a/libc/src/stdio/printf_core/string_writer.cpp +++ b/libc/src/stdio/printf_core/string_writer.cpp @@ -24,10 +24,11 @@ } } -void write_to_string(void *raw_pointer, const char *__restrict to_write, - size_t len) { +int write_to_string(void *raw_pointer, const char *__restrict to_write, + size_t len) { StringWriter *string_writer = reinterpret_cast(raw_pointer); string_writer->write(to_write, len); + return 0; } } // namespace printf_core diff --git a/libc/src/stdio/printf_core/vfprintf_internal.h b/libc/src/stdio/printf_core/vfprintf_internal.h new file mode 100644 --- /dev/null +++ b/libc/src/stdio/printf_core/vfprintf_internal.h @@ -0,0 +1,24 @@ +//===-- Internal implementation header of vfprintf --------------*- C++ -*-===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_LIBC_SRC_STDIO_PRINTF_CORE_VFPRINTF_INTERNAL_H +#define LLVM_LIBC_SRC_STDIO_PRINTF_CORE_VFPRINTF_INTERNAL_H + +#include "src/__support/arg_list.h" + +#include + +namespace __llvm_libc { +namespace printf_core { + +int vfprintf_internal(::FILE *__restrict stream, const char *__restrict format, + internal::ArgList args); +} // namespace printf_core +} // namespace __llvm_libc + +#endif // LLVM_LIBC_SRC_STDIO_PRINTF_CORE_VFPRINTF_INTERNAL_H diff --git a/libc/src/stdio/fprintf.cpp b/libc/src/stdio/printf_core/vfprintf_internal.cpp copy from libc/src/stdio/fprintf.cpp copy to libc/src/stdio/printf_core/vfprintf_internal.cpp --- a/libc/src/stdio/fprintf.cpp +++ b/libc/src/stdio/printf_core/vfprintf_internal.cpp @@ -1,4 +1,4 @@ -//===-- Implementation of fprintf -------------------------------*- C++ -*-===// +//===-- Internal implementation of vfprintf ---------------------*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. @@ -6,35 +6,31 @@ // //===----------------------------------------------------------------------===// -#include "src/stdio/fprintf.h" +#include "src/stdio/printf_core/vfprintf_internal.h" #include "src/__support/arg_list.h" -#include "src/stdio/ferror.h" #include "src/stdio/printf_core/file_writer.h" #include "src/stdio/printf_core/printf_main.h" #include "src/stdio/printf_core/writer.h" -#include #include namespace __llvm_libc { +namespace printf_core { -LLVM_LIBC_FUNCTION(int, fprintf, - (::FILE *__restrict stream, const char *__restrict format, - ...)) { - va_list vlist; - va_start(vlist, format); - internal::ArgList args(vlist); // This holder class allows for easier copying - // and pointer semantics, as well as handling - // destruction automatically. - va_end(vlist); +int vfprintf_internal(::FILE *__restrict stream, const char *__restrict format, + internal::ArgList args) { printf_core::Writer writer(reinterpret_cast(stream), printf_core::write_to_file); - + __llvm_libc::File *llvm_stream = + reinterpret_cast<__llvm_libc::File *>(stream); + llvm_stream->lock(); int ret_val = printf_core::printf_main(&writer, format, args); - if (__llvm_libc::ferror(stream)) - return -1; + if (llvm_stream->error_unlocked()) + ret_val = -1; + llvm_stream->unlock(); return ret_val; } +} // namespace printf_core } // namespace __llvm_libc diff --git a/libc/src/stdio/printf_core/writer.h b/libc/src/stdio/printf_core/writer.h --- a/libc/src/stdio/printf_core/writer.h +++ b/libc/src/stdio/printf_core/writer.h @@ -14,7 +14,7 @@ namespace __llvm_libc { namespace printf_core { -using WriteFunc = void (*)(void *, const char *__restrict, size_t); +using WriteFunc = int (*)(void *, const char *__restrict, size_t); class Writer final { // output is a pointer to the string or file that the writer is meant to write @@ -23,26 +23,28 @@ // raw_write is a function that, when called on output with a char* and // length, will copy the number of bytes equal to the length from the char* - // onto the end of output. + // onto the end of output. It should return a positive number on success, or a + // negative number on failure. Once a negative number is returned the value of + // chars_written will be set to it and it will not be updated unless another + // negative number is passed. WriteFunc raw_write; - unsigned long long chars_written = 0; + int chars_written = 0; public: Writer(void *init_output, WriteFunc init_raw_write) : output(init_output), raw_write(init_raw_write) {} // write will copy length bytes from new_string into output using - // raw_write, unless that would cause more bytes than max_length to be - // written. It always increments chars_written by length. + // raw_write. It increments chars_written by length unless raw_write returns a + // negative value. void write(const char *new_string, size_t length); - // write_chars will copy length copies of new_char into output using raw_write - // unless that would cause more bytes than max_length to be written. It always - // increments chars_written by length. + // write_chars will copy length copies of new_char into output using the write + // function and a statically sized buffer. This is primarily used for padding. void write_chars(char new_char, size_t length); - unsigned long long get_chars_written() { return chars_written; } + int get_chars_written() { return chars_written; } }; } // namespace printf_core diff --git a/libc/src/stdio/printf_core/writer.cpp b/libc/src/stdio/printf_core/writer.cpp --- a/libc/src/stdio/printf_core/writer.cpp +++ b/libc/src/stdio/printf_core/writer.cpp @@ -15,11 +15,13 @@ void Writer::write(const char *new_string, size_t length) { - raw_write(output, new_string, length); + int result = raw_write(output, new_string, length); - // chars_written tracks the number of chars that would have been written - // regardless of what the raw_write call does. - chars_written += length; + if (result < 0) { + chars_written = length; + } else if (chars_written >= 0) { + chars_written += length; + } } void Writer::write_chars(char new_char, size_t length) { diff --git a/libc/test/src/stdio/CMakeLists.txt b/libc/test/src/stdio/CMakeLists.txt --- a/libc/test/src/stdio/CMakeLists.txt +++ b/libc/test/src/stdio/CMakeLists.txt @@ -97,6 +97,17 @@ libc.src.stdio.fread ) + +add_libc_unittest( + printf_test + SUITE + libc_stdio_unittests + SRCS + printf_test.cpp + DEPENDS + libc.src.stdio.printf +) + add_subdirectory(printf_core) add_subdirectory(testdata) diff --git a/libc/test/src/stdio/printf_core/converter_test.cpp b/libc/test/src/stdio/printf_core/converter_test.cpp --- a/libc/test/src/stdio/printf_core/converter_test.cpp +++ b/libc/test/src/stdio/printf_core/converter_test.cpp @@ -37,7 +37,7 @@ str_writer.terminate(); ASSERT_STREQ(str, "abc"); - ASSERT_EQ(writer.get_chars_written(), 3ull); + ASSERT_EQ(writer.get_chars_written(), 3); } TEST_F(LlvmLibcPrintfConverterTest, PercentConversion) { @@ -51,7 +51,7 @@ str[1] = '\0'; ASSERT_STREQ(str, "%"); - ASSERT_EQ(writer.get_chars_written(), 1ull); + ASSERT_EQ(writer.get_chars_written(), 1); } TEST_F(LlvmLibcPrintfConverterTest, CharConversionSimple) { @@ -69,7 +69,7 @@ str_writer.terminate(); ASSERT_STREQ(str, "D"); - ASSERT_EQ(writer.get_chars_written(), 1ull); + ASSERT_EQ(writer.get_chars_written(), 1); } TEST_F(LlvmLibcPrintfConverterTest, CharConversionRightJustified) { @@ -84,7 +84,7 @@ str_writer.terminate(); ASSERT_STREQ(str, " E"); - ASSERT_EQ(writer.get_chars_written(), 4ull); + ASSERT_EQ(writer.get_chars_written(), 4); } TEST_F(LlvmLibcPrintfConverterTest, CharConversionLeftJustified) { @@ -101,7 +101,7 @@ str_writer.terminate(); ASSERT_STREQ(str, "F "); - ASSERT_EQ(writer.get_chars_written(), 4ull); + ASSERT_EQ(writer.get_chars_written(), 4); } TEST_F(LlvmLibcPrintfConverterTest, StringConversionSimple) { @@ -117,7 +117,7 @@ str_writer.terminate(); ASSERT_STREQ(str, "DEF"); - ASSERT_EQ(writer.get_chars_written(), 3ull); + ASSERT_EQ(writer.get_chars_written(), 3); } TEST_F(LlvmLibcPrintfConverterTest, StringConversionPrecisionHigh) { @@ -132,7 +132,7 @@ str_writer.terminate(); ASSERT_STREQ(str, "456"); - ASSERT_EQ(writer.get_chars_written(), 3ull); + ASSERT_EQ(writer.get_chars_written(), 3); } TEST_F(LlvmLibcPrintfConverterTest, StringConversionPrecisionLow) { @@ -147,7 +147,7 @@ str_writer.terminate(); ASSERT_STREQ(str, "xy"); - ASSERT_EQ(writer.get_chars_written(), 2ull); + ASSERT_EQ(writer.get_chars_written(), 2); } TEST_F(LlvmLibcPrintfConverterTest, StringConversionRightJustified) { @@ -162,7 +162,7 @@ str_writer.terminate(); ASSERT_STREQ(str, " 789"); - ASSERT_EQ(writer.get_chars_written(), 4ull); + ASSERT_EQ(writer.get_chars_written(), 4); } TEST_F(LlvmLibcPrintfConverterTest, StringConversionLeftJustified) { @@ -179,7 +179,7 @@ str_writer.terminate(); ASSERT_STREQ(str, "ghi "); - ASSERT_EQ(writer.get_chars_written(), 4ull); + ASSERT_EQ(writer.get_chars_written(), 4); } TEST_F(LlvmLibcPrintfConverterTest, IntConversionSimple) { @@ -193,5 +193,5 @@ str_writer.terminate(); ASSERT_STREQ(str, "12345"); - ASSERT_EQ(writer.get_chars_written(), 5ull); + ASSERT_EQ(writer.get_chars_written(), 5); } diff --git a/libc/test/src/stdio/printf_core/string_writer_test.cpp b/libc/test/src/stdio/printf_core/string_writer_test.cpp --- a/libc/test/src/stdio/printf_core/string_writer_test.cpp +++ b/libc/test/src/stdio/printf_core/string_writer_test.cpp @@ -36,7 +36,7 @@ str_writer.terminate(); ASSERT_STREQ("abc", str); - ASSERT_EQ(writer.get_chars_written(), 3ull); + ASSERT_EQ(writer.get_chars_written(), 3); } TEST(LlvmLibcPrintfStringWriterTest, WriteMultipleTimes) { @@ -52,7 +52,7 @@ str_writer.terminate(); ASSERT_STREQ("abcDEF123", str); - ASSERT_EQ(writer.get_chars_written(), 9ull); + ASSERT_EQ(writer.get_chars_written(), 9); } TEST(LlvmLibcPrintfStringWriterTest, WriteChars) { @@ -67,7 +67,7 @@ str_writer.terminate(); ASSERT_STREQ("aaa", str); - ASSERT_EQ(writer.get_chars_written(), 3ull); + ASSERT_EQ(writer.get_chars_written(), 3); } TEST(LlvmLibcPrintfStringWriterTest, WriteCharsMultipleTimes) { @@ -83,7 +83,7 @@ str_writer.terminate(); ASSERT_STREQ("aaaDDD111", str); - ASSERT_EQ(writer.get_chars_written(), 9ull); + ASSERT_EQ(writer.get_chars_written(), 9); } TEST(LlvmLibcPrintfStringWriterTest, WriteManyChars) { @@ -107,7 +107,7 @@ "ZZZZZZZZZZ" "ZZZZZZZZZ", str); - ASSERT_EQ(writer.get_chars_written(), 99ull); + ASSERT_EQ(writer.get_chars_written(), 99); } TEST(LlvmLibcPrintfStringWriterTest, MixedWrites) { @@ -124,7 +124,7 @@ str_writer.terminate(); ASSERT_STREQ("aaaDEF111456", str); - ASSERT_EQ(writer.get_chars_written(), 12ull); + ASSERT_EQ(writer.get_chars_written(), 12); } TEST(LlvmLibcPrintfStringWriterTest, WriteWithMaxLength) { @@ -138,7 +138,7 @@ str_writer.terminate(); ASSERT_STREQ("abcDEF1234", str); - ASSERT_EQ(writer.get_chars_written(), 12ull); + ASSERT_EQ(writer.get_chars_written(), 12); } TEST(LlvmLibcPrintfStringWriterTest, WriteCharsWithMaxLength) { @@ -153,7 +153,7 @@ str_writer.terminate(); ASSERT_STREQ("1111111111", str); - ASSERT_EQ(writer.get_chars_written(), 15ull); + ASSERT_EQ(writer.get_chars_written(), 15); } TEST(LlvmLibcPrintfStringWriterTest, MixedWriteWithMaxLength) { @@ -170,7 +170,7 @@ str_writer.terminate(); ASSERT_STREQ("aaaDEF1114", str); - ASSERT_EQ(writer.get_chars_written(), 12ull); + ASSERT_EQ(writer.get_chars_written(), 12); } TEST(LlvmLibcPrintfStringWriterTest, StringWithMaxLengthOne) { @@ -189,7 +189,7 @@ str_writer.terminate(); ASSERT_STREQ("", str); - ASSERT_EQ(writer.get_chars_written(), 12ull); + ASSERT_EQ(writer.get_chars_written(), 12); } TEST(LlvmLibcPrintfStringWriterTest, NullStringWithZeroMaxLength) { @@ -202,5 +202,5 @@ writer.write_chars('1', 3); writer.write("456", 3); - ASSERT_EQ(writer.get_chars_written(), 12ull); + ASSERT_EQ(writer.get_chars_written(), 12); } diff --git a/libc/test/src/stdio/printf_test.cpp b/libc/test/src/stdio/printf_test.cpp new file mode 100644 --- /dev/null +++ b/libc/test/src/stdio/printf_test.cpp @@ -0,0 +1,29 @@ +//===-- Unittests for printf ---------------------------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#include "src/stdio/printf.h" + +#include "utils/UnitTest/Test.h" + +TEST(LlvmLibcPrintfTest, PrintOut) { + int written; + + constexpr char simple[] = "A simple string with no conversions.\n"; + written = __llvm_libc::printf(simple); + EXPECT_EQ(written, static_cast(sizeof(simple) - 1)); + + constexpr char numbers[] = "1234567890\n"; + written = __llvm_libc::printf("%s", numbers); + EXPECT_EQ(written, static_cast(sizeof(numbers) - 1)); + + constexpr char format_more[] = "%s and more\n"; + constexpr char short_numbers[] = "1234"; + written = __llvm_libc::printf(format_more, short_numbers); + EXPECT_EQ(written, + static_cast(sizeof(format_more) + sizeof(short_numbers) - 4)); +}