NetJury Scripting Examples

Transcription

1 NetJury Scripting Examples The NetJury Scripting Language (NSL) is used to configure and execute test cases in scripting mode. For more information on other modes of operation, please refer to the Quick Start Guide or the User manual. This document shall give a short overview of the NSL and how to use it in the scripting mode. Architecture of the Programmable Logic Subsystem The programming logic (PL) subsystem of the NetJury controls the high precision real-time functions. The Ethernet ports A to D are directly connected to the PL, this enables full control over all Ethernet frames in the real-time subsystem. Figure 1: Diagram of the PL Subsystem Figure 1 gives an overview of the PL subsystem with the internal components of ports A to D shown in detail in port A. The PL subsystem components are programmed from the PS with the NetJury Scripting Language (NSL). NSL scripts are interpreted and executed directly in the PL. This allows to program test case sequences with absolute real-time precision. The sections below describe the components of the PL subsystem. 1

2 Frame Analyzers Each port contains a programmable frame analyzer to analyze and evaluate ingress traffic. Analyzers inspect the frame data and generate statistics that can be used for automatic test result evaluation and test report generation: Frame data inspection on Ethernet layer 1 Pattern matching and filtering Frame counters, positive/negative result counters Frame tagging with event specific information codes Example: Inspect ingress frames from sender with source address 0x72 0x10 0xED 0x3A 0x68 0xB8 and create the information tag 0xA2 if the payload size is larger than 50 octets. Frame Generators Four frame generators assigned to the ports A to D can be programmed to generate customized frames and send them at a given time: Specify the frame data directly with NSL Use increments and register values to create dynamic frame data Forward received frames and selectively manipulate received frame data Setup loops for deterministic frame generation at wire-speed Figure 2 shows the data fields that can be accessed by analyzers and generators Figure 2: Frame Generator and Analyzer data field access Example: Modify the 28 th byte of the payload of a received frame with the value in register 0x02 and send it 128μs later to the receiver with address 0x72 0x10 0xED 0x3A 0x68 0xB8. 2

3 NSL Script Execution Overview NSL scripts are organized in human readable text files on the Linux file system as *.nsl files. Once the script implementation is finished, the files can be passed as argument to the NSL parser application which triggers the corresponding functions in the programmable logic (PL) subsystem through the On-Chip-Bus (OCB). Figure 3: The diagram shows the control path of the NSL scripting components. Log data and analyzer statistics generated by the analyzers are transferred via the OCB interface from the PL back to the PS where the NSL parser creates a *.log file. A script file <name>_sim<n>.nsl will generate a reporting file <name>_log<n>.log In order to execute a NSL script file, the NetJury must be configured to scripting mode before launching a NSL script: > netjury-config scripting To launch a NSL script and print the report to a log file execute the following command: > netjury_testscript_parser <scriptname> Figure 4: Example section of an NSL script supervision_frame.nsl 3

4 NSL Test Case Examples Example 1 Address Resolution Protocol (ARP) This example shows a how to send ARP requests to the DUT and evaluation the ARP responses of the DUT. Note: The advantage of ARP is that nearly all network devices support ARP therefore it is well suitable to trigger the DUT response. (In comparison, many devices do not support the well-known ping protocol). Figure 5: Test setup to use a standard PC as DUT (Port A) and Host PC (Console) in parallel. Test Environment (see Figure 5) 1. Connect the LAN interface of the DUT (standard PC or other Ethernet device) to the NetJury Ethernet Test Interface A. 2. Attach the console port of the NetJury to a computer using a standard USB cable. The device driver should be installed automatically on your computer. 3. Configure the PC with the static IP address as shown in the figure above. 4. Set the NetJury to scripting mode and launch the script by the following commands: netjury-config scripting cd /home/root/scripting_example/ netjury_testscript_parser arp_exemple.nsl 5. The test result log information is printed as console output TestScript Execution SUCCESSFUL CHECK = 3 PASS = 3 FAIL = Alternatively the test result log information may be redirected to a log file by the following command: netjury_testscript_parser arp_exemple.nsl 2>&1 tee arp_exemple.log 6. The generated frames can be observed on the Host PC using Wireshark. Recommendations: If the MAC address of the DUT would be known, the analyzer could be optimized to keep only track of the packets coming from the DUT (ignoring all packets with different MAC).It would be a good exercise to identify the MAC address of the DUT and add the filtering to this example test case. 4

5 The ARP example NSL script set the generator and analyzer as follows: Generator Setup HEADER_SIZE 14 PAYLOAD_SIZE 46 CRC_MODE NUMBER OF FRAME 10 INTERGAP FRAME DELAY 0 Frame Setup SRC ADDRESS DEST ADDRESSS ETH_FIELD PAYLOAD 1: calculate FCS automatically 12 (bytes) [NETJURY_MAC_ADDR] Broadcast ARP (0x0806) Payload is set according to the ARP protocol: Sender IP address: [NETJURY_IP_ADDR] Sender MAC address: [NETJURY_MAC_ADDR] Target IP address: (DUT) Target MAC address: null Analyzer Setup FRAME EXPECTED 0: (will not stop the Analyzer ) FRAME EXPECTED_OK CRC_MODE Frame Setup SRC ADDRESS DEST ADDRESSS ETH_FIELD PAYLOAD_SIZE 46 PAYLOAD 10: (Analyzer expects ten frames) 1: calculate FCS automatically Ignored [NETJURY_MAC_ADDR] ARP (0x0806) All payload is compared (except the sender MAC address field) to the expected ARP protocol: Sender IP address: (DUT) Sender MAC address: ignored Target IP address [NETJURY_IP_ADDR] Target MAC address : [NETJURY_MAC_ADDR] Execution PASS/FAIL criteria The conditions for a positive test result for each test run: Successful frame transmissions by the generator. The test sequence takes max 5sec. The analyzer reports with state FRAME EXPECTED_OK The test case reports PASS if all test sequences have been successful. Therefore the script only controls the counter FRAME EXPECTED_OK in order to discard other frames to be received in between. This counter must be equal to the number of FRAME_EXPECTED_OKs in the analyzer. 5

6 Example 2 Ethernet Throughput Test This example generates a packet stream that generates a predefined throughput. Note: The size of the interface gap (see figure 2) specifies the pause between two consecutive Ethernet frames. By manipulating the interface gap, the throughput can be precisely controlled. Figure 6: Test setup to use a standard PC as DUT (Port A) and Host PC (Console). Test Environment (see figure 1) 1. Connect the LAN interface of the DUT (standard PC or other Ethernet device) to the NetJury Ethernet Test Interface A. 2. Attach the console port of the NetJury to a computer using a standard USB cable. The device driver should be installed automatically on your computer. 3. There is no need to configure the IP address of the DUT as the generated packet stream is a broadcasts stream. 4. Set the NetJury to scripting mode and launch the script by the following commands: netjury-config scripting cd /home/root/scripting_example/ netjury_testscript_parser throughput_exemple.nsl 5. The test result log information is printed as console output PASS Recommendations: Modify the interframe gap in the NSL script and observe how the overall throughput will change. 6

7 The ARP example NSL script set the generator and analyzer as follows: Generator setup HEADER_SIZE 14 PAYLOAD_SIZE 500 CRC_MODE NUMBER OF FRAME INTERGAP FRAME DELAY 0 Frame Setup SRC ADDRESS DEST ADDRESSS ETH_FIELD PAYLOAD 1: calculate FCS automatically ( maximum) Edit this value in the script to modify the throughput. The section is highlighted with the comments below: <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< EDIT <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< STOP Unit: byte Default value: 12 Maximum value: [NETJURY_MAC_ADDR] Broadcast ARP (0x0806) Fill with 0x00 Execution PASS/FAIL criteria The test case will report PASS as soon as all frames have been generated and transmitted. Note: The generator can send a maximum of frames per test run. If it is required to generate a longer test sequence, this may be achieved by stopping and restarting the generator when it reaches the maximum number of To do so, simply open the NSL file and duplicate the highlighted part (use //insert here// section) REPORT --Start sending the frame and checking received frames OCBM_WRITE TXA TR_CTRL 1 ETH_TXRX_START STARTSTOP_ALL LOOP WAIT_FOR 100 us EXITONCHECKM TXA TR_STAT 0x2 0x2 masked out) ENDLOOP REPORT REPORT Check the status of TXA OCBM_CHECK TXA TR_STAT 0x2 0x2 ETH_TXRX_STOP STARTSTOP_ALL OCBM_WRITE TXA TR_CTRL 0 --exit loop if bit 2 is 1 (== done, all others bits are //INSERT HERE// WAIT_FOR 1 ms REPORT END 7