console.h

Go to the documentation of this file.

//    MemoryAccessor - A tool for accessing /proc/PID/mem
//    Copyright (C) 2024  zloymish
//
//    This program is free software: you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    (at your option) any later version.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
#ifndef MEMORYACCESSOR_SRC_CONSOLE_H_
#define MEMORYACCESSOR_SRC_CONSOLE_H_
 
#include <array>
#include <cstdint>
#include <exception>
#include <string>
#include <vector>
 
#include "hexviewer.h"
#include "memoryaccessor.h"
#include "segmentinfo.h"
#include "tools.h"
 
class Console;
 
struct Command {
  using CommandFuncP = void (Console::*)(
      const Command &parent, const std::vector<std::string>
                                 &); 
 
  std::string name;           
  CommandFuncP func{nullptr}; 
  std::vector<std::array<std::string, 2>>
      description; 
};
 
class Console {
public:
  constexpr static int kCommandsNumber{
      9}; 
 
  explicit Console(MemoryAccessor &memory_accessor, HexViewer &hex_viewer,
                   Tools &tools) noexcept(false);
 
  Console(const Console &origin) = delete;
 
  Console(Console &&origin) = delete;
 
  Console &operator=(const Console &origin) = delete;
 
  Console &operator=(Console &&origin) = delete;
 
  ~Console() noexcept;
 
  void SetBufferSize(const size_t &buffer_size) { buffer_size_ = buffer_size; }
 
  void PrintNameVer() const noexcept;
  void Start() noexcept;
  void ReadStdin() noexcept;
  void HandleCommand(const std::string &line) noexcept;
 
  const std::string kProjectName{"MemoryAccessor"}; 
  const std::string kProjectVersion{"v1.0"};        
  const std::string kProjectDescription{
      "A command-line front-end for exploring virtual memory of a linux "
      "process "
      "by accessing /proc/PID/mem file."}; 
  const std::string kConsolePrefix{
      "(MemAcc)"}; 
 
  MemoryAccessor
      &memory_accessor_;  
  HexViewer &hex_viewer_; 
  Tools &tools_;          
 
  const Command kCommands[kCommandsNumber]{
      {"help", &Console::CommandHelp, {{"help", "Show help"}}},
      {"name",
       &Console::CommandName,
       {{"name name [pid_num]", "Search for PID by name and set PID if only 1 "
                                "PID found, or set PID number"},
        {"",
         "pid_num of found PIDs if pid_num is specified (starting from 0)."}}},
      {"pid",
       &Console::CommandPid,
       {{"pid PID", "Set PID and parse /proc/PID/maps."}}},
      {"maps",
       &Console::CommandMaps,
       {{"maps", "List memory segments found by parsing /proc/PID/maps."}}},
      {"view",
       &Console::CommandView,
       {{"view SEGMENT", "Print data of memory segment, where SEGMENT is its "
                         "\"maps\" number, or first"},
        {"", "with matching name."},
        {"-h", "show hex (if no -r specified)"},
        {"-r", "print raw data"},
        {"-f file", "output to file"}}},
      {"read",
       &Console::CommandRead,
       {{"read address amount", "Read amount bytes starting from address."},
        {"-h", "show hex (if no -r specified)"},
        {"-r", "print raw data"},
        {"-f file", "output to file"}}},
      {"write",
       &Console::CommandWrite,
       {{"write address amount string",
         "Write amount bytes of string to memory starting from address."},
        {"or", ""},
        {"write address amount -f file",
         "Write amount bytes from file to memory starting from address."}}},
      {"diff",
       &Console::CommandDiff,
       {{"diff length [replacement]",
         "Find difference in memory states by length and replace to string, if "
         "specified."}}},
      {"await",
       &Console::CommandAwait,
       {{"await process_name", "Wait for the process with matching name."},
        {"await -p pid", "Wait for the process with PID."}}},
  }; 
private:
  enum class Error0Arg {
    kPidNotSet,               
    kPidNotSetUnexpectably,   
    kErrCheckingPid,          
    kPrintErrCheckingProcess, 
    kPrintErrOpenMaps,        
    kPrintErrParseMaps,       
    kPrintErrOpenMem,         
    kPrintSegNotExist,        
    kPrintSegNoAccess,        
  };
 
  class WrapperException : public std::exception {
  public:
    WrapperException(uint8_t _return_code) : return_code(_return_code) {}
 
    uint8_t return_code; 
  private:
    virtual const char *what() const noexcept override {
      return "Wrapper exception";
    }
  };
 
  void PrintDescription(const Command &command, uint32_t left = 2,
                        uint32_t middle = 0) const noexcept;
  void ShowUsage(const Command &command) const noexcept;
  void PrintError0Arg(const Error0Arg &error) const noexcept;
  void PrintFileNotOpened(const std::string &path) const noexcept;
  void PrintFileFail(const std::string &path) const noexcept;
 
  void PrintSegment(const SegmentInfo &segmentInfo) const noexcept;
  void
  PrintSegments(const std::vector<SegmentInfo> &segment_infos) const noexcept;
 
  std::vector<std::string> ParseCmdline(std::string line) const noexcept;
 
  uint8_t ParseAddress(const std::string &s, size_t &result) const noexcept;
  uint8_t StoiWrapper(const std::string &s, int &result,
                      const std::string &name) const noexcept;
  uint8_t StoullWrapper(const std::string &s, uint64_t &result,
                        const std::string &name) const noexcept;
  uint8_t ParseMapsWrapper() const noexcept;
  uint8_t CheckPidWrapper() const noexcept;
  uint8_t CheckSegNumWrapper(const size_t &num) const noexcept;
  uint8_t ReadSegWrapper(char *dst, const size_t &num, size_t start = 0,
                         size_t amount = SIZE_MAX) const noexcept;
  uint8_t WriteSegWrapper(char *src, const size_t &num, size_t start = 0,
                          size_t amount = SIZE_MAX) const noexcept;
  uint8_t ReadWrapper(char *dst, size_t address, size_t amount,
                      size_t &done_amount) const noexcept;
  uint8_t WriteWrapper(char *src, size_t address, size_t amount,
                       size_t &done_amount) const noexcept;
 
  uint8_t DiffReadSeg(std::unique_ptr<char[]> &mem_dump,
                      const size_t &num) noexcept;
  void DiffCompare(const char *old_dump, const char *new_dump,
                   const size_t &o_offs, const size_t &n_offs, size_t amount,
                   size_t start_addr, const size_t &length,
                   const std::string &replacement) noexcept;
  uint8_t DiffOldNext(size_t &i, const size_t &old_segments_amount,
                      std::vector<std::unique_ptr<char[]>>::iterator &it,
                      std::vector<std::unique_ptr<char[]>> &full_dump) noexcept;
  uint8_t DiffNewNext(size_t &j,
                      std::vector<std::unique_ptr<char[]>>::iterator &it,
                      std::unique_ptr<char[]> &mem_dump,
                      std::vector<std::unique_ptr<char[]>> &full_dump) noexcept;
 
  void CommandHelp(const Command &parent,
                   const std::vector<std::string> &args) noexcept;
  void CommandName(const Command &parent,
                   const std::vector<std::string> &args) noexcept;
  void CommandPid(const Command &parent,
                  const std::vector<std::string> &args) noexcept;
  void CommandMaps(const Command &parent,
                   const std::vector<std::string> &args) noexcept;
  void CommandView(const Command &parent,
                   const std::vector<std::string> &args) noexcept;
  void CommandRead(const Command &parent,
                   const std::vector<std::string> &args) noexcept;
  void CommandWrite(const Command &parent,
                    const std::vector<std::string> &args) noexcept;
  void CommandDiff(const Command &parent,
                   const std::vector<std::string> &args) noexcept;
  void CommandAwait(const Command &parent,
                    const std::vector<std::string> &args) noexcept;
 
  static bool one_instance_created_; 
  const std::string kCheckSudoStr{
      "Check if you're running with \"sudo\"."}; 
 
  size_t buffer_size_{
      0x1000}; 
 
  bool seg_not_exist_msg_enabled_{
      true}; 
  bool seg_no_access_msg_enabled_{
      true}; 
};
 
#endif // MEMORYACCESSOR_SRC_CONSOLE_H_