- UserScript Protocol reworked. Needs more testing. May need a significant rewrite in the future, but for now this will have to do - therefore it has been marked "EXPERIMENTAL" for now
---------------------------------
- StreamConfigDialog: Valid subsequent protocol choices for a particular protocol in the simple protocol selection widget is no longer hardcoded - ProtocolManager is queried for validitity of each pair of possible protocols; signal-slot connections are made accordingly. This refactoring makes it easier to add a protocol to the simple protocol selection widget
- ProtocolManager: populates and maintains a database of valid 'neighbour protocols' and implements a method - isValidNeighbour() to query the same for a pair of protocols
- AbstractProtocol: new method protocolIdType() introduced to build the above database (in conjunction with the existing method protocolId(ProtocolIdType)); default implementation returns ProtocolIdNone
- Protocols which include a valid/supported ProtocolIdType (eth/llc/ip) reimplement protocolIdType() to return the apporpirate ProtocolIdType. These are viz.
- combo
- eth
- llc
- snap
- ip
- Speed optimization while populating streamqueues if the protocolFrameValue/Size() does not vary across packets
- AbstractProtocol: new methods to support the above optimization
- isProtocolFrameValueVariable()
- isProtocolFrameSizeVariable()
- isProtocolFramePayloadValueVariable()
- isProtocolFramePayloadSizeVariable()
(each of the default implementations returns false indicating that the protocol frame value or frame size is fixed and not variable)
- Protocols which support variable values/size (list follows) reimplement the above methods appropriately
- combo
- mac
- dot3
- ip4
- tcp
- udp
- payload
- StreamInfo::makePacket() moved to base class as StreamBase::frameValue()
- StreamBase: all 'get' accessor functions made 'const'
- class ProtocolManager: while registering a protocol, no need to pass the protocol name; ProtocolManager finds it out internally by using the protocol's shortName() method
Fixes
-----
- Fixed issue with port capture not starting the first time 'start capture' was clicked
--------------------------
- AbstractProtocol Constructor and Factory function now take an optional (default NULL) "parent" abstract protocol in addition to the stream; this "parent" protocol is non-NULL for protocols which are aggregated in a ComboProtocol
- All subclasses of AbstractProtocol modified as per the above interface change
- ProtocolManager also modifed as per the above interface change
- new data members in AbstractProtocol - prev, next; the AbstractProtocol implementation now uses these members to traverse protocols on the list instead of ProtocolListIterator; this change required for ComboProtocol
- ProtocolListIterator updates these new members - prev/next on insert/remove/replace
- ComboProtocol and ProtocolListIterator classes made friends of AbstractProtocol
- ComboProtocol implemented as a template class (completed)
- Dot2LLc implemented as a combo of Dot3Raw and LLC
- Dot2Snap implemented as a combo of Dot2Llc and SNAP
- VlanStack implemented as a combo of VLAN + VLAN
- ProtocolManager now uses the ProtocolId enums rather than hardcoded values
Stream Config Dialog
--------------------
- "None" radio button added to all protocol levels
- Protocol Level 1 added with 'mac' as the only valid protocol in the "simple" mode widget
- With Dot2Llc, Dot2Snap and VlanStack implemented as "combo" protocols, the protocol choice radiobuttons in the "simple" mode are now 1:1 with a protocol; this has the following implications/advantages:
- Updates of the "simple" mode widget from/to stream's protocolList is simpler; this code has now been rewritten to take advantage of 1:1
- This paves the way for exporting tunneled protocols 4over4, 4over6, 6over4 etc. in the "simple" mode
- This should also (hopefully) require less changes when adding a new protocol; more work needs to be done to reach this goal
Fixes
-----
- Dot3Protocol now derives "length" correctly for VLAN tagged packets
- StreamBase now uses the ProtocolListIterator to append the default protocols in a stream instead of directly manipulating ProtocolList; also in protoDataCopyFrom()
Others (Client/Server)
----------------------
- Port Packet Capture implemented; "view capture" is pending (hack put in place now for testing)
Common
------
- Change in OstProto
- Individual protocols are now extensions of (new) message 'Protocol' instead of 'Stream'
- Stream now contains a repeated Protocol which also determines the ordered set of currently selected protocols; StreamCore.frame_proto which was doing this earlier has been removed
- Change in AbstractProtocol Interface
- Parent changed to StreamBase
- Corresponding change in constructor and factory func - createInstance()
- new method protocolNumber() - returns unique id for each protocol
- protoDataCopyInto/From() now copies into OstProto::Protocol instead of OstProto::Stream
- Change in all subclasses of AbstractProtocol to match new interface
- For all protocols, configFrom is no longer static, but each protocol has its own configForm
- configForm creation is lazy
- configForm is still a child of the protocol i.e. it will be destroyed alongwith the protocol
- TODO: convert configWidget() to a pure factory function i.e. the protocol does not own the configForm - this requires us to pass the widget into load/storeConfigWidget() methods
- ProtocolCollection class removed alongwith its .h and .cpp
- ProtocolList class redefined to serve the purpose of ProtocolCollection
- New class ProtocolListIterator defined to iterate ProtocolList
- AbstractProtocol methods now use the ProtocolListIterator
- Factory function createProtocol() added to ProtocolManager
- OstProto::StreamCore accessor functions moved from Stream to StreamBase
Server
------
- MyService uses the newly moved accessors to StreamBase for OstProto::StreamCore members
- StreamInfo now uses the protocols to create the packet
Client
------
- StreamConfigDialog now uses ProtocolListIterator
- So does PacketModel
- new method: fieldFlags() - isCksum, isMeta; Note: isMeta is a flag now not a attrib
- fieldData() bit fields are now in lsb not msb - protocolFrameValue() and subclasses changed accordingly
- protocolFrameValue() now takes an additional bool param indicating whether the frameValue is being requested for a checksum calculation; if so fields which are checksum fields are assumed to be zero and their value is not fetched to prevent infinite recursion
- Other Protocols
- mac: srcMac/dstMac modes is now working
- vlan: implemented VLAN protocol
- ip4: src/dst Addr modes is now working
- udp/tcp: checksum done
- Basic testing done for MAC, VLAN, IPv4, UDP and TCP protocols
- sample protocol: .cpp/.h added to repos - need to be made compilable
- StreamConfigDialog
- Redesigned the protocol selection tab to accomodate "Advanced Protocol Selection"
- L2 Tab config widgets are now in 2 columns
- Packet Tree View is no longer collapsed if selected protocols don't change
- New Classes:
o ProtocolManager - singleton with which all protocols register
o ProtocolCollection - Aggregates all registered protocols; exports methods to work on all protocols
o StreamBase - aggregates ProtocolCollection with Stream Core and Control; the client/server side stream classes now derive from StreamBase leading to major reduction in their code (more cleanup pending)
- AbstractProtocol now supports the additional methods
o createInstance()
o protocolFrameSize()
o protocolFrameOffset(), protocolFramePayloadSize()
o protocolId(), payloadProtocolId()
o protocolFrameCksum(), protocolFramePayloadCksum()
0 constructor takes an extra param - frameProtoList
- Specific protocols - eth2, llc, snap, ip4, udp, tcp now return length, protocol id and cksums correctly (tcp/udp cksum pending)
- StreamConfigDialog - protocol controls for length, cksum and protocolid are automatically updated (not fully working yet)
