zircon/kernel/lib/console/include/lib/console.h

// Copyright 2016 The Fuchsia Authors
// Copyright (c) 2008-2009 Travis Geiselbrecht
//
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT

#ifndef ZIRCON_KERNEL_LIB_CONSOLE_INCLUDE_LIB_CONSOLE_H_
#define ZIRCON_KERNEL_LIB_CONSOLE_INCLUDE_LIB_CONSOLE_H_

#include <debug.h>
#include <lib/special-sections/special-sections.h>
#include <stdbool.h>
#include <stddef.h>
#include <sys/types.h>

#include <fbl/macros.h>
#include <kernel/mutex.h>
#include <kernel/spinlock.h>
#include <kernel/timer.h>

/* command args */
typedef struct {
  const char* str;
  unsigned long u;
  void* p;
  long i;
  bool b;
} cmd_args;

typedef int console_cmd(int argc, const cmd_args* argv, uint32_t flags);

#define CMD_AVAIL_NORMAL (0x1 << 0)
#define CMD_AVAIL_PANIC (0x1 << 1)
#define CMD_AVAIL_ALWAYS (CMD_AVAIL_NORMAL | CMD_AVAIL_PANIC)

/* command is happening at crash time */
#define CMD_FLAG_PANIC (0x1 << 0)

/* a block of commands to register */
typedef struct {
  const char* cmd_str;
  const char* help_str;
  console_cmd* cmd_callback;
  uint8_t availability_mask;
} cmd;

/* register a static block of commands at init time */

/* enable the panic shell if we're being built */
#if !defined(ENABLE_PANIC_SHELL) && PLATFORM_SUPPORTS_PANIC_SHELL
#define ENABLE_PANIC_SHELL 1
#endif

#if LK_DEBUGLEVEL == 0

#define STATIC_COMMAND_START [[maybe_unused]] static void _cmd_list() {
#define STATIC_COMMAND_END(name) }
#define STATIC_COMMAND(command_str, help_str, func) (void)(func);
#define STATIC_COMMAND_MASKED(command_str, help_str, func, availability_mask) (void)(func);

#else  // LK_DEBUGLEVEL != 0

#define STATIC_COMMAND_START \
  static const cmd _cmd_list SPECIAL_SECTION(".data.rel.ro.commands", cmd)[] = {
#define STATIC_COMMAND_END(name) \
  }                              \
  ;

#define STATIC_COMMAND(command_str, help_str, func) {command_str, help_str, func, CMD_AVAIL_NORMAL},
#define STATIC_COMMAND_MASKED(command_str, help_str, func, availability_mask) \
  {command_str, help_str, func, availability_mask},

#endif  // LK_DEBUGLEVEL == 0

class RecurringCallback {
 public:
  using CallbackFunc = void (*)();

  explicit RecurringCallback(CallbackFunc callback) : func_(callback) {}

  void Toggle();

 private:
  DISALLOW_COPY_ASSIGN_AND_MOVE(RecurringCallback);

  static void CallbackWrapper(Timer* t, zx_time_t now, void* arg);

  DECLARE_SPINLOCK(RecurringCallback) lock_;
  Timer timer_;
  bool started_ = false;
  CallbackFunc func_ = nullptr;
};

/* external api */
int console_run_script(const char* string);
int console_run_script_locked(const char* string);  // special case from inside a command
void console_abort_script(void);

/* panic shell api */
void panic_shell_start(void);

extern int lastresult;

#endif  // ZIRCON_KERNEL_LIB_CONSOLE_INCLUDE_LIB_CONSOLE_H_