src/rmr/common/include/rmr.h

   1 // : vi ts=4 sw=4 noet :
   2 /*
   3 ==================================================================================
   4         Copyright (c) 2019 Nokia
   5         Copyright (c) 2018-2019 AT&T Intellectual Property.
   6
   7    Licensed under the Apache License, Version 2.0 (the "License");
   8    you may not use this file except in compliance with the License.
   9    You may obtain a copy of the License at
  10
  11            http://www.apache.org/licenses/LICENSE-2.0
  12
  13    Unless required by applicable law or agreed to in writing, software
  14    distributed under the License is distributed on an "AS IS" BASIS,
  15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16    See the License for the specific language governing permissions and
  17    limitations under the License.
  18 ==================================================================================
  19 */
  20
  21 /*
  22         Mnemonic:       rmr.h
  23         Abstract:       General (public) header file for the uta message routing library
  24         Author:         E. Scott Daniels
  25         Date:           27 November 2018
  26 */
  27
  28 #ifndef _rmr_h
  29 #define _rmr_h
  30
  31 #include <sys/epoll.h>          // broken on mac
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37
  38 #define RMR_MAX_XID                     32              // space in header reserved for user xaction id
  39 #define RMR_MAX_MEID            32              // spece in header reserved for managed element id
  40 #define RMR_MAX_SRC                     64              // max length of hostname (which could be IPv6 addr with [...]:port so more than the 39 bytes of a plain addr
  41 #define RMR_MAX_SID                     32              // misc sender info/data (reserved)
  42 #define RMR_MAX_RCV_BYTES       4096    // max bytes we support in a receive message
  43
  44                                                                         // various flags for function calls
  45 #define RMRFL_NONE                      0x00    // no flags
  46 #define RMRFL_NOTHREAD          0x01    // do not start an additional route collector thread
  47 #define RMRFL_MTCALL            0x02    // set up multi-threaded call support (rmr_init)
  48 #define RMRFL_AUTO_ALLOC        0x03    // send auto allocates a zerocopy buffer
  49 #define RMRFL_NAME_ONLY         0x04    // only the hostname:ip is provided as source information for rts() calls
  50
  51 #define RMR_DEF_SIZE            0               // pass as size to have msg allocation use the default msg size
  52
  53 #define RMR_VOID_MSGTYPE        (-1)    // unset/invalid message type and sub id
  54 #define RMR_VOID_SUBID          (-1)
  55
  56 #define RMR_OK                          0               // state is good
  57 #define RMR_ERR_BADARG          1               // argument passd to function was unusable
  58 #define RMR_ERR_NOENDPT         2               // send/call could not find an endpoint based on msg type
  59 #define RMR_ERR_EMPTY           3               // msg received had no payload; attempt to send an empty message
  60 #define RMR_ERR_NOHDR           4               // message didn't contain a valid header
  61 #define RMR_ERR_SENDFAILED      5               // send failed; errno has nano reason
  62 #define RMR_ERR_CALLFAILED      6               // unable to send call() message
  63 #define RMR_ERR_NOWHOPEN        7               // no wormholes are open
  64 #define RMR_ERR_WHID            8               // wormhole id was invalid
  65 #define RMR_ERR_OVERFLOW        9               // operation would have busted through a buffer/field size
  66 #define RMR_ERR_RETRY           10              // request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)
  67 #define RMR_ERR_RCVFAILED       11              // receive failed (hard error)
  68 #define RMR_ERR_TIMEOUT         12              // message processing call timed out
  69 #define RMR_ERR_UNSET           13              // the message hasn't been populated with a transport buffer
  70 #define RMR_ERR_TRUNC           14              // received message likely truncated
  71 #define RMR_ERR_INITFAILED      15              // initialisation of something (probably message) failed
  72 #define RMR_ERR_NOTSUPP         16              // the request is not supported, or RMr was not initialised for the request
  73
  74 #define RMR_WH_CONNECTED(a) (a>=0)      // for now whid is integer; it could be pointer at some future date
  75
  76 /*
  77         General message buffer. Passed to send and returned by receive.
  78
  79         (All fields are exposed such that if a wrapper needs to dup the storage as it passes
  80         into or out of their environment they dup it all, not just what we choose to expose.)
  81
  82         NOTE:
  83         State is the RMR state of processing on the message. The transport state (tp_state)
  84         will be set to mirror the value of errno for wrappers unable to access errno directly,
  85         but will only be set if state is not RMR_OK. Even then, the value may be suspect as
  86         the underlying transport mechanism may not set errno. It is strongly recommended that
  87         user applications use tp_state only for dianostic purposes to convey additional information
  88         in a log message.
  89 */
  90 typedef struct {
  91         int     state;                                  // state of processing
  92         int     mtype;                                  // message type
  93         int     len;                                    // length of data in the payload (send or received)
  94         unsigned char* payload;         // transported data
  95         unsigned char* xaction;         // pointer to fixed length transaction id bytes
  96         int sub_id;                                     // subscription id
  97         int             tp_state;                       // transport state (errno) valid only if state != RMR_OK, and even then may not be valid
  98
  99                                                                 // these things are off limits to the user application
 100         void*   tp_buf;                         // underlying transport allocated pointer (e.g. nng message)
 101         void*   header;                         // internal message header (whole buffer: header+payload)
 102         unsigned char* id;                      // if we need an ID in the message separate from the xaction id
 103         int             flags;                          // various MFL_ (private) flags as needed
 104         int             alloc_len;                      // the length of the allocated space (hdr+payload)
 105 } rmr_mbuf_t;
 106
 107
 108 typedef int rmr_whid_t;                 // wormhole identifier returned by rmr_wh_open(), passed to rmr_wh_send_msg()
 109
 110
 111 // ---- library message specific prototypes ------------------------------------------------------------
 112 extern rmr_mbuf_t* rmr_alloc_msg( void* vctx, int size );
 113 extern rmr_mbuf_t* rmr_call( void* vctx, rmr_mbuf_t* msg );
 114 extern void rmr_close( void* vctx );
 115 extern void* rmr_init( char* proto_port, int max_msg_size, int flags );
 116 extern int rmr_init_trace( void* vctx, int size );
 117 extern int rmr_payload_size( rmr_mbuf_t* msg );
 118 extern rmr_mbuf_t* rmr_send_msg( void* vctx, rmr_mbuf_t* msg );
 119 extern rmr_mbuf_t* rmr_mtosend_msg( void* vctx, rmr_mbuf_t* msg, int max_to );
 120 extern rmr_mbuf_t* rmr_rcv_msg( void* vctx, rmr_mbuf_t* old_msg );
 121 extern rmr_mbuf_t* rmr_rcv_specific( void* uctx, rmr_mbuf_t* msg, char* expect, int allow2queue );
 122 extern rmr_mbuf_t*  rmr_rts_msg( void* vctx, rmr_mbuf_t* msg );
 123 extern int rmr_ready( void* vctx );
 124 extern int rmr_set_rtimeout( void* vctx, int time );
 125 extern int rmr_set_stimeout( void* vctx, int time );
 126 extern int rmr_get_rcvfd( void* vctx );                                                         // only supported with nng
 127 extern rmr_mbuf_t* rmr_torcv_msg( void* vctx, rmr_mbuf_t* old_msg, int ms_to );
 128 extern rmr_mbuf_t*  rmr_tralloc_msg( void* context, int msize, int trsize, unsigned const char* data );
 129 extern rmr_whid_t rmr_wh_open( void* vctx, char const* target );
 130 extern rmr_mbuf_t* rmr_wh_send_msg( void* vctx, rmr_whid_t whid, rmr_mbuf_t* msg );
 131 extern void rmr_wh_close( void* vctx, int whid );
 132
 133 // ----- mt call support --------------------------------------------------------------------------------
 134 extern rmr_mbuf_t* rmr_mt_call( void* vctx, rmr_mbuf_t* mbuf, int call_id, int max_wait );
 135 extern rmr_mbuf_t* rmr_mt_rcv( void* vctx, rmr_mbuf_t* mbuf, int max_wait );
 136
 137 // ----- msg buffer operations (no context needed) ------------------------------------------------------
 138 extern int rmr_bytes2meid( rmr_mbuf_t* mbuf, unsigned char const* src, int len );
 139 extern void rmr_bytes2payload( rmr_mbuf_t* mbuf, unsigned char const* src, int len );
 140 extern int rmr_bytes2xact( rmr_mbuf_t* mbuf, unsigned char const* src, int len );
 141 extern void rmr_free_msg( rmr_mbuf_t* mbuf );
 142 extern unsigned char*  rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest );
 143 extern unsigned char*  rmr_get_src( rmr_mbuf_t* mbuf, unsigned char* dest );
 144 extern unsigned char* rmr_get_srcip( rmr_mbuf_t* msg, unsigned char* dest );
 145 extern rmr_mbuf_t* rmr_realloc_msg( rmr_mbuf_t* mbuf, int new_tr_size );
 146 extern int rmr_str2meid( rmr_mbuf_t* mbuf, unsigned char const* str );
 147 extern void rmr_str2payload( rmr_mbuf_t* mbuf, unsigned char const* str );
 148 extern void rmr_str2payload( rmr_mbuf_t* mbuf, unsigned char const* str );
 149 extern int rmr_str2xact( rmr_mbuf_t* mbuf, unsigned char const* str );
 150 extern void* rmr_trace_ref( rmr_mbuf_t* msg, int* sizeptr );
 151
 152 extern int rmr_get_trlen( rmr_mbuf_t* msg );
 153 extern int rmr_get_trace( rmr_mbuf_t* msg, unsigned char* dest, int size );
 154 extern int rmr_set_trace( rmr_mbuf_t* msg, unsigned const char* data, int size );
 155
 156 extern int rmr_rcv_to( void* vctx, int time );          // DEPRECATED -- replaced with set_rtimeout
 157 extern int rmr_send_to( void* vctx, int time );         // DEPRECATED -- replaced with set_stimeout
 158
 159
 160 // --- uta compatability defs if needed user should define UTA_COMPAT  ----------------------------------
 161 #ifdef UTA_COMPAT
 162 #pragma message( "use of UTA_COMPAT is deprecated and soon to be removed" )
 163
 164 #define UTA_MAX_XID RMR_MAX_XID
 165 #define UTA_MAX_SID     RMR_MAX_SID
 166 #define UTA_MAX_SRC RMR_MAX_SRC
 167 #define UTA_MAX_RCV_BYTES RMR_MAX_RCV_BYTES
 168
 169 #define UTAFL_NONE              RMRFL_NONE
 170 #define UTAFL_AUTO_ALLOC RMRFL_AUTO_ALLOC
 171
 172 #define UTA_DEF_SIZE    RMRFL_AUTO_ALLOC
 173
 174 #define UTA_OK                   RMR_OK
 175 #define UTA_ERR_BADARG  RMR_ERR_BADARG
 176 #define UTA_ERR_NOENDPT RMR_ERR_NOENDPT
 177 #define UTA_ERR_EMPTY   RMR_ERR_EMPTY
 178 #define UTA_ERR_NOHDR   RMR_ERR_NOHDR
 179 #define UTA_ERR_SENDFAILED RMR_ERR_SENDFAILED
 180 #define UTA_ERR_CALLFAILED RMR_ERR_CALLFAILED
 181
 182 #define uta_mbuf_t rmr_mbuf_t
 183
 184 #define uta_alloc_msg  rmr_alloc_msg
 185 #define uta_call rmr_call
 186 #define uta_free_msg rmr_free_msg
 187 #define uta_init rmr_init
 188 #define uta_payload_size  rmr_payload_size
 189 #define uta_send_msg  rmr_send_msg
 190 #define uta_rcv_msg rmr_rcv_msg
 191 #define uta_rcv_specific rmr_rcv_specific
 192 #define uta_rcv_to rmr_rcv_to
 193 #define uta_rts_msg rmr_rts_msg
 194 #define uta_ready rmr_ready
 195 #define uta_send_to rmr_send_to
 196 #endif          // uta compat
 197
 198
 199 #ifdef __cplusplus
 200  }
 201 #endif
 202
 203 #endif          // dup include prevention