X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FPackets%2FPacketImpl.hh;h=56e261de42f596b362665de13304e2320a5fb2ad;hb=7ee689fe38d66aa3a0004d55e8708750d35adc0b;hp=3aa2964e4577b2a097771ab0a53b7293c69507db;hpb=943a6b0973f66bc699c6e7b404da256145e93acf;p=senf.git diff --git a/senf/Packets/PacketImpl.hh b/senf/Packets/PacketImpl.hh index 3aa2964..56e261d 100644 --- a/senf/Packets/PacketImpl.hh +++ b/senf/Packets/PacketImpl.hh @@ -37,7 +37,7 @@ //#include "PacketImpl.mpp" #include "PacketImpl.ih" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// namespace senf { @@ -59,6 +59,43 @@ namespace senf { */ struct ComplexAnnotation {}; + /** \brief Dump annotation registry debug information + + This function will dump debug information about all registered annotations to \a os. This + information may then be used to tune the following annotation parameters for optimal + performance: + \li \c SENF_PACKET_ANNOTATION_SLOTS (define, default 8) is the number of slots available for + fast annotations + \li \c SENF_PACKET_ANNOTATION_SLOTSIZE (define, default 16) is the maximum size of a fast + annotation in bytes + + The output includes the current parameter and has the following columns: + \li \c NAME: Annotation type name + \li \c FAST: This is 'yes', if the annotation was allocated to a fast slot. Otherwise the + annotation is managed as a slow/complex annotation + \li \c COMPLEX: This is 'yes', if the annotation inherits from ComplexAnnotation + \li \c SIZE: Size of the annotation in bytes + + Fast annotations are considerable faster than complex and slow annotations. However, only + annotations which do not need constructor or destructor calls and which may be + zero-initialized (on the memory level) are legible as fast annotations. + + It is thus desirable to eliminate any complex and slow annotations, if possible. To optimize + the annotation system, you may take the following steps: + \li If there are reasonably sized non-complex annotations which are larger than the current + \c SENF_PACKET_ANNOTATION_SLOTSIZE value, increase this value accordingly + \li If there are more non-complex annotations with a size less than + \c SENF_PACKET_ANNOTATION_SLOTSIZE than there are available slots, increase \c + SENF_PACKET_ANNOTATION_SLOTS accordingly + \li If all fast annotations are smaller than \c SENF_PACKET_ANNOTATION_SLOTSIZE, you may + decrease that value accordingly + \li If there are fewer than \c SENF_PACKET_ANNOTATION_SLOTS fast annotations, you may + decrease that value accordingly + + \see \ref packet_usage_annotation + */ + void dumpPacketAnnotationRegistry(std::ostream & os); + namespace detail { /** \brief Internal: Packet data storage @@ -94,8 +131,8 @@ namespace detail { // rerference/memory management - void add_ref(refcount_t n=1); - void release(refcount_t n=1); + void add_ref(); + void release(); refcount_t refcount() const; // Interpreter chain @@ -134,6 +171,8 @@ namespace detail { template Annotation & annotation(); + void clearAnnotations(); + void assignAnnotations(PacketImpl const & other); void dumpAnnotations(std::ostream & os); /** \brief Internal: Keep PacketImpl instance alive @@ -154,8 +193,8 @@ namespace detail { void eraseInterpreters(interpreter_list::iterator b, interpreter_list::iterator e); void updateIterators(PacketData * self, difference_type pos, difference_type n); - void * annotation(AnnotationRegistry::key_t key); // may return 0 ! - void * complexAnnotation(AnnotationRegistry::key_t key); // may return 0 ! + void * annotation(AnnotationRegistry::key_type key); // may return 0 ! + void * complexAnnotation(AnnotationRegistry::key_type key); // may return 0 ! template void * complexAnnotation(); @@ -170,16 +209,14 @@ namespace detail { typedef boost::ptr_vector< boost::nullable > ComplexAnnotations; -# ifndef SENF_PACKET_NO_COMPLEX_ANNOTATIONS - ComplexAnnotations complexAnnotations_; -# endif + ComplexAnnotations complexAnnotations_; SimpleAnnotationSlot simpleAnnotations_[SENF_PACKET_ANNOTATION_SLOTS]; }; }} -///////////////////////////////hh.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #endif #if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_PacketImpl_i_) #define HH_SENF_Packets_PacketImpl_i_