DevFs.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef DEVFS_H
#define DEVFS_H
 
#include "pedigree/kernel/Log.h"
#include "pedigree/kernel/graphics/Graphics.h"
#include "pedigree/kernel/graphics/GraphicsService.h"
#include "pedigree/kernel/machine/InputManager.h"
#include "pedigree/kernel/process/Mutex.h"
#include "pedigree/kernel/utilities/ExtensibleBitmap.h"
#include "pedigree/kernel/utilities/Vector.h"
 
#include "modules/subsys/posix/PsAuxFile.h"
#include "modules/subsys/posix/VirtualTerminal.h"
#include "modules/system/vfs/Directory.h"
#include "modules/system/vfs/File.h"
#include "modules/system/vfs/Filesystem.h"
 
class DevFs;
class DevFsDirectory;
class Serial;
 
extern DevFs* g_pDevFs;
 
class RandomFile : public File {
 public:
  RandomFile(String str, size_t inode, Filesystem* pParentFS, File* pParent)
      : File(str, 0, 0, 0, inode, pParentFS, 0, pParent) {
    setPermissionsOnly(FILE_UR | FILE_UW | FILE_GR | FILE_GW | FILE_OR | FILE_OW);
    setUidOnly(0);
    setGidOnly(0);
  }
  ~RandomFile() {}
 
  virtual uint64_t readBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                bool bCanBlock = true);
  virtual uint64_t writeBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                 bool bCanBlock = true);
  bool supports(size_t command) const override;
  int command(size_t command, void* buffer) override;
 
 private:
  virtual bool isBytewise() const {
    return true;
  }
};
 
class NullFile : public File {
 public:
  NullFile(String str, size_t inode, Filesystem* pParentFS, File* pParentNode)
      : File(str, 0, 0, 0, inode, pParentFS, 0, pParentNode) {
    setPermissionsOnly(FILE_UR | FILE_UW | FILE_GR | FILE_GW | FILE_OR | FILE_OW);
    setUidOnly(0);
    setGidOnly(0);
  }
  ~NullFile() {}
 
  virtual uint64_t readBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                bool bCanBlock = true);
  virtual uint64_t writeBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                 bool bCanBlock = true);
 
 private:
  virtual bool isBytewise() const {
    return true;
  }
};
 
class ZeroFile : public File {
 public:
  ZeroFile(String str, size_t inode, Filesystem* pParentFS, File* pParentNode)
      : File(str, 0, 0, 0, inode, pParentFS, 0, pParentNode) {
    setPermissionsOnly(FILE_UR | FILE_UW | FILE_GR | FILE_GW | FILE_OR | FILE_OW);
    setUidOnly(0);
    setGidOnly(0);
  }
  ~ZeroFile() {}
 
  virtual uint64_t readBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                bool bCanBlock = true);
  virtual uint64_t writeBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                 bool bCanBlock = true);
 
 private:
  virtual bool isBytewise() const {
    return true;
  }
};
 
class SerialFile : public File {
 public:
  SerialFile(String str, size_t inode, Filesystem* pParentFS, File* pParent, Serial* serial);
  ~SerialFile() {}
 
  virtual uint64_t readBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                bool bCanBlock = true);
  virtual uint64_t writeBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                 bool bCanBlock = true);
  virtual int select(bool bWriting = false, int timeout = 0);
 
 private:
  Serial* m_Serial;
 
  virtual bool isBytewise() const {
    return true;
  }
};
 
class PtmxFile : public File {
 public:
  PtmxFile(String str, size_t inode, Filesystem* pParentFS, File* pParent,
           DevFsDirectory* m_pPtsDirectory, uint32_t slavePermissions = 0333,
           bool callerOwns = false);
  ~PtmxFile();
 
  virtual uint64_t readBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                bool bCanBlock = true);
  virtual uint64_t writeBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                 bool bCanBlock = true);
 
  // override open() to correctly handle returning a master and creating
  // the associated slave.
  virtual File* open();
  bool isCharacterDevice() const override {
    return true;
  }
  uint64_t deviceNumber() const override {
    return 0x0502;
  }
 
 private:
  ExtensibleBitmap m_Terminals;
  DevFsDirectory* m_pPtsDirectory;
  Mutex m_Lock;
  Vector<File*> m_Masters;
  uint32_t m_SlavePermissions;
  bool m_CallerOwns;
 
  virtual bool isBytewise() const {
    return true;
  }
};
 
class RtcFile : public File {
 public:
  RtcFile(size_t inode, Filesystem* pParentFS, File* pParentNode)
      : File(String("rtc"), 0, 0, 0, inode, pParentFS, 0, pParentNode) {
    setPermissionsOnly(FILE_UR | FILE_UW | FILE_GR | FILE_GW | FILE_OR);
    setUidOnly(0);
    setGidOnly(0);
  }
  ~RtcFile() {}
 
  virtual uint64_t readBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                bool bCanBlock = true);
  virtual uint64_t writeBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                 bool bCanBlock = true);
 
  virtual bool supports(const size_t command) const;
  virtual int command(const size_t command, void* buffer);
 
 private:
  virtual bool isBytewise() const {
    return true;
  }
};
 
class FramebufferFile : public File {
 public:
  FramebufferFile(String str, size_t inode, Filesystem* pParentFS, File* pParentNode);
  ~FramebufferFile();
 
  bool initialise();
 
  virtual uintptr_t readBlock(uint64_t location);
  virtual physical_uintptr_t getPhysicalPage(size_t offset);
  bool isDirectPhysicalMapping() const override {
    return true;
  }
  void returnPhysicalPage(size_t offset) override;
 
  virtual bool supports(const size_t command) const;
  virtual int command(const size_t command, void* buffer);
 
 
 private:
  GraphicsService::GraphicsParameters* m_pGraphicsParameters;
 
  bool m_bTextMode;
  size_t m_nDepth;
  uint32_t m_LinuxPalette[256];
};
 
class Tty0File : public File {
 public:
  Tty0File(String str, size_t inode, Filesystem* pParentFS, File* pParent, DevFs* devfs);
  ~Tty0File();
 
  virtual uint64_t readBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                bool bCanBlock = true);
  virtual uint64_t writeBytewise(uint64_t location, uint64_t size, uintptr_t buffer,
                                 bool bCanBlock = true);
 
  // override open() to correctly handle returning a master and creating
  // the associated slave.
  virtual File* open();
 
 private:
  DevFs* m_pDevFs;
 
  virtual bool isBytewise() const {
    return true;
  }
};
 
class MemFile : public File {
 public:
  MemFile(String name, size_t inode, Filesystem* pParentFS, File* pParentNode)
      : File(name, 0, 0, 0, inode, pParentFS, 0, pParentNode) {
    setPermissionsOnly(FILE_UR | FILE_UW | FILE_GR | FILE_GW | FILE_OR | FILE_OW);
    setUidOnly(0);
    setGidOnly(0);
  }
  ~MemFile() {}
 
  virtual physical_uintptr_t getPhysicalPage(size_t offset);
  bool isDirectPhysicalMapping() const override {
    return true;
  }
  virtual void returnPhysicalPage(size_t offset);
};
 
class DevFsDirectory : public Directory {
 public:
  DevFsDirectory(String name, Time::Timestamp accessedTime, Time::Timestamp modifiedTime,
                 Time::Timestamp creationTime, uintptr_t inode, class Filesystem* pFs, size_t size,
                 File* pParent)
      : Directory(name, accessedTime, modifiedTime, creationTime, inode, pFs, size, pParent) {}
 
  virtual ~DevFsDirectory();
 
  bool addEntry(String name, File* pFile) {
    return addDirectoryEntry(name, pFile);
  }
};
 
class DevFs : public Filesystem {
 public:
  SyncStatus sync() override {
    return SyncStatus::Success;
  }
 
  DevFs()
      : m_pRoot(0), m_CttySelector(nullptr), m_Serial(nullptr), m_VtManager(0), m_pPsAuxFile(0) {}
 
  virtual ~DevFs();
 
  virtual bool initialise(Disk* pDisk);
 
  virtual File* getRoot() const {
    return m_pRoot;
  }
  virtual const String& getVolumeLabel() const {
    static String devfsLabel("dev");
    return devfsLabel;
  }
 
  virtual size_t getNextInode();
  virtual void revertInode();
 
  bool isControllingTerminalSelector(const File* file) const {
    return file && file == m_CttySelector;
  }
 
  void handleInput(InputManager::InputNotification& in);
 
  VirtualTerminalManager& getTerminalManager() {
    return *m_VtManager;
  }
 
 protected:
  virtual bool createFile(File* parent, const String& filename, uint32_t mask) {
    return false;
  }
  virtual bool createDirectory(File* parent, const String& filename, uint32_t mask) {
    return false;
  }
  virtual bool createSymlink(File* parent, const String& filename, const String& value) {
    return false;
  }
  virtual bool removeNode(File*, const String&, File*) {
    return false;
  }
 
 private:
  DevFs(const DevFs&);
  DevFs& operator=(const DevFs&);
 
  DevFsDirectory* m_pRoot;
  File* m_CttySelector;
  SerialFile* m_Serial;
 
  size_t m_NextInode;
 
  VirtualTerminalManager* m_VtManager;
 
  PsAuxFile* m_pPsAuxFile;
};
 
#endif