| /* ********************************************************** |
| * Copyright (c) 2011 Google, Inc. All rights reserved. |
| * Copyright (c) 2010 VMware, Inc. All rights reserved. |
| * **********************************************************/ |
| |
| /* |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * |
| * * Redistributions of source code must retain the above copyright notice, |
| * this list of conditions and the following disclaimer. |
| * |
| * * Redistributions in binary form must reproduce the above copyright notice, |
| * this list of conditions and the following disclaimer in the documentation |
| * and/or other materials provided with the distribution. |
| * |
| * * Neither the name of VMware, Inc. nor the names of its contributors may be |
| * used to endorse or promote products derived from this software without |
| * specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL VMWARE, INC. OR CONTRIBUTORS BE LIABLE |
| * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH |
| * DAMAGE. |
| */ |
| |
| /** |
| *************************************************************************** |
| *************************************************************************** |
| \page page_drcontainers Container Data Structures |
| |
| The \p drcontainers DynamoRIO Extension provides container data structures |
| that use the DR API for memory allocation and synchronization. |
| |
| - \ref sec_drcontainers_setup |
| - \ref sec_drcontainers_hashtable |
| - \ref sec_drcontainers_vector |
| - \ref sec_drcontainers_table |
| |
| \section sec_drcontainers_setup Setup |
| |
| To use \p drcontainers with your client simply include this line in your client's |
| \p CMakeLists.txt file: |
| |
| \code use_DynamoRIO_extension(clientname drcontainers) \endcode |
| |
| That will automatically set up the include path and library dependence. |
| |
| \section sec_drcontainers_hashtable Hashtable |
| |
| The hashtable supports integer, string, and custom hash keys, and has |
| synchronization and memory allocation and deallocation parametrized for |
| flexible usage. See hashtable_init_ex() and related functions. |
| |
| \section sec_drcontainers_vector DrVector |
| |
| The DrVector is a simple resizable array. |
| |
| \section sec_drcontainers_table DrTable |
| |
| The DrTable is a resizable array that does not relocate data, |
| enabling a user to use pointers to access array entries directly. |
| |
| */ |