drd.supp

#
# The following suppressions are suited for debug build
# of librpma on Ubuntu 22.04 used in the CircleCI.
# They may not work for any other OS, OS version,
# rdma-core version and for the release build.
#

#
# All suppressions should follow the following format:
#
# Assessment: (XXX - to mark assessment that is not done yet)
#
# This suppression indicates a lack of MT safety.
#
# OS: a version of OS
# OFED: a version of OFED if used
# libibverbs: a version of libibverbs
# librdmacm: a version of librdmacm
# rdma-core: a version of the 'rdma-core' package if installed
#
# Occurs in traces of:
# - a function name of public API of librpma
#
# There are 3 types of suppressions:
#
# 1) general one (on an external API)
# {
#    Conflicting store of size 4
#    drd:ConflictingAccess
#    ...
#    fun:ibv_dontfork_range
#    ...
# }
#
# 2) explicit librpma API call
# {
#    Conflicting store of size 4
#    drd:ConflictingAccess
#    ...
#    fun:rpma_conn_cfg_set_timeout
#    ...
# }
#
# 3) detailed external one (on an external API)
# {
#    Conflicting store of size 4
#    drd:ConflictingAccess
#    ...
#    fun:funA
#    fun:funB
#    fun:funC
#    fun:function_call_used directly form_public_API
#    ...
# }
#

#
# Assessment: this suppression indicates a lack of MT safety.
#
# syslog(3) has the "MT-Safe env locale" attributes(7)
# and therefore it can be considered as not MT-safe by valgrind.
# This issue can cause that logs of syslog(3) can be corrupted,
# but it does not affect the MT-safety of the librpma library.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs: 1.14.39.0
# librdmacm: 1.3.39.0
#
# It can occur in traces of all functions of librpma API.
#
{
   syslog(): race while reading the name of time zone
   drd:ConflictingAccess
   ...
   fun:__vsyslog_internal
   fun:*syslog*
   fun:rpma_log_default_function
   ...
}

#
# Assessment: these 2 suppressions indicate a lack of MT safety.
#
# rpma_log_default_function() calls rpma_get_timestamp_prefix()
# which calls localtime_r(3).
# localtime_r(3) has the "MT-Safe env locale" attributes(7)
# and therefore it is considered as not MT-safe by valgrind.
# This issue can cause that logs of rpma_log_default_function() can be corrupted,
# but it does not affect the MT-safety of the librpma library.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs: 1.14.39.0
# librdmacm: 1.3.39.0
#
# They can occur in traces of all functions of librpma API.
#
{
   Race while reading the name of time zone ("GMT").
   drd:ConflictingAccess
   ...
   fun:__tz_convert
   fun:rpma_get_timestamp_prefix
   fun:rpma_log_default_function
   ...
}
{
   Race while reading the name of time zone ("GMT") - non-existing code path (unknown Valgrind issue on CircleCI)
   drd:ConflictingAccess
   ...
   fun:__tz_convert
   fun:rpma_log_default_function
   ...
}

#
# Assessment: this suppression does not indicate a lack of MT safety.
#
# cma_dev_cnt was a global counter of elements populating the global array of
# devices detected by librdmacm. It was used as an indicator of already done
# initialization. It was checked before locking a mutex required to make any
# changes to the global array and changing the counter itself as follows:
# 
# static int cma_dev_cnt;
# ...
# int ucma_init(void)
# {
#     if (cma_dev_cnt)
#         return 0;
#
#     pthread_mutex_lock(&mut);
#     if (cma_dev_cnt) {
#         pthread_mutex_unlock(&mut);
#         return 0;
#     }
# ...
#     cma_dev_cnt = dev_cnt;
# ...
#     pthread_mutex_unlock(&mut);
# ...
# }
#
# But having a race, in this case, should do no harm since the counter is also
# checked after locking the mutex. So, even writing a new value to the counter
# even if it will be torn and read partially by another thread it won't lead
# to abnormal behaviour.
#
# Note: This issue is no longer the case for rdma-core >= v30.0 since there
# instead of a global array is a global list. But the logic seems to be
# the same: a quick check (a comparison) followed by the mutex lock and
# recheck of the condition so the final assessment should be the same.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs: 1.14.39.0
# librdmacm: 1.3.39.0
#
# Occurs in traces of:
# - rpma_utils_get_ibv_context
#
{
   Conflicting store/load of size 4
   drd:ConflictingAccess
   ...
   fun:ucma_init
   ...
   fun:rdma_getaddrinfo
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs: 1.14.39.0
# librdmacm: 1.3.39.0
#
# Occurs in traces of:
# - rpma_utils_get_ibv_context
# - rpma_ep_listen
#
{
   Conflicting store of size 8
   drd:ConflictingAccess
   fun:idm_set
   fun:ucma_insert_id
   fun:rdma_create_id2.part.0
   ...
}

#
# Assessment: these 2 suppressions indicate a lack of MT safety.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs: 1.14.39.0
# librdmacm: 1.3.39.0
#
# Occurs in traces of:
# - rpma_utils_get_ibv_context
# - rpma_ep_shutdown
#
{
   Conflicting load of size 8
   drd:ConflictingAccess
   fun:idm_clear
   fun:ucma_remove_id
   fun:ucma_free_id
   fun:rdma_destroy_id
   ...
}
{
   Conflicting load of size 8
   drd:ConflictingAccess
   fun:UnknownInlinedFun
   fun:UnknownInlinedFun
   fun:ucma_free_id
   fun:rdma_destroy_id
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS - Ubuntu 22.04
# OFED - MLNX_OFED 5.6-2.0.9.0
# libibverbs - 1.14.40.0
# librdmacm - 1.3.40.0
#
# Occurs in traces of:
# - rpma_conn_req_delete
#
{
   rpma_conn_req_delete
   drd:ConflictingAccess
   obj:*librdmacm.so*
   fun:rdma_destroy_id
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs: 1.14.39.0
# librdmacm: 1.3.39.0
#
# Occurs in traces of:
# - rpma_mr_reg
# - rpma_conn_req_new
#
{
   Conflicting store of size 4
   drd:ConflictingAccess
   fun:ibv_dontfork_range
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs: 1.14.39.0
# librdmacm: 1.3.39.0
#
# Occurs in traces of:
# - rpma_mr_dereg
# - rpma_conn_req_delete
#
{
   Conflicting store of size 4
   drd:ConflictingAccess
   fun:ibv_dofork_range
   ...
}

#
# Assessment: this suppression does NOT indicate a lack of MT safety.
#             It is a SoftRoCE specific mutex error (Mutex not locked).
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs: 1.14.39.0
# librdmacm: 1.3.39.0
#
# Occurs in traces of:
# - rpma_conn_req_new
# - rpma_ep_next_conn_req
#
{
   SoftRoCE specific mutex error (Mutex not locked)
   drd:MutexErr
   fun:pthread_spin_init@*
   fun:rxe_create_qp
   fun:UnknownInlinedFun
   fun:rdma_create_qp_ex
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS: Ubuntu 22.04
# OFED: MLNX_OFED 5.6-2.0.9.0
# libibverbs: 1.14.40.0
# librdmacm: 1.3.40.0
#
# Occurs in traces of:
# - rpma_conn_req_new
# - rpma_ep_listen
#
{
   Conflicting store of size 8
   drd:ConflictingAccess
   fun:UnknownInlinedFun
   fun:UnknownInlinedFun
   fun:rdma_create_id2.part.0
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS - Ubuntu 22.04
# OFED - MLNX_OFED 5.6-2.0.9.0
# libibverbs - 1.14.40.0
# librdmacm - 1.3.40.0
#
# Occurs in traces of:
# - rpma_conn_req_new
# - rpma_cq_wait
#
{
   Conflicting store of size 8
   drd:ConflictingAccess
   ...
   fun:ibv_req_notify_cq
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS - Ubuntu 22.04
# OFED - MLNX_OFED 5.6-2.0.9.0
# libibverbs - 1.14.40.0
# librdmacm - 1.3.40.0
#
# Occurs in traces of:
# - rpma_conn_req_new
#
{
   Conflicting Access
   drd:ConflictingAccess
   obj:*librdmacm.so*
   fun:rpma_conn_req_new
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS - Ubuntu 22.04
# OFED - MLNX_OFED 5.6-2.0.9.0
# libibverbs - 1.14.40.0
# librdmacm - 1.3.40.0
#
# Occurs in traces of:
# - rpma_ep_listen
#
{
   Conflicting Access
   drd:ConflictingAccess
   obj:*librdmacm.so*
   fun:rpma_ep_listen
   ...
}

#
# Assessment: these 5 suppressions indicate a lack of MT safety.
#
# OS - Ubuntu 22.04
# OFED - MLNX_OFED 5.6-2.0.9.0
# libibverbs - 1.14.40.0
# librdmacm - 1.3.40.0
#
# They all occur in traces of:
# - rpma_utils_get_ibv_context
#
{
   Conflicting Access
   drd:ConflictingAccess
   ...
   obj:*librdmacm.so*
   fun:rdma_getaddrinfo
   fun:rpma_info_new
   fun:rpma_utils_get_ibv_context
   ...
}
{
   Conflicting Access
   drd:ConflictingAccess
   ...
   fun:rdma_create_event_channel
   obj:*librdmacm.so*
   fun:rpma_utils_get_ibv_context
   ...
}
{
   Conflicting Access
   drd:ConflictingAccess
   obj:*librdmacm.so*
   fun:rdma_create_id
   fun:rpma_utils_get_ibv_context
   ...
}
{
   Conflicting Access
   drd:ConflictingAccess
   obj:*librdmacm.so*
   fun:rpma_utils_get_ibv_context
   ...
}
{
   Conflicting Access
   drd:ConflictingAccess
   fun:rdma_bind_addr
   fun:rpma_info_bind_addr
   fun:rpma_utils_get_ibv_context
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety when SoftRoCE is used.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs - 1.14.39.0
# librdmacm - 1.3.39.0
#
# Occurs in traces of:
# - rpma_conn_req_new
# - rpma_ep_next_conn_req
#
{
   General suppression related to SoftRoCE issue with mutex
   drd:MutexErr
   ...
   obj:*librxe-rdmav34.so*
   ...
   fun:rdma_create_qp_ex
   fun:rpma_peer_setup_qp
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS - Ubuntu 22.04
# OFED - MLNX_OFED 5.6-2.0.9.0
# libibverbs - 1.14.40.0
# librdmacm - 1.3.40.0
#
# Occurs in traces of:
# - rpma_srq_delete
#
{
   Conflicting Access
   drd:ConflictingAccess
   ...
   fun:rpma_srq_delete
   ...
}

#
# Assessment: this suppression indicates a lack of MT safety.
#
# OS - Ubuntu 22.04
# OFED - MLNX_OFED 5.6-2.0.9.0
# libibverbs - 1.14.40.0
# librdmacm - 1.3.40.0
#
# Occurs in traces of:
# - rpma_srq_new
#
{
   Conflicting Access
   drd:ConflictingAccess
   ...
   fun:rpma_srq_new
   ...
}

#
# Assessment: these 2 suppressions indicate a lack of MT safety when SoftRoCE is used.
#
# OS: ubuntu-2204:2022.04.1 of CircleCI
# libibverbs - 1.14.39.0
# librdmacm - 1.3.39.0
#
# Occurs in traces of:
# - rpma_srq_new
#
{
   Conditional Error
   drd:CondErr
   ...
   fun:ibv_create_srq*
   fun:rpma_peer_create_srq
   fun:rpma_srq_new
   ...
}
{
   General suppression related to SoftRoCE issue with mutex
   drd:MutexErr
   ...
   fun:pthread_mutex_init@*
   ...
   fun:rpma_srq_new
   ...
}