fixing cmake for rename of license file

Javid Habibi · Javid Habibi · commit 82ccfe299d71 · 2020-07-16T16:46:18.000-07:00
bumping up version # for release

Update README.md

Adding build status badge
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,8 +2,8 @@ cmake_minimum_required (VERSION 3.13)
 project (procmon)
 
 # Set the project version number.
-set (procmon_VERSION_MAJOR 0)
-set (procmon_VERSION_MINOR 1)
+set (procmon_VERSION_MAJOR 1)
+set (procmon_VERSION_MINOR 0)
 set (procmon_VERSION_PATCH 0)
 
 # make ncurses a requirement
@@ -108,7 +108,7 @@ set(CPACK_PACKAGE_VERSION_PATCH "${procmon_VERSION_PATCH}")
 set(AZDO_BUILD_ID "999999")
 
 # setup license and readme for package
-SET(CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/LICENSE.txt)
+SET(CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/LICENSE)
 SET(CPACK_RESOURCE_FILE_README ${PROJECT_SOURCE_DIR}/README.md)
 
 # setup CPACK RPM Variables
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Process Monitor for Linux (Preview)
+# Process Monitor for Linux (Preview) [![Build Status](https://oss-sysinternals.visualstudio.com/Procmon%20for%20Linux/_apis/build/status/microsoft.ProcMon-for-Linux?branchName=main)](https://oss-sysinternals.visualstudio.com/Procmon%20for%20Linux/_build/latest?definitionId=18&branchName=main)
 Process Monitor (Procmon) is a Linux reimagining of the classic Procmon tool from the Sysinternals suite of tools for Windows.  Procmon provides a convenient and efficient way for Linux developers to trace the syscall activity on the system.  
 
 ![Procmon in use](procmon.gif "Procmon in use")
@@ -13,7 +13,7 @@ Process Monitor (Procmon) is a Linux reimagining of the classic Procmon tool fro
  
 
 ## Install Procmon
-Checkout our [install instructions](INSTALL.md) for ditribution specific steps to install Procmon.
+Checkout our [install instructions](INSTALL.md) for distribution specific steps to install Procmon.
 
 ## Building Procmon from source
 
@@ -105,4 +105,4 @@ Please see also our [Code of Conduct](CODE_OF_CONDUCT.md).
 # License
 Copyright (c) Microsoft Corporation. All rights reserved.
 
-Licensed under the MIT License.
+Licensed under the MIT License.
diff --git a/procmon.1 b/procmon.1
@@ -1,10 +1,13 @@
 .\" Manpage for procmon.
-.TH man 8 "04/22/2020" "0.9" "procmon manpage"
+.TH man 8 "07/16/2020" "0.1" "procmon manpage"
 .SH NAME
 procmon \- syscall tracing diagnostics tool
 .SH SYNOPSIS
 procmon [OPTIONS...]
-      -h          Prints this help screen
-      -p/--pids   Comma separated list of process ids to monitor
+      -h                       Prints this help screen
+      -p/--pids                Comma separated list of process ids to monitor
+      -e/--events              Comma separated list of system calls to monitor
+      -c/--collect [FILEPATH]  Option to start Procmon in a headless mode
+      -f/--file FILEPATH       Open a Procmon trace file
 .SH DESCRIPTION
 Procmon is a Linux reimagining of the classic Procmon tool from the Sysinternals suite of tools for Windows. Procmon provides a convenient and efficient way for Linux developers to trace the syscall activity on the system.
diff --git a/procmon.gif b/procmon.gif
diff --git a/src/common/cancellable_message_queue.h b/src/common/cancellable_message_queue.h
@@ -21,12 +21,11 @@ class CancellableMessageQueue
     std::mutex              writeLock;
     std::mutex              readLock;
     std::condition_variable readCondition;
-    // TODO: should this be atomic?
     std::atomic<bool> cancelled = false;
 
     std::queue<T> leftQueue;
     std::queue<T> rightQueue;
-    // TODO: Should these be atomic pointers instead?
+
     std::queue<T> *currentWriteQueue = &leftQueue;
     std::queue<T> *currentReadQueue = &rightQueue;
 
diff --git a/src/common/cli_utils.cpp b/src/common/cli_utils.cpp
@@ -11,14 +11,12 @@ namespace CLIUtils
         // re-enable cursor before exiting Procmon
         system("setterm -cursor on");
         
-        // TODO: something better?
         exit(-1);
     }
 
     // Prints usage string to terminal
     void DisplayUsage(bool shouldExit)
     {
-        // TODO
         std::cout << "procmon [OPTIONS...]" << std::endl;
         std::cout << "   OPTIONS" << std::endl;
         std::cout << "      -h/--help                Prints this help screen" << std::endl;
diff --git a/src/common/cli_utils.h b/src/common/cli_utils.h
@@ -19,7 +19,6 @@ namespace CLIUtils
     {
         if (arg == NULL)
         {
-            // TODO: real error logging 
             std::cerr << "ERROR: The argument '" << argName << "' cannot be null." << std::endl << std::endl;
             DisplayUsage(true);
         }
diff --git a/src/common/stack_trace.h b/src/common/stack_trace.h
@@ -17,8 +17,6 @@ struct StackTrace
 
     StackTrace() {}
 
-    // TODO use better serialization
-    // TODO throw exception on null/empty stack to serialize
     std::string Serialize()
     {
         std::string ret;
@@ -32,7 +30,6 @@ struct StackTrace
         return ret;
     }
 
-    // TODO throw exception on null/empty stack trace to deserialize
     void Inflate(std::string blob) 
     {
         std::string token;
diff --git a/src/configuration/procmon_configuration.cpp b/src/configuration/procmon_configuration.cpp
@@ -22,7 +22,6 @@ void ProcmonConfiguration::HandlePidArgs(char *pidArgs)
         }
         catch(const std::exception& e)
         {
-            // TODO: Actual error handling
             std::cerr << "ProcmonConfiguration::Invalid pid specified - " << e.what() << '\n';
             CLIUtils::FastExit();
         }
@@ -38,7 +37,6 @@ void ProcmonConfiguration::HandleStorageArgs(char *storageArgs)
     }
     else
     {
-        // TODO: actual error handling...
         std::cerr << "ProcmonConfiguration::\"" << storageArgs << "\" is not a valid storage engine" << std::endl;
         CLIUtils::FastExit();
     }
@@ -108,17 +106,14 @@ ProcmonConfiguration::ProcmonConfiguration(int argc, char *argv[])
                 CLIUtils::DisplayUsage(true);
                 break;
             case 'p':
-                //CLIUtils::ProtectArgNotNull(optarg, "pids");
                 HandlePidArgs(optarg);
                 break;
 
             case 's':
-                //CLIUtils::ProtectArgNotNull(optarg, "storageEngine");
                 HandleStorageArgs(optarg);
                 break;
 
             case 'e':
-                //CLIUtils::ProtectArgNotNull(optarg, "events");
                 HandleEventArgs(optarg);
                 break;
 
@@ -186,7 +181,7 @@ ProcmonConfiguration::ProcmonConfiguration(int argc, char *argv[])
     _tracerEngine->AddEvent(events);
     _tracerEngine->AddPids(pids);
 
-    // TODO dynamically handle this based on architecture rather then current limit of x86_64
+    // List of all syscalls that contain pointer params
     pointerSyscalls = ::SyscallSchema::Utils::Linux64PointerSycalls;
 }
 
diff --git a/src/configuration/procmon_configuration.h b/src/configuration/procmon_configuration.h
@@ -31,7 +31,6 @@ struct ProcmonArgs
     std::vector<pid_t> pids;
     std::vector<Event> events;
     StorageProxy::StorageEngineType storageEngineType;
-    // Other args
 };
 
 // Should only be created once.  Pass around using
@@ -61,11 +60,7 @@ class ProcmonConfiguration : public ProcmonArgs
     std::string ConvertEpocTime(time_t time);
 
 public:
-    // TODO: What does every configuration need to have
-    // TODO: How do we map CLI args to fields here
-
-    // Initializes the configuration handling args 
-    // and creating necessary resources.
+    // Initializes the configuration handling args and creating necessary resources.
     ProcmonConfiguration(int argc, char *argv[]);
 
     // Getters & Setters
diff --git a/src/display/column.cpp b/src/display/column.cpp
@@ -47,7 +47,6 @@ void Column::addLine(std::string value)
     this->currentLine++;
 }
 
-// TODO account for resizing columns by users i.e. use x param
 int Column::resize(int height, int width, int x)
 {
     this->height = height;
@@ -96,7 +95,6 @@ void Column::redrawColumn()
     }
 }
 
-// TODO: implement move logic once click support is implimented
 void Column::moveColumn(int x)
 {
     this->x = x;
diff --git a/src/display/event_formatter.cpp b/src/display/event_formatter.cpp
@@ -91,7 +91,6 @@ std::string EventFormatter::DecodeArguments(ITelemetry event)
     std::vector<struct SyscallSchema::SyscallSchema>& schema = config->GetSchema();
 
     // Find the schema item
-    // TODO: We have to be smarted how we store the Syscall schema. Rather than a vector of SyscallSchema entries key off of the syscall ID for faster lookup. 
     int index = FindSyscall(event.syscall);
     SyscallSchema::SyscallSchema item = schema[index];
 
@@ -175,9 +174,6 @@ std::string EventFormatter::DecodeArguments(ITelemetry event)
 
         args+="  ";
     }
-    
-    // Once we complete the decoding of the arguments we can free the source buffer
-    // free(lineData.arguments); <--- I am going to leave this line here for a later conversation point with Mario
 
     // now that we have the argument string for detail view we need to santize it for ASCII control characters
     for(int i = 0; i < args.length(); i++)
diff --git a/src/display/screen.cpp b/src/display/screen.cpp
@@ -12,9 +12,6 @@
 #include <thread>
 #include <set>
 
-// TODO setup color theme management
-// TODO utilize column map to allow more easy customizability of visible columns
-
 Screen::Screen()
 {
     totalLines = 0;
@@ -46,8 +43,7 @@ void Screen::InitializeFormatters()
 void Screen::initScreen(std::shared_ptr<ProcmonConfiguration> config)
 {
     configPtr = config;
-    // TODO investigate automatic scrolling for a smoother UX  i.e. scrollok()
-
+    
     InitializeFormatters();
 
     root = initscr();           // start curses mode
@@ -81,7 +77,6 @@ void Screen::initScreen(std::shared_ptr<ProcmonConfiguration> config)
 
     LOG(INFO) << "ScreenH:" << screenH << "ScreenW:" << screenW << "Column Height:" << columnHeight;
 
-    // TODO harden UI to detect if terminal supports colors and exit appropriately
     // start initializing UI components
     initHeader();
     initFooter();
@@ -601,7 +596,7 @@ void Screen::shutdownScreen()
 
 int Screen::getUserInput()
 {
-    return wgetch(headerWin);       // TODO investigate this to make sure it is dependable vs getch redrawing over all windows
+    return wgetch(headerWin);
 }
 
 void Screen::initColors()
@@ -934,7 +929,6 @@ void Screen::scrollDown()
         // page down to scroll to next page if the current page is full
         if(totalEvents == totalLines)
         {
-            // TODO in the state machine refactor of the UI redo this logic
             int oldPage = currentPage;
             pageDown();
 
@@ -1072,7 +1066,6 @@ std::string Screen::DecodeArguments(ITelemetry event)
     std::vector<struct SyscallSchema::SyscallSchema>& schema = config->GetSchema();
 
     // Find the schema item
-    // TODO: We have to be smarted how we store the Syscall schema. Rather than a vector of SyscallSchema entries key off of the syscall ID for faster lookup. 
     int index = FindSyscall(event.syscall);
     SyscallSchema::SyscallSchema item = schema[index];
 
@@ -1156,10 +1149,6 @@ std::string Screen::DecodeArguments(ITelemetry event)
 
         args+="  ";
     }
-    
-    // Once we complete the decoding of the arguments we can free the source buffer
-    // free(lineData.arguments); <--- I am going to leave this line here for a later conversation point with Mario
-
     return args;
 }
 
@@ -1255,8 +1244,6 @@ void Screen::resize()
     // get new terminal size
     getmaxyx(stdscr, screenH, screenW);
 
-    // TODO error check for minimum terminal size needed
-
     // calculate column height for initial screen size
     columnHeight = screenH - HEADER_HEIGHT - FOOTER_HEIGHT;
 
@@ -1596,7 +1583,6 @@ void Screen::closeHelpView()
 }
 
 
-// TODO abstract all these views out to their own objects
 void Screen::showDetailView()
 {
     int y = 1;
@@ -1806,16 +1792,8 @@ void Screen::handleMouseEvent(MEVENT* event)
                 setLineColor(currentLine, LINE_COLOR);
                 currentLine = event->y - pidColumn->getY();
                 setLineColor(currentLine, HIGHLIGHT_COLOR);
-
-                // was this a double click?
-                if(event->bstate == BUTTON1_DOUBLE_CLICKED)
-                {
-                    // TODO open up detail view and display information on specific event for a double click
-                    LOG(INFO) << "Double click at Y: " << event->y;
-                }
             }
             break;
-        // TODO is there anything we can do for a right click?
 
         default:
             LOG(INFO) << "Unknown mouse click";
diff --git a/src/display/screen_configuration.h b/src/display/screen_configuration.h
@@ -9,11 +9,6 @@
 #include <ncurses.h>
 #include <math.h>
 
-/*
-* TODO:
-* - manage import/export current screen config
-* - default color management setup
-*/
 class ScreenConfiguration
 {
     public:
diff --git a/src/procmon.cpp b/src/procmon.cpp
@@ -22,12 +22,11 @@ int main(int argc, char *argv[])
 
     /*
     * Turn off cursor for shell. Note this has to be done before EBPF spins up.
-    * This is due to a conflict that leads to the consumer thread dieing when the sytem
+    * This is due to a conflict that leads to the consumer thread dieing when the system
     * function is executed.
     */
     system("setterm -cursor off");
 
-    // TODO properly configure logger rather then this basic config
     // Configure logging
     el::Loggers::addFlag(el::LoggingFlag::HierarchicalLogging);
     el::Loggers::addFlag(el::LoggingFlag::AutoSpacing);
@@ -41,7 +40,6 @@ int main(int argc, char *argv[])
     LOG(INFO) << "Tracing " << config->events.size() << " system calls";
 
     // Configure logging
-    // TODO integrate into ProcmonConfiguration
     el::Configurations defaultConf;
     defaultConf.setToDefault();
 
diff --git a/src/storage/storage_proxy.h b/src/storage/storage_proxy.h
@@ -40,7 +40,6 @@ class StorageProxy
         case StorageEngineType::Sql:
             return new Sqlite3StorageEngine();
         default:
-            // TODO: handle this error better...
             return new MockStorageEngine();
         }
     };
diff --git a/src/storage/test_sqlite3_storage_engine.cpp b/src/storage/test_sqlite3_storage_engine.cpp
@@ -27,7 +27,6 @@ static std::vector<pid_t> pidRange(pid_t start, pid_t end)
 
 static bool telemetryMatches(ITelemetry first, ITelemetry second)
 {
-    // Todo(Jon): Need to add something for stack trace parameter once that becomes clear.
     return first.comm == second.comm && first.syscall == second.syscall &&
     first.pid == second.pid && first.processName == second.processName;
 }
diff --git a/src/tracer/ebpf/ebpf_tracer_engine.cpp b/src/tracer/ebpf/ebpf_tracer_engine.cpp
diff --git a/src/tracer/ebpf/raw_ebpf_event.h b/src/tracer/ebpf/raw_ebpf_event.h
diff --git a/src/tracer/tracer_engine.h b/src/tracer/tracer_engine.h

Original file line number	Diff line number	Diff line change
`@@ -11,14 +11,12 @@ namespace CLIUtils`
`11`	`11`	`// re-enable cursor before exiting Procmon`
`12`	`12`	`system("setterm -cursor on");`
`13`	`13`
`14`		`- // TODO: something better?`
`15`	`14`	`exit(-1);`
`16`	`15`	`}`
`17`	`16`
`18`	`17`	`// Prints usage string to terminal`
`19`	`18`	`void DisplayUsage(bool shouldExit)`
`20`	`19`	`{`
`21`		`- // TODO`
`22`	`20`	`std::cout << "procmon [OPTIONS...]" << std::endl;`
`23`	`21`	`std::cout << " OPTIONS" << std::endl;`
`24`	`22`	`std::cout << " -h/--help Prints this help screen" << std::endl;`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@ namespace CLIUtils`
`19`	`19`	`{`
`20`	`20`	`if (arg == NULL)`
`21`	`21`	`{`
`22`		`- // TODO: real error logging`
`23`	`22`	`std::cerr << "ERROR: The argument '" << argName << "' cannot be null." << std::endl << std::endl;`
`24`	`23`	`DisplayUsage(true);`
`25`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,6 @@ struct StackTrace`
`17`	`17`
`18`	`18`	`StackTrace() {}`
`19`	`19`
`20`		`- // TODO use better serialization`
`21`		`- // TODO throw exception on null/empty stack to serialize`
`22`	`20`	`std::string Serialize()`
`23`	`21`	`{`
`24`	`22`	`std::string ret;`
`@@ -32,7 +30,6 @@ struct StackTrace`
`32`	`30`	`return ret;`
`33`	`31`	`}`
`34`	`32`
`35`		`- // TODO throw exception on null/empty stack trace to deserialize`
`36`	`33`	`void Inflate(std::string blob)`
`37`	`34`	`{`
`38`	`35`	`std::string token;`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ void ProcmonConfiguration::HandlePidArgs(char *pidArgs)`
`22`	`22`	`}`
`23`	`23`	`catch(const std::exception& e)`
`24`	`24`	`{`
`25`		`- // TODO: Actual error handling`
`26`	`25`	`std::cerr << "ProcmonConfiguration::Invalid pid specified - " << e.what() << '\n';`
`27`	`26`	`CLIUtils::FastExit();`
`28`	`27`	`}`
`@@ -38,7 +37,6 @@ void ProcmonConfiguration::HandleStorageArgs(char *storageArgs)`
`38`	`37`	`}`
`39`	`38`	`else`
`40`	`39`	`{`
`41`		`- // TODO: actual error handling...`
`42`	`40`	`std::cerr << "ProcmonConfiguration::\"" << storageArgs << "\" is not a valid storage engine" << std::endl;`
`43`	`41`	`CLIUtils::FastExit();`
`44`	`42`	`}`
`@@ -108,17 +106,14 @@ ProcmonConfiguration::ProcmonConfiguration(int argc, char *argv[])`
`108`	`106`	`CLIUtils::DisplayUsage(true);`
`109`	`107`	`break;`
`110`	`108`	`case 'p':`
`111`		`- //CLIUtils::ProtectArgNotNull(optarg, "pids");`
`112`	`109`	`HandlePidArgs(optarg);`
`113`	`110`	`break;`
`114`	`111`
`115`	`112`	`case 's':`
`116`		`- //CLIUtils::ProtectArgNotNull(optarg, "storageEngine");`
`117`	`113`	`HandleStorageArgs(optarg);`
`118`	`114`	`break;`
`119`	`115`
`120`	`116`	`case 'e':`
`121`		`- //CLIUtils::ProtectArgNotNull(optarg, "events");`
`122`	`117`	`HandleEventArgs(optarg);`
`123`	`118`	`break;`
`124`	`119`
`@@ -186,7 +181,7 @@ ProcmonConfiguration::ProcmonConfiguration(int argc, char *argv[])`
`186`	`181`	`_tracerEngine->AddEvent(events);`
`187`	`182`	`_tracerEngine->AddPids(pids);`
`188`	`183`
`189`		`- // TODO dynamically handle this based on architecture rather then current limit of x86_64`
	`184`	`+ // List of all syscalls that contain pointer params`
`190`	`185`	`pointerSyscalls = ::SyscallSchema::Utils::Linux64PointerSycalls;`
`191`	`186`	`}`
`192`	`187`