contrib/ofed/management/opensm/include/opensm/osm_console_io.h

   1 /*
   2  * Copyright (c) 2005-2007 Voltaire, Inc. All rights reserved.
   3  *
   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:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  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.
  22  *
  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
  30  * SOFTWARE.
  31  *
  32  */
  33 /*
  34  * Abstract:
  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.
  38  */
  39
  40 #ifndef _OSM_CONSOLE_IO_H_
  41 #define _OSM_CONSOLE_IO_H_
  42
  43 #include <opensm/osm_subnet.h>
  44 #include <opensm/osm_log.h>
  45
  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"
  51
  52 #define OSM_DEFAULT_CONSOLE      OSM_DISABLE_CONSOLE
  53 #define OSM_DEFAULT_CONSOLE_PORT 10000
  54 #define OSM_DAEMON_NAME          "opensm"
  55
  56 #define OSM_COMMAND_PROMPT       "$ "
  57
  58 #ifdef __cplusplus
  59 #  define BEGIN_C_DECLS extern "C" {
  60 #  define END_C_DECLS   }
  61 #else                           /* !__cplusplus */
  62 #  define BEGIN_C_DECLS
  63 #  define END_C_DECLS
  64 #endif                          /* __cplusplus */
  65
  66 BEGIN_C_DECLS
  67 typedef struct osm_console {
  68         int socket;
  69         int in_fd;
  70         int out_fd;
  71         int authorized;
  72         FILE *in;
  73         FILE *out;
  74         char client_type[32];
  75         char client_ip[64];
  76         char client_hn[128];
  77 } osm_console_t;
  78
  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);
  83
  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);
  87 #endif
  88
  89 END_C_DECLS
  90 #endif                          /* _OSM_CONSOLE_IO_H_ */