clixon/test/test_perf_mem.sh

#!/usr/bin/env bash
# Backend Memory tests of config data, footprint using the clixon-conf state statistics
# Create a large datastore, load it and measure
# Baseline: (thinkpad laptop) running db:
# 100K objects: 500K   mem: 74M
# 1M   objects: 5M     mem: 747M

# Magic line must be first in script (see README.md)
s="$_" ; . ./lib.sh || if [ "$s" = $0 ]; then exit 0; else return 0; fi

# Enable this for massif memory profiling
#clixon_backend="valgrind --tool=massif clixon_backend"

clixon_util_xpath=clixon_util_xpath 

# Number of list/leaf-list entries in file
: ${perfnr:=2000} # 10000 causes timeout in valgrind test

APPNAME=example

cfg=$dir/scaling-conf.xml
fyang=$dir/scaling.yang
pidfile=$dir/pidfile

cat <<EOF > $fyang
module scaling{
   yang-version 1.1;
   namespace "urn:example:clixon";
   prefix ex;
   container x {
    list y {
      key "a";
      leaf a {
        type int32;
      }
      leaf b {
        type int32;
      }
    }
  }
}
EOF

cat <<EOF > $cfg
<clixon-config xmlns="http://clicon.org/config">
  <CLICON_CONFIGFILE>$cfg</CLICON_CONFIGFILE>
  <CLICON_FEATURE>ietf-netconf:startup</CLICON_FEATURE>
  <CLICON_YANG_DIR>$dir</CLICON_YANG_DIR>
  <CLICON_YANG_DIR>${YANG_INSTALLDIR}</CLICON_YANG_DIR>
  <CLICON_YANG_MAIN_FILE>$fyang</CLICON_YANG_MAIN_FILE>
  <CLICON_SOCK>/usr/local/var/run/$APPNAME.sock</CLICON_SOCK>
  <CLICON_BACKEND_PIDFILE>$pidfile</CLICON_BACKEND_PIDFILE>
  <CLICON_XMLDB_DIR>$dir</CLICON_XMLDB_DIR>
  <CLICON_XMLDB_PRETTY>false</CLICON_XMLDB_PRETTY>
  <CLICON_CLI_MODE>example</CLICON_CLI_MODE>
  <CLICON_CLI_DIR>/usr/local/lib/example/cli</CLICON_CLI_DIR>
  <CLICON_CLISPEC_DIR>/usr/local/lib/example/clispec</CLICON_CLISPEC_DIR>
  <CLICON_CLI_LINESCROLLING>0</CLICON_CLI_LINESCROLLING>
  <CLICON_FEATURE>ietf-netconf:startup</CLICON_FEATURE>
</clixon-config>
EOF

# Test function
# Arguments:
# 1: nr   size of large list
function testrun(){
    nr=$1

    new "test params: -f $cfg"

    if [ $BE -ne 0 ]; then
        new "generate config with $nr list entries"
        echo -n "<${DATASTORE_TOP}><x xmlns=\"urn:example:clixon\">" > $dir/startup_db
        for (( i=0; i<$nr; i++ )); do  
            echo -n "<y><a>$i</a><b>$i</b></y>" >> $dir/startup_db
        done
        echo "</x></${DATASTORE_TOP}>" >> $dir/startup_db

        new "kill old backend"
        sudo clixon_backend -zf $cfg
        if [ $? -ne 0 ]; then
            err
        fi
        new "start backend -s startup -f $cfg"
        start_backend -s startup -f $cfg
    fi

    new "wait backend"
    wait_backend

    pid=$(cat $pidfile)

    new "netconf get stats"
    rpc=$(chunked_framing "<rpc $DEFAULTNS><stats $LIBNS><modules>true</modules></stats></rpc>")
    res=$(echo "$DEFAULTHELLO$rpc" | $clixon_netconf -qef $cfg)
#    echo "res:$res"
    err0=$(echo "$res" | $clixon_util_xpath -p "/rpc-reply/rpc-error")
    err=${err0#"nodeset:"}
    if [ -n "$err" ]; then
        err1 "<rpc-reply><global>" "$err"
    fi
    objects=$(echo "$res" | $clixon_util_xpath -p "/rpc-reply/global/xmlnr" | awk -F ">" '{print $2}' | awk -F "<" '{print $1}')

    echo "Total"
    echo "   objects: $objects"

#
    if [ -f /proc/$pid/statm ]; then     # This only works on Linux 
#       cat /proc/$pid/statm
        echo -n "   /proc/$pid/statm: "
        cat /proc/$pid/statm|awk '{print $1*4/1000 "M"}'
    fi
    dbs="running candidate startup";
    for db in $dbs; do
        echo "$db"
        resdb0=$(echo "$res" | $clixon_util_xpath -p "/rpc-reply/datastores/datastore[name=\"$db\"]")
        resdb=${resdb0#"nodeset:0:"}
        if [ "$resdb0" = "$resdb" ]; then
            err1 "nodeset:0:" "$resdb0"
        fi
        echo -n "   objects: "
        echo $resdb | $clixon_util_xpath -p "datastore/nr" | awk -F ">" '{print $2}' | awk -F "<" '{print $1}'
        echo -n "   mem: "
        echo $resdb | $clixon_util_xpath -p "datastore/size" | awk -F ">" '{print $2}' | awk -F "<" '{print $1}' | awk '{print $1/1000000 "M"}'
    done
    if [ $BE -ne 0 ]; then
        new "Kill backend"
        # Check if premature kill
        pid=$(pgrep -u root -f clixon_backend)
        if [ -z "$pid" ]; then
            err "backend already dead"
        fi
        # kill backend

        new "Zap backend"
        stop_backend -f $cfg
    fi
}

new "Memory test for backend with $perfnr entries"
testrun $perfnr

rm -rf $dir

# unset conditional parameters 
unset perfnr

if false; then
# Example memory pretty-printed:
x:
  base struct:  104
  name:         2
  childvec:     131072
  (ns-cache:    115) # only in startup?
  sum:          131178
xmlns:
  base struct:  56
  name:         6
  value-cb:     38
  sum:          100
y:
  base struct:  104
  name:         2
  childvec:     16
  (ns-cache:     115)  # only in startup?
  sum:          122
a:
  base struct:  104
  name:         2
  childvec:     8
(ns-cache:     115)  # only in startup?
  value-cv:     72  # Value cached for sorting
  sum:          186
body:
  base struct:  56
  name:         5
  value-cb:     4
  sum:          65
b:
  sum:          114
  base struct:  104
  name:         2
  childvec:     8
  (ns-cache:     115)  # only in startup?

fi

new "endtest"
endtest