Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */ |
| 2 | /* |
| 3 | * Copyright (c) 2011 UCLA |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License version 2 as |
| 7 | * published by the Free Software Foundation; |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 17 | * |
| 18 | * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu> |
| 19 | */ |
| 20 | |
| 21 | #ifndef CCNX_TRACE_HELPER_H |
| 22 | #define CCNX_TRACE_HELPER_H |
| 23 | |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 24 | #include "ns3/nstime.h" |
| 25 | #include "ns3/event-id.h" |
| 26 | |
Alexander Afanasyev | b3e4b85 | 2011-12-23 15:58:20 -0800 | [diff] [blame] | 27 | #include <list> |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 28 | |
| 29 | namespace ns3 { |
| 30 | |
Alexander Afanasyev | 06b42ec | 2012-01-11 19:05:36 -0800 | [diff] [blame] | 31 | class Node; |
Alexander Afanasyev | b3e4b85 | 2011-12-23 15:58:20 -0800 | [diff] [blame] | 32 | class CcnxAppTracer; |
| 33 | class CcnxL3Tracer; |
Alexander Afanasyev | c4f8828 | 2012-01-03 11:27:20 -0800 | [diff] [blame] | 34 | class Ipv4AppTracer; |
Alexander Afanasyev | 06b42ec | 2012-01-11 19:05:36 -0800 | [diff] [blame] | 35 | class WindowTracer; |
Alexander Afanasyev | e9c9d72 | 2012-01-19 16:59:30 -0800 | [diff] [blame] | 36 | class CcnxPathWeightTracer; |
| 37 | class Application; |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 38 | |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 39 | class CcnxTraceHelper |
| 40 | { |
| 41 | public: |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 42 | CcnxTraceHelper (); |
| 43 | |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 44 | /** |
| 45 | * @brief Destructor that invokes trace output procedures |
| 46 | */ |
| 47 | ~CcnxTraceHelper (); |
| 48 | |
| 49 | /** |
| 50 | * @brief Set filename to output app trace. |
| 51 | * |
| 52 | * By default, trace is output to NS_LOG_INFO stream |
| 53 | * |
| 54 | * @param file File where trace will be written to |
| 55 | */ |
| 56 | void |
| 57 | SetAppTraceFile (const std::string &appTrace = "apps.log"); |
| 58 | |
| 59 | /** |
| 60 | * @brief Set filename to output app trace. |
| 61 | * |
| 62 | * By default, trace is output to NS_LOG_INFO stream |
| 63 | * |
| 64 | * @param file File where trace will be written to |
| 65 | */ |
| 66 | void |
| 67 | SetL3TraceFile (const std::string &l3Trace = "l3.log"); |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 68 | |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 69 | /** |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 70 | * @brief Enable aggregate app-level CCNx tracing on all CCNx applications |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 71 | * |
| 72 | * @param app Class name of the application of interest |
| 73 | */ |
| 74 | void |
| 75 | EnableAggregateAppAll (const std::string &app); |
| 76 | |
| 77 | /** |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 78 | * @brief Enable aggregate network-level CCNx tracing on all CCNx node |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 79 | */ |
| 80 | void |
| 81 | EnableAggregateL3All (); |
| 82 | |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 83 | /** |
Alexander Afanasyev | 3183b5a | 2011-12-23 20:48:20 -0800 | [diff] [blame] | 84 | * @brief Enable network-level CCNx rate tracing on all CCNx nodes |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 85 | */ |
| 86 | void |
| 87 | EnableRateL3All (const std::string &l3RateTrace = "l3-rate.log"); |
| 88 | |
Alexander Afanasyev | 3183b5a | 2011-12-23 20:48:20 -0800 | [diff] [blame] | 89 | /** |
| 90 | * @brief Enable app-level CCNx sequence tracing on all CCNx applications |
| 91 | */ |
| 92 | void |
| 93 | EnableSeqsAppAll (const std::string &app, const std::string &appSeqsTrace = "app-seqs.log"); |
| 94 | |
Alexander Afanasyev | c4f8828 | 2012-01-03 11:27:20 -0800 | [diff] [blame] | 95 | /** |
| 96 | * @brief Enable app-level IPv4 sequence tracing on all nodes (BulkSender + PacketSink) |
| 97 | */ |
| 98 | void |
| 99 | EnableIpv4SeqsAppAll (const std::string &appSeqsTrace = "app-seqs.log"); |
Alexander Afanasyev | e4c2ece | 2012-01-11 10:44:40 -0800 | [diff] [blame] | 100 | |
| 101 | /** |
| 102 | * @brief Enable tracing of window changes in CcnxConsumerWindow |
| 103 | */ |
| 104 | void |
| 105 | EnableWindowsAll (const std::string &windowTrace = "windows.log"); |
Alexander Afanasyev | 06b42ec | 2012-01-11 19:05:36 -0800 | [diff] [blame] | 106 | |
| 107 | /** |
| 108 | * @brief Enable tracing of congestion window changes in TcpNewReno |
| 109 | */ |
| 110 | void |
| 111 | EnableWindowsTcpAll (const std::string &windowTrace); |
| 112 | |
Alexander Afanasyev | e9c9d72 | 2012-01-19 16:59:30 -0800 | [diff] [blame] | 113 | /** |
| 114 | * @brief Should be called with node pointer after TCP application |
| 115 | * |
| 116 | * Workaround because NS-3 needs object to exist before connecting trace |
| 117 | */ |
Alexander Afanasyev | 06b42ec | 2012-01-11 19:05:36 -0800 | [diff] [blame] | 118 | void TcpConnect (Ptr<Node> node); |
| 119 | |
Alexander Afanasyev | e9c9d72 | 2012-01-19 16:59:30 -0800 | [diff] [blame] | 120 | /** |
| 121 | * @brief Enable tracing of path weights |
| 122 | */ |
| 123 | void |
| 124 | EnablePathWeights (const std::string &pathWeights); |
| 125 | |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 126 | private: |
| 127 | std::string m_appTrace; |
Alexander Afanasyev | b3e4b85 | 2011-12-23 15:58:20 -0800 | [diff] [blame] | 128 | std::list<Ptr<CcnxAppTracer> > m_apps; |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 129 | |
| 130 | std::string m_l3Trace; |
Alexander Afanasyev | b3e4b85 | 2011-12-23 15:58:20 -0800 | [diff] [blame] | 131 | std::list<Ptr<CcnxL3Tracer> > m_l3s; |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 132 | |
Alexander Afanasyev | b3e4b85 | 2011-12-23 15:58:20 -0800 | [diff] [blame] | 133 | std::list<Ptr<CcnxL3Tracer> > m_l3Rates; |
Alexander Afanasyev | c86c283 | 2011-12-23 02:56:22 -0800 | [diff] [blame] | 134 | std::ostream *m_l3RateTrace; |
Alexander Afanasyev | 3183b5a | 2011-12-23 20:48:20 -0800 | [diff] [blame] | 135 | |
| 136 | std::list<Ptr<CcnxAppTracer> > m_appSeqs; |
| 137 | std::ostream *m_appSeqsTrace; |
Alexander Afanasyev | c4f8828 | 2012-01-03 11:27:20 -0800 | [diff] [blame] | 138 | |
| 139 | std::list<Ptr<Ipv4AppTracer> > m_ipv4AppSeqs; |
| 140 | std::ostream *m_ipv4AppSeqsTrace; |
Alexander Afanasyev | e4c2ece | 2012-01-11 10:44:40 -0800 | [diff] [blame] | 141 | |
Alexander Afanasyev | 06b42ec | 2012-01-11 19:05:36 -0800 | [diff] [blame] | 142 | std::list<Ptr<WindowTracer> > m_windows; |
Alexander Afanasyev | e4c2ece | 2012-01-11 10:44:40 -0800 | [diff] [blame] | 143 | std::ostream *m_windowsTrace; |
Alexander Afanasyev | 06b42ec | 2012-01-11 19:05:36 -0800 | [diff] [blame] | 144 | |
| 145 | std::list<Ptr<WindowTracer> > m_windowsTcp; |
| 146 | std::ostream *m_windowsTcpTrace; |
Alexander Afanasyev | e9c9d72 | 2012-01-19 16:59:30 -0800 | [diff] [blame] | 147 | |
| 148 | std::list<Ptr<CcnxPathWeightTracer> > m_pathWeights; |
| 149 | std::ostream *m_pathWeightsTrace; |
Alexander Afanasyev | 141d131 | 2011-12-18 14:58:35 -0800 | [diff] [blame] | 150 | }; |
| 151 | |
| 152 | |
| 153 | } // namespace ns3 |
| 154 | |
| 155 | #endif /* CCNX_TRACE_HELPER_H */ |