Wireshark  4.3.0
The Wireshark network protocol analyzer
io_graph_dialog.h
Go to the documentation of this file.
1 
10 #ifndef IO_GRAPH_DIALOG_H
11 #define IO_GRAPH_DIALOG_H
12 
13 #include <config.h>
14 
15 #include "epan/epan_dissect.h"
16 #include "epan/prefs.h"
17 #include "ui/preference_utils.h"
18 
19 #include "ui/io_graph_item.h"
20 
21 #include "wireshark_dialog.h"
22 
23 #include <ui/qt/models/uat_model.h>
25 
26 #include <wsutil/str_util.h>
27 
28 #include <QPointer>
29 #include <QIcon>
30 #include <QMenu>
31 #include <QTextStream>
32 
33 #include <vector>
34 
35 class QRubberBand;
36 class QTimer;
37 class QAbstractButton;
39 
40 class QCPBars;
41 class QCPGraph;
42 class QCPItemTracer;
43 class QCustomPlot;
44 class QCPAxisTicker;
45 class QCPAxisTickerDateTime;
46 
47 // GTK+ set this to 100000 (NUM_IO_ITEMS) before raising it to unlimited
48 // in commit 524583298beb671f43e972476693866754d38a38.
49 // This is the maximum index returned from get_io_graph_index that will
50 // be added to the graph. Thus, for a minimum interval size of 1 μs no
51 // more than 33.55 s.
52 // Each io_graph_item_t is 88 bytes on a system with 64 bit time_t, so
53 // the max size we'll attempt to allocate for the array of items is 2.75 GiB
54 // (plus a tiny amount extra for the std::vector bookkeeping.)
55 // 2^25 = 16777216
56 const int max_io_items_ = 1 << 25;
57 
58 // XXX - Move to its own file?
59 class IOGraph : public QObject {
60 Q_OBJECT
61 public:
62  // COUNT_TYPE_* in gtk/io_graph.c
63  enum PlotStyles { psLine, psDotLine, psStepLine, psDotStepLine, psImpulse, psBar, psStackedBar, psDot, psSquare, psDiamond, psCross, psPlus, psCircle };
64 
65  explicit IOGraph(QCustomPlot *parent);
66  ~IOGraph();
67  QString configError() const { return config_err_; }
68  QString name() const { return name_; }
69  void setName(const QString &name);
70  QString filter() const { return filter_; }
71  bool setFilter(const QString &filter);
72  void applyCurrentColor();
73  bool visible() const { return visible_; }
74  void setVisible(bool visible);
75  bool needRetap() const { return need_retap_; }
76  void setNeedRetap(bool retap);
77  QRgb color() const;
78  void setColor(const QRgb color);
79  void setPlotStyle(int style);
80  QString valueUnitLabel() const;
81  format_size_units_e formatUnits() const;
82  void setValueUnits(int val_units);
83  QString valueUnitField() const { return vu_field_; }
84  void setValueUnitField(const QString &vu_field);
85  unsigned int movingAveragePeriod() const { return moving_avg_period_; }
86  void setInterval(int interval);
87  bool addToLegend();
88  bool removeFromLegend();
89  QCPGraph *graph() const { return graph_; }
90  QCPBars *bars() const { return bars_; }
91  double startOffset() const;
92  nstime_t startTime() const;
93  int packetFromTime(double ts) const;
94  bool hasItemToShow(int idx, double value) const;
95  double getItemValue(int idx, const capture_file *cap_file) const;
96  int maxInterval () const { return cur_idx_; }
97 
98  void clearAllData();
99 
100  unsigned int moving_avg_period_;
101  unsigned int y_axis_factor_;
102 
103 public slots:
104  void recalcGraphData(capture_file *cap_file);
105  void captureEvent(CaptureEvent e);
106  void reloadValueUnitField();
107 
108 signals:
109  void requestReplot();
110  void requestRecalc();
111  void requestRetap();
112 
113 private:
114  // Callbacks for register_tap_listener
115  static void tapReset(void *iog_ptr);
116  static tap_packet_status tapPacket(void *iog_ptr, packet_info *pinfo, epan_dissect_t *edt, const void *data, tap_flags_t flags);
117  static void tapDraw(void *iog_ptr);
118 
119  void removeTapListener();
120 
121  bool showsZero() const;
122 
123  template<class DataMap> double maxValueFromGraphData(const DataMap &map);
124  template<class DataMap> void scaleGraphData(DataMap &map, int scalar);
125 
126  QCustomPlot *parent_;
127  QString config_err_;
128  QString name_;
129  bool tap_registered_;
130  bool visible_;
131  bool need_retap_;
132  QCPGraph *graph_;
133  QCPBars *bars_;
134  QString filter_;
135  QString full_filter_; // Includes vu_field_ if used
136  QBrush color_;
137  io_graph_item_unit_t val_units_;
138  QString vu_field_;
139  int hf_index_;
140  int interval_;
141  nstime_t start_time_;
142 
143  // Cached data. We should be able to change the Y axis without retapping as
144  // much as is feasible.
145  std::vector<io_graph_item_t> items_;
146  int cur_idx_;
147 };
148 
149 namespace Ui {
150 class IOGraphDialog;
151 }
152 
154 {
155  Q_OBJECT
156 
157 public:
158  explicit IOGraphDialog(QWidget &parent, CaptureFile &cf, QString displayFilter = QString());
159  ~IOGraphDialog();
160 
161  enum UatColumns { colEnabled = 0, colName, colDFilter, colColor, colStyle, colYAxis, colYField, colSMAPeriod, colYAxisFactor, colMaxNum};
162 
163  void addGraph(bool checked, QString name, QString dfilter, QRgb color_idx, IOGraph::PlotStyles style,
164  io_graph_item_unit_t value_units, QString yfield, int moving_average, int yaxisfactor);
165  void addGraph(bool copy_from_current = false);
166  void addDefaultGraph(bool enabled, int idx = 0);
167  void syncGraphSettings(int row);
168  qsizetype graphCount() const;
169 
170 public slots:
171  void scheduleReplot(bool now = false);
172  void scheduleRecalc(bool now = false);
173  void scheduleRetap(bool now = false);
174  void reloadFields();
175 
176 protected:
177  void captureFileClosing();
178  void keyPressEvent(QKeyEvent *event);
179  void reject();
180 
181 protected slots:
182  void modelDataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles);
183  void modelRowsReset();
184  void modelRowsInserted(const QModelIndex &parent, int first, int last);
185  void modelRowsRemoved(const QModelIndex &parent, int first, int last);
186  void modelRowsMoved(const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow);
187 
188 signals:
189  void goToPacket(int packet_num);
190  void recalcGraphData(capture_file *cap_file);
191  void intervalChanged(int interval);
192  void reloadValueUnitFields();
193 
194 private:
195  Ui::IOGraphDialog *ui;
196  CopyFromProfileButton *copy_profile_bt_;
197 
198  //Model and delegate were chosen over UatFrame because add/remove/copy
199  //buttons would need realignment (UatFrame has its own)
200  QPointer<UatModel> uat_model_;
201  UatDelegate *uat_delegate_;
202 
203  // XXX - This needs to stay synced with UAT index
204  QVector<IOGraph*> ioGraphs_;
205 
206  QString hint_err_;
207  QCPGraph *base_graph_;
208  QCPItemTracer *tracer_;
209  uint32_t packet_num_;
210  nstime_t start_time_;
211  bool mouse_drags_;
212  QRubberBand *rubber_band_;
213  QPoint rb_origin_;
214  QMenu ctx_menu_;
215  QTimer *stat_timer_;
216  bool need_replot_; // Light weight: tell QCP to replot existing data
217  bool need_recalc_; // Medium weight: recalculate values, then replot
218  bool need_retap_; // Heavy weight: re-read packet data
219  bool auto_axes_;
220  int precision_;
221 
222  QSharedPointer<QCPAxisTicker> number_ticker_;
223  QSharedPointer<QCPAxisTickerDateTime> datetime_ticker_;
224 
225 
226 // void fillGraph();
227  void zoomAxes(bool in);
228  void zoomXAxis(bool in);
229  void zoomYAxis(bool in);
230  void panAxes(int x_pixels, int y_pixels);
231  void toggleTracerStyle(bool force_default = false);
232  void getGraphInfo();
233  void updateHint();
234  void updateLegend();
235  QRectF getZoomRanges(QRect zoom_rect);
236  void createIOGraph(int currentRow);
237  void loadProfileGraphs();
238  void makeCsv(QTextStream &stream) const;
239  bool saveCsv(const QString &file_name) const;
240  IOGraph *currentActiveGraph() const;
241  bool graphIsEnabled(int row) const;
242 
243 private slots:
244  static void applyChanges();
245 
246  void copyFromProfile(QString filename);
247  void updateWidgets();
248  void showContextMenu(const QPoint &pos);
249  void graphClicked(QMouseEvent *event);
250  void mouseMoved(QMouseEvent *event);
251  void mouseReleased(QMouseEvent *event);
252  void selectedFrameChanged(QList<int> frames);
253 
254  void resetAxes();
255  void updateStatistics(void);
256  void copyAsCsvClicked();
257 
258  void on_intervalComboBox_currentIndexChanged(int index);
259  void on_todCheckBox_toggled(bool checked);
260  void on_graphUat_currentItemChanged(const QModelIndex &current, const QModelIndex &previous);
261 
262  void on_logCheckBox_toggled(bool checked);
263  void on_automaticUpdateCheckBox_toggled(bool checked);
264  void on_enableLegendCheckBox_toggled(bool checked);
265  void on_newToolButton_clicked();
266  void on_deleteToolButton_clicked();
267  void on_copyToolButton_clicked();
268  void on_clearToolButton_clicked();
269  void on_moveUpwardsToolButton_clicked();
270  void on_moveDownwardsToolButton_clicked();
271  void on_dragRadioButton_toggled(bool checked);
272  void on_zoomRadioButton_toggled(bool checked);
273  void on_actionReset_triggered();
274  void on_actionZoomIn_triggered();
275  void on_actionZoomInX_triggered();
276  void on_actionZoomInY_triggered();
277  void on_actionZoomOut_triggered();
278  void on_actionZoomOutX_triggered();
279  void on_actionZoomOutY_triggered();
280  void on_actionMoveUp10_triggered();
281  void on_actionMoveLeft10_triggered();
282  void on_actionMoveRight10_triggered();
283  void on_actionMoveDown10_triggered();
284  void on_actionMoveUp1_triggered();
285  void on_actionMoveLeft1_triggered();
286  void on_actionMoveRight1_triggered();
287  void on_actionMoveDown1_triggered();
288  void on_actionGoToPacket_triggered();
289  void on_actionDragZoom_triggered();
290  void on_actionToggleTimeOrigin_triggered();
291  void on_actionCrosshairs_triggered();
292  void on_buttonBox_helpRequested();
293  void on_buttonBox_accepted();
294  void buttonBoxClicked(QAbstractButton *button);
295 };
296 
297 #endif // IO_GRAPH_DIALOG_H
Definition: capture_event.h:21
Definition: capture_file.h:21
Definition: copy_from_profile_button.h:21
Definition: io_graph_dialog.h:154
void captureFileClosing()
Called when the capture file is about to close. This can be used to disconnect taps and similar actio...
Definition: io_graph_dialog.cpp:763
Definition: io_graph_dialog.h:59
Definition: uat_delegate.h:24
Definition: wireshark_dialog.h:35
format_size_units_e
Definition: str_util.h:231
Definition: cfile.h:67
Definition: packet_info.h:44
Definition: epan_dissect.h:28
Definition: nstime.h:26
Definition: stream.c:41
tap_packet_status
Definition: tap.h:25