reclick

ReClick - A framework for network virtualization using programmable hardware

ReClick Installation and Usage

---

Requirements

---

Java SE 1.7 or higher
Eclipse IDE

Installation

---

1. Download ReClick package from Github
2. Unzip the package
3. Install Eclipse IDE in your workstation
4. Open Eclipse and specify a workspace of your choice
5. Now import ReClick as an eclipse project - Select File -> Import -> Existing projects into workspace -> Select root directory -> Specify the directory of ReClick (directory where the build_reclick.xml file exists) -> Finish

Project organization

---

• src

  • reclick [source files for reclick compiler]
  • click [source files for click compiler wrapper]

• config

  • dataplane [location of dataplane verilog produced from click description]
  • tests [location of NetFPGA specific tests for generating packets]
  • .click files provide example Click dataplane configurations

• doc

  • documentation on ReClick grammar
  • elements
    • rtl [Verilog ReClick modules auto-generated by ReClick compiler from components]
    • src [ReClick component library (many elements are work in progress)]
    • miscellaneous verilog files used for compilation

• scripts

  • misc scripts for design automation

• templates

  • internal templates used by ReClick compiler

Build Instructions

---

1. Select Window -> Show View -> Other -> ANT
2. Drag and drop build_reclick.xml to ANT window
3. Drag and drop build_click.xml to ANT window
4. To build ReClick component compiler, expand ReClick tab and double click compile [default] option
5. To build Click dataplane compiler, expand Click tab and double click compile [default] option

Usage Instructions

---

A. Compiling a ReClick component

1. Write your ReClick component and place the component under elements/src folder
2. Click run under reclick in ANT window
3. This will prompt for user input file -> Specify name of reclick file (e.g. DecIPTTL.rclk)
4. After compilation, output will be available under elements/rtl folder with the name .v

A. Compiling a Click dataplane configuration

1. Write your Click configuration and place under config folder (with the file extension .click). Make sure you use components available in the library.
2. Click run under click in ANT window
3. This will prompt for user input file -> Specify name of Click configuration file (e.g. TestDecIPTTL.click)
4. If compilation is successful, a dataplane (dataplane.v) will be generated under config/dataplane folder.
5. The dataplane file can be instantiated within the NetFPGA user datapath.

Contact: [email protected]