bird/nest/cli.h

87 lines
2.3 KiB
C
Raw Normal View History

/*
* BIRD Internet Routing Daemon -- Command-Line Interface
*
* (c) 1999--2000 Martin Mares <mj@ucw.cz>
*
* Can be freely distributed and used under the terms of the GNU GPL.
*/
#ifndef _BIRD_CLI_H_
#define _BIRD_CLI_H_
#include "lib/resource.h"
#include "lib/event.h"
#define CLI_RX_BUF_SIZE 4096
#define CLI_TX_BUF_SIZE 4096
#define CLI_MAX_ASYNC_QUEUE 4096
#define CLI_MSG_SIZE 500
#define CLI_LINE_SIZE 512
struct cli_out {
struct cli_out *next;
byte *wpos, *outpos, *end;
byte buf[0];
};
typedef struct cli {
node n; /* Node in list of all log hooks */
pool *pool;
void *priv; /* Private to sysdep layer */
byte *rx_buf, *rx_pos, *rx_aux; /* sysdep */
struct cli_out *tx_buf, *tx_pos, *tx_write;
event *event;
1999-10-31 23:43:44 +08:00
void (*cont)(struct cli *c);
1999-11-17 20:00:21 +08:00
void (*cleanup)(struct cli *c);
1999-10-31 23:43:44 +08:00
void *rover; /* Private to continuation routine */
int last_reply;
int restricted; /* CLI is restricted to read-only commands */
struct linpool *parser_pool; /* Pool used during parsing */
struct linpool *show_pool; /* Pool used during route show */
byte *ring_buf; /* Ring buffer for asynchronous messages */
byte *ring_end, *ring_read, *ring_write; /* Pointers to the ring buffer */
2015-05-19 14:53:34 +08:00
uint ring_overflow; /* Counter of ring overflows */
uint log_mask; /* Mask of allowed message levels */
uint log_threshold; /* When free < log_threshold, store only important messages */
uint async_msg_size; /* Total size of async messages queued in tx_buf */
} cli;
extern pool *cli_pool;
extern struct cli *this_cli; /* Used during parsing */
#define CLI_ASYNC_CODE 10000
1999-10-31 23:43:44 +08:00
/* Functions to be called by command handlers */
void cli_printf(cli *, int, char *, ...);
#define cli_msg(x...) cli_printf(this_cli, x)
2015-05-19 14:53:34 +08:00
void cli_set_log_echo(cli *, uint mask, uint size);
1999-10-31 23:43:44 +08:00
static inline void cli_separator(cli *c)
{ if (c->last_reply) cli_printf(c, -c->last_reply, ""); };
1999-10-31 23:43:44 +08:00
/* Functions provided to sysdep layer */
cli *cli_new(void *);
void cli_init(void);
void cli_free(cli *);
void cli_kick(cli *);
void cli_written(cli *);
2015-05-19 14:53:34 +08:00
void cli_echo(uint class, byte *msg);
static inline int cli_access_restricted(void)
{
if (this_cli && this_cli->restricted)
return (cli_printf(this_cli, 8007, "Access denied"), 1);
else
return 0;
}
1999-10-31 23:43:44 +08:00
/* Functions provided by sysdep layer */
2009-07-14 20:18:54 +08:00
void cli_write_trigger(cli *);
int cli_get_command(cli *);
#endif