llvm-project/lldb/tools/lldb-perf/darwin/sketch/sketch.cpp

//===-- sketch.cpp ----------------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#include <CoreFoundation/CoreFoundation.h>

#include "lldb-perf/lib/Timer.h"
#include "lldb-perf/lib/Metric.h"
#include "lldb-perf/lib/Measurement.h"
#include "lldb-perf/lib/TestCase.h"
#include "lldb-perf/lib/Xcode.h"

#include <iostream>
#include <unistd.h>
#include <fstream>
#include <getopt.h>

using namespace lldb_perf;

class SketchTest : public TestCase
{
public:
    SketchTest () :
        m_fetch_frames_measurement ([this] () -> void
            {
                Xcode::FetchFrames (GetProcess(),false,false);
            }, "fetch-frames", "time to dump backtrace for every frame in every thread"),
        m_file_line_bp_measurement([this] (const char* file, uint32_t line) -> void
            {
                Xcode::CreateFileLineBreakpoint(GetTarget(), file, line);
            }, "file-line-bkpt", "time to set a breakpoint given a file and line"),
        m_fetch_modules_measurement ([this] () -> void
            {
                Xcode::FetchModules(GetTarget());
            }, "fetch-modules", "time to get info for all modules in the process"),
        m_fetch_vars_measurement([this] (int depth) -> void
            {
                SBProcess process (GetProcess());
                auto threads_count = process.GetNumThreads();
                for (size_t thread_num = 0; thread_num < threads_count; thread_num++)
                {
                    SBThread thread(process.GetThreadAtIndex(thread_num));
                    SBFrame frame(thread.GetFrameAtIndex(0));
                    Xcode::FetchVariables(frame,depth,GetVerbose());
                }
            }, "fetch-vars", "time to dump variables for the topmost frame in every thread"),
        m_run_expr_measurement([this] (SBFrame frame, const char* expr) -> void
            {
                SBValue value(frame.EvaluateExpression(expr, lldb::eDynamicCanRunTarget));
                Xcode::FetchVariable (value, 0, GetVerbose());
            }, "run-expr", "time to evaluate an expression and display the result")
    {}
    
    virtual
    ~SketchTest ()
    {
    }
    
    virtual bool
	Setup (int argc, const char** argv)
    {
        //SetVerbose(true);
        m_app_path.assign(argv[1]);
        m_doc_path.assign(argv[2]);
        m_out_path.assign(argv[3]);
        TestCase::Setup(argc,argv);
        m_target = m_debugger.CreateTarget(m_app_path.c_str());
        const char* file_arg = m_doc_path.c_str(); 
        const char* persist_arg = "-ApplePersistenceIgnoreState";
        const char* persist_skip = "YES";
        const char* empty = nullptr;
        const char* args[] = {file_arg,persist_arg,persist_skip,empty};
        SBLaunchInfo launch_info (args);
        m_file_line_bp_measurement("SKTDocument.m",245);
        m_file_line_bp_measurement("SKTDocument.m",283);
        m_file_line_bp_measurement("SKTText.m",326);
        return Launch (launch_info);
    }
    
    void
    DoTest ()
    {
        m_fetch_frames_measurement();
        m_fetch_modules_measurement();
        m_fetch_vars_measurement(1);
    }
    
	virtual void
	TestStep (int counter, ActionWanted &next_action)
    {
        switch (counter)
        {
        case 0:
            {
                DoTest ();
                m_file_line_bp_measurement("SKTDocument.m",254);
                next_action.Continue();
            }
            break;
                
        case 1:
            {
                DoTest ();
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"properties");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"[properties description]");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"typeName");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"data");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"[data description]");
                next_action.Continue();
            }
            break;

        case 2:
            {
                DoTest ();
                next_action.Continue();
            }
            break;

        case 3:
            {
                DoTest ();
                next_action.StepOver(m_thread);
            }
            break;

        case 4:
            {
                DoTest ();
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"layoutManager");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"contents");
                next_action.StepOver(m_thread);
            }
            break;
        
        case 5:
            {
                DoTest ();
                next_action.StepOver(m_thread);
            }
            break;

        case 6:
            {
                DoTest ();
                next_action.StepOver(m_thread);
            }
            break;

        case 7:
            {
                DoTest ();
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"@\"an NSString\"");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"[(id)@\"an NSString\" description]");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"@[@1,@2,@3]");
                next_action.StepOut(m_thread);
            }
            break;

        case 8:
            {
                DoTest ();
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"[graphics description]");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"[selectionIndexes description]");
                m_run_expr_measurement(m_thread.GetFrameAtIndex(0),"(BOOL)NSIntersectsRect(rect, graphicDrawingBounds)");
                next_action.Kill();
            }
            break;
        
        default:
            {
                next_action.Kill();
            }
            break;
        }
    }
    
    virtual void
    WriteResults (Results &results)
    {
        m_fetch_frames_measurement.WriteAverageValue(results);
        m_file_line_bp_measurement.WriteAverageValue(results);
        m_fetch_modules_measurement.WriteAverageValue(results);
        m_fetch_vars_measurement.WriteAverageValue(results);
        m_run_expr_measurement.WriteAverageValue(results);
        results.Write(m_out_path.c_str());
    }
    
    void
    SetExecutablePath (const char* str)
    {
        if (str)
            m_app_path.assign(str);
    }
    
    const char*
    GetExecutablePath ()
    {
        if (m_app_path.empty())
            return NULL;
        return m_app_path.c_str();
    }
    
    void
    SetDocumentPath (const char* str)
    {
        if (str)
            m_doc_path.assign(str);
    }
    
    const char*
    GetDocumentPath ()
    {
        if (m_doc_path.empty())
            return NULL;
        return m_doc_path.c_str();
    }

    
    void
    SetResultFilePath (const char* str)
    {
        if (str)
            m_out_path.assign(str);
    }
    
    const char*
    GetResultFilePath ()
    {
        if (m_out_path.empty())
            return NULL;
        return m_out_path.c_str();
    }
    
private:
    Measurement<lldb_perf::TimeGauge, std::function<void()>> m_fetch_frames_measurement;
    Measurement<lldb_perf::TimeGauge, std::function<void(const char*, uint32_t)>> m_file_line_bp_measurement;
    Measurement<lldb_perf::TimeGauge, std::function<void()>> m_fetch_modules_measurement;
    Measurement<lldb_perf::TimeGauge, std::function<void(int)>> m_fetch_vars_measurement;
    Measurement<lldb_perf::TimeGauge, std::function<void(SBFrame, const char*)>> m_run_expr_measurement;
    
    std::string m_app_path;
    std::string m_doc_path;
    std::string m_out_path;
};

struct Options
{
    std::string sketch_path;
    std::string foobar_path;
    std::string out_file;
    bool verbose;
    bool error;
    bool print_help;
    
    Options() :
    verbose (false),
    error (false),
    print_help (false)
    {
    }
};

static struct option g_long_options[] = {
    { "verbose",    no_argument,            NULL, 'v' },
    { "sketch",     required_argument,      NULL, 'c' },
    { "foobar",     required_argument,      NULL, 'f' },
    { "out-file",   required_argument,      NULL, 'o' },
    { NULL,         0,                      NULL,  0  }
};


std::string
GetShortOptionString (struct option *long_options)
{
    std::string option_string;
    for (int i = 0; long_options[i].name != NULL; ++i)
    {
        if (long_options[i].flag == NULL)
        {
            option_string.push_back ((char) long_options[i].val);
            switch (long_options[i].has_arg)
            {
                default:
                case no_argument:
                    break;
                case required_argument:
                    option_string.push_back (':');
                    break;
                case optional_argument:
                    option_string.append (2, ':');
                    break;
            }
        }
    }
    return option_string;
}

int main(int argc, const char * argv[])
{
    
    // Prepare for & make calls to getopt_long.
    
    SketchTest test;
    
    std::string short_option_string (GetShortOptionString(g_long_options));
    
    Options option_data;
    bool done = false;
    
#if __GLIBC__
    optind = 0;
#else
    optreset = 1;
    optind = 1;
#endif
    while (!done)
    {
        int long_options_index = -1;
        const int short_option = ::getopt_long_only (argc,
                                                     const_cast<char **>(argv),
                                                     short_option_string.c_str(),
                                                     g_long_options,
                                                     &long_options_index);
        
        switch (short_option)
        {
            case 0:
                // Already handled
                break;
                
            case -1:
                done = true;
                break;
                
            case '?':
                option_data.print_help = true;
                break;
                
            case 'h':
                option_data.print_help = true;
                break;
                
            case 'v':
                option_data.verbose = true;
                break;
                
            case 'c':
            {
                SBFileSpec file(optarg);
                if (file.Exists())
                    test.SetExecutablePath(optarg);
                else
                    fprintf(stderr, "error: file specified in --sketch (-c) option doesn't exist: '%s'\n", optarg);
            }
                break;
                
            case 'f':
            {
                SBFileSpec file(optarg);
                if (file.Exists())
                    test.SetDocumentPath(optarg);
                else
                    fprintf(stderr, "error: file specified in --foobar (-f) option doesn't exist: '%s'\n", optarg);
            }
                break;
                
            case 'o':
                test.SetResultFilePath(optarg);
                break;
                
            default:
                option_data.error = true;
                option_data.print_help = true;
                fprintf (stderr, "error: unrecognized option %c\n", short_option);
                break;
        }
    }
    
    
    if (test.GetExecutablePath() == NULL)
    {
        // --sketch is mandatory
        option_data.print_help = true;
        option_data.error = true;
        fprintf (stderr, "error: the '--sketch=PATH' option is mandatory\n");
    }
    
    if (test.GetDocumentPath() == NULL)
    {
        // --foobar is mandatory
        option_data.print_help = true;
        option_data.error = true;
        fprintf (stderr, "error: the '--foobar=PATH' option is mandatory\n");
    }
    
    if (option_data.print_help)
    {
        puts(R"(
             NAME
             lldb_perf_sketch -- a tool that measures LLDB peformance while debugging sketch.
             
             SYNOPSIS
             lldb_perf_sketch --sketch=PATH --foobar=PATH [--out-file=PATH --verbose]
             
             DESCRIPTION
             Runs a set of static timing and memory tasks against sketch and outputs results
             to a plist file.
             )");
    }
    if (option_data.error)
    {
        exit(1);
    }
    
    // Update argc and argv after parsing options
    argc -= optind;
    argv += optind;
    
    test.SetVerbose(option_data.verbose);
    TestCase::Run(test, argc, argv);
    return 0;
}