summaryrefslogtreecommitdiff
path: root/AK/LogStream.h
blob: 9d6a0900bf6e574c3ddca00e3dcae0ed00bab2cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <AK/Format.h>
#include <AK/Forward.h>
#include <AK/Types.h>
#include <AK/kmalloc.h>
#include <AK/kstdio.h>

#if !defined(KERNEL)
#    include <AK/ScopedValueRollback.h>
#    include <AK/StringView.h>
#    include <errno.h>
#    include <unistd.h>
#endif

namespace AK {

class LogStream {
public:
    LogStream()
#if !defined(KERNEL)
        : m_errno_restorer(errno)
#endif
    {
    }
    virtual ~LogStream() = default;

    virtual void write(const char*, int) const = 0;

private:
#if !defined(KERNEL)
    ScopedValueRollback<int> m_errno_restorer;
#endif
};

class BufferedLogStream : public LogStream {
    mutable size_t m_size { 0 };
    mutable size_t m_capacity { 128 };
    union {
        mutable u8* m_buffer { nullptr };
        mutable u8 m_local_buffer[128];
    } u;

    void grow(size_t bytes_needed) const
    {
        size_t new_capacity = (m_size + bytes_needed + 0x7F) & ~0x7F;
        u8* new_data = static_cast<u8*>(kmalloc(new_capacity));
        if (m_capacity <= sizeof(u.m_local_buffer)) {
            __builtin_memcpy(new_data, u.m_local_buffer, m_size);
        } else if (u.m_buffer) {
            __builtin_memcpy(new_data, u.m_buffer, m_size);
            kfree(u.m_buffer);
        }
        u.m_buffer = new_data;
        m_capacity = new_capacity;
    }

protected:
    u8* data() const
    {
        if (m_capacity <= sizeof(u.m_local_buffer))
            return u.m_local_buffer;
        return u.m_buffer;
    }

    size_t size() const { return m_size; }

    bool empty() const { return m_size == 0; }

public:
    BufferedLogStream() = default;

    virtual ~BufferedLogStream() override
    {
        if (m_capacity > sizeof(u.m_local_buffer))
            kfree(u.m_buffer);
    }

    virtual void write(const char* str, int len) const override
    {
        size_t new_size = m_size + len;
        if (new_size > m_capacity)
            grow(len);
        __builtin_memcpy(data() + m_size, str, len);
        m_size = new_size;
    }
};

class DebugLogStream final : public BufferedLogStream {
public:
    DebugLogStream() = default;
    virtual ~DebugLogStream() override;

    // DebugLogStream only checks `enabled` and possibly generates output while the destructor runs.
    static void set_enabled(bool);
    static bool is_enabled();

private:
    static bool s_enabled;
};

#ifdef KERNEL
class KernelLogStream final : public BufferedLogStream {
public:
    KernelLogStream() = default;
    virtual ~KernelLogStream() override;
};
#endif

inline const LogStream& operator<<(const LogStream& stream, const char* value)
{
    if (!value)
        return stream << "(null)";
    int length = 0;
    const char* p = value;
    while (*(p++))
        ++length;
    stream.write(value, length);
    return stream;
}

const LogStream& operator<<(const LogStream&, const FlyString&);
const LogStream& operator<<(const LogStream&, const String&);
const LogStream& operator<<(const LogStream&, const StringView&);
const LogStream& operator<<(const LogStream&, int);
const LogStream& operator<<(const LogStream&, long);
const LogStream& operator<<(const LogStream&, unsigned);
const LogStream& operator<<(const LogStream&, long long);
const LogStream& operator<<(const LogStream&, unsigned long);
const LogStream& operator<<(const LogStream&, unsigned long long);

#if !defined(KERNEL)
const LogStream& operator<<(const LogStream&, double);
const LogStream& operator<<(const LogStream&, float);
#endif

template<typename T>
const LogStream& operator<<(const LogStream& stream, Span<T> span)
{
    return stream << "{ " << span.data() << ", " << span.size() << " }";
}

const LogStream& operator<<(const LogStream&, const void*);

inline const LogStream& operator<<(const LogStream& stream, char value)
{
    stream.write(&value, 1);
    return stream;
}

inline const LogStream& operator<<(const LogStream& stream, bool value)
{
    return stream << (value ? "true" : "false");
}

[[deprecated("Plase use dbgln in AK/Format.h instead.")]] DebugLogStream dbg();

#ifdef KERNEL
KernelLogStream klog();
#else
DebugLogStream klog();
#endif

void dump_bytes(ReadonlyBytes);

}

using AK::dbg;
using AK::klog;
using AK::LogStream;