mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-05-23 07:33:47 +00:00
7158f95bac
In the command module, the following functions are implemented: - register_command_handler Provide one interface to register command handler, other module can use this interface to register multiple handler for one command. - find_command Provide one interface to find a command instance by name; - dispatch_command_handlers Provide one interface to dispatch the command and invoke registered handler. v1-->v2: Add comments in head file. v2-->v3: Update interface name since "dm" prefix is useless. Update some log message. v3-->v4: Support guest shutdown. v4-->v5: Refine command name and add parameter check for interface. v5-->v6: Remove allow s5 command. Tracked-On: #6652 Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com> Reviewed-by: fei1.li@intel.com
88 lines
2.3 KiB
C
88 lines
2.3 KiB
C
/*
|
|
* Copyright (C)2021 Intel Corporation
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
#ifndef _CMD_H_
|
|
#define _CMD_H_
|
|
#include <pthread.h>
|
|
#include <sys/queue.h>
|
|
|
|
|
|
#define SYNC_CMD "sync"
|
|
#define ACK_SYNC "ack_sync"
|
|
#define REQ_SYS_SHUTDOWN "req_sys_shutdown"
|
|
#define ACK_REQ_SYS_SHUTDOWN "ack_req_sys_shutdown"
|
|
#define POWEROFF_CMD "poweroff_cmd"
|
|
#define ACK_POWEROFF "ack_poweroff"
|
|
#define ACK_TIMEOUT "ack_timeout"
|
|
#define REQ_USER_VM_SHUTDOWN "req_user_vm_shutdown"
|
|
#define USER_VM_SHUTDOWN "user_vm_shutdown"
|
|
|
|
#define ACK_REQ_USER_VM_SHUTDOWN "ack_req_user_vm_shutdown"
|
|
#define ACK_USER_VM_SHUTDOWN "ack_user_vm_shutdown"
|
|
#define FAIL_CONNECT "fail_connect"
|
|
#define USER_VM_DISCONNECT "user_vm_disconnect"
|
|
#define S5_REJECTED "system shutdown request is rejected"
|
|
|
|
#define SYNC_LEN (sizeof(SYNC_CMD))
|
|
|
|
#define POWEROFF "poweroff"
|
|
|
|
#define CMD_NAME_MAX 32U
|
|
|
|
enum command_id {
|
|
SYNC_ID = 0x0,
|
|
ACKED_SYNC_ID,
|
|
REQ_SYS_SHUTDOWN_ID,
|
|
ACKED_REQ_SYS_SHUTDOWN_ID,
|
|
POWEROFF_CMD_ID,
|
|
ACKED_POWEROFF_ID,
|
|
ACK_TIMEOUT_ID,
|
|
REQ_USER_VM_SHUTDOWN_ID,
|
|
USER_VM_SHUTDOWN_ID,
|
|
ACK_USER_VM_SHUTDOWN_ID,
|
|
CMD_END,
|
|
};
|
|
|
|
typedef int (cmd_handler)(void *arg, int fd);
|
|
struct command_handlers {
|
|
void *arg;
|
|
cmd_handler *fn;
|
|
|
|
LIST_ENTRY(command_handlers) list;
|
|
};
|
|
|
|
struct command {
|
|
const char name[CMD_NAME_MAX]; /**< command name */
|
|
enum command_id id; /**< command id */
|
|
|
|
/* command handler list */
|
|
LIST_HEAD(cmd_handlers_list, command_handlers) cmd_handlers_head;
|
|
pthread_mutex_t cmd_handler_mtx; /**< mutex to protect command handler list */
|
|
};
|
|
/**
|
|
* @brief register command handler, other module can use this interface to
|
|
* register multiple handler for one command.
|
|
*
|
|
* @param fn the command handler which will be registered
|
|
* @param arg the parameter which will be passed into hanlder
|
|
* @param cmd_name the command name
|
|
*/
|
|
int register_command_handler(cmd_handler *fn, void *arg, const char *cmd_name);
|
|
/**
|
|
* @brief find a command instance by name
|
|
*
|
|
* @param name the command name
|
|
* @return command instance
|
|
*/
|
|
struct command *find_command(const char *name);
|
|
/**
|
|
* @brief dispatch the command and invoke registered handler.
|
|
*
|
|
* @param arg command instance
|
|
* @param fd the file descriptor of the device
|
|
* @return the flag indicates the state of command handler execution
|
|
*/
|
|
int dispatch_command_handlers(void *arg, int fd);
|
|
#endif
|