LocksCommand.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 LOCKSCOMMAND_H
#define LOCKSCOMMAND_H
#include "pedigree/kernel/Atomic.h"
#include "pedigree/kernel/debugger/DebuggerCommand.h"
#include "pedigree/kernel/debugger/DebuggerIO.h"
#include "pedigree/kernel/debugger/Scrollable.h"
#include "pedigree/kernel/processor/state_forward.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/StaticString.h"
 
#include <config.h>
 
class Spinlock;
 
#define NUM_BT_FRAMES 6
#define MAX_DESCRIPTORS 50
 
#ifdef TESTSUITE
#define LOCKS_COMMAND_NUM_CPU 4
#else
#if MULTIPROCESSOR
#define LOCKS_COMMAND_NUM_CPU 255
#else
#define LOCKS_COMMAND_NUM_CPU 1
#endif
#endif
 
class LocksCommand : public DebuggerCommand, public Scrollable {
  friend class Spinlock;
 
 public:
  LocksCommand();
 
  virtual ~LocksCommand();
 
  void autocomplete(const HugeStaticString& input, HugeStaticString& output);
 
  bool execute(const HugeStaticString& input, HugeStaticString& output, InterruptState& state,
               DebuggerIO* screen);
 
  const NormalStaticString getString() {
    return NormalStaticString("locks");
  }
 
  void setReady();
 
  void setFatal();
 
  bool lockAttempted(const Spinlock* pLock, size_t nCpu = ~0U, bool intState = false);
  bool lockAcquired(const Spinlock* pLock, size_t nCpu = ~0U, bool intState = false);
  bool lockReleased(const Spinlock* pLock, size_t nCpu = ~0U);
 
  bool checkSchedule(size_t nCpu = ~0U);
 
  bool checkState(const Spinlock* pLock, size_t nCpu = ~0U);
 
  // Scrollable interface.
  virtual const char* getLine1(size_t index, DebuggerIO::Colour& colour,
                               DebuggerIO::Colour& bgColour);
  virtual const char* getLine2(size_t index, size_t& colOffset, DebuggerIO::Colour& colour,
                               DebuggerIO::Colour& bgColour);
  virtual size_t getLineCount();
 
 protected:
  void clearFatal();
 
 private:
  enum State {
    Inactive = 0,
    Attempted,
    Acquired,
    Checked,
  };
 
  const char* stateName(State s) {
    switch (s) {
      case Attempted:
        return "attempted";
      case Acquired:
        return "acquired";
      case Checked:
        return "checked";
      case Inactive:
        return "inactive";
      default:
        return "unknown";
    }
  }
 
  struct LockDescriptor {
    LockDescriptor() : pLock(0), state(Inactive) {}
 
    const Spinlock* pLock;
    State state;
  };
 
  LockDescriptor m_pDescriptors[LOCKS_COMMAND_NUM_CPU][MAX_DESCRIPTORS];
 
  Atomic<bool> m_bAcquiring;
  Atomic<uint8_t> m_NextPosition[LOCKS_COMMAND_NUM_CPU];
  Atomic<size_t> m_LockIndex;
 
  bool m_bFatal;
 
  size_t m_SelectedLine;
 
  LockDescriptor* m_pSelectedLock;
};
 
extern LocksCommand g_LocksCommand;
 
#endif