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