[svn-r11903] Purpose:

Add files that I forgot in my last checkin.

Description:

cache_api.c cache_common.c cache_common.h are new files that result
from breaking the old cache test into two tests.


Solution:

See above.

Platforms tested:

h5committested before the last checkin.  Will run another
h5committest shortly, but it shouldn't be necessary as there
are no new changes.

Misc. update:

1 files changed, 500 insertions, 0 deletions

diff --git a/test/cache_common.h b/test/cache_common.h
new file mode 100644
index 0000000..acacb30
--- /dev/null
+++ b/test/cache_common.h
@@ -0,0 +1,500 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by the Board of Trustees of the University of Illinois.         *
+ * All rights reserved.                                                      *
+ *                                                                           *
+ * This file is part of HDF5.  The full HDF5 copyright notice, including     *
+ * terms governing use, modification, and redistribution, is contained in    *
+ * the files COPYING and Copyright.html.  COPYING can be found at the root   *
+ * of the source code distribution tree; Copyright.html can be found at the  *
+ * root level of an installed copy of the electronic HDF5 document set and   *
+ * is linked from the top-level documents page.  It can also be found at     *
+ * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
+ * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/* Programmer:  John Mainzer
+ *              10/27/05
+ *
+ *		This file contains common #defines, type definitions, and
+ *		externs for tests of the cache implemented in H5C.c
+ */
+#include "h5test.h"
+#include "H5Iprivate.h"
+#include "H5ACprivate.h"
+
+#define H5C_PACKAGE             /*suppress error about including H5Cpkg   */
+
+#include "H5Cpkg.h"
+
+#define H5F_PACKAGE             /*suppress error about including H5Fpkg   */
+
+#include "H5Fpkg.h"
+
+#define NO_CHANGE       -1
+
+/* with apologies for the abuse of terminology... */
+
+#define PICO_ENTRY_TYPE		0
+#define NANO_ENTRY_TYPE		1
+#define MICRO_ENTRY_TYPE	2
+#define TINY_ENTRY_TYPE		3
+#define SMALL_ENTRY_TYPE	4
+#define MEDIUM_ENTRY_TYPE	5
+#define LARGE_ENTRY_TYPE	6
+#define HUGE_ENTRY_TYPE		7
+#define MONSTER_ENTRY_TYPE	8
+
+#define NUMBER_OF_ENTRY_TYPES	9
+
+#define PICO_ENTRY_SIZE		(size_t)1
+#define NANO_ENTRY_SIZE		(size_t)4
+#define MICRO_ENTRY_SIZE	(size_t)16
+#define TINY_ENTRY_SIZE		(size_t)64
+#define SMALL_ENTRY_SIZE	(size_t)256
+#define MEDIUM_ENTRY_SIZE	(size_t)1024
+#define LARGE_ENTRY_SIZE	(size_t)(4 * 1024)
+#define HUGE_ENTRY_SIZE		(size_t)(16 * 1024)
+#define MONSTER_ENTRY_SIZE	(size_t)(64 * 1024)
+
+#define NUM_PICO_ENTRIES	(10 * 1024)
+#define NUM_NANO_ENTRIES	(10 * 1024)
+#define NUM_MICRO_ENTRIES	(10 * 1024)
+#define NUM_TINY_ENTRIES	(10 * 1024)
+#define NUM_SMALL_ENTRIES	(10 * 1024)
+#define NUM_MEDIUM_ENTRIES	(10 * 1024)
+#define NUM_LARGE_ENTRIES	(10 * 1024)
+#define NUM_HUGE_ENTRIES	(10 * 1024)
+#define NUM_MONSTER_ENTRIES	(10 * 1024)
+
+#define MAX_ENTRIES		(10 * 1024)
+
+#define PICO_BASE_ADDR		(haddr_t)0
+#define NANO_BASE_ADDR		(haddr_t)(PICO_BASE_ADDR + \
+                                      (PICO_ENTRY_SIZE * NUM_PICO_ENTRIES))
+#define MICRO_BASE_ADDR		(haddr_t)(NANO_BASE_ADDR + \
+                                      (NANO_ENTRY_SIZE * NUM_NANO_ENTRIES))
+#define TINY_BASE_ADDR		(haddr_t)(MICRO_BASE_ADDR + \
+			              (MICRO_ENTRY_SIZE * NUM_MICRO_ENTRIES))
+#define SMALL_BASE_ADDR		(haddr_t)(TINY_BASE_ADDR + \
+                                      (TINY_ENTRY_SIZE * NUM_TINY_ENTRIES))
+#define MEDIUM_BASE_ADDR	(haddr_t)(SMALL_BASE_ADDR + \
+                                      (SMALL_ENTRY_SIZE * NUM_SMALL_ENTRIES))
+#define LARGE_BASE_ADDR		(haddr_t)(MEDIUM_BASE_ADDR + \
+                                      (MEDIUM_ENTRY_SIZE * NUM_MEDIUM_ENTRIES))
+#define HUGE_BASE_ADDR		(haddr_t)(LARGE_BASE_ADDR + \
+                                      (LARGE_ENTRY_SIZE * NUM_LARGE_ENTRIES))
+#define MONSTER_BASE_ADDR	(haddr_t)(HUGE_BASE_ADDR + \
+                                      (HUGE_ENTRY_SIZE * NUM_HUGE_ENTRIES))
+
+#define PICO_ALT_BASE_ADDR	(haddr_t)(MONSTER_BASE_ADDR + \
+				     (MONSTER_ENTRY_SIZE * NUM_MONSTER_ENTRIES))
+#define NANO_ALT_BASE_ADDR	(haddr_t)(PICO_ALT_BASE_ADDR + \
+                                      (PICO_ENTRY_SIZE * NUM_PICO_ENTRIES))
+#define MICRO_ALT_BASE_ADDR	(haddr_t)(NANO_ALT_BASE_ADDR + \
+                                      (NANO_ENTRY_SIZE * NUM_NANO_ENTRIES))
+#define TINY_ALT_BASE_ADDR	(haddr_t)(MICRO_ALT_BASE_ADDR + \
+			              (MICRO_ENTRY_SIZE * NUM_MICRO_ENTRIES))
+#define SMALL_ALT_BASE_ADDR	(haddr_t)(TINY_ALT_BASE_ADDR + \
+                                      (TINY_ENTRY_SIZE * NUM_TINY_ENTRIES))
+#define MEDIUM_ALT_BASE_ADDR	(haddr_t)(SMALL_ALT_BASE_ADDR + \
+                                      (SMALL_ENTRY_SIZE * NUM_SMALL_ENTRIES))
+#define LARGE_ALT_BASE_ADDR	(haddr_t)(MEDIUM_ALT_BASE_ADDR + \
+                                      (MEDIUM_ENTRY_SIZE * NUM_MEDIUM_ENTRIES))
+#define HUGE_ALT_BASE_ADDR	(haddr_t)(LARGE_ALT_BASE_ADDR + \
+                                      (LARGE_ENTRY_SIZE * NUM_LARGE_ENTRIES))
+#define MONSTER_ALT_BASE_ADDR	(haddr_t)(HUGE_ALT_BASE_ADDR + \
+                                      (HUGE_ENTRY_SIZE * NUM_HUGE_ENTRIES))
+
+typedef struct test_entry_t
+{
+    H5C_cache_entry_t	  header;	/* entry data used by the cache
+					 * -- must be first
+                               		 */
+    struct test_entry_t * self; 	/* pointer to this entry -- used for
+					 * sanity checking.
+                                         */
+    haddr_t		  addr;         /* where the cache thinks this entry
+                                         * is located
+                                         */
+    hbool_t		  at_main_addr;	/* boolean flag indicating whether
+					 * the entry is supposed to be at
+					 * either its main or alternate
+					 * address.
+     					 */
+    haddr_t		  main_addr;    /* initial location of the entry
+                                         */
+    haddr_t		  alt_addr;	/* location to which the entry
+					 * can be relocated or "renamed"
+                                         */
+    size_t		  size;         /* how big the cache thinks this
+                                         * entry is
+                                         */
+    int32_t		  type;		/* indicates which entry array this
+					 * entry is in
+                                         */
+    int32_t		  index;	/* index in its entry array
+                                         */
+    int32_t		  reads;	/* number of times this entry has
+					 * been loaded.
+                                         */
+    int32_t		  writes;	/* number of times this entry has
+                                         * been written
+                                         */
+    hbool_t		  is_dirty;	/* entry has been modified since
+                                         * last write
+                                         */
+    hbool_t		  is_protected;	/* entry should currently be on
+					 * the cache's protected list.
+                                         */
+    hbool_t		  loaded;       /* entry has been loaded since the
+                                         * last time it was reset.
+                                         */
+    hbool_t		  cleared;      /* entry has been cleared since the
+                                         * last time it was reset.
+                                         */
+    hbool_t		  flushed;      /* entry has been flushed since the
+                                         * last time it was reset.
+                                         */
+    hbool_t               destroyed;    /* entry has been destroyed since the
+                                         * last time it was reset.
+                                         */
+} test_entry_t;
+
+/* The following is a cut down copy of the hash table manipulation
+ * macros from H5C.c, which have been further modified to avoid references
+ * to the error reporting macros.  Needless to say, these macros must be
+ * updated as necessary.
+ */
+
+#define H5C__HASH_MASK          ((size_t)(H5C__HASH_TABLE_LEN - 1) << 3)
+#define H5C__HASH_FCN(x)        (int)(((x) & H5C__HASH_MASK) >> 3)
+
+#define H5C__PRE_HT_SEARCH_SC(cache_ptr, Addr)          \
+if ( ( (cache_ptr) == NULL ) ||                         \
+     ( (cache_ptr)->magic != H5C__H5C_T_MAGIC ) ||      \
+     ( ! H5F_addr_defined(Addr) ) ||                    \
+     ( H5C__HASH_FCN(Addr) < 0 ) ||                     \
+     ( H5C__HASH_FCN(Addr) >= H5C__HASH_TABLE_LEN ) ) { \
+    HDfprintf(stdout, "Pre HT search SC failed.\n");    \
+}
+
+#define H5C__POST_SUC_HT_SEARCH_SC(cache_ptr, entry_ptr, Addr, k) \
+if ( ( (cache_ptr) == NULL ) ||                                   \
+     ( (cache_ptr)->magic != H5C__H5C_T_MAGIC ) ||                \
+     ( (cache_ptr)->index_len < 1 ) ||                            \
+     ( (entry_ptr) == NULL ) ||                                   \
+     ( (cache_ptr)->index_size < (entry_ptr)->size ) ||           \
+     ( H5F_addr_ne((entry_ptr)->addr, (Addr)) ) ||                \
+     ( (entry_ptr)->size <= 0 ) ||                                \
+     ( ((cache_ptr)->index)[k] == NULL ) ||                       \
+     ( ( ((cache_ptr)->index)[k] != (entry_ptr) ) &&              \
+       ( (entry_ptr)->ht_prev == NULL ) ) ||                      \
+     ( ( ((cache_ptr)->index)[k] == (entry_ptr) ) &&              \
+       ( (entry_ptr)->ht_prev != NULL ) ) ||                      \
+     ( ( (entry_ptr)->ht_prev != NULL ) &&                        \
+       ( (entry_ptr)->ht_prev->ht_next != (entry_ptr) ) ) ||      \
+     ( ( (entry_ptr)->ht_next != NULL ) &&                        \
+       ( (entry_ptr)->ht_next->ht_prev != (entry_ptr) ) ) ) {     \
+    HDfprintf(stdout, "Post successful HT search SC failed.\n");  \
+}
+
+
+#define H5C__SEARCH_INDEX(cache_ptr, Addr, entry_ptr)                   \
+{                                                                       \
+    int k;                                                              \
+    int depth = 0;                                                      \
+    H5C__PRE_HT_SEARCH_SC(cache_ptr, Addr)                              \
+    k = H5C__HASH_FCN(Addr);                                            \
+    entry_ptr = ((cache_ptr)->index)[k];                                \
+    while ( ( entry_ptr ) && ( H5F_addr_ne(Addr, (entry_ptr)->addr) ) ) \
+    {                                                                   \
+        (entry_ptr) = (entry_ptr)->ht_next;                             \
+        (depth)++;                                                      \
+    }                                                                   \
+    if ( entry_ptr )                                                    \
+    {                                                                   \
+        H5C__POST_SUC_HT_SEARCH_SC(cache_ptr, entry_ptr, Addr, k)       \
+        if ( entry_ptr != ((cache_ptr)->index)[k] )                     \
+        {                                                               \
+            if ( (entry_ptr)->ht_next )                                 \
+            {                                                           \
+                (entry_ptr)->ht_next->ht_prev = (entry_ptr)->ht_prev;   \
+            }                                                           \
+            HDassert( (entry_ptr)->ht_prev != NULL );                   \
+            (entry_ptr)->ht_prev->ht_next = (entry_ptr)->ht_next;       \
+            ((cache_ptr)->index)[k]->ht_prev = (entry_ptr);             \
+            (entry_ptr)->ht_next = ((cache_ptr)->index)[k];             \
+            (entry_ptr)->ht_prev = NULL;                                \
+            ((cache_ptr)->index)[k] = (entry_ptr);                      \
+        }                                                               \
+    }                                                                   \
+}
+
+
+/* misc type definitions */
+
+struct flush_cache_test_spec
+{
+    int			entry_num;
+    int			entry_type;
+    int			entry_index;
+    hbool_t		insert_flag;
+    hbool_t		dirty_flag;
+    unsigned int	flags;
+    hbool_t		expected_loaded;
+    hbool_t		expected_cleared;
+    hbool_t		expected_flushed;
+    hbool_t		expected_destroyed;
+};
+
+
+/* global variable externs: */
+
+extern const char *FILENAME[];
+
+extern hbool_t write_permitted;
+extern hbool_t pass; /* set to false on error */
+extern hbool_t skip_long_tests;
+extern hbool_t run_full_test;
+extern const char *failure_mssg;
+
+extern test_entry_t pico_entries[NUM_PICO_ENTRIES];
+extern test_entry_t nano_entries[NUM_NANO_ENTRIES];
+extern test_entry_t micro_entries[NUM_MICRO_ENTRIES];
+extern test_entry_t tiny_entries[NUM_TINY_ENTRIES];
+extern test_entry_t small_entries[NUM_SMALL_ENTRIES];
+extern test_entry_t medium_entries[NUM_MEDIUM_ENTRIES];
+extern test_entry_t large_entries[NUM_LARGE_ENTRIES];
+extern test_entry_t huge_entries[NUM_HUGE_ENTRIES];
+extern test_entry_t monster_entries[NUM_MONSTER_ENTRIES];
+
+extern test_entry_t * entries[NUMBER_OF_ENTRY_TYPES];
+extern const int32_t max_indices[NUMBER_OF_ENTRY_TYPES];
+extern const size_t entry_sizes[NUMBER_OF_ENTRY_TYPES];
+extern const haddr_t base_addrs[NUMBER_OF_ENTRY_TYPES];
+extern const haddr_t alt_base_addrs[NUMBER_OF_ENTRY_TYPES];
+extern const char * entry_type_names[NUMBER_OF_ENTRY_TYPES];
+
+
+/* call back function declarations: */
+
+herr_t check_write_permitted(const H5F_t UNUSED * f,
+                             hid_t UNUSED dxpl_id,
+                             hbool_t * write_permitted_ptr);
+
+herr_t pico_clear(H5F_t * f, void *  thing, hbool_t dest);
+herr_t nano_clear(H5F_t * f, void *  thing, hbool_t dest);
+herr_t micro_clear(H5F_t * f, void *  thing, hbool_t dest);
+herr_t tiny_clear(H5F_t * f, void *  thing, hbool_t dest);
+herr_t small_clear(H5F_t * f, void *  thing, hbool_t dest);
+herr_t medium_clear(H5F_t * f, void *  thing, hbool_t dest);
+herr_t large_clear(H5F_t * f, void *  thing, hbool_t dest);
+herr_t huge_clear(H5F_t * f, void *  thing, hbool_t dest);
+herr_t monster_clear(H5F_t * f, void *  thing, hbool_t dest);
+
+
+herr_t pico_dest(H5F_t * f, void * thing);
+herr_t nano_dest(H5F_t * f, void * thing);
+herr_t micro_dest(H5F_t * f, void * thing);
+herr_t tiny_dest(H5F_t * f, void * thing);
+herr_t small_dest(H5F_t * f, void * thing);
+herr_t medium_dest(H5F_t * f, void * thing);
+herr_t large_dest(H5F_t * f, void * thing);
+herr_t huge_dest(H5F_t * f, void *  thing);
+herr_t monster_dest(H5F_t * f, void *  thing);
+
+
+herr_t pico_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                  haddr_t addr, void *thing);
+herr_t nano_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                  haddr_t addr, void *thing);
+herr_t micro_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                   haddr_t addr, void *thing);
+herr_t tiny_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                  haddr_t addr, void *thing);
+herr_t small_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                   haddr_t addr, void *thing);
+herr_t medium_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                    haddr_t addr, void *thing);
+herr_t large_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                   haddr_t addr, void *thing);
+herr_t huge_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                  haddr_t addr, void *thing);
+herr_t monster_flush(H5F_t *f, hid_t dxpl_id, hbool_t dest,
+                     haddr_t addr, void *thing);
+
+
+void * pico_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                 const void *udata1, void *udata2);
+void * nano_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                 const void *udata1, void *udata2);
+void * micro_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                  const void *udata1, void *udata2);
+void * tiny_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                 const void *udata1, void *udata2);
+void * small_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                  const void *udata1, void *udata2);
+void * medium_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                   const void *udata1, void *udata2);
+void * large_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                  const void *udata1, void *udata2);
+void * huge_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                 const void *udata1, void *udata2);
+void * monster_load(H5F_t *f, hid_t dxpl_id, haddr_t addr,
+                    const void *udata1, void *udata2);
+
+
+herr_t pico_size(H5F_t * f, void * thing, size_t * size_ptr);
+herr_t nano_size(H5F_t * f, void * thing, size_t * size_ptr);
+herr_t micro_size(H5F_t * f, void * thing, size_t * size_ptr);
+herr_t tiny_size(H5F_t * f, void * thing, size_t * size_ptr);
+herr_t small_size(H5F_t * f, void * thing, size_t * size_ptr);
+herr_t medium_size(H5F_t * f, void * thing, size_t * size_ptr);
+herr_t large_size(H5F_t * f, void * thing, size_t * size_ptr);
+herr_t huge_size(H5F_t * f, void * thing, size_t * size_ptr);
+herr_t monster_size(H5F_t * f, void * thing, size_t * size_ptr);
+
+/* callback table extern */
+
+extern const H5C_class_t types[NUMBER_OF_ENTRY_TYPES];
+
+
+/* function declarations: */
+
+void addr_to_type_and_index(haddr_t addr,
+                            int32_t * type_ptr,
+                            int32_t * index_ptr);
+
+#if 0 /* keep this for a while -- it may be useful */
+haddr_t type_and_index_to_addr(int32_t type,
+                               int32_t idx);
+#endif
+
+void insert_entry(H5C_t * cache_ptr,
+                  int32_t type,
+                  int32_t idx,
+                  hbool_t dirty,
+                  unsigned int flags);
+
+void rename_entry(H5C_t * cache_ptr,
+                  int32_t type,
+                  int32_t idx,
+                  hbool_t main_addr);
+
+void protect_entry(H5C_t * cache_ptr,
+                   int32_t type,
+                   int32_t idx);
+
+hbool_t entry_in_cache(H5C_t * cache_ptr,
+                       int32_t type,
+                       int32_t idx);
+
+void reset_entries(void);
+
+H5C_t * setup_cache(size_t max_cache_size, size_t min_clean_size);
+
+void row_major_scan_forward(H5C_t * cache_ptr,
+                            int32_t lag,
+                            hbool_t verbose,
+                            hbool_t reset_stats,
+                            hbool_t display_stats,
+                            hbool_t display_detailed_stats,
+                            hbool_t do_inserts,
+                            hbool_t dirty_inserts,
+                            hbool_t do_renames,
+                            hbool_t rename_to_main_addr,
+                            hbool_t do_destroys,
+                            int dirty_destroys,
+                            int dirty_unprotects);
+
+void hl_row_major_scan_forward(H5C_t * cache_ptr,
+                               int32_t max_index,
+                               hbool_t verbose,
+                               hbool_t reset_stats,
+                               hbool_t display_stats,
+                               hbool_t display_detailed_stats,
+                               hbool_t do_inserts,
+                               hbool_t dirty_inserts);
+
+void row_major_scan_backward(H5C_t * cache_ptr,
+                             int32_t lag,
+                             hbool_t verbose,
+                             hbool_t reset_stats,
+                             hbool_t display_stats,
+                             hbool_t display_detailed_stats,
+                             hbool_t do_inserts,
+                             hbool_t dirty_inserts,
+                             hbool_t do_renames,
+                             hbool_t rename_to_main_addr,
+                             hbool_t do_destroys,
+                             int dirty_destroys,
+                             int dirty_unprotects);
+
+void hl_row_major_scan_backward(H5C_t * cache_ptr,
+                                int32_t max_index,
+                                hbool_t verbose,
+                                hbool_t reset_stats,
+                                hbool_t display_stats,
+                                hbool_t display_detailed_stats,
+                                hbool_t do_inserts,
+                                hbool_t dirty_inserts);
+
+void col_major_scan_forward(H5C_t * cache_ptr,
+                            int32_t lag,
+                            hbool_t verbose,
+                            hbool_t reset_stats,
+                            hbool_t display_stats,
+                            hbool_t display_detailed_stats,
+                            hbool_t do_inserts,
+                            hbool_t dirty_inserts,
+                            int dirty_unprotects);
+
+void hl_col_major_scan_forward(H5C_t * cache_ptr,
+                               int32_t max_index,
+                               hbool_t verbose,
+                               hbool_t reset_stats,
+                               hbool_t display_stats,
+                               hbool_t display_detailed_stats,
+                               hbool_t do_inserts,
+                               hbool_t dirty_inserts,
+                               int dirty_unprotects);
+
+void col_major_scan_backward(H5C_t * cache_ptr,
+                             int32_t lag,
+                             hbool_t verbose,
+                             hbool_t reset_stats,
+                             hbool_t display_stats,
+                             hbool_t display_detailed_stats,
+                             hbool_t do_inserts,
+                             hbool_t dirty_inserts,
+                             int dirty_unprotects);
+
+void hl_col_major_scan_backward(H5C_t * cache_ptr,
+                                int32_t max_index,
+                                hbool_t verbose,
+                                hbool_t reset_stats,
+                                hbool_t display_stats,
+                                hbool_t display_detailed_stats,
+                                hbool_t do_inserts,
+                                hbool_t dirty_inserts,
+                                int dirty_unprotects);
+
+void takedown_cache(H5C_t * cache_ptr,
+                    hbool_t dump_stats,
+                    hbool_t dump_detailed_stats);
+
+void flush_cache(H5C_t * cache_ptr,
+                 hbool_t destroy_entries,
+                 hbool_t dump_stats,
+                 hbool_t dump_detailed_stats);
+
+void unprotect_entry(H5C_t * cache_ptr,
+                     int32_t type,
+                     int32_t idx,
+                     int dirty,
+                     unsigned int flags);
+
+void verify_clean(void);
+
+void verify_unprotected(void);
+