2 * Copyright (c) 2005-2007 Voltaire, Inc. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35 * Declaration of osm_console_t.
36 * This object represents the OpenSM Console object.
37 * This object is part of the OpenSM family of objects.
40 #ifndef _OSM_CONSOLE_IO_H_
41 #define _OSM_CONSOLE_IO_H_
43 #include <opensm/osm_subnet.h>
44 #include <opensm/osm_log.h>
46 #define OSM_DISABLE_CONSOLE "off"
47 #define OSM_LOCAL_CONSOLE "local"
48 #define OSM_REMOTE_CONSOLE "socket"
49 #define OSM_LOOPBACK_CONSOLE "loopback"
50 #define OSM_CONSOLE_NAME "OSM Console"
52 #define OSM_DEFAULT_CONSOLE OSM_DISABLE_CONSOLE
53 #define OSM_DEFAULT_CONSOLE_PORT 10000
54 #define OSM_DAEMON_NAME "opensm"
56 #define OSM_COMMAND_PROMPT "$ "
59 # define BEGIN_C_DECLS extern "C" {
60 # define END_C_DECLS }
61 #else /* !__cplusplus */
62 # define BEGIN_C_DECLS
64 #endif /* __cplusplus */
67 typedef struct osm_console {
79 void osm_console_prompt(FILE * out);
80 int osm_console_init(osm_subn_opt_t * opt, osm_console_t * p_oct, osm_log_t * p_log);
81 void osm_console_exit(osm_console_t * p_oct, osm_log_t * p_log);
82 int is_console_enabled(osm_subn_opt_t *p_opt);
84 #ifdef ENABLE_OSM_CONSOLE_SOCKET
85 int cio_open(osm_console_t * p_oct, int new_fd, osm_log_t * p_log);
86 int is_authorized(osm_console_t * p_oct);
90 #endif /* _OSM_CONSOLE_IO_H_ */