summaryrefslogtreecommitdiffstats
path: root/test/external.c
blob: fa61006ed5a1698cf9661c5e2fe34b606088945e (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
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
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * 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 COPYING file, which can be found at the root of the source code       *
 * distribution tree, or in https://www.hdfgroup.org/licenses.               *
 * If you do not have access to either file, you may request a copy from     *
 * help@hdfgroup.org.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Programmer:  Robb Matzke
 *              Tuesday, March  3, 1998
 *
 * Purpose:    Tests datasets stored in external raw files.
 */
#include "external_common.h"
#include "external_fname.h"

#define AEF_EXNAME_MAX_LEN 12 /* string buffer size for external file name */
                              /* used in __add_external_files()            */

/*-------------------------------------------------------------------------
 * Function:    files_have_same_contents
 *
 * Purpose:     Determines whether two files contain the same data.
 *
 * Return:      Success:    nonzero if same, zero if different.
 *              Failure:    zero
 *
 * Programmer:  Robb Matzke
 *              Wednesday, March  4, 1998
 *
 *-------------------------------------------------------------------------
 */
static hbool_t
files_have_same_contents(const char *name1, const char *name2)
{
    int     fd1 = 0;
    int     fd2 = 0;
    ssize_t n1  = 0;
    ssize_t n2  = 0;
    char    buf1[1024];
    char    buf2[1024];
    hbool_t ret = FALSE; /* not equal until proven otherwise */

    if ((fd1 = HDopen(name1, O_RDONLY)) < 0)
        goto out;
    if ((fd2 = HDopen(name2, O_RDONLY)) < 0)
        goto out;

    /* Loop until files are empty or we encounter a problem */
    while (1) {
        HDmemset(buf1, 0, sizeof(buf1));
        HDmemset(buf2, 0, sizeof(buf2));

        n1 = HDread(fd1, buf1, sizeof(buf1));
        if (n1 < 0 || (size_t)n1 > sizeof(buf1))
            break;
        n2 = HDread(fd2, buf2, sizeof(buf2));
        if (n2 < 0 || (size_t)n2 > sizeof(buf2))
            break;

        if (n1 != n2)
            break;

        if (n1 == 0 && n2 == 0) {
            ret = TRUE;
            break;
        }

        if (HDmemcmp(buf1, buf2, (size_t)n1))
            break;

    } /* end while */

out:
    if (fd1)
        HDclose(fd1);
    if (fd2)
        HDclose(fd2);
    return ret;
} /* end files_have_same_contents() */

/*-------------------------------------------------------------------------
 * Function:    test_non_extendible
 *
 * Purpose:     Tests a non-extendible dataset with a single external file.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Monday, November 23, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_non_extendible(hid_t file)
{
    hid_t   dcpl        = -1;          /* dataset creation properties          */
    hid_t   space       = -1;          /* data space                           */
    hid_t   dset        = -1;          /* dataset                              */
    hsize_t cur_size[1] = {100};       /* data space current size              */
    hsize_t max_size[1] = {100};       /* data space maximum size              */
    int     n           = 0;           /* number of external files             */
    off_t   file_offset = 0;           /* external file offset                 */
    hsize_t file_size   = 0;           /* sizeof external file segment         */
    haddr_t dset_addr   = HADDR_UNDEF; /* address of dataset                   */

    TESTING("fixed-size data space, exact storage");

    /* Create the dataset and close */
    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_external(dcpl, "ext1.data", (off_t)0, (hsize_t)(max_size[0] * sizeof(int))) < 0)
        FAIL_STACK_ERROR
    if ((space = H5Screate_simple(1, cur_size, max_size)) < 0)
        FAIL_STACK_ERROR
    if ((dset = H5Dcreate2(file, "dset1", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR
    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR

    /* Read dataset creation information */
    if ((dset = H5Dopen2(file, "dset1", H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR

    /* Test dataset address.  Should be undefined. */
    H5E_BEGIN_TRY { dset_addr = H5Dget_offset(dset); }
    H5E_END_TRY;
    if (dset_addr != HADDR_UNDEF)
        FAIL_STACK_ERROR

    /* Check external count */
    if ((dcpl = H5Dget_create_plist(dset)) < 0)
        FAIL_STACK_ERROR
    if ((n = H5Pget_external_count(dcpl)) < 0)
        FAIL_STACK_ERROR
    if (1 != n) {
        H5_FAILED();
        HDputs("    Returned external count is wrong.");
        HDprintf("   got: %d\n    ans: 1\n", n);
        goto error;
    }

    /* Verify external file settings */
    if (H5Pget_external(dcpl, 0, 0, NULL, &file_offset, &file_size) < 0)
        FAIL_STACK_ERROR
    if (file_offset != 0) {
        H5_FAILED();
        HDputs("    Wrong file offset.");
        HDprintf("    got: %lu\n    ans: 0\n", (unsigned long)file_offset);
        goto error;
    }
    if (file_size != (max_size[0] * sizeof(int))) {
        H5_FAILED();
        HDputs("    Wrong file size.");
        HDprintf("    got: %lu\n    ans: %lu\n", (unsigned long)file_size,
                 (unsigned long)max_size[0] * sizeof(int));
        goto error;
    }

    /* Done (dataspace was previously closed) */
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Pclose(dcpl);
        H5Sclose(space);
        H5Dclose(dset);
    }
    H5E_END_TRY;
    return 1;
} /* end test_non_extendible() */

/*-------------------------------------------------------------------------
 * Function:    test_too_small
 *
 * Purpose:     Test a single external file which is too small to represent
 *              all the data.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Monday, November 23, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_too_small(hid_t file)
{
    hid_t   dcpl        = -1;    /* dataset creation properties          */
    hid_t   space       = -1;    /* data space                           */
    hid_t   dset        = -1;    /* dataset                              */
    hsize_t cur_size[1] = {100}; /* current data space size              */
    hsize_t max_size[1] = {100}; /* maximum data space size              */

    TESTING("external storage is too small");

    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_external(dcpl, "ext1.data", (off_t)0, (hsize_t)(max_size[0] * sizeof(int) - 1)) <
        0) /* note -1 */
        FAIL_STACK_ERROR
    if ((space = H5Screate_simple(1, cur_size, max_size)) < 0)
        FAIL_STACK_ERROR

    H5E_BEGIN_TRY { dset = H5Dcreate2(file, "dset2", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT); }
    H5E_END_TRY;
    if (dset >= 0)
        FAIL_PUTS_ERROR("    Small external file succeeded instead of failing.");
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR

    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Sclose(space);
        H5Pclose(dcpl);
        H5Dclose(dset);
    }
    H5E_END_TRY;
    return 1;
} /* end test_too_small() */

/*-------------------------------------------------------------------------
 * Function:    test_large_enough_current_eventual
 *
 * Purpose:     Test a single external file which is large enough to
 *              represent the current data and large enough to represent the
 *              eventual size of the data.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Monday, November 23, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_large_enough_current_eventual(hid_t file)
{
    hid_t   dcpl        = -1;    /* dataset creation properties          */
    hid_t   space       = -1;    /* data space                           */
    hid_t   dset        = -1;    /* dataset                              */
    hsize_t cur_size[1] = {100}; /* current data space size              */
    hsize_t max_size[1] = {200}; /* maximum data space size              */

    TESTING("extendible dataspace, exact external size");

    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_external(dcpl, "ext1.data", (off_t)0, (hsize_t)(max_size[0] * sizeof(int))) < 0)
        FAIL_STACK_ERROR
    if ((space = H5Screate_simple(1, cur_size, max_size)) < 0)
        FAIL_STACK_ERROR
    if ((dset = H5Dcreate2(file, "dset3", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR

    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR

    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Dclose(dset);
        H5Pclose(dcpl);
        H5Sclose(space);
    }
    H5E_END_TRY;
    return 1;
} /* end test_large_enough_current_eventual() */

/*-------------------------------------------------------------------------
 * Function:    test_large_enough_current_not_eventual
 *
 * Purpose:     Test a single external file which is large enough for the
 *              current data size but not large enough for the eventual size.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Monday, November 23, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_large_enough_current_not_eventual(hid_t file)
{
    hid_t   dcpl        = -1;    /* dataset creation properties          */
    hid_t   space       = -1;    /* data space                           */
    hid_t   dset        = -1;    /* dataset                              */
    hsize_t cur_size[1] = {100}; /* current data space size              */
    hsize_t max_size[1] = {200}; /* maximum data space size              */

    TESTING("extendible dataspace, external storage is too small");

    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_external(dcpl, "ext1.data", (off_t)0, (hsize_t)(max_size[0] * sizeof(int) - 1)) <
        0) /* note -1 */
        FAIL_STACK_ERROR
    if ((space = H5Screate_simple(1, cur_size, max_size)) < 0)
        FAIL_STACK_ERROR

    H5E_BEGIN_TRY { dset = H5Dcreate2(file, "dset4", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT); }
    H5E_END_TRY;
    if (dset >= 0)
        FAIL_PUTS_ERROR("    Small external file succeeded instead of failing.");

    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR

    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Dclose(dset);
        H5Pclose(dcpl);
        H5Sclose(space);
    }
    H5E_END_TRY;
    return 1;
} /* end test_large_enough_current_not_eventual() */

/*-------------------------------------------------------------------------
 * Function:    test_unlimited
 *
 * Purpose:     Test a single external file of unlimited size and an
 *              unlimited data space.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Monday, November 23, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_unlimited(hid_t file)
{
    hid_t   dcpl        = -1;              /* dataset creation properties   */
    hid_t   space       = -1;              /* data space                    */
    hid_t   dset        = -1;              /* dataset                       */
    hsize_t cur_size[1] = {100};           /* data space current size       */
    hsize_t max_size[1] = {H5S_UNLIMITED}; /* data space maximum size       */
    int     n;                             /* number of external files      */
    off_t   file_offset;                   /* external file offset          */
    hsize_t file_size;                     /* sizeof external file segment  */

    TESTING("unlimited dataspace, unlimited external storage");

    /* Create dataset */
    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_external(dcpl, "ext1.data", (off_t)0, H5F_UNLIMITED) < 0)
        FAIL_STACK_ERROR
    if ((space = H5Screate_simple(1, cur_size, max_size)) < 0)
        FAIL_STACK_ERROR
    if ((dset = H5Dcreate2(file, "dset5", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR

    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR

    /* Read dataset creation information */
    if ((dset = H5Dopen2(file, "dset5", H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR
    if ((dcpl = H5Dget_create_plist(dset)) < 0)
        FAIL_STACK_ERROR
    if ((n = H5Pget_external_count(dcpl)) < 0)
        FAIL_STACK_ERROR
    if (1 != n) {
        H5_FAILED();
        HDputs("    Returned external count is wrong.");
        HDprintf("    got: %d\n    ans: 1\n", n);
        goto error;
    } /* end if */

    if (H5Pget_external(dcpl, 0, 0, NULL, &file_offset, &file_size) < 0)
        FAIL_STACK_ERROR
    if (file_offset != 0) {
        H5_FAILED();
        HDputs("    Wrong file offset.");
        HDprintf("    got: %lu\n    ans: 0\n", (unsigned long)file_offset);
        goto error;
    }
    if (H5F_UNLIMITED != file_size) {
        H5_FAILED();
        HDputs("    Wrong file size.");
        HDprintf("    got: %lu\n    ans: INF\n", (unsigned long)file_size);
        goto error;
    }

    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR

    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Dclose(dset);
        H5Pclose(dcpl);
        H5Sclose(space);
    }
    H5E_END_TRY;
    return 1;
} /* end test_unlimited() */

/*-------------------------------------------------------------------------
 * Function:    __add_external_files
 *
 * Purpose:     Add external file names to the DCPL with the given properties.
 *              Used in test_multiple_files().
 *              Limit to no more than 999 external files.
 *
 * Return:      Success:    0
 *              Failure:    -1
 *
 * Programmer:  Jacob Smith
 *              29 Sep 2019
 *
 *-------------------------------------------------------------------------
 */
static int
__add_external_files(hid_t dcpl_id, unsigned int n_external_files, off_t offset, hsize_t max_ext_size)
{
    char         exname[AEF_EXNAME_MAX_LEN + 1];
    unsigned int i = 0;

    if (dcpl_id < 0) {
        return -1;
    }
    for (i = 0; i < n_external_files; i++) {
        if (HDsnprintf(exname, AEF_EXNAME_MAX_LEN, "ext%d.data", i + 1) > AEF_EXNAME_MAX_LEN) {
            HDfprintf(stderr, "External file %d overflows name buffer\n", i + 1);
            fflush(stderr);
            return -1;
        }
        if (H5Pset_external(dcpl_id, exname, offset, max_ext_size) < 0) {
            HDfprintf(stderr, "Problem adding external file %s\n", exname);
            fflush(stderr);
            return -1;
        }
    }
    return 0;
} /* end __add_external_files() */

/*-------------------------------------------------------------------------
 * Function:    test_multiple_files
 *
 * Purpose:     Test multiple external files for a dataset.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Monday, November 23, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_multiple_files(hid_t file)
{
    hid_t        dcpl        = -1;    /* dataset creation properties         */
    hid_t        space       = -1;    /* dataspace                           */
    hid_t        dset        = -1;    /* dataset                             */
    hsize_t      cur_size[1] = {100}; /* data space current size             */
    hsize_t      max_size[1] = {100}; /* data space maximum size             */
    hsize_t      max_ext_size;        /* maximum size of external files      */
    unsigned int n_external_files = 4;

    TESTING("multiple external files");

    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR

    max_ext_size = (hsize_t)(sizeof(int) * max_size[0] / n_external_files);

    if (__add_external_files(dcpl, n_external_files, 0, max_ext_size) < 0) {
        FAIL_STACK_ERROR;
    }

    if ((space = H5Screate_simple(1, cur_size, max_size)) < 0)
        FAIL_STACK_ERROR

    if ((dset = H5Dcreate2(file, "dset6", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR

    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    /* Re-use space below */

    /* ----------------------------------------------
     * Verify that too-small external files will fail
     */
    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR

    max_ext_size -= 1;

    if (__add_external_files(dcpl, n_external_files, 0, max_ext_size) < 0) {
        FAIL_STACK_ERROR;
    }

    H5E_BEGIN_TRY { dset = H5Dcreate2(file, "dset7", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT); }
    H5E_END_TRY;
    if (dset >= 0)
        FAIL_PUTS_ERROR("    Small external files succeeded instead of failing.");

    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR

    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Dclose(dset);
        H5Pclose(dcpl);
        H5Sclose(space);
    }
    H5E_END_TRY;
    return 1;
} /* end test_multiple_files() */

/*-------------------------------------------------------------------------
 * Function:    test_add_to_unlimited
 *
 * Purpose:     It should be impossible to define an unlimited external file
 *              and then follow it with another external file.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Monday, November 23, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_add_to_unlimited(void)
{
    hid_t  dcpl   = -1;   /* dataset creation properties          */
    herr_t status = FAIL; /* function return status               */
    int    n      = 0;    /* number of external files             */

    TESTING("external file following unlimited file");

    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_external(dcpl, "ext1.data", (off_t)0, H5F_UNLIMITED) < 0)
        FAIL_STACK_ERROR

    H5E_BEGIN_TRY { status = H5Pset_external(dcpl, "ext2.data", (off_t)0, (hsize_t)100); }
    H5E_END_TRY;
    if (status >= 0)
        FAIL_PUTS_ERROR("    H5Pset_external() succeeded when it should have failed.");

    if ((n = H5Pget_external_count(dcpl)) < 0)
        FAIL_STACK_ERROR
    if (1 != n)
        FAIL_PUTS_ERROR("    Wrong external file count returned.");

    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY { H5Pclose(dcpl); }
    H5E_END_TRY;
    return 1;
} /* end test_add_to_unlimited() */

/*-------------------------------------------------------------------------
 * Function:    test_overflow
 *
 * Purpose:     It should be impossible to create a set of external files
 *              whose total size overflows a size_t integer.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Monday, November 23, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_overflow(void)
{
    hid_t  dcpl   = -1;   /* dataset creation properties          */
    herr_t status = FAIL; /* return status                        */

    TESTING("address overflow in external files");

    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_external(dcpl, "ext1.data", (off_t)0, H5F_UNLIMITED - 1) < 0)
        FAIL_STACK_ERROR

    H5E_BEGIN_TRY { status = H5Pset_external(dcpl, "ext2.data", (off_t)0, (hsize_t)100); }
    H5E_END_TRY;
    if (status >= 0)
        FAIL_PUTS_ERROR("    H5Pset_external() succeeded when it should have failed.");

    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR

    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY { H5Pclose(dcpl); }
    H5E_END_TRY;
    return 1;
} /* end test_overflow() */

/*-------------------------------------------------------------------------
 * Function:    test_read_file_set
 *
 * Purpose:     Tests reading from an external file set.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Wednesday, March  4, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_read_file_set(hid_t fapl)
{
    hid_t   file  = -1;        /* file to write to                     */
    hid_t   dcpl  = -1;        /* dataset creation properties          */
    hid_t   space = -1;        /* data space                           */
    hid_t   dset  = -1;        /* dataset                              */
    hid_t   grp   = -1;        /* group to emit diagnostics            */
    size_t  i     = 0;         /* miscellaneous counter                */
    char    filename[1024];    /* file names                           */
    int     part[PART_SIZE];   /* raw data buffer (partial)            */
    int     whole[TOTAL_SIZE]; /* raw data buffer (total)              */
    hsize_t cur_size;          /* current data space size              */
    hid_t   hs_space = -1;     /* hyperslab data space                 */
    hsize_t hs_start = 30;     /* hyperslab starting offset            */
    hsize_t hs_count = 25;     /* hyperslab size                       */

    TESTING("read external dataset");

    if (HDsetenv("HDF5_EXTFILE_PREFIX", "", 1) < 0)
        TEST_ERROR

    /* Reset the raw data files */
    if (reset_raw_data_files(FALSE) < 0)
        TEST_ERROR

    /* Create the file and an initial group.  This causes messages about
     * debugging to be emitted before we start playing games with what the
     * output looks like.
     */
    h5_fixname(EXT_FNAME[1], fapl, filename, sizeof(filename));
    if ((file = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
        FAIL_STACK_ERROR
    if ((grp = H5Gcreate2(file, "emit-diagnostics", H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR
    if (H5Gclose(grp) < 0)
        FAIL_STACK_ERROR

    /* Create the dcpl */
    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < N_EXT_FILES; i++) {
        HDsnprintf(filename, sizeof(filename), "extern_%dr.raw", (int)i + 1);
        if (H5Pset_external(dcpl, filename, (off_t)(i * GARBAGE_PER_FILE), (hsize_t)sizeof(part)) < 0)
            FAIL_STACK_ERROR
    }

    /* Create the dataspace */
    cur_size = TOTAL_SIZE;
    if ((space = H5Screate_simple(1, &cur_size, NULL)) < 0)
        FAIL_STACK_ERROR

    /* Create the dataset */
    if ((dset = H5Dcreate2(file, "dset1", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR

    /* Read the entire dataset */
    HDmemset(whole, 0, sizeof(whole));
    if (H5Dread(dset, H5T_NATIVE_INT, space, space, H5P_DEFAULT, whole) < 0)
        FAIL_STACK_ERROR

    /* Compare data */
    for (i = 0; i < TOTAL_SIZE; i++)
        if (whole[i] != (signed)i)
            FAIL_PUTS_ERROR("Incorrect value(s) read.");

    /* Read via a hypserslab in the middle of the dataset */

    /* Set up dataspace */
    if ((hs_space = H5Scopy(space)) < 0)
        FAIL_STACK_ERROR
    if (H5Sselect_hyperslab(hs_space, H5S_SELECT_SET, &hs_start, NULL, &hs_count, NULL) < 0)
        FAIL_STACK_ERROR

    /* Read */
    HDmemset(whole, 0, sizeof(whole));
    if (H5Dread(dset, H5T_NATIVE_INT, hs_space, hs_space, H5P_DEFAULT, whole) < 0)
        FAIL_STACK_ERROR

    /* Verify data */
    for (i = (size_t)hs_start; i < (size_t)(hs_start + hs_count); i++) {
        if (whole[i] != (signed)i)
            FAIL_PUTS_ERROR("Incorrect value(s) read (hyperslab).");
    } /* end for */

    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(hs_space) < 0)
        FAIL_STACK_ERROR
    if (H5Fclose(file) < 0)
        FAIL_STACK_ERROR
    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Gclose(grp);
        H5Dclose(dset);
        H5Pclose(dcpl);
        H5Sclose(space);
        H5Sclose(hs_space);
        H5Fclose(file);
    }
    H5E_END_TRY;
    return 1;
} /* end test_read_file_set() */

/*-------------------------------------------------------------------------
 * Function:    test_write_file_set
 *
 * Purpose:     Tests writing to an external file set.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Robb Matzke
 *              Wednesday, March  4, 1998
 *
 *-------------------------------------------------------------------------
 */
static int
test_write_file_set(hid_t fapl)
{
    hid_t    file       = -1;   /* file to which to write               */
    hid_t    dcpl       = -1;   /* dataset creation properties          */
    hid_t    mem_space  = -1;   /* memory data space                    */
    hid_t    file_space = -1;   /* file data space                      */
    hid_t    dset       = -1;   /* dataset                              */
    unsigned i          = 0;    /* miscellaneous counter                */
    int      part[PART_SIZE];   /* raw data buffer (partial)            */
    int      whole[TOTAL_SIZE]; /* raw data buffer (total)              */
    hsize_t  cur_size = 100;    /* current data space size              */
    hsize_t  max_size = 200;    /* maximum data space size              */
    hsize_t  hs_start = 100;    /* hyperslab starting offset            */
    hsize_t  hs_count = 100;    /* hyperslab size                       */
    char     filename[1024];    /* file name                            */

    TESTING("write external dataset");

    if (HDsetenv("HDF5_EXTFILE_PREFIX", "", 1) < 0)
        TEST_ERROR

    /* Create another file */
    h5_fixname(EXT_FNAME[2], fapl, filename, sizeof(filename));
    if ((file = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
        FAIL_STACK_ERROR

    /* Create the dcpl and external file list */
    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < N_EXT_FILES; i++) {
        hsize_t size;

        HDsnprintf(filename, sizeof(filename), "extern_%dw.raw", (int)i + 1);

        if (i != N_EXT_FILES - 1)
            size = (hsize_t)sizeof(part);
        else
            size = H5F_UNLIMITED;

        if (H5Pset_external(dcpl, filename, (off_t)(i * GARBAGE_PER_FILE), size) < 0)
            FAIL_STACK_ERROR
    } /* end for */

    /* Reset the raw data files */
    if (reset_raw_data_files(FALSE) < 0)
        TEST_ERROR

    /* Create the dataset */
    if ((mem_space = H5Screate_simple(1, &cur_size, &max_size)) < 0)
        FAIL_STACK_ERROR
    if ((file_space = H5Scopy(mem_space)) < 0)
        FAIL_STACK_ERROR
    if ((dset = H5Dcreate2(file, "dset1", H5T_NATIVE_INT, file_space, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR

    /* Write the entire dataset and compare with the original */
    for (i = 0; i < cur_size; i++)
        whole[i] = (int)i;
    if (H5Dwrite(dset, H5T_NATIVE_INT, mem_space, file_space, H5P_DEFAULT, whole) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < N_EXT_FILES; i++) {
        char name1[64], name2[64];

        HDsprintf(name1, "extern_%dr.raw", i + 1);
        HDsprintf(name2, "extern_%dw.raw", i + 1);
        if (!files_have_same_contents(name1, name2))
            FAIL_PUTS_ERROR("   Output differs from expected value.")
    } /* end for */

    /* Extend the dataset by another 100 elements */
    if (H5Dset_extent(dset, &max_size) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(file_space) < 0)
        FAIL_STACK_ERROR
    if ((file_space = H5Dget_space(dset)) < 0)
        FAIL_STACK_ERROR

    /* Write second half of dataset */
    for (i = 0; i < hs_count; i++)
        whole[i] = 100 + (int)i;
    if (H5Sselect_hyperslab(file_space, H5S_SELECT_SET, &hs_start, NULL, &hs_count, NULL) < 0)
        FAIL_STACK_ERROR
    if (H5Dwrite(dset, H5T_NATIVE_INT, mem_space, file_space, H5P_DEFAULT, whole) < 0)
        FAIL_STACK_ERROR

    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(mem_space) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(file_space) < 0)
        FAIL_STACK_ERROR
    if (H5Fclose(file) < 0)
        FAIL_STACK_ERROR

    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Dclose(dset);
        H5Pclose(dcpl);
        H5Sclose(mem_space);
        H5Sclose(file_space);
        H5Fclose(file);
    }
    H5E_END_TRY;
    return 1;
} /* end test_write_file_set() */

/*-------------------------------------------------------------------------
 * Function:    test_path_absolute
 *
 * Purpose:     Test absolute filenames for external files.
 *              This will create an HDF5 file in a subdirectory which will
 *              refer to /full/path/extern_*a.raw on unix and to
 *              c:\full\path\extern_*a.raw and \full\path\extern_*a.raw on
 *              windows.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Steffen Kiess
 *              March 10, 2015
 *
 *-------------------------------------------------------------------------
 */
static int
test_path_absolute(hid_t fapl)
{
    hid_t   file  = -1;        /* file to write to                     */
    hid_t   dcpl  = -1;        /* dataset creation properties          */
    hid_t   space = -1;        /* data space                           */
    hid_t   dset  = -1;        /* dataset                              */
    size_t  i     = 0;         /* miscellaneous counter                */
    char    cwdpath[1024];     /* working directory                    */
    char    filename[1088];    /* file name                            */
    int     part[PART_SIZE];   /* raw data buffer (partial)            */
    int     whole[TOTAL_SIZE]; /* raw data buffer (total)              */
    hsize_t cur_size;          /* current data space size              */

    TESTING("absolute filenames for external file");

    h5_fixname(EXT_FNAME[3], fapl, filename, sizeof(filename));
    if ((file = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
        FAIL_STACK_ERROR

    /* Reset the raw data files */
    if (reset_raw_data_files(FALSE) < 0)
        TEST_ERROR

    /* Create the dcpl */
    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (NULL == HDgetcwd(cwdpath, sizeof(cwdpath)))
        TEST_ERROR
    for (i = 0; i < N_EXT_FILES; i++) {
        HDsnprintf(filename, sizeof(filename), "%s%sextern_%dr.raw", cwdpath, H5_DIR_SEPS, (int)i + 1);
#if defined(H5_HAVE_WINDOW_PATH)
        /* For windows, test path-absolute case (\dir\file.raw) for the second file */
        if (i == 1)
            HDsnprintf(filename, sizeof(filename), "%s%sextern_%dr.raw", cwdpath + 2, H5_DIR_SEPS, i + 1);
#endif
        if (H5Pset_external(dcpl, filename, (off_t)(i * GARBAGE_PER_FILE), (hsize_t)sizeof(part)) < 0)
            FAIL_STACK_ERROR
    } /* end for */

    /* create the dataspace */
    cur_size = TOTAL_SIZE;
    if ((space = H5Screate_simple(1, &cur_size, NULL)) < 0)
        FAIL_STACK_ERROR

    /* create the dataset */
    if ((dset = H5Dcreate2(file, "dset1", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR

    /* Read the entire dataset and compare with the original */
    HDmemset(whole, 0, sizeof(whole));
    if (H5Dread(dset, H5T_NATIVE_INT, space, space, H5P_DEFAULT, whole) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < TOTAL_SIZE; i++)
        if (whole[i] != (signed)i)
            FAIL_PUTS_ERROR("Incorrect value(s) read.");

    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    if (H5Fclose(file) < 0)
        FAIL_STACK_ERROR
    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Dclose(dset);
        H5Sclose(space);
        H5Pclose(dcpl);
        H5Fclose(file);
    }
    H5E_END_TRY;
    return 1;
} /* end test_path_absolute() */

/*-------------------------------------------------------------------------
 * Function:    test_path_relative
 *
 * Purpose:     Test external files with filename relative to current directory.
 *              This will create an HDF5 file in a subdirectory which will
 *              refer to extern_*a.raw
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Steffen Kiess
 *              March 10, 2015
 *
 *-------------------------------------------------------------------------
 */
static int
test_path_relative(hid_t fapl)
{
    hid_t   file  = -1;        /* file to write to                     */
    hid_t   dcpl  = -1;        /* dataset creation properties          */
    hid_t   space = -1;        /* data space                           */
    hid_t   dset  = -1;        /* dataset                              */
    size_t  i     = 0;         /* miscellaneous counters               */
    char    filename[1024];    /* file name                            */
    int     part[PART_SIZE];   /* raw data buffer (partial)            */
    int     whole[TOTAL_SIZE]; /* raw data buffer (total)              */
    hsize_t cur_size;          /* current data space size              */

    TESTING("filenames relative to current directory for external file");

    if (HDsetenv("HDF5_EXTFILE_PREFIX", "", 1) < 0)
        TEST_ERROR

    if (HDmkdir("extern_dir", (mode_t)0755) < 0 && errno != EEXIST)
        TEST_ERROR;

    h5_fixname(EXT_FNAME[4], fapl, filename, sizeof(filename));
    if ((file = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
        FAIL_STACK_ERROR;

    /* Reset the raw data files */
    if (reset_raw_data_files(FALSE) < 0)
        TEST_ERROR

    /* Create the dataset */
    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < N_EXT_FILES; i++) {
        HDsnprintf(filename, sizeof(filename), "extern_%dr.raw", (int)i + 1);
        if (H5Pset_external(dcpl, filename, (off_t)(i * GARBAGE_PER_FILE), (hsize_t)sizeof(part)) < 0)
            FAIL_STACK_ERROR
    } /* end for */

    cur_size = TOTAL_SIZE;
    if ((space = H5Screate_simple(1, &cur_size, NULL)) < 0)
        FAIL_STACK_ERROR
    if ((dset = H5Dcreate2(file, "dset1", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
        FAIL_STACK_ERROR

    /* Read the entire dataset and compare with the original */
    HDmemset(whole, 0, sizeof(whole));
    if (H5Dread(dset, H5T_NATIVE_INT, space, space, H5P_DEFAULT, whole) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < TOTAL_SIZE; i++)
        if (whole[i] != (signed)i)
            FAIL_PUTS_ERROR("Incorrect value(s) read.");

    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Fclose(file) < 0)
        FAIL_STACK_ERROR
    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Dclose(dset);
        H5Pclose(dcpl);
        H5Sclose(space);
        H5Fclose(file);
    }
    H5E_END_TRY;
    return 1;
} /* end test_path_relative() */

/*-------------------------------------------------------------------------
 * Function:    test_path_relative_cwd
 *
 * Purpose:     Test external files with filename relative to current directory.
 *              This will create an HDF5 file in a subdirectory which will
 *              refer to ../extern_*a.raw
 *              The files are then accessed by setting the efile_prefix dataset
 *              access property to "${ORIGIN}".
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Steffen Kiess
 *              March 10, 2015
 *
 *-------------------------------------------------------------------------
 */
static int
test_path_relative_cwd(hid_t fapl)
{
    hid_t   file  = -1;        /* file to write to                     */
    hid_t   dcpl  = -1;        /* dataset creation properties          */
    hid_t   space = -1;        /* data space                           */
    hid_t   dapl  = -1;        /* dataset access property list         */
    hid_t   dapl2 = -1;        /* copy of dapl                         */
    hid_t   dset  = -1;        /* dataset                              */
    hid_t   dset2 = -1;        /* dataset, opened a second time        */
    hid_t   dset3 = -1;        /* dataset, opened with different prefix    */
    size_t  i     = 0;         /* miscellaneous counters               */
    char    filename[1024];    /* file name                            */
    int     part[PART_SIZE];   /* raw data buffer (partial)            */
    int     whole[TOTAL_SIZE]; /* raw data buffer (total)              */
    hsize_t cur_size;          /* current data space size              */
    char    buffer[1024];      /* buffer to read efile_prefix          */

    TESTING("filenames relative to HDF5 file for external file");

    if (HDsetenv("HDF5_EXTFILE_PREFIX", "", 1) < 0)
        TEST_ERROR

    if (HDmkdir("extern_dir", (mode_t)0755) < 0 && errno != EEXIST)
        TEST_ERROR;

    h5_fixname(EXT_FNAME[4], fapl, filename, sizeof(filename));
    if ((file = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
        FAIL_STACK_ERROR;

    /* Reset the raw data files */
    if (reset_raw_data_files(FALSE) < 0)
        TEST_ERROR

    /* Create the dataset */
    if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < N_EXT_FILES; i++) {
        HDsnprintf(filename, sizeof(filename), "..%sextern_%dr.raw", H5_DIR_SEPS, (int)i + 1);
        if (H5Pset_external(dcpl, filename, (off_t)(i * GARBAGE_PER_FILE), (hsize_t)sizeof(part)) < 0)
            FAIL_STACK_ERROR
    } /* end for */

    cur_size = TOTAL_SIZE;
    if ((space = H5Screate_simple(1, &cur_size, NULL)) < 0)
        FAIL_STACK_ERROR
    if ((dapl = H5Pcreate(H5P_DATASET_ACCESS)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_efile_prefix(dapl, "${ORIGIN}") < 0)
        FAIL_STACK_ERROR
    if (H5Pget_efile_prefix(dapl, buffer, sizeof(buffer)) < 0)
        FAIL_STACK_ERROR
    if (HDstrcmp(buffer, "${ORIGIN}") != 0)
        FAIL_PUTS_ERROR("efile prefix not set correctly");
    if ((dapl2 = H5Pcopy(dapl)) < 0)
        FAIL_STACK_ERROR

    /* Create dataset */
    if ((dset = H5Dcreate2(file, "dset1", H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, dapl2)) < 0)
        FAIL_STACK_ERROR

    /* Reopen dataset with same efile_prefix property */
    if ((dset2 = H5Dopen2(file, "dset1", dapl2)) < 0)
        FAIL_STACK_ERROR

    /* Reopen dataset with different efile_prefix property */
    if (H5Pset_efile_prefix(dapl, "//") < 0)
        FAIL_STACK_ERROR
    H5E_BEGIN_TRY { dset3 = H5Dopen2(file, "dset1", dapl); }
    H5E_END_TRY;
    if (dset3 >= 0)
        FAIL_PUTS_ERROR("reopening the dataset with a different efile_prefix succeded");

    /* Read the entire dataset and compare with the original */
    HDmemset(whole, 0, sizeof(whole));
    if (H5Dread(dset, H5T_NATIVE_INT, space, space, H5P_DEFAULT, whole) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < TOTAL_SIZE; i++)
        if (whole[i] != (signed)i)
            FAIL_PUTS_ERROR("Incorrect value(s) read.");

    /* Close dataset */
    if (H5Dclose(dset2) < 0)
        FAIL_STACK_ERROR
    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR

    /* Open dataset (use a differend prefix than for create.
     * This works because the dataset was closed.
     */
    if (H5Pset_efile_prefix(dapl2, "${ORIGIN}/.") < 0)
        FAIL_STACK_ERROR
    if ((dset = H5Dopen2(file, "dset1", dapl2)) < 0)
        FAIL_STACK_ERROR

    /* Reopen dataset with same efile_prefix property */
    if ((dset2 = H5Dopen2(file, "dset1", dapl2)) < 0)
        FAIL_STACK_ERROR

    /* Reopen dataset with different efile_prefix property */
    if (H5Pset_efile_prefix(dapl, NULL) < 0)
        FAIL_STACK_ERROR
    H5E_BEGIN_TRY { dset3 = H5Dopen2(file, "dset1", dapl); }
    H5E_END_TRY;
    if (dset3 >= 0)
        FAIL_PUTS_ERROR("reopening the dataset with a different efile_prefix succeded");

    /* Read the entire dataset and compare with the original */
    HDmemset(whole, 0, sizeof(whole));
    if (H5Dread(dset, H5T_NATIVE_INT, space, space, H5P_DEFAULT, whole) < 0)
        FAIL_STACK_ERROR
    for (i = 0; i < TOTAL_SIZE; i++)
        if (whole[i] != (signed)i)
            FAIL_PUTS_ERROR("Incorrect value(s) read.");

    if (H5Dclose(dset2) < 0)
        FAIL_STACK_ERROR
    if (H5Dclose(dset) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dapl2) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dapl) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl) < 0)
        FAIL_STACK_ERROR
    if (H5Sclose(space) < 0)
        FAIL_STACK_ERROR
    if (H5Fclose(file) < 0)
        FAIL_STACK_ERROR
    PASSED();
    return 0;

error:
    H5E_BEGIN_TRY
    {
        H5Pclose(dapl2);
        H5Pclose(dapl);
        H5Dclose(dset3);
        H5Dclose(dset2);
        H5Dclose(dset);
        H5Pclose(dcpl);
        H5Sclose(space);
        H5Fclose(file);
    }
    H5E_END_TRY;
    return 1;
} /* end test_path_relative_cwd() */

/*-------------------------------------------------------------------------
 * Function:    test_h5d_get_access_plist
 *
 * Purpose:     Ensure that H5Dget_access_plist returns correct values.
 *
 * Return:      Success:    0
 *              Failure:    1
 *
 * Programmer:  Dana Robinson
 *              March 2016
 *
 *-------------------------------------------------------------------------
 */
static int
test_h5d_get_access_plist(hid_t fapl_id)
{
    hid_t   fid     = -1;   /* file to write to                     */
    hid_t   dcpl_id = -1;   /* dataset creation properties          */
    hid_t   dapl_id = -1;   /* dataset access properties            */
    hid_t   sid     = -1;   /* data space                           */
    hid_t   did     = -1;   /* dataset                              */
    hsize_t dims    = 0;    /* dataset size                         */
    char *  buffer  = NULL; /* saved prefix name from dapl          */
    char    filename[1024]; /* file names                           */

    TESTING("H5Dget_access_plist() returns correct prefix");

    if (HDsetenv("HDF5_EXTFILE_PREFIX", "", 1) < 0)
        TEST_ERROR

    /* Reset the raw data files */
    if (reset_raw_data_files(FALSE) < 0)
        TEST_ERROR

    /* Create the file */
    h5_fixname(EXT_FNAME[5], fapl_id, filename, sizeof(filename));
    if ((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl_id)) < 0)
        FAIL_STACK_ERROR

    /* Create the dcpl and set external storage */
    if ((dcpl_id = H5Pcreate(H5P_DATASET_CREATE)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_external(dcpl_id, "extern_1r.raw", (off_t)0, (hsize_t)0) < 0)
        FAIL_STACK_ERROR

    /* Create the dapl and set the prefix */
    if ((dapl_id = H5Pcreate(H5P_DATASET_ACCESS)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_efile_prefix(dapl_id, "someprefix") < 0)
        FAIL_STACK_ERROR

    /* Create the dataset */
    if ((sid = H5Screate_simple(1, &dims, NULL)) < 0)
        FAIL_STACK_ERROR
    if ((did = H5Dcreate2(fid, "dset1", H5T_NATIVE_INT, sid, H5P_DEFAULT, dcpl_id, dapl_id)) < 0)
        FAIL_STACK_ERROR

    /* Close the dapl */
    if (H5Pclose(dapl_id) < 0)
        FAIL_STACK_ERROR
    dapl_id = -1;

    /* Get a data access property list from the dataset */
    if ((dapl_id = H5Dget_access_plist(did)) < 0)
        FAIL_STACK_ERROR

    /* Check the value for the external prefix */
    if ((buffer = (char *)HDcalloc((size_t)64, sizeof(char))) == NULL)
        TEST_ERROR
    if (H5Pget_efile_prefix(dapl_id, buffer, (size_t)64) < 0)
        FAIL_STACK_ERROR
    if (HDstrcmp(buffer, "someprefix") != 0)
        FAIL_PUTS_ERROR("external file prefix from dapl incorrect");

    /* Close everything */
    HDfree(buffer);
    if (H5Sclose(sid) < 0)
        FAIL_STACK_ERROR
    if (H5Dclose(did) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dcpl_id) < 0)
        FAIL_STACK_ERROR
    if (H5Pclose(dapl_id) < 0)
        FAIL_STACK_ERROR
    if (H5Fclose(fid) < 0)
        FAIL_STACK_ERROR

    PASSED();
    return 0;

error:
    if (buffer)
        HDfree(buffer);
    H5E_BEGIN_TRY
    {
        H5Dclose(did);
        H5Pclose(dcpl_id);
        H5Pclose(dapl_id);
        H5Sclose(sid);
        H5Fclose(fid);
    }
    H5E_END_TRY;
    return 1;
} /* end test_h5d_get_access_plist() */

/*-------------------------------------------------------------------------
 * Function:    main
 *
 * Purpose:     Runs external dataset tests.
 *
 * Return:      EXIT_SUCCESS/EXIT_FAILURE
 *
 * Programmer:  Robb Matzke
 *              Tuesday, March  3, 1998
 *
 *-------------------------------------------------------------------------
 */
int
main(void)
{
    hid_t    fapl_id_old = -1; /* file access properties (old format)  */
    hid_t    fapl_id_new = -1; /* file access properties (new format)  */
    hid_t    fid         = -1; /* file for test_1* functions           */
    hid_t    gid         = -1; /* group to emit diagnostics            */
    char     filename[1024];   /* file name for test_1* funcs          */
    unsigned latest_format;    /* default or latest file format        */
    int      nerrors = 0;      /* number of errors                     */

    h5_reset();

    /* Get a fapl for the old (default) file format */
    fapl_id_old = h5_fileaccess();
    h5_fixname(EXT_FNAME[0], fapl_id_old, filename, sizeof(filename));

    /* Copy and set up a fapl for the latest file format */
    if ((fapl_id_new = H5Pcopy(fapl_id_old)) < 0)
        FAIL_STACK_ERROR
    if (H5Pset_libver_bounds(fapl_id_new, H5F_LIBVER_LATEST, H5F_LIBVER_LATEST) < 0)
        FAIL_STACK_ERROR

    /* The file format doesn't matter for this test */
    nerrors += test_h5d_get_access_plist(fapl_id_new);
    HDputs("");

    /* Test with old & new format groups */
    for (latest_format = FALSE; latest_format <= TRUE; latest_format++) {
        hid_t current_fapl_id = -1;

        /* Set the fapl for different file formats */
        if (latest_format) {
            HDputs("\nTesting with the latest file format:");
            current_fapl_id = fapl_id_new;
        }
        else {
            HDputs("Testing with the default file format:");
            current_fapl_id = fapl_id_old;
        }

        /* Create the common file used by some of the tests */
        if ((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, current_fapl_id)) < 0)
            FAIL_STACK_ERROR

        /* Create a group that will be used in the file set read test */
        if ((gid = H5Gcreate2(fid, "emit-diagnostics", H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
            FAIL_STACK_ERROR
        if (H5Gclose(gid) < 0)
            FAIL_STACK_ERROR

        /* These tests use a common file */
        nerrors += test_non_extendible(fid);
        nerrors += test_too_small(fid);
        nerrors += test_large_enough_current_eventual(fid);
        nerrors += test_large_enough_current_not_eventual(fid);
        nerrors += test_unlimited(fid);
        nerrors += test_multiple_files(fid);

        /* These tests use no file */
        nerrors += test_add_to_unlimited();
        nerrors += test_overflow();

        /* These file set tests use the VFD-aware fapl */
        nerrors += test_read_file_set(current_fapl_id);
        nerrors += test_write_file_set(current_fapl_id);
        nerrors += test_path_absolute(current_fapl_id);
        nerrors += test_path_relative(current_fapl_id);
        nerrors += test_path_relative_cwd(current_fapl_id);

        /* Verify symbol table messages are cached */
        nerrors += (h5_verify_cached_stabs(EXT_FNAME, current_fapl_id) < 0 ? 1 : 0);

        /* Close the common file */
        if (H5Fclose(fid) < 0)
            FAIL_STACK_ERROR

    } /* end for old and new format */

    if (nerrors > 0)
        goto error;

    /* Close the new ff fapl. h5_cleanup will take care of the old ff fapl */
    if (H5Pclose(fapl_id_new) < 0)
        FAIL_STACK_ERROR

    HDputs("All external storage tests passed.");

    /* Clean up files used by file set tests */
    if (h5_cleanup(EXT_FNAME, fapl_id_old)) {
        HDremove("extern_1r.raw");
        HDremove("extern_2r.raw");
        HDremove("extern_3r.raw");
        HDremove("extern_4r.raw");

        HDremove("extern_1w.raw");
        HDremove("extern_2w.raw");
        HDremove("extern_3w.raw");
        HDremove("extern_4w.raw");

        HDrmdir("extern_dir");
    }

    return EXIT_SUCCESS;

error:
    H5E_BEGIN_TRY
    {
        H5Fclose(fid);
        H5Pclose(fapl_id_old);
        H5Pclose(fapl_id_new);
        H5Gclose(gid);
    }
    H5E_END_TRY;
    nerrors = MAX(1, nerrors);
    HDprintf("%d TEST%s FAILED.\n", nerrors, 1 == nerrors ? "" : "s");
    return EXIT_FAILURE;
} /* end main() */