LoDisk.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 LODISK_H
#define LODISK_H
 
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/Disk.h"
#include "pedigree/kernel/process/Mutex.h"
#include "pedigree/kernel/processor/MemoryRegion.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/Cache.h"
#include "pedigree/kernel/utilities/String.h"
 
#include "modules/system/vfs/File.h"
 
 
class EXPORTED_PUBLIC FileDisk : public Disk {
 public:
  enum AccessType {
    RamOnly = 0,
 
    Standard
  };
 
  FileDisk() = delete;
  FileDisk(String file, AccessType mode = Standard);
  virtual ~FileDisk();
 
  virtual void getName(String& str) {
    if (m_pFile)
      str = m_pFile->getName();
    else
      str = String("FileDisk");
  }
 
  bool initialise();
 
  virtual BufferView read(uint64_t location);
  virtual void write(uint64_t location);
  virtual void align(uint64_t location);
  virtual size_t getSize() const;
  virtual bool pin(uint64_t location);
  virtual void unpin(uint64_t location);
 
  virtual bool cacheIsCritical() {
    return true;
  }
 
 private:
  FileDisk(const FileDisk&);
  FileDisk& operator=(const FileDisk&);
 
  File* m_pFile;
 
  bool m_bVfsReference;
 
  AccessType m_Mode;
 
  Cache m_Cache;
 
  // Our region of memory
  MemoryRegion m_MemRegion;
 
  // Mutex to ensure only one request runs at a time
  Mutex m_ReqMutex;
 
  uint64_t m_AlignPoints[8];
  size_t m_nAlignPoints;
};
 
#endif