src/bindings/rmr-python/rmr/rmr.py

   1 # ==================================================================================
   2 #       Copyright (c) 2019 Nokia
   3 #       Copyright (c) 2018-2019 AT&T Intellectual Property.
   4 #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");
   6 #   you may not use this file except in compliance with the License.
   7 #   You may obtain a copy of the License at
   8 #
   9 #          http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #   Unless required by applicable law or agreed to in writing, software
  12 #   distributed under the License is distributed on an "AS IS" BASIS,
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #   See the License for the specific language governing permissions and
  15 #   limitations under the License.
  16 # ==================================================================================
  17 import uuid
  18 import json
  19 from ctypes import RTLD_GLOBAL, Structure, c_int, POINTER, c_char, c_char_p, c_void_p, memmove, cast
  20 from ctypes import CDLL
  21 from ctypes import create_string_buffer
  22
  23 # https://docs.python.org/3.7/library/ctypes.html
  24 # https://stackoverflow.com/questions/2327344/ctypes-loading-a-c-shared-library-that-has-dependencies/30845750#30845750
  25 # make sure you do a set -x LD_LIBRARY_PATH /usr/local/lib/;
  26
  27 # even though we don't use these directly, they contain symbols we need
  28 _ = CDLL("libnng.so", mode=RTLD_GLOBAL)
  29 rmr_c_lib = CDLL("librmr_nng.so", mode=RTLD_GLOBAL)
  30
  31
  32 # Internal Helpers (not a part of public api)
  33
  34
  35 _rmr_const = rmr_c_lib.rmr_get_consts
  36 _rmr_const.argtypes = []
  37 _rmr_const.restype = c_char_p
  38
  39
  40 def _get_constants(cache={}):
  41     """
  42     Get or build needed constants from rmr
  43     TODO: are there constants that end user applications need?
  44     """
  45     if cache:
  46         return cache
  47
  48     js = _rmr_const()  # read json string
  49     cache = json.loads(str(js.decode()))  # create constants value object as a hash
  50     return cache
  51
  52
  53 def _get_mapping_dict(cache={}):
  54     """
  55     Get or build the state mapping dict
  56
  57     RMR_OK              0   state is good
  58     RMR_ERR_BADARG      1   argument passd to function was unusable
  59     RMR_ERR_NOENDPT     2   send/call could not find an endpoint based on msg type
  60     RMR_ERR_EMPTY       3   msg received had no payload; attempt to send an empty message
  61     RMR_ERR_NOHDR       4   message didn't contain a valid header
  62     RMR_ERR_SENDFAILED  5   send failed; errno has nano reason
  63     RMR_ERR_CALLFAILED  6   unable to send call() message
  64     RMR_ERR_NOWHOPEN    7   no wormholes are open
  65     RMR_ERR_WHID        8   wormhole id was invalid
  66     RMR_ERR_OVERFLOW    9   operation would have busted through a buffer/field size
  67     RMR_ERR_RETRY       10  request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)
  68     RMR_ERR_RCVFAILED   11  receive failed (hard error)
  69     RMR_ERR_TIMEOUT     12  message processing call timed out
  70     RMR_ERR_UNSET       13  the message hasn't been populated with a transport buffer
  71     RMR_ERR_TRUNC       14  received message likely truncated
  72     RMR_ERR_INITFAILED  15  initialisation of something (probably message) failed
  73
  74     """
  75     if cache:
  76         return cache
  77
  78     rmr_consts = _get_constants()
  79     for key in rmr_consts:  # build the state mapping dict
  80         if key[:7] in ["RMR_ERR", "RMR_OK"]:
  81             en = int(rmr_consts[key])
  82             cache[en] = key
  83
  84     return cache
  85
  86
  87 def _state_to_status(stateno):
  88     """
  89     Convert a msg state to status
  90
  91     """
  92     sdict = _get_mapping_dict()
  93     return sdict.get(stateno, "UNKNOWN STATE")
  94
  95
  96 _RCONST = _get_constants()
  97
  98
  99 ##############
 100 # PUBLIC API
 101 ##############
 102
 103
 104 # These constants are directly usable by importers of this library
 105 # TODO: Are there others that will be useful?
 106
 107 RMR_MAX_RCV_BYTES = _RCONST["RMR_MAX_RCV_BYTES"]
 108
 109 RMRFL_NONE = _RCONST.get("RMRFL_MTCALL", 0x02)    # initialisation flags
 110 RMRFL_NONE = _RCONST.get("RMRFL_NONE", 0x0)
 111
 112 RMR_OK = _RCONST["RMR_OK"]                        # useful state constants
 113 RMR_ERR_TIMEOUT = _RCONST["RMR_ERR_TIMEOUT"]
 114 RMR_ERR_RETRY = _RCONST["RMR_ERR_RETRY"]
 115
 116
 117 class rmr_mbuf_t(Structure):
 118     """
 119     Reimplementation of rmr_mbuf_t which is in an unaccessible header file (src/common/include/rmr.h)
 120
 121     | typedef struct {
 122     |    int     state;          // state of processing
 123     |    int     mtype;          // message type
 124     |    int     len;            // length of data in the payload (send or received)
 125     |    unsigned char* payload; // transported data
 126     |    unsigned char* xaction; // pointer to fixed length transaction id bytes
 127     |    int sub_id;             // subscription id
 128     |    int      tp_state;      // transport state (a.k.a errno)
 129     |
 130     | these things are off limits to the user application
 131     |
 132     |    void*   tp_buf;         // underlying transport allocated pointer (e.g. nng message)
 133     |    void*   header;         // internal message header (whole buffer: header+payload)
 134     |    unsigned char* id;      // if we need an ID in the message separate from the xaction id
 135     |    int flags;              // various MFL (private) flags as needed
 136     |    int alloc_len;          // the length of the allocated space (hdr+payload)
 137     | } rmr_mbuf_t;
 138
 139     We do not include the fields we are not supposed to mess with
 140
 141     RE PAYLOADs type below, see the documentation for c_char_p:
 142        class ctypes.c_char_p
 143            Represents the C char * datatype when it points to a zero-terminated string. For a general character pointer that may also point to binary data, POINTER(c_char) must be used. The constructor accepts an integer address, or a bytes object.
 144     """
 145
 146     _fields_ = [
 147         ("state", c_int),
 148         ("mtype", c_int),
 149         ("len", c_int),
 150         (
 151             "payload",
 152             POINTER(c_char),
 153         ),  # according to th following the python bytes are already unsinged https://bytes.com/topic/python/answers/695078-ctypes-unsigned-char
 154         ("xaction", POINTER(c_char)),
 155         ("sub_id", c_int),
 156         ("tp_state", c_int),
 157     ]
 158
 159
 160 # argtypes and restype are important: https://stackoverflow.com/questions/24377845/ctype-why-specify-argtypes
 161
 162
 163 _rmr_init = rmr_c_lib.rmr_init
 164 _rmr_init.argtypes = [c_char_p, c_int, c_int]
 165 _rmr_init.restype = c_void_p
 166
 167
 168 def rmr_init(uproto_port, max_msg_size, flags):
 169     """
 170     Refer to rmr C documentation for rmr_init
 171     extern void* rmr_init(char* uproto_port, int max_msg_size, int flags)
 172     """
 173     return _rmr_init(uproto_port, max_msg_size, flags)
 174
 175
 176 _rmr_ready = rmr_c_lib.rmr_ready
 177 _rmr_ready.argtypes = [c_void_p]
 178 _rmr_ready.restype = c_int
 179
 180
 181 def rmr_ready(vctx):
 182     """
 183     Refer to rmr C documentation for rmr_ready
 184     extern int rmr_ready(void* vctx)
 185     """
 186     return _rmr_ready(vctx)
 187
 188
 189 _rmr_close = rmr_c_lib.rmr_close
 190 _rmr_close.argtypes = [c_void_p]
 191
 192
 193 def rmr_close(vctx):
 194     """
 195     Refer to rmr C documentation for rmr_close
 196     extern void rmr_close(void* vctx)
 197     """
 198     return _rmr_close(vctx)
 199
 200
 201 _rmr_set_stimeout = rmr_c_lib.rmr_set_stimeout
 202 _rmr_set_stimeout.argtypes = [c_void_p, c_int]
 203 _rmr_set_stimeout.restype = c_int
 204
 205
 206 def rmr_set_stimeout(vctx, time):
 207     """
 208     Refer to the rmr C documentation for rmr_set_stimeout
 209     extern int rmr_set_stimeout(void* vctx, int time)
 210     """
 211     return _rmr_set_stimeout(vctx, time)
 212
 213
 214 _rmr_alloc_msg = rmr_c_lib.rmr_alloc_msg
 215 _rmr_alloc_msg.argtypes = [c_void_p, c_int]
 216 _rmr_alloc_msg.restype = POINTER(rmr_mbuf_t)
 217
 218
 219 def rmr_alloc_msg(vctx, size):
 220     """
 221     Refer to the rmr C documentation for rmr_alloc_msg
 222     extern rmr_mbuf_t* rmr_alloc_msg(void* vctx, int size)
 223     """
 224     return _rmr_alloc_msg(vctx, size)
 225
 226
 227 _rmr_free_msg = rmr_c_lib.rmr_free_msg
 228 _rmr_free_msg.argtypes = [c_void_p]
 229 _rmr_free_msg.restype = None
 230
 231
 232 def rmr_free_msg(mbuf):
 233     """
 234     Refer to the rmr C documentation for rmr_free_msg
 235     extern void rmr_free_msg( rmr_mbuf_t* mbuf )
 236     """
 237     if mbuf is not None:
 238         _rmr_free_msg(mbuf)
 239
 240
 241 _rmr_payload_size = rmr_c_lib.rmr_payload_size
 242 _rmr_payload_size.argtypes = [POINTER(rmr_mbuf_t)]
 243 _rmr_payload_size.restype = c_int
 244
 245
 246 def rmr_payload_size(ptr_mbuf):
 247     """
 248     Refer to the rmr C documentation for rmr_payload_size
 249     extern int rmr_payload_size(rmr_mbuf_t* msg)
 250     """
 251     return _rmr_payload_size(ptr_mbuf)
 252
 253
 254 """
 255 The following functions all seem to have the same interface
 256 """
 257
 258 _rmr_send_msg = rmr_c_lib.rmr_send_msg
 259 _rmr_send_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)]
 260 _rmr_send_msg.restype = POINTER(rmr_mbuf_t)
 261
 262
 263 def rmr_send_msg(vctx, ptr_mbuf):
 264     """
 265     Refer to the rmr C documentation for rmr_send_msg
 266     extern rmr_mbuf_t* rmr_send_msg(void* vctx, rmr_mbuf_t* msg)
 267     """
 268     return _rmr_send_msg(vctx, ptr_mbuf)
 269
 270
 271 # TODO: the old message (Send param) is actually optional, but I don't know how to specify that in Ctypes.
 272 _rmr_rcv_msg = rmr_c_lib.rmr_rcv_msg
 273 _rmr_rcv_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)]
 274 _rmr_rcv_msg.restype = POINTER(rmr_mbuf_t)
 275
 276
 277 def rmr_rcv_msg(vctx, ptr_mbuf):
 278     """
 279     Refer to the rmr C documentation for rmr_rcv_msg
 280     extern rmr_mbuf_t* rmr_rcv_msg(void* vctx, rmr_mbuf_t* old_msg)
 281     """
 282     return _rmr_rcv_msg(vctx, ptr_mbuf)
 283
 284
 285 _rmr_torcv_msg = rmr_c_lib.rmr_torcv_msg
 286 _rmr_torcv_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t), c_int]
 287 _rmr_torcv_msg.restype = POINTER(rmr_mbuf_t)
 288
 289
 290 def rmr_torcv_msg(vctx, ptr_mbuf, ms_to):
 291     """
 292     Refer to the rmr C documentation for rmr_torcv_msg
 293     extern rmr_mbuf_t* rmr_torcv_msg(void* vctx, rmr_mbuf_t* old_msg, int ms_to)
 294     """
 295     return _rmr_torcv_msg(vctx, ptr_mbuf, ms_to)
 296
 297
 298 _rmr_rts_msg = rmr_c_lib.rmr_rts_msg
 299 _rmr_rts_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)]
 300 _rmr_rts_msg.restype = POINTER(rmr_mbuf_t)
 301
 302
 303 def rmr_rts_msg(vctx, ptr_mbuf):
 304     """
 305     Refer to the rmr C documentation for rmr_rts_msg
 306     extern rmr_mbuf_t*  rmr_rts_msg(void* vctx, rmr_mbuf_t* msg)
 307     """
 308     return _rmr_rts_msg(vctx, ptr_mbuf)
 309
 310
 311 _rmr_call = rmr_c_lib.rmr_call
 312 _rmr_call.argtypes = [c_void_p, POINTER(rmr_mbuf_t)]
 313 _rmr_call.restype = POINTER(rmr_mbuf_t)
 314
 315
 316 def rmr_call(vctx, ptr_mbuf):
 317     """
 318     Refer to the rmr C documentation for rmr_call
 319     extern rmr_mbuf_t* rmr_call(void* vctx, rmr_mbuf_t* msg)
 320     """
 321     return _rmr_call(vctx, ptr_mbuf)
 322
 323
 324 _rmr_bytes2meid = rmr_c_lib.rmr_bytes2meid
 325 _rmr_bytes2meid.argtypes = [POINTER(rmr_mbuf_t), c_char_p, c_int]
 326 _rmr_bytes2meid.restype = c_int
 327
 328
 329 def rmr_bytes2meid(ptr_mbuf, src, length):
 330     """
 331     Refer to the rmr C documentation for rmr_bytes2meid
 332     extern int rmr_bytes2meid(rmr_mbuf_t* mbuf, unsigned char const* src, int len);
 333     """
 334     return _rmr_bytes2meid(ptr_mbuf, src, length)
 335
 336
 337 # this is an alias to rmr_bytes2meid using familiar set/get terminoloigy
 338 rmr_set_meid = rmr_bytes2meid
 339
 340 # CAUTION:  Some of the C functions expect a mutable buffer to copy the bytes into;
 341 #           if there is a get_* function below, use it to set up and return the
 342 #           buffer properly.
 343
 344 # extern unsigned char*  rmr_get_meid(rmr_mbuf_t* mbuf, unsigned char* dest);
 345 # we don't provide direct access to this function (unless it is asked for) because it is not really useful to provide your own buffer.
 346 # Rather, rmr_get_meid does this for you, and just returns the string.
 347 _rmr_get_meid = rmr_c_lib.rmr_get_meid
 348 _rmr_get_meid.argtypes = [POINTER(rmr_mbuf_t), c_char_p]
 349 _rmr_get_meid.restype = c_char_p
 350
 351
 352 def rmr_get_meid(ptr_mbuf):
 353     """
 354     Get the managed equipment ID (meid) from the message header.
 355
 356     Parameters
 357     ----------
 358     ptr_mbuf: ctypes c_void_p
 359         Pointer to an rmr message buffer
 360
 361     Returns
 362     -------
 363     string:
 364         meid
 365     """
 366     sz = _get_constants().get("RMR_MAX_MEID", 64)  # size for buffer to fill
 367     buf = create_string_buffer(sz)
 368     _rmr_get_meid(ptr_mbuf, buf)
 369     return buf.value.decode()  # decode turns into a string
 370
 371
 372 _rmr_get_src = rmr_c_lib.rmr_get_src
 373 _rmr_get_src.argtypes = [POINTER(rmr_mbuf_t), c_char_p]
 374 _rmr_get_src.restype = c_char_p
 375
 376
 377 def rmr_get_src(ptr_mbuf, dest):
 378     """
 379     Refer to the rmr C documentation for rmr_get_src
 380     extern unsigned char*  rmr_get_src(rmr_mbuf_t* mbuf, unsigned char* dest);
 381     """
 382     return _rmr_get_src(ptr_mbuf, dest)
 383
 384
 385 # Methods that exist ONLY in rmr-python, and are not wrapped methods
 386 # In hindsight, I wish i put these in a seperate module, but leaving this here to prevent api breakage.
 387
 388
 389 def get_payload(ptr_mbuf):
 390     """
 391     Given a rmr_buf_t*, get it's binary payload as a bytes object
 392
 393     Parameters
 394     ----------
 395     ptr_mbuf: ctypes c_void_p
 396         Pointer to an rmr message buffer
 397
 398     Returns
 399     -------
 400     bytes:
 401         the message payload
 402     """
 403     # Logic came from the answer here: https://stackoverflow.com/questions/55103298/python-ctypes-read-pointerc-char-in-python
 404     sz = ptr_mbuf.contents.len
 405     CharArr = c_char * sz
 406     return CharArr(*ptr_mbuf.contents.payload[:sz]).raw
 407
 408
 409 def get_xaction(ptr_mbuf):
 410     """
 411     given a rmr_buf_t*, get it's transaction id
 412
 413     Parameters
 414     ----------
 415     ptr_mbuf: ctypes c_void_p
 416         Pointer to an rmr message buffer
 417
 418     Returns
 419     -------
 420     bytes:
 421         the transaction id
 422     """
 423     val = cast(ptr_mbuf.contents.xaction, c_char_p).value
 424     sz = _get_constants().get("RMR_MAX_XID", 0)
 425     return val[:sz]
 426
 427
 428 def message_summary(ptr_mbuf):
 429     """
 430     Returns a dict that contains the fields of a message
 431
 432     Parameters
 433     ----------
 434     ptr_mbuf: ctypes c_void_p
 435         Pointer to an rmr message buffer
 436
 437     Returns
 438     -------
 439     dict:
 440         dict message summary
 441     """
 442     if ptr_mbuf.contents.len > RMR_MAX_RCV_BYTES:
 443         return "Malformed message: message length is greater than the maximum possible"
 444
 445     return {
 446         "payload": get_payload(ptr_mbuf),
 447         "payload length": ptr_mbuf.contents.len,
 448         "message type": ptr_mbuf.contents.mtype,
 449         "subscription id": ptr_mbuf.contents.sub_id,
 450         "transaction id": get_xaction(ptr_mbuf),
 451         "message state": ptr_mbuf.contents.state,
 452         "message status": _state_to_status(ptr_mbuf.contents.state),
 453         "payload max size": rmr_payload_size(ptr_mbuf),
 454         "meid": rmr_get_meid(ptr_mbuf),
 455         "message source": get_src(ptr_mbuf),
 456         "errno": ptr_mbuf.contents.tp_state,
 457     }
 458
 459
 460 def set_payload_and_length(byte_str, ptr_mbuf):
 461     """
 462     | Set an rmr payload and content length
 463     | In place method, no return
 464
 465     Parameters
 466     ----------
 467     byte_str: bytes
 468         the bytes to set the payload to
 469     ptr_mbuf: ctypes c_void_p
 470         Pointer to an rmr message buffer
 471     """
 472     memmove(ptr_mbuf.contents.payload, byte_str, len(byte_str))
 473     ptr_mbuf.contents.len = len(byte_str)
 474
 475
 476 def generate_and_set_transaction_id(ptr_mbuf):
 477     """
 478     | Generate a UUID and Set an rmr transaction id to it
 479     | In place method, no return
 480
 481     Parameters
 482     ----------
 483     ptr_mbuf: ctypes c_void_p
 484         Pointer to an rmr message buffer
 485     """
 486     uu_id = uuid.uuid1().hex.encode("utf-8")
 487     sz = _get_constants().get("RMR_MAX_XID", 0)
 488     memmove(ptr_mbuf.contents.xaction, uu_id, sz)
 489
 490
 491 def get_src(ptr_mbuf):
 492     """
 493     Get the message source (likely host:port)
 494
 495     Parameters
 496     ----------
 497     ptr_mbuf: ctypes c_void_p
 498         Pointer to an rmr message buffer
 499
 500     Returns
 501     -------
 502     string:
 503         message source
 504     """
 505     sz = _get_constants().get("RMR_MAX_SRC", 64)  # size to fill
 506     buf = create_string_buffer(sz)
 507     rmr_get_src(ptr_mbuf, buf)
 508     return buf.value.decode()