DOCA: fix optional deps + remove PreallocatorMixin from source stage

Signed-off-by: eagostini <[email protected]>

docker/optional_deps/doca.sh

@@ -0,0 +1,64 @@
+#!/bin/bash
+# SPDX-FileCopyrightText: Copyright (c) 2021-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -e
+
+MORPHEUS_SUPPORT_DOCA=${MORPHEUS_SUPPORT_DOCA:-OFF}
+LINUX_DISTRO=${LINUX_DISTRO:-ubuntu}
+LINUX_VER=${LINUX_VER:-22.04}
+DOCA_VERSION=${DOCA_VERSION:-2.7.0}
+
+# Exit early if nothing to do
+if [[ ${MORPHEUS_SUPPORT_DOCA} != @(TRUE|ON) ]]; then
+   exit 0
+fi
+
+WORKING_DIR=$1
+
+echo "Installing DOCA using directory: ${WORKING_DIR}"
+
+DEB_DIR=${WORKING_DIR}/deb
+
+mkdir -p ${DEB_DIR}
+
+DOCA_OS_VERSION="ubuntu2204"
+DOCA_PKG_LINK="https://www.mellanox.com/downloads/DOCA/DOCA_v${DOCA_VERSION}/host/doca-host_${DOCA_VERSION}-204000-24.04-${DOCA_OS_VERSION}_amd64.deb"
+
+# Upgrade the base packages (diff between image and Canonical upstream repo)
+apt update -y
+apt upgrade -y
+
+# Install wget
+apt install -y --no-install-recommends wget
+
+wget -qO - ${DOCA_PKG_LINK} -O doca-host.deb
+apt install ./doca-host.deb
+apt update
+apt install -y doca-all
+apt install -y doca-gpu doca-gpu-dev
+
+# Now install the gdrcopy library according to: https://github.com/NVIDIA/gdrcopy
+GDRCOPY_DIR=${WORKING_DIR}/gdrcopy
+
+if [[ ! -d "${GDRCOPY_DIR}" ]] ; then
+    git clone https://github.com/NVIDIA/gdrcopy.git ${GDRCOPY_DIR}
+    cd ${GDRCOPY_DIR}
+else
+    cd ${GDRCOPY_DIR}
+    git pull https://github.com/NVIDIA/gdrcopy.git
+fi
+
+make lib lib_install

examples/doca/README.md

@@ -15,7 +15,10 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-# DOCA Sensitive Information Detection Example
+# DOCA GPU Real-Time traffic analysis
+
+Examples in this directory use the DOCA Source Stage to receive and pre-process network packets in real-time before passing packets info to the next Morphues stages.
+
 ## Obtaining the Morpheus DOCA Container
 DOCA Support is in early access and may only be used via the Morpheus DOCA Container found in NGC. Please speak to your NVIDIA Morpheus contact for more information.
 
@@ -25,7 +28,17 @@ The container must be run in privileged mode and mount in hugepages as configure
 docker run -v /dev/hugepages:/dev/hugepages --privileged --rm -ti --runtime=nvidia --net=host --gpus=all --cap-add=sys_nice ${MORPHEUS_DOCA_IMAGE} bash
 ```
 
+# Preparing the environment
+
+Prior to running the example, the `rdma-core` conda package needs to be _removed by force_ from the conda environment, otherwise the environment is incompatible with the DOCA-provided packages.
+```
+conda remove --force rdma-core
+```
+
+For more info about how to configure the machine, please refer to the [DOCA GPUNetIO programming guide](https://docs.nvidia.com/doca/sdk/doca+gpunetio/index.html).
+
 ## Finding the GPU and NIC PCIe Addresses
+
 The DOCA example requires specifying the PCIe Address of both the GPU and NIC explicitly. Determining the correct GPU and NIC PCIe Addresses is non-trivial and requires coordinating with those who have configured the physical hardware and firmware according to the DOCA GPUNetIO documentation, but the following commands can help find a NIC and GPU situation on the same NUMA node.
 ```
 $ lspci -tv | grep -E "NVIDIA|ella|(^\+)|(^\-)"
@@ -59,17 +72,61 @@ cf:00.0 3D controller: NVIDIA Corporation Device 20b9 (rev a1)
 ```
 We can see the GPU's PCIe address is `cf:00.0`, and we can infer from the above commands that the nearest ConnectX-6 NIC's PCIe address is `cc:00.*`. In this case, we have port `1` physically connected to the network, so we use PCIe Address `cc:00.1`.
 
-## Running the Example
-The DOCA example is similar to the Sensitive Information Detection (SID) example in that it uses the `sid-minibert` model in conjunction with the `TritonInferenceStage` to detect sensitive information. The difference is that the sensitive information we will be detecting is obtained from a live TCP packet stream provided by a `DocaSourceStage`.
 
-Prior to running the example, the `rdma-core` conda package needs to be _removed by force_ from the conda environment, otherwise the environment is incompatible with the DOCA-provided packages.
+## Running the example for UDP traffic analysis
+
+In case of UDP traffic, the sample will launch a simple pipeline with the DOCA Source Stage followed by a Monitor Stage to report number of received packets.
+
 ```
-conda remove --force rdma-core
+python3 ./examples/doca/run_udp_raw.py --nic_addr 17:00.1 --gpu_addr ca:00.0 --traffic_type udp
+```
+UDP traffic can be easily sent with nping to the interface where Morpheus is listening:
+```
+nping --udp -c 100000 -p 4100 192.168.2.27 --data-length 1024 --delay 0.1ms
+```
+
+Morpheus output would be:
+```
+====Pipeline Pre-build====
+====Pre-Building Segment: linear_segment_0====
+====Pre-Building Segment Complete!====
+====Pipeline Pre-build Complete!====
+====Registering Pipeline====
+====Building Pipeline====
+EAL: Detected CPU lcores: 64
+EAL: Detected NUMA nodes: 2
+EAL: Detected shared linkage of DPDK
+EAL: Multi-process socket /var/run/dpdk/rte/mp_socket
+EAL: Selected IOVA mode 'PA'
+EAL: VFIO support initialized
+TELEMETRY: No legacy callbacks, legacy socket not created
+EAL: Probe PCI driver: mlx5_pci (15b3:a2dc) device: 0000:ca:00.0 (socket 1)
+EAL: Probe PCI driver: gpu_cuda (10de:2331) device: 0000:17:00.0 (socket 0)
+====Building Pipeline Complete!====
+DOCA GPUNetIO rate: 0 pkts [00:00, ? pkts/s]====Registering Pipeline Complete!====
+====Starting Pipeline====
+====Pipeline Started====
+====Building Segment: linear_segment_0====
+Added source: <from-doca-0; DocaSourceStage(nic_pci_address=ca:00.0, gpu_pci_address=17:00.0, traffic_type=udp)>
+  └─> morpheus.MessageMeta
+Added stage: <monitor-1; MonitorStage(description=DOCA GPUNetIO rate, smoothing=0.05, unit=pkts, delayed_start=False, determine_count_fn=None, log_level=LogLevels.INFO)>
+  └─ morpheus.MessageMeta -> morpheus.MessageMeta
+====Building Segment Complete!====
+DOCA GPUNetIO rate: 100000 pkts [00:12, 10963.39 pkts/s]
+```
+
+As the DOCA Source stage output packets in the new RawMessage format that not all the Morpheus stages may support, there is an additional stage named DOCA Convert Stage which transform the data RawMessage to the Messagemeta format.
+
 ```
+python3 ./examples/doca/run_udp_convert.py --nic_addr 17:00.1 --gpu_addr ca:00.0 --traffic_type udp
+```
+
+## Doca Sensitive Information Detection example for TCP traffic
 
+The DOCA example is similar to the Sensitive Information Detection (SID) example in that it uses the `sid-minibert` model in conjunction with the `TritonInferenceStage` to detect sensitive information. The difference is that the sensitive information we will be detecting is obtained from a live TCP packet stream provided by a `DocaSourceStage`.
 To run the example from the Morpheus root directory and capture all TCP network traffic from the given NIC, use the following command and replace the `nic_addr` and `gpu_addr` arguments with your NIC and GPU PCIe addresses.
 ```
-# python examples/doca/run.py --nic_addr cc:00.1 --gpu_addr cf:00.0 --traffic_type tcp
+# python examples/doca/run_tcp.py --nic_addr cc:00.1 --gpu_addr cf:00.0 --traffic_type tcp
 ```
 ```
 ====Registering Pipeline====
@@ -119,45 +176,3 @@ AddClass rate: 0 pkts [00:09, ? pkts/s]
 ```
 The output can be found in `doca_output.csv`
 
-## Running the Example for UDP traffic
-
-In case of UDP traffic, the sample will launch a simple pipeline with the DOCA Source Stage followed by a Monitor Stage to report number of received packets.
-Command line is similar to the TCP example.
-
-```
-python3 ./examples/doca/run.py --nic_addr 17:00.1 --gpu_addr ca:00.0 --traffic_type udp
-```
-UDP traffic can be easily sent with nping to the interface where Morpheus is listening:
-```
-nping --udp -c 100000 -p 4100 192.168.2.27 --data-length 1024 --delay 0.1ms
-```
-
-Morpheus output would be:
-```
-====Pipeline Pre-build====
-====Pre-Building Segment: linear_segment_0====
-====Pre-Building Segment Complete!====
-====Pipeline Pre-build Complete!====
-====Registering Pipeline====
-====Building Pipeline====
-EAL: Detected CPU lcores: 64
-EAL: Detected NUMA nodes: 2
-EAL: Detected shared linkage of DPDK
-EAL: Multi-process socket /var/run/dpdk/rte/mp_socket
-EAL: Selected IOVA mode 'PA'
-EAL: VFIO support initialized
-TELEMETRY: No legacy callbacks, legacy socket not created
-EAL: Probe PCI driver: mlx5_pci (15b3:a2dc) device: 0000:ca:00.0 (socket 1)
-EAL: Probe PCI driver: gpu_cuda (10de:2331) device: 0000:17:00.0 (socket 0)
-====Building Pipeline Complete!====
-DOCA GPUNetIO rate: 0 pkts [00:00, ? pkts/s]====Registering Pipeline Complete!====
-====Starting Pipeline====
-====Pipeline Started====
-====Building Segment: linear_segment_0====
-Added source: <from-doca-0; DocaSourceStage(nic_pci_address=ca:00.0, gpu_pci_address=17:00.0, traffic_type=udp)>
-  └─> morpheus.MessageMeta
-Added stage: <monitor-1; MonitorStage(description=DOCA GPUNetIO rate, smoothing=0.05, unit=pkts, delayed_start=False, determine_count_fn=None, log_level=LogLevels.INFO)>
-  └─ morpheus.MessageMeta -> morpheus.MessageMeta
-====Building Segment Complete!====
-DOCA GPUNetIO rate: 100000 pkts [00:12, 10963.39 pkts/s]
-```

examples/doca/run_tcp.py

@@ -20,8 +20,9 @@
 from morpheus.config import CppConfig
 from morpheus.config import PipelineModes
 from morpheus.pipeline.linear_pipeline import LinearPipeline
-from morpheus.stages.doca.doca_convert_stage import DocaConvertStage
+from morpheus.messages import RawPacketMessage
 from morpheus.stages.doca.doca_source_stage import DocaSourceStage
+from morpheus.stages.doca.doca_convert_stage import DocaConvertStage
 from morpheus.stages.general.monitor_stage import MonitorStage
 from morpheus.stages.inference.triton_inference_stage import TritonInferenceStage
 from morpheus.stages.output.write_to_file_stage import WriteToFileStage
@@ -77,11 +78,11 @@ def run_pipeline(pipeline_batch_size, model_max_batch_size, model_fea_length, ou
     config.mode = PipelineModes.NLP
 
     # Below properties are specified by the command line
-    config.num_threads = 1
+    config.num_threads = 5
+    config.edge_buffer_size = 1024
     config.pipeline_batch_size = pipeline_batch_size
     config.model_max_batch_size = model_max_batch_size
     config.feature_length = model_fea_length
-    config.mode = PipelineModes.NLP
 
     config.class_labels = [
         'address',
@@ -96,8 +97,6 @@ def run_pipeline(pipeline_batch_size, model_max_batch_size, model_fea_length, ou
         'user'
     ]
 
-    config.edge_buffer_size = 128
-
     pipeline = LinearPipeline(config)
 
     # add doca source stage

morpheus/stages/doca/doca_source_stage.py

@@ -20,15 +20,14 @@
 from morpheus.config import Config
 from morpheus.config import PipelineModes
 from morpheus.messages import RawPacketMessage
-from morpheus.pipeline.preallocator_mixin import PreallocatorMixin
 from morpheus.pipeline.single_output_source import SingleOutputSource
 from morpheus.pipeline.stage_schema import StageSchema
 
 logger = logging.getLogger(__name__)
 
 
 @register_stage("from-doca-source", modes=[PipelineModes.NLP])
-class DocaSourceStage(PreallocatorMixin, SingleOutputSource):
+class DocaSourceStage(SingleOutputSource):
     """
     A source stage used to receive raw packet data from a ConnectX-6 Dx NIC.