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
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* 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 COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#define H5PL_PACKAGE /*suppress error about including H5PLpkg */
/****************/
/* Module Setup */
/****************/
/* Interface initialization */
#define H5_INTERFACE_INIT_FUNC H5PL__init_interface
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5MMprivate.h" /* Memory management */
#include "H5PLpkg.h" /* Plugin */
#include "H5Zprivate.h" /* Filter pipeline */
/****************/
/* Local Macros */
/****************/
#ifdef H5_HAVE_WIN32_API
#define H5PL_EXPAND_ENV_VAR \
{ \
long bufCharCount; \
char *tempbuf; \
if (NULL == (tempbuf = (char *)H5MM_malloc(H5PL_EXPAND_BUFFER_SIZE))) \
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for expanded path") \
if ((bufCharCount = ExpandEnvironmentStringsA(dl_path, tempbuf, H5PL_EXPAND_BUFFER_SIZE)) > \
H5PL_EXPAND_BUFFER_SIZE) { \
tempbuf = (char *)H5MM_xfree(tempbuf); \
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "expanded path is too long") \
} \
if (bufCharCount == 0) { \
tempbuf = (char *)H5MM_xfree(tempbuf); \
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTGET, FAIL, "failed to expand path") \
} \
dl_path = (char *)H5MM_xfree(dl_path); \
dl_path = tempbuf; \
}
#else
#define H5PL_EXPAND_ENV_VAR
#endif /* H5_HAVE_WIN32_API */
/****************************/
/* Macros for supporting
* both Windows and Unix */
/****************************/
/* Windows support
*
* SPECIAL WINDOWS NOTE
*
* Some of the Win32 API functions expand to fooA or fooW depending on
* whether UNICODE or _UNICODE are defined. You MUST explicitly use
* the A version of the functions to force char * behavior until we
* work out a scheme for proper Windows Unicode support.
*
* If you do not do this, people will be unable to incorporate our
* source code into their own CMake builds if they define UNICODE.
*/
#ifdef H5_HAVE_WIN32_API
#define H5PL_PATH_SEPARATOR ";"
/* Handle for dynamic library */
#define H5PL_HANDLE HINSTANCE
/* Get a handle to a plugin library. Windows: TEXT macro handles Unicode strings */
#define H5PL_OPEN_DLIB(S) LoadLibraryExA(S, NULL, LOAD_WITH_ALTERED_SEARCH_PATH)
/* Get the address of a symbol in dynamic library */
#define H5PL_GET_LIB_FUNC(H, N) GetProcAddress(H, N)
/* Close dynamic library */
#define H5PL_CLOSE_LIB(H) FreeLibrary(H)
/* Clear error - nothing to do */
#define H5PL_CLR_ERROR
/* maximum size for expanding env vars */
#define H5PL_EXPAND_BUFFER_SIZE 32767
typedef const void *(__cdecl *H5PL_get_plugin_info_t)(void);
/* Unix support */
#else /* H5_HAVE_WIN32_API */
#define H5PL_PATH_SEPARATOR ":"
/* Handle for dynamic library */
#define H5PL_HANDLE void *
/* Get a handle to a plugin library. Windows: TEXT macro handles Unicode strings */
#define H5PL_OPEN_DLIB(S) dlopen(S, RTLD_LAZY | RTLD_LOCAL)
/* Get the address of a symbol in dynamic library */
#define H5PL_GET_LIB_FUNC(H, N) dlsym(H, N)
/* Close dynamic library */
#define H5PL_CLOSE_LIB(H) dlclose(H)
/* Clear error */
#define H5PL_CLR_ERROR HERROR(H5E_PLUGIN, H5E_CANTGET, "can't dlopen:%s", dlerror())
typedef const void *(*H5PL_get_plugin_info_t)(void);
#endif /* H5_HAVE_WIN32_API */
/* Whether to preload pathnames for plugin libraries */
#define H5PL_DEFAULT_PATH H5_DEFAULT_PLUGINDIR
/* Special symbol to indicate no plugin loading */
#define H5PL_NO_PLUGIN "::"
/******************/
/* Local Typedefs */
/******************/
/* Type for the list of info for opened plugin libraries */
typedef struct H5PL_table_t {
H5PL_type_t pl_type; /* plugin type */
int pl_id; /* ID for the plugin */
H5PL_HANDLE handle; /* plugin handle */
} H5PL_table_t;
/********************/
/* Local Prototypes */
/********************/
static herr_t H5PL__init_path_table(void);
static htri_t H5PL__find(H5PL_type_t plugin_type, int type_id, char *dir, const void **info);
static htri_t H5PL__open(H5PL_type_t pl_type, char *libname, int plugin_id, const void **pl_info);
static htri_t H5PL__search_table(H5PL_type_t plugin_type, int type_id, const void **info);
static herr_t H5PL__close(H5PL_HANDLE handle);
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
/* Table for opened plugin libraries */
static size_t H5PL_table_alloc_g = 0;
static size_t H5PL_table_used_g = 0;
static H5PL_table_t *H5PL_table_g = NULL;
/* Table of location paths for plugin libraries */
static char * H5PL_path_table_g[H5PL_MAX_PATH_NUM];
static size_t H5PL_num_paths_g = 0;
static hbool_t H5PL_path_found_g = FALSE;
/* Enable all plugin libraries */
static unsigned int H5PL_plugin_g = H5PL_ALL_PLUGIN;
/*--------------------------------------------------------------------------
NAME
H5PL__init_interface -- Initialize interface-specific information
USAGE
herr_t H5PL__init_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Initializes any interface-specific data or routines.
--------------------------------------------------------------------------*/
static herr_t
H5PL__init_interface(void)
{
char *preload_path;
FUNC_ENTER_STATIC_NOERR
/* Retrieve pathnames from HDF5_PLUGIN_PRELOAD if the user sets it
* to tell the library to load plugin libraries without search.
*/
if (NULL != (preload_path = HDgetenv("HDF5_PLUGIN_PRELOAD"))) {
/* Special symbal "::" means no plugin during data reading. */
if (!HDstrcmp(preload_path, H5PL_NO_PLUGIN))
H5PL_plugin_g = 0;
} /* end if */
FUNC_LEAVE_NOAPI(SUCCEED)
} /* end H5PL__init_interface() */
/*-------------------------------------------------------------------------
* Function: H5PLset_loading_state
*
* Purpose: Control the loading of dynamic plugin types.
*
* This function will not allow plugin types if the pathname from the HDF5_PLUGIN_PRELOAD
* environment variable is set to the special "::" string.
*
* plugin bit = 0, will prevent the use of that dynamic plugin type.
* plugin bit = 1, will allow the use of that dynamic plugin type.
*
* H5PL_TYPE_FILTER changes just dynamic filters
* A H5PL_ALL_PLUGIN will enable all dynamic plugin types
* A zero value will disable all dynamic plugin types
*
* Return: Non-negative or success
*
*-------------------------------------------------------------------------
*/
herr_t
H5PLset_loading_state(unsigned int plugin_type)
{
char * preload_path;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "Iu", plugin_type);
/* change the bit value of the requested plugin type(s) */
H5PL_plugin_g = plugin_type;
/* check if special ENV variable is set and disable all plugin types */
if (NULL != (preload_path = HDgetenv("HDF5_PLUGIN_PRELOAD"))) {
/* Special symbol "::" means no plugin during data reading. */
if (!HDstrcmp(preload_path, H5PL_NO_PLUGIN))
H5PL_plugin_g = 0;
}
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLset_loading_state() */
/*-------------------------------------------------------------------------
* Function: H5PLget_loading_state
*
* Purpose: Query state of the loading of dynamic plugin types.
*
* This function will return the state of the global flag.
*
* Return: Zero if all plugin types are disabled, negative if all
* plugin types are enabled, positive if one or more of the plugin types are enabled.
*
*-------------------------------------------------------------------------
*/
herr_t
H5PLget_loading_state(unsigned int *plugin_type)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "*Iu", plugin_type);
if (plugin_type)
*plugin_type = H5PL_plugin_g;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLget_loading_state() */
/*-------------------------------------------------------------------------
* Function: H5PL_term_interface
*
* Purpose: Terminate the H5PL interface: release all memory, reset all
* global variables to initial values. This only happens if all
* types have been destroyed from other interfaces.
*
* Return: Success: Positive if any action was taken that might
* affect some other interface; zero otherwise.
*
* Failure: Negative.
*
* Programmer: Raymond Lu
* 20 February 2013
*
*-------------------------------------------------------------------------
*/
int
H5PL_term_interface(void)
{
int i = 0;
FUNC_ENTER_NOAPI_NOINIT_NOERR
if (H5_interface_initialize_g) {
size_t u; /* Local index variable */
/* Close opened dynamic libraries */
for (u = 0; u < H5PL_table_used_g; u++)
H5PL__close((H5PL_table_g[u]).handle);
/* Free the table of dynamic libraries */
H5PL_table_g = (H5PL_table_t *)H5MM_xfree(H5PL_table_g);
H5PL_table_used_g = H5PL_table_alloc_g = 0;
/* Free the table of search paths */
for (u = 0; u < H5PL_num_paths_g; u++)
if (H5PL_path_table_g[u])
H5PL_path_table_g[u] = (char *)H5MM_xfree(H5PL_path_table_g[u]);
H5PL_num_paths_g = 0;
H5PL_path_found_g = FALSE;
H5_interface_initialize_g = 0;
i = 1;
} /* end if */
FUNC_LEAVE_NOAPI(i)
} /* end H5PL_term_interface() */
/*-------------------------------------------------------------------------
* Function: H5PL_load
*
* Purpose: Given the plugin type and identifier, this function searches
* and/or loads a dynamic plugin library first among the already
* opened libraries then in the designated location paths.
*
* Return: Non-NULL on success/NULL on failure
*
* Programmer: Raymond Lu
* 13 February 2013
*
*-------------------------------------------------------------------------
*/
const void *
H5PL_load(H5PL_type_t type, int id)
{
htri_t found; /* Whether the plugin was found */
const void *plugin_info = NULL;
const void *ret_value = NULL;
FUNC_ENTER_NOAPI(NULL)
switch (type) {
case H5PL_TYPE_FILTER:
if ((H5PL_plugin_g & H5PL_FILTER_PLUGIN) == 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTLOAD, NULL,
"required dynamically loaded plugin filter '%d' is not available", id)
break;
case H5PL_TYPE_ERROR:
case H5PL_TYPE_NONE:
default:
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTLOAD, NULL,
"required dynamically loaded plugin '%d' is not valid", id)
} /* end switch */
/* Initialize the location paths for dynamic libraries, if they aren't
* already set up.
*/
if (FALSE == H5PL_path_found_g)
if (H5PL__init_path_table() < 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTINIT, NULL, "can't initialize search path table")
/* Search in the table of already loaded plugin libraries */
if ((found = H5PL__search_table(type, id, &plugin_info)) < 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTGET, NULL, "search in table failed")
/* If not found, iterate through the path table to find the right dynamic library */
if (!found) {
size_t i; /* Local index variable */
for (i = 0; i < H5PL_num_paths_g; i++) {
if ((found = H5PL__find(type, id, H5PL_path_table_g[i], &plugin_info)) < 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTGET, NULL, "search in paths failed")
/* Break out if found */
if (found) {
HDassert(plugin_info);
break;
} /* end if */
} /* end for */
} /* end if */
/* Check if we found the plugin */
if (found)
ret_value = plugin_info;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5PL_load() */
/*-------------------------------------------------------------------------
* Function: H5PLappend
*
* Purpose: Insert a plugin path at the end of the list.
*
* Return: Non-negative or success.
*
*-------------------------------------------------------------------------
*/
herr_t
H5PLappend(const char *plugin_path)
{
herr_t ret_value = SUCCEED; /* Return value */
char * dl_path = NULL;
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "*s", plugin_path);
if (H5PL_num_paths_g == H5PL_MAX_PATH_NUM)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "too many directories in path for table")
if (NULL == plugin_path)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no path provided")
if (NULL == (dl_path = H5MM_strdup(plugin_path)))
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
H5PL_EXPAND_ENV_VAR
H5PL_path_table_g[H5PL_num_paths_g] = dl_path;
H5PL_num_paths_g++;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLappend() */
/*-------------------------------------------------------------------------
* Function: H5PLprepend
*
* Purpose: Insert a plugin path at the beginning of the list.
*
* Return: Non-negative or success.
*
*-------------------------------------------------------------------------
*/
herr_t
H5PLprepend(const char *plugin_path)
{
herr_t ret_value = SUCCEED; /* Return value */
char * dl_path = NULL;
unsigned int plindex;
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "*s", plugin_path);
if (H5PL_num_paths_g == H5PL_MAX_PATH_NUM)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "too many directories in path for table")
if (NULL == plugin_path)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no path provided")
if (NULL == (dl_path = H5MM_strdup(plugin_path)))
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
H5PL_EXPAND_ENV_VAR
for (plindex = (unsigned int)H5PL_num_paths_g; plindex > 0; plindex--)
H5PL_path_table_g[plindex] = H5PL_path_table_g[plindex - 1];
H5PL_path_table_g[0] = dl_path;
H5PL_num_paths_g++;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLprepend() */
/*-------------------------------------------------------------------------
* Function: H5PLreplace
*
* Purpose: Replace the path at the specified index.
*
* Return: Non-negative or success.
*
*-------------------------------------------------------------------------
*/
herr_t
H5PLreplace(const char *plugin_path, unsigned int index)
{
herr_t ret_value = SUCCEED; /* Return value */
char * dl_path = NULL;
FUNC_ENTER_API(FAIL)
H5TRACE2("e", "*sIu", plugin_path, index);
if (NULL == plugin_path)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no path provided")
if (index >= H5PL_MAX_PATH_NUM)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "index path out of bounds for table")
if (NULL == (dl_path = H5MM_strdup(plugin_path)))
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
H5PL_EXPAND_ENV_VAR
if (H5PL_path_table_g[index])
H5PL_path_table_g[index] = (char *)H5MM_xfree(H5PL_path_table_g[index]);
H5PL_path_table_g[index] = dl_path;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLreplace() */
/*-------------------------------------------------------------------------
* Function: H5PLinsert
*
* Purpose: Insert a plugin path at the specified index, moving other paths after the index.
*
* Return: Non-negative or success.
*
*-------------------------------------------------------------------------
*/
herr_t
H5PLinsert(const char *plugin_path, unsigned int index)
{
herr_t ret_value = SUCCEED; /* Return value */
char * dl_path = NULL;
unsigned int plindex;
FUNC_ENTER_API(FAIL)
H5TRACE2("e", "*sIu", plugin_path, index);
if (H5PL_num_paths_g == H5PL_MAX_PATH_NUM)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "too many directories in path for table")
if (NULL == plugin_path)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no path provided")
if (index >= H5PL_MAX_PATH_NUM)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "index path out of bounds for table")
if (NULL == (dl_path = H5MM_strdup(plugin_path)))
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
H5PL_EXPAND_ENV_VAR
for (plindex = (unsigned int)H5PL_num_paths_g; plindex > index; plindex--)
H5PL_path_table_g[plindex] = H5PL_path_table_g[plindex - 1];
H5PL_path_table_g[index] = dl_path;
H5PL_num_paths_g++;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLinsert() */
/*-------------------------------------------------------------------------
* Function: H5PLremove
*
* Purpose: Remove the plugin path at the specifed index and compacting the list.
*
* Return: Non-negative or success.
*
*-------------------------------------------------------------------------
*/
herr_t
H5PLremove(unsigned int index)
{
herr_t ret_value = SUCCEED; /* Return value */
unsigned int plindex;
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "Iu", index);
if (H5PL_num_paths_g == 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "no directories in table")
if (index >= H5PL_MAX_PATH_NUM)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "index path out of bounds for table")
if (NULL == H5PL_path_table_g[index])
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no directory path at index")
H5PL_path_table_g[index] = (char *)H5MM_xfree(H5PL_path_table_g[index]);
H5PL_num_paths_g--;
for (plindex = index; plindex < (unsigned int)H5PL_num_paths_g; plindex++)
H5PL_path_table_g[plindex] = H5PL_path_table_g[plindex + 1];
H5PL_path_table_g[H5PL_num_paths_g] = NULL;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLremove() */
/*-------------------------------------------------------------------------
* Function: H5PLget
*
* Purpose: Query the plugin path at the specified index.
*
* Return: Success: The length of path.
*
* If `pathname' is non-NULL then write up to `size' bytes into that
* buffer and always return the length of the pathname.
* Otherwise `size' is ignored and the function does not store the pathname,
* just returning the number of characters required to store the pathname.
* If an error occurs then the buffer pointed to by `pathname' (NULL or non-NULL)
* is unchanged and the function returns a negative value.
* If a zero is returned for the name's length, then there is no pathname
* associated with the index.
*
*-------------------------------------------------------------------------
*/
ssize_t
H5PLget(unsigned int index, char *pathname /*out*/, size_t size)
{
ssize_t ret_value = 0; /* Return value */
size_t len = 0; /* Length of pathname */
char * dl_path = NULL;
FUNC_ENTER_API(FAIL)
H5TRACE3("Zs", "Iuxz", index, pathname, size);
if (H5PL_num_paths_g == 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "no directories in table")
if (index >= H5PL_MAX_PATH_NUM)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "index path out of bounds for table")
if (NULL == (dl_path = H5PL_path_table_g[index]))
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "no directory path at index")
len = HDstrlen(dl_path);
if (pathname) {
HDstrncpy(pathname, dl_path, MIN((size_t)(len + 1), size));
if ((size_t)len >= size)
pathname[size - 1] = '\0';
} /* end if */
/* Set return value */
ret_value = (ssize_t)len;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLget() */
/*-------------------------------------------------------------------------
* Function: H5PLsize
*
* Purpose: Query the size of the current list of plugin paths.
*
* Return: Plugin path size
*
*-------------------------------------------------------------------------
*/
herr_t
H5PLsize(unsigned int *listsize)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "*Iu", listsize);
*listsize = (unsigned int)H5PL_num_paths_g;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5PLsize() */
/*-------------------------------------------------------------------------
* Function: H5PL__init_path_table
*
* Purpose: Initialize the path table.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* 18 March 2013
*
*-------------------------------------------------------------------------
*/
static herr_t
H5PL__init_path_table(void)
{
char * dl_path = NULL;
char * origin_dl_path;
char * dir;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_STATIC
/* Retrieve paths from HDF5_PLUGIN_PATH if the user sets it
* or from the default paths if it isn't set.
*/
origin_dl_path = HDgetenv("HDF5_PLUGIN_PATH");
if (NULL == origin_dl_path)
dl_path = H5MM_strdup(H5PL_DEFAULT_PATH);
else
dl_path = H5MM_strdup(origin_dl_path);
if (NULL == dl_path)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
H5PL_EXPAND_ENV_VAR
/* Put paths in the path table. They are separated by ":" */
dir = HDstrtok(dl_path, H5PL_PATH_SEPARATOR);
while (dir) {
/* Check for too many directories in path */
if (H5PL_num_paths_g == H5PL_MAX_PATH_NUM)
HGOTO_ERROR(H5E_PLUGIN, H5E_NOSPACE, FAIL, "too many directories in path for table")
if (NULL == (H5PL_path_table_g[H5PL_num_paths_g] = H5MM_strdup(dir)))
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
H5PL_num_paths_g++;
dir = HDstrtok(NULL, H5PL_PATH_SEPARATOR);
} /* end while */
H5PL_path_found_g = TRUE;
done:
if (dl_path)
dl_path = (char *)H5MM_xfree(dl_path);
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5PL__init_path_table() */
/*-------------------------------------------------------------------------
* Function: H5PL__find
*
* Purpose: Given a path, this function opens the directory and envokes
* another function to go through all files to find the right
* plugin library. Two function definitions are for Unix and
* Windows.
*
* Return: TRUE on success,
* FALSE on not found,
* negative on failure
*
* Programmer: Raymond Lu
* 13 February 2013
*
*-------------------------------------------------------------------------
*/
#ifndef H5_HAVE_WIN32_API
static htri_t
H5PL__find(H5PL_type_t plugin_type, int type_id, char *dir, const void **info)
{
char * pathname = NULL;
DIR * dirp = NULL;
struct dirent *dp;
htri_t ret_value = FALSE;
FUNC_ENTER_STATIC
/* Open the directory */
if (!(dirp = HDopendir(dir)))
HGOTO_ERROR(H5E_PLUGIN, H5E_OPENERROR, FAIL, "can't open directory: %s", dir)
/* Iterates through all entries in the directory to find the right plugin library */
while (NULL != (dp = HDreaddir(dirp))) {
/* The library we are looking for should be called libxxx.so... on Unix
* or libxxx.xxx.dylib on Mac.
*/
#ifndef __CYGWIN__
if (!HDstrncmp(dp->d_name, "lib", (size_t)3) &&
(HDstrstr(dp->d_name, ".so") || HDstrstr(dp->d_name, ".dylib"))) {
#else
if (!HDstrncmp(dp->d_name, "cyg", (size_t)3) && HDstrstr(dp->d_name, ".dll")) {
#endif
h5_stat_t my_stat;
size_t pathname_len;
htri_t found_in_dir;
/* Allocate & initialize the path name */
pathname_len = HDstrlen(dir) + HDstrlen(dp->d_name) + 2;
if (NULL == (pathname = (char *)H5MM_malloc(pathname_len)))
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
HDsnprintf(pathname, pathname_len, "%s/%s", dir, dp->d_name);
/* Get info for directory entry */
if (HDstat(pathname, &my_stat) == -1)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't stat file: %s", HDstrerror(errno))
/* If it is a directory, skip it */
if (S_ISDIR(my_stat.st_mode))
continue;
/* Attempt to open the dynamic library as a filter library */
if ((found_in_dir = H5PL__open(plugin_type, pathname, type_id, info)) < 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTGET, FAIL, "search in directory failed")
if (found_in_dir)
HGOTO_DONE(TRUE) /* Indicate success */
pathname = (char *)H5MM_xfree(pathname);
} /* end if */
} /* end while */
done:
if (dirp)
if (HDclosedir(dirp) < 0)
HDONE_ERROR(H5E_FILE, H5E_CLOSEERROR, FAIL, "can't close directory: %s", HDstrerror(errno))
pathname = (char *)H5MM_xfree(pathname);
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5PL__find() */
#else /* H5_HAVE_WIN32_API */
static htri_t
H5PL__find(H5PL_type_t plugin_type, int type_id, char *dir, const void **info)
{
WIN32_FIND_DATAA fdFile;
HANDLE hFind;
char * pathname = NULL;
char service[2048];
htri_t ret_value = FALSE;
FUNC_ENTER_STATIC
/* Specify a file mask. *.* = We want everything! */
sprintf(service, "%s\\*.dll", dir);
if ((hFind = FindFirstFileA(service, &fdFile)) == INVALID_HANDLE_VALUE)
HGOTO_ERROR(H5E_PLUGIN, H5E_OPENERROR, FAIL, "can't open directory")
do {
/* Find first file will always return "."
* and ".." as the first two directories.
*/
if (HDstrcmp(fdFile.cFileName, ".") != 0 && HDstrcmp(fdFile.cFileName, "..") != 0) {
size_t pathname_len;
htri_t found_in_dir;
/* Allocate & initialize the path name */
pathname_len = HDstrlen(dir) + HDstrlen(fdFile.cFileName) + 2;
if (NULL == (pathname = (char *)H5MM_malloc(pathname_len)))
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTALLOC, FAIL, "can't allocate memory for path")
HDsnprintf(pathname, pathname_len, "%s\\%s", dir, fdFile.cFileName);
/* Is the entity a File or Folder? */
if (fdFile.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
continue;
if ((found_in_dir = H5PL__open(plugin_type, pathname, type_id, info)) < 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTGET, FAIL, "search in directory failed")
if (found_in_dir)
HGOTO_DONE(TRUE) /* Indicate success */
pathname = (char *)H5MM_xfree(pathname);
} /* end if */
} while (FindNextFileA(hFind, &fdFile)); /* Find the next file. */
done:
if (hFind)
FindClose(hFind);
if (pathname)
pathname = (char *)H5MM_xfree(pathname);
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5PL__find() */
#endif /* H5_HAVE_WIN32_API */
/*-------------------------------------------------------------------------
* Function: H5PL__open
*
* Purpose: Iterates through all files to find the right plugin library.
* It loads the dynamic plugin library and keeps it on the list
* of loaded libraries.
*
* Return: TRUE on success,
* FALSE on not found,
* negative on failure
*
* Programmer: Raymond Lu
* 13 February 2013
*
*-------------------------------------------------------------------------
*/
/* NOTE: We turn off -Wpedantic in gcc to quiet a warning about converting
* object pointers to function pointers, which is undefined in ANSI C.
* This is basically unavoidable due to the nature of dlsym() and *is*
* defined in POSIX, so it's fine.
*
* This pragma only needs to surround the assignment of the
* get_plugin_info function pointer, but early (4.4.7, at least) gcc
* only allows diagnostic pragmas to be toggled outside of functions.
*/
H5_GCC_DIAG_OFF("pedantic")
static htri_t
H5PL__open(H5PL_type_t pl_type, char *libname, int pl_id, const void **pl_info)
{
H5PL_HANDLE handle = NULL;
htri_t ret_value = FALSE;
FUNC_ENTER_STATIC
/* There are different reasons why a library can't be open, e.g. wrong architecture.
* simply continue if we can't open it.
*/
if (NULL == (handle = H5PL_OPEN_DLIB(libname))) {
H5PL_CLR_ERROR; /* clear error */
} /* end if */
else {
H5PL_get_plugin_info_t get_plugin_info = NULL;
/* Return a handle for the function H5PLget_plugin_info in the dynamic library.
* The plugin library is suppose to define this function.
*/
if (NULL ==
(get_plugin_info = (H5PL_get_plugin_info_t)H5PL_GET_LIB_FUNC(handle, "H5PLget_plugin_info"))) {
if (H5PL__close(handle) < 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CLOSEERROR, FAIL, "can't close dynamic library")
} /* end if */
else {
const H5Z_class2_t *plugin_info;
/* Invoke H5PLget_plugin_info to verify this is the right library we are looking for.
* Move on if it isn't.
*/
if (NULL == (plugin_info = (const H5Z_class2_t *)(*get_plugin_info)())) {
if (H5PL__close(handle) < 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CLOSEERROR, FAIL, "can't close dynamic library")
HGOTO_ERROR(H5E_PLUGIN, H5E_CANTGET, FAIL, "can't get plugin info")
} /* end if */
/* Successfully found plugin library, check if it's the right one */
if (plugin_info->id == pl_id) {
/* Expand the table if it is too small */
if (H5PL_table_used_g >= H5PL_table_alloc_g) {
size_t n = MAX(H5Z_MAX_NFILTERS, 2 * H5PL_table_alloc_g);
H5PL_table_t *table =
(H5PL_table_t *)H5MM_realloc(H5PL_table_g, n * sizeof(H5PL_table_t));
if (!table)
HGOTO_ERROR(H5E_RESOURCE, H5E_CANTALLOC, FAIL,
"unable to extend dynamic library table")
H5PL_table_g = table;
H5PL_table_alloc_g = n;
} /* end if */
(H5PL_table_g[H5PL_table_used_g]).handle = handle;
(H5PL_table_g[H5PL_table_used_g]).pl_type = pl_type;
(H5PL_table_g[H5PL_table_used_g]).pl_id = plugin_info->id;
H5PL_table_used_g++;
/* Set the plugin info to return */
*pl_info = (const void *)plugin_info;
/* Indicate success */
ret_value = TRUE;
} /* end if */
else if (H5PL__close(handle) < 0)
HGOTO_ERROR(H5E_PLUGIN, H5E_CLOSEERROR, FAIL, "can't close dynamic library")
} /* end if */
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5PL__open() */
/*-------------------------------------------------------------------------
* Function: H5PL__search_table
*
* Purpose: Search in the list of already opened dynamic libraries
* to see if the one we are looking for is already opened.
*
* Return: TRUE on success,
* FALSE on not found,
* Negative on failure
*
* Programmer: Raymond Lu
* 13 February 2013
*
*-------------------------------------------------------------------------
*/
static htri_t
H5PL__search_table(H5PL_type_t plugin_type, int type_id, const void **info)
{
htri_t ret_value = FALSE;
FUNC_ENTER_STATIC
/* Search in the table of already opened dynamic libraries */
if (H5PL_table_used_g > 0) {
size_t i;
for (i = 0; i < H5PL_table_used_g; i++) {
if ((plugin_type == (H5PL_table_g[i]).pl_type) && (type_id == (H5PL_table_g[i]).pl_id)) {
H5PL_get_plugin_info_t get_plugin_info;
const H5Z_class2_t * plugin_info;
if (NULL == (get_plugin_info = (H5PL_get_plugin_info_t)H5PL_GET_LIB_FUNC(
(H5PL_table_g[i]).handle, "H5PLget_plugin_info")))
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTGET, FAIL, "can't get function for H5PLget_plugin_info")
if (NULL == (plugin_info = (const H5Z_class2_t *)(*get_plugin_info)()))
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTGET, FAIL, "can't get plugin info")
*info = plugin_info;
HGOTO_DONE(TRUE)
} /* end if */
} /* end for */
} /* end if */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5PL__search_table() */
H5_GCC_DIAG_ON("pedantic")
/*-------------------------------------------------------------------------
* Function: H5PL__close
*
* Purpose: Closes the handle for dynamic library
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Raymond Lu
* 13 February 2013
*
*-------------------------------------------------------------------------
*/
static herr_t
H5PL__close(H5PL_HANDLE handle)
{
FUNC_ENTER_STATIC_NOERR
H5PL_CLOSE_LIB(handle);
FUNC_LEAVE_NOAPI(SUCCEED)
} /* end H5PL__close() */
|