X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FPackets%2FPacketImpl.hh;h=ad0b7e8d3aa1ccd8bd276da10211df7b12d628a8;hb=refs%2Fheads%2Fmaster;hp=fcdd71f8d7872cd40522e84a6f56d0ce3679bf17;hpb=20c3dbf64b3beed10655dceaee5791680fb25383;p=senf.git diff --git a/senf/Packets/PacketImpl.hh b/senf/Packets/PacketImpl.hh index fcdd71f..ad0b7e8 100644 --- a/senf/Packets/PacketImpl.hh +++ b/senf/Packets/PacketImpl.hh @@ -2,23 +2,28 @@ // // Copyright (C) 2007 // Fraunhofer Institute for Open Communication Systems (FOKUS) -// Competence Center NETwork research (NET), St. Augustin, GERMANY -// Stefan Bund // -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. +// The contents of this file are subject to the Fraunhofer FOKUS Public License +// Version 1.0 (the "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// http://senf.berlios.de/license.html // -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. +// The Fraunhofer FOKUS Public License Version 1.0 is based on, +// but modifies the Mozilla Public License Version 1.1. +// See the full license text for the amendments. // -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the -// Free Software Foundation, Inc., -// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +// Software distributed under the License is distributed on an "AS IS" basis, +// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License +// for the specific language governing rights and limitations under the License. +// +// The Original Code is Fraunhofer FOKUS code. +// +// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. +// (registered association), Hansastraße 27 c, 80686 Munich, Germany. +// All Rights Reserved. +// +// Contributor(s): +// Stefan Bund /** \file \brief PacketImpl public header */ @@ -37,7 +42,7 @@ //#include "PacketImpl.mpp" #include "PacketImpl.ih" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// namespace senf { @@ -59,6 +64,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 +136,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 +176,8 @@ namespace detail { template Annotation & annotation(); + void clearAnnotations(); + void assignAnnotations(PacketImpl const & other); void dumpAnnotations(std::ostream & os); /** \brief Internal: Keep PacketImpl instance alive @@ -141,7 +185,7 @@ namespace detail { \internal The Guard will keep the PacketImpl instance alive during a members execution time - It the refcount should drop to 0, PacketImpl will be deleted after the member + If the refcount should drop to 0, PacketImpl will be deleted after the member has completed executing. */ struct Guard { @@ -170,16 +214,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_