# limitations under the License.
# ==================================================================================
import uuid
-import json
-from ctypes import CDLL, POINTER, RTLD_GLOBAL, Structure
-from ctypes import c_char, c_char_p, c_int, c_void_p, cast, create_string_buffer, memmove
+from ctypes import POINTER, Structure
+from ctypes import c_int, c_char, c_char_p, c_void_p, memmove, cast, create_string_buffer
from ricxappframe.rmr.exceptions import BadBufferAllocation, MeidSizeOutOfRange, InitFailed
+from ricxappframe.rmr.rmrclib.rmrclib import rmr_c_lib, get_constants, state_to_status
-# https://docs.python.org/3.7/library/ctypes.html
-# https://stackoverflow.com/questions/2327344/ctypes-loading-a-c-shared-library-that-has-dependencies/30845750#30845750
-# make sure you do a set -x LD_LIBRARY_PATH /usr/local/lib/;
-rmr_c_lib = CDLL("librmr_si.so", mode=RTLD_GLOBAL)
-
-
-# Internal Helpers (not a part of public api)
-
-
-_rmr_const = rmr_c_lib.rmr_get_consts
-_rmr_const.argtypes = []
-_rmr_const.restype = c_char_p
-
-
-def _get_constants(cache={}) -> dict:
- """
- Gets constants published by RMR and caches for subsequent calls.
- TODO: are there constants that end user applications need?
- """
- if cache:
- return cache
-
- js = _rmr_const() # read json string
- cache = json.loads(str(js.decode())) # create constants value object as a hash
- return cache
+##############
+# PRIVATE API
+##############
-def _get_mapping_dict(cache={}) -> dict:
+def _get_rmr_constant(key: str, default=None):
"""
- Builds a state mapping dict from constants and caches for subsequent calls.
- Relevant constants at this writing include:
-
- RMR_OK 0 state is good
- RMR_ERR_BADARG 1 argument passd to function was unusable
- RMR_ERR_NOENDPT 2 send/call could not find an endpoint based on msg type
- RMR_ERR_EMPTY 3 msg received had no payload; attempt to send an empty message
- RMR_ERR_NOHDR 4 message didn't contain a valid header
- RMR_ERR_SENDFAILED 5 send failed; errno has nano reason
- RMR_ERR_CALLFAILED 6 unable to send call() message
- RMR_ERR_NOWHOPEN 7 no wormholes are open
- RMR_ERR_WHID 8 wormhole id was invalid
- RMR_ERR_OVERFLOW 9 operation would have busted through a buffer/field size
- RMR_ERR_RETRY 10 request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)
- RMR_ERR_RCVFAILED 11 receive failed (hard error)
- RMR_ERR_TIMEOUT 12 message processing call timed out
- RMR_ERR_UNSET 13 the message hasn't been populated with a transport buffer
- RMR_ERR_TRUNC 14 received message likely truncated
- RMR_ERR_INITFAILED 15 initialization of something (probably message) failed
-
+ Gets the constant with the named key from the RMR C library.
+ Returns None if the value is not a simple type. This happens
+ during sphinx autodoc document generation, which mocks the
+ rmrclib package to work without the RMR shared object file,
+ and the response is something like this:
+ <class 'ricxappframe.rmr.rmrclib.rmrclib.get_constants.get'>
+ Workaround for https://github.com/sphinx-doc/sphinx/issues/7422
"""
- if cache:
- return cache
+ val = get_constants().get(key, default)
+ return val if isinstance(val, (type(None), bool, bytes, float, int, str)) else None
- rmr_consts = _get_constants()
- for key in rmr_consts: # build the state mapping dict
- if key[:7] in ["RMR_ERR", "RMR_OK"]:
- en = int(rmr_consts[key])
- cache[en] = key
-
- return cache
-
-
-def _state_to_status(stateno: int) -> str:
- """
- Converts a msg state integer to a status string.
- Returns "UNKNOWN STATE" if the int value is not known.
+# argtypes and restype are important:
+# https://stackoverflow.com/questions/24377845/ctype-why-specify-argtypes
+def _wrap_rmr_function(funcname, restype, argtypes):
"""
- sdict = _get_mapping_dict()
- return sdict.get(stateno, "UNKNOWN STATE")
+ Simplify wrapping ctypes functions.
+ Parameters
+ ----------
+ funcname: str
+ Name of library method
+ restype: class
+ Name of ctypes class; e.g., c_char_p
+ argtypes: list
+ List of ctypes classes; e.g., [ c_char_p, int ]
-_RCONST = _get_constants()
+ Returns
+ -------
+ _FuncPointer:
+ Pointer to C library function
+"""
+ func = rmr_c_lib.__getattr__(funcname)
+ func.restype = restype
+ func.argtypes = argtypes
+ return func
##############
# PUBLIC API
##############
-
-# These constants are directly usable by importers of this library
+# Publish constants from RMR C-language header files for use by importers of this library.
# TODO: Are there others that will be useful?
-
-#: Maximum size message to receive
-RMR_MAX_RCV_BYTES = _RCONST["RMR_MAX_RCV_BYTES"]
+#: Typical size message to receive; size is not limited
+RMR_MAX_RCV_BYTES = _get_rmr_constant('RMR_MAX_RCV_BYTES')
#: Multi-threaded initialization flag
-RMRFL_MTCALL = _RCONST.get("RMRFL_MTCALL", 0x02) # initialization flags
+RMRFL_MTCALL = _get_rmr_constant('RMRFL_MTCALL', 0x02) # initialization flags
#: Empty flag
-RMRFL_NONE = _RCONST.get("RMRFL_NONE", 0x0)
+RMRFL_NONE = _get_rmr_constant('RMRFL_NONE', 0x0)
#: State constant for OK
-RMR_OK = _RCONST["RMR_OK"]
+RMR_OK = _get_rmr_constant('RMR_OK', 0x00)
#: State constant for timeout
-RMR_ERR_TIMEOUT = _RCONST["RMR_ERR_TIMEOUT"]
+RMR_ERR_TIMEOUT = _get_rmr_constant('RMR_ERR_TIMEOUT')
#: State constant for retry
-RMR_ERR_RETRY = _RCONST["RMR_ERR_RETRY"]
+RMR_ERR_RETRY = _get_rmr_constant('RMR_ERR_RETRY')
class rmr_mbuf_t(Structure):
]
-# argtypes and restype are important: https://stackoverflow.com/questions/24377845/ctype-why-specify-argtypes
-
-
-_rmr_init = rmr_c_lib.rmr_init
-_rmr_init.argtypes = [c_char_p, c_int, c_int]
-_rmr_init.restype = c_void_p
+_rmr_init = _wrap_rmr_function('rmr_init', c_void_p, [c_char_p, c_int, c_int])
def rmr_init(uproto_port: c_char_p, max_msg_size: int, flags: int) -> c_void_p:
return mrc
-_rmr_ready = rmr_c_lib.rmr_ready
-_rmr_ready.argtypes = [c_void_p]
-_rmr_ready.restype = c_int
+_rmr_ready = _wrap_rmr_function('rmr_ready', c_int, [c_void_p])
def rmr_ready(vctx: c_void_p) -> int:
return _rmr_ready(vctx)
-_rmr_close = rmr_c_lib.rmr_close
-_rmr_close.argtypes = [c_void_p]
+_rmr_close = _wrap_rmr_function('rmr_close', None, [c_void_p])
def rmr_close(vctx: c_void_p):
_rmr_close(vctx)
-_rmr_set_stimeout = rmr_c_lib.rmr_set_stimeout
-_rmr_set_stimeout.argtypes = [c_void_p, c_int]
-_rmr_set_stimeout.restype = c_int
+_rmr_set_stimeout = _wrap_rmr_function('rmr_set_stimeout', c_int, [c_void_p, c_int])
def rmr_set_stimeout(vctx: c_void_p, rloops: int) -> int:
return _rmr_set_stimeout(vctx, rloops)
-_rmr_alloc_msg = rmr_c_lib.rmr_alloc_msg
-_rmr_alloc_msg.argtypes = [c_void_p, c_int]
-_rmr_alloc_msg.restype = POINTER(rmr_mbuf_t)
+_rmr_alloc_msg = _wrap_rmr_function('rmr_alloc_msg', POINTER(rmr_mbuf_t), [c_void_p, c_int])
def rmr_alloc_msg(vctx: c_void_p, size: int,
raise BadBufferAllocation
-_rmr_realloc_payload = rmr_c_lib.rmr_realloc_payload
-_rmr_realloc_payload.argtypes = [POINTER(rmr_mbuf_t), c_int, c_int, c_int] # new_len, copy, clone
-_rmr_realloc_payload.restype = POINTER(rmr_mbuf_t)
+_rmr_realloc_payload = _wrap_rmr_function('rmr_realloc_payload', POINTER(rmr_mbuf_t), [POINTER(rmr_mbuf_t), c_int, c_int, c_int]) # new_len, copy, clone
def rmr_realloc_payload(ptr_mbuf: c_void_p, new_len: int, copy=False, clone=False):
return _rmr_realloc_payload(ptr_mbuf, new_len, copy, clone)
-_rmr_free_msg = rmr_c_lib.rmr_free_msg
-_rmr_free_msg.argtypes = [POINTER(rmr_mbuf_t)]
-_rmr_free_msg.restype = None
+_rmr_free_msg = _wrap_rmr_function('rmr_free_msg', None, [POINTER(rmr_mbuf_t)])
def rmr_free_msg(ptr_mbuf: c_void_p):
_rmr_free_msg(ptr_mbuf)
-_rmr_payload_size = rmr_c_lib.rmr_payload_size
-_rmr_payload_size.argtypes = [POINTER(rmr_mbuf_t)]
-_rmr_payload_size.restype = c_int
+_rmr_payload_size = _wrap_rmr_function('rmr_payload_size', c_int, [POINTER(rmr_mbuf_t)])
def rmr_payload_size(ptr_mbuf: c_void_p) -> int:
The following functions all seem to have the same interface
"""
-_rmr_send_msg = rmr_c_lib.rmr_send_msg
-_rmr_send_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)]
-_rmr_send_msg.restype = POINTER(rmr_mbuf_t)
+_rmr_send_msg = _wrap_rmr_function('rmr_send_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)])
def rmr_send_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_t):
# TODO: the old message (Send param) is actually optional, but I don't know how to specify that in Ctypes.
-_rmr_rcv_msg = rmr_c_lib.rmr_rcv_msg
-_rmr_rcv_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)]
-_rmr_rcv_msg.restype = POINTER(rmr_mbuf_t)
+_rmr_rcv_msg = _wrap_rmr_function('rmr_rcv_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)])
def rmr_rcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_t):
return _rmr_rcv_msg(vctx, ptr_mbuf)
-_rmr_torcv_msg = rmr_c_lib.rmr_torcv_msg
-_rmr_torcv_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t), c_int]
-_rmr_torcv_msg.restype = POINTER(rmr_mbuf_t)
+_rmr_torcv_msg = _wrap_rmr_function('rmr_torcv_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t), c_int])
def rmr_torcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), ms_to: int) -> POINTER(rmr_mbuf_t):
return _rmr_torcv_msg(vctx, ptr_mbuf, ms_to)
-_rmr_rts_msg = rmr_c_lib.rmr_rts_msg
-_rmr_rts_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)]
-_rmr_rts_msg.restype = POINTER(rmr_mbuf_t)
+_rmr_rts_msg = _wrap_rmr_function('rmr_rts_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)])
def rmr_rts_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), payload=None, mtype=None) -> POINTER(rmr_mbuf_t):
return _rmr_rts_msg(vctx, ptr_mbuf)
-_rmr_call = rmr_c_lib.rmr_call
-_rmr_call.argtypes = [c_void_p, POINTER(rmr_mbuf_t)]
-_rmr_call.restype = POINTER(rmr_mbuf_t)
+_rmr_call = _wrap_rmr_function('rmr_call', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)])
def rmr_call(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_t):
return _rmr_call(vctx, ptr_mbuf)
-_rmr_bytes2meid = rmr_c_lib.rmr_bytes2meid
-_rmr_bytes2meid.argtypes = [POINTER(rmr_mbuf_t), c_char_p, c_int]
-_rmr_bytes2meid.restype = c_int
+_rmr_bytes2meid = _wrap_rmr_function('rmr_bytes2meid', c_int, [POINTER(rmr_mbuf_t), c_char_p, c_int])
def rmr_set_meid(ptr_mbuf: POINTER(rmr_mbuf_t), byte_str: bytes) -> int:
int:
number of bytes copied
"""
- max = _get_constants().get("RMR_MAX_MEID", 32)
+ max = _get_rmr_constant("RMR_MAX_MEID", 32)
if len(byte_str) >= max:
raise MeidSizeOutOfRange
# extern unsigned char* rmr_get_meid(rmr_mbuf_t* mbuf, unsigned char* dest);
# 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.
# Rather, rmr_get_meid does this for you, and just returns the string.
-_rmr_get_meid = rmr_c_lib.rmr_get_meid
-_rmr_get_meid.argtypes = [POINTER(rmr_mbuf_t), c_char_p]
-_rmr_get_meid.restype = c_char_p
+_rmr_get_meid = _wrap_rmr_function('rmr_get_meid', c_char_p, [POINTER(rmr_mbuf_t), c_char_p])
def rmr_get_meid(ptr_mbuf: POINTER(rmr_mbuf_t)) -> bytes:
bytes:
Managed entity ID
"""
- sz = _get_constants().get("RMR_MAX_MEID", 32) # size for buffer to fill
+ sz = _get_rmr_constant("RMR_MAX_MEID", 32) # size for buffer to fill
buf = create_string_buffer(sz)
_rmr_get_meid(ptr_mbuf, buf)
return buf.value
-_rmr_get_src = rmr_c_lib.rmr_get_src
-_rmr_get_src.argtypes = [POINTER(rmr_mbuf_t), c_char_p]
-_rmr_get_src.restype = c_char_p
+_rmr_get_src = _wrap_rmr_function('rmr_get_src', c_char_p, [POINTER(rmr_mbuf_t), c_char_p])
def rmr_get_src(ptr_mbuf: POINTER(rmr_mbuf_t), dest: c_char_p) -> c_char_p:
the transaction id
"""
val = cast(ptr_mbuf.contents.xaction, c_char_p).value
- sz = _get_constants().get("RMR_MAX_XID", 0)
+ sz = _get_rmr_constant("RMR_MAX_XID", 0)
return val[:sz]
"subscription id": ptr_mbuf.contents.sub_id,
"transaction id": get_xaction(ptr_mbuf),
"message state": ptr_mbuf.contents.state,
- "message status": _state_to_status(ptr_mbuf.contents.state),
+ "message status": state_to_status(ptr_mbuf.contents.state),
"payload max size": rmr_payload_size(ptr_mbuf),
"meid": rmr_get_meid(ptr_mbuf),
"message source": get_src(ptr_mbuf),
tid_bytes: bytes
bytes of the desired transaction id
"""
- sz = _get_constants().get("RMR_MAX_XID", 0)
+ sz = _get_rmr_constant("RMR_MAX_XID", 0)
memmove(ptr_mbuf.contents.xaction, tid_bytes, sz)
string:
message source
"""
- sz = _get_constants().get("RMR_MAX_SRC", 64) # size to fill
+ sz = _get_rmr_constant("RMR_MAX_SRC", 64) # size to fill
buf = create_string_buffer(sz)
rmr_get_src(ptr_mbuf, buf)
return buf.value.decode()
Code Review / ric-plt / xapp-frame-py.git / blobdiff