X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ricxappframe%2Frmr%2Frmr.py;h=d9519e53f01ad901573f134531e9d57c5a19d934;hb=a03c517f024363d54865cf75f8e566bb446decf5;hp=59885ed872efeff539886bde83a00f5448fd3c6e;hpb=f55e4d8bf25ae7bf4424f374c8dc5753e8fb3fe5;p=ric-plt%2Fxapp-frame-py.git diff --git a/ricxappframe/rmr/rmr.py b/ricxappframe/rmr/rmr.py index 59885ed..d9519e5 100644 --- a/ricxappframe/rmr/rmr.py +++ b/ricxappframe/rmr/rmr.py @@ -14,6 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. # ================================================================================== +""" +Wraps all RMR functions, but does not have a reference to the shared library. +""" import uuid from ctypes import POINTER, Structure from ctypes import c_int, c_char, c_char_p, c_void_p, memmove, cast, create_string_buffer @@ -80,10 +83,37 @@ RMRFL_MTCALL = _get_rmr_constant('RMRFL_MTCALL', 0x02) # initialization flags RMRFL_NONE = _get_rmr_constant('RMRFL_NONE', 0x0) #: State constant for OK RMR_OK = _get_rmr_constant('RMR_OK', 0x00) -#: State constant for timeout -RMR_ERR_TIMEOUT = _get_rmr_constant('RMR_ERR_TIMEOUT') +#: State constant for no endpoint based on msg type +RMR_ERR_NOENDPT = _get_rmr_constant('RMR_ERR_NOENDPT') #: State constant for retry RMR_ERR_RETRY = _get_rmr_constant('RMR_ERR_RETRY') +#: State constant for timeout +RMR_ERR_TIMEOUT = _get_rmr_constant('RMR_ERR_TIMEOUT') + +# Publish keys used in the message summary dict as constants + +# message payload, bytes +RMR_MS_PAYLOAD = "payload" +# payload length, integer +RMR_MS_PAYLOAD_LEN = "payload length" +# message type, integer +RMR_MS_MSG_TYPE = "message type" +# subscription ID, integer +RMR_MS_SUB_ID = "subscription id" +# transaction ID, bytes +RMR_MS_TRN_ID = "transaction id" +# state of message processing, integer; e.g., 0 +RMR_MS_MSG_STATE = "message state" +# state of message processing converted to string; e.g., RMR_OK +RMR_MS_MSG_STATUS = "message status" +# number of bytes usable in the payload, integer +RMR_MS_PAYLOAD_MAX = "payload max size" +# managed entity ID, bytes +RMR_MS_MEID = "meid" +# message source, string; e.g., host:port +RMR_MS_MSG_SOURCE = "message source" +# transport state, integer +RMR_MS_ERRNO = "errno" class rmr_mbuf_t(Structure): @@ -101,7 +131,7 @@ class rmr_mbuf_t(Structure): | | these things are off limits to the user application | - | void* tp_buf; // underlying transport allocated pointer (e.g. nng message) + | void* tp_buf; // underlying transport allocated pointer | void* header; // internal message header (whole buffer: header+payload) | unsigned char* id; // if we need an ID in the message separate from the xaction id | int flags; // various MFL (private) flags as needed @@ -114,13 +144,13 @@ class rmr_mbuf_t(Structure): 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. """ - + # re payload, according to the following the python bytes are already unsigned: + # https://bytes.com/topic/python/answers/695078-ctypes-unsigned-char _fields_ = [ ("state", c_int), ("mtype", c_int), ("len", c_int), - ("payload", POINTER(c_char)), # according to the following the python bytes are already unsigned - # https://bytes.com/topic/python/answers/695078-ctypes-unsigned-char + ("payload", POINTER(c_char)), ("xaction", POINTER(c_char)), ("sub_id", c_int), ("tp_state", c_int), @@ -298,7 +328,7 @@ def rmr_alloc_msg(vctx: c_void_p, size: int, raise BadBufferAllocation -_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 +_rmr_realloc_payload = _wrap_rmr_function('rmr_realloc_payload', POINTER(rmr_mbuf_t), [POINTER(rmr_mbuf_t), c_int, c_int, c_int]) def rmr_realloc_payload(ptr_mbuf: c_void_p, new_len: int, copy=False, clone=False): @@ -358,7 +388,7 @@ def rmr_payload_size(ptr_mbuf: c_void_p) -> int: Gets the number of bytes available in the payload. Refer to RMR C documentation for method:: - extern int rmr_payload_size(rmr_mbuf_t* msg) + extern int rmr_payload_size(rmr_mbuf_t* mbuf) Parameters ---------- @@ -373,10 +403,6 @@ def rmr_payload_size(ptr_mbuf: c_void_p) -> int: return _rmr_payload_size(ptr_mbuf) -""" -The following functions all seem to have the same interface -""" - _rmr_send_msg = _wrap_rmr_function('rmr_send_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)]) @@ -385,7 +411,7 @@ def rmr_send_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_m Sends the message according to the routing table and returns an empty buffer. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_send_msg(void* vctx, rmr_mbuf_t* msg) + extern rmr_mbuf_t* rmr_send_msg(void* vctx, rmr_mbuf_t* mbuf) Parameters ---------- @@ -396,7 +422,7 @@ def rmr_send_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_m Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ return _rmr_send_msg(vctx, ptr_mbuf) @@ -411,7 +437,7 @@ def rmr_rcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mb Waits for a message to arrive, and returns it. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_rcv_msg(void* vctx, rmr_mbuf_t* old_msg) + extern rmr_mbuf_t* rmr_rcv_msg(void* vctx, rmr_mbuf_t* old_mbuf) Parameters ---------- @@ -422,7 +448,7 @@ def rmr_rcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mb Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ return _rmr_rcv_msg(vctx, ptr_mbuf) @@ -436,7 +462,7 @@ def rmr_torcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), ms_to: int) -> Waits up to the timeout value for a message to arrive, and returns it. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_torcv_msg(void* vctx, rmr_mbuf_t* old_msg, int ms_to) + extern rmr_mbuf_t* rmr_torcv_msg(void* vctx, rmr_mbuf_t* old_mbuf, int ms_to) Parameters ---------- @@ -449,7 +475,7 @@ def rmr_torcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), ms_to: int) -> Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ return _rmr_torcv_msg(vctx, ptr_mbuf, ms_to) @@ -463,7 +489,7 @@ def rmr_rts_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), payload=None, mty Sends a message to the originating endpoint and returns an empty buffer. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_rts_msg(void* vctx, rmr_mbuf_t* msg) + extern rmr_mbuf_t* rmr_rts_msg(void* vctx, rmr_mbuf_t* mbuf) additional features beyond c-rmr: if payload is not None, attempts to set the payload @@ -482,7 +508,7 @@ def rmr_rts_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), payload=None, mty Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ @@ -503,7 +529,7 @@ def rmr_call(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_ Sends a message, waits for a response and returns it. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_call(void* vctx, rmr_mbuf_t* msg) + extern rmr_mbuf_t* rmr_call(void* vctx, rmr_mbuf_t* mbuf) Parameters ---------- @@ -512,7 +538,7 @@ def rmr_call(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_ Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ return _rmr_call(vctx, ptr_mbuf) @@ -536,7 +562,7 @@ def rmr_set_meid(ptr_mbuf: POINTER(rmr_mbuf_t), byte_str: bytes) -> int: Parameters ---------- ptr_mbuf: ctypes c_void_p - Pointer to an RMR message buffer + Pointer to rmr_mbuf structure byte_tr: bytes Managed entity ID value @@ -545,8 +571,8 @@ def rmr_set_meid(ptr_mbuf: POINTER(rmr_mbuf_t), byte_str: bytes) -> int: int: number of bytes copied """ - max = _get_rmr_constant("RMR_MAX_MEID", 32) - if len(byte_str) >= max: + max_meid = _get_rmr_constant("RMR_MAX_MEID", 32) + if len(byte_str) >= max_meid: raise MeidSizeOutOfRange return _rmr_bytes2meid(ptr_mbuf, byte_str, len(byte_str)) @@ -572,15 +598,15 @@ def rmr_get_meid(ptr_mbuf: POINTER(rmr_mbuf_t)) -> bytes: Parameters ---------- ptr_mbuf: ctypes c_void_p - Pointer to an RMR message buffer + Pointer to rmr_mbuf structure Returns ------- bytes: Managed entity ID """ - sz = _get_rmr_constant("RMR_MAX_MEID", 32) # size for buffer to fill - buf = create_string_buffer(sz) + max_meid = _get_rmr_constant("RMR_MAX_MEID", 32) # size for buffer to fill + buf = create_string_buffer(max_meid) _rmr_get_meid(ptr_mbuf, buf) return buf.value @@ -598,7 +624,7 @@ def rmr_get_src(ptr_mbuf: POINTER(rmr_mbuf_t), dest: c_char_p) -> c_char_p: Parameters ---------- ptr_mbuf: ctypes POINTER(rmr_mbuf_t) - Pointer to an RMR message buffer + Pointer to rmr_mbuf structure dest: ctypes c_char_p Pointer to a buffer to receive the message source @@ -610,8 +636,157 @@ def rmr_get_src(ptr_mbuf: POINTER(rmr_mbuf_t), dest: c_char_p) -> c_char_p: return _rmr_get_src(ptr_mbuf, dest) -# Methods that exist ONLY in rmr-python, and are not wrapped methods -# In hindsight, I wish i put these in a separate module, but leaving this here to prevent api breakage. +_rmr_set_vlevel = _wrap_rmr_function('rmr_set_vlevel', None, [c_int]) + + +def rmr_set_vlevel(new_level: c_int): + """ + Sets the verbosity level which determines the messages RMR writes to standard error. + Refer to RMR C documentation for method:: + + void rmr_set_vlevel( int new_level ) + + Parameters + ---------- + new_level: int + New logging verbosity level, an integer in the range 0 (none) to 5 (debug). + """ + _rmr_set_vlevel(new_level) + + +_rmr_wh_call = _wrap_rmr_function('rmr_wh_call', POINTER(rmr_mbuf_t), [c_void_p, c_int, POINTER(rmr_mbuf_t), c_int, c_int]) + + +def rmr_wh_call(vctx: c_void_p, whid: c_int, ptr_mbuf: POINTER(rmr_mbuf_t), call_id: c_int, max_wait: c_int) -> POINTER(rmr_mbuf_t): + """ + Sends a message buffer (msg) using a wormhole ID (whid) and waits for a response. + Refer to RMR C documentation for method:: + + rmr_mbuf_t* rmr_wh_call( void* vctx, rmr_whid_t whid, rmr_mbuf_t* mbuf, int call_id, int max_wait ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + whid: c_int + Wormhole ID returned by rmr_wh_open + ptr_mbuf: ctypes POINTER(rmr_mbuf_t) + Pointer to rmr_mbuf structure + call_id: c_int + number in the range of 2..255 to identify the caller + max_wait: c_int + number of milliseconds to wait for a reply + + Returns + ------- + ctypes c_void_p: + Pointer to rmr_mbuf structure + """ + return _rmr_wh_call(vctx, whid, ptr_mbuf, call_id, max_wait) + + +_rmr_wh_close = _wrap_rmr_function('rmr_close', None, [c_void_p, c_int]) + + +def rmr_wh_close(vctx: c_void_p, whid: c_int): + """ + Closes the wormhole associated with the wormhole id. + Refer to RMR C documentation for method:: + + void rmr_close( void* vctx, rmr_whid_t whid ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + whid: c_int + Wormhole ID returned by rmr_wh_open + """ + _rmr_wh_close(vctx, whid) + + +_rmr_wh_open = _wrap_rmr_function('rmr_wh_open', c_int, [c_void_p, c_char_p]) + + +def rmr_wh_open(vctx: c_void_p, target: c_char_p) -> c_int: + """ + Creates a direct link for sending to another RMR based process. + Refer to RMR C documentation for method:: + + rmr_whid_t rmr_wh_open( void* vctx, char* target ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + target: str + Pointer to bytes built from the target process host name and port number + as a string; e.g., b'localhost:4550' + + Returns + ------- + c_int: + Wormhole ID + """ + return _rmr_wh_open(vctx, target) + + +_rmr_wh_send_msg = _wrap_rmr_function('rmr_wh_send_msg', POINTER(rmr_mbuf_t), [c_void_p, c_int, POINTER(rmr_mbuf_t)]) + + +def rmr_wh_send_msg(vctx: c_void_p, whid: c_int, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_t): + """ + Sends a message buffer (msg) using a wormhole ID (whid). + Refer to RMR C documentation for method:: + + rmr_mbuf_t* rmr_wh_send_msg( void* vctx, rmr_whid_t id, rmr_mbuf_t* msg ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + whid: c_int + Wormhole ID returned by rmr_wh_open + ptr_mbuf: ctypes POINTER(rmr_mbuf_t) + Pointer to rmr_mbuf structure + + Returns + ------- + ctypes POINTER(rmr_mbuf_t): + Pointer to rmr_mbuf structure + """ + return _rmr_wh_send_msg(vctx, whid, ptr_mbuf) + + +_rmr_wh_state = _wrap_rmr_function('rmr_wh_state', c_int, [c_void_p, c_int]) + + +def rmr_wh_state(vctx: c_void_p, whid: c_int) -> c_int: + """ + Gets the state of the connection associated with the given wormhole (whid). + Refer to RMR C documentation for method:: + + int rmr_wh_state( void* vctx, rmr_whid_t whid ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + whid: c_int + Wormhole ID returned by rmr_wh_open + + Returns + ------- + c_int: + State of the connection + """ + return _rmr_wh_state(vctx, whid, whid) + + +######################################################################################## +# Methods that exist ONLY in rmr-python, and are not wrapped methods. +# These should have been in a separate module, but leaving here to prevent api breakage. +######################################################################################## def get_payload(ptr_mbuf: c_void_p) -> bytes: @@ -628,10 +803,11 @@ def get_payload(ptr_mbuf: c_void_p) -> bytes: bytes: the message payload """ - # Logic came from the answer here: https://stackoverflow.com/questions/55103298/python-ctypes-read-pointerc-char-in-python - sz = ptr_mbuf.contents.len - CharArr = c_char * sz - return CharArr(*ptr_mbuf.contents.payload[:sz]).raw + # Logic came from the answer here: + # https://stackoverflow.com/questions/55103298/python-ctypes-read-pointerc-char-in-python + length = ptr_mbuf.contents.len + char_arr = c_char * length + return char_arr(*ptr_mbuf.contents.payload[:length]).raw def get_xaction(ptr_mbuf: c_void_p) -> bytes: @@ -649,36 +825,36 @@ def get_xaction(ptr_mbuf: c_void_p) -> bytes: the transaction id """ val = cast(ptr_mbuf.contents.xaction, c_char_p).value - sz = _get_rmr_constant("RMR_MAX_XID", 0) - return val[:sz] + max_xid = _get_rmr_constant("RMR_MAX_XID", 0) + return val[:max_xid] def message_summary(ptr_mbuf: c_void_p) -> dict: """ - Returns a dict with the fields of an RMR message. + Builds a dict with the contents of an RMR message. Parameters ---------- ptr_mbuf: ctypes c_void_p - Pointer to an rmr message buffer + Pointer to an RMR message buffer Returns ------- dict: - dict message summary + Message content as key-value pairs; keys are defined as RMR_MS_* constants. """ return { - "payload": get_payload(ptr_mbuf) if ptr_mbuf.contents.state == RMR_OK else None, - "payload length": ptr_mbuf.contents.len, - "message type": ptr_mbuf.contents.mtype, - "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), - "payload max size": rmr_payload_size(ptr_mbuf), - "meid": rmr_get_meid(ptr_mbuf), - "message source": get_src(ptr_mbuf), - "errno": ptr_mbuf.contents.tp_state, + RMR_MS_PAYLOAD: get_payload(ptr_mbuf) if ptr_mbuf.contents.state == RMR_OK else None, + RMR_MS_PAYLOAD_LEN: ptr_mbuf.contents.len, + RMR_MS_MSG_TYPE: ptr_mbuf.contents.mtype, + RMR_MS_SUB_ID: ptr_mbuf.contents.sub_id, + RMR_MS_TRN_ID: get_xaction(ptr_mbuf), + RMR_MS_MSG_STATE: ptr_mbuf.contents.state, + RMR_MS_MSG_STATUS: state_to_status(ptr_mbuf.contents.state), + RMR_MS_PAYLOAD_MAX: rmr_payload_size(ptr_mbuf), + RMR_MS_MEID: rmr_get_meid(ptr_mbuf), + RMR_MS_MSG_SOURCE: get_src(ptr_mbuf), + RMR_MS_ERRNO: ptr_mbuf.contents.tp_state, } @@ -728,8 +904,8 @@ def set_transaction_id(ptr_mbuf: c_void_p, tid_bytes: bytes): tid_bytes: bytes bytes of the desired transaction id """ - sz = _get_rmr_constant("RMR_MAX_XID", 0) - memmove(ptr_mbuf.contents.xaction, tid_bytes, sz) + max_xid = _get_rmr_constant("RMR_MAX_XID", 0) + memmove(ptr_mbuf.contents.xaction, tid_bytes, max_xid) def get_src(ptr_mbuf: c_void_p) -> str: @@ -746,7 +922,7 @@ def get_src(ptr_mbuf: c_void_p) -> str: string: message source """ - sz = _get_rmr_constant("RMR_MAX_SRC", 64) # size to fill - buf = create_string_buffer(sz) + max_src = _get_rmr_constant("RMR_MAX_SRC", 64) # size to fill + buf = create_string_buffer(max_src) rmr_get_src(ptr_mbuf, buf) return buf.value.decode()