FAQ Search Today's Posts Mark Forums Read
» Video Reviews

» Linux Archive

Linux-archive is a website aiming to archive linux email lists and to make them easily accessible for linux users/developers.


» Sponsor

» Partners

» Sponsor

Go Back   Linux Archive > Debian > Debian User

 
 
LinkBack Thread Tools
 
Old 01-19-2009, 12:07 PM
Hans de Goede
 
Default PATCH: make open-iscsi userspace tools functionality available as a library

Hi All,

Short intro: I'm a long time Linux an and developer. Since Sept 1st I work for
RedHat on the installer team (anaconda the installer for Fedora and RHEL).


We currently make all kind of calls to iscsiadm in the installer and then parse
the output for our iscsi functionality. This is a bit of a kludge and somewhat
error prone.


Therefore we would like to export (some) of the functionality of iscsiadm as a
C-library. I've discussed this a bit with Mike Christie and we arived add doing
a library which hides all open-iscsi's internals (no existing headers used in
the libraries public headers) so that changes to open-iscsi can still be done
easily without breaking the library's API.


I've got documentation of the proposed API here:
http://people.atrpms.net/~hdegoede/html/libiscsi_8h.html

And the attached patch implements this, as you see only very minimal changes to
the existing code are needed, the library code is all in its own dir, and wraps
various files under the usr dir.


The API currently offers pretty minimal functionality (just what we need in
anaconda) I'm fine with extending this (patches welcome). But currently I would
like to focus on the set of functionality as the current API offers and try to
get that right. Most important here is to have a clean, clear and usable API
which is also future proof, as I want to freeze the ABI of the available
functions asap. WRT this I would especially like feedback on the futrue
proofness of the libiscsi_node struct.


Thanks & Regards,

Hans


p.s.

I noticed I haven't added copyright headers to the new Files yet, the new code
is all Copyright (C) 2008 - 2009 Red Hat, Inc. All rights reserved. Author
Hans de Goede, and may be distributed under the GNU GPL version 2 or (at your
option) any later version.


diff -urN open-iscsi-2.0-870.1.orig/libiscsi/Makefile open-iscsi-2.0-870.1/libiscsi/Makefile
--- open-iscsi-2.0-870.1.orig/libiscsi/Makefile 1970-01-01 01:00:00.000000000 +0100
+++ open-iscsi-2.0-870.1/libiscsi/Makefile 2009-01-08 12:31:21.000000000 +0100
@@ -0,0 +1,44 @@
+# This Makefile will work only with GNU make.
+
+OSNAME=$(shell uname -s)
+OPTFLAGS ?= -O2 -g
+WARNFLAGS ?= -Wall -Wstrict-prototypes
+CFLAGS = $(OPTFLAGS) $(WARNFLAGS) -I../include -I../usr -D$(OSNAME) -fPIC -D_GNU_SOURCE
+LIB = libiscsi.so.0
+TESTS = tests/test_discovery tests/test_login tests/test_logout tests/test_params
+
+# sources shared between iscsid, iscsiadm and iscsistart
+ISCSI_LIB_SRCS = util.o io.o auth.o login.o log.o md5.o sha1.o iface.o idbm.o sysdeps.o sysfs.o iscsi_sysfs.o
+# sources shared with the userspace utils, note we build these separately
+# to get PIC versions.
+USR_OBJS = $(patsubst %.o, usr-objs/%.o, $(ISCSI_LIB_SRCS) strings.o
+discovery.o)
+
+# Flags for the tests
+tests/% : CFLAGS = $(OPTFLAGS) $(WARNFLAGS) -I.
+
+all: lib tests html
+
+lib: $(LIB)
+tests: $(TESTS)
+
+usr-objs/%.o: ../usr/%.c
+ mkdir -p usr-objs
+ $(CC) $(CFLAGS) -c $< -o $@
+
+$(LIB): $(USR_OBJS) libiscsi.o
+ $(CC) $(CFLAGS) -shared -Wl,-soname,$(LIB) $^ -o $@
+ ln -s -f $(LIB) libiscsi.so
+
+$(TESTS): $(USR_OBJS) $(LIB)
+
+html: libiscsi.h libiscsi.doxy
+ doxygen libiscsi.doxy
+
+clean:
+ rm -rf *.o usr-objs libiscsi.so* .depend *~ html $(TESTS) tests/*~
+
+depend:
+ gcc $(CFLAGS) -M `ls *.c` > .depend
+
+-include .depend ../usr/.depend
diff -urN open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.c open-iscsi-2.0-870.1/libiscsi/libiscsi.c
--- open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.c 1970-01-01 01:00:00.000000000 +0100
+++ open-iscsi-2.0-870.1/libiscsi/libiscsi.c 2009-01-19 12:28:08.000000000 +0100
@@ -0,0 +1,354 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <unistd.h>
+#include "libiscsi.h"
+#include "idbm.h"
+#include "iscsiadm.h"
+#include "log.h"
+#include "sysfs.h"
+#include "iscsi_sysfs.h"
+#include "util.h"
+#include "sysdeps.h"
+#include "iface.h"
+
+#define CHECK(a) { rc = a; if (rc) goto leave; }
+
+struct libiscsi_context {
+ char libiscsi_error_string[256];
+};
+
+struct libiscsi_context *libiscsi_init(void)
+{
+ struct libiscsi_context *context;
+
+ context = calloc(sizeof *context, 1);
+ if (!context)
+ return NULL;
+
+ /* enable stdout logging */
+ log_daemon = 0;
+ log_init("libiscsi", 1024);
+ sysfs_init();
+ increase_max_files();
+ if (idbm_init(NULL)) {
+ free(context);
+ return NULL;
+ }
+
+ iface_setup_host_bindings();
+
+ return context;
+}
+
+void libiscsi_cleanup(struct libiscsi_context *context)
+{
+ idbm_terminate();
+ free_transports();
+ sysfs_cleanup();
+ free(context);
+}
+
+static void free_rec_list(struct list_head *rec_list)
+{
+ struct node_rec *rec, *tmp;
+
+ list_for_each_entry_safe(rec, tmp, rec_list, list) {
+ list_del(&rec->list);
+ free(rec);
+ }
+}
+
+int libiscsi_discover_sendtargets(struct libiscsi_context *context,
+ const char *address, int port, const struct libiscsi_auth_info *auth_info,
+ struct libiscsi_node **found_nodes)
+{
+ struct discovery_rec drec;
+ LIST_HEAD(new_rec_list);
+ LIST_HEAD(bound_rec_list);
+ struct node_rec *rec;
+ int rc, found = 0;
+
+ INIT_LIST_HEAD(&new_rec_list);
+ INIT_LIST_HEAD(&bound_rec_list);
+
+ if (found_nodes)
+ *found_nodes = NULL;
+
+ /* Fill the drec struct with all needed info */
+ memset(&drec, 0, sizeof drec);
+ idbm_sendtargets_defaults(&drec.u.sendtargets);
+ drec.type = DISCOVERY_TYPE_SENDTARGETS;
+ strlcpy(drec.address, address, sizeof(drec.address));
+ drec.port = port;
+ switch(auth_info ? auth_info->method : libiscsi_auth_none) {
+ case libiscsi_auth_none:
+ break;
+ case libiscsi_auth_chap:
+ if (!auth_info->chap.username[0])
+ return -EINVAL;
+ if (!auth_info->chap.password[0])
+ return -EINVAL;
+ if (auth_info->chap.reverse_username[0] &&
+ !auth_info->chap.reverse_password[0])
+ return -EINVAL;
+
+ drec.u.sendtargets.auth.authmethod = AUTH_METHOD_CHAP;
+ strlcpy(drec.u.sendtargets.auth.username,
+ auth_info->chap.username, AUTH_STR_MAX_LEN);
+ strlcpy((char *)drec.u.sendtargets.auth.password,
+ auth_info->chap.password, AUTH_STR_MAX_LEN);
+ drec.u.sendtargets.auth.password_length =
+ strlen((char *)drec.u.sendtargets.auth.password);
+ strlcpy(drec.u.sendtargets.auth.username_in,
+ auth_info->chap.reverse_username, AUTH_STR_MAX_LEN);
+ strlcpy((char *)drec.u.sendtargets.auth.password_in,
+ auth_info->chap.reverse_password, AUTH_STR_MAX_LEN);
+ drec.u.sendtargets.auth.password_in_length =
+ strlen((char *)drec.u.sendtargets.auth.password_in);
+ break;
+ default:
+ return -EINVAL;
+ }
+
+ CHECK(discovery_sendtargets(&drec, &new_rec_list))
+ CHECK(idbm_add_discovery(&drec, 1))
+
+ /* bind ifaces to node recs so we know what we have */
+ list_for_each_entry(rec, &new_rec_list, list)
+ CHECK(idbm_bind_ifaces_to_node(rec, NULL, &bound_rec_list))
+
+ /* now add/update records */
+ list_for_each_entry(rec, &bound_rec_list, list) {
+ CHECK(idbm_add_node(rec, &drec, 1))
+ found++;
+ }
+
+ if (found_nodes && found) {
+ *found_nodes = calloc(found, sizeof **found_nodes);
+ if (*found_nodes == NULL) {
+ rc = -ENOMEM;
+ goto leave;
+ }
+ found = 0;
+ list_for_each_entry(rec, &bound_rec_list, list) {
+ strlcpy((*found_nodes)[found].name, rec->name,
+ LIBISCSI_VALUE_MAXLEN);
+ (*found_nodes)[found].tpgt = rec->tpgt;
+ strlcpy((*found_nodes)[found].address,
+ rec->conn[0].address, NI_MAXHOST);
+ (*found_nodes)[found].port = rec->conn[0].port;
+ found++;
+ }
+ }
+
+ rc = -found;
+leave:
+ free_rec_list(&bound_rec_list);
+ free_rec_list(&new_rec_list);
+
+ return -rc;
+}
+
+int libiscsi_discover_isns(struct libiscsi_context *context,
+ struct libiscsi_node **found_nodes)
+{
+ return -EINVAL;
+}
+
+int libiscsi_discover_firmware(struct libiscsi_context *context,
+ struct libiscsi_node **found_nodes)
+{
+ return -EINVAL; /* FIXME */
+}
+
+int libiscsi_node_set_auth(struct libiscsi_context *context,
+ const struct libiscsi_node *node,
+ const struct libiscsi_auth_info *auth_info)
+{
+ int rc = 0;
+
+ switch(auth_info ? auth_info->method : libiscsi_auth_none) {
+ case libiscsi_auth_none:
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.authmethod", "None"))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.username", ""))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.password", ""))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.username_in", ""))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.password_in", ""))
+ break;
+
+ case libiscsi_auth_chap:
+ if (!auth_info->chap.username[0])
+ return -EINVAL;
+ if (!auth_info->chap.password[0])
+ return -EINVAL;
+ if (auth_info->chap.reverse_username[0] &&
+ !auth_info->chap.reverse_password[0])
+ return -EINVAL;
+
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.authmethod", "CHAP"))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.username",
+ auth_info->chap.username))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.password",
+ auth_info->chap.password))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.username_in",
+ auth_info->chap.reverse_username))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.password_in",
+ auth_info->chap.reverse_password))
+ break;
+
+ default:
+ return -EINVAL;
+ }
+leave:
+ return rc;
+}
+
+static void node_to_rec(const struct libiscsi_node *node,
+ struct node_rec *rec)
+{
+ memset(rec, 0, sizeof *rec);
+ idbm_node_setup_defaults(rec);
+ strlcpy(rec->name, node->name, TARGET_NAME_MAXLEN);
+ rec->tpgt = node->tpgt;
+ strncpy(rec->conn[0].address, node->address, NI_MAXHOST);
+ rec->conn[0].port = node->port;
+}
+
+int login_helper(void *data, node_rec_t *rec)
+{
+ int rc = iscsid_req_by_rec(MGMT_IPC_SESSION_LOGIN, rec);
+ if (rc) {
+ iscsid_handle_error(rc);
+ rc = ENOTCONN;
+ }
+ return rc;
+}
+
+int libiscsi_node_login(struct libiscsi_context *context,
+ const struct libiscsi_node *node)
+{
+ int nr_found = 0, rc;
+
+ CHECK(idbm_for_each_iface(&nr_found, NULL, login_helper,
+ (char *)node->name, node->tpgt,
+ (char *)node->address, node->port))
+ if (nr_found == 0)
+ rc = ENODEV;
+leave:
+ return rc;
+}
+
+static int logout_helper(void *data, struct session_info *info)
+{
+ int rc;
+ struct node_rec *rec = data;
+
+ if (!iscsi_match_session(rec, info))
+ return -1; /* Not a match */
+
+ rc = iscsid_req_by_sid(MGMT_IPC_SESSION_LOGOUT, info->sid);
+ if (rc) {
+ iscsid_handle_error(rc);
+ rc = EIO;
+ }
+
+ return rc;
+}
+
+int libiscsi_node_logout(struct libiscsi_context *context,
+ const struct libiscsi_node *node)
+{
+ int nr_found = 0, rc;
+ struct node_rec rec;
+
+ node_to_rec(node, &rec);
+ CHECK(iscsi_sysfs_for_each_session(&rec, &nr_found, logout_helper))
+ if (nr_found == 0)
+ rc = ENODEV;
+leave:
+ return rc;
+}
+
+int libiscsi_node_set_parameter(struct libiscsi_context *context,
+ const struct libiscsi_node *node,
+ const char *parameter, const char *value)
+{
+ int nr_found = 0, rc;
+ struct db_set_param set_param = {
+ .name = (char *)parameter,
+ .value = (char *)value,
+ };
+
+ CHECK(idbm_for_each_iface(&nr_found, &set_param, idbm_node_set_param,
+ (char *)node->name, node->tpgt,
+ (char *)node->address, node->port))
+ if (nr_found == 0)
+ rc = ENODEV;
+leave:
+ return rc;
+}
+
+static int get_parameter_helper(void *data, node_rec_t *rec)
+{
+ struct db_set_param *param = data;
+ recinfo_t *info;
+ int i;
+
+ info = idbm_recinfo_alloc(MAX_KEYS);
+ if (!info)
+ return ENOMEM;
+
+ idbm_recinfo_node(rec, info);
+
+ for (i = 0; i < MAX_KEYS; i++) {
+ if (!info[i].visible)
+ continue;
+
+ if (strcmp(param->name, info[i].name))
+ continue;
+
+ strlcpy(param->value, info[i].value, LIBISCSI_VALUE_MAXLEN);
+ return 0;
+ }
+
+ return EINVAL; /* No such parameter */
+}
+
+int libiscsi_node_get_parameter(struct libiscsi_context *context,
+ const struct libiscsi_node *node, const char *parameter, char *value)
+{
+ int nr_found = 0, rc = 0;
+ struct db_set_param set_param = {
+ .name = (char *)parameter,
+ .value = value,
+ };
+
+ /* Note we assume there is only one interface, if not we will get
+ the value from the last interface iterated over!
+ This (multiple interfaces) can only happen if someone explicitly
+ created ones using iscsiadm. Even then this should not be a problem
+ as most settings should be the same independent of the iface. */
+ CHECK(idbm_for_each_iface(&nr_found, &set_param, get_parameter_helper,
+ (char *)node->name, node->tpgt,
+ (char *)node->address, node->port))
+ if (nr_found == 0)
+ rc = ENODEV;
+leave:
+ return rc;
+}
+
+const char *libiscsi_get_error_string(struct libiscsi_context *context)
+{
+}
diff -urN open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.doxy open-iscsi-2.0-870.1/libiscsi/libiscsi.doxy
--- open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.doxy 1970-01-01 01:00:00.000000000 +0100
+++ open-iscsi-2.0-870.1/libiscsi/libiscsi.doxy 2009-01-08 12:19:19.000000000 +0100
@@ -0,0 +1,1473 @@
+# Doxyfile 1.5.7.1
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = libiscsi
+
+# 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 =
+
+# 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 =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
+# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
+# Spanish, Swedish, and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = NO
+
+# 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 =
+
+# 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 = 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
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit rief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=par Side Effects:
" 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
's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = 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
+
+# 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
osubgrouping command.
+
+SUBGROUPING = YES
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = 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
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = 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
+# and Mac users are advised to set this option to NO.
+
+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
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting odo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting est
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting ug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by if sectionname ... endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using showinitializer or hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
+# doxygen. The layout file controls the global structure of the generated output files
+# in an output format independent way. The create the layout file that represents
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name
+# of the layout file.
+
+LAYOUT_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = YES
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT =
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS =
+
+# 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
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the include or dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the image command).
+
+IMAGE_PATH =
+
+# 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 <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# 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 = NO
+
+# 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.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = 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
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
+# are set, an additional index file will be generated that can be used as input for
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
+# HTML documentation.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file .
+
+QHG_LOCATION =
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature. Other possible values
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
+
+GENERATE_TREEVIEW = NONE
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = 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
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the atchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = 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
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag i
 
Old 01-19-2009, 12:34 PM
Hans de Goede
 
Default PATCH: make open-iscsi userspace tools functionality available as a library

Bart Van Assche wrote:

On Mon, Jan 19, 2009 at 2:07 PM, Hans de Goede <hdegoede@redhat.com> wrote:

Therefore we would like to export (some) of the functionality of iscsiadm as a
C-library.


Great !


I've got documentation of the proposed API here:
http://people.atrpms.net/~hdegoede/html/libiscsi_8h.html


Not so great:

libiscsi_get_error_string()
This function can be called to get a human readable error string when
a libiscsi function has returned an error. This function uses a static
buffer thus the result is only valid as long as no other libiscsi
calls are made after the failing function call.



That should read: "This function uses a single buffer per context, thus the
result is only valid as long as no other libiscsi calls are made on the same
context after the failing function call."


Actually this reminds me this function currently isn't even implemented. I'm
planning on changing usr/log.c to make this possible. The idea is that dolog
becomes a function pointer which can be pointer to either a function

doing the current log_daemon behavior, or to one doing the current print to
stderr behavior. Then the log_daemon variable can be removed, and libiscsi can
supply its own logging function which can store the last error message.

But before making these changes I first wanted to discuss this on this list, so
are there any objections against this change?



This makes it impossible to use libiscsi_get_error_string() in a safe
way in multithreaded software.


Well, as long as you use one context per thread, it should be safe, atleast API
wise, unfortunately the used existing open-iscsi code is full of global
variables. So thread safety will come as a future enhancement. Actually the
only reason for the whole "context" paradigm in the current API is to allow a
move over to thread safety in the future without breaking ABI.



Furthermore, there are some minor spelling issues, e.g. "cleanups".
Shouldn't this be "cleans up" ?


patches welcome

Regards,

Hans

_______________________________________________
Anaconda-devel-list mailing list
Anaconda-devel-list@redhat.com
https://www.redhat.com/mailman/listinfo/anaconda-devel-list
 
Old 01-19-2009, 02:35 PM
Hans de Goede
 
Default PATCH: make open-iscsi userspace tools functionality available as a library

Boaz Harrosh wrote:

Hans de Goede wrote:

Hi All,

The API currently offers pretty minimal functionality (just what we need in
anaconda) I'm fine with extending this (patches welcome). But currently I would
like to focus on the set of functionality as the current API offers and try to
get that right. Most important here is to have a clean, clear and usable API
which is also future proof, as I want to freeze the ABI of the available
functions asap. WRT this I would especially like feedback on the futrue
proofness of the libiscsi_node struct.




First of all Thank you very much for doing this. I'm sure it will prove
very useful in the future, the issue has been raised in the passed, multiple
times.

I can see that you have not attempted to refactor iscsiadm so to use the library.
Which means you will be shipping the same exact code twice.


If you look at the code you will see that there actually is not all that much
duplication.



Is your long term
plan to do that once libiscsi is mature enough, or you would rather keep these
two separate and duplicated?



To keep them separate, see above.



Regarding the API:
- The overall state and division of labor looks very nice. :-)

- libiscsi_discover_sendtargets - maybe (very maybe) the "int port" could be dropped and
"const char *address" could be of the form "address_or_host[ort]".
Regarding defaults and all that.



Nah, that is ok for a cmdline interface, but cumbersome for an API, we could do
something where port == 0 would choose the default port though.



- libiscsi_discover_isns - Looks like it is missing the actual input parameters usually
a "char *iqn" I think?



I've checked the (AFAIK currently incomplete) iscsiadm code and that does not
have any parameters. Given that this is pretty much a pie in the sky, we could
just remove this function completely for now.



- libiscsi_discover_firmware - What is that for? Also missing an input parameter.



This reads iscsi target info (portal and authentication info) from the BIOS of
machines who support booting from iscsi, there is no input parameter, as
machines tend to have only one BIOS (to query).



- I can't help noticing the missing of query functions, Both query of DB of discovered
Nodes, as well as info of logged-in nodes.


Ack, those are not needed by anaconda, but should probably be added to make
this more generally usefull, patches welcome



- libiscsi_node_set_parameter - Question: (Sorry have not read the code) Is that persistent,
gets saved in DB. Or is just for current session/login?



Actually it only changes the database, so it will not influence parameters of
the current session. I guess this needs better documentation making this clear.


Regards,

Hans

_______________________________________________
Anaconda-devel-list mailing list
Anaconda-devel-list@redhat.com
https://www.redhat.com/mailman/listinfo/anaconda-devel-list
 
Old 01-20-2009, 08:03 AM
Hans de Goede
 
Default PATCH: make open-iscsi userspace tools functionality available as a library

Bart Van Assche wrote:

On Mon, Jan 19, 2009 at 4:35 PM, Hans de Goede <hdegoede@redhat.com> wrote:

- libiscsi_discover_sendtargets - maybe (very maybe) the "int port" could be dropped and
"const char *address" could be of the form "address_or_host[ort]".
Regarding defaults and all that.


Nah, that is ok for a cmdline interface, but cumbersome for an API, we could do
something where port == 0 would choose the default port though.


Have you considered to replace both "const char *address" and "int
port" by "const struct sockaddr *address, socklen_t address_len" ?
This would avoid having to figure out inside
libiscsi_discover_sendtargets() whether the passed address is in IPv4
or in IPv6 format (if numeric).


libiscsi builds on top of the existing open-iscsi userspace code, in this code
the "const char *address" and "int port" notation is used everywhere.


Regards,

Hans

_______________________________________________
Anaconda-devel-list mailing list
Anaconda-devel-list@redhat.com
https://www.redhat.com/mailman/listinfo/anaconda-devel-list
 
Old 01-20-2009, 05:23 PM
Hans de Goede
 
Default PATCH: make open-iscsi userspace tools functionality available as a library

Konrad Rzeszutek wrote:

On Mon, Jan 19, 2009 at 02:07:23PM +0100, Hans de Goede wrote:

Hi All,

Short intro: I'm a long time Linux an and developer. Since Sept 1st I work for
RedHat on the installer team (anaconda the installer for Fedora and RHEL).


We currently make all kind of calls to iscsiadm in the installer and then parse
the output for our iscsi functionality. This is a bit of a kludge and somewhat
error prone.


Therefore we would like to export (some) of the functionality of iscsiadm as a
C-library. I've discussed this a bit with Mike Christie and we arived add doing
a library which hides all open-iscsi's internals (no existing headers used in
the libraries public headers) so that changes to open-iscsi can still be done
easily without breaking the library's API.


I've got documentation of the proposed API here:
http://people.atrpms.net/~hdegoede/html/libiscsi_8h.html

And the attached patch implements this, as you see only very minimal changes to
the existing code are needed, the library code is all in its own dir, and wraps

various files under the usr dir.

The API currently offers pretty minimal functionality (just what we need in
anaconda) I'm fine with extending this (patches welcome). But currently I would
like to focus on the set of functionality as the current API offers and try to
get that right. Most important here is to have a clean, clear and usable API
which is also future proof, as I want to freeze the ABI of the available


I would recommend that you provide as the first variable in all of the structs
an unsigned int called 'version'. This way if the structs are extended they
would be backwards compatible and there is an easy way to identify which
version of structs they are.



Erm, given the amount of programs which will probably end up using this (not
all that much) a distro should be able to easily rebuild all those in case of
an ABI change and thus a soname bump. I understand what you are trying to say
here, but IMHO the added complexity and ugliness is not worth it.


Regards,

Hans

_______________________________________________
Anaconda-devel-list mailing list
Anaconda-devel-list@redhat.com
https://www.redhat.com/mailman/listinfo/anaconda-devel-list
 
Old 01-20-2009, 05:58 PM
Hans de Goede
 
Default PATCH: make open-iscsi userspace tools functionality available as a library

Hi,

Konrad Rzeszutek wrote:

Thanks for the review!

> I presume you have run this program (and the test-code) through
> valgrind with no memory leaks?
>

Erm, no, has iscsiadm been run through valgrind? If not I'm not going to be
running libiscsi through it either (sorry) libiscsi builds on top of many
open-iscsi userspace code internals, and those are not always pretty (many
global variables for example).


> Please see my comments below.
>
> > diff -urN open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.c
> open-iscsi-2.0-870.1/libiscsi/libiscsi.c
> > --- open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.c 1970-01-01
> 01:00:00.000000000 +0100
> > +++ open-iscsi-2.0-870.1/libiscsi/libiscsi.c 2009-01-19
> 12:28:08.000000000 +0100
> > @@ -0,0 +1,354 @@
> > +#include <stdio.h>
> > +#include <stdlib.h>
> > +#include <string.h>
> > +#include <errno.h>
> > +#include <unistd.h>
> > +#include "libiscsi.h"
>
>
> > +#include "idbm.h"
> > +#include "iscsiadm.h"
> > +#include "log.h"
> > +#include "sysfs.h"
> > +#include "iscsi_sysfs.h"
> > +#include "util.h"
> > +#include "sysdeps.h"
> > +#include "iface.h"
>
> Do these guys need to be in quotes? In the Makefile you did specify the
> header
> directory so I would think that would work.
>

Using <> might work too, but this way it is clear this are open-iscsi headers,
and not system headers.


> > +
> > +#define CHECK(a) { rc = a; if (rc) goto leave; }
> > +
> > +struct libiscsi_context {
> > + char libiscsi_error_string[256];
>
> Use a #define for the size.
>

Why? Once we will actually start using this, it will be filled with snprintf,
with a sizeof as second parameter, so I see no reason to use a define.



> > +};
> > +
> > +struct libiscsi_context *libiscsi_init(void)
> > +{
> > + struct libiscsi_context *context;
> > +
> > + context = calloc(sizeof *context, 1);
>
> Swap the arguments around. First argument is the number of elements,
> while the second
> is the size of the element.
>

You are right, will fix.

> > + if (!context)
> > + return NULL;
> > +
> > + /* enable stdout logging */
> > + log_daemon = 0;
> > + log_init("libiscsi", 1024);
> > + sysfs_init();
> > + increase_max_files();
> > + if (idbm_init(NULL)) {
> > + free(context);
>
> No sysfs_cleanup() call? Or log_close()?
>

log_close() does not exist (weird open-iscsi internals), but yes it needs a
sysfs_cleanup() call.



> > + return NULL;
> > + }
> > +
> > + iface_setup_host_bindings();
> > +
> > + return context;
> > +}
> > +
>
> ... snip..
> > +int libiscsi_discover_sendtargets(struct libiscsi_context *context,
> > + const char *address, int port, const struct libiscsi_auth_info
> *auth_info,
> > + struct libiscsi_node **found_nodes)
> .. snip ..
> > + if (!auth_info->chap.username[0])
>
> Would it make sense to add logging here as well? Like
> 'log_warning("Non-existent CHAP username!")' or such?
>

Yes, that is the plan when I actually get error logging implemented, see the
comments about this in my initial mail (I'm waiting on feedback on some
proposed changes to the open-iscsi internal logging API).


> > + return -EINVAL;
> > + if (!auth_info->chap.password[0])
> > + return -EINVAL;
>
> Is against the CHAP to have an empty password? Ah n/m. The
> http://www.ietf.org/rfc/rfc1994.txt says: "The CHAP algorithm requires
> that the length of the secret MUST be at least 1 octet." Maybe
> put a check for that?
>
> BTW, I am not sure if the PPP CHAP RFC == iSCSI CHAP, so I
> might be spewing non-sense here.
>
>
> > + if (auth_info->chap.reverse_username[0] &&
> > + !auth_info->chap.reverse_password[0])
> > + return -EINVAL;
> > +
> > + drec.u.sendtargets.auth.authmethod = AUTH_METHOD_CHAP;
> > + strlcpy(drec.u.sendtargets.auth.username,
> > + auth_info->chap.username, AUTH_STR_MAX_LEN);
> > + strlcpy((char *)drec.u.sendtargets.auth.password,
> > + auth_info->chap.password, AUTH_STR_MAX_LEN);
> > + drec.u.sendtargets.auth.password_length =
> > + strlen((char *)drec.u.sendtargets.auth.password);
>
> This doesn't guard against passwords that are of AUTH_STR_MAX_LEN
> length.

It does, first the passed in string gets strlcpy-ed to
drec.u.sendtargets.auth.password, strlcpy will copy at max AUTH_STR_MAX_LEN - 1
bytes and will always 0 terminate the dest.


Then the lenght of drec.u.sendtargets.auth.password gets used, not the length
of what was passed in but the length of the (limited length) copy.


<snip>

> > + break;
> > + default:
> > + return -EINVAL;
> > + }
> > +
> > + CHECK(discovery_sendtargets(&drec, &new_rec_list))
> > + CHECK(idbm_add_discovery(&drec, 1))
>
> Make the 1 a #define? Without me looking at the code I had
> no idea that 1 stands for 'over-write'. Thought at first it
> was the count of records - which looked weird.
>

Internal open-iscsi API, when it becomes a define there I'll happily use it.

> > +
> > + /* bind ifaces to node recs so we know what we have */
> > + list_for_each_entry(rec, &new_rec_list, list)
> > + CHECK(idbm_bind_ifaces_to_node(rec, NULL, &bound_rec_list))
> > +
> > + /* now add/update records */
> > + list_for_each_entry(rec, &bound_rec_list, list) {
> > + CHECK(idbm_add_node(rec, &drec, 1))
>
> Ditto.
>

Ditto.

> > + found++;
> > + }
> > +
> > + if (found_nodes && found) {
> > + *found_nodes = calloc(found, sizeof **found_nodes);
>
> Please swap the arguments.
>

Erm, no, this time I got it right the first time.

>
> .. snip ..
> > +int libiscsi_node_set_auth(struct libiscsi_context *context,
> > + const struct libiscsi_node *node,
> > + const struct libiscsi_auth_info *auth_info)
> > +{
> > + int rc = 0;
> > +
> > + switch(auth_info ? auth_info->method : libiscsi_auth_none) {
> > + case libiscsi_auth_none:
> > + CHECK(libiscsi_node_set_parameter(context, node,
> > + "node.session.auth.authmethod", "None"))
> > + CHECK(libiscsi_node_set_parameter(context, node,
> > + "node.session.auth.username", ""))
> > + CHECK(libiscsi_node_set_parameter(context, node,
> > + "node.session.auth.password", ""))
> > + CHECK(libiscsi_node_set_parameter(context, node,
> > + "node.session.auth.username_in", ""))
> > + CHECK(libiscsi_node_set_parameter(context, node,
> > + "node.session.auth.password_in", ""))
>
> Would it make sense to print a warning why this failed (if it fails
> obviously?)
> As a developer of this I would not have an idea from the header file why
> it failed
> and would have to start instrumenting this code to figure what is wrong.
>

Notice the CHECK macro, if it fails it will stop at the first failing call, and
return an error code (and once implemented save an error string which can be
retrieved later).


> > + break;
> > +
> > + case libiscsi_auth_chap:
> > + if (!auth_info->chap.username[0])
> > + return -EINVAL;
> > + if (!auth_info->chap.password[0])
>
> Perhaps the same idea. Put in a log_warning? Or maybe log_debug..
>

Ack.


> > + return -EINVAL;
> > + if (auth_info->chap.reverse_username[0] &&
> > + !auth_info->chap.reverse_password[0])
> > + return -EINVAL;
> > +
>
> .. snip ..
> > +static void node_to_rec(const struct libiscsi_node *node,
> > + struct node_rec *rec)
> > +{
> > + memset(rec, 0, sizeof *rec);
> > + idbm_node_setup_defaults(rec);
> > + strlcpy(rec->name, node->name, TARGET_NAME_MAXLEN);
> > + rec->tpgt = node->tpgt;
> > + strncpy(rec->conn[0].address, node->address, NI_MAXHOST);
>
> You been using 'strlcpy' all the time, but here you use 'strncpy'. Why?
>

My bad, thanks for catching this, that should be a strlcpy (strncpy sucks
majorly!).


> > + rec->conn[0].port = node->port;
> > +}
> > +
> > +int login_helper(void *data, node_rec_t *rec)
> > +{
> > + int rc = iscsid_req_by_rec(MGMT_IPC_SESSION_LOGIN, rec);
> > + if (rc) {
> > + iscsid_handle_error(rc);
> > + rc = ENOTCONN;
>
> Should that have a - in front of it? Hmm.. I thought Mike wanted
> all of the return codes to be a positive number. Which means all
> the other functions you have should _NOT_ have the '-'?
>
> Looking at the 'idbm_*' all of its return codes are positive. Perhaps
> a global search and replace for the -E to E?
>

The only functions returning negative codes are the discovery functions, as
they return the number of nodes found on success. If people dislike this I can
return the number of found nodes through a pointer instead.


> > + }
> > + return rc;
> > +}
> > +
> > +int libiscsi_node_login(struct libiscsi_context *context,
> > + const struct libiscsi_node *node)
> > +{
> > + int nr_found = 0, rc;
> > +
> > + CHECK(idbm_for_each_iface(&nr_found, NULL, login_helper,
> > + (char *)node->name, node->tpgt,
> > + (char *)node->address, node->port))
> > + if (nr_found == 0)
> > + rc = ENODEV;
> > +leave:
> > + return rc;
> > +}
> > +
> > +static int logout_helper(void *data, struct session_info *info)
> > +{
> > + int rc;
> > + struct node_rec *rec = data;
> > +
> > + if (!iscsi_match_session(rec, info))
> > + return -1; /* Not a match */
>
> Oh boy. Can you put a comment of why you are mixing standard error
> codes with negative numbers? At first I thought this was an error
> until I looked in 'iscsi_sysfs_for_each_session' and found:
> "if less than zero it means it was not a match"
>
> Can you just say that 'iscsi_sysfs_for_each_session' requires this
> type of return code for not a match please?
>

You mean make the comment more verbose, sure if that makes you happy This
are those infamous open-iscsi internals again, which I'm trying really hard to
hide from the outside (iow when only looking at libiscsi.h) once you start
looking at libiscsi.c, well ...



> .. snip ..
>
> > +static int get_parameter_helper(void *data, node_rec_t *rec)
> > +{
> > + struct db_set_param *param = data;
> > + recinfo_t *info;
> > + int i;
> > +
> > + info = idbm_recinfo_alloc(MAX_KEYS);
> > + if (!info)
> > + return ENOMEM;
> > +
> > + idbm_recinfo_node(rec, info);
> > +
> > + for (i = 0; i < MAX_KEYS; i++) {
> > + if (!info[i].visible)
> > + continue;
> > +
> > + if (strcmp(param->name, info[i].name))
>
> How about 'strncmp' ?
>

Why?

> > + continue;
> > +
> > + strlcpy(param->value, info[i].value, LIBISCSI_VALUE_MAXLEN);
> > + return 0;
> > + }
> > +
> > + return EINVAL; /* No such parameter */
> > +}
> > +
>
> .. snip ..
>
> > diff -urN open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.h
> open-iscsi-2.0-870.1/libiscsi/libiscsi.h
> > --- open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.h 1970-01-01
> 01:00:00.000000000 +0100
> > +++ open-iscsi-2.0-870.1/libiscsi/libiscsi.h 2009-01-19
> 12:19:04.000000000 +0100
> > @@ -0,0 +1,236 @@
> > +#include <netdb.h>
> > +
> > +/** rief Maximum length for iSCSI values.
> > + *
> > + * Maximum length for iSCSI values such as hostnames and parameter
> values.
> > + */
> > +#define LIBISCSI_VALUE_MAXLEN 256
> > +
> > +/** rief supported authentication methods
> > + *
> > + * This enum lists all supported authentication methods.
> > + */
> > +enum libiscsi_auth_t {
> > + libiscsi_auth_none /** No authentication */,
> > + libiscsi_auth_chap /** CHAP authentication */,
> > +};
> > +
> > +/** rief libiscsi context struct
> > + *
> > + * Note: even though libiscsi uses a context struct, the underlying
> open-iscsi
> > + * code does not, so libiscsi is not thread safe, not even when
> using one
> > + * context per thread!
> > + */
> > +struct libiscsi_context;
> > +
> > +/** rief iSCSI node record
> > + *
> > + * Struct holding data uniquely identifying an iSCSI node.
> > + */
> > +struct libiscsi_node {
>
> Add 'unsigned int version' in case this structs grows in the future.
> The
> version for right could be '100'.
>
> > + char name[LIBISCSI_VALUE_MAXLEN] /** iSCSI iqn for the node.
> */;
> > + int tpgt /** Portal group number. */;
>
> Not unsigned int? The RFC says " - Target Portal Group Tag: A numerical
> identifier (16-bit) for an
> iSCSI Target Portal Group."
>

open-iscsi-2.0-870.1/usr/config.h: 211:
int tpgt;

This is from the already existing code.

>
> > + /* Note open-iscsi has some code in place for multiple
> connections in one
> > + node record and thus multiple address / port combi's, but
> this does not
> > + get used anywhere, so we keep things simple and assume one
> connection */
> > + char address[NI_MAXHOST] /** Portal hostname or
> IP-address. */;
> > + int port /** Portal port number. */;
>
> The same. unsigned int?
>

open-iscsi-2.0-870.1/usr/config.h: 225:
int port;

<snip>

> > +/** rief Discover iSCSI nodes using sendtargets and add them to
> the node db.
> > + *
> > + * This function connects to the given address and port and then
> tries to
> > + * discover iSCSI nodes using the sendtargets protocol. Any found
> nodes are
> > + * added to the local iSCSI node database and are returned in a
> dynamically
> > + * allocated array.
> > + *
> > + * Note that the (optional) authentication info is for
> authenticating the
> > + * discovery, and is not for the found nodes! If the connection(s)
> to the
> > + * node(s) need authentication too, you can set the username /
> password for
> > + * those (which can be different!) using the
> libiscsi_node_set_auth() function.
> > + *
> > + * param context libiscsi context to operate on.
> > + * param address Hostname or IP-address to connect to.
> > + * param port Port to connect to.
> > + * param auth_info Authentication information, or NULL.
> > + * param found_nodes The address of the dynamically
> allocated array
> > + * of found nodes will be returned
> through this
> > + * pointer if not NULL. The caller
> must free this
> > + * array using free().
> > + *
eturn The number of found nodes or, in
> case of error,
> > + * a negative standard error code
> (from errno.h).
>
> Values in errno are positive. Look in /usr/include/asm-generic/errno-base.h
>

When stored in errno, yes but for example when passed along inside the kernel
they are negative.


> Maybe have an addtional argument for the number of found nodes and use the
> return value just for error codes?

We could do that, but I'm not entirely happy with doing things that way, iow I
like the current method better. Still if there are more people in favor of
making this change I won't block it.


> Also that would mean using the proper
> declaration for the number of nodes. Imagine finding 32,768 nodes, and
> trying
> to demonstrate that as a 'int'. You would end up with -1, which in your
> case means -EPERM!
>
> (Yeah I know, who in their right mind would want to have have 32768
> nodes ..!?)
>

Actually an int is atleast 32 bit on any relevant system, so that would be 2
billion nodes and then some more.


<snip>

> > + */
> > +int libiscsi_discover_firmware(struct libiscsi_context *context,
> > + struct libiscsi_node **found_nodes);
>
>
> .. snip ..
> > +/** rief Get human readable string describing the last libiscsi
> error.
> > + *
> > + * This function can be called to get a human readable error string
> when a
> > + * libiscsi function has returned an error. This function uses a
> static buffer
> > + * thus the result is only valid as long as no other libiscsi calls
> are made
> > + * after the failing function call.
> > + *
> > + * param context libiscsi context to operate on.
> > + *
> > + *
eturn human readable string describing the last libiscsi error.
> > + */
> > +const char *libiscsi_get_error_string(struct libiscsi_context
> *context);
>
> Why is this neccessary? 'strerror' won't work?

Sure but that will only give you a very vague error like "no such file or
directory, while as this will return something like:

"Error trying to open /var/lib/iscsi/nodes/iqn.foo.bar:testdisk/127.0.0.1,2670:
no such file or directory"

> If you want to carry
> error messages
> maybe have all the functions return a struct, such as this:
>
> struct iscsi_err {
> int errno;
> const char *msg;
> }
>
> Which would carry the relevant error code and the message?
>

Becuase that makes using the library harder, esp when one is not interested in
such verbose error messages.




>
> > diff -urN open-iscsi-2.0-870.1.orig/libiscsi/tests/test_discovery.c
> open-iscsi-2.0-870.1/libiscsi/tests/test_discovery.c
> > --- open-iscsi-2.0-870.1.orig/libiscsi/tests/test_discovery.c
> 1970-01-01 01:00:00.000000000 +0100
> > +++ open-iscsi-2.0-870.1/libiscsi/tests/test_discovery.c
> 2009-01-19 12:33:09.000000000 +0100
>
> Awesome. Thanks for including test-cases.
>

Well, they are a bit hardcoded to my setup, I think I'll add an /etc/ietd.conf
which can be used to run the tests with, but they still won't run out of the
box on any system. But with that said, yes tests are good!


>
> Thank you for the library.

I'm glad you like it

> I am really looking forward to using it
> instead of
> wrapping all calls to iSCSI via 'iscsiadm' and this makes it so much
> easier.

I know, wrapping iscsiadm can be a pain, that is why I wrote this lib.

Regards,

Hans


_______________________________________________
Anaconda-devel-list mailing list
Anaconda-devel-list@redhat.com
https://www.redhat.com/mailman/listinfo/anaconda-devel-list
 
Old 01-21-2009, 09:09 AM
Hans de Goede
 
Default PATCH: make open-iscsi userspace tools functionality available as a library

Hans de Goede wrote:
> On Tue, Jan 20, 2009 at 07:58:07PM +0100, Hans de Goede wrote:
> >
> > Hi,
> >
> > Konrad Rzeszutek wrote:
> >
> > Thanks for the review!
> >
> > > I presume you have run this program (and the test-code) through
> > > valgrind with no memory leaks?
> > >
> >
> > Erm, no, has iscsiadm been run through valgrind? If not I'm not going
> to be
> > running libiscsi through it either (sorry) libiscsi builds on top of
> many
>
> I meant the test-cases.
>

I understood the first time, but unless someone can show me clean iscsiadm
valgrind results, I'm not going to be spending time on running libiscsi through
valgrind. libiscsi is a wrapper around the open-iscsi userspace code used by
iscsiadm, and I have no time to go and make that code completely valgrind clean.


<snip>

> > > > + CHECK(discovery_sendtargets(&drec, &new_rec_list))
> > > > + CHECK(idbm_add_discovery(&drec, 1))
> > >
> > > Make the 1 a #define? Without me looking at the code I had
> > > no idea that 1 stands for 'over-write'. Thought at first it
> > > was the count of records - which looked weird.
> > >
> >
> > Internal open-iscsi API, when it becomes a define there I'll happily
> use it.
>
> How about a comment instead then.
>

Will do.


<snip>

> > > > +int login_helper(void *data, node_rec_t *rec)
> > > > +{
> > > > + int rc = iscsid_req_by_rec(MGMT_IPC_SESSION_LOGIN, rec);
> > > > + if (rc) {
> > > > + iscsid_handle_error(rc);
> > > > + rc = ENOTCONN;
> > >
> > > Should that have a - in front of it? Hmm.. I thought Mike wanted
> > > all of the return codes to be a positive number. Which means all
> > > the other functions you have should _NOT_ have the '-'?
> > >
> > > Looking at the 'idbm_*' all of its return codes are positive. Perhaps
> > > a global search and replace for the -E to E?
> > >
> >
> > The only functions returning negative codes are the discovery
> functions, as
>
> I think having the same mechanism and behavior to return error codes will
> save folks from trouble down the line. Having all functions return a
> positive
> error codes.
>


Ok, I have to agree that having all error codes be positive would be the
consistent thing to do, so I'll make this change.


<snip>

> > > > +{
> > > > + int rc;
> > > > + struct node_rec *rec = data;
> > > > +
> > > > + if (!iscsi_match_session(rec, info))
> > > > + return -1; /* Not a match */
> > >
> > > Oh boy. Can you put a comment of why you are mixing standard error
> > > codes with negative numbers? At first I thought this was an error
> > > until I looked in 'iscsi_sysfs_for_each_session' and found:
> > > "if less than zero it means it was not a match"
> > >
> > > Can you just say that 'iscsi_sysfs_for_each_session' requires this
> > > type of return code for not a match please?
> > >
> >
> > You mean make the comment more verbose, sure if that makes you happy
>
>
> Please do.
>

Will do.

<snip>

> > > > +/** rief Get human readable string describing the last libiscsi
> > > error.
> > > > + *
> > > > + * This function can be called to get a human readable error
> string
> > > when a
> > > > + * libiscsi function has returned an error. This function uses a
> > > static buffer
> > > > + * thus the result is only valid as long as no other libiscsi
> calls
> > > are made
> > > > + * after the failing function call.
> > > > + *
> > > > + * param context libiscsi context to operate on.
> > > > + *
> > > > + *
eturn human readable string describing the last libiscsi
> error.
> > > > + */
> > > > +const char *libiscsi_get_error_string(struct libiscsi_context
> > > *context);
> > >
> > > Why is this neccessary? 'strerror' won't work?
> >
> > Sure but that will only give you a very vague error like "no such
> file or
> > directory, while as this will return something like:
> > "Error trying to open
> /var/lib/iscsi/nodes/iqn.foo.bar:testdisk/127.0.0.1,2670:
> > no such file or directory"
>
> OK. I think the previous concerns about thread safety are important. The
> idea I proposed
> below would fix that.

The thread safety model for libiscsi (if the used internal open-iscsi code ever
becomes thread clean) is that of having one context per thread, since the last
error message is stored in the context, there is no thread safety problem here.


Regards,

Hans


_______________________________________________
Anaconda-devel-list mailing list
Anaconda-devel-list@redhat.com
https://www.redhat.com/mailman/listinfo/anaconda-devel-list
 
Old 01-21-2009, 02:10 PM
Hans de Goede
 
Default PATCH: make open-iscsi userspace tools functionality available as a library

Hi All,

Here is the second version of my iscsi library work, I've incorporated all
discussed changes. And I've the proposed error logging chanegs so that the
caller now can retrieve an error string instead of all error being printed to
stderr.


Thanks & Regards,

Hans


p.s.

I still haven't added copyright headers to the new Files yet, the new code
is all Copyright (C) 2008 - 2009 Red Hat, Inc. All rights reserved. Author
Hans de Goede, and may be distributed under the GNU GPL version 2 or (at your
option) any later version.


diff -urN open-iscsi-2.0-870.1.orig/libiscsi/Makefile open-iscsi-2.0-870.1/libiscsi/Makefile
--- open-iscsi-2.0-870.1.orig/libiscsi/Makefile 1970-01-01 01:00:00.000000000 +0100
+++ open-iscsi-2.0-870.1/libiscsi/Makefile 2009-01-08 12:31:21.000000000 +0100
@@ -0,0 +1,44 @@
+# This Makefile will work only with GNU make.
+
+OSNAME=$(shell uname -s)
+OPTFLAGS ?= -O2 -g
+WARNFLAGS ?= -Wall -Wstrict-prototypes
+CFLAGS = $(OPTFLAGS) $(WARNFLAGS) -I../include -I../usr -D$(OSNAME) -fPIC -D_GNU_SOURCE
+LIB = libiscsi.so.0
+TESTS = tests/test_discovery tests/test_login tests/test_logout tests/test_params
+
+# sources shared between iscsid, iscsiadm and iscsistart
+ISCSI_LIB_SRCS = util.o io.o auth.o login.o log.o md5.o sha1.o iface.o idbm.o sysdeps.o sysfs.o iscsi_sysfs.o
+# sources shared with the userspace utils, note we build these separately
+# to get PIC versions.
+USR_OBJS = $(patsubst %.o, usr-objs/%.o, $(ISCSI_LIB_SRCS) strings.o
+discovery.o)
+
+# Flags for the tests
+tests/% : CFLAGS = $(OPTFLAGS) $(WARNFLAGS) -I.
+
+all: lib tests html
+
+lib: $(LIB)
+tests: $(TESTS)
+
+usr-objs/%.o: ../usr/%.c
+ mkdir -p usr-objs
+ $(CC) $(CFLAGS) -c $< -o $@
+
+$(LIB): $(USR_OBJS) libiscsi.o
+ $(CC) $(CFLAGS) -shared -Wl,-soname,$(LIB) $^ -o $@
+ ln -s -f $(LIB) libiscsi.so
+
+$(TESTS): $(USR_OBJS) $(LIB)
+
+html: libiscsi.h libiscsi.doxy
+ doxygen libiscsi.doxy
+
+clean:
+ rm -rf *.o usr-objs libiscsi.so* .depend *~ html $(TESTS) tests/*~
+
+depend:
+ gcc $(CFLAGS) -M `ls *.c` > .depend
+
+-include .depend ../usr/.depend
diff -urN open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.c open-iscsi-2.0-870.1/libiscsi/libiscsi.c
--- open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.c 1970-01-01 01:00:00.000000000 +0100
+++ open-iscsi-2.0-870.1/libiscsi/libiscsi.c 2009-01-21 15:42:59.000000000 +0100
@@ -0,0 +1,400 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <unistd.h>
+#include <sys/syslog.h>
+#include "libiscsi.h"
+#include "idbm.h"
+#include "iscsiadm.h"
+#include "log.h"
+#include "sysfs.h"
+#include "iscsi_sysfs.h"
+#include "util.h"
+#include "sysdeps.h"
+#include "iface.h"
+#include "iscsi_proto.h"
+
+#define CHECK(a) { rc = a; if (rc) goto leave; }
+
+struct libiscsi_context {
+ char error_str[256];
+ /* For get_parameter_helper() */
+ const char *parameter;
+ char *value;
+};
+
+static void libiscsi_log(int prio, void *priv, const char *fmt, va_list ap)
+{
+ struct libiscsi_context *context = priv;
+
+ if (prio > LOG_ERR) /* We are only interested in errors (or worse) */
+ return;
+
+ vsnprintf(context->error_str, sizeof(context->error_str), fmt, ap);
+}
+
+struct libiscsi_context *libiscsi_init(void)
+{
+ struct libiscsi_context *context;
+
+ context = calloc(1, sizeof *context);
+ if (!context)
+ return NULL;
+
+ log_init("libiscsi", 1024, libiscsi_log, context);
+ sysfs_init();
+ increase_max_files();
+ if (idbm_init(NULL)) {
+ sysfs_cleanup();
+ free(context);
+ return NULL;
+ }
+
+ iface_setup_host_bindings();
+
+ return context;
+}
+
+void libiscsi_cleanup(struct libiscsi_context *context)
+{
+ idbm_terminate();
+ free_transports();
+ sysfs_cleanup();
+ free(context);
+}
+
+static void free_rec_list(struct list_head *rec_list)
+{
+ struct node_rec *rec, *tmp;
+
+ list_for_each_entry_safe(rec, tmp, rec_list, list) {
+ list_del(&rec->list);
+ free(rec);
+ }
+}
+
+static int verify_auth_info(struct libiscsi_context *context,
+ const struct libiscsi_auth_info *auth_info)
+{
+ switch(auth_info ? auth_info->method : libiscsi_auth_none) {
+ case libiscsi_auth_none:
+ break;
+ case libiscsi_auth_chap:
+ if (!auth_info->chap.username[0]) {
+ strcpy(context->error_str, "Empty username");
+ return EINVAL;
+ }
+ if (!auth_info->chap.password[0]) {
+ strcpy(context->error_str, "Empty password");
+ return EINVAL;
+ }
+ if (auth_info->chap.reverse_username[0] &&
+ !auth_info->chap.reverse_password[0]) {
+ strcpy(context->error_str, "Empty reverse password");
+ return EINVAL;
+ }
+ break;
+ default:
+ sprintf(context->error_str, "Invalid authentication type: %d",
+ (int)auth_info->method);
+ return EINVAL;
+ }
+ return 0;
+}
+
+int libiscsi_discover_sendtargets(struct libiscsi_context *context,
+ const char *address, int port,
+ const struct libiscsi_auth_info *auth_info,
+ int *nr_found, struct libiscsi_node **found_nodes)
+{
+ struct discovery_rec drec;
+ LIST_HEAD(new_rec_list);
+ LIST_HEAD(bound_rec_list);
+ struct node_rec *rec;
+ int rc = 0, found = 0;
+
+ INIT_LIST_HEAD(&new_rec_list);
+ INIT_LIST_HEAD(&bound_rec_list);
+
+ if (nr_found)
+ *nr_found = 0;
+ if (found_nodes)
+ *found_nodes = NULL;
+
+ CHECK(verify_auth_info(context, auth_info))
+
+ /* Fill the drec struct with all needed info */
+ memset(&drec, 0, sizeof drec);
+ idbm_sendtargets_defaults(&drec.u.sendtargets);
+ drec.type = DISCOVERY_TYPE_SENDTARGETS;
+ strlcpy(drec.address, address, sizeof(drec.address));
+ drec.port = port ? port : ISCSI_LISTEN_PORT;
+ switch(auth_info ? auth_info->method : libiscsi_auth_none) {
+ case libiscsi_auth_chap:
+ drec.u.sendtargets.auth.authmethod = AUTH_METHOD_CHAP;
+ strlcpy(drec.u.sendtargets.auth.username,
+ auth_info->chap.username, AUTH_STR_MAX_LEN);
+ strlcpy((char *)drec.u.sendtargets.auth.password,
+ auth_info->chap.password, AUTH_STR_MAX_LEN);
+ drec.u.sendtargets.auth.password_length =
+ strlen((char *)drec.u.sendtargets.auth.password);
+ strlcpy(drec.u.sendtargets.auth.username_in,
+ auth_info->chap.reverse_username, AUTH_STR_MAX_LEN);
+ strlcpy((char *)drec.u.sendtargets.auth.password_in,
+ auth_info->chap.reverse_password, AUTH_STR_MAX_LEN);
+ drec.u.sendtargets.auth.password_in_length =
+ strlen((char *)drec.u.sendtargets.auth.password_in);
+ break;
+ }
+
+ CHECK(discovery_sendtargets(&drec, &new_rec_list))
+ CHECK(idbm_add_discovery(&drec, 1 /* overwrite existing records */))
+
+ /* bind ifaces to node recs so we know what we have */
+ list_for_each_entry(rec, &new_rec_list, list)
+ CHECK(idbm_bind_ifaces_to_node(rec, NULL, &bound_rec_list))
+
+ /* now add/update records */
+ list_for_each_entry(rec, &bound_rec_list, list) {
+ CHECK(idbm_add_node(rec, &drec, 1 /* overwrite */))
+ found++;
+ }
+
+ if (nr_found)
+ *nr_found = found;
+
+ if (found_nodes && found) {
+ *found_nodes = calloc(found, sizeof **found_nodes);
+ if (*found_nodes == NULL) {
+ snprintf(context->error_str,
+ sizeof(context->error_str), strerror(ENOMEM));
+ rc = ENOMEM;
+ goto leave;
+ }
+ found = 0;
+ list_for_each_entry(rec, &bound_rec_list, list) {
+ strlcpy((*found_nodes)[found].name, rec->name,
+ LIBISCSI_VALUE_MAXLEN);
+ (*found_nodes)[found].tpgt = rec->tpgt;
+ strlcpy((*found_nodes)[found].address,
+ rec->conn[0].address, NI_MAXHOST);
+ (*found_nodes)[found].port = rec->conn[0].port;
+ found++;
+ }
+ }
+
+leave:
+ free_rec_list(&bound_rec_list);
+ free_rec_list(&new_rec_list);
+
+ return rc;
+}
+
+int libiscsi_discover_firmware(struct libiscsi_context *context,
+ int *nr_found, struct libiscsi_node **found_nodes)
+{
+ strcpy(context->error_str, "Firmware discovery is not implemented");
+ return EINVAL; /* FIXME */
+}
+
+int libiscsi_node_set_auth(struct libiscsi_context *context,
+ const struct libiscsi_node *node,
+ const struct libiscsi_auth_info *auth_info)
+{
+ int rc = 0;
+
+ CHECK(verify_auth_info(context, auth_info))
+
+ switch(auth_info ? auth_info->method : libiscsi_auth_none) {
+ case libiscsi_auth_none:
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.authmethod", "None"))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.username", ""))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.password", ""))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.username_in", ""))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.password_in", ""))
+ break;
+
+ case libiscsi_auth_chap:
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.authmethod", "CHAP"))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.username",
+ auth_info->chap.username))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.password",
+ auth_info->chap.password))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.username_in",
+ auth_info->chap.reverse_username))
+ CHECK(libiscsi_node_set_parameter(context, node,
+ "node.session.auth.password_in",
+ auth_info->chap.reverse_password))
+ break;
+ }
+leave:
+ return rc;
+}
+
+static void node_to_rec(const struct libiscsi_node *node,
+ struct node_rec *rec)
+{
+ memset(rec, 0, sizeof *rec);
+ idbm_node_setup_defaults(rec);
+ strlcpy(rec->name, node->name, TARGET_NAME_MAXLEN);
+ rec->tpgt = node->tpgt;
+ strlcpy(rec->conn[0].address, node->address, NI_MAXHOST);
+ rec->conn[0].port = node->port;
+}
+
+int login_helper(void *data, node_rec_t *rec)
+{
+ int rc = iscsid_req_by_rec(MGMT_IPC_SESSION_LOGIN, rec);
+ if (rc) {
+ iscsid_handle_error(rc);
+ rc = ENOTCONN;
+ }
+ return rc;
+}
+
+int libiscsi_node_login(struct libiscsi_context *context,
+ const struct libiscsi_node *node)
+{
+ int nr_found = 0, rc;
+
+ CHECK(idbm_for_each_iface(&nr_found, NULL, login_helper,
+ (char *)node->name, node->tpgt,
+ (char *)node->address, node->port))
+ if (nr_found == 0) {
+ strcpy(context->error_str, "No such node");
+ rc = ENODEV;
+ }
+leave:
+ return rc;
+}
+
+static int logout_helper(void *data, struct session_info *info)
+{
+ int rc;
+ struct node_rec *rec = data;
+
+ if (!iscsi_match_session(rec, info))
+ /* Tell iscsi_sysfs_for_each_session this session was not a
+ match so that it will not increase nr_found. */
+ return -1;
+
+ rc = iscsid_req_by_sid(MGMT_IPC_SESSION_LOGOUT, info->sid);
+ if (rc) {
+ iscsid_handle_error(rc);
+ rc = EIO;
+ }
+
+ return rc;
+}
+
+int libiscsi_node_logout(struct libiscsi_context *context,
+ const struct libiscsi_node *node)
+{
+ int nr_found = 0, rc;
+ struct node_rec rec;
+
+ node_to_rec(node, &rec);
+ CHECK(iscsi_sysfs_for_each_session(&rec, &nr_found, logout_helper))
+ if (nr_found == 0) {
+ strcpy(context->error_str, "No matching session");
+ rc = ENODEV;
+ }
+leave:
+ return rc;
+}
+
+int libiscsi_node_set_parameter(struct libiscsi_context *context,
+ const struct libiscsi_node *node,
+ const char *parameter, const char *value)
+{
+ int nr_found = 0, rc;
+ struct db_set_param set_param = {
+ .name = (char *)parameter,
+ .value = (char *)value,
+ };
+
+ CHECK(idbm_for_each_iface(&nr_found, &set_param, idbm_node_set_param,
+ (char *)node->name, node->tpgt,
+ (char *)node->address, node->port))
+ if (nr_found == 0) {
+ strcpy(context->error_str, "No such node");
+ rc = ENODEV;
+ }
+leave:
+ return rc;
+}
+
+static int get_parameter_helper(void *data, node_rec_t *rec)
+{
+ struct libiscsi_context *context = data;
+ recinfo_t *info;
+ int i;
+
+ info = idbm_recinfo_alloc(MAX_KEYS);
+ if (!info) {
+ snprintf(context->error_str, sizeof(context->error_str),
+ strerror(ENOMEM));
+ return ENOMEM;
+ }
+
+ idbm_recinfo_node(rec, info);
+
+ for (i = 0; i < MAX_KEYS; i++) {
+ if (!info[i].visible)
+ continue;
+
+ if (strcmp(context->parameter, info[i].name))
+ continue;
+
+ strlcpy(context->value, info[i].value, LIBISCSI_VALUE_MAXLEN);
+ break;
+ }
+
+ free(info);
+
+ if (i == MAX_KEYS) {
+ strcpy(context->error_str, "No such parameter");
+ return EINVAL;
+ }
+
+ return 0;
+}
+
+int libiscsi_node_get_parameter(struct libiscsi_context *context,
+ const struct libiscsi_node *node, const char *parameter, char *value)
+{
+ int nr_found = 0, rc = 0;
+
+ context->parameter = parameter;
+ context->value = value;
+
+ /* Note we assume there is only one interface, if not we will get
+ the value from the last interface iterated over!
+ This (multiple interfaces) can only happen if someone explicitly
+ created ones using iscsiadm. Even then this should not be a problem
+ as most settings should be the same independent of the iface. */
+ CHECK(idbm_for_each_iface(&nr_found, context, get_parameter_helper,
+ (char *)node->name, node->tpgt,
+ (char *)node->address, node->port))
+ if (nr_found == 0) {
+ strcpy(context->error_str, "No such node");
+ rc = ENODEV;
+ }
+leave:
+ return rc;
+}
+
+const char *libiscsi_get_error_string(struct libiscsi_context *context)
+{
+ return context->error_str;
+}
diff -urN open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.doxy open-iscsi-2.0-870.1/libiscsi/libiscsi.doxy
--- open-iscsi-2.0-870.1.orig/libiscsi/libiscsi.doxy 1970-01-01 01:00:00.000000000 +0100
+++ open-iscsi-2.0-870.1/libiscsi/libiscsi.doxy 2009-01-08 12:19:19.000000000 +0100
@@ -0,0 +1,1473 @@
+# Doxyfile 1.5.7.1
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = libiscsi
+
+# 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 =
+
+# 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 =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
+# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
+# Spanish, Swedish, and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = NO
+
+# 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 =
+
+# 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 = 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
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit rief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=par Side Effects:
" 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
's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = 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
+
+# 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
osubgrouping command.
+
+SUBGROUPING = YES
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = 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
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = 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
+# and Mac users are advised to set this option to NO.
+
+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
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting odo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting est
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting ug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by if sectionname ... endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using showinitializer or hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
+# doxygen. The layout file controls the global structure of the generated output files
+# in an output format independent way. The create the layout file that represents
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name
+# of the layout file.
+
+LAYOUT_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = YES
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT =
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS =
+
+# 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
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the include or dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the image command).
+
+IMAGE_PATH =
+
+# 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 <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# 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 = NO
+
+# 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.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = 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
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
+# are set, an additional index file will be generated that can be used as input for
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
+# HTML documentation.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file .
+
+QHG_LOCATION =
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature. Other possible values
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
+
+GENERATE_TREEVIEW = NONE
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = 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
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the atchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = 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
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to
 

Thread Tools




All times are GMT. The time now is 11:22 AM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.
Copyright 2007 - 2008, www.linux-archive.org