//
// Copyright (C) 2007
// Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-// Stefan Bund <g0dil@berlios.de>
//
-// 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 <g0dil@berlios.de>
/** \file
\brief PacketImpl public header */
#include <memory>
#include <vector>
#include <boost/utility.hpp>
-#include <boost/type_traits/is_base_of.hpp>
-#include <boost/type_traits/has_trivial_constructor.hpp>
-#include <boost/type_traits/has_trivial_destructor.hpp>
#include <boost/static_assert.hpp>
+#include <boost/ptr_container/ptr_vector.hpp>
#include <senf/Utils/pool_alloc_mixin.hh>
#include <senf/Utils/singleton.hh>
//#include "PacketImpl.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+#include "PacketImpl.ih"
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
namespace senf {
*/
struct ComplexAnnotation {};
-namespace detail {
-
- struct AnnotationP
- {
- virtual ~AnnotationP();
- };
-
- template <class Annotation>
- struct TAnnotationP
- : public AnnotationP
- {
- Annotation annotation;
- };
-
- union AnnotationEntry {
- AnnotationP * p;
- unsigned long long i;
- };
-
- struct AnnotationIndexerBase
- {
- virtual ~AnnotationIndexerBase();
- virtual void v_dump(PacketImpl * p, std::ostream & os) = 0;
-
- static unsigned maxAnnotations;
- static std::vector<bool> & small();
- static std::vector<AnnotationIndexerBase*> & registry();
- static void dump(PacketImpl * p, std::ostream & os);
- };
+ /** \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
- template <class Annotation>
- struct AnnotationIndexer
- : public senf::singleton< AnnotationIndexer<Annotation> >,
- public AnnotationIndexerBase
- {
- AnnotationIndexer();
- virtual void v_dump(PacketImpl * p, std::ostream & os);
- unsigned index_;
- static unsigned index();
- static bool const Complex = boost::is_base_of<ComplexAnnotation, Annotation>::value;
- static bool const Small = (sizeof(Annotation) <= sizeof(AnnotationEntry) && ! Complex);
-
-# if 0 // The test is difficult since it does not work with user-defined trivial constructors
-# ifdef BOOST_HAS_TYPE_TRAITS_INTRINSICS
-
- BOOST_STATIC_ASSERT(( (boost::has_trivial_constructor<Annotation>::value
- && boost::has_trivial_destructor<Annotation>::value)
- || Complex ));
-
-# endif
-# endif
- };
-
- template <class Annotation, bool Small = AnnotationIndexer<Annotation>::Small>
- struct GetAnnotation
- {
- static Annotation & get(AnnotationEntry & e);
- static void dump(AnnotationEntry & e, std::ostream & os);
- };
+ \see \ref packet_usage_annotation
+ */
+ void dumpPacketAnnotationRegistry(std::ostream & os);
- template <class Annotation>
- struct GetAnnotation<Annotation, true>
- {
- static Annotation & get(AnnotationEntry & e);
- static void dump(AnnotationEntry & e, std::ostream & os);
- };
+namespace detail {
/** \brief Internal: Packet data storage
// 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
// Annotations
template <class Annotation>
Annotation & annotation();
+
+ void clearAnnotations();
+ void assignAnnotations(PacketImpl const & other);
void dumpAnnotations(std::ostream & os);
- template <class Annotation>
- void dumpAnnotation(std::ostream & os);
/** \brief Internal: Keep PacketImpl instance alive
};
private:
+ void eraseInterpreters(interpreter_list::iterator b, interpreter_list::iterator e);
+ void updateIterators(PacketData * self, difference_type pos, difference_type n);
+
+ void * annotation(AnnotationRegistry::key_type key); // may return 0 !
+ void * complexAnnotation(AnnotationRegistry::key_type key); // may return 0 !
+ template <class Annotation>
+ void * complexAnnotation();
+
refcount_t refcount_;
raw_container data_;
interpreter_list interpreters_;
-
- typedef std::vector<AnnotationEntry> Annotations;
- Annotations annotations_;
- void eraseInterpreters(interpreter_list::iterator b, interpreter_list::iterator e);
- void updateIterators(PacketData * self, difference_type pos, difference_type n);
+ union SimpleAnnotationSlot
+ {
+ unsigned char _ [SENF_PACKET_ANNOTATION_SLOTSIZE];
+ };
+
+ typedef boost::ptr_vector< boost::nullable<AnnotationRegistry::EntryBase> >
+ ComplexAnnotations;
+ 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_
#include "PacketImpl.cci"
-//#include "PacketImpl.ct"
+#include "PacketImpl.ct"
#include "PacketImpl.cti"
#endif
// compile-command: "scons -u test"
// comment-column: 40
// End:
-
projects / senf.git / blobdiff