Disk.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 MACHINE_DISK_H
#define MACHINE_DISK_H
 
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/Device.h"
#include "pedigree/kernel/machine/DiskPaging.h"
#include "pedigree/kernel/machine/DiskView.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/BufferView.h"
 
class String;
 
class EXPORTED_PUBLIC Disk : public Device {
 public:
  enum SubType { ATA = 0, ATAPI };
 
  Disk();
  Disk(Device* p);
  virtual ~Disk();
 
  virtual Disk* physicalDisk();
  bool acquireUse(DiskUse& use);
  uint32_t endpointId();
 
  virtual bool getPartitionUuid(String& uuid) const;
  virtual bool getPartitionLabel(String& label) const;
 
  virtual PagingStatus preparePagingTransport(PagingTransport*& transport);
 
  void retireEndpoint();
  bool tryCloseEndpoint();
  void reopenEndpoint();
 
 protected:
  void reserveEndpoint();
  void publishEndpoint();
 
 private:
  DiskEndpoint* m_Endpoint;
 
 public:
  virtual Type getType();
 
  virtual SubType getSubType();
 
  virtual void getName(String& str);
 
  virtual void dump(String& str);
 
  virtual BufferView read(uint64_t location);
 
  virtual DiskReadView readView(uint64_t location);
  virtual DiskWriteView writeView(uint64_t location);
 
 protected:
  friend class DiskReadView;
  // Acquisition runs inside the caller's endpoint admission and I/O termination scope.
  virtual BufferView acquireView(uint64_t location, bool writable, uint64_t& token);
  virtual void releaseView(uint64_t token, bool writable);
 
 public:
  MUST_USE_RESULT virtual bool readInto(uint64_t location, void* buffer, size_t length);
  MUST_USE_RESULT virtual bool writeFrom(uint64_t location, const void* buffer, size_t length);
 
  struct ReadBuffer {
    uint64_t location;
    void* buffer;
    size_t length;
    bool complete;
  };
  static constexpr size_t MaxReadBuffers = 32;
  struct WriteBuffer {
    uint64_t location;
    const void* buffer;
    size_t length;
    bool complete;
    physical_uintptr_t dmaPhysical = 0;
  };
  static constexpr size_t MaxWriteBuffers = 32;
  MUST_USE_RESULT virtual bool writeFromBatch(WriteBuffer* buffers, size_t count);
 
  MUST_USE_RESULT virtual bool readIntoBatch(ReadBuffer* buffers, size_t count);
 
  MUST_USE_RESULT virtual bool syncData();
 
  MUST_USE_RESULT bool readViews(uint64_t location, size_t length, BufferViewSequence& views);
 
  void unpinViews(uint64_t location, BufferViewSequence& views);
 
  virtual void write(uint64_t location);
 
  virtual void align(uint64_t location);
 
  virtual size_t getSize() const;
 
  virtual size_t getBlockSize() const;
 
  virtual size_t getNativeBlockSize() const;
 
  MUST_USE_RESULT virtual bool pin(uint64_t location) = 0;
 
  virtual void unpin(uint64_t location) = 0;
 
  virtual bool cacheIsCritical();
 
  virtual void flush(uint64_t location);
 
  virtual bool sync(uint64_t location, bool async);
 
  static constexpr size_t MaxSyncPages = 64;
 
  MUST_USE_RESULT virtual bool syncPages(const uint64_t* locations, size_t count);
 
  MUST_USE_RESULT virtual bool syncAll();
 
  MUST_USE_RESULT virtual bool retireCachePage(uint64_t location);
 
  MUST_USE_RESULT virtual bool zero(uint64_t location, size_t length);
};
 
#endif