From f9aef5f826a1c72c7b0066fa68891edee9416a61 Mon Sep 17 00:00:00 2001 From: Lassi Marttala Date: Tue, 4 Sep 2012 10:55:46 +0200 Subject: [GDLT-120]: Improved Network trace. Rewrite to POSIX queue. This is a squash of multiple commits. The original commit messages follow. [GDLT-120]: Segmented network trace: Correct error condition checks. [GDLT-120]: Add documentation for extended network trace [GDLT-120]: Add dlt_queue. Linked list based dynamic queue. [GDLT-120]: Recode to using queue for segmented messages [GDLT-120]: Improved thread start handling. Add error handling. Remove libm from linkage. [GDLT-120]: Avoid sending an extraneous empty segment, when size is aligned [GDLT-120]: More expansive return values from dlt_user_log_send_log [GDLT-120]: Change default behaviour of dlt_user_trace_network to truncated, instead of discard. [GDLT-120]: Convert to POSIX queue. --- automotive-dlt.spec.in | 1 + doc/CMakeLists.txt | 7 + doc/extended_network_trace_doxygen.cfg.cmake | 1532 ++++++++++++++++++++++++++ doc/extended_network_trace_mainpage.h | 129 +++ include/dlt/dlt_user.h | 8 +- src/lib/CMakeLists.txt | 6 +- src/lib/dlt_user.c | 382 ++++--- src/shared/dlt_queue.c | 172 +++ src/shared/dlt_queue.h | 142 +++ src/shared/dlt_user_shared.h | 11 +- src/tests/CMakeLists.txt | 6 +- src/tests/dlt-test-queue.c | 94 ++ 12 files changed, 2345 insertions(+), 145 deletions(-) mode change 100755 => 100644 doc/CMakeLists.txt create mode 100755 doc/extended_network_trace_doxygen.cfg.cmake create mode 100755 doc/extended_network_trace_mainpage.h mode change 100755 => 100644 src/lib/CMakeLists.txt create mode 100644 src/shared/dlt_queue.c create mode 100644 src/shared/dlt_queue.h create mode 100644 src/tests/dlt-test-queue.c diff --git a/automotive-dlt.spec.in b/automotive-dlt.spec.in index 7dea8b3..c9f6763 100644 --- a/automotive-dlt.spec.in +++ b/automotive-dlt.spec.in @@ -98,6 +98,7 @@ rm -rf $RPM_BUILD_ROOT %{_bindir}/dlt-test-filetransfer %{_bindir}/dlt-test-multi-process %{_bindir}/dlt-test-multi-process-client +%{_bindir}/dlt-test-queue %attr(0755,root,root) %{_bindir}/dlt-daemon diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt old mode 100755 new mode 100644 index fbcccb9..07ce7ba --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -18,6 +18,7 @@ if(WITH_DOC) configure_file(${CMAKE_SOURCE_DIR}/doc/doxygen.cfg.cmake ${CMAKE_BINARY_DIR}/doc/doxygen.cfg @ONLY) configure_file(${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg.cmake ${CMAKE_BINARY_DIR}/doc/filetransfer_doxygen.cfg @ONLY) + configure_file(${CMAKE_SOURCE_DIR}/doc/extended_network_trace_doxygen.cfg.cmake ${CMAKE_BINARY_DIR}/doc/extended_network_trace_doxygen.cfg @ONLY) add_custom_target (doc ALL COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/doxygen.cfg @@ -29,6 +30,12 @@ if(WITH_DOC) WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc ) + add_custom_target (doc-extended-network-trace ALL + COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/extended_network_trace_doxygen.cfg + WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc + ) + + endif(WITH_DOC) if(WITH_MAN) diff --git a/doc/extended_network_trace_doxygen.cfg.cmake b/doc/extended_network_trace_doxygen.cfg.cmake new file mode 100755 index 0000000..b7f997f --- /dev/null +++ b/doc/extended_network_trace_doxygen.cfg.cmake @@ -0,0 +1,1532 @@ +# Doxyfile 1.5.8 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = @PROJECT_NAME@ - ExtendedNetworkTrace + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = @GENIVI_PROJECT_VERSION@ + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./DOC_DLT_ExtendedNetworkTrace + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, +# Spanish, Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = YES + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ./../../doc/extended_network_trace_mainpage.h \ + ./../src/lib/dlt_user.c \ + ./../include/dlt_user.h + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ + + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = doc \ + examples \ + .git + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = @CMAKE_SOURCE_DIR@/doc/images + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = YES + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. + +GENERATE_TREEVIEW = ALL + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = YES + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = NO + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = NO + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Options related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/doc/extended_network_trace_mainpage.h b/doc/extended_network_trace_mainpage.h new file mode 100755 index 0000000..f525d12 --- /dev/null +++ b/doc/extended_network_trace_mainpage.h @@ -0,0 +1,129 @@ +/** + * @licence app begin@ + * Copyright (C) 2012 BMW AG + * + * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps. + * + * Contributions are licensed to the GENIVI Alliance under one or more + * Contribution License Agreements. + * + * \copyright + * This Source Code Form is subject to the terms of the + * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with + * this file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * + * \author Lassi Marttala BMW 2012 + * + * For further information see http://www.genivi.org/. + * @licence end@ + */ + +/** \mainpage + +\image html genivilogo.png + +\par More information +can be found at https://collab.genivi.org/wiki/display/genivi/GENIVI+Home \n + +\par About DLT +The DLT is a Deamon that enables diagnostic log and trace in a GENIVI headunit and is based on AUTOSAR 4.0. + +DLT Extended Network Trace Main Page + +\section Introduction Introduction +The extended network trace functionality allows now for large network messages to be sent or truncated. + +\section Protocol Protocol +When truncation of messages is allowed, the truncated messages will be wrapped into a special message which indicates +that a network trace message was truncated and what was the original size of the message. + +Segmented messages are sent in multiple packages. The package stream is prepended with a a start message indicating +which contain a unique handle for this stream, size of data to follow, count of segments to follow and segment size. +Each segment contains the stream handle, segment sequence number, the data and data length. +Finally after sending all the data segments, one more packet is sent to indicate the end of the stream. + +\subsection Truncated Truncated package +Truncated message can be sent using the following function: +\code +int dlt_user_trace_network_truncated(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload, int allow_truncate) +\endcode +This will send a packet in the following format: +\code +,----------------------------------------------------. +| NWTR | Package identifier. STRING +|----------------------------------------------------| +| header | nw_trace header and it's length. RAW +|----------------------------------------------------| +| size | Original size of the message. UINT +|----------------------------------------------------| +| payload | The truncated nw_trace payload. RAW +`----------------------------------------------------' +\endcode + +\subsection Segmented Segmented messages +User can send a segmented network trace message asynchronously using: +\code +void dlt_user_trace_network_segmented(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload) +\endcode +This will start a background thread and return immediately. User can also send all the required packages one by one using: +\code +int dlt_user_trace_network_segmented_start(unsigned int *id, DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len) +int dlt_user_trace_network_segmented_segment(int id, DltContext *handle, DltNetworkTraceType nw_trace_type, int sequence, uint16_t payload_len, void *payload) +int dlt_user_trace_network_segmented_end(int id, DltContext *handle, DltNetworkTraceType nw_trace_type) +\endcode +It is not recommended to use these functions unless you really have to. + +\subsection Start Segmented start packet +The first packet in the stream is the header: +\code +,----------------------------------------------------. +| NWST | Package identifier. STRING +|----------------------------------------------------| +| streamhandle | Unique identifier for all packages in the stream. UINT +|----------------------------------------------------| +| header | nw_trace header and it's length. RAW +|----------------------------------------------------| +| payloadsize | Size of the complete payload in this stream. UINT +|----------------------------------------------------| +| segmentcount | Number of segments to follow. +|----------------------------------------------------| +| segmentlen | Size of one segment +`----------------------------------------------------' +\endcode + +\subsection Data Data segment +After the header, follows a stream of data segments. +\code +,----------------------------------------------------. +| NWCH | Package identifier. STRING +|----------------------------------------------------| +| streamhandle | Unique identifier for all packages in the stream. UINT +|----------------------------------------------------| +| sequence | Sequence number of this segment. UINT +|----------------------------------------------------| +| data | One segment of the original nw_trace. RAW +`----------------------------------------------------' +\endcode + +\subsection End End packet +After all the segments have been sent, an End identifier is sent. +\code +,----------------------------------------------------. +| NWEN | Package identifier. STRING +|----------------------------------------------------| +| streamhandle | Unique identifier for all packages in the stream. UINT +`----------------------------------------------------' +\endcode + + +\section Requirements Requirements + \code + automotive-dlt + \endcode +
+ +\section Licence Licence +Copyright 2012 - BMW AG, Lassi Marttala + +* */ diff --git a/include/dlt/dlt_user.h b/include/dlt/dlt_user.h index 6742969..60d163f 100644 --- a/include/dlt/dlt_user.h +++ b/include/dlt/dlt_user.h @@ -72,11 +72,11 @@ \addtogroup userapi \{ */ - #include "dlt_types.h" #include "dlt_common.h" #include "dlt_user_macros.h" #include "dlt_shm.h" +#include #if !defined (__WIN32__) #include @@ -204,6 +204,9 @@ typedef struct char appID[DLT_ID_SIZE]; /**< Application ID */ int dlt_log_handle; /**< Handle to fifo of dlt daemon */ int dlt_user_handle; /**< Handle to own fifo */ + mqd_t dlt_segmented_queue_read_handle; /**< Handle message queue */ + mqd_t dlt_segmented_queue_write_handle; /**< Handle message queue */ + pthread_t dlt_segmented_nwt_handle; /**< thread handle of segmented sending */ int8_t dlt_is_file; /**< Target of logging: 1 to file, 0 to daemon */ @@ -382,8 +385,9 @@ int dlt_user_trace_network_truncated(DltContext *handle, DltNetworkTraceType nw_ * @param header pointer to network message header * @param payload_len length of network message payload * @param payload pointer to network message payload + * @return 0 on success, -1 on failure */ -void dlt_user_trace_network_segmented(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload); +int dlt_user_trace_network_segmented(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload); /************************************************************************************************** * The folowing API functions define a high level function interface for DLT diff --git a/src/lib/CMakeLists.txt b/src/lib/CMakeLists.txt old mode 100755 new mode 100644 index 0f2913b..bd0e4df --- a/src/lib/CMakeLists.txt +++ b/src/lib/CMakeLists.txt @@ -14,10 +14,10 @@ # @licence end@ ########q -set(dlt_LIB_SRCS dlt_user dlt_client dlt_filetransfer ${CMAKE_SOURCE_DIR}/src/shared/dlt_common.c ${CMAKE_SOURCE_DIR}/src/shared/dlt_user_shared.c ${CMAKE_SOURCE_DIR}/src/shared/dlt_shm.c) +set(dlt_LIB_SRCS dlt_user dlt_client dlt_filetransfer ${CMAKE_SOURCE_DIR}/src/shared/dlt_queue.c ${CMAKE_SOURCE_DIR}/src/shared/dlt_common.c ${CMAKE_SOURCE_DIR}/src/shared/dlt_user_shared.c ${CMAKE_SOURCE_DIR}/src/shared/dlt_shm.c) add_library(dlt ${dlt_LIB_SRCS}) -target_link_libraries(dlt rt m ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries(dlt rt ${CMAKE_THREAD_LIBS_INIT}) set_target_properties(dlt PROPERTIES VERSION ${DLT_VERSION} SOVERSION ${DLT_MAJOR_VERSION}) @@ -27,5 +27,3 @@ install(TARGETS dlt COMPONENT base) - - diff --git a/src/lib/dlt_user.c b/src/lib/dlt_user.c index 117e6ae..7c87174 100644 --- a/src/lib/dlt_user.c +++ b/src/lib/dlt_user.c @@ -63,7 +63,6 @@ Initials Date Comment aw 13.01.2010 initial */ - #include /* for getenv(), free(), atexit() */ #include /* for strcmp(), strncmp(), strlen(), memset(), memcpy() */ #include /* for signal(), SIGPIPE, SIG_IGN */ @@ -83,10 +82,13 @@ #include /* writev() */ +#include + #include "dlt_user.h" #include "dlt_user_shared.h" #include "dlt_user_shared_cfg.h" #include "dlt_user_cfg.h" +#include "dlt_queue.h" static DltUser dlt_user; static int dlt_user_initialised = 0; @@ -97,11 +99,28 @@ static sem_t dlt_mutex; static pthread_t dlt_receiverthread_handle; static pthread_attr_t dlt_receiverthread_attr; +/* Segmented Network Trace */ +#define DLT_MAX_TRACE_SEGMENT_SIZE 1024 +#define DLT_MESSAGE_QUEUE_NAME "/dlt_message_queue" +#define DLT_DELAYED_RESEND_INDICATOR_PATTERN 0xFFFFFFFF + +typedef struct { + DltContext *handle; + uint16_t id; + DltNetworkTraceType nw_trace_type; + uint16_t header_len; + void *header; + uint16_t payload_len; + void *payload; +} s_segmented_data; + +dlt_queue *dlt_segmented_nwt_queue; + /* Function prototypes for internally used functions */ static void dlt_user_receiverthread_function(void *ptr); static void dlt_user_atexit_handler(void); static int dlt_user_log_init(DltContext *handle, DltContextData *log); -static int dlt_user_log_send_log(DltContextData *log, int mtype); +static DltReturnValue dlt_user_log_send_log(DltContextData *log, int mtype); static int dlt_user_log_send_register_application(void); static int dlt_user_log_send_unregister_application(void); static int dlt_user_log_send_register_context(DltContextData *log); @@ -112,6 +131,7 @@ static int dlt_user_print_msg(DltMessage *msg, DltContextData *log); static int dlt_user_log_check_user_message(void); static void dlt_user_log_reattach_to_daemon(void); static int dlt_user_log_send_overflow(void); +static void dlt_user_trace_network_segmented_thread(void *unused); int dlt_user_check_library_version(const char *user_major_version,const char *user_minor_version){ @@ -223,7 +243,43 @@ int dlt_init(void) dlt_log(LOG_WARNING, "Can't destroy thread attributes!\n"); } - return 0; + /* Generate per process name for queue */ + char queue_name[NAME_MAX]; + sprintf(queue_name, "%s.%d", DLT_MESSAGE_QUEUE_NAME, getpid()); + + /* Maximum queue size is 10, limit to size of pointers */ + struct mq_attr mqatr; + mqatr.mq_flags = 0; + mqatr.mq_maxmsg = 10; + mqatr.mq_msgsize = sizeof(s_segmented_data *); + mqatr.mq_curmsgs = 0; + + /* Separate handles for reading and writing */ + dlt_user.dlt_segmented_queue_read_handle = mq_open(queue_name, O_CREAT| O_RDONLY, + S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH, &mqatr); + if(dlt_user.dlt_segmented_queue_read_handle < 0) + { + dlt_log(LOG_CRIT, "Can't create message queue read handle!\n"); + dlt_log(LOG_CRIT, strerror(errno)); + return -1; + } + + dlt_user.dlt_segmented_queue_write_handle = mq_open(queue_name, O_WRONLY); + if(dlt_user.dlt_segmented_queue_write_handle < 0) + { + dlt_log(LOG_CRIT, "Can't open message queue write handle!\n"); + dlt_log(LOG_CRIT, strerror(errno)); + return -1; + } + + if(pthread_create(&(dlt_user.dlt_segmented_nwt_handle), NULL, + (void *)dlt_user_trace_network_segmented_thread, NULL)) + { + dlt_log(LOG_CRIT, "Can't start segmented thread!\n"); + return -1; + } + + return 0; } int dlt_init_file(const char *name) @@ -430,6 +486,27 @@ int dlt_free(void) dlt_user.dlt_ll_ts_num_entries = 0; } + if (dlt_user.dlt_segmented_nwt_handle) + { + pthread_cancel(dlt_user.dlt_segmented_nwt_handle); + } + + char queue_name[NAME_MAX]; + sprintf(queue_name, "%s.%d", DLT_MESSAGE_QUEUE_NAME, getpid()); + + if(mq_close(dlt_user.dlt_segmented_queue_write_handle) < 0) + { + dlt_log(LOG_ERR, "Failed to unlink message queue write handle!\n"); + dlt_log(LOG_ERR, strerror(errno)); + } + + if(mq_close(dlt_user.dlt_segmented_queue_read_handle) < 0 || + mq_unlink(queue_name)) + { + dlt_log(LOG_ERR, "Failed to unlink message queue read handle!\n"); + dlt_log(LOG_ERR, strerror(errno)); + } + dlt_user_initialised = 0; return 0; @@ -1085,7 +1162,7 @@ int dlt_user_log_write_finish(DltContextData *log) return -1; } - return dlt_user_log_send_log(log, DLT_TYPE_LOG); + return dlt_user_log_send_log(log, DLT_TYPE_LOG) < 0 ? -1 : 0; } int dlt_user_log_write_raw(DltContextData *log,void *data,uint16_t length) @@ -1744,16 +1821,7 @@ int dlt_register_injection_callback(DltContext *handle, uint32_t service_id, /** * NW Trace related */ -#define MAX_TRACE_SEGMENT_SIZE 1024 -typedef struct { - DltContext handle; - DltNetworkTraceType nw_trace_type; - uint16_t header_len; - void *header; - uint16_t payload_len; - void *payload; -} s_segmented_data; int check_buffer() { @@ -1771,18 +1839,15 @@ int check_buffer() * Send the start of a segment chain. * Returns -1 on failure */ -int dlt_user_trace_network_segmented_start(unsigned int *id, DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len) +int dlt_user_trace_network_segmented_start(uint16_t *id, DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len) { DltContextData log; struct timeval tv; - if (dlt_user_initialised==0) + if (handle==NULL) { - if (dlt_init()<0) - { - return -1; - } + return -1; } if (dlt_user_log_init(handle, &log)==-1) @@ -1790,12 +1855,6 @@ int dlt_user_trace_network_segmented_start(unsigned int *id, DltContext *handle, return -1; } - if (handle==0) - { - return -1; - } - - DLT_SEM_LOCK(); if (dlt_user.dlt_ll_ts==0) @@ -1834,21 +1893,27 @@ int dlt_user_trace_network_segmented_start(unsigned int *id, DltContext *handle, } /* Write size of payload */ - if(dlt_user_log_write_uint(&log, payload_len)) + if(dlt_user_log_write_uint(&log, payload_len) < 0) { return -1; } /* Write expected segment count */ - uint16_t segment_count = floor(payload_len/MAX_TRACE_SEGMENT_SIZE)+1; + uint16_t segment_count = payload_len/DLT_MAX_TRACE_SEGMENT_SIZE+1; - if(dlt_user_log_write_uint(&log, segment_count)) + /* If segments align perfectly with segment size, avoid sending empty segment */ + if((payload_len % DLT_MAX_TRACE_SEGMENT_SIZE) == 0) + { + segment_count--; + } + + if(dlt_user_log_write_uint(&log, segment_count) < 0) { return -1; } /* Write length of one segment */ - if(dlt_user_log_write_uint(&log, MAX_TRACE_SEGMENT_SIZE)) + if(dlt_user_log_write_uint(&log, DLT_MAX_TRACE_SEGMENT_SIZE) < 0) { return -1; } @@ -1863,42 +1928,26 @@ int dlt_user_trace_network_segmented_start(unsigned int *id, DltContext *handle, return 0; } -int dlt_user_trace_network_segmented_segment(int id, DltContext *handle, DltNetworkTraceType nw_trace_type, int sequence, uint16_t payload_len, void *payload) +int dlt_user_trace_network_segmented_segment(uint16_t id, DltContext *handle, DltNetworkTraceType nw_trace_type, int sequence, uint16_t payload_len, void *payload) { - int max_wait = 20; - usleep(1000); // Yield, to give other threads time while(check_buffer() < 0) { usleep(1000*50); // Wait 50ms - if(max_wait-- < 0) - { - // Waited one second for buffer to flush, return error. - return -1; - } dlt_user_log_resend_buffer(); } - DltContextData log; - - if (dlt_user_initialised==0) + if (handle==NULL) { - if (dlt_init()<0) - { - return -1; - } + return -1; } + DltContextData log; + if (dlt_user_log_init(handle, &log)==-1) { return -1; } - if (handle==0) - { - return -1; - } - - DLT_SEM_LOCK(); if (dlt_user.dlt_ll_ts==0) @@ -1928,7 +1977,7 @@ int dlt_user_trace_network_segmented_segment(int id, DltContext *handle, DltNetw } /* Write segment sequence number */ - if(dlt_user_log_write_uint(&log, sequence)) + if(dlt_user_log_write_uint(&log, sequence) < 0) { return -1; } @@ -1946,19 +1995,19 @@ int dlt_user_trace_network_segmented_segment(int id, DltContext *handle, DltNetw { DLT_SEM_FREE(); } + + /* Allow other threads to log between chunks */ + pthread_yield(); return 0; } -int dlt_user_trace_network_segmented_end(int id, DltContext *handle, DltNetworkTraceType nw_trace_type) +int dlt_user_trace_network_segmented_end(uint16_t id, DltContext *handle, DltNetworkTraceType nw_trace_type) { DltContextData log; - if (dlt_user_initialised==0) + if (handle==0) { - if (dlt_init()<0) - { - return -1; - } + return -1; } if (dlt_user_log_init(handle, &log)==-1) @@ -1966,10 +2015,6 @@ int dlt_user_trace_network_segmented_end(int id, DltContext *handle, DltNetworkT return -1; } - if (handle==0) - { - return -1; - } DLT_SEM_LOCK(); @@ -2010,67 +2055,142 @@ int dlt_user_trace_network_segmented_end(int id, DltContext *handle, DltNetworkT return 0; } -void dlt_user_trace_network_segmented_thread(s_segmented_data *data) +void dlt_user_trace_network_segmented_thread(void *unused) { - unsigned int id; - /* Send initial message */ - if(dlt_user_trace_network_segmented_start(&id, &(data->handle), data->nw_trace_type, data->header_len, data->header, data->payload_len) < 0) - { - // TODO: Report error - return; - } + /* Unused on purpose. */ + (void) unused; - /* Send segments */ - uint16_t offset = 0; - uint16_t sequence = 0; - void *ptr; + s_segmented_data *data; - do + while(1) { - uint16_t len = data->payload_len - offset; - if(len > MAX_TRACE_SEGMENT_SIZE) + ssize_t read = mq_receive(dlt_user.dlt_segmented_queue_read_handle, (char *)&data, + sizeof(s_segmented_data * ), NULL); + if(read != sizeof(s_segmented_data *)) { - len = MAX_TRACE_SEGMENT_SIZE; + dlt_log(LOG_ERR, "NWTSegmented: Error while reading queue.\n"); + dlt_log(LOG_ERR, strerror(errno)); + continue; } - ptr = data->payload + offset; - if(dlt_user_trace_network_segmented_segment(id, &(data->handle), data->nw_trace_type, sequence++, len, ptr) < 0) + + /* Indicator just to try to flush the buffer */ + if(data == (s_segmented_data *)DLT_DELAYED_RESEND_INDICATOR_PATTERN) { - // TODO: Report error - return; + dlt_user_log_resend_buffer(); + continue; } - offset += MAX_TRACE_SEGMENT_SIZE; - }while(offset < data->payload_len); - dlt_user_trace_network_segmented_end(id, &(data->handle), data->nw_trace_type); + /* Segment the data and send the chunks */ + void *ptr = NULL; + uint16_t offset = 0; + uint16_t sequence = 0; + do + { + uint16_t len = 0; + if(offset + DLT_MAX_TRACE_SEGMENT_SIZE > data->payload_len) + { + len = data->payload_len - offset; + } + else + { + len = DLT_MAX_TRACE_SEGMENT_SIZE; + } + /* If payload size aligns perfectly with segment size, avoid sendind empty segment */ + if(len == 0) + { + break; + } - // Allocated outside of thread, free here. - free(data->header); - free(data->payload); - free(data); + ptr = data->payload + offset; + DltReturnValue err = dlt_user_trace_network_segmented_segment(data->id, data->handle, data->nw_trace_type, sequence++, len, ptr); + if(err == DLT_RETURN_BUFFER_FULL || err == DLT_RETURN_ERROR) + { + dlt_log(LOG_ERR,"NWTSegmented: Could not send segment. Aborting.\n"); + break; // Inner loop + } + offset += len; + }while(ptr < data->payload + data->payload_len); + + /* Send the end message */ + DltReturnValue err = dlt_user_trace_network_segmented_end(data->id, data->handle, data->nw_trace_type); + if(err == DLT_RETURN_BUFFER_FULL || err == DLT_RETURN_ERROR) + { + dlt_log(LOG_ERR,"NWTSegmented: Could not send end segment.\n"); + } + + /* Free resources */ + free(data->header); + free(data->payload); + free(data); + } } -void dlt_user_trace_network_segmented(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload) +int dlt_user_trace_network_segmented(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload) { + /* Send as normal trace if possible */ + if(header_len+payload_len+sizeof(uint16_t) < DLT_USER_BUF_MAX_SIZE) { + return dlt_user_trace_network(handle, nw_trace_type, header_len, header, payload_len, payload); + } + + /* Allocate Memory */ s_segmented_data *thread_data = malloc(sizeof(s_segmented_data)); + if(thread_data == NULL) + { + return -1; + } + thread_data->header = malloc(header_len); + if(thread_data->header == NULL) + { + free(thread_data); + return -1; + } + thread_data->payload = malloc(payload_len); + if(thread_data->payload == NULL) + { + free(thread_data->header); + free(thread_data); + return -1; + } /* Copy data */ - memcpy(&(thread_data->handle), handle, sizeof(DltContext)); + thread_data->handle = handle; thread_data->nw_trace_type = nw_trace_type; thread_data->header_len = header_len; - thread_data->header = malloc(header_len); memcpy(thread_data->header, header, header_len); thread_data->payload_len = payload_len; - thread_data->payload = malloc(payload_len); memcpy(thread_data->payload, payload, payload_len); - /* Begin background thread */ - pthread_t thread; - pthread_create(&thread, NULL, (void *)dlt_user_trace_network_segmented_thread, thread_data); + /* Send start message */ + DltReturnValue err = dlt_user_trace_network_segmented_start(&(thread_data->id), + thread_data->handle, thread_data->nw_trace_type, + thread_data->header_len, thread_data->header, + thread_data->payload_len); + if(err == DLT_RETURN_BUFFER_FULL || err == DLT_RETURN_ERROR) + { + dlt_log(LOG_ERR,"NWTSegmented: Could not send start segment. Aborting.\n"); + free(thread_data->header); + free(thread_data->payload); + free(thread_data); + return -1; + } + + /* Add to queue */ + if(mq_send(dlt_user.dlt_segmented_queue_write_handle, + (char *)&thread_data, sizeof(s_segmented_data *), 1) < 0) + { + free(thread_data->header); + free(thread_data->payload); + free(thread_data); + dlt_log(LOG_ERR, "NWTSegmented: Could not write into queue.\n"); + dlt_log(LOG_ERR, strerror(errno)); + return -1; + } + return 0; } int dlt_user_trace_network(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload) { - return dlt_user_trace_network_truncated(handle, nw_trace_type, header_len, header, payload_len, payload, 0); + return dlt_user_trace_network_truncated(handle, nw_trace_type, header_len, header, payload_len, payload, 1); } int dlt_user_trace_network_truncated(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload, int allow_truncate) @@ -2461,37 +2581,37 @@ int dlt_user_log_init(DltContext *handle, DltContextData *log) return 0; } -int dlt_user_log_send_log(DltContextData *log, int mtype) +DltReturnValue dlt_user_log_send_log(DltContextData *log, int mtype) { DltMessage msg; DltUserHeader userheader; int32_t len; - DltReturnValue ret = 0; + DltReturnValue ret = DLT_RETURN_OK; if (log==0) { - return -1; + return DLT_RETURN_ERROR; } if (log->handle==0) { - return -1; + return DLT_RETURN_ERROR; } if (dlt_user.appID[0]=='\0') { - return -1; + return DLT_RETURN_ERROR; } if (log->handle->contextID[0]=='\0') { - return -1; + return DLT_RETURN_ERROR; } if ((mtypeDLT_TYPE_CONTROL)) { - return -1; + return DLT_RETURN_ERROR; } /* also for Trace messages */ @@ -2501,19 +2621,19 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_LOG)==-1) #endif { - return -1; + return DLT_RETURN_ERROR; } if (dlt_message_init(&msg,0)==-1) { - return -1; + return DLT_RETURN_ERROR; } msg.storageheader = (DltStorageHeader*)msg.headerbuffer; if (dlt_set_storageheader(msg.storageheader,dlt_user.ecuID)==-1) { - return -1; + return DLT_RETURN_ERROR; } msg.standardheader = (DltStandardHeader*)(msg.headerbuffer + sizeof(DltStorageHeader)); @@ -2545,7 +2665,7 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) if (dlt_message_set_extraparameters(&msg,0)==-1) { - return -1; + return DLT_RETURN_ERROR; } /* Fill out extended header, if extended header should be provided */ @@ -2569,7 +2689,7 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) default: { /* This case should not occur */ - return -1; + return DLT_RETURN_ERROR; break; } } @@ -2596,7 +2716,7 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) if (len>UINT16_MAX) { dlt_log(LOG_CRIT,"Huge message discarded!\n"); - return -1; + return DLT_RETURN_ERROR; } msg.standardheader->len = DLT_HTOBE_16(len); @@ -2609,7 +2729,7 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) { if (dlt_user_print_msg(&msg, log)==-1) { - return -1; + return DLT_RETURN_ERROR; } } } @@ -2618,7 +2738,7 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) { /* log to file */ ret=dlt_user_log_out2(dlt_user.dlt_log_handle, msg.headerbuffer, msg.headersize, log->buffer, log->size); - return ((ret==DLT_RETURN_OK)?0:-1); + return ret; } else { @@ -2634,10 +2754,10 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) } /* try to resent old data first */ - ret = 0; + ret = DLT_RETURN_OK; if(dlt_user.dlt_log_handle!=-1) ret = dlt_user_log_resend_buffer(); - if(ret==0) + if(ret==DLT_RETURN_OK) { /* resend ok or nothing to resent */ #ifdef DLT_SHM_ENABLE @@ -2681,18 +2801,28 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) log->buffer, log->size)==-1) { dlt_log(LOG_ERR,"Storing message to history buffer failed! Message discarded.\n"); + ret = DLT_RETURN_BUFFER_FULL; } DLT_SEM_FREE(); + + /* Ask segmented thread to try emptying the buffer soon. */ + void *indic = (void *)DLT_DELAYED_RESEND_INDICATOR_PATTERN; + mq_send(dlt_user.dlt_segmented_queue_read_handle, (char *)&indic, sizeof(void *), 1); } switch (ret) { + case DLT_RETURN_BUFFER_FULL: + { + /* Buffer full */ + return DLT_RETURN_BUFFER_FULL; + } case DLT_RETURN_PIPE_FULL: { /* data could not be written */ dlt_user.overflow = 1; - return -1; + return DLT_RETURN_PIPE_FULL; } case DLT_RETURN_PIPE_ERROR: { @@ -2710,26 +2840,26 @@ int dlt_user_log_send_log(DltContextData *log, int mtype) dlt_user_print_msg(&msg, log); } - return -1; + return DLT_RETURN_PIPE_ERROR; } case DLT_RETURN_ERROR: { /* other error condition */ - return -1; + return DLT_RETURN_ERROR; } case DLT_RETURN_OK: { - return 0; + return DLT_RETURN_OK; } default: { /* This case should never occur. */ - return -1; + return DLT_RETURN_ERROR; } } } - return 0; + return DLT_RETURN_OK; } int dlt_user_log_send_register_application(void) @@ -3307,20 +3437,6 @@ int dlt_user_log_resend_buffer(void) if (ret==DLT_RETURN_OK) { dlt_buffer_remove(&(dlt_user.startup_buffer)); - /* - DLT_SEM_LOCK(); - if (dlt_buffer_push(&(dlt_user.startup_buffer), buf, size)==-1) - { - dlt_log(LOG_ERR,"Error pushing back message to history buffer. Message discarded.\n"); - } - DLT_SEM_FREE(); - - // In case of: data could not be written, set overflow flag - if (ret==DLT_RETURN_PIPE_FULL) - { - dlt_user.overflow = 1; - } - */ } else { diff --git a/src/shared/dlt_queue.c b/src/shared/dlt_queue.c new file mode 100644 index 0000000..b9b4855 --- /dev/null +++ b/src/shared/dlt_queue.c @@ -0,0 +1,172 @@ +/** + * @licence app begin@ + * Copyright (C) 2012 BMW AG + * + * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps. + * + * Contributions are licensed to the GENIVI Alliance under one or more + * Contribution License Agreements. + * + * \copyright + * This Source Code Form is subject to the terms of the + * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with + * this file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * + * \author Lassi Marttala BMW 2012 + * + * \file dlt_queue.h + * For further information see http://www.genivi.org/. + * @licence end@ + */ + + +/******************************************************************************* +** ** +** SRC-MODULE: dlt_queue.h ** +** ** +** TARGET : linux ** +** ** +** PROJECT : DLT ** +** ** +** AUTHOR : Lassi Marttala ** +** ** +** PURPOSE : Linked list based dynamic queue ** +** ** +** REMARKS : ** +** ** +** PLATFORM DEPENDANT [yes/no]: no ** +** ** +** TO BE CHANGED BY USER [yes/no]: no ** +** ** +*******************************************************************************/ + +/******************************************************************************* +** Author Identity ** +******************************************************************************** +** ** +** Initials Name Company ** +** -------- ------------------------- ---------------------------------- ** +** lm Lassi Marttala Eureka GmbH ** +*******************************************************************************/ +#include +#include + +#include "dlt_queue.h" + +// Thread safety +static sem_t dlt_queue_mutex; +#define DLT_QUEUE_SEM_LOCK() { sem_wait(&dlt_queue_mutex); } +#define DLT_QUEUE_SEM_FREE() { sem_post(&dlt_queue_mutex); } + +dlt_queue_item *dlt_queue_create_item() +{ + dlt_queue_item *item = malloc(sizeof(dlt_queue_item)); + item->item = NULL; + item->item_size = 0; + item->next_item = NULL; + return item; +} + +void dlt_queue_free_item(dlt_queue_item *item) +{ + if(item != NULL) + { + free(item); + item = NULL; + } +} + +dlt_queue *dlt_queue_create() +{ + static int init_done = 0; + if(!init_done) + { + init_done = 1; + sem_init(&dlt_queue_mutex, 0, 1); + } + return (dlt_queue *)malloc(sizeof(dlt_queue)); +} + +void dlt_queue_free(dlt_queue *queue) +{ + if(queue != NULL) + { + free(queue); + queue = NULL; + } +} + +void dlt_queue_push(dlt_queue_item *item, dlt_queue *queue) +{ + DLT_QUEUE_SEM_LOCK() + item->next_item = NULL; + // Empty queue + if(dlt_queue_is_empty(queue)) + { + queue->head = item; + queue->tail = item; + } + // Exactly one item + else if(queue->head == queue->tail) + { + queue->head->next_item = (struct dlt_queue_item *)item; + queue->tail = item; + } + // Default case + else + { + queue->tail->next_item = (struct dlt_queue_item *)item; + queue->tail = item; + } + DLT_QUEUE_SEM_FREE() +} + +dlt_queue_item *dlt_queue_pop(dlt_queue *queue) +{ + DLT_QUEUE_SEM_LOCK() + dlt_queue_item *retval = NULL; + // Empty queue + if(dlt_queue_is_empty(queue)) + { + retval = NULL; + } + // Exactly one item + else if(queue->head == queue->tail) + { + retval = queue->head; + retval->next_item = NULL; + queue->head = NULL; + queue->tail = NULL; + } + // Default case + else + { + retval = queue->head; + queue->head = (dlt_queue_item *)retval->next_item; + retval->next_item = NULL; + } + DLT_QUEUE_SEM_FREE() + return retval; +} + +int dlt_queue_is_empty(dlt_queue *queue) +{ + if(queue->head == NULL && queue->tail == NULL) + return 1; + return 0; +} + +int dlt_queue_item_count(dlt_queue *queue) +{ + DLT_QUEUE_SEM_LOCK() + int retval = 0; + dlt_queue_item *ptr = queue->head; + while(ptr != NULL) + { + ptr = (dlt_queue_item *) ptr->next_item; + retval++; + } + DLT_QUEUE_SEM_FREE() + return retval; +} diff --git a/src/shared/dlt_queue.h b/src/shared/dlt_queue.h new file mode 100644 index 0000000..40eda03 --- /dev/null +++ b/src/shared/dlt_queue.h @@ -0,0 +1,142 @@ +/** + * @licence app begin@ + * Copyright (C) 2012 BMW AG + * + * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps. + * + * Contributions are licensed to the GENIVI Alliance under one or more + * Contribution License Agreements. + * + * \copyright + * This Source Code Form is subject to the terms of the + * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with + * this file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * + * \author Lassi Marttala BMW 2012 + * + * \file dlt_common_cfg.h + * For further information see http://www.genivi.org/. + * @licence end@ + */ + + +/******************************************************************************* +** ** +** SRC-MODULE: dlt_queue.h ** +** ** +** TARGET : linux ** +** ** +** PROJECT : DLT ** +** ** +** AUTHOR : Lassi Marttala ** +** ** +** PURPOSE : Linked list based dynamic queue ** +** ** +** REMARKS : ** +** ** +** PLATFORM DEPENDANT [yes/no]: no ** +** ** +** TO BE CHANGED BY USER [yes/no]: no ** +** ** +*******************************************************************************/ + +/******************************************************************************* +** Author Identity ** +******************************************************************************** +** ** +** Initials Name Company ** +** -------- ------------------------- ---------------------------------- ** +** lm Lassi Marttala Eureka GmbH ** +*******************************************************************************/ +#ifndef __DLT_QUEUE_H_ +#define __DLT_QUEUE_H_ +#include + +/** + * \brief One item in the linked list + */ +typedef struct { + void *item; + uint16_t item_size; + struct dlt_queue_item *next_item; +}dlt_queue_item; + +/** + * \brief Linked list of items + */ +typedef struct { + dlt_queue_item *head; + dlt_queue_item *tail; +} dlt_queue; + +/** + * \brief Create new empty queue item + * Allocates a new item and returns a pointer to it + * @return Pointer to the new item + */ +dlt_queue_item *dlt_queue_create_item(); + +/** + * \brief Free an queue item + * Frees the memory of the queue item + * @param item Pointer to the item to be freed + */ +void dlt_queue_free_item(dlt_queue_item *item); + +/** + * \brief Create a new empty queue + * Queue is created with no items in it. + * User is responsible for calling dlt_queue_free after + * the queue is not needed anymore. + * @return New allocated queue + */ +dlt_queue *dlt_queue_create(); + +/** + * \brief Delete a queue + * Free the memory of the queue structure. + * Queued items are NOT freed. User must first pop all the items + * to remove the from queue and fere their memory themself. + * @param queue the queue to be freed + */ +void dlt_queue_free(dlt_queue *queue); + +/** + * \brief Push an item to the end of the queue + * Add a new item to the queue. It is now the new tail item. + * Queue does not take ownership of the item. User still must + * handle the freeing of the memory. + * @param item New item to add to the queue + * @param queue Queue to add the item to. + */ +void dlt_queue_push(dlt_queue_item *item, dlt_queue *queue); + +/** + * \brief Pop an item from the head of the queue + * Remove an item from the head of the queue and return it. + * @param queue Queue to pop from + * @return Pointer to the popped item + */ +dlt_queue_item *dlt_queue_pop(dlt_queue *queue); + +/** + * \brief Checks if the queue is empty + * Checks if the head and and tail are null pointers + * and returns the result. + * @param queue Queue to check + * @return 1 if queue is empty, 0 if not. + */ +int dlt_queue_is_empty(dlt_queue *queue); + +/** + * \brief Counts the items in the queue + * Walks the item chain and reports the number of items in + * the queue. If you only need to know if there are items + * or not, please use dlt_queue_is_empty, which is cheaper + * than counting the items. + * @param queue Queue to check + * @return number of items. + */ +int dlt_queue_item_count(dlt_queue *queue); +#endif diff --git a/src/shared/dlt_user_shared.h b/src/shared/dlt_user_shared.h index 251a12e..203763a 100755 --- a/src/shared/dlt_user_shared.h +++ b/src/shared/dlt_user_shared.h @@ -75,11 +75,12 @@ * This are the return values for the functions dlt_user_log_out2() and dlt_user_log_out3() */ typedef enum -{ - DLT_RETURN_PIPE_FULL = -3, - DLT_RETURN_PIPE_ERROR = -2, - DLT_RETURN_ERROR = -1, - DLT_RETURN_OK = 0 +{ + DLT_RETURN_BUFFER_FULL = -4, + DLT_RETURN_PIPE_FULL = -3, + DLT_RETURN_PIPE_ERROR = -2, + DLT_RETURN_ERROR = -1, + DLT_RETURN_OK = 0 } DltReturnValue; /** diff --git a/src/tests/CMakeLists.txt b/src/tests/CMakeLists.txt index 3d5ab91..e91ab58 100644 --- a/src/tests/CMakeLists.txt +++ b/src/tests/CMakeLists.txt @@ -13,6 +13,10 @@ # # @licence end@ ######## +set(dlt_test_queue_SRCS dlt-test-queue) +add_executable(dlt-test-queue ${dlt_test_queue_SRCS}) +target_link_libraries(dlt-test-queue dlt) +set_target_properties(dlt-test-queue PROPERTIES LINKER_LANGUAGE C) set(dlt_test_multi_process_SRCS dlt-test-multi-process) add_executable(dlt-test-multi-process ${dlt_test_multi_process_SRCS}) @@ -54,7 +58,7 @@ add_executable(dlt-test-filetransfer ${dlt_test_filetransfer_SRCS}) target_link_libraries(dlt-test-filetransfer dlt) set_target_properties(dlt-test-filetransfer PROPERTIES LINKER_LANGUAGE C) -install(TARGETS dlt-test-multi-process dlt-test-multi-process-client dlt-test-user dlt-test-client dlt-test-stress-user dlt-test-stress-client dlt-test-stress dlt-test-filetransfer +install(TARGETS dlt-test-queue dlt-test-multi-process dlt-test-multi-process-client dlt-test-user dlt-test-client dlt-test-stress-user dlt-test-stress-client dlt-test-stress dlt-test-filetransfer RUNTIME DESTINATION bin COMPONENT base) diff --git a/src/tests/dlt-test-queue.c b/src/tests/dlt-test-queue.c new file mode 100644 index 0000000..774ea8f --- /dev/null +++ b/src/tests/dlt-test-queue.c @@ -0,0 +1,94 @@ +/** + * @licence app begin@ + * Copyright (C) 2012 BMW AG + * + * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps. + * + * Contributions are licensed to the GENIVI Alliance under one or more + * Contribution License Agreements. + * + * \copyright + * This Source Code Form is subject to the terms of the + * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with + * this file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * + * \author Lassi Marttala BMW 2012 + * + * \file dlt-test-queue.h + * For further information see http://www.genivi.org/. + * @licence end@ + */ + + +/******************************************************************************* +** ** +** SRC-MODULE: dlt_queue.h ** +** ** +** TARGET : linux ** +** ** +** PROJECT : DLT ** +** ** +** AUTHOR : Lassi Marttala ** +** ** +** PURPOSE : Test for queue implementation ** +** ** +** REMARKS : ** +** ** +** PLATFORM DEPENDANT [yes/no]: no ** +** ** +** TO BE CHANGED BY USER [yes/no]: no ** +** ** +*******************************************************************************/ + +/******************************************************************************* +** Author Identity ** +******************************************************************************** +** ** +** Initials Name Company ** +** -------- ------------------------- ---------------------------------- ** +** lm Lassi Marttala Eureka GmbH ** +*******************************************************************************/ + +#include "dlt_queue.h" +#include +#include + +int main(void) +{ + char *item_content = "item_content\n"; + int item_len = strlen(item_content) + 1; + dlt_queue *queue = dlt_queue_create(); + printf("#1\tdlt_queue_is_empty returns\t%d\n", dlt_queue_is_empty(queue)); + + dlt_queue_item *first = dlt_queue_create_item(); + first->item = item_content; + first->item_size = item_len; + dlt_queue_push(first, queue); + + printf("#2\tdlt_queue_is_empty returns\t%d\n", dlt_queue_is_empty(queue)); + printf("#3\tdlt_queue_item_count returns\t%d\n", dlt_queue_item_count(queue)); + + dlt_queue_item *tret = dlt_queue_pop(queue); + printf("#4\tItem content after pop:\t%d:%s", tret->item_size, (char *)tret->item); + dlt_queue_free_item(tret); + + int i=0; + for(i=0;i<5;i++) + { + dlt_queue_item *newitem = dlt_queue_create_item(); + newitem->item = item_content; + newitem->item_size = i; + dlt_queue_push(newitem, queue); + } + printf("#5\tdlt_queue_item_count returns\t%d\n", dlt_queue_item_count(queue)); + while(!dlt_queue_is_empty(queue)) + { + dlt_queue_item *olditem = dlt_queue_pop(queue); + printf("#6\tItem size (item number):%d\n", olditem->item_size); + dlt_queue_free_item(olditem); + } + printf("#7\tdlt_queue_is_empty returns\t%d\n", dlt_queue_is_empty(queue)); + printf("#8\tdlt_queue_item_count returns\t%d\n", dlt_queue_item_count(queue)); + return 0; +} -- cgit v1.2.1