Alternate Channel Storage Backends

Full details: http://s.asterisk.net/dc679ec3

The previous proof-of-concept showed that the cpp_map_name_id alternate
storage backed performed better than all the others so this final PR
adds only that option.  You still need to enable it in menuselect under
the "Alternate Channel Storage Backends" category.

To select which one is used at runtime, set the "channel_storage_backend"
option in asterisk.conf to one of the values described in
asterisk.conf.sample.  The default remains "ao2_legacy".

UpgradeNote: With this release, you can now select an alternate channel
storage backend based on C++ Maps.  Using the new backend may increase
performance and reduce the chances of deadlocks on heavily loaded systems.
For more information, see http://s.asterisk.net/dc679ec3

Author: gtjoseph

Makefile

@@ -1090,12 +1090,13 @@ menuselect/nmenuselect: menuselect/makeopts .lastclean
 menuselect/makeopts: makeopts .lastclean
 	+$(MAKE_MENUSELECT) makeopts
 
-menuselect-tree: $(foreach dir,$(filter-out main,$(MOD_SUBDIRS)),$(wildcard $(dir)/*.c) $(wildcard $(dir)/*.cc) $(wildcard $(dir)/*.xml)) build_tools/cflags.xml build_tools/cflags-devmode.xml sounds/sounds.xml utils/utils.xml agi/agi.xml configure makeopts
+menuselect-tree: $(foreach dir,$(filter-out main,$(MOD_SUBDIRS)),$(wildcard $(dir)/*.c) $(wildcard $(dir)/*.cc) $(wildcard $(dir)/*.xml)) main/channelstorage_makeopts.xml build_tools/cflags.xml build_tools/cflags-devmode.xml sounds/sounds.xml utils/utils.xml agi/agi.xml configure makeopts
 	@echo "Generating input for menuselect ..."
 	@echo "<?xml version=\"1.0\"?>" > $@
 	@echo >> $@
 	@echo "<menu name=\"Asterisk Module and Build Option Selection\">" >> $@
 	+@for dir in $(sort $(filter-out main,$(MOD_SUBDIRS))); do $(SILENTMAKE) -C $${dir} SUBDIR=$${dir} moduleinfo >> $@; done
+	@cat main/channelstorage_makeopts.xml >> $@
 	@cat build_tools/cflags.xml >> $@
 	+@for dir in $(sort $(filter-out main,$(MOD_SUBDIRS))); do $(SILENTMAKE) -C $${dir} SUBDIR=$${dir} makeopts >> $@; done
 	@if [ "${AST_DEVMODE}" = "yes" ]; then \

configs/samples/asterisk.conf.sample

@@ -130,6 +130,14 @@ documentation_language = en_US	; Set the language you want documentation
                 ; cause Asterisk to search for sounds files in
                 ; AST_DATA_DIR/sounds/custom before searching the
                 ; normal directories like AST_DATA_DIR/sounds/<lang>.
+;channel_storage_backend = ao2_legacy ; Select the channel storage backend
+                ; to use for live operation.
+                ;   ao2_legacy:  Original implementation (default)
+                ; Depending on compile options, the following may also be
+                ; available:
+                ;   cpp_map_name_id: Use C++ Maps to index both
+                ;                    channel name and channel uniqueid.
+                ; See http://s.asterisk.net/dc679ec3 for more information.
 
 ; Changing the following lines may compromise your security.
 ;[files]

include/asterisk/channel.h

@@ -1455,15 +1455,17 @@ int ast_queue_answer(struct ast_channel *chan, const struct ast_stream_topology
 /*!
  * \brief Change channel name
  *
- * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
+ * \pre Absolutely all channels and the channel storage backend _MUST_ be
+ * unlocked before calling this function.
  *
  * \param chan the channel to change the name of
  * \param newname the name to change to
  *
- * \note this function must _NEVER_ be used when any channels are locked
- * regardless if it is the channel who's name is being changed or not because
- * it invalidates our channel container locking order... lock container first,
- * then the individual channels, never the other way around.
+ * \note this function must _NEVER_ be used when any channels or the channel
+ * storage backend are locked regardless if it is the channel who's name is
+ * being changed or not because it invalidates our channel container locking
+ * order... lock container first, then the individual channels, never the
+ * other way around.
  */
 void ast_change_name(struct ast_channel *chan, const char *newname);
 
@@ -3119,48 +3121,64 @@ struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
 
 /*! @} End channel iterator definitions. */
 
+/*! @{ Channel search functions */
+
+/*!
+* \warning Absolutely _NO_ channel locks should be held while calling any of
+* these functions.
+*/
+
 /*!
  * \brief Call a function with every active channel
  *
  * \details
  * This function executes a callback one time for each active channel on the
  * system.  The channel is provided as an argument to the function.
  *
- * \note Absolutely _NO_ channel locks should be held before calling this function.
  * \since 1.8
  */
 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
 		void *data, int ao2_flags);
 
-/*! @{ Channel search functions */
-
 /*!
- * \brief Find a channel by name
+ * \brief Find a channel by name or uniqueid
  *
- * \param name the name or uniqueid of the channel to search for
+ * \param search the name or uniqueid of the channel to search for
  *
  * \details
- * Find a channel that has the same name as the provided argument.
+ * First searches for a channel with a matching name.  If not found
+ * a search for a channel with a matching uniqueid is done.
  *
- * \retval a channel with the name specified by the argument
+ * \retval a channel with a matching name or uniqueid
  * \retval NULL if no channel was found
  *
+ *\note The fallback search by uniqueid is a historical thing.  If you
+ * know the search term is a uniqueid, use \ref ast_channel_get_by_uniqueid
+ * instead.
+ *
  * \since 1.8
  */
-struct ast_channel *ast_channel_get_by_name(const char *name);
+struct ast_channel *ast_channel_get_by_name(const char *search);
 
 /*!
  * \brief Find a channel by a name prefix
  *
- * \param name The channel name or uniqueid prefix to search for
- * \param name_len Only search for up to this many characters from the name
+ * \param search The channel name or uniqueid prefix to search for
+ * \param len Only search for up to this many characters from the search term
  *
  * \details
- * Find a channel that has the same name prefix as specified by the arguments.
+ * Search for a channel that has the same name prefix as specified by the
+ * search term.  If not found, search for an exact match on the uniqueid.
+ * Searching by partial uniqueid doesn't make any sense as it's usually
+ * a system-name plus a timestamp and is not supported.
  *
- * \retval a channel with the name prefix specified by the arguments
+ * \retval a channel with a matching name or uniqueid
  * \retval NULL if no channel was found
  *
+ *\note The fallback search by uniqueid is a historical thing.  If you
+ * know the search term is a uniqueid, use \ref ast_channel_get_by_uniqueid
+ * instead.
+ *
  * \since 1.8
  */
 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
@@ -3181,6 +3199,16 @@ struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name
  */
 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
 
+/*!
+ * \brief Find a channel by a uniqueid
+ *
+ * \param uniqueid The uniqueid to search for
+ *
+ * \retval a channel with the uniqueid specified by the arguments
+ * \retval NULL if no channel was found
+ */
+struct ast_channel *ast_channel_get_by_uniqueid(const char *uniqueid);
+
 /*! @} End channel search functions. */
 
 /*!
@@ -4998,5 +5026,27 @@ void *ast_channel_get_stream_topology_change_source(struct ast_channel *chan);
 #define ast_channel_has_tech_function(chan, function) \
 	(ast_channel_tech(chan) ? ast_channel_tech(chan)->function != NULL : 0)
 
+/*!
+ * \brief Get the name of the current channel storage driver
+ *
+ * \return The name of the current channel storage driver
+ */
+const char *ast_channel_get_current_storage_driver_name(void);
+
+/*!
+ * \internal
+ * \brief Set the current channel storage driver
+ *
+ * \param driver_name The name of the driver to set as the current driver
+ *
+ * \return 0 on success, -1 on failure
+ *
+ * \warning Changing the channel storage driver while Asterisk is running is
+ *          not supported.  This function will return an error if called while
+ *          the ast_fully_booted flag is set.  The function is exposed only
+ *          because options.c needs it to set the driver when reading
+ *          asterisk.conf.
+ */
+int internal_channel_set_current_storage_driver(const char *driver_name);
 
 #endif /* _ASTERISK_CHANNEL_H */

include/asterisk/channel_internal.h

@@ -39,4 +39,11 @@ void ast_channel_internal_set_stream_topology_change_source(
 void ast_channel_internal_swap_stream_topology(struct ast_channel *chan1,
 	struct ast_channel *chan2);
 
+/*! \brief The current channel storage driver */
+extern const struct ast_channelstorage_driver *current_channel_storage_driver;
+extern struct ast_channelstorage_instance *current_channel_storage_instance;
+
+void ast_channel_close_storage(void);
+int ast_channel_open_storage(void);
+
 #endif /* ASTERISK_CHANNEL_INTERNAL_H */

include/asterisk/options.h

@@ -32,6 +32,7 @@ extern "C" {
 #define AST_CACHE_DIR_LEN 	512
 #define AST_FILENAME_MAX	80
 #define AST_CHANNEL_NAME    80  /*!< Max length of an ast_channel name */
+#define AST_CHANNEL_STORAGE_BACKEND_NAME_LEN  80  /*!< Max length of storage backend name */
 
 
 /*! \ingroup main_options */

main/Makefile

@@ -31,7 +31,10 @@ ifeq ($(PJPROJECT_BUNDLED),yes)
 SRC:=$(filter-out libasteriskpj.c,$(SRC))
 endif
 OBJSFILTER:=$(MOD_OBJS) fskmodem_int.o fskmodem_float.o cygload.o buildinfo.o
-SRC_CC:=$(wildcard *.cc)
+
+SRC_CC:=$(filter-out $(addsuffix .cc,$(MENUSELECT_CHANNELSTORAGE)),$(wildcard *.cc))
+SRC:=$(filter-out $(addsuffix .c,$(MENUSELECT_CHANNELSTORAGE)),$(SRC))
+
 OBJS=$(filter-out $(OBJSFILTER),$(SRC:.c=.o) $(SRC_CC:.cc=.oo))
 
 # we need to link in the objects statically, not as a library, because

main/asterisk.c

@@ -245,6 +245,7 @@ int daemon(int, int);  /* defined in libresolv of all places */
 #include "asterisk/utf8.h"
 
 #include "../defaults.h"
+#include "channelstorage.h"
 
 /*** DOCUMENTATION
 	<managerEvent language="en_US" name="FullyBooted">
@@ -578,6 +579,8 @@ static char *handle_show_settings(struct ast_cli_entry *e, int cmd, struct ast_c
 		ast_cli(a->fd, "  RTP dynamic payload types:   %u-%u\n",
 		        AST_RTP_PT_FIRST_DYNAMIC, AST_RTP_MAX_PT - 1);
 	}
+	ast_cli(a->fd, "  Channel storage backend:     %s\n",
+		ast_channel_get_current_storage_driver_name());
 
 	ast_cli(a->fd, "\n* Subsystems\n");
 	ast_cli(a->fd, "  -------------\n");