/*
 * Copyright (c) 2017 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_LICENSE_HEADER_END@
 */


#ifndef Diagnostics_h
#define Diagnostics_h

#include <stdint.h>
#include <stdarg.h>
#include <string_view>
#include <TargetConditionals.h>

#if BUILDING_CACHE_BUILDER || BUILDING_UNIT_TESTS || BUILDING_CACHE_BUILDER_UNIT_TESTS
  #include <set>
  #include <string>
  #include <vector>
#endif

#if BUILDING_LD || BUILDING_UNIT_TESTS || BUILDING_SHARED_CACHE_LINKER || BUILDING_CACHE_BUILDER || BUILDING_CACHE_BUILDER_UNIT_TESTS
  #include "Error.h"
#endif

#include "Defines.h"
#include "va_list_wrap.h"

#if __has_feature(ptrauth_calls)
#include <ptrauth.h>
// Note this is a DB key (per-process data) and address authenticated
#define __ptrauth_dyld_diag __ptrauth(ptrauth_key_process_dependent_data, 1, 0)
#else
#define __ptrauth_dyld_diag
#endif

class VIS_HIDDEN Diagnostics
{
public:
                    Diagnostics();
                    ~Diagnostics();
                    Diagnostics(const Diagnostics&) = delete;
                    Diagnostics& operator=(const Diagnostics&) = delete;
                    Diagnostics(Diagnostics&&);
                    Diagnostics& operator=(Diagnostics&&);

    void            error(const char* format, ...)  __attribute__((format(printf, 2, 3)));
    void            error(const char* format, va_list_wrap vaWrap) __attribute__((format(printf, 2, 0)));
    void            appendError(const char* format, ...)  __attribute__((format(printf, 2, 3)));
#if BUILDING_CACHE_BUILDER || BUILDING_UNIT_TESTS || BUILDING_CACHE_BUILDER_UNIT_TESTS
                    Diagnostics(bool verbose);
                    Diagnostics(const std::string& prefix, bool verbose=false);

    void            warning(const char* format, ...)  __attribute__((format(printf, 2, 3)));
    void            verbose(const char* format, ...)  __attribute__((format(printf, 2, 3)));
    void            copy(const Diagnostics&);
#endif

    bool            hasError() const;
    bool            noError() const;
    void            clearError();
    void            assertNoError() const;
    bool            errorMessageContains(const char* subString) const;
    bool            empty() const;

#if BUILDING_CACHE_BUILDER || BUILDING_UNIT_TESTS || BUILDING_CACHE_BUILDER_UNIT_TESTS
    const std::string               prefix() const;
    std::string                     errorMessage() const;
    const char*                     errorMessageCStr() const;
    const std::set<std::string>     warnings() const;
    void                            clearWarnings();
#else
    const char*                     errorMessage() const;
    const char*                     errorMessageCStr() const { return errorMessage(); }
#endif

    std::string_view                errorMessageSV() const;

#if BUILDING_LD || BUILDING_UNIT_TESTS || BUILDING_SHARED_CACHE_LINKER || BUILDING_CACHE_BUILDER || BUILDING_CACHE_BUILDER_UNIT_TESTS
    mach_o::Error                   toError() const;
    void                            error(const mach_o::Error& err);
#endif

private:
#if TARGET_OS_EXCLAVEKIT
    char                     _strBuf[1024];
#else
    char* __ptrauth_dyld_diag _buffer = nullptr;
    uint32_t                  _bufferSize = 0;
    uint32_t                  _bufferUsed = 0;
#endif
#if BUILDING_CACHE_BUILDER || BUILDING_UNIT_TESTS || BUILDING_CACHE_BUILDER_UNIT_TESTS
    std::string              _prefix;
    std::set<std::string>    _warnings;
    bool                     _verbose = false;
#endif
};

#if BUILDING_CACHE_BUILDER || BUILDING_UNIT_TESTS || BUILDING_CACHE_BUILDER_UNIT_TESTS

class VIS_HIDDEN TimeRecorder
{
public:
    // Call pushTimedSection(), then mark events with recordTime. Call popTimedSection() to stop the current timing session.
    // This is stack-based, so you can start a sub-timer with pushTimedSection() / recordTime / recordTime... / popTimedSection()
    // inside a first timed section.
    // Call logTimings() to print everything.

    // Start a new timed section.
    void pushTimedSection();

    // Records the time taken since the last pushTimedSection() / recordTime() at the current level
    void recordTime(const char* format, ...)  __attribute__((format(printf, 2, 3)));

    // Stop the current timed section and pop back one level.
    void popTimedSection();

    void logTimings();
private:
    struct TimingEntry {
        uint64_t time;
        std::string logMessage;
        int depth;
    };

    std::vector<uint64_t> openTimings;
    std::vector<TimingEntry> timings;
};

#endif /* BUILDING_CACHE_BUILDER */

#endif // Diagnostics_h