/* * Copyright (c) 2020, the SerenityOS developers. * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #if defined(__serenity__) && !defined(KERNEL) # include #endif #ifdef KERNEL # include # include #else # include # include # include #endif namespace AK { class FormatParser : public GenericLexer { public: struct FormatSpecifier { StringView flags; size_t index; }; explicit FormatParser(StringView input); StringView consume_literal(); bool consume_number(size_t& value); bool consume_specifier(FormatSpecifier& specifier); bool consume_replacement_field(size_t& index); }; namespace { static constexpr size_t use_next_index = NumericLimits::max(); // The worst case is that we have the largest 64-bit value formatted as binary number, this would take // 65 bytes. Choosing a larger power of two won't hurt and is a bit of mitigation against out-of-bounds accesses. static constexpr size_t convert_unsigned_to_string(u64 value, Array& buffer, u8 base, bool upper_case) { VERIFY(base >= 2 && base <= 16); constexpr const char* lowercase_lookup = "0123456789abcdef"; constexpr const char* uppercase_lookup = "0123456789ABCDEF"; if (value == 0) { buffer[0] = '0'; return 1; } size_t used = 0; while (value > 0) { if (upper_case) buffer[used++] = uppercase_lookup[value % base]; else buffer[used++] = lowercase_lookup[value % base]; value /= base; } for (size_t i = 0; i < used / 2; ++i) swap(buffer[i], buffer[used - i - 1]); return used; } void vformat_impl(TypeErasedFormatParams& params, FormatBuilder& builder, FormatParser& parser) { const auto literal = parser.consume_literal(); builder.put_literal(literal); FormatParser::FormatSpecifier specifier; if (!parser.consume_specifier(specifier)) { VERIFY(parser.is_eof()); return; } if (specifier.index == use_next_index) specifier.index = params.take_next_index(); auto& parameter = params.parameters().at(specifier.index); FormatParser argparser { specifier.flags }; parameter.formatter(params, builder, argparser, parameter.value); vformat_impl(params, builder, parser); } } // namespace AK::{anonymous} FormatParser::FormatParser(StringView input) : GenericLexer(input) { } StringView FormatParser::consume_literal() { const auto begin = tell(); while (!is_eof()) { if (consume_specific("{{")) continue; if (consume_specific("}}")) continue; if (next_is(is_any_of("{}"))) return m_input.substring_view(begin, tell() - begin); consume(); } return m_input.substring_view(begin); } bool FormatParser::consume_number(size_t& value) { value = 0; bool consumed_at_least_one = false; while (next_is(is_ascii_digit)) { value *= 10; value += parse_ascii_digit(consume()); consumed_at_least_one = true; } return consumed_at_least_one; } bool FormatParser::consume_specifier(FormatSpecifier& specifier) { VERIFY(!next_is('}')); if (!consume_specific('{')) return false; if (!consume_number(specifier.index)) specifier.index = use_next_index; if (consume_specific(':')) { const auto begin = tell(); size_t level = 1; while (level > 0) { VERIFY(!is_eof()); if (consume_specific('{')) { ++level; continue; } if (consume_specific('}')) { --level; continue; } consume(); } specifier.flags = m_input.substring_view(begin, tell() - begin - 1); } else { if (!consume_specific('}')) VERIFY_NOT_REACHED(); specifier.flags = ""; } return true; } bool FormatParser::consume_replacement_field(size_t& index) { if (!consume_specific('{')) return false; if (!consume_number(index)) index = use_next_index; if (!consume_specific('}')) VERIFY_NOT_REACHED(); return true; } void FormatBuilder::put_padding(char fill, size_t amount) { for (size_t i = 0; i < amount; ++i) m_builder.append(fill); } void FormatBuilder::put_literal(StringView value) { for (size_t i = 0; i < value.length(); ++i) { m_builder.append(value[i]); if (value[i] == '{' || value[i] == '}') ++i; } } void FormatBuilder::put_string( StringView value, Align align, size_t min_width, size_t max_width, char fill) { const auto used_by_string = min(max_width, value.length()); const auto used_by_padding = max(min_width, used_by_string) - used_by_string; if (used_by_string < value.length()) value = value.substring_view(0, used_by_string); if (align == Align::Left || align == Align::Default) { m_builder.append(value); put_padding(fill, used_by_padding); } else if (align == Align::Center) { const auto used_by_left_padding = used_by_padding / 2; const auto used_by_right_padding = ceil_div(used_by_padding, 2); put_padding(fill, used_by_left_padding); m_builder.append(value); put_padding(fill, used_by_right_padding); } else if (align == Align::Right) { put_padding(fill, used_by_padding); m_builder.append(value); } } void FormatBuilder::put_u64( u64 value, u8 base, bool prefix, bool upper_case, bool zero_pad, Align align, size_t min_width, char fill, SignMode sign_mode, bool is_negative) { if (align == Align::Default) align = Align::Right; Array buffer; const auto used_by_digits = convert_unsigned_to_string(value, buffer, base, upper_case); size_t used_by_prefix = 0; if (align == Align::Right && zero_pad) { // We want String::formatted("{:#08x}", 32) to produce '0x00000020' instead of '0x000020'. This // behavior differs from both fmtlib and printf, but is more intuitive. used_by_prefix = 0; } else { if (is_negative || sign_mode != SignMode::OnlyIfNeeded) used_by_prefix += 1; if (prefix) { if (base == 8) used_by_prefix += 1; else if (base == 16) used_by_prefix += 2; else if (base == 2) used_by_prefix += 2; } } const auto used_by_field = used_by_prefix + used_by_digits; const auto used_by_padding = max(used_by_field, min_width) - used_by_field; const auto put_prefix = [&]() { if (is_negative) m_builder.append('-'); else if (sign_mode == SignMode::Always) m_builder.append('+'); else if (sign_mode == SignMode::Reserved) m_builder.append(' '); if (prefix) { if (base == 2) { if (upper_case) m_builder.append("0B"); else m_builder.append("0b"); } else if (base == 8) { m_builder.append("0"); } else if (base == 16) { if (upper_case) m_builder.append("0X"); else m_builder.append("0x"); } } }; const auto put_digits = [&]() { for (size_t i = 0; i < used_by_digits; ++i) m_builder.append(buffer[i]); }; if (align == Align::Left) { const auto used_by_right_padding = used_by_padding; put_prefix(); put_digits(); put_padding(fill, used_by_right_padding); } else if (align == Align::Center) { const auto used_by_left_padding = used_by_padding / 2; const auto used_by_right_padding = ceil_div(used_by_padding, 2); put_padding(fill, used_by_left_padding); put_prefix(); put_digits(); put_padding(fill, used_by_right_padding); } else if (align == Align::Right) { const auto used_by_left_padding = used_by_padding; if (zero_pad) { put_prefix(); put_padding('0', used_by_left_padding); put_digits(); } else { put_padding(fill, used_by_left_padding); put_prefix(); put_digits(); } } } void FormatBuilder::put_i64( i64 value, u8 base, bool prefix, bool upper_case, bool zero_pad, Align align, size_t min_width, char fill, SignMode sign_mode) { const auto is_negative = value < 0; value = is_negative ? -value : value; put_u64(static_cast(value), base, prefix, upper_case, zero_pad, align, min_width, fill, sign_mode, is_negative); } #ifndef KERNEL void FormatBuilder::put_f64( double value, u8 base, bool upper_case, bool zero_pad, Align align, size_t min_width, size_t precision, char fill, SignMode sign_mode) { StringBuilder string_builder; FormatBuilder format_builder { string_builder }; if (isnan(value) || isinf(value)) [[unlikely]] { if (value < 0.0) string_builder.append('-'); else if (sign_mode == SignMode::Always) string_builder.append('+'); else string_builder.append(' '); if (isnan(value)) string_builder.append(upper_case ? "NAN"sv : "nan"sv); else string_builder.append(upper_case ? "INF"sv : "inf"sv); format_builder.put_string(string_builder.string_view(), align, min_width, NumericLimits::max(), fill); return; } bool is_negative = value < 0.0; if (is_negative) value = -value; format_builder.put_u64(static_cast(value), base, false, upper_case, false, Align::Right, 0, ' ', sign_mode, is_negative); if (precision > 0) { // FIXME: This is a terrible approximation but doing it properly would be a lot of work. If someone is up for that, a good // place to start would be the following video from CppCon 2019: // https://youtu.be/4P_kbF0EbZM (Stephan T. Lavavej “Floating-Point : Making Your Code 10x Faster With C++17's Final Boss”) value -= static_cast(value); double epsilon = 0.5; for (size_t i = 0; i < precision; ++i) epsilon /= 10.0; size_t visible_precision = 0; for (; visible_precision < precision; ++visible_precision) { if (value - static_cast(value) < epsilon) break; value *= 10.0; epsilon *= 10.0; } if (zero_pad || visible_precision > 0) string_builder.append('.'); if (visible_precision > 0) format_builder.put_u64(static_cast(value), base, false, upper_case, true, Align::Right, visible_precision); if (zero_pad && (precision - visible_precision) > 0) format_builder.put_u64(0, base, false, false, true, Align::Right, precision - visible_precision); } put_string(string_builder.string_view(), align, min_width, NumericLimits::max(), fill); } void FormatBuilder::put_f80( long double value, u8 base, bool upper_case, Align align, size_t min_width, size_t precision, char fill, SignMode sign_mode) { StringBuilder string_builder; FormatBuilder format_builder { string_builder }; if (isnan(value) || isinf(value)) [[unlikely]] { if (value < 0.0l) string_builder.append('-'); else if (sign_mode == SignMode::Always) string_builder.append('+'); else string_builder.append(' '); if (isnan(value)) string_builder.append(upper_case ? "NAN"sv : "nan"sv); else string_builder.append(upper_case ? "INF"sv : "inf"sv); format_builder.put_string(string_builder.string_view(), align, min_width, NumericLimits::max(), fill); return; } bool is_negative = value < 0.0l; if (is_negative) value = -value; format_builder.put_u64(static_cast(value), base, false, upper_case, false, Align::Right, 0, ' ', sign_mode, is_negative); if (precision > 0) { // FIXME: This is a terrible approximation but doing it properly would be a lot of work. If someone is up for that, a good // place to start would be the following video from CppCon 2019: // https://youtu.be/4P_kbF0EbZM (Stephan T. Lavavej “Floating-Point : Making Your Code 10x Faster With C++17's Final Boss”) value -= static_cast(value); long double epsilon = 0.5l; for (size_t i = 0; i < precision; ++i) epsilon /= 10.0l; size_t visible_precision = 0; for (; visible_precision < precision; ++visible_precision) { if (value - static_cast(value) < epsilon) break; value *= 10.0l; epsilon *= 10.0l; } if (visible_precision > 0) { string_builder.append('.'); format_builder.put_u64(static_cast(value), base, false, upper_case, true, Align::Right, visible_precision); } } put_string(string_builder.string_view(), align, min_width, NumericLimits::max(), fill); } #endif void FormatBuilder::put_hexdump(ReadonlyBytes bytes, size_t width, char fill) { auto put_char_view = [&](auto i) { put_padding(fill, 4); for (size_t j = i - width; j < i; ++j) { auto ch = bytes[j]; m_builder.append(ch >= 32 && ch <= 127 ? ch : '.'); // silly hack } }; for (size_t i = 0; i < bytes.size(); ++i) { if (width > 0) { if (i % width == 0 && i) { put_char_view(i); put_literal("\n"sv); } } put_u64(bytes[i], 16, false, false, true, Align::Right, 2); } if (width > 0 && bytes.size() && bytes.size() % width == 0) put_char_view(bytes.size()); } void vformat(StringBuilder& builder, StringView fmtstr, TypeErasedFormatParams& params) { FormatBuilder fmtbuilder { builder }; FormatParser parser { fmtstr }; vformat_impl(params, fmtbuilder, parser); } void StandardFormatter::parse(TypeErasedFormatParams& params, FormatParser& parser) { if (StringView { "<^>" }.contains(parser.peek(1))) { VERIFY(!parser.next_is(is_any_of("{}"))); m_fill = parser.consume(); } if (parser.consume_specific('<')) m_align = FormatBuilder::Align::Left; else if (parser.consume_specific('^')) m_align = FormatBuilder::Align::Center; else if (parser.consume_specific('>')) m_align = FormatBuilder::Align::Right; if (parser.consume_specific('-')) m_sign_mode = FormatBuilder::SignMode::OnlyIfNeeded; else if (parser.consume_specific('+')) m_sign_mode = FormatBuilder::SignMode::Always; else if (parser.consume_specific(' ')) m_sign_mode = FormatBuilder::SignMode::Reserved; if (parser.consume_specific('#')) m_alternative_form = true; if (parser.consume_specific('0')) m_zero_pad = true; if (size_t index = 0; parser.consume_replacement_field(index)) { if (index == use_next_index) index = params.take_next_index(); m_width = params.parameters().at(index).to_size(); } else if (size_t width = 0; parser.consume_number(width)) { m_width = width; } if (parser.consume_specific('.')) { if (size_t index = 0; parser.consume_replacement_field(index)) { if (index == use_next_index) index = params.take_next_index(); m_precision = params.parameters().at(index).to_size(); } else if (size_t precision = 0; parser.consume_number(precision)) { m_precision = precision; } } if (parser.consume_specific('b')) m_mode = Mode::Binary; else if (parser.consume_specific('B')) m_mode = Mode::BinaryUppercase; else if (parser.consume_specific('d')) m_mode = Mode::Decimal; else if (parser.consume_specific('o')) m_mode = Mode::Octal; else if (parser.consume_specific('x')) m_mode = Mode::Hexadecimal; else if (parser.consume_specific('X')) m_mode = Mode::HexadecimalUppercase; else if (parser.consume_specific('c')) m_mode = Mode::Character; else if (parser.consume_specific('s')) m_mode = Mode::String; else if (parser.consume_specific('p')) m_mode = Mode::Pointer; else if (parser.consume_specific('f')) m_mode = Mode::Float; else if (parser.consume_specific('a')) m_mode = Mode::Hexfloat; else if (parser.consume_specific('A')) m_mode = Mode::HexfloatUppercase; else if (parser.consume_specific("hex-dump")) m_mode = Mode::HexDump; if (!parser.is_eof()) dbgln("{} did not consume '{}'", __PRETTY_FUNCTION__, parser.remaining()); VERIFY(parser.is_eof()); } void Formatter::format(FormatBuilder& builder, StringView value) { if (m_sign_mode != FormatBuilder::SignMode::Default) VERIFY_NOT_REACHED(); if (m_alternative_form) VERIFY_NOT_REACHED(); if (m_zero_pad) VERIFY_NOT_REACHED(); if (m_mode != Mode::Default && m_mode != Mode::String && m_mode != Mode::Character && m_mode != Mode::HexDump) VERIFY_NOT_REACHED(); m_width = m_width.value_or(0); m_precision = m_precision.value_or(NumericLimits::max()); if (m_mode == Mode::HexDump) builder.put_hexdump(value.bytes(), m_width.value(), m_fill); else builder.put_string(value, m_align, m_width.value(), m_precision.value(), m_fill); } void Formatter::vformat(FormatBuilder& builder, StringView fmtstr, TypeErasedFormatParams& params) { StringBuilder string_builder; AK::vformat(string_builder, fmtstr, params); return Formatter::format(builder, string_builder.string_view()); } template void Formatter>::Type>::format(FormatBuilder& builder, T value) { if (m_mode == Mode::Character) { // FIXME: We just support ASCII for now, in the future maybe unicode? VERIFY(value >= 0 && value <= 127); m_mode = Mode::String; Formatter formatter { *this }; return formatter.format(builder, StringView { reinterpret_cast(&value), 1 }); } if (m_precision.has_value()) VERIFY_NOT_REACHED(); if (m_mode == Mode::Pointer) { if (m_sign_mode != FormatBuilder::SignMode::Default) VERIFY_NOT_REACHED(); if (m_align != FormatBuilder::Align::Default) VERIFY_NOT_REACHED(); if (m_alternative_form) VERIFY_NOT_REACHED(); if (m_width.has_value()) VERIFY_NOT_REACHED(); m_mode = Mode::Hexadecimal; m_alternative_form = true; m_width = 2 * sizeof(void*); m_zero_pad = true; } u8 base = 0; bool upper_case = false; if (m_mode == Mode::Binary) { base = 2; } else if (m_mode == Mode::BinaryUppercase) { base = 2; upper_case = true; } else if (m_mode == Mode::Octal) { base = 8; } else if (m_mode == Mode::Decimal || m_mode == Mode::Default) { base = 10; } else if (m_mode == Mode::Hexadecimal) { base = 16; } else if (m_mode == Mode::HexadecimalUppercase) { base = 16; upper_case = true; } else if (m_mode == Mode::HexDump) { m_width = m_width.value_or(32); builder.put_hexdump({ &value, sizeof(value) }, m_width.value(), m_fill); return; } else { VERIFY_NOT_REACHED(); } m_width = m_width.value_or(0); if constexpr (IsSame, T>) builder.put_u64(value, base, m_alternative_form, upper_case, m_zero_pad, m_align, m_width.value(), m_fill, m_sign_mode); else builder.put_i64(value, base, m_alternative_form, upper_case, m_zero_pad, m_align, m_width.value(), m_fill, m_sign_mode); } void Formatter::format(FormatBuilder& builder, char value) { if (m_mode == Mode::Binary || m_mode == Mode::BinaryUppercase || m_mode == Mode::Decimal || m_mode == Mode::Octal || m_mode == Mode::Hexadecimal || m_mode == Mode::HexadecimalUppercase) { // Trick: signed char != char. (Sometimes weird features are actually helpful.) Formatter formatter { *this }; return formatter.format(builder, static_cast(value)); } else { Formatter formatter { *this }; return formatter.format(builder, { &value, 1 }); } } void Formatter::format(FormatBuilder& builder, wchar_t value) { if (m_mode == Mode::Binary || m_mode == Mode::BinaryUppercase || m_mode == Mode::Decimal || m_mode == Mode::Octal || m_mode == Mode::Hexadecimal || m_mode == Mode::HexadecimalUppercase) { Formatter formatter { *this }; return formatter.format(builder, static_cast(value)); } else { StringBuilder codepoint; codepoint.append_code_point(value); Formatter formatter { *this }; return formatter.format(builder, codepoint.to_string()); } } void Formatter::format(FormatBuilder& builder, bool value) { if (m_mode == Mode::Binary || m_mode == Mode::BinaryUppercase || m_mode == Mode::Decimal || m_mode == Mode::Octal || m_mode == Mode::Hexadecimal || m_mode == Mode::HexadecimalUppercase) { Formatter formatter { *this }; return formatter.format(builder, static_cast(value)); } else if (m_mode == Mode::HexDump) { return builder.put_hexdump({ &value, sizeof(value) }, m_width.value_or(32), m_fill); } else { Formatter formatter { *this }; return formatter.format(builder, value ? "true" : "false"); } } #ifndef KERNEL void Formatter::format(FormatBuilder& builder, long double value) { u8 base; bool upper_case; if (m_mode == Mode::Default || m_mode == Mode::Float) { base = 10; upper_case = false; } else if (m_mode == Mode::Hexfloat) { base = 16; upper_case = false; } else if (m_mode == Mode::HexfloatUppercase) { base = 16; upper_case = true; } else { VERIFY_NOT_REACHED(); } m_width = m_width.value_or(0); m_precision = m_precision.value_or(6); builder.put_f80(value, base, upper_case, m_align, m_width.value(), m_precision.value(), m_fill, m_sign_mode); } void Formatter::format(FormatBuilder& builder, double value) { u8 base; bool upper_case; if (m_mode == Mode::Default || m_mode == Mode::Float) { base = 10; upper_case = false; } else if (m_mode == Mode::Hexfloat) { base = 16; upper_case = false; } else if (m_mode == Mode::HexfloatUppercase) { base = 16; upper_case = true; } else { VERIFY_NOT_REACHED(); } m_width = m_width.value_or(0); m_precision = m_precision.value_or(6); builder.put_f64(value, base, upper_case, m_zero_pad, m_align, m_width.value(), m_precision.value(), m_fill, m_sign_mode); } void Formatter::format(FormatBuilder& builder, float value) { Formatter formatter { *this }; formatter.format(builder, value); } #endif #ifndef KERNEL void vout(FILE* file, StringView fmtstr, TypeErasedFormatParams& params, bool newline) { StringBuilder builder; vformat(builder, fmtstr, params); if (newline) builder.append('\n'); const auto string = builder.string_view(); const auto retval = ::fwrite(string.characters_without_null_termination(), 1, string.length(), file); if (static_cast(retval) != string.length()) { auto error = ferror(file); dbgln("vout() failed ({} written out of {}), error was {} ({})", retval, string.length(), error, strerror(error)); } } #endif static bool is_debug_enabled = true; void set_debug_enabled(bool value) { is_debug_enabled = value; } void vdbgln(StringView fmtstr, TypeErasedFormatParams& params) { if (!is_debug_enabled) return; StringBuilder builder; #ifdef __serenity__ # ifdef KERNEL if (Kernel::Processor::is_initialized()) { if (Kernel::Thread::current()) { auto& thread = *Kernel::Thread::current(); builder.appendff("\033[34;1m[#{} {}({}:{})]\033[0m: ", Kernel::Processor::current_id(), thread.process().name(), thread.pid().value(), thread.tid().value()); } else { builder.appendff("\033[34;1m[#{} Kernel]\033[0m: ", Kernel::Processor::current_id()); } } else { builder.appendff("\033[34;1m[Kernel]\033[0m: "); } # else static TriState got_process_name = TriState::Unknown; static char process_name_buffer[256]; if (got_process_name == TriState::Unknown) { if (get_process_name(process_name_buffer, sizeof(process_name_buffer)) == 0) got_process_name = TriState::True; else got_process_name = TriState::False; } if (got_process_name == TriState::True) builder.appendff("\033[33;1m{}({}:{})\033[0m: ", process_name_buffer, getpid(), gettid()); # endif #endif vformat(builder, fmtstr, params); builder.append('\n'); const auto string = builder.string_view(); #ifdef __serenity__ # ifdef KERNEL if (!Kernel::Processor::is_initialized()) { kernelearlyputstr(string.characters_without_null_termination(), string.length()); return; } # endif #endif dbgputstr(string.characters_without_null_termination(), string.length()); } #ifdef KERNEL void vdmesgln(StringView fmtstr, TypeErasedFormatParams& params) { StringBuilder builder; # ifdef __serenity__ if (Kernel::Processor::is_initialized() && Kernel::Thread::current()) { auto& thread = *Kernel::Thread::current(); builder.appendff("\033[34;1m[{}({}:{})]\033[0m: ", thread.process().name(), thread.pid().value(), thread.tid().value()); } else { builder.appendff("\033[34;1m[Kernel]\033[0m: "); } # endif vformat(builder, fmtstr, params); builder.append('\n'); const auto string = builder.string_view(); kernelputstr(string.characters_without_null_termination(), string.length()); } void v_critical_dmesgln(StringView fmtstr, TypeErasedFormatParams& params) { // FIXME: Try to avoid memory allocations further to prevent faulting // at OOM conditions. StringBuilder builder; # ifdef __serenity__ if (Kernel::Processor::is_initialized() && Kernel::Thread::current()) { auto& thread = *Kernel::Thread::current(); builder.appendff("[{}({}:{})]: ", thread.process().name(), thread.pid().value(), thread.tid().value()); } else { builder.appendff("[Kernel]: "); } # endif vformat(builder, fmtstr, params); builder.append('\n'); const auto string = builder.string_view(); kernelcriticalputstr(string.characters_without_null_termination(), string.length()); } #endif template struct Formatter; template struct Formatter; template struct Formatter; template struct Formatter; template struct Formatter; template struct Formatter; template struct Formatter; template struct Formatter; template struct Formatter; template struct Formatter; } // namespace AK