FileOperationsMixin.h

//
// Copyright (c) 2014-present, Facebook, Inc.
// All rights reserved.
//
// This source code is licensed under the University of Illinois/NCSA Open
// Source License found in the LICENSE file in the root directory of this
// source tree. An additional grant of patent rights can be found in the
// PATENTS file in the same directory.
//
 
#pragma once
 
#include "DebugServer2/GDBRemote/DummySessionDelegateImpl.h"
#include "DebugServer2/Host/File.h"
#include "DebugServer2/Host/ProcessSpawner.h"
#include "DebugServer2/Target/Process.h"
#include "DebugServer2/Target/Thread.h"
 
#include <utility>
 
namespace ds2 {
namespace GDBRemote {
 
template <typename T> class FileOperationsMixin : public T {
protected:
  std::unordered_map<int, Host::File> _openFiles;
 
public:
  template <typename... Args>
  explicit FileOperationsMixin(Args &&... args)
      : T(std::forward<Args>(args)...) {}
 
private:
  // vFile paths are frequently relative (e.g. a bare filename an inferior
  // writes into its own working directory); unlike qPlatform_shell, the
  // vFile packets carry no separate working-directory field, so ds2 has to
  // apply the platform session's own configured working directory itself.
  // This has to stay session-local rather than mutating ds2's actual
  // process cwd: platform mode serves each connected client on its own
  // thread with its own session (see PlatformMain in Sources/main.cpp), and
  // the process cwd is shared state across all of them.
  std::string resolvePath(Session &session, std::string const &path) const;
 
protected:
  ErrorCode onFileOpen(Session &session, std::string const &path,
                       OpenFlags flags, uint32_t mode, int &fd) override;
  ErrorCode onFileClose(Session &session, int fd) override;
  ErrorCode onFileRead(Session &session, int fd, uint64_t &count,
                       uint64_t offset, ByteVector &buffer) override;
  ErrorCode onFileWrite(Session &session, int fd, uint64_t offset,
                        const ByteVector &buffer, uint64_t &nwritten) override;
 
protected:
  ErrorCode onFileCreateDirectory(Session &session, std::string const &path,
                                  uint32_t mode) override;
 
protected:
  ErrorCode onFileExists(Session &session, std::string const &path) override;
  ErrorCode onFileGetSize(Session &session, std::string const &path,
                          uint64_t &size) override;
  ErrorCode onFileGetMode(Session &session, std::string const &path,
                          uint32_t &mode) const override;
  ErrorCode onFileFstat(Session &session, int fd, ByteVector &buffer) const override;
  ErrorCode onFileRemove(Session &session, std::string const &path) override;
 
protected:
  ErrorCode onFileSetPermissions(Session &session, std::string const &path,
                                 uint32_t mode) override;
  ErrorCode onQueryModuleInfo(Session &session, std::string &path,
                              std::string &triple,
                              ModuleInfo &info) const override;
 
#if 0
    // more F packets:
    // https://sourceware.org/gdb/onlinedocs/gdb/List-of-Supported-Calls.html#List-of-Supported-Calls
    virtual ErrorCode onGetCurrentTime(Session &session, TimeValue &tv);
 
    virtual ErrorCode onFileIsATTY(Session &session, int fd);
    virtual ErrorCode onFileRename(Session &session,
            std::string const &oldPath, std::string const &newPath);
 
    virtual ErrorCode onFileGetStat(Session &session, std::string const &path,
            FileStat &stat);
    virtual ErrorCode onFileGetStat(Session &session, int fd,
            FileStat &stat);
 
    virtual ErrorCode onFileSeek(Session &session, int fd,
            int64_t offset, int whence, int64_t &newOffset);
#endif
};
} // namespace GDBRemote
} // namespace ds2
 
#include "../Sources/GDBRemote/Mixins/FileOperationsMixin.hpp"