Skip to content

Commit

Permalink
example: Update README with the information on socket pktio scripts
Browse files Browse the repository at this point in the history
Scripts required to run with socket pktios were outdated and
were replaced.

Signed-off-by: Bogdan Pricope <[email protected]>
Reviewed-by: Matias Elo <[email protected]>
  • Loading branch information
bogdanPricope authored and MatiasElo committed May 13, 2020
1 parent 03dba93 commit f895ea8
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions example/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
Environment considerations
===============================================================================

Socket pktio
=============
Before running example applications with linux interfaces as socket pktios
you need to block access for the other applications to those linux interfaces:

# ./scripts/ofp_linux_interface_acquire.sh <interface_name>

To restore access to a linux interface, call:

# ./scripts/ofp_linux_interface_release.sh.sh <interface_name>

Note: Super user rights are required to run those scripts.


Open IP Fast Path Examples
===============================================================================

Expand Down Expand Up @@ -28,15 +45,15 @@ local sockets opened for forwarding. More information available on the OpenFastP

webserver
-------------------------------------------------------------------------------
This is a simple web server that uses sockets as expected.
This is a simple web server that uses ofp sockets.

To setup and run the web server:
# setup www_dir (default: /var/www) do:
To setup the web server:
Set the environment variable www_dir to the path of the folder containing
the web pages:
export www_dir=/path/to/your/www
./scripts/start_webserver.sh <ethX> <IP>

# To stop the web server:
./scripts/start_webserver.sh <ethX>
To run the web server:
# ./webserver -i <interface_name> -c <core_number>

By default the webserver uses ofp_select to monitor the file descriptors. By
defining CPPFLAGS='-DUSE_EPOLL' when running configure the webserver can be set to
Expand Down

0 comments on commit f895ea8

Please sign in to comment.