summaryrefslogtreecommitdiffstats
path: root/src/H5AC.c
blob: 19e177e83794231728b1cf7ede4d3ec5bfa768c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
/*-------------------------------------------------------------------------
 * Copyright (C) 1997	National Center for Supercomputing Applications.
 *                      All rights reserved.
 *
 *-------------------------------------------------------------------------
 *
 * Created:		hdf5cache.c
 * 			Jul  9 1997
 * 			Robb Matzke <matzke@llnl.gov>
 *
 * Purpose:		Functions in this file implement a cache for
 *			things which exist on disk.  All "things" associated
 *			with a particular HDF file share the same cache; each
 *			HDF file has it's own cache.
 *
 * Modifications:
 *
 * 	Robb Matzke, 4 Aug 1997
 *	Added calls to H5E.
 *
 *-------------------------------------------------------------------------
 */
#include <H5private.h>
#include <H5ACprivate.h>
#include <H5Eprivate.h>
#include <H5MMprivate.h>

/*
 * Sorting the cache by address before flushing is sometimes faster
 * than flushing in cache order.
 */
/* #define H5AC_SORT_BY_ADDR */

/*
 * Private file-scope variables.
 */
#define PABLO_MASK	H5AC_mask
#define INTERFACE_INIT	NULL
static int	interface_initialize_g = FALSE;		/*initialized?*/


#ifdef H5AC_SORT_BY_ADDR
static H5AC_t *current_cache_g = NULL;			/*for sorting */
#endif


/*-------------------------------------------------------------------------
 * Function:	H5AC_create
 *
 * Purpose:	Initialize the cache just after a file is opened.  The
 *		SIZE_HINT is the number of cache slots desired.  If you
 *		pass an invalid value then H5AC_NSLOTS is used.  You can
 *		turn off caching by using 1 for the SIZE_HINT value.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Jul  9 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5AC_create (H5F_t *f, intn size_hint)
{
   H5AC_t	*cache = NULL;
   FUNC_ENTER (H5AC_create, FAIL);

   assert (f);
   assert (NULL==f->shared->cache);
   if (size_hint<1) size_hint = H5AC_NSLOTS;

   f->shared->cache = cache = H5MM_xcalloc (1, sizeof (H5AC_t));
   cache->nslots = size_hint;
   cache->slot = H5MM_xcalloc (cache->nslots, sizeof (H5AC_slot_t));

   FUNC_LEAVE (SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5AC_dest
 *
 * Purpose:	Flushes all data to disk and destroys the cache.
 *		This function fails if any object are protected since the
 *		resulting file might not be consistent.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Jul  9 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5AC_dest (H5F_t *f)
{
   H5AC_t	*cache = NULL;
   FUNC_ENTER (H5AC_dest, FAIL);

   assert (f);
   assert (f->shared->cache);
   cache = f->shared->cache;
   
   if (H5AC_flush (f, NULL, NO_ADDR, TRUE)<0) {
      HRETURN_ERROR (H5E_CACHE, H5E_CANTFLUSH, FAIL);
   }

#ifdef H5AC_DEBUG
   {
      intn	i;
      for (i=0; i<cache->nslots; i++) {
	 cache->slot[i].prot = H5MM_xfree (cache->slot[i].prot);
	 cache->slot[i].aprots = 0;
	 cache->slot[i].nprots = 0;
      }
   }
#endif

   cache->slot = H5MM_xfree (cache->slot);
   cache->nslots = 0;
   f->shared->cache = cache = H5MM_xfree (cache);
   FUNC_LEAVE (SUCCEED);
}
   

/*-------------------------------------------------------------------------
 * Function:	H5AC_find_f
 *
 * Purpose:	Given an object type and the address at which that object
 *		is located in the file, return a pointer to the object.
 *		The optional UDATA1 and UDATA2 structures are passed down to
 *		the function that is responsible for loading the object into
 *		memory.
 *
 * 		The returned pointer is guaranteed to be valid until the next
 *		call to an H5AC function (if you want a pointer which is valid
 *		indefinately then see H5AC_protect()).
 *
 * 		If H5AC_DEBUG is defined then this function also
 *		checks that the requested object is not currently
 *		protected since it is illegal to modify a protected object
 *		except through the pointer returned by H5AC_protect().
 *
 * Return:	Success:	Pointer to the object.  The pointer is
 *				valid until some other cache function
 *				is called.
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Jul  9 1997
 *
 * Modifications:
 *
 * 	Robb Matzke, 4 Aug 1997
 *	Fails immediately if the cached object is at the correct address
 *	but is of the wrong type.  This happens if the caller doesn't know
 *	what type of object is at the address and calls this function with
 *	various type identifiers until one succeeds (cf., the debugger).
 *
 * 	Robb Matzke, 30 Oct 1997
 *	Keeps track of hits, misses, and flushes per object type so we have
 *	some cache performance diagnostics.
 *
 *-------------------------------------------------------------------------
 */
void *
H5AC_find_f (H5F_t *f, const H5AC_class_t *type, const haddr_t *addr,
	     const void *udata1, void *udata2)
{
   unsigned	idx;
   herr_t	status;
   void		*thing = NULL;
   herr_t	(*flush)(H5F_t*,hbool_t,const haddr_t*,void*)=NULL;
   H5AC_slot_t	*slot = NULL;
   H5AC_t	*cache = NULL;

   FUNC_ENTER (H5AC_find, NULL);

   assert (f);
   assert (f->shared->cache);
   assert (type);
   assert (type->load);
   assert (type->flush);
   assert (addr && H5F_addr_defined (addr));
   idx = H5AC_HASH (f, addr);
   cache = f->shared->cache;
   slot = cache->slot + idx;
   
   /*
    * Return right away if the item is in the cache.
    */
   if (slot->type==type && H5F_addr_eq (&(slot->addr), addr)) {
      cache->diagnostics[type->id].nhits++;
      HRETURN (slot->thing);
   }
   cache->diagnostics[type->id].nmisses++;

   /*
    * Fail if the item in the cache is at the correct address but is
    * of the wrong type.
    */
   if (slot->type && slot->type!=type && H5F_addr_eq (&(slot->addr), addr)) {
      HRETURN_ERROR (H5E_CACHE, H5E_BADTYPE, NULL);
   }

#ifdef H5AC_DEBUG
   /*
    * Check that the requested thing isn't protected, for protected things
    * can only be modified through the pointer already handed out by the
    * H5AC_protect() function.
    */
   {
      intn i;
      for (i=0; i<slot->nprots; i++) {
	 assert (H5F_addr_ne (addr, &(slot->prot[i].addr)));
      }
   }
#endif

   /*
    * Load a new thing.  If it can't be loaded, then return an error
    * without preempting anything.
    */
   if (NULL==(thing=(type->load)(f, addr, udata1, udata2))) {
      HRETURN_ERROR (H5E_CACHE, H5E_CANTLOAD, NULL);
   }

   /*
    * Free the previous cache entry if there is one.
    */
   if (slot->type) {
      flush = slot->type->flush;
      status = (flush)(f, TRUE, &(slot->addr), slot->thing);
      if (status<0) {
	 /*
	  * The old thing could not be removed from the stack.
	  * Release the new thing and fail.
	  */
	 if ((type->flush)(f, TRUE, addr, thing)<0) {
	    HRETURN_ERROR (H5E_CACHE, H5E_CANTFLUSH, NULL);
	 }
	 HRETURN_ERROR (H5E_CACHE, H5E_CANTFLUSH, NULL);
      }
      cache->diagnostics[slot->type->id].nflushes++;
   }

   /*
    * Make the cache point to the new thing.
    */
   slot->type = type;
   slot->addr = *addr;
   slot->thing = thing;

   FUNC_LEAVE (thing);
}


/*-------------------------------------------------------------------------
 * Function:	H5AC_compare
 *
 * Purpose:	Compare two hash entries by address.  Unused entries are
 *		all equal to one another and greater than all used entries.
 *
 * Return:	Success:	-1, 0, 1
 *
 *		Failure:	never fails
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Aug 12 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
#ifdef H5AC_SORT_BY_ADDR
static int
H5AC_compare (const void *_a, const void *_b)
{
   intn 	a = *((const intn *)_a);
   intn		b = *((const intn *)_b);

   assert (current_cache_g);

   if (NULL==current_cache_g->slot[a].type) {
      if (NULL==current_cache_g->slot[b].type) {
	 return 0;
      } else {
	 return -1;
      }
   } else if (NULL==current_cache_g->slot[b].type) {
      return 1;
   } else if (current_cache_g->slot[a].addr < current_cache_g->slot[b].addr) {
      return -1;
   } else if (current_cache_g->slot[a].addr > current_cache_g->slot[b].addr) {
      return 1;
   }
   return 0;
}
#endif


/*-------------------------------------------------------------------------
 * Function:	H5AC_flush
 *
 * Purpose:	Flushes (and destroys if DESTROY is non-zero) the specified
 *		entry from the cache.  If the entry TYPE is CACHE_FREE and
 *		ADDR is the null pointer then all types of entries are
 *		flushed. If TYPE is CACHE_FREE and ADDR is non-null, then
 *		whatever is cached at ADDR is flushed.  Otherwise the thing
 *		at ADDR is flushed if it is the correct type.
 *
 * 		If there are protected objects they will not be flushed.
 *		However, an attempt will be made to flush all non-protected
 *		items before this function returns failure.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL if there was a request to flush all
 *				items and something was protected.
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Jul  9 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5AC_flush (H5F_t *f, const H5AC_class_t *type, const haddr_t *addr,
	    hbool_t destroy)
{
   uintn	i;
   herr_t	status;
   herr_t	(*flush)(H5F_t*,hbool_t,const haddr_t*,void*)=NULL;
   H5AC_slot_t	*slot;
   intn		*map=NULL;
   intn		nslots;
   H5AC_t	*cache=NULL;

   FUNC_ENTER (H5AC_flush, FAIL);

   assert (f);
   assert (f->shared->cache);
   cache = f->shared->cache;

   if (!addr) {

#ifdef H5AC_SORT_BY_ADDR
      /*
       * Sort the cache entries by address since flushing them in
       * ascending order by address may be much more efficient.
       */
      map = H5MM_xmalloc (cache->nslots * sizeof(intn));
      for (i=nslots=0; i<cache->nslots; i++) {
	 if (cache->slot[i].type) map[nslots++] = i;
      }
      assert (NULL==current_cache_g);
      current_cache_g = cache;
      HDqsort (map, nslots, sizeof(intn), H5AC_compare);
      current_cache_g = NULL;
#ifdef NDEBUG
      for (i=1; i<nslots; i++) {
	 assert (H5F_addr_lt (&(cache->slot[i-1].addr),
			      &(cache->slot[i].addr)));
      }
#endif
#else
      nslots = cache->nslots;
#endif

      /*
       * Look at all cache entries.
       */
      for (i=0; i<nslots; i++) {
#ifdef H5AC_SORT_BY_ADDR
	 slot = cache->slot + map[i];
	 if (NULL==slot->type) break; /*the rest are empty*/
#else
	 slot = cache->slot + i;
	 if (NULL==slot->type) continue;
#endif
	 if (!type || type==slot->type) {
	    flush = slot->type->flush;
	    status = (flush)(f, destroy, &(slot->addr), slot->thing);
	    if (status<0) {
	       map = H5MM_xfree (map);
	       HRETURN_ERROR (H5E_CACHE, H5E_CANTFLUSH, FAIL);
	    }
	    cache->diagnostics[slot->type->id].nflushes++;
	    if (destroy) slot->type = NULL;
	 }
      }
      map = H5MM_xfree (map);

      /*
       * If there are protected object then fail.  However, everything
       * else should have been flushed.
       */
      if (cache->nprots>0) {
	 HRETURN_ERROR (H5E_CACHE, H5E_PROTECT, FAIL);
      }
      
   } else {
      i = H5AC_HASH (f, addr);
      if ((!type || cache->slot[i].type==type) &&
	  H5F_addr_eq (&(cache->slot[i].addr), addr)) {
	 /*
	  * Flush just this entry.
	  */
	 flush = cache->slot[i].type->flush;
	 status =  (flush) (f, destroy, &(cache->slot[i].addr),
			    cache->slot[i].thing);
	 if (status<0) {
	    HRETURN_ERROR (H5E_CACHE, H5E_CANTFLUSH, FAIL);
	 }
	 cache->diagnostics[cache->slot[i].type->id].nflushes++;
	 if (destroy) cache->slot[i].type = NULL;
      }
   }

   FUNC_LEAVE (SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5AC_set
 *
 * Purpose:	Adds the specified thing to the cache.  The thing need not
 *		exist on disk yet, but it must have an address and disk
 *		space reserved.
 *
 * 		If H5AC_DEBUG is defined then this function checks
 *		that the object being inserted isn't a protected object.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Jul  9 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5AC_set (H5F_t *f, const H5AC_class_t *type, const haddr_t *addr, void *thing)
{
   herr_t	status;
   uintn	idx;
   herr_t	(*flush)(H5F_t*,hbool_t,const haddr_t*,void*)=NULL;
   H5AC_slot_t	*slot = NULL;
   H5AC_t	*cache=NULL;

   FUNC_ENTER (H5AC_set, FAIL);

   assert (f);
   assert (f->shared->cache);
   assert (type);
   assert (type->flush);
   assert (addr && H5F_addr_defined (addr));
   assert (thing);
   idx = H5AC_HASH (f, addr);
   cache = f->shared->cache;
   slot = cache->slot + idx;

#ifdef H5AC_DEBUG
   {
      intn i;
      for (i=0; i<slot->nprots; i++) {
	 assert (H5F_addr_ne (addr, &(slot->prot[i].addr)));
      }
   }
#endif
   
   if (slot->type) {
      flush = slot->type->flush;
      status = (flush)(f, TRUE, &(slot->addr), slot->thing);
      if (status<0) {
	 HRETURN_ERROR (H5E_CACHE, H5E_CANTFLUSH, FAIL);
      }
      cache->diagnostics[slot->type->id].nflushes++;
   }

   slot->type = type;
   slot->addr = *addr;
   slot->thing = thing;
   cache->diagnostics[type->id].ninits++;

   FUNC_LEAVE (SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5AC_rename
 *
 * Purpose:	Use this function to notify the cache that an object's
 *		file address changed.
 *
 * 		If H5AC_DEBUG is defined then this function checks
 *		that the old and new addresses don't correspond to the
 *		address of a protected object.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Jul  9 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5AC_rename (H5F_t *f, const H5AC_class_t *type,
	     const haddr_t *old_addr, const haddr_t *new_addr)
{
   uintn	old_idx, new_idx;
   herr_t	(*flush)(H5F_t*, hbool_t, const haddr_t*, void*);
   herr_t	status;
   H5AC_t	*cache=NULL;

   FUNC_ENTER (H5AC_rename, FAIL);

   assert (f);
   assert (f->shared->cache);
   assert (type);
   assert (old_addr);
   assert (new_addr);
   old_idx = H5AC_HASH (f, old_addr);
   new_idx = H5AC_HASH (f, new_addr);
   cache = f->shared->cache;

#ifdef H5AC_DEBUG
   {
      int i;

      for (i=0; i<cache->slot[old_idx].nprots; i++) {
	 assert (H5F_addr_ne (old_addr, &(cache->slot[old_idx].prot[i].addr)));
      }
      for (i=0; i<cache->slot[new_idx].nprots; i++) {
	 assert (H5F_addr_ne (new_addr, &(cache->slot[new_idx].prot[i].addr)));
      }
   }
#endif
      
   /*
    * We don't need to do anything if the object isn't cached or if the
    * new hash value is the same as the old one.
    */
   if (cache->slot[old_idx].type!=type ||
       H5F_addr_ne (&(cache->slot[old_idx].addr), old_addr)) {
      HRETURN (SUCCEED);
   }
   if (old_idx==new_idx) {
      cache->slot[old_idx].addr = *new_addr;
      HRETURN (SUCCEED);
   }
      
   /*
    * Free the item from the destination cache line.
    */
   if (cache->slot[new_idx].type) {
      flush = cache->slot[new_idx].type->flush;
      status = (flush)(f, TRUE, &(cache->slot[new_idx].addr),
		       cache->slot[new_idx].thing);
      if (status<0) {
	 HRETURN_ERROR (H5E_CACHE, H5E_CANTFLUSH, FAIL);
      }
      cache->diagnostics[cache->slot[new_idx].type->id].nflushes++;
   }

   /*
    * Move the source to the destination (it might not be cached)
    */
   cache->slot[new_idx].type = cache->slot[old_idx].type;
   cache->slot[new_idx].addr = *new_addr;
   cache->slot[new_idx].thing = cache->slot[old_idx].thing;
   cache->slot[old_idx].type = NULL;

   FUNC_LEAVE (SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5AC_protect
 *
 * Purpose:	Similar to H5AC_find() except the object is removed from
 *		the cache and given to the caller, preventing other parts
 *		of the program from modifying the protected object or
 *		preempting it from the cache.
 *
 * 		The caller must call H5AC_unprotect() when finished with
 *		the pointer.
 *
 * 		If H5AC_DEBUG is defined then we check that the
 *		requested object isn't already protected.
 *
 * Return:	Success:	Ptr to the object.
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Sep  2 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
void *
H5AC_protect (H5F_t *f, const H5AC_class_t *type, const haddr_t *addr,
	      const void *udata1, void *udata2)
{
   int		idx;
   void		*thing = NULL;
   H5AC_t	*cache = NULL;
   H5AC_slot_t	*slot = NULL;

#ifdef H5AC_DEBUG
   static	ncalls = 0;
   if (0==ncalls++) {
      fprintf (stderr, "HDF5-DIAG: debugging cache (expensive)\n");
   }
#endif
   
   FUNC_ENTER (H5AC_protect, NULL);

   /* check args */
   assert (f);
   assert (f->shared->cache);
   assert (type);
   assert (type->load);
   assert (type->flush);
   assert (addr && H5F_addr_defined (addr));
   idx = H5AC_HASH (f, addr);
   cache = f->shared->cache;
   slot = cache->slot+idx;

   if (slot->type==type && H5F_addr_eq (&(slot->addr), addr)) {
      /*
       * The object is already cached; simply remove it from the cache.
       */
      cache->diagnostics[slot->type->id].nhits++;
      thing = slot->thing;
      slot->type = NULL;
      H5F_addr_undef (&(slot->addr));
      slot->thing = NULL;

   } else if (slot->type && H5F_addr_eq (&(slot->addr), addr)) {
      /*
       * Right address but wrong object type.
       */
      HRETURN_ERROR (H5E_CACHE, H5E_BADTYPE, NULL);
	      
   } else {
#ifdef H5AC_DEBUG
      /*
       * Check that the requested thing isn't protected, for protected things
       * can only be modified through the pointer already handed out by the
       * H5AC_protect() function.
       */
      intn i;
      for (i=0; i<slot->nprots; i++) {
	 assert (H5F_addr_ne (addr, &(slot->prot[i].addr)));
      }
#endif

      /*
       * Load a new thing.  If it can't be loaded, then return an error
       * without preempting anything.
       */
      cache->diagnostics[type->id].nmisses++;
      if (NULL==(thing=(type->load)(f, addr, udata1, udata2))) {
	 HRETURN_ERROR (H5E_CACHE, H5E_CANTLOAD, NULL);
      }
   }

#ifdef H5AC_DEBUG
   /*
    * Add the protected object to the protect debugging fields of the
    * cache.
    */
   if (slot->nprots>=slot->aprots) {
      slot->aprots += 10;
      slot->prot = H5MM_xrealloc (slot->prot,
				  slot->aprots * sizeof(H5AC_prot_t));
   }
   slot->prot[slot->nprots].type = type;
   slot->prot[slot->nprots].addr = *addr;
   slot->prot[slot->nprots].thing = thing;
   slot->nprots += 1;
#endif

   cache->nprots += 1;
   FUNC_LEAVE (thing);
}


/*-------------------------------------------------------------------------
 * Function:	H5AC_unprotect
 *
 * Purpose:	This function should be called to undo the effect of
 *		H5AC_protect().  The TYPE and ADDR arguments should be the
 *		same as the corresponding call to H5AC_protect() and the
 *		THING argument should be the value returned by H5AC_protect().
 *
 * 		If H5AC_DEBUG is defined then this function fails
 *		if the TYPE and ADDR arguments are not what was used when the
 *		object was protected or if the object was never protected.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Sep  2 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5AC_unprotect (H5F_t *f, const H5AC_class_t *type, const haddr_t *addr,
		void *thing)
{
   herr_t	status;
   uintn	idx;
   herr_t	(*flush)(H5F_t*,hbool_t,const haddr_t*,void*)=NULL;
   H5AC_t	*cache = NULL;
   H5AC_slot_t	*slot = NULL;
   
   FUNC_ENTER (H5AC_unprotect, FAIL);

   /* check args */
   assert (f);
   assert (f->shared->cache);
   assert (type);
   assert (type->flush);
   assert (addr && H5F_addr_defined (addr));
   assert (thing);
   idx = H5AC_HASH (f, addr);
   cache = f->shared->cache;
   slot = cache->slot + idx;

   /*
    * Flush any object already in the cache at that location.  It had
    * better not be another copy of the protected object.
    */
   if (slot->type) {
      assert (H5F_addr_ne (&(slot->addr), addr));
      flush = slot->type->flush;
      status = (flush)(f, TRUE, &(slot->addr), slot->thing);
      if (status<0) {
	 HRETURN_ERROR (H5E_CACHE, H5E_CANTFLUSH, FAIL);
      }
      cache->diagnostics[slot->type->id].nflushes++;
   }

#ifdef H5AC_DEBUG
   /*
    * Remove the object's protect data to indicate that it is no longer
    * protected.
    */
   {
      int found, i;
      for (i=0,found=FALSE; i<slot->nprots && !found; i++) {
	 if (H5F_addr_eq (addr, &(slot->prot[i].addr))) {
	    assert (slot->prot[i].type==type);
	    HDmemmove (slot->prot+i, slot->prot+i+1,
		       ((slot->nprots-i)-1) * sizeof(H5AC_prot_t));
	    slot->nprots -= 1;
	    found = TRUE;
	 }
      }
      assert (found);
   }
#endif

   /*
    * Insert the object back into the cache; it is no longer protected.
    */
   slot->type = type;
   slot->addr = *addr;
   slot->thing = thing;
   cache->nprots -= 1;

   FUNC_LEAVE (SUCCEED);
}



/*-------------------------------------------------------------------------
 * Function:	H5AC_debug
 *
 * Purpose:	Prints debugging info about the cache.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *              Thursday, October 30, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5AC_debug (H5F_t *f)
{
   H5AC_subid_t	i;
   char		s[32], ascii[32];
   H5AC_t	*cache = f->shared->cache;
   double	miss_rate;

   FUNC_ENTER (H5AC_debug, FAIL);

   fprintf (stderr, "HDF5-DIAG: cache diagnostics for %s\n", f->name);
   fprintf (stderr, "   %18s  %8s %8s %8s %8s+%-8s\n",
	    "", "Hits", "Misses", "MissRate", "Inits", "Flushes");
   
   for (i=0; i<H5AC_NTYPES; i++) {

      switch (i) {
      case H5AC_BT_ID:
	 strcpy (s, "B-tree nodes");
	 break;
      case H5AC_SNODE_ID:
	 strcpy (s, "symbol table nodes");
	 break;
      case H5AC_HEAP_ID:
	 strcpy (s, "heaps");
	 break;
      case H5AC_OHDR_ID:
	 strcpy (s, "object headers");
	 break;
      default:
	 sprintf (s, "unknown id %d", i);
      }

      if (cache->diagnostics[i].nhits) {
	 miss_rate = 100.0 * cache->diagnostics[i].nmisses /
		     cache->diagnostics[i].nhits;
      } else {
	 miss_rate = 0.0;
      }

      if (miss_rate>100) {
	 sprintf (ascii, "%7d%%", (int)(miss_rate+0.5));
      } else {
	 sprintf (ascii, "%7.2f%%", miss_rate);
      }
      fprintf (stderr, "   %18s: %8d %8d %7s %8d%+-9d\n", s,
	       cache->diagnostics[i].nhits,
	       cache->diagnostics[i].nmisses,
	       ascii,
	       cache->diagnostics[i].ninits,
	       cache->diagnostics[i].nflushes-cache->diagnostics[i].ninits);
   }

   FUNC_LEAVE (SUCCEED);
}