TUTORIAL: Quickstart with freediameter

Size: px

Start display at page:

Download "TUTORIAL: Quickstart with freediameter"

Anna Howard
5 years ago
Views:

1 38 TUTORIAL: Quickstart with freediameter How to compile and run freediameter in a simple testbed.

2 Tutorial: Creating a fd testbed 39 Goal : create a simple testbed Two nodes: one client, one server Run a test application ping -like What you need: Two machines (with FQDN in same realm for simplicity) An X.509 certificate hierarchy (CA, 2 certs) See contrib/ca_script for a script for openssl.

3 Prerequisites (in INSTALL file) 40 freediameter dependencies (debian packages) Tools: mercurial, cmake, flex, bison, gcc, make Libs: libsctp-dev, libgcrypt-dev, libgnutls-dev Install all these with your package manager (ex: apt-get) Get the latest freediameter version: 1 st time: hg clone Later: hg pull ; hg update Good Mercurial tutorial:

4 Preparing freediameter: cmake 41 cmake is an autotools equivalent with simpler syntax cmake or cmake-gui Choose the options: Extensions, Dependencies paths, Debug, etc Generate: create the Makefile (same as./configure)

5 cmake in our tutorial 42 Prepare a build directory (out of source): mkdir build && cd build We use these flags (cmake-gui is more friendly): -DBUILD_TEST_APP:BOOL=ON : Include the test application extension -DBUILD_DBG_MONITOR:BOOL=ON : Display some information -DSKIP_TESTS:BOOL=ON : Do not compile the unit tests -DCMAKE_BUILD_TYPE:STRING=Debug : include debug symbols for gdb Generate & check system dependencies: cmake $FLAGS /path/to/source

6 cmake output 43 After running the command you should see: -- Configuring done -- Generating done -- Build files have been written to: /build You can check the generated files, in particular: CMakeCache.txt : contains all configured options include/freediameter/freediameter-host.h : machine-dependent values (such as endianness )

7 Compiling freediameter: make 44 Just issue make in the build directory. If you want more information: make VERBOSE=1 Some usual targets are supported, such as make clean

freediameter configuration file 45 Create 2 files fd.conf as follow: LoadExtension = "extensions/test_app.fdx"; LoadExtension = "extensions/dbg_monitor.fdx"; TLS_Cred = ".../cert.pem", ".../privkey.

8 freediameter configuration file 45 Create 2 files fd.conf as follow: LoadExtension = "extensions/test_app.fdx"; LoadExtension = "extensions/dbg_monitor.fdx"; TLS_Cred = ".../cert.pem", ".../privkey.pem"; ConnectPeer = "serv.testbed"; Adapt the paths and peer names to each peer. `hostname fqdn` must work properly with this simple file. Otherwise, add: Identity = "my.diam.id"; You can configure the test application (see sample conf)

9 Understanding test_app 46 Test-app is a «ping» application (not standard) Showcase of many features, using all basic functions. More details in part III of the tutorial

10 Running the daemon 47./freeDiameter/freeDiameterd h -c : configuration file -d,-q : increase, decrease verbosity./freediameter/freediameterd dd c fd.conf All extensions loaded. -- Configuration : freediameter daemon initialized. Terminate with ^C (`kill TERM $PID`)

11 Running the test 48 Start the daemon on both peers. Check the connection is established the dbg_monitor extensions shows status every 30 secs the other peer must appear in STATE_OPEN state. Send SIGUSR1 to the client s daemon (kill USR1 $PID) This is the test_app trigger to send the ping request. Check these lines appear on the console: SEND 74b0dc51 to serv.testbed.net' (testbed.net) RECV 74b0dc51 (Ok) Status: 2001 From 'serv.testbed.net' ('testbed.net') in sec

12 49 Live demonstration running test_app Murphy s law: If anything can go wrong, it will

13 Debugging freediameter 50 And if it does not work? How to debug? Multi-threaded: a debugger is difficult to use But still useful in case of core dump Useful gdb command: threads apply all where Breakpoints are sometimes helpful Easy to set when using macro TRACE_HERE() Good news: tracing is very easy with freediameter! Use CHECK_*, TRACE_* macro (even in extensions) Exemple: CHECK_FCT_DO(_call_, _fallback_) Trace (level CALL:9), execute _call_. If it returns an error, trace (level INFO:1), execute _fallback_

Traces format explained 51 tid:psm/proxy.b.

c:984 Function, file, line where the trace

14 Traces format explained 51 tid:psm/proxy.b.rt Identifies the thread, here the PSM of proxy.b.rt peer 02/23/10,17:18: The timestamp of this trace. in Function, file, line where the trace was Unknown address family returned : Marks an important line (level >= INFO, usually errors) The message itself.

15 Tracing freediameter 52 To obtain more traces : First option : use more -d flag. Ex: freediameterd ddd c fd.conf Max level (10): almost all calls are displayed. Unusable in most cases: changes the dynamics, fills the HDD Recommended: -dd when debugging, none or q otherwise. Second option: localized verbosity. --dbg_func=<func> The debug level is maximum only inside this function --dbg_file=<file> The debug level is maximum only for this file. To save the output: tee i logfile.txt

16 53 Live demonstration log file content Murphy s law: Given the most inappropriate time for something to go wrong, that's when it will occur.

17 End of part II. 54 Thank you for listening! Any question at this point? Next: Part III - Writing an extension

Download, Install and Setup the Linux Development Workload Create a New Linux Project Configure a Linux Project Configure a Linux CMake Project

Table of Contents Download, Install and Setup the Linux Development Workload Create a New Linux Project Configure a Linux Project Configure a Linux CMake Project Connect to Your Remote Linux Computer Deploy,