src/nepi/data/processing/ccn/parser.py

   1 #!/usr/bin/env python
   2
   3 ###############################################################################
   4 #
   5 #    CCNX benchmark
   6 #    Copyright (C) 2014 INRIA
   7 #
   8 #    This program is free software: you can redistribute it and/or modify
   9 #    it under the terms of the GNU General Public License as published by
  10 #    the Free Software Foundation, either version 3 of the License, or
  11 #    (at your option) any later version.
  12 #
  13 #    This program is distributed in the hope that it will be useful,
  14 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 #    GNU General Public License for more details.
  17 #
  18 #    You should have received a copy of the GNU General Public License
  19 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 #
  21 #
  22 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  23 #
  24 ###############################################################################
  25
  26 #
  27 # This library contains functions to parse (CCNx) ccnd logs.
  28 #
  29 # Results from experiments must be stored in a directory
  30 # named with the experiment run id.
  31 # ccnd logs are stored in .log files in a subdirectory per node.
  32 # The following diagram exemplifies the experiment result directory
  33 # structure (nidi is the unique identifier assigned to node i):
  34 #
  35 #    run_id
  36 #               \   nid1
  37 #                        \ nid2.log
  38 #               \   nid2
  39 #                        \ nid1.log
  40 #               \   nid3
  41 #                        \ nid3.log
  42 #
  43
  44 import collections
  45 import functools
  46 import networkx
  47 import os
  48 import pickle
  49 import tempfile
  50
  51 from nepi.util.timefuncs import compute_delay_ms
  52 from nepi.util.statfuncs import compute_mean
  53 import nepi.data.processing.ping.parser as ping_parser
  54
  55 def is_control(content_name):
  56     return content_name.startswith("ccnx:/%C1") or \
  57             content_name.startswith("ccnx:/ccnx") or \
  58             content_name.startswith("ccnx:/...")
  59
  60
  61 def parse_file(filename):
  62     """ Parses message information from ccnd log files
  63
  64         filename: path to ccndlog file
  65
  66     """
  67
  68     faces = dict()
  69     sep = " "
  70
  71     f = open(filename, "r")
  72
  73     data = []
  74
  75     for line in f:
  76         cols =  line.strip().split(sep)
  77
  78         # CCN_PEEK
  79         # MESSAGE interest_from
  80         # 1374181938.808523 ccnd[9245]: debug.4352 interest_from 6 ccnx:/test/bunny.ts (23 bytes,sim=0CDCC1D7)
  81         #
  82         # MESSAGE interest_to
  83         # 1374181938.812750 ccnd[9245]: debug.3502 interest_to 5 ccnx:/test/bunny.ts (39 bytes,i=2844,sim=0CDCC1D7)
  84         #
  85         # MESSAGE CONTENT FROM
  86         # 1374181938.868682 ccnd[9245]: debug.4643 content_from 5 ccnx:/test/bunny.ts/%FD%05%1E%85%8FVw/%00/%9E%3D%01%D9%3Cn%95%2BvZ%8
  87         #
  88         # MESSAGE CONTENT_TO
  89         # 1374181938.868772 ccnd[9245]: debug.1619 content_to 6 ccnx:/test/bunny.ts/%FD%05%1E%85%8FVw/%00/%9E%3D%01%D9%3Cn%95%2BvZ%8
  90         #
  91         # 1375596708.222304 ccnd[9758]: debug.3692 interest_expiry ccnx:/test/bunny.ts/%FD%05%1E%86%B1GS/%00%0A%F7 (44 bytes,c=0:1,i=2819,sim=49FA8048)
  92
  93         # External face creation
  94         # 1374181452.965961 ccnd[9245]: accepted datagram client id=5 (flags=0x40012) 204.85.191.10 port 9695
  95
  96         if line.find("accepted datagram client") > -1:
  97             face_id = (cols[5]).replace("id=",'')
  98             ip = cols[7]
  99             port = cols[9]
 100             faces[face_id] = (ip, port)
 101             continue
 102
 103         # 1374181452.985296 ccnd[9245]: releasing face id 4 (slot 4)
 104         if line.find("releasing face id") > -1:
 105             face_id = cols[5]
 106             if face_id in faces:
 107                 del faces[face_id]
 108             continue
 109
 110         if len(cols) < 6:
 111             continue
 112
 113         timestamp = cols[0]
 114         message_type = cols[3]
 115
 116         if message_type not in ["interest_from", "interest_to", "content_from",
 117                 "content_to", "interest_dupnonce", "interest_expiry"]:
 118             continue
 119
 120         face_id = cols[4]
 121         content_name = cols[5]
 122
 123         # Interest Nonce ? -> 412A74-0844-0008-50AA-F6EAD4
 124         nonce = ""
 125         if message_type in ["interest_from", "interest_to", "interest_dupnonce"]:
 126             last = cols[-1]
 127             if len(last.split("-")) == 5:
 128                 nonce = last
 129
 130         try:
 131             size = int((cols[6]).replace('(',''))
 132         except:
 133             print "interest_expiry without face id!", line
 134             continue
 135
 136         # If no external IP address was identified for this face
 137         # asume it is a local face
 138         peer = "localhost"
 139
 140         if face_id in faces:
 141             peer, port = faces[face_id]
 142
 143         data.append((content_name, timestamp, message_type, peer, face_id,
 144             size, nonce, line))
 145
 146     f.close()
 147
 148     return data
 149
 150 def dump_content_history(content_history):
 151     f = tempfile.NamedTemporaryFile(delete=False)
 152     pickle.dump(content_history, f)
 153     f.close()
 154     return f.name
 155
 156 def load_content_history(fname):
 157     f = open(fname, "r")
 158     content_history = pickle.load(f)
 159     f.close()
 160
 161     os.remove(fname)
 162     return content_history
 163
 164 def annotate_cn_node(graph, nid, ips2nid, data, content_history):
 165     for (content_name, timestamp, message_type, peer, face_id,
 166             size, nonce, line) in data:
 167
 168         # Ignore control messages for the time being
 169         if is_control(content_name):
 170             continue
 171
 172         if message_type == "interest_from" and \
 173                 peer == "localhost":
 174             graph.node[nid]["ccn_consumer"] = True
 175         elif message_type == "content_from" and \
 176                 peer == "localhost":
 177             graph.node[nid]["ccn_producer"] = True
 178
 179         # Ignore local messages for the time being.
 180         # They could later be used to calculate the processing times
 181         # of messages.
 182         if peer == "localhost":
 183             continue
 184
 185         # remove digest
 186         if message_type in ["content_from", "content_to"]:
 187             content_name = "/".join(content_name.split("/")[:-1])
 188
 189         if content_name not in content_history:
 190             content_history[content_name] = list()
 191
 192         peernid = ips2nid[peer]
 193         graph.add_edge(nid, peernid)
 194
 195         content_history[content_name].append((timestamp, message_type, nid,
 196             peernid, nonce, size, line))
 197
 198 def annotate_cn_graph(logs_dir, graph, parse_ping_logs = False):
 199     """ Adds CCN content history for each node in the topology graph.
 200
 201     """
 202     # Make a copy of the graph to ensure integrity
 203     graph = graph.copy()
 204
 205     ips2nid = dict()
 206
 207     for nid in graph.nodes():
 208         ips = graph.node[nid]["ips"]
 209         for ip in ips:
 210             ips2nid[ip] = nid
 211
 212     found_files = False
 213
 214     # Now walk through the ccnd logs...
 215     for dirpath, dnames, fnames in os.walk(logs_dir):
 216         # continue if we are not at the leaf level (if there are subdirectories)
 217         if dnames:
 218             continue
 219
 220         # Each dirpath correspond to a different node
 221         nid = os.path.basename(dirpath)
 222
 223         content_history = dict()
 224
 225         for fname in fnames:
 226             if fname.endswith(".log"):
 227                 found_files = True
 228                 filename = os.path.join(dirpath, fname)
 229                 data = parse_file(filename)
 230                 annotate_cn_node(graph, nid, ips2nid, data, content_history)
 231
 232         # Avoid storing everything in memory, instead dump to a file
 233         # and reference the file
 234         fname = dump_content_history(content_history)
 235         graph.node[nid]["history"] = fname
 236
 237     if not found_files:
 238         msg = "No CCND output files were found to parse at %s " % logs_dir
 239         raise RuntimeError, msg
 240
 241     if parse_ping_logs:
 242         ping_parser.annotate_cn_graph(logs_dir, graph)
 243
 244     return graph
 245
 246 def ccn_producers(graph):
 247     """ Returns the nodes that are content providers """
 248     return [nid for nid in graph.nodes() \
 249             if graph.node[nid].get("ccn_producer")]
 250
 251 def ccn_consumers(graph):
 252     """ Returns the nodes that are content consumers """
 253     return [nid for nid in graph.nodes() \
 254             if graph.node[nid].get("ccn_consumer")]
 255
 256 def process_content_history(graph):
 257     """ Compute CCN message counts and aggregates content historical
 258     information in the content_names dictionary
 259
 260     """
 261
 262     ## Assume single source
 263     source = ccn_consumers(graph)[0]
 264
 265     interest_expiry_count = 0
 266     interest_dupnonce_count = 0
 267     interest_count = 0
 268     content_count = 0
 269     content_names = dict()
 270
 271     # Collect information about exchanged messages by content name and
 272     # link delay info.
 273     for nid in graph.nodes():
 274         # Load the data collected from the node's ccnd log
 275         fname = graph.node[nid]["history"]
 276         history = load_content_history(fname)
 277
 278         for content_name in history.keys():
 279             hist = history[content_name]
 280
 281             for (timestamp, message_type, nid1, nid2, nonce, size, line) in hist:
 282                 if message_type in ["content_from", "content_to"]:
 283                     # The first Interest sent will not have a version or chunk number.
 284                     # The first Content sent back in reply, will end in /=00 or /%00.
 285                     # Make sure to map the first Content to the first Interest.
 286                     if content_name.endswith("/=00"):
 287                         content_name = "/".join(content_name.split("/")[0:-2])
 288
 289                 # Add content name to dictionary
 290                 if content_name not in content_names:
 291                     content_names[content_name] = dict()
 292                     content_names[content_name]["interest"] = dict()
 293                     content_names[content_name]["content"] = list()
 294
 295                 # Classify interests by replica
 296                 if message_type in ["interest_from"] and \
 297                         nonce not in content_names[content_name]["interest"]:
 298                     content_names[content_name]["interest"][nonce] = list()
 299
 300                 # Add consumer history
 301                 if nid == source:
 302                     if message_type in ["interest_to", "content_from"]:
 303                         # content name history as seen by the source
 304                         if "consumer_history" not in content_names[content_name]:
 305                             content_names[content_name]["consumer_history"] = list()
 306
 307                         content_names[content_name]["consumer_history"].append(
 308                                 (timestamp, message_type))
 309
 310                 # Add messages per content name and cumulate totals by message type
 311                 if message_type == "interest_dupnonce":
 312                     interest_dupnonce_count += 1
 313                 elif message_type == "interest_expiry":
 314                     interest_expiry_count += 1
 315                 elif message_type == "interest_from":
 316                     interest_count += 1
 317                     # Append to interest history of the content name
 318                     content_names[content_name]["interest"][nonce].append(
 319                             (timestamp, nid2, nid1))
 320                 elif message_type == "content_from":
 321                     content_count += 1
 322                     # Append to content history of the content name
 323                     content_names[content_name]["content"].append((timestamp, nid2, nid1))
 324                 else:
 325                     continue
 326             del hist
 327         del history
 328
 329     # Compute the time elapsed between the time an interest is sent
 330     # in the consumer node and when the content is received back
 331     for content_name in content_names.keys():
 332         # order content and interest messages by timestamp
 333         content_names[content_name]["content"] = sorted(
 334               content_names[content_name]["content"])
 335
 336         for nonce, timestamps in content_names[content_name][
 337                     "interest"].iteritems():
 338               content_names[content_name]["interest"][nonce] = sorted(
 339                         timestamps)
 340
 341         history = sorted(content_names[content_name]["consumer_history"])
 342         content_names[content_name]["consumer_history"] = history
 343
 344         # compute the rtt time of the message
 345         rtt = None
 346         waiting_content = False
 347         interest_timestamp = None
 348         content_timestamp = None
 349
 350         for (timestamp, message_type) in history:
 351             if not waiting_content and message_type == "interest_to":
 352                 waiting_content = True
 353                 interest_timestamp = timestamp
 354                 continue
 355
 356             if waiting_content and message_type == "content_from":
 357                 content_timestamp = timestamp
 358                 break
 359
 360         # If we can't determine who sent the interest, discard it
 361         rtt = -1
 362         if interest_timestamp and content_timestamp:
 363             rtt = compute_delay_ms(content_timestamp, interest_timestamp)
 364
 365         content_names[content_name]["rtt"] = rtt
 366         content_names[content_name]["lapse"] = (interest_timestamp, content_timestamp)
 367
 368     return (graph,
 369         content_names,
 370         interest_expiry_count,
 371         interest_dupnonce_count,
 372         interest_count,
 373         content_count)
 374
 375 def process_content_history_logs(logs_dir, graph, parse_ping_logs = False):
 376     """ Parse CCN logs and aggregate content history information in graph.
 377     Returns annotated graph and message countn and content names history.
 378
 379     """
 380     ## Process logs and analyse data
 381     try:
 382         graph = annotate_cn_graph(logs_dir, graph,
 383                 parse_ping_logs = parse_ping_logs)
 384     except:
 385         print "Skipping: Error parsing ccnd logs", logs_dir
 386         raise
 387
 388     source = ccn_consumers(graph)[0]
 389     target = ccn_producers(graph)[0]
 390
 391     # Process the data from the ccnd logs, but do not re compute
 392     # the link delay.
 393     try:
 394         (graph,
 395         content_names,
 396         interest_expiry_count,
 397         interest_dupnonce_count,
 398         interest_count,
 399         content_count) = process_content_history(graph)
 400     except:
 401         print "Skipping: Error processing ccn data", logs_dir
 402         raise
 403
 404     return (graph,
 405             content_names,
 406             interest_expiry_count,
 407             interest_dupnonce_count,
 408             interest_count,
 409             content_count)