Getting Started with the SDAccel Environment on Nimbix Cloud

Transcription

1 Getting Started with the SDAccel Envirnment n Nimbix Clud

2 Revisin Histry The fllwing table shws the revisin histry fr this dcument. Date Versin Changes 09/17/ Updated figures thrughut Updated bard cnfiguratins Changes t lgin URL 08/16/ Changes are: Mdified Lgin URL. 06/20/ Changes are: Updated fr release. Changed Nimbix t Material Cmpute flw. Updated figures thrughut. Added reference t the Xilinx VU9P Develper Bard DSA file. 12/15/ Updated supprted bard cnfiguratins. Updated cmmands thrughut. Updated Figure /14/ Initial Xilinx Release Getting Started: SDAccel Envirnment n Nimbix Clud 2

3 Table f Cntents Revisin Histry... 2 Chapter 1: SDAccel Envirnment n Nimbix Clud Overview... 4 Intrductin... 4 Chapter 2: Nimbix Accunt Creatin, Lgin, and Setup... 6 Creating an Accunt... 6 Lgging int Yur Nimbix Accunt... 7 Transferring Data t and frm Nimbix... 8 /data Directry: Imprtant Ntes Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Intrductin Step 1: Lgin t yur Nimbix accunt Step 2: Lad SDAccel Examples frm the GitHub Site Step 3: Cmpile the Design Step 4: Terminate the Sessin Step 5: Deply the Applicatin Getting Started: SDAccel Envirnment n Nimbix Clud 3

4 Chapter 1: SDAccel Envirnment n Nimbix Clud Overview Intrductin This dcument demnstrates hw t get started using SDAccel Envirnment in the Nimbix Clud. The SDAccel Envirnment, a member f the SDx family f develpment envirnments fr systems and sftware engineers, enables up t 25X better perfrmance/watt fr data center applicatin acceleratin leveraging FPGAs. Nimbix Inc has partnered with Xilinx t deliver an pprtunity t test drive SDAccel and see hw FPGA-based acceleratin can speed-up yur OpenCL C, C/C++ and RTL Kernels. The Nimbix Clud prvides a purpse-built cmpute clud fr big data and cmputatin. It nw hsts the SDAccel develpment envirnment fr cmpanies wh want t streamline evaluatins and accelerate FPGA OpenCL kernels. Yu can use multiple appraches when wrking with Nimbix Clud, such as: Using Nimbix t cmpile and deply yur applicatin with Xilinx FPGAs Cmpiling the applicatin n yur lcal machine, transferring the cmpiled files t Nimbix, and then deplying the applicatin n Nimbix This dcument describes hw t use bth appraches and cntains a step-by-step tutrial t help familiarize yu with using SDAccel in the Nimbix envirnment. IMPORTANT: When cmpiling the applicatin t be deplyed n Xilinx FPGAs available in the Nimbix Clud, yu need specify ne f the fllwing bard cnfiguratins: Nimbix Supprted Xilinx SDx (SDAccel) Develpment SDAccel develpment app name Develpment tlkit installed Built-in FPGA Bard supprts (DSA) Xilinx SDAccel Develpment _p SDx _p Xilinx KCU1500 Acceleratr (DSA: xilinx_kcu1500_dynamic_5_0) Xilinx VCU1525 Acceleratr (DSA: xilinx_vcu1525_dynamic_5_1) Xilinx SDAccel Develpment SDx Xilinx KCU1500 Acceleratr (DSA: xilinx_kcu1500_dynamic_5_0) Xilinx VCU1525 Acceleratr (DSA: xilinx_vcu1525_dynamic_5_1) Xilinx SDAccel Develpment XDF SDx Xilinx Alve U200 Acceleratr (DSA: xilinx_u200_xdma_201820_1) Xilinx Alve U250 Acceleratr (DSA: xilinx_u250_xdma_201820_1) Getting Started: SDAccel Envirnment n Nimbix Clud 4

5 Chapter 1: SDAccel Envirnment n Nimbix Clud Overview Nimbix Supprted Xilinx SDx (SDAccel) Runtime and Develper Bards Xilinx FPGA Bard Acces App Runtime/Driver installed Machine Type FPGA Bard (DSA) Xilinx FPGA (with _p Runtime) Xilinx FPGA (with Runtime) Xilinx Alve FPGA (with XRT Runtime) SDx _p nx4a Xilinx KCU1500 Acceleratr (DSA: xilinx_kcu1500_dynamic_5_0) nx5a Xilinx VCU1525 Acceleratr (DSA: xilinx_vcu1525_dynamic_5_1) SDx nx4b Xilinx KCU1500 Acceleratr (DSA: xilinx_kcu1500_dynamic_5_0) nx5b Xilinx VCU1525 Acceleratr (DSA: xilinx_vcu1525_dynamic_5_1) XRT nx5u Xilinx Alve U200 Acceleratr (DSA: xilinx_u200_xdma_201820_1) nx6u Xilinx Alve U250 Acceleratr (DSA: xilinx_u250_xdma_201820_1) Getting Started: SDAccel Envirnment n Nimbix Clud 5

6 Chapter 2: Nimbix Accunt Creatin, Lgin, and Setup Creating an Accunt T create an accunt, d the fllwing: 1. Register fr the SDAccel Envirnment at the Nimbix website. Navigate with yur brwser t 2. The fllwing figure shws the Lgin page. 3. Cmplete the frm. Figure 1: Nimbix Clud Landing Page Upn apprval f yur accunt, yu receive an cnfirmatin alng with infrmatin intrducing t cmplete the sign up and registratin prcess Getting Started: SDAccel Envirnment n Nimbix Clud 6

7 Chapter 2: Nimbix Accunt Creatin, Lgin, and Setup Lgging int Yur Nimbix Accunt T lgin t yur accunt: 1. Navigate t Figure 2: Nimbix Lgin Page 2. Enter yur user name and a passwrd and then click Lg In t lgin int yur accunt. When yu lgin t yur accunt, the Nimbix interface Cmpute pens. Figure 3: Dashbard Page Getting Started: SDAccel Envirnment n Nimbix Clud 7

8 Chapter 2: Nimbix Accunt Creatin, Lgin, and Setup The Dashbard prvides yu infrmatin abut: The jbs yu are currently running and their status Previusly run jbs The Cmpute page allws yu t cmpile and deply yur applicatins. Transferring Data t and frm Nimbix When wrking with SDAccel, yu might need t transfer files frm yur machine. Nimbix. SFTP is the preferred file transfer methd. The fllwing instructins demnstrate file transfer using the FileZilla SFTP client sftware. Nte: Fllw this link fr mre infrmatin regarding file transfers. 1. Dwnlad and install FileZilla. 2. Open FileZilla and cnfigure the fllwing: a. In Hst: Specify drp.jarvice.cm b. In Prt: Specify the value 22 Figure 4: FileZilla SFTP client c. In Username: Specify yur Nimbix Username d. The Passwrd: Specify yur JARVICE API key T btain yur API key, lgin t yur Nimbix accunt, g t yur accunt settings and cpy the API Key frm the Settings page, as shwn in Figure 5. Getting Started: SDAccel Envirnment n Nimbix Clud 8

9 Chapter 2: Nimbix Accunt Creatin, Lgin, and Setup Figure 5: API Key n the Settings Page 3. Select the Quickcnnect buttn t cnnect t Nimbix. When the cnnectin establishes successfully, yu see the /data directry n the remte site, as shwn in the fllwing figure: Figure 6: Remte Site data Directry Using FileZilla interface, yu can nw start t transfer files t and frm Nimbix. IMPORTANT: If yu wrk behind a cmpany firewall and are unable t cnnect t Nimbix, speak with yur IT department and request the access t the 22 (TCP) prt. Getting Started: SDAccel Envirnment n Nimbix Clud 9

10 Chapter 2: Nimbix Accunt Creatin, Lgin, and Setup /data Directry: Imprtant Ntes Wrking in the Nimbix envirnment, yu will need t use the /data directry in different situatins, s it is imprtant t understand the fllwing features: Data lcated in the Nimbix /data directry is preserved after yu shut dwn running systems and lgut frm yur Nimbix accunt. Cpy critical files t the /data directry if yu want t preserve them fr later reuse. Yu can als create sub-directries under /data if necessary. The /data directry is where yu need t exchange data between Nimbix and yur lcal machine. Fr example, if yu need cde lcated in yur lcal machine fr SDAccel cmpilatin n Nimbix, transfer this file t the /data directry first and then cpy frm /data t the final flder. The /data directry is the lcatin frm which t deply cmpiled applicatins n FPGAs in the Nimbix Clud. Cpy all necessary files t the /data directry first. Chapter 3: Using the SDAccel Envirnment in Nimbix Clud describes these activities. Getting Started: SDAccel Envirnment n Nimbix Clud 10

11 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Intrductin The tutrial uses the vadd example available in the /getting_started/misc flder at this lcatin: Step 1: Lgin t yur Nimbix accunt 1. G t: Figure 7: Nimbix Accunt Lgin 2. Prvide yur Username and Passwrd and select Lg In. 3. In the pened page, select Cmpute, shwn in the fllwing figure, t pen the Cmpute page. Figure 8: Cmpute The Cmpute page pens, as shwn in the fllwing figure: Getting Started: SDAccel Envirnment n Nimbix Clud 11

12 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Figure 9: The Cmpute Page a. Use SDAccel Develpment t: Cmpile and run yur applicatin in CPU and Hardware Emulatin mdes. Cmpile yur applicatin and transfer the cmpiled design t the /data directry fr Hardware deplyment using FPGA bards hsted by Nimbix. b. Use SDAccel Runtime t: Deply yur applicatin n the FPGA machines in the Nimbix Clud. Fr applicatin deplyment, the cmpiled applicatin and data files shuld be lcated in the /data directry. Getting Started: SDAccel Envirnment n Nimbix Clud 12

13 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Step 2: Lad SDAccel Examples frm the GitHub Site 1. Launch SDAccel Develpment Envirnment 2. On the Cmpute page, select SDAccel Develpment XDF. 3. Select the Desktp Mde, shwn in the fllwing figure: Figure 10: Selecting Desktp Mde 4. The Builder page pens. Yu can change default ptins, such as the machine cnfiguratin t use, windw size, and s frth, if necessary. The fllwing figure shws the tp-level Desktp Mde page. When yur cnfiguratins are set, cntinue the jb submissin by pressing Submit. Figure 11: Task Builder This autmatically makes the Dashbard page active, as shwn in Figure 12, where yu can see that yu have a new active jb. NOTE: If yu wish t cpy and paste cmmands frm this dcument directly t the desktp envirnment, yu can cnnect with a VNC client r by using ssh t lg in t a terminal with the credentials prvided in the Dashbard Current view as in Figure 12. Getting Started: SDAccel Envirnment n Nimbix Clud 13

14 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Figure 12: Dashbard Displaying an Active Jb 5. Click in the desktp preview space t pen a new tab with an interactive desktp sessin. Nte: It can take several secnds befre the desktp preview pens. The ready-t-use Linux desktp envirnment becmes available, as shwn in the fllwing figure: Figure 13: Ready-t-Use Linux Desktp Getting Started: SDAccel Envirnment n Nimbix Clud 14

15 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Tw icns are n the desktp: Terminal: Opens a new terminal with a ready-t-use SDAccel envirnment. data: The directry in which yu transfer the cmpiled applicatins fr hardware deplyment. See /data Directry: Imprtant Ntes fr mre infrmatin abut the /data directry. Dwnlad the Latest SDAccel Examples frm GitHub 1. Open the Terminal. 2. In the Terminal, enter the fllwing cmmand t get the latest versin f the SDAccel examples hsted n GitHub: git clne --depth 1 /data/examples After the cmmand executes, the terminal shuld lk like the fllwing figure: Figure 14: Terminal with Latest Versin f SDAccel Examples Getting Started: SDAccel Envirnment n Nimbix Clud 15

16 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Step 3: Cmpile the Design This tutrial uses a simple vadd example. In the pened Terminal, g t the /data/examples/getting_started/misc/vadd directry by typing the fllwing cmmand: cd /data/examples/getting_started/misc/vadd Cmpile and Run the Applicatin in CPU Emulatin Mde The CPU Emulatin mde verifies functinal crrectness f the applicatin. T cmpile the vadd example fr a CPU Emulatin mde, d the fllwing: 1. Run the fllwing cmmand in an pened Terminal frm the vadd directry: make TARGETS=sw_emu DEVICES=xilinx_u200_xdma_201820_1 all This cmmand generates: A hst executable, named vadd in the current directry. A krnl_vadd.sw_emu.xilinx_ u200_xdma_201820_1.xclbin file (XCLBIN) lcated in the xclbin directry. 2. Befre running the applicatin in CPU Emulatin mde, run the fllwing cmmands: exprt XCL_EMULATION_MODE=sw_emu emcnfigutil --platfrm 'xilinx_u200_xdma_201820_1' --nd 1 These cmmands set the library path, the XCL_EMULATION_MODE variable, and the DSA file. 3. Nw yu can launch the applicatin using the fllwing cmmand:./vadd Nte: This applicatin uses the XCL_EMULATION_MODE variable and discvered emulated devices t select the crrect XCLBIN file. 4. Upn successful executin f the applicatin, the fllwing utput displays:... Result Match: i = 1021 CPU result = 3063 Krnl Result = 3063 Result Match: i = 1022 CPU result = 3066 Krnl Result = 3066 Result Match: i = 1023 CPU result = 3069 Krnl Result = 3069 TEST PASSED Getting Started: SDAccel Envirnment n Nimbix Clud 16

17 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Cmpile and Run the Applicatin in Hardware Emulatin Mde The Hardware Emulatin mde checks the crrectness f the lgic generated fr the custm cmpute units, and estimates the applicatin perfrmance. T cmpile the example fr a Hardware Emulatin mde: 1. Run the fllwing cmmand in an pened Terminal frm the vadd directry: make TARGETS=hw_emu DEVICES=xilinx_u200_xdma_201820_1 check This cmmand generates: A hst executable, named vadd in the current directry. A krnl_vadd.hw_emu.xilinx_u200_xdma_201820_1.xclbin (XCLBIN) file lcated in the xclbin directry. IMPORTANT: If yu: Cntinue t use the same Terminal yu used t run CPU Emulatin mde, then befre running the applicatin in a Hardware Emulatin mde, run the fllwing cmmand: exprt XCL_EMULATION_MODE=hw_emu Cmpiled the applicatin fr Hardware Emulatin mde using a different terminal, run the fllwing cmmands first: exprt XCL_EMULATION_MODE=hw_emu 2. Nw yu can launch the applicatin using the fllwing cmmand:./vadd Nte: This applicatin uses the XCL_EMULATION_MODE variable and discvered emulated devices t select the crrect XCLBIN file. 3. Upn successful executin f the applicatin, the fllwing utput displays:... Result Match: i = 1021 CPU result = 3063 Krnl Result = 3063 Result Match: i = 1022 CPU result = 3066 Krnl Result = 3066 Result Match: i = 1023 CPU result = 3069 Krnl Result = 3069 TEST PASSED 4. After the Hardware emulatin has been cmpleted, yu can explre the applicatin perfrmance by pening the sdaccel_prfile_summary.html file in the Firefx Web Brwser using the fllwing cmmand: firefx sdaccel_prfile_summary.html Yu shuld see the reprt shwn in Figure 15. Getting Started: SDAccel Envirnment n Nimbix Clud 17

18 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Figure 15: SDAccel Prfile Summary Reprt Getting Started: SDAccel Envirnment n Nimbix Clud 18

19 Cmpile and Prepare the Applicatin fr Hardware Deplyment Chapter 3: Using the SDAccel Envirnment in Nimbix Clud 1. T cmpile the example fr hardware deplyment, run the fllwing cmmand in an pened Terminal frm the getting_started/vadd directry: make TARGETS=hw DEVICES=xilinx_u200_xdma_201820_1 all This cmmand generates: A hst executable named vadd in the current directry. A krnl_vadd.hw.xilinx_u200_xdma_201820_1.xclbin (XCLBIN) file lcated in the xclbin directry. 2. T simplify the applicatin deplyment n Nimbix, the hst s executable shuld have the.exe file extensin. Cpy the vadd executable t vadd.exe with the fllwing cmmand: mv vadd vadd.exe IMPORTANT: At this step, yu can clse the current SDAccel Develpment sessin; hwever, all files nt lcated in the /data directry will be lst. Cpy any files yu wish t preserve t the /data directry befre yu cntinue. Step 4: Terminate the Sessin T terminate the current sessin: 1. Frm the Dashbard, select shutdwn. 2. Select Yes. Figure 16: Shutdwn Optin Yu shuld see in the Dashbard page that the prcess status is Cmpleted. Yu shuld als receive a crrespnding . Figure 17: Instance Status Check: Cmpleted WARNING! After terminating the sessin, yu might see that the jb is still Prcessing, as shwn in the fllwing figure. Getting Started: SDAccel Envirnment n Nimbix Clud 19

20 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Figure 18: Instance Status Check: Prcessing 3. If the jb is still prcessing, check Frce Stp, select Yes, then select Shutdwn t terminate the jb. Figure 19: Instance Management Buttns Getting Started: SDAccel Envirnment n Nimbix Clud 20

21 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Step 5: Deply the Applicatin The applicatin is nw cmpiled and all the necessary files fr hardware deplyment are lcated in the /data directry. T deply the applicatin: 1. Frm the Cmpute page f the Nimbix Envirnment, select SDAccel Runtime XDF> batch, shwn in the fllwing figure. Figure 20: Selecting Batch Wrkflw 2. On the pened page: a. Select the target platfrm frm the Select Machine drp-dwn menu. Fr this example, select Alve U200 FPGA: Figure 21: Selecting the Bard b. Select the vadd.exe hst executable file lcated in the /examples/getting_started/misc/vadd/ directry frm the Executable dialg bx, shwn in the fllwing figure. Figure 22: Selecting the Hst Executable File The applicatin autmatically detects the XCLBIN file fr deplyment; n further arguments need t be specified. Figure 23: Arguments Field Nte: The directry where the hst executable file is lcated is cnsidered a current directry by Nimbix. Getting Started: SDAccel Envirnment n Nimbix Clud 21

22 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud c. T btain a graphical Trace reprt, check ne f the fllwing ptins: Figure 24: TRACE Reprt Optins d. Select Submit t launch the deplyment and btain the results. If the executin f the applicatin is successful, the fllwing status displays: Figure 25: Successful Applicatin Executin Status Nimbix sends yu the applicatin lg file by autmatically. e. Select the SDAccel Runtime: batch jb t expand it, and then select Output t see the lg file generated by the applicatin. Yu shuld see lg messages similar t the CPU and Hardware Emulatin mdes, as shwn in Figure 26. Getting Started: SDAccel Envirnment n Nimbix Clud 22

23 Chapter 3: Using the SDAccel Envirnment in Nimbix Clud Figure 26: Jb Output In additin t the with the lg file yu receive frm Nimbix, yu can save the lg file n yur lcal machine by clicking the Dwnlad buttn in the utput windws, as shwn in the fllwing figure: Figure 27: Dwnlad Lg File The applicatin autmatically generates the perfrmance reprt in the sdaccel_prfile_summary.html file, lcated in the xbinst directry. T explre this reprt yu can either: Restart the SDAccel Envirnment and pen this file using the Firefx Web Brwser. Cpy the file t yur lcal machine using the methd described in Transferring Data t and frm Nimbix and then pening it using yur Web Brwser. Getting Started: SDAccel Envirnment n Nimbix Clud 23

24 Getting Started: SDAccel Envirnment n Nimbix Clud 24