diff --git a/include/AuthRequest.h b/include/AuthRequest.h index b0b4a49e61..44623d92de 100644 --- a/include/AuthRequest.h +++ b/include/AuthRequest.h @@ -21,8 +21,8 @@ #include "ActionManager.h" #include "PoolObjectAuth.h" -#include "SSLTools.h" #include "AuthManager.h" +#include "NebulaUtil.h" #include "SyncRequest.h" @@ -75,22 +75,22 @@ public: username = _username; password = _password; session = _session; - + driver = _driver; } /** * Adds a CREATE authorization request. - * + * * OBJECT:<-1|OBJECT_TMPL_XML64>:CREATE:UID:AUTH - * + * * @param type of the object to be created * @param template (base64 encoded) of the new object */ void add_create_auth(PoolObjectSQL::ObjectType type, const string& txml_64) { PoolObjectAuth perms; //oid & gid set to -1 - + perms.uid = uid; perms.obj_type = type; @@ -143,20 +143,20 @@ public: bool core_authenticate() { - string sha1_session = SSLTools::sha1_digest(session); + string sha1_session = one_util::sha1_digest(session); return (password == sha1_session); } - -private: - + +private: + friend class AuthManager; - + /** * The user id for this request */ int uid; - + /** * The user group ID */ diff --git a/include/Host.h b/include/Host.h index 58e83dd1a4..03d082aad5 100644 --- a/include/Host.h +++ b/include/Host.h @@ -80,27 +80,6 @@ public: return ((state == MONITORING_ERROR) || (state==MONITORING_MONITORED)); } - /** - * Updates the Host's last_monitored time stamp. - * @param success if the monitored action was successfully performed - */ - void touch(bool success) - { - last_monitored = time(0); - - if ( state != DISABLED) //Don't change the state is host is disabled - { - if (success == true) - { - state = MONITORED; - } - else - { - state = ERROR; - } - } - }; - /** * Disables the current host, it will not be monitored nor used by the * scheduler @@ -119,11 +98,27 @@ public: state = INIT; }; - /** Update host counters and update the whole host on the DB + /** + * Update host after a successful monitor. It modifies counters, state + * and template attributes * @param parse_str string with values to be parsed + * @param with_vm_info if monitoring contains VM information + * @param lost set of VMs that should be in the host and were not found + * @param found VMs running in the host (as expected) and info. * @return 0 on success **/ - int update_info(string &parse_str); + int update_info(string &parse_str, + bool &with_vm_info, + set &lost, + map &found); + + /** + * Update host after a failed monitor. It state + * and template attributes + * @param message from the driver + * @param vm_ids running on the host + */ + void error_info(const string& message, set &vm_ids); /** * Inserts the last monitoring, and deletes old monitoring entries. @@ -134,7 +129,7 @@ public: int update_monitoring(SqlDB * db); /** - * Retrives host state + * Retrieves host state * @return HostState code number */ HostState get_state() const @@ -143,7 +138,7 @@ public: }; /** - * Retrives VMM mad name + * Retrieves VMM mad name * @return string vmm mad name */ const string& get_vmm_mad() const @@ -152,7 +147,7 @@ public: }; /** - * Retrives VNM mad name + * Retrieves VNM mad name * @return string vnm mad name */ const string& get_vnm_mad() const @@ -161,7 +156,7 @@ public: }; /** - * Retrives IM mad name + * Retrieves IM mad name * @return string im mad name */ const string& get_im_mad() const @@ -194,7 +189,7 @@ public: }; /** - * Retrives last time the host was monitored + * Retrieves last time the host was monitored * @return time_t last monitored time */ time_t get_last_monitored() const @@ -273,7 +268,7 @@ public: } /** - * Adds a new VM to the given share by icrementing the cpu, mem and disk + * Adds a new VM to the given share by incrementing the cpu, mem and disk * counters * @param vm_id id of the vm to add to the host * @param cpu needed by the VM (percentage) @@ -302,7 +297,7 @@ public: * disk counters * @param vm_id id of the vm to delete from the host * @param cpu used by the VM (percentage) - * @param mem used by the VM (in Kb) + * @param mem used by the VM (in KB) * @param disk used by the VM * @return 0 on success */ @@ -409,6 +404,31 @@ private: virtual ~Host(); + // ************************************************************************* + // Host Management + // ************************************************************************* + + /** + * Updates the Host's last_monitored time stamp. + * @param success if the monitored action was successfully performed + */ + void touch(bool success) + { + last_monitored = time(0); + + if ( state != DISABLED) //Don't change the state is host is disabled + { + if (success == true) + { + state = MONITORED; + } + else + { + state = ERROR; + } + } + }; + // ************************************************************************* // DataBase implementation (Private) // ************************************************************************* diff --git a/include/HostPool.h b/include/HostPool.h index 4b0e2a9a1d..8ccb539097 100644 --- a/include/HostPool.h +++ b/include/HostPool.h @@ -109,12 +109,12 @@ public: /** * Get the least monitored hosts - * @param discovered hosts, map to store the retrieved hosts hids and - * hostnames + * @param discovered hosts * @param host_limit max. number of hosts to monitor at a time + * @param target_time Filters hosts with last_mon_time <= target_time * @return int 0 if success */ - int discover(map * discovered_hosts, int host_limit); + int discover(set * discovered_hosts, int host_limit, time_t target_time); /** * Allocates a given capacity to the host @@ -267,12 +267,15 @@ private: /** * Callback function to get the IDs of the hosts to be monitored * (Host::discover) + * + * @param _set the set* of host ids * @param num the number of columns read from the DB + * @param values the column values * @param names the column names - * @param vaues the column values + * * @return 0 on success */ - int discover_cb(void * _map, int num, char **values, char **names); + int discover_cb(void * _set, int num, char **values, char **names); /** * Deletes all monitoring entries for all hosts diff --git a/include/InformationManager.h b/include/InformationManager.h index de6007acea..cae100c7b1 100644 --- a/include/InformationManager.h +++ b/include/InformationManager.h @@ -122,7 +122,7 @@ private: friend void * im_action_loop(void *arg); /** - * Time in seconds to expire a monitoring action (10 minutes) + * Time in seconds to expire a monitoring action (5 minutes) */ static const time_t monitor_expire; diff --git a/include/NebulaUtil.h b/include/NebulaUtil.h index 4df47cace6..3ffb3958c9 100644 --- a/include/NebulaUtil.h +++ b/include/NebulaUtil.h @@ -28,6 +28,30 @@ namespace one_util std::string log_time(time_t the_time); std::string log_time(); + + /** + * sha1 digest + * @param in the string to be hashed + * @return sha1 hash of str + */ + std::string sha1_digest(const std::string& in); + + /** + * Base 64 encoding + * @param in the string to encoded + * @return a pointer to the encoded string (must be freed) or 0 in case of + * error + */ + std::string * base64_encode(const std::string& in); + + /** + * Base 64 deencoding + * @param in the string to decode + * @return a pointer to the decoded string (must be freed) or 0 in case of + * error + */ + std::string * base64_decode(const std::string& in); + }; #endif /* _NEBULA_UTIL_H_ */ diff --git a/include/PoolObjectSQL.h b/include/PoolObjectSQL.h index d9f77426d8..812a587157 100644 --- a/include/PoolObjectSQL.h +++ b/include/PoolObjectSQL.h @@ -397,12 +397,36 @@ public: } /** - * Sets an error message for the VM in the template - * @param message - * @return 0 on success + * Sets an error message with timestamp in the template + * @param message Message string */ void set_template_error_message(const string& message); + /** + * Deletes the error message from the template + */ + void clear_template_error_message(); + + /** + * Adds a string attribute + * @param att_name Name for the attribute + * @param att_val Message string + */ + void add_template_attribute(const string& name, const string& value) + { + obj_template->add(name, value); + } + + /** + * Adds an int attribute + * @param att_name Name for the attribute + * @param att_val integer + */ + void add_template_attribute(const string& name, int value) + { + obj_template->add(name, value); + } + /** * Factory method for templates, it should be implemented * by classes that uses templates diff --git a/include/SSLTools.h b/include/SSLTools.h deleted file mode 100644 index 12b8275716..0000000000 --- a/include/SSLTools.h +++ /dev/null @@ -1,51 +0,0 @@ -/* ------------------------------------------------------------------------ */ -/* Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs */ -/* */ -/* Licensed under the Apache License, Version 2.0 (the "License"); you may */ -/* not use this file except in compliance with the License. You may obtain */ -/* a copy of the License at */ -/* */ -/* http://www.apache.org/licenses/LICENSE-2.0 */ -/* */ -/* Unless required by applicable law or agreed to in writing, software */ -/* distributed under the License is distributed on an "AS IS" BASIS, */ -/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ -/* See the License for the specific language governing permissions and */ -/* limitations under the License. */ -/* -------------------------------------------------------------------------*/ - -#ifndef SSL_TOOLS_H_ -#define SSL_TOOLS_H_ - -#include - -using namespace std; - -/** - * The SSLTools class provides a simple interface to common SSL utils used - * in OpenNebula - */ -class SSLTools -{ -public: - /** - * sha1 digest - * @param in the string to be hashed - * @return sha1 hash of str - */ - static string sha1_digest(const string& in); - - /** - * Base 64 encoding - * @param in the string to encoded - * @return a pointer to the encoded string (must be freed) or 0 in case of - * error - */ - static string * base64_encode(const string& in); - -private: - SSLTools(){}; - ~SSLTools(){}; -}; - -#endif /*SSL_TOOLS_H_*/ diff --git a/include/VirtualMachine.h b/include/VirtualMachine.h index e3a88b61bb..ec52350bed 100644 --- a/include/VirtualMachine.h +++ b/include/VirtualMachine.h @@ -171,7 +171,7 @@ public: }; /** - * Updates VM dynamic information (usage counters). + * Updates VM dynamic information (usage counters), and updates last_poll * @param _memory Kilobytes used by the VM (total) * @param _cpu used by the VM (rate) * @param _net_tx transmitted bytes (total) @@ -181,28 +181,8 @@ public: const int _memory, const int _cpu, const long long _net_tx, - const long long _net_rx) - { - if (_memory != -1) - { - memory = _memory; - } - - if (_cpu != -1) - { - cpu = _cpu; - } - - if (_net_tx != -1) - { - net_tx = _net_tx; - } - - if (_net_rx != -1) - { - net_rx = _net_rx; - } - }; + const long long _net_rx, + const map &custom); /** * Returns the deployment ID @@ -778,15 +758,6 @@ public: return last_poll; }; - /** - * Sets time of last information polling. - * @param poll time in epoch, normally time(0) - */ - void set_last_poll(time_t poll) - { - last_poll = poll; - }; - /** * Get the VM physical requirements for the host. * @param cpu diff --git a/include/VirtualMachineManagerDriver.h b/include/VirtualMachineManagerDriver.h index f6a1ae0f16..6ffe23c07f 100644 --- a/include/VirtualMachineManagerDriver.h +++ b/include/VirtualMachineManagerDriver.h @@ -68,6 +68,22 @@ public: const VirtualMachine * vm, const string& file_name) const = 0; + /** + * Updates the VM with the information gathered by the drivers + * + * @param id VM id + * @param monitor_str String returned by the poll driver call + */ + static void process_poll(int id, const string &monitor_str); + + /** + * Updates the VM with the information gathered by the drivers + * + * @param vm VM to update, must be locked + * @param monitor_str String returned by the poll driver call + */ + static void process_poll(VirtualMachine* vm, const string &monitor_str); + protected: /** * Gets a configuration attr from driver configuration file (single @@ -268,8 +284,6 @@ private: write_drv("DETACHDISK", oid, drv_msg); } -private: - void write_drv(const char * aname, const int oid, const string& msg) const { ostringstream os; @@ -278,6 +292,25 @@ private: write(os); } + + /** + * Gets VM information from the driver answer + * @param monitor_str from the driver + * @param memory Kilobytes used by the VM (total) + * @param cpu used by the VM (rate) + * @param net_tx transmitted bytes (total) + * @param net_rx received bytes (total) + * @param state of the vm + * @param custom monitor information + */ + static int parse_vm_info( + const string& monitor_str, + int &cpu, + int &memory, + long long &net_tx, + long long &net_rx, + char &state, + map &custom); }; /* -------------------------------------------------------------------------- */ diff --git a/install.sh b/install.sh index 7d64948adc..dee2497563 100755 --- a/install.sh +++ b/install.sh @@ -813,11 +813,13 @@ IM_PROBES_FILES="src/im_mad/remotes/run_probes" IM_PROBES_KVM_FILES="src/im_mad/remotes/kvm.d/kvm.rb \ src/im_mad/remotes/kvm.d/architecture.sh \ src/im_mad/remotes/kvm.d/cpu.sh \ + src/im_mad/remotes/kvm.d/poll.sh \ src/im_mad/remotes/kvm.d/name.sh" IM_PROBES_XEN_FILES="src/im_mad/remotes/xen.d/xen.rb \ src/im_mad/remotes/xen.d/architecture.sh \ src/im_mad/remotes/xen.d/cpu.sh \ + src/im_mad/remotes/xen.d/poll.sh \ src/im_mad/remotes/xen.d/name.sh" IM_PROBES_VMWARE_FILES="src/im_mad/remotes/vmware.d/vmware.rb" diff --git a/share/doc/one/one.doxyfile b/share/doc/one/one.doxyfile index 7bcb99a929..bfeb52fcd8 100644 --- a/share/doc/one/one.doxyfile +++ b/share/doc/one/one.doxyfile @@ -1,1294 +1,1792 @@ -# Doxyfile 1.5.3 +# Doxyfile 1.8.1.2 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# 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 (" ") +# 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. +# 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 +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. +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. -PROJECT_NAME = "OpenNebula Internal documentation" +PROJECT_NAME = "OpenNebula Internal documentation" -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# 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 = 1.0 +PROJECT_NUMBER = 1.0 -# 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 +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# 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 = ./ +OUTPUT_DIRECTORY = ./ -# 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 +# 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 = YES +CREATE_SUBDIRS = YES -# 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, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# 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, Esperanto, 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-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. -OUTPUT_LANGUAGE = English +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). +# 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 = NO +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 +# 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 +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" +# 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 = +ABBREVIATE_BRIEF = -# 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 +# 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 +ALWAYS_DETAILED_SEC = YES -# 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 +# 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 +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 +# 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 +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 +# 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 = /home/ruben/Programs/Eclipse_Workspace/ +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 +# 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 = +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 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system # doesn't support long names like on DOS, Mac, or CD-ROM. -SHORT_NAMES = NO +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 +# 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 +JAVADOC_AUTOBRIEF = YES -# 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 +# 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 +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 +# 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 DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = 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 +# 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 +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 +# 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 +SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# 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 = 4 +TAB_SIZE = 4 -# 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:". +# 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 = +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 +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# 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 = NO +OPTIMIZE_OUTPUT_FOR_C = NO -# 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. +# 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 +OPTIMIZE_OUTPUT_JAVA = NO -# 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 +# 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, CSharp, 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. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# 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 makes the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. -BUILTIN_STL_SUPPORT = YES +BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. -CPP_CLI_SUPPORT = NO +CPP_CLI_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 +# 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 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 = YES + +# 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 +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 +# 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 +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# 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 penalty. +# 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 roughly 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 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_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 +# 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 = NO +EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. -EXTRACT_PRIVATE = NO +EXTRACT_PRIVATE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = NO +EXTRACT_STATIC = NO -# 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 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 +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. +# 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 +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. +# 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 namespaces are hidden. -EXTRACT_ANON_NSPACES = NO +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. +# 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 = YES +HIDE_UNDOC_MEMBERS = YES -# 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 +# 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 = YES +HIDE_UNDOC_CLASSES = YES -# 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 +# 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 +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 +# 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 +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. +# 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 = NO +INTERNAL_DOCS = NO -# 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 +# 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 = YES +CASE_SENSE_NAMES = YES -# 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 +# 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 +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 +# 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 +SHOW_INCLUDE_FILES = YES -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# 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 +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 +# 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 +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 +# 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 +SORT_BRIEF_DOCS = 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. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = 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 +# Note: This option applies only to the class list, not to the # alphabetical list. -SORT_BY_SCOPE_NAME = NO +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 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = 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 +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 +# 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 +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 +# 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 +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 +# 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 +GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +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 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro 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 macros in the +# documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. -MAX_INITIALIZER_LINES = 30 +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 +# 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 +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. +# 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_DIRECTORIES = NO +SHOW_FILES = 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 +# 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 = +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. To 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 = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# 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 +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 +# 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 +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 +# 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 = NO +WARN_IF_UNDOCUMENTED = NO -# 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 +# 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 +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 +# The WARN_NO_PARAMDOC option can be enabled 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 +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 +# 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" +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 +# 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 = +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 +# 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 = ../../../include +INPUT = ../../../include ../../../src/scheduler/include/ -# 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. +# 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 +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 +# 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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl -FILE_PATTERNS = *.h +FILE_PATTERNS = *.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. +# 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 = NO +RECURSIVE = NO -# 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 +# The EXCLUDE tag can be used to specify files and/or directories that should be +# 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. +# Note that relative paths are relative to the directory from which doxygen is +# run. -EXCLUDE = +EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded # from the input. -EXCLUDE_SYMLINKS = NO +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 +# 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 = +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 +# 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 = +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 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 = +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 +# 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 = +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. +# 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 +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_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 = +IMAGE_PATH = -# 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 +# 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 = +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. +# 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 or if +# non of the patterns match the file name, INPUT_FILTER is applied. -FILTER_PATTERNS = +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 +# 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 +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = #--------------------------------------------------------------------------- # 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. If you have enabled CALL_GRAPH or CALLER_GRAPH -# then you must also enable this option. If you don't then doxygen will produce -# a warning and turn it on anyway +# 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 = NO +SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. -INLINE_SOURCES = NO +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. +# 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, C++ and Fortran comments will always remain visible. -STRIP_CODE_COMMENTS = YES +STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented +# 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 (the default) -# then for each documented function all documented entities +# 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 +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 documentstion. +# 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 +# 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 +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 +# 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 = YES +VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # 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 +# 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 +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 +# 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 +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 +# 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 = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. -GENERATE_HTML = YES +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 +# 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 +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 +# 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 +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. +# 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. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! -HTML_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 +# 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 = +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! +# 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 +# style sheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = +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. +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. -HTML_ALIGN_MEMBERS = YES +HTML_EXTRA_FILES = -# 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 compressed HTML help file (.chm) +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = 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. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# 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 + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# 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 +GENERATE_HTMLHELP = NO -# 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_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 +# 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 = +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 +# 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 = +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 +# 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 +GENERATE_CHI = NO -# 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 +# 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 +BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members +# 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 = NO +TOC_EXPAND = NO -# 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. +# 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. -DISABLE_INDEX = NO +GENERATE_QHP = 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. +# 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. -ENUM_VALUES_PER_LINE = 4 +QCH_FILE = -# If the GENERATE_TREEVIEW tag is set to YES, 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. +# 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 -GENERATE_TREEVIEW = NO +QHP_NAMESPACE = org.doxygen.Project -# 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 +# 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 = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# 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 YES, 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 (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# 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 +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# 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 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = YES +GENERATE_LATEX = NO -# 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 +# 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 +LATEX_OUTPUT = latex -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# 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. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. -LATEX_CMD_NAME = latex +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 +# 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 +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 +# 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 +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 +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and # executive. If left blank a4wide will be used. -PAPER_TYPE = a4wide +PAPER_TYPE = a4wide -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# 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 = +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 +# 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 = +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 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# 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 = NO +PDF_HYPERLINKS = NO -# 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 +# 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 = NO +USE_PDFLATEX = NO -# 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. +# 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 +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.) +# 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 +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain #--------------------------------------------------------------------------- # 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 +# 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 = NO +GENERATE_RTF = NO -# 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 +# 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 +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 +# 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 +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. +# 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 +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 +# Load style sheet 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 = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_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 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages -GENERATE_MAN = NO +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 +# 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 +MAN_OUTPUT = man -# The MAN_EXTENSION tag determines the extension that is added to +# 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 +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 +# 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 +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 +# 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 +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 +# 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 +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 +# 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 = +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 +# 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 = +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 +# 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 +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 +# 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 +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 +# 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 +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 +# 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 +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 +# 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 +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 +# 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 = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# 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 +# 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 +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 +# 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 +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 +# 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 +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. +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. -SEARCH_INCLUDES = YES +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 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 = +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 +# 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 = +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 +# 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 = +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. +# 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 that +# overrules the definition found in the source code. -EXPAND_AS_DEFINED = +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. +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. -SKIP_FUNCTION_MACROS = YES +SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# 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. +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. 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. 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 = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# 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 = +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 +# 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 +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 +# 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 +EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script +# 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 +PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# 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. +# 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 also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. -CLASS_DIAGRAMS = NO +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. +# 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 = +MSCGEN_PATH = -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# 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 +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 +# 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 = YES +HAVE_DOT = YES -# 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. +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. -CLASS_GRAPH = YES +DOT_NUM_THREADS = 0 -# 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 +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You 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 = Helvetica + +# 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 Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +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 +# 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 +COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# 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 +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 +# 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 +UML_LOOK = NO -# If set to YES, the inheritance and collaboration graphs will show the +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. -TEMPLATE_RELATIONS = NO +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 +# 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 +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 +# 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 +INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags 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. +# 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 +CALL_GRAPH = NO -# If the CALLER_GRAPH, SOURCE_BROWSER 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. +# 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 +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. +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. -GRAPHICAL_HIERARCHY = YES +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 +# If the DIRECTORY_GRAPH 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 +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. +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). -DOT_IMAGE_FORMAT = png +DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# 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 = +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 +# 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 = +DOTFILE_DIRS = -# The MAX_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 -# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_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 +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 +# 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 +MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# 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). +# 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 +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) +# 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 +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 +# 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 +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 +# 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 - -#--------------------------------------------------------------------------- -# Configuration::additions 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 +DOT_CLEANUP = YES diff --git a/share/etc/oned.conf b/share/etc/oned.conf index 5833e0e5e7..06132ab3ea 100644 --- a/share/etc/oned.conf +++ b/share/etc/oned.conf @@ -6,16 +6,14 @@ # Daemon configuration attributes #------------------------------------------------------------------------------- # MANAGER_TIMER: Time in seconds the core uses to evaluate periodical functions. -# HOST_MONITORING_INTERVAL and VM_POLLING_INTERVAL can not have smaller values -# than MANAGER_TIMER. +# MONITORING_INTERVAL cannot have a smaller value than MANAGER_TIMER. +# +# MONITORING_INTERVAL: Time in seconds between host and VM monitorization. # -# HOST_MONITORING_INTERVAL: Time in seconds between host monitorization. # HOST_PER_INTERVAL: Number of hosts monitored in each interval. # HOST_MONITORING_EXPIRATION_TIME: Time, in seconds, to expire monitoring # information. Use 0 to disable HOST monitoring recording. # -# VM_POLLING_INTERVAL: Time in seconds between virtual machine monitorization. -# Use 0 to disable VM monitoring. # VM_PER_INTERVAL: Number of VMs monitored in each interval. # VM_MONITORING_EXPIRATION_TIME: Time, in seconds, to expire monitoring # information. Use 0 to disable VM monitoring recording. @@ -46,7 +44,6 @@ # VM_SUBMIT_ON_HOLD: Forces VMs to be created on hold state instead of pending. # Values: YES or NO. #******************************************************************************* -# LOG = [ system = "file", @@ -55,11 +52,11 @@ LOG = [ #MANAGER_TIMER = 30 -HOST_MONITORING_INTERVAL = 600 +MONITORING_INTERVAL = 300 + #HOST_PER_INTERVAL = 15 #HOST_MONITORING_EXPIRATION_TIME = 86400 -VM_POLLING_INTERVAL = 600 #VM_PER_INTERVAL = 5 #VM_MONITORING_EXPIRATION_TIME = 86400 diff --git a/src/authm/AuthManager.cc b/src/authm/AuthManager.cc index 2eaa4dc507..4c31b8500a 100644 --- a/src/authm/AuthManager.cc +++ b/src/authm/AuthManager.cc @@ -17,7 +17,7 @@ #include "AuthManager.h" #include "AuthRequest.h" #include "NebulaLog.h" -#include "SSLTools.h" +#include "NebulaUtil.h" #include "PoolObjectAuth.h" #include "Nebula.h" @@ -40,7 +40,7 @@ void AuthRequest::add_auth(Operation op, if ( !ob_template.empty() ) { - string * encoded_id = SSLTools::base64_encode(ob_template); + string * encoded_id = one_util::base64_encode(ob_template); if (encoded_id != 0) { diff --git a/src/common/Attribute.cc b/src/common/Attribute.cc index 9b374f3962..7d53506791 100644 --- a/src/common/Attribute.cc +++ b/src/common/Attribute.cc @@ -270,6 +270,11 @@ int VectorAttribute::vector_value(const char *name, int & value) const istringstream iss(it->second); iss >> value; + if (iss.fail() || !iss.eof()) + { + return -1; + } + return 0; } @@ -295,6 +300,11 @@ int VectorAttribute::vector_value(const char *name, float & value) const istringstream iss(it->second); iss >> value; + if (iss.fail() || !iss.eof()) + { + return -1; + } + return 0; } diff --git a/src/common/NebulaUtil.cc b/src/common/NebulaUtil.cc index 29eb5063af..60ac444696 100644 --- a/src/common/NebulaUtil.cc +++ b/src/common/NebulaUtil.cc @@ -15,6 +15,16 @@ /* -------------------------------------------------------------------------- */ #include "NebulaUtil.h" + +#include +#include +#include +#include +#include + +#include +#include +#include #include using namespace std; @@ -25,12 +35,18 @@ string& one_util::toupper(string& st) return st; }; +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + string& one_util::tolower(string& st) { transform(st.begin(),st.end(),st.begin(),(int(*)(int))std::tolower); return st; }; +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + string one_util::log_time(time_t the_time) { char time_str[26]; @@ -46,8 +62,115 @@ string one_util::log_time(time_t the_time) return string(time_str); }; +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + string one_util::log_time() { return log_time( time(0) ); }; +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + +string * one_util::base64_encode(const string& in) +{ + BIO * bio_mem; + BIO * bio_64; + + char * encoded_c; + long int size; + + bio_64 = BIO_new(BIO_f_base64()); + bio_mem = BIO_new(BIO_s_mem()); + + BIO_push(bio_64, bio_mem); + + BIO_set_flags(bio_64, BIO_FLAGS_BASE64_NO_NL); + + BIO_write(bio_64, in.c_str(), in.length()); + + if (BIO_flush(bio_64) != 1) + { + return 0; + } + + size = BIO_get_mem_data(bio_mem,&encoded_c); + + string * encoded = new string(encoded_c,size); + + BIO_free_all(bio_64); + + return encoded; +} + +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + +string * one_util::base64_decode(const string& in) +{ + BIO * bio_mem_in; + BIO * bio_mem_out; + BIO * bio_64; + + char inbuf[512]; + int inlen; + + char * decoded_c; + long int size; + + bio_64 = BIO_new(BIO_f_base64()); + + bio_mem_in = BIO_new(BIO_s_mem()); + bio_mem_out = BIO_new(BIO_s_mem()); + + bio_64 = BIO_push(bio_64, bio_mem_in); + + BIO_set_flags(bio_64, BIO_FLAGS_BASE64_NO_NL); + + BIO_write(bio_mem_in, in.c_str(), in.length()); + + while((inlen = BIO_read(bio_64, inbuf, 512)) > 0) + { + BIO_write(bio_mem_out, inbuf, inlen); + } + + size = BIO_get_mem_data(bio_mem_out, &decoded_c); + + string * decoded = new string(decoded_c, size); + + BIO_free_all(bio_64); + BIO_free_all(bio_mem_out); + + return decoded; +} + +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + +string one_util::sha1_digest(const string& in) +{ + EVP_MD_CTX mdctx; + unsigned char md_value[EVP_MAX_MD_SIZE]; + unsigned int md_len; + ostringstream oss; + + EVP_MD_CTX_init(&mdctx); + EVP_DigestInit_ex(&mdctx, EVP_sha1(), NULL); + + EVP_DigestUpdate(&mdctx, in.c_str(), in.length()); + + EVP_DigestFinal_ex(&mdctx,md_value,&md_len); + EVP_MD_CTX_cleanup(&mdctx); + + for(unsigned int i = 0; i -#include -#include -#include -#include - -#include "SSLTools.h" -#include -#include -#include - - -//#include - - -//#include -//#include -//#include - -/* -------------------------------------------------------------------------- */ -/* -------------------------------------------------------------------------- */ - -string * SSLTools::base64_encode(const string& in) -{ - BIO * bio_mem; - BIO * bio_64; - - char * encoded_c; - long int size; - - bio_64 = BIO_new(BIO_f_base64()); - bio_mem = BIO_new(BIO_s_mem()); - - BIO_push(bio_64, bio_mem); - - BIO_set_flags(bio_64,BIO_FLAGS_BASE64_NO_NL); - - BIO_write(bio_64, in.c_str(), in.length()); - - if (BIO_flush(bio_64) != 1) - { - return 0; - } - - size = BIO_get_mem_data(bio_mem,&encoded_c); - - string * encoded = new string(encoded_c,size); - - BIO_free_all(bio_64); - - return encoded; -} - -/* -------------------------------------------------------------------------- */ -/* -------------------------------------------------------------------------- */ - -string SSLTools::sha1_digest(const string& in) -{ - EVP_MD_CTX mdctx; - unsigned char md_value[EVP_MAX_MD_SIZE]; - unsigned int md_len; - ostringstream oss; - - EVP_MD_CTX_init(&mdctx); - EVP_DigestInit_ex(&mdctx, EVP_sha1(), NULL); - - EVP_DigestUpdate(&mdctx, in.c_str(), in.length()); - - EVP_DigestFinal_ex(&mdctx,md_value,&md_len); - EVP_MD_CTX_cleanup(&mdctx); - - for(unsigned int i = 0; i &lost, + map &found) { - char * error_msg; - int rc; - float fv; + char * error_msg; + Template* tmpl; + VectorAttribute* vatt; + vector::iterator it; + vector vm_att; + + int rc; + int vmid; + float fv; + + ostringstream zombie; + ostringstream wild; + + int num_zombies = 0; + int num_wilds = 0; + + // + // ---------------------------------------------------------------------- // + // Parse Template (twice because of repeated VM values) // + // ---------------------------------------------------------------------- // rc = obj_template->parse(parse_str, &error_msg); if ( rc != 0 ) { - NebulaLog::log("ONE", Log::ERROR, error_msg); + ostringstream ess; + + ess << "Error parsing host information: " << error_msg + << "Monitoring information: " << parse_str; + + NebulaLog::log("ONE", Log::ERROR, ess); + + touch(false); + + set_template_error_message("Error parsing monitor information." + " Check oned.log for more details."); free(error_msg); + return -1; } + tmpl = new Template(); + + tmpl->parse(parse_str, &error_msg); + + // ---------------------------------------------------------------------- // + // Extract share information // + // ---------------------------------------------------------------------- // get_template_attribute("TOTALCPU", fv); host_share.max_cpu = static_cast(fv); get_template_attribute("TOTALMEMORY", fv); @@ -201,12 +239,113 @@ int Host::update_info(string &parse_str) get_template_attribute("USEDMEMORY", fv); host_share.used_mem = static_cast(fv); + // ---------------------------------------------------------------------- // + // Remove expired information // + // ---------------------------------------------------------------------- // + clear_template_error_message(); + + remove_template_attribute("ZOMBIES"); + remove_template_attribute("TOTAL_ZOMBIES"); + + remove_template_attribute("WILDS"); + remove_template_attribute("TOTAL_WILDS"); + + remove_template_attribute("VM"); + + get_template_attribute("VM_POLL", with_vm_info); + remove_template_attribute("VM_POLL"); + + // ---------------------------------------------------------------------- // + // Correlate VM information with the list of running VMs // + // ---------------------------------------------------------------------- // + tmpl->remove("VM", vm_att); + + lost = vm_collection.get_collection_copy(); + + for (it = vm_att.begin(); it != vm_att.end(); it++) + { + vatt = dynamic_cast(*it); + + if (vatt == 0) + { + delete *it; + continue; + } + + rc = vatt->vector_value("ID", vmid); + + if (rc == 0 && vmid != -1) + { + if (lost.erase(vmid) == 1) //Good, known + { + found.insert(make_pair(vmid, vatt->vector_value("POLL"))); + } + else //Bad, known but should not be here + { + if (num_zombies++ > 0) + { + zombie << ", "; + } + + zombie << vatt->vector_value("DEPLOY_ID"); + } + } + else if (rc == 0) //not ours + { + if (num_wilds++ > 0) + { + wild << ", "; + } + + wild << vatt->vector_value("DEPLOY_ID"); + } + + delete *it; + } + + if (num_wilds > 0) + { + add_template_attribute("TOTAL_WILDS", num_wilds); + add_template_attribute("WILDS", wild.str()); + } + + if (num_zombies > 0) + { + add_template_attribute("TOTAL_ZOMBIES", num_zombies); + add_template_attribute("ZOMBIES", zombie.str()); + } + + delete tmpl; + + // Touch the host to update its last_monitored timestamp and state + + touch(true); + return 0; } /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ +void Host::error_info(const string& message, set &vm_ids) +{ + ostringstream oss; + + vm_ids = vm_collection.get_collection_copy(); + + oss << "Error monitoring Host " << get_name() << " (" << get_oid() << ")" + << ": " << message; + + NebulaLog::log("ONE", Log::ERROR, oss); + + touch(false); + + set_template_error_message(oss.str()); +} + +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + int Host::update_monitoring(SqlDB * db) { ostringstream oss; diff --git a/src/host/HostPool.cc b/src/host/HostPool.cc index 762550e6d6..f0362280fa 100644 --- a/src/host/HostPool.cc +++ b/src/host/HostPool.cc @@ -243,36 +243,32 @@ error_common: /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ -int HostPool::discover_cb(void * _map, int num, char **values, char **names) +int HostPool::discover_cb(void * _set, int num, char **values, char **names) { - map * discovered_hosts; - string im_mad; - int hid; - int rc; + set * discovered_hosts; + string im_mad; + int hid; - discovered_hosts = static_cast *>(_map); + discovered_hosts = static_cast *>(_set); - if ( (num<2) || (values[0] == 0) || (values[1] == 0) ) + if ( (num<1) || (values[0] == 0) ) { return -1; } hid = atoi(values[0]); - rc = ObjectXML::xpath_value(im_mad,values[1],"/HOST/IM_MAD"); - if( rc != 0) - { - return -1; - } - - discovered_hosts->insert(make_pair(hid,im_mad)); + discovered_hosts->insert(hid); return 0; } /* -------------------------------------------------------------------------- */ -int HostPool::discover(map * discovered_hosts, int host_limit) +int HostPool::discover( + set * discovered_hosts, + int host_limit, + time_t target_time) { ostringstream sql; int rc; @@ -280,9 +276,9 @@ int HostPool::discover(map * discovered_hosts, int host_limit) set_callback(static_cast(&HostPool::discover_cb), static_cast(discovered_hosts)); - sql << "SELECT oid, body FROM " - << Host::table << " WHERE state != " - << Host::DISABLED << " ORDER BY last_mon_time ASC LIMIT " << host_limit; + sql << "SELECT oid FROM " << Host::table + << " WHERE last_mon_time <= " << target_time + << " ORDER BY last_mon_time ASC LIMIT " << host_limit; rc = db->exec(sql,this); diff --git a/src/im/InformationManager.cc b/src/im/InformationManager.cc index b3fb10f42b..99436fa033 100644 --- a/src/im/InformationManager.cc +++ b/src/im/InformationManager.cc @@ -19,9 +19,10 @@ #include #include +#include -const time_t InformationManager::monitor_expire = 600; +const time_t InformationManager::monitor_expire = 300; /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ @@ -97,6 +98,8 @@ int InformationManager::start() return -1; } + utime(remotes_location.c_str(), 0); + NebulaLog::log("InM",Log::INFO,"Starting Information Manager..."); pthread_attr_init (&pattr); @@ -144,8 +147,8 @@ void InformationManager::timer_action() struct stat sb; - map discovered_hosts; - map::iterator it; + set discovered_hosts; + set::iterator it; const InformationManagerDriver * imd; @@ -153,6 +156,7 @@ void InformationManager::timer_action() istringstream iss; time_t monitor_length; + time_t target_time; mark = mark + timer_period; @@ -165,15 +169,17 @@ void InformationManager::timer_action() // Clear the expired monitoring records hpool->clean_expired_monitoring(); - rc = hpool->discover(&discovered_hosts, host_limit); + now = time(0); + + target_time = now - monitor_period; + + rc = hpool->discover(&discovered_hosts, host_limit, target_time); if ((rc != 0) || (discovered_hosts.empty() == true)) { return; } - now = time(0); - if (stat(remotes_location.c_str(), &sb) == -1) { sb.st_mtime = 0; @@ -184,7 +190,7 @@ void InformationManager::timer_action() for(it=discovered_hosts.begin();it!=discovered_hosts.end();it++) { - host = hpool->get(it->first,true); + host = hpool->get(*it,true); if (host == 0) { @@ -200,21 +206,21 @@ void InformationManager::timer_action() hpool->update(host); } - if ( host->isEnabled() && !(host->isMonitoring()) && - (monitor_length >= monitor_period)) + if ( !(host->isMonitoring()) && + (host->isEnabled() || host->get_share_running_vms() != 0) ) { oss.str(""); oss << "Monitoring host " << host->get_name() - << " (" << it->first << ")"; + << " (" << host->get_oid() << ")"; NebulaLog::log("InM",Log::INFO,oss); - imd = get(it->second); + imd = get(host->get_im_mad()); if (imd == 0) { oss.str(""); - oss << "Could not find information driver " << it->second; + oss << "Could not find information driver " << host->get_im_mad(); NebulaLog::log("InM",Log::ERROR,oss); host->set_state(Host::ERROR); @@ -229,7 +235,7 @@ void InformationManager::timer_action() update_remotes = true; } - imd->monitor(it->first,host->get_name(),update_remotes); + imd->monitor(host->get_oid(),host->get_name(),update_remotes); host->set_monitoring_state(); } diff --git a/src/im/InformationManagerDriver.cc b/src/im/InformationManagerDriver.cc index 56489a48f2..d9bbc8971e 100644 --- a/src/im/InformationManagerDriver.cc +++ b/src/im/InformationManagerDriver.cc @@ -16,6 +16,9 @@ #include "InformationManagerDriver.h" #include "NebulaLog.h" +#include "Nebula.h" +#include "NebulaUtil.h" +#include "VirtualMachineManagerDriver.h" #include @@ -45,13 +48,18 @@ void InformationManagerDriver::protocol( string action; //stores the action result string result; - //stores the action id of the asociated HOSR + //stores the action id of the associated HOST int id; ostringstream ess; - string hinfo; + Host * host; + set vm_ids; + + string hinfo64; + string* hinfo; + // Parse the driver message if ( is.good() ) @@ -87,6 +95,13 @@ void InformationManagerDriver::protocol( if ( action == "MONITOR" ) { + bool vm_poll; + + set lost; + map found; + + int rc; + host = hpool->get(id,true); if ( host == 0 ) @@ -94,43 +109,74 @@ void InformationManagerDriver::protocol( goto error_host; } - if (result == "SUCCESS") + getline (is, hinfo64); + + hinfo = one_util::base64_decode(hinfo64); + + if (result != "SUCCESS") { - size_t pos; - int rc; + set vm_ids; - ostringstream oss; + host->error_info(*hinfo, vm_ids); - getline (is,hinfo); - - for (pos=hinfo.find(',');pos!=string::npos;pos=hinfo.find(',')) + for (set::iterator it = vm_ids.begin(); it != vm_ids.end(); it++) { - hinfo.replace(pos,1,"\n"); + Nebula &ne = Nebula::instance(); + LifeCycleManager *lcm = ne.get_lcm(); + + lcm->trigger(LifeCycleManager::MONITOR_DONE, *it); } - hinfo += "\n"; + delete hinfo; - oss << "Host " << id << " successfully monitored."; - NebulaLog::log("InM",Log::DEBUG,oss); + hpool->update(host); + host->unlock(); - rc = host->update_info(hinfo); - - if (rc != 0) - { - goto error_parse_info; - } + return; } - else + + rc = host->update_info(*hinfo, vm_poll, lost, found); + + if (rc != 0) { - goto error_driver_info; + delete hinfo; + + hpool->update(host); + host->unlock(); + + return; } - host->touch(true); + delete hinfo; hpool->update(host); hpool->update_monitoring(host); + ess << "Host " << host->get_name() << " (" << host->get_oid() << ")" + << " successfully monitored."; + + NebulaLog::log("InM", Log::DEBUG, ess); + host->unlock(); + + if (vm_poll) + { + set::iterator its; + map::iterator itm; + + for (its = lost.begin(); its != lost.end(); its++) + { + Nebula &ne = Nebula::instance(); + LifeCycleManager *lcm = ne.get_lcm(); + + lcm->trigger(LifeCycleManager::MONITOR_DONE, *its); + } + + for (itm = found.begin(); itm != found.end(); itm++) + { + VirtualMachineManagerDriver::process_poll(itm->first, itm->second); + } + } } else if (action == "LOG") { @@ -142,27 +188,6 @@ void InformationManagerDriver::protocol( return; -error_driver_info: - ess << "Error monitoring host " << id << " : " << is.str(); - goto error_common_info; - -error_parse_info: - ess << "Error parsing host information: " << hinfo; - goto error_common_info; - -error_common_info: - NebulaLog::log("InM",Log::ERROR,ess); - - host->set_template_error_message(ess.str()); - - host->touch(false); - - hpool->update(host); - - host->unlock(); - - return; - error_host: ess << "Could not get host " << id; NebulaLog::log("InM",Log::ERROR,ess); @@ -170,7 +195,6 @@ error_host: return; error_parse: - ess << "Error while parsing driver message: " << message; NebulaLog::log("InM",Log::ERROR,ess); diff --git a/src/im_mad/dummy/one_im_dummy.rb b/src/im_mad/dummy/one_im_dummy.rb index da3bb2150b..60ed2bd1be 100755 --- a/src/im_mad/dummy/one_im_dummy.rb +++ b/src/im_mad/dummy/one_im_dummy.rb @@ -30,6 +30,7 @@ $: << RUBY_LIB_LOCATION require 'OpenNebulaDriver' require 'CommandManager' +require 'base64' # The SSH Information Manager Driver @@ -48,20 +49,22 @@ class DummyInformationManager < OpenNebulaDriver # Execute the sensor array in the remote host def action_monitor(number, host, not_used) - results = "HYPERVISOR=dummy," - results << "HOSTNAME=#{host}," + results = "HYPERVISOR=dummy\n" + results << "HOSTNAME=#{host}\n" - results << "CPUSPEED=2.2GHz," + results << "CPUSPEED=2.2GHz\n" used_memory = rand(16777216) - results << "TOTALMEMORY=16777216," - results << "USEDMEMORY=#{used_memory}," - results << "FREEMEMORY=#{16777216-used_memory}," + results << "TOTALMEMORY=16777216\n" + results << "USEDMEMORY=#{used_memory}\n" + results << "FREEMEMORY=#{16777216-used_memory}\n" used_cpu = rand(800) - results << "TOTALCPU=800," - results << "USEDCPU=#{used_cpu}," - results << "FREECPU=#{800-used_cpu}" + results << "TOTALCPU=800\n" + results << "USEDCPU=#{used_cpu}\n" + results << "FREECPU=#{800-used_cpu}\n" + + results = Base64::encode64(results).strip.delete("\n") send_message("MONITOR", RESULT[:success], number, results) end diff --git a/src/im_mad/ec2/one_im_ec2.rb b/src/im_mad/ec2/one_im_ec2.rb index 6a978f8dae..cbe5b54025 100755 --- a/src/im_mad/ec2/one_im_ec2.rb +++ b/src/im_mad/ec2/one_im_ec2.rb @@ -28,6 +28,7 @@ $: << RUBY_LIB_LOCATION require 'pp' require 'OpenNebulaDriver' +require 'base64' # The EC2 Information Manager Driver class EC2InformationManagerDriver < OpenNebulaDriver @@ -57,15 +58,16 @@ class EC2InformationManagerDriver < OpenNebulaDriver totalmemory = smem + lmem + xlmem totalcpu = scpu + lcpu + xlcpu - @info="HYPERVISOR=ec2,TOTALMEMORY=#{totalmemory},"<< - "TOTALCPU=#{totalcpu},CPUSPEED=1000,FREEMEMORY=#{totalmemory},"<< - "FREECPU=#{totalcpu}" + @info="HYPERVISOR=ec2\nTOTALMEMORY=#{totalmemory}\n"<< + "TOTALCPU=#{totalcpu}\nCPUSPEED=1000\nFREEMEMORY=#{totalmemory}"<< + "\nFREECPU=#{totalcpu}\n" end # The monitor action, just print the capacity info and hostname def action_monitor(num, host, not_used) - send_message("MONITOR", RESULT[:success], num, - "HOSTNAME=#{host},#{@info}") + info = "HOSTNAME=\"#{host}\"\n#{@info}" + info64 = Base64::encode64(info).strip.delete("\n") + send_message("MONITOR", RESULT[:success], num, info64) end end diff --git a/src/im_mad/im_exec/one_im_exec.rb b/src/im_mad/im_exec/one_im_exec.rb index cb8c496296..94d04c3a47 100755 --- a/src/im_mad/im_exec/one_im_exec.rb +++ b/src/im_mad/im_exec/one_im_exec.rb @@ -71,8 +71,9 @@ class InformationManagerDriver < OpenNebulaDriver end end end + do_action("#{@hypervisor}", number, host, :MONITOR, - :script_name => 'run_probes') + :script_name => 'run_probes', :base64 => true) end end @@ -102,7 +103,7 @@ begin when '--local' local_actions={ 'MONITOR' => nil } when '--force-copy' - force_copy=true + force_copy=true end end rescue Exception => e diff --git a/src/im_mad/remotes/ganglia.d/ganglia_probe b/src/im_mad/remotes/ganglia.d/ganglia_probe index 1fc6a43071..2be364e322 100755 --- a/src/im_mad/remotes/ganglia.d/ganglia_probe +++ b/src/im_mad/remotes/ganglia.d/ganglia_probe @@ -87,5 +87,5 @@ info.each do |key, value| GangliaHost.print_info(key, value) end - +system("../../vmm/kvm/poll_ganglia #{host}") diff --git a/src/im_mad/remotes/kvm.d/poll.sh b/src/im_mad/remotes/kvm.d/poll.sh new file mode 100755 index 0000000000..915f0a1a0a --- /dev/null +++ b/src/im_mad/remotes/kvm.d/poll.sh @@ -0,0 +1,20 @@ +#!/bin/sh + +# -------------------------------------------------------------------------- # +# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs # +# # +# Licensed under the Apache License, Version 2.0 (the "License"); you may # +# not use this file except in compliance with the License. You may obtain # +# a copy of the License at # +# # +# http://www.apache.org/licenses/LICENSE-2.0 # +# # +# Unless required by applicable law or agreed to in writing, software # +# distributed under the License is distributed on an "AS IS" BASIS, # +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # +# See the License for the specific language governing permissions and # +# limitations under the License. # +#--------------------------------------------------------------------------- # + +../../vmm/kvm/poll --kvm -t + diff --git a/src/im_mad/remotes/run_probes b/src/im_mad/remotes/run_probes index 0f55fa1998..02508eedbb 100755 --- a/src/im_mad/remotes/run_probes +++ b/src/im_mad/remotes/run_probes @@ -50,7 +50,7 @@ data=$( EXIT_CODE=$? -echo $data | tr '\n' ' ' +echo "$data" if [ "x$EXIT_CODE" != "x0" ]; then exit $EXIT_CODE diff --git a/src/im_mad/remotes/vmware.d/vmware.rb b/src/im_mad/remotes/vmware.d/vmware.rb index 28a5547752..13b52785be 100755 --- a/src/im_mad/remotes/vmware.d/vmware.rb +++ b/src/im_mad/remotes/vmware.d/vmware.rb @@ -77,13 +77,46 @@ end def add_info(name, value) value = "0" if value.nil? or value.to_s.empty? - @result_str << "#{name}=#{value} " + @result_str << "#{name}=#{value}\n" end def print_info puts @result_str end +def get_vm_names + rc, data = do_action("virsh -c #{@uri} --readonly list") + return [] if !rc + + data.gsub!(/^.*----$/m, '').strip! + lines=data.split(/\n/) + + lines.map do |line| + line.split(/\s+/).delete_if {|d| d.empty? }[1] + end.compact +end + +def get_vm_info(host, vm) + `../../vmm/vmware/poll #{vm} #{host}`.strip +end + +def get_all_vm_info(host, vms) + puts "VM_POLL=YES" + vms.each do |vm| + info=get_vm_info(host, vm) + + number = -1 + if (vm =~ /^one-\d*$/) + number = vm.split('-').last + end + + puts "VM=[" + puts " ID=#{number}," + puts " DEPLOY_ID=#{vm}," + puts " POLL=\"#{info}\" ]" + end +end + # ######################################################################## # # Main Procedure # # ######################################################################## # @@ -165,3 +198,5 @@ add_info("TOTALMEMORY",$total_memory) add_info("FREEMEMORY",free_memory.to_i) print_info + +get_all_vm_info(host, get_vm_names) diff --git a/src/im_mad/remotes/xen.d/poll.sh b/src/im_mad/remotes/xen.d/poll.sh new file mode 100755 index 0000000000..a3215e63ee --- /dev/null +++ b/src/im_mad/remotes/xen.d/poll.sh @@ -0,0 +1,20 @@ +#!/bin/sh + +# -------------------------------------------------------------------------- # +# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs # +# # +# Licensed under the Apache License, Version 2.0 (the "License"); you may # +# not use this file except in compliance with the License. You may obtain # +# a copy of the License at # +# # +# http://www.apache.org/licenses/LICENSE-2.0 # +# # +# Unless required by applicable law or agreed to in writing, software # +# distributed under the License is distributed on an "AS IS" BASIS, # +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # +# See the License for the specific language governing permissions and # +# limitations under the License. # +#--------------------------------------------------------------------------- # + +../../vmm/xen/poll --xen -t + diff --git a/src/image/ImageManagerActions.cc b/src/image/ImageManagerActions.cc index 94954b6bf5..31bd636bbd 100644 --- a/src/image/ImageManagerActions.cc +++ b/src/image/ImageManagerActions.cc @@ -17,7 +17,6 @@ #include "ImageManager.h" #include "NebulaLog.h" #include "ImagePool.h" -#include "SSLTools.h" #include "SyncRequest.h" #include "Template.h" #include "Nebula.h" @@ -812,7 +811,7 @@ string * ImageManager::format_message( << ds_data << ""; - return SSLTools::base64_encode(oss.str()); + return one_util::base64_encode(oss.str()); } /* -------------------------------------------------------------------------- */ diff --git a/src/mad/ruby/OpenNebulaDriver.rb b/src/mad/ruby/OpenNebulaDriver.rb index e25ae7bdb2..b5ba44ff95 100644 --- a/src/mad/ruby/OpenNebulaDriver.rb +++ b/src/mad/ruby/OpenNebulaDriver.rb @@ -18,6 +18,7 @@ require "ActionManager" require "CommandManager" require "DriverExecHelper" +require 'base64' # This class provides basic messaging and logging functionality # to implement OpenNebula Drivers. A driver is a program that @@ -29,7 +30,7 @@ require "DriverExecHelper" # with the action name through the register_action function class OpenNebulaDriver < ActionManager include DriverExecHelper - + # @return [String] Base path for scripts attr_reader :local_scripts_base_path, :remote_scripts_base_path # @return [String] Path for scripts @@ -57,10 +58,10 @@ class OpenNebulaDriver < ActionManager super(@options[:concurrency], @options[:threaded]) - @retries = @options[:retries] + @retries = @options[:retries] #Set default values - initialize_helper(directory, @options) + initialize_helper(directory, @options) register_action(:INIT, method("init")) end @@ -78,13 +79,15 @@ class OpenNebulaDriver < ActionManager # @option ops [String] :stdin text to be writen to stdin # @option ops [String] :script_name default script name for the action, # action name is used by defaults - # @option ops [String] :respond if defined will send result to ONE core + # @option ops [Bool] :respond if defined will send result to ONE core + # @option ops [Bool] :base64 encode the information sent to ONE core def do_action(parameters, id, host, aname, ops={}) options={ :stdin => nil, :script_name => nil, :respond => true, - :ssh_stream => nil + :ssh_stream => nil, + :base64 => false }.merge(ops) params = parameters + " #{id} #{host}" @@ -115,7 +118,8 @@ class OpenNebulaDriver < ActionManager result, info = get_info_from_execution(execution) if options[:respond] - send_message(aname,result,id,info) + info = Base64::encode64(info).strip.delete("\n") if options[:base64] + send_message(aname, result, id, info) end [result, info] diff --git a/src/nebula/Nebula.cc b/src/nebula/Nebula.cc index 418ad6117b..a736c860d8 100644 --- a/src/nebula/Nebula.cc +++ b/src/nebula/Nebula.cc @@ -638,17 +638,19 @@ void Nebula::start() MadManager::mad_manager_system_init(); time_t timer_period; + time_t monitor_period; nebula_configuration->get("MANAGER_TIMER", timer_period); + nebula_configuration->get("MONITORING_INTERVAL", monitor_period); // ---- Virtual Machine Manager ---- try { - time_t poll_period; vector vmm_mads; int vm_limit; + time_t poll_period; - nebula_configuration->get("VM_POLLING_INTERVAL", poll_period); + poll_period = monitor_period * 2.5; nebula_configuration->get("VM_PER_INTERVAL", vm_limit); @@ -695,11 +697,8 @@ void Nebula::start() try { vector im_mads; - time_t monitor_period; int host_limit; - nebula_configuration->get("HOST_MONITORING_INTERVAL", monitor_period); - nebula_configuration->get("HOST_PER_INTERVAL", host_limit); nebula_configuration->get("IM_MAD", im_mads); diff --git a/src/nebula/NebulaTemplate.cc b/src/nebula/NebulaTemplate.cc index 65b0df29ee..5d1c4c4041 100644 --- a/src/nebula/NebulaTemplate.cc +++ b/src/nebula/NebulaTemplate.cc @@ -89,10 +89,9 @@ void OpenNebulaTemplate::set_conf_default() #******************************************************************************* # Daemon configuration attributes #------------------------------------------------------------------------------- -# HOST_MONITORING_INTERVAL +# MONITORING_INTERVAL # HOST_PER_INTERVAL # HOST_MONITORING_EXPIRATION_TIME -# VM_POLLING_INTERVAL # VM_PER_INTERVAL # VM_MONITORING_EXPIRATION_TIME # PORT @@ -102,10 +101,10 @@ void OpenNebulaTemplate::set_conf_default() # VM_SUBMIT_ON_HOLD #******************************************************************************* */ - // MONITOR_INTERVAL - value = "600"; + // MONITORING_INTERVAL + value = "300"; - attribute = new SingleAttribute("HOST_MONITORING_INTERVAL",value); + attribute = new SingleAttribute("MONITORING_INTERVAL",value); conf_default.insert(make_pair(attribute->name(),attribute)); // HOST_PER_INTERVAL @@ -120,12 +119,6 @@ void OpenNebulaTemplate::set_conf_default() attribute = new SingleAttribute("HOST_MONITORING_EXPIRATION_TIME",value); conf_default.insert(make_pair(attribute->name(),attribute)); - // POLL_INTERVAL - value = "600"; - - attribute = new SingleAttribute("VM_POLLING_INTERVAL",value); - conf_default.insert(make_pair(attribute->name(),attribute)); - // VM_PER_INTERVAL value = "5"; diff --git a/src/pool/PoolObjectSQL.cc b/src/pool/PoolObjectSQL.cc index 76ace6a665..bdc5c9a41b 100644 --- a/src/pool/PoolObjectSQL.cc +++ b/src/pool/PoolObjectSQL.cc @@ -16,7 +16,7 @@ #include "PoolObjectSQL.h" #include "PoolObjectAuth.h" -#include "SSLTools.h" +#include "NebulaUtil.h" #include "Nebula.h" #include "Clusterable.h" @@ -29,7 +29,7 @@ string& PoolObjectSQL::to_xml64(string &xml64) to_xml(xml64); - str64 = SSLTools::base64_encode(xml64); + str64 = one_util::base64_encode(xml64); xml64 = *str64; @@ -141,20 +141,7 @@ void PoolObjectSQL::set_template_error_message(const string& message) SingleAttribute * attr; ostringstream error_value; - char str[26]; - time_t the_time; - - the_time = time(NULL); - -#ifdef SOLARIS - ctime_r(&(the_time),str,sizeof(char)*26); -#else - ctime_r(&(the_time),str); -#endif - - str[24] = '\0'; // Get rid of final enter character - - error_value << str << " : " << message; + error_value << one_util::log_time() << " : " << message; //Replace previous error message and insert the new one @@ -167,6 +154,14 @@ void PoolObjectSQL::set_template_error_message(const string& message) /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ +void PoolObjectSQL::clear_template_error_message() +{ + remove_template_attribute(error_attribute_name); +} + +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + int PoolObjectSQL::replace_template(const string& tmpl_str, string& error) { Template * new_tmpl = get_new_template(); diff --git a/src/rm/RequestManagerUser.cc b/src/rm/RequestManagerUser.cc index 464f3415ec..c026c398c9 100644 --- a/src/rm/RequestManagerUser.cc +++ b/src/rm/RequestManagerUser.cc @@ -15,6 +15,7 @@ /* -------------------------------------------------------------------------- */ #include "RequestManagerUser.h" +#include "NebulaUtil.h" using namespace std; @@ -47,14 +48,14 @@ void RequestManagerUser:: failure_response(ACTION, request_error(error_str,""), att); return; } - + success_response(id, att); } /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ -int UserChangePassword::user_action(int user_id, +int UserChangePassword::user_action(int user_id, xmlrpc_c::paramList const& paramList, string& error_str) { @@ -71,7 +72,7 @@ int UserChangePassword::user_action(int user_id, if (user->get_auth_driver() == UserPool::CORE_AUTH) { - new_pass = SSLTools::sha1_digest(new_pass); + new_pass = one_util::sha1_digest(new_pass); } int rc = user->set_password(new_pass, error_str); @@ -128,7 +129,7 @@ int UserChangeAuth::user_action(int user_id, { if ( new_auth == UserPool::CORE_AUTH) { - new_pass = SSLTools::sha1_digest(new_pass); + new_pass = one_util::sha1_digest(new_pass); } // The password may be invalid, try to change it first @@ -170,7 +171,7 @@ void UserChangeAuth::log_xmlrpc_param( /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ -int UserSetQuota::user_action(int user_id, +int UserSetQuota::user_action(int user_id, xmlrpc_c::paramList const& paramList, string& error_str) { diff --git a/src/scheduler/src/client/Client.cc b/src/scheduler/src/client/Client.cc index 5e647d3e0c..0c3e0327f5 100644 --- a/src/scheduler/src/client/Client.cc +++ b/src/scheduler/src/client/Client.cc @@ -15,7 +15,6 @@ /* -------------------------------------------------------------------------- */ #include "Client.h" -#include "SSLTools.h" #include #include diff --git a/src/um/UserPool.cc b/src/um/UserPool.cc index c24b5f0cb4..cce59357b9 100644 --- a/src/um/UserPool.cc +++ b/src/um/UserPool.cc @@ -22,7 +22,7 @@ #include "NebulaLog.h" #include "Nebula.h" #include "AuthManager.h" -#include "SSLTools.h" +#include "NebulaUtil.h" #include #include @@ -145,7 +145,7 @@ UserPool::UserPool(SqlDB * db, srand(time(0)); sstr << rand(); - random = SSLTools::sha1_digest( sstr.str() ); + random = one_util::sha1_digest(sstr.str()); filenames[0] = nd.get_var_location() + "/.one/sunstone_auth"; filenames[1] = nd.get_var_location() + "/.one/occi_auth"; @@ -188,7 +188,7 @@ UserPool::UserPool(SqlDB * db, GroupPool::ONEADMIN_ID, SERVER_NAME, GroupPool::ONEADMIN_NAME, - SSLTools::sha1_digest(random), + one_util::sha1_digest(random), "server_cipher", true, error_str); @@ -289,7 +289,7 @@ int UserPool::allocate ( if (auth_driver == UserPool::CORE_AUTH) { - upass = SSLTools::sha1_digest(password); + upass = one_util::sha1_digest(password); } // Build a new User object diff --git a/src/vm/VirtualMachine.cc b/src/vm/VirtualMachine.cc index 7d79d4ce53..c60f67d023 100644 --- a/src/vm/VirtualMachine.cc +++ b/src/vm/VirtualMachine.cc @@ -2465,6 +2465,47 @@ string VirtualMachine::get_system_dir() const /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ +void VirtualMachine::update_info( + const int _memory, + const int _cpu, + const long long _net_tx, + const long long _net_rx, + const map &custom) +{ + map::const_iterator it; + + last_poll = time(0); + + if (_memory != -1) + { + memory = _memory; + } + + if (_cpu != -1) + { + cpu = _cpu; + } + + if (_net_tx != -1) + { + net_tx = _net_tx; + } + + if (_net_rx != -1) + { + net_rx = _net_rx; + } + + for (it = custom.begin(); it != custom.end(); it++) + { + replace_template_attribute(it->first, it->second); + } + + set_vm_info(); + + clear_template_error_message(); +}; + /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ diff --git a/src/vmm/VirtualMachineManager.cc b/src/vmm/VirtualMachineManager.cc index 933a2bd911..383d3bfe0d 100644 --- a/src/vmm/VirtualMachineManager.cc +++ b/src/vmm/VirtualMachineManager.cc @@ -19,6 +19,7 @@ #include "XenDriver.h" #include "XMLDriver.h" #include "LibVirtDriver.h" +#include "NebulaUtil.h" #include "Nebula.h" @@ -380,7 +381,7 @@ string * VirtualMachineManager::format_message( oss << tmpl << ""; - return SSLTools::base64_encode(oss.str()); + return one_util::base64_encode(oss.str()); } /* -------------------------------------------------------------------------- */ @@ -1337,8 +1338,6 @@ void VirtualMachineManager::poll_action( "", vm->to_xml(vm_tmpl)); - vm->set_last_poll(time(0)); - vmd->poll(vid, *drv_msg); delete drv_msg; @@ -1420,7 +1419,8 @@ error_common: void VirtualMachineManager::timer_action() { - static int mark = 0; + static int mark = 0; + static int timer_start = time(0); VirtualMachine * vm; vector oids; @@ -1446,6 +1446,13 @@ void VirtualMachineManager::timer_action() // Clear the expired monitoring records vmpool->clean_expired_monitoring(); + // Skip monitoring the first poll_period to allow the Host monitoring to + // gather the VM info + if ( timer_start + poll_period > thetime ) + { + return; + } + // Monitor only VMs that hasn't been monitored for 'poll_period' seconds. rc = vmpool->get_running(oids, vm_limit, thetime - poll_period); @@ -1478,8 +1485,6 @@ void VirtualMachineManager::timer_action() os << "Monitoring VM " << *it << "."; NebulaLog::log("VMM", Log::INFO, os); - vm->set_last_poll(thetime); - vmd = get(vm->get_vmm_mad()); if ( vmd == 0 ) @@ -1505,8 +1510,6 @@ void VirtualMachineManager::timer_action() delete drv_msg; - vmpool->update(vm); - vm->unlock(); } } diff --git a/src/vmm/VirtualMachineManagerDriver.cc b/src/vmm/VirtualMachineManagerDriver.cc index 14fd61f8c1..109f717579 100644 --- a/src/vmm/VirtualMachineManagerDriver.cc +++ b/src/vmm/VirtualMachineManagerDriver.cc @@ -206,12 +206,10 @@ void VirtualMachineManagerDriver::protocol( if (result == "SUCCESS") { string deploy_id; - time_t thetime = time(0); is >> deploy_id; vm->update_info(deploy_id); - vm->set_last_poll(thetime); vmpool->update(vm); @@ -236,7 +234,7 @@ void VirtualMachineManagerDriver::protocol( } else { - log_error(vm,os,is,"Error shuting down VM"); + log_error(vm,os,is,"Error shutting down VM"); vmpool->update(vm); lcm->trigger(LifeCycleManager::SHUTDOWN_FAILURE, id); @@ -314,7 +312,7 @@ void VirtualMachineManagerDriver::protocol( { if (result == "SUCCESS") { - vm->log("VMM",Log::ERROR,"VM Successfully rebooted."); + vm->log("VMM",Log::INFO,"VM successfully rebooted."); } else { @@ -326,7 +324,7 @@ void VirtualMachineManagerDriver::protocol( { if (result == "SUCCESS") { - vm->log("VMM",Log::ERROR,"VM Successfully reseted."); + vm->log("VMM",Log::INFO,"VM successfully reset."); } else { @@ -340,8 +338,8 @@ void VirtualMachineManagerDriver::protocol( LifeCycleManager *lcm = ne.get_lcm(); if ( result == "SUCCESS" ) - { - vm->log("VMM", Log::ERROR, "VM Disk Successfully attached."); + { + vm->log("VMM", Log::INFO, "VM Disk successfully attached."); lcm->trigger(LifeCycleManager::ATTACH_SUCCESS, id); } @@ -360,7 +358,7 @@ void VirtualMachineManagerDriver::protocol( if ( result == "SUCCESS" ) { - vm->log("VMM",Log::ERROR,"VM Disk Successfully detached."); + vm->log("VMM",Log::INFO,"VM Disk successfully detached."); lcm->trigger(LifeCycleManager::DETACH_SUCCESS, id); } @@ -379,7 +377,7 @@ void VirtualMachineManagerDriver::protocol( if ( result == "SUCCESS" ) { - vm->log("VMM", Log::ERROR, "Host Successfully cleaned."); + vm->log("VMM", Log::INFO, "Host successfully cleaned."); lcm->trigger(LifeCycleManager::CLEANUP_SUCCESS, id); } @@ -395,161 +393,19 @@ void VirtualMachineManagerDriver::protocol( { if (result == "SUCCESS") { - size_t pos; + string monitor_str; + getline(is, monitor_str); - string tmp; - string var; - ostringstream os; - istringstream tiss; - - int cpu = -1; - int memory = -1; - long long net_tx = -1; - long long net_rx = -1; - char state = '-'; - - string monitor_str = is.str(); - bool parse_error = false; - - while(is.good()) - { - is >> tmp >> ws; - - pos = tmp.find('='); - - if ( pos == string::npos ) - { - parse_error = true; - continue; - } - - tmp.replace(pos,1," "); - - tiss.clear(); - - tiss.str(tmp); - - tiss >> var >> ws; - - if (!tiss.good()) - { - parse_error = true; - continue; - } - - if (var == "USEDMEMORY") - { - tiss >> memory; - } - else if (var == "USEDCPU") - { - tiss >> cpu; - } - else if (var == "NETRX") - { - tiss >> net_rx; - } - else if (var == "NETTX") - { - tiss >> net_tx; - } - else if (var == "STATE") - { - tiss >> state; - } - else if (!var.empty()) - { - string val; - - os.str(""); - os << "Adding custom monitoring attribute: " << tmp; - - vm->log("VMM",Log::WARNING,os); - - tiss >> val; - - vm->replace_template_attribute(var,val); - } - } - - if (parse_error) - { - os.str(""); - os << "Error parsing monitoring str:\"" << monitor_str <<"\""; - - vm->log("VMM",Log::ERROR,os); - - vm->set_template_error_message(os.str()); - vmpool->update(vm); - - vm->unlock(); - return; - } - - vm->update_info(memory,cpu,net_tx,net_rx); - vm->set_vm_info(); - - vmpool->update(vm); - vmpool->update_history(vm); - vmpool->update_monitoring(vm); - - if (state != '-' && - (vm->get_lcm_state() == VirtualMachine::RUNNING || - vm->get_lcm_state() == VirtualMachine::UNKNOWN)) - { - Nebula &ne = Nebula::instance(); - LifeCycleManager * lcm = ne.get_lcm(); - - switch (state) - { - case 'a': // Still active, good! - os.str(""); - os << "Monitor Information:\n" - << "\tCPU : "<< cpu << "\n" - << "\tMemory: "<< memory << "\n" - << "\tNet_TX: "<< net_tx << "\n" - << "\tNet_RX: "<< net_rx; - vm->log("VMM",Log::DEBUG,os); - - if ( vm->get_lcm_state() == VirtualMachine::UNKNOWN) - { - vm->log("VMM",Log::INFO,"VM was now found, new state is" - " RUNNING"); - vm->set_state(VirtualMachine::RUNNING); - vmpool->update(vm); - } - break; - - case 'p': // It's paused - vm->log("VMM",Log::INFO,"VM running but new state " - "from monitor is PAUSED."); - - lcm->trigger(LifeCycleManager::MONITOR_SUSPEND, id); - break; - - case 'e': //Failed - vm->log("VMM",Log::INFO,"VM running but new state " - "from monitor is ERROR."); - - lcm->trigger(LifeCycleManager::MONITOR_FAILURE, id); - break; - - case 'd': //The VM was not found - vm->log("VMM",Log::INFO,"VM running but it was not found." - " Restart and delete actions available or try to" - " recover it manually"); - - lcm->trigger(LifeCycleManager::MONITOR_DONE, id); - break; - } - } + process_poll(vm, monitor_str); } else { - log_error(vm,os,is,"Error monitoring VM"); - vmpool->update(vm); + Nebula &ne = Nebula::instance(); + LifeCycleManager* lcm = ne.get_lcm(); - vm->log("VMM",Log::ERROR,os); + log_error(vm, os, is, "Error monitoring VM"); + + lcm->trigger(LifeCycleManager::MONITOR_DONE, vm->get_oid()); } } else if (action == "LOG") @@ -566,6 +422,211 @@ void VirtualMachineManagerDriver::protocol( /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ +void VirtualMachineManagerDriver::process_poll( + int id, + const string &monitor_str) +{ + // Get the VM from the pool + VirtualMachine* vm = Nebula::instance().get_vmpool()->get(id,true); + + if ( vm == 0 ) + { + return; + } + + process_poll(vm, monitor_str); + + vm->unlock(); +} + +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + +void VirtualMachineManagerDriver::process_poll( + VirtualMachine* vm, + const string& monitor_str) +{ + int rc; + + int cpu; + int memory; + long long net_tx; + long long net_rx; + char state; + + map custom; + ostringstream oss; + + Nebula &ne = Nebula::instance(); + + LifeCycleManager* lcm = ne.get_lcm(); + VirtualMachinePool* vmpool = ne.get_vmpool(); + + /* ---------------------------------------------------------------------- */ + /* Parse VM info and update VM */ + /* ---------------------------------------------------------------------- */ + + rc = parse_vm_info(monitor_str, cpu, memory, net_tx, net_rx, state, custom); + + if (rc == -1) + { + vm->set_template_error_message("Error parsing monitoring information."); + + vmpool->update(vm); + + return; + } + + oss << "VM " << vm->get_oid() << " successfully monitored: " << monitor_str; + NebulaLog::log("VMM", Log::INFO, oss); + + vm->update_info(memory, cpu, net_tx, net_rx, custom); + + vmpool->update(vm); + + vmpool->update_history(vm); + + vmpool->update_monitoring(vm); + + /* ---------------------------------------------------------------------- */ + /* Process the VM state from the monitoring info */ + /* ---------------------------------------------------------------------- */ + + if (state == '-' || ( vm->get_lcm_state() != VirtualMachine::RUNNING && + vm->get_lcm_state() != VirtualMachine::UNKNOWN)) + { + return; + } + + switch (state) + { + case 'a': // Still active, good! + if ( vm->get_lcm_state() == VirtualMachine::UNKNOWN) + { + vm->log("VMM", Log::INFO, "VM found again, state is RUNNING"); + + vm->set_state(VirtualMachine::RUNNING); + vmpool->update(vm); + } + break; + + case 'p': // It's paused + vm->log("VMM",Log::INFO, "VM running but monitor state is PAUSED."); + + lcm->trigger(LifeCycleManager::MONITOR_SUSPEND, vm->get_oid()); + break; + + case 'e': //Failed + vm->log("VMM", Log::INFO, "VM running but monitor state is ERROR."); + + lcm->trigger(LifeCycleManager::MONITOR_FAILURE, vm->get_oid()); + break; + + case 'd': //The VM was not found + vm->log("VMM", Log::INFO, "VM running but it was not found." + " Restart and delete actions available or try to" + " recover it manually"); + + lcm->trigger(LifeCycleManager::MONITOR_DONE, vm->get_oid()); + break; + } +} + +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + +int VirtualMachineManagerDriver::parse_vm_info( + const string& monitor_str, + int &cpu, + int &memory, + long long &net_tx, + long long &net_rx, + char &state, + map &custom) +{ + istringstream is; + + int parse_error = 0; + size_t pos; + + string tmp; + string var; + + ostringstream os; + istringstream tiss; + + cpu = -1; + memory = -1; + net_tx = -1; + net_rx = -1; + state = '-'; + + custom.clear(); + + is.str(monitor_str); + + while(is.good()) + { + is >> tmp >> ws; + + pos = tmp.find('='); + + if ( pos == string::npos ) + { + parse_error = -1; + continue; + } + + tmp.replace(pos,1," "); + + tiss.clear(); + + tiss.str(tmp); + + tiss >> var >> ws; + + if (!tiss.good()) + { + parse_error = -1; + continue; + } + + if (var == "USEDMEMORY") + { + tiss >> memory; + } + else if (var == "USEDCPU") + { + tiss >> cpu; + } + else if (var == "NETRX") + { + tiss >> net_rx; + } + else if (var == "NETTX") + { + tiss >> net_tx; + } + else if (var == "STATE") + { + tiss >> state; + } + else if (!var.empty()) + { + string val; + + tiss >> val; + + custom.insert(make_pair(var, val)); + } + } + + return parse_error; +} + +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ + void VirtualMachineManagerDriver::recover() { NebulaLog::log("VMM",Log::INFO,"Recovering VMM drivers"); diff --git a/src/vmm_mad/remotes/poll_ganglia.rb b/src/vmm_mad/remotes/poll_ganglia.rb index c151dfacbc..0bb822fb34 100755 --- a/src/vmm_mad/remotes/poll_ganglia.rb +++ b/src/vmm_mad/remotes/poll_ganglia.rb @@ -49,9 +49,40 @@ GANGLIA_PORT=8649 #GANGLIA_FILE='data.xml' -domain=ARGV[0] -dom_id=ARGV[2] -host=ARGV[1] +def info_string(dom_info) + if dom_info + info=dom_info.map do |key, value| + "#{key.to_s.upcase}=#{value}" + end.join(' ') + else + '' + end +end + +def vm_info(name, dom_info) + number = -1 + + if (name =~ /^one-\d*$/) + number = name.split('-').last + end + + string="VM=[\n" + string<<" ID=\"#{number}\",\n" + string<<" DEPLOY_ID=#{name},\n" + string<<" POLL=\"#{info_string(dom_info)}\" ]" + string +end + + +if ARGV.length==1 + host=ARGV[0] + ALL=true +else + domain=ARGV[0] + dom_id=ARGV[2] + host=ARGV[1] + ALL=false +end # Gets monitoring data from ganglia or file begin @@ -66,24 +97,26 @@ rescue end doms_info=ganglia.get_vms_information -dom_id=domain.split('-').last -# Unknown state when the VM is not found -if !doms_info || !(doms_info[domain] || doms_info[dom_id]) - puts "STATE=d" - exit(0) +if !ALL + dom_id=domain.split('-').last + + # Unknown state when the VM is not found + if !doms_info || !(doms_info[domain] || doms_info[dom_id]) + puts "STATE=d" + exit(0) + end + + # Get key one- or key from the hash + dom_info=doms_info[domain] + dom_info=doms_info[dom_id] if !dom_info + + puts info_string(dom_info) +else + puts "VM_POLL=YES" + + doms_info.each do |name, data| + puts vm_info(name, data) + end end -# Get key one- or key from the hash -dom_info=doms_info[domain] -dom_info=doms_info[dom_id] if !dom_info - -if dom_info - info=dom_info.map do |key, value| - "#{key.to_s.upcase}=#{value}" - end.join(' ') - - puts info -end - - diff --git a/src/vmm_mad/remotes/poll_xen_kvm.rb b/src/vmm_mad/remotes/poll_xen_kvm.rb index 20f5f70c0f..8e5cc312cf 100755 --- a/src/vmm_mad/remotes/poll_xen_kvm.rb +++ b/src/vmm_mad/remotes/poll_xen_kvm.rb @@ -343,6 +343,34 @@ def print_all_vm_info(hypervisor) puts Base64.encode64(compressed).delete("\n") end +def print_all_vm_template(hypervisor) + vms=hypervisor.get_all_vm_info + + puts "VM_POLL=YES" + + vms.each do |name, data| + number = -1 + + if (name =~ /^one-\d*$/) + number = name.split('-').last + end + + string="VM=[\n" + string<<" ID=#{number},\n" + string<<" DEPLOY_ID=#{name},\n" + + values=data.map do |key, value| + print_data(key, value) + end + + monitor=values.zip.join(' ') + + string<<" POLL=\"#{monitor}\" ]" + + puts string + end +end + hypervisor=select_hypervisor if !hypervisor @@ -354,7 +382,9 @@ load_vars(hypervisor) vm_id=ARGV[0] -if vm_id +if vm_id=='-t' + print_all_vm_template(hypervisor) +elsif vm_id print_one_vm_info(hypervisor, vm_id) else print_all_vm_info(hypervisor)