Coverage Report

Created: 2025-06-13 06:34

/src/icu/icu4c/source/common/udata.cpp
Line
Count
Source (jump to first uncovered line)
1
// © 2016 and later: Unicode, Inc. and others.
2
// License & terms of use: http://www.unicode.org/copyright.html
3
/*
4
******************************************************************************
5
*
6
*   Copyright (C) 1999-2016, International Business Machines
7
*   Corporation and others.  All Rights Reserved.
8
*
9
******************************************************************************
10
*   file name:  udata.cpp
11
*   encoding:   UTF-8
12
*   tab size:   8 (not used)
13
*   indentation:4
14
*
15
*   created on: 1999oct25
16
*   created by: Markus W. Scherer
17
*/
18
19
#include "unicode/utypes.h"  /* U_PLATFORM etc. */
20
21
#ifdef __GNUC__
22
/* if gcc
23
#define ATTRIBUTE_WEAK __attribute__ ((weak))
24
might have to #include some other header
25
*/
26
#endif
27
28
#include "unicode/putil.h"
29
#include "unicode/udata.h"
30
#include "unicode/uversion.h"
31
#include "charstr.h"
32
#include "cmemory.h"
33
#include "cstring.h"
34
#include "mutex.h"
35
#include "putilimp.h"
36
#include "restrace.h"
37
#include "uassert.h"
38
#include "ucln_cmn.h"
39
#include "ucmndata.h"
40
#include "udatamem.h"
41
#include "uhash.h"
42
#include "umapfile.h"
43
#include "umutex.h"
44
45
/***********************************************************************
46
*
47
*   Notes on the organization of the ICU data implementation
48
*
49
*      All of the public API is defined in udata.h
50
*
51
*      The implementation is split into several files...
52
*
53
*         - udata.c  (this file) contains higher level code that knows about
54
*                     the search paths for locating data, caching opened data, etc.
55
*
56
*         - umapfile.c  contains the low level platform-specific code for actually loading
57
*                     (memory mapping, file reading, whatever) data into memory.
58
*
59
*         - ucmndata.c  deals with the tables of contents of ICU data items within
60
*                     an ICU common format data file.  The implementation includes
61
*                     an abstract interface and support for multiple TOC formats.
62
*                     All knowledge of any specific TOC format is encapsulated here.
63
*
64
*         - udatamem.c has code for managing UDataMemory structs.  These are little
65
*                     descriptor objects for blocks of memory holding ICU data of
66
*                     various types.
67
*/
68
69
/* configuration ---------------------------------------------------------- */
70
71
/* If you are excruciatingly bored turn this on .. */
72
/* #define UDATA_DEBUG 1 */
73
74
#if defined(UDATA_DEBUG)
75
#   include <stdio.h>
76
#endif
77
78
U_NAMESPACE_USE
79
80
/*
81
 *  Forward declarations
82
 */
83
static UDataMemory *udata_findCachedData(const char *path, UErrorCode &err);
84
85
/***********************************************************************
86
*
87
*    static (Global) data
88
*
89
************************************************************************/
90
91
/*
92
 * Pointers to the common ICU data.
93
 *
94
 * We store multiple pointers to ICU data packages and iterate through them
95
 * when looking for a data item.
96
 *
97
 * It is possible to combine this with dependency inversion:
98
 * One or more data package libraries may export
99
 * functions that each return a pointer to their piece of the ICU data,
100
 * and this file would import them as weak functions, without a
101
 * strong linker dependency from the common library on the data library.
102
 *
103
 * Then we can have applications depend on only that part of ICU's data
104
 * that they really need, reducing the size of binaries that take advantage
105
 * of this.
106
 */
107
static UDataMemory *gCommonICUDataArray[10] = { nullptr };   // Access protected by icu global mutex.
108
109
static u_atomic_int32_t gHaveTriedToLoadCommonData {0};  //  See extendICUData().
110
111
static UHashtable  *gCommonDataCache = nullptr;  /* Global hash table of opened ICU data files.  */
112
static icu::UInitOnce gCommonDataCacheInitOnce {};
113
114
#if !defined(ICU_DATA_DIR_WINDOWS)
115
static UDataFileAccess  gDataFileAccess = UDATA_DEFAULT_ACCESS;  // Access not synchronized.
116
                                                                 // Modifying is documented as thread-unsafe.
117
#else
118
// If we are using the Windows data directory, then look in one spot only.
119
static UDataFileAccess  gDataFileAccess = UDATA_NO_FILES;
120
#endif
121
122
static UBool U_CALLCONV
123
udata_cleanup()
124
0
{
125
0
    int32_t i;
126
127
0
    if (gCommonDataCache) {             /* Delete the cache of user data mappings.  */
128
0
        uhash_close(gCommonDataCache);  /*   Table owns the contents, and will delete them. */
129
0
        gCommonDataCache = nullptr;        /*   Cleanup is not thread safe.                */
130
0
    }
131
0
    gCommonDataCacheInitOnce.reset();
132
133
0
    for (i = 0; i < UPRV_LENGTHOF(gCommonICUDataArray) && gCommonICUDataArray[i] != nullptr; ++i) {
134
0
        udata_close(gCommonICUDataArray[i]);
135
0
        gCommonICUDataArray[i] = nullptr;
136
0
    }
137
0
    gHaveTriedToLoadCommonData = 0;
138
139
0
    return true;                   /* Everything was cleaned up */
140
0
}
141
142
static UBool U_CALLCONV
143
findCommonICUDataByName(const char *inBasename, UErrorCode &err)
144
0
{
145
0
    UBool found = false;
146
0
    int32_t i;
147
148
0
    UDataMemory  *pData = udata_findCachedData(inBasename, err);
149
0
    if (U_FAILURE(err) || pData == nullptr)
150
0
        return false;
151
152
0
    {
153
0
        Mutex lock;
154
0
        for (i = 0; i < UPRV_LENGTHOF(gCommonICUDataArray); ++i) {
155
0
            if ((gCommonICUDataArray[i] != nullptr) && (gCommonICUDataArray[i]->pHeader == pData->pHeader)) {
156
                /* The data pointer is already in the array. */
157
0
                found = true;
158
0
                break;
159
0
            }
160
0
        }
161
0
    }
162
0
    return found;
163
0
}
164
165
166
/*
167
 * setCommonICUData.   Set a UDataMemory to be the global ICU Data
168
 */
169
static UBool
170
setCommonICUData(UDataMemory *pData,     /*  The new common data.  Belongs to caller, we copy it. */
171
                 UBool       warn,       /*  If true, set USING_DEFAULT warning if ICUData was    */
172
                                         /*    changed by another thread before we got to it.     */
173
                 UErrorCode *pErr)
174
1
{
175
1
    UDataMemory  *newCommonData = UDataMemory_createNewInstance(pErr);
176
1
    int32_t i;
177
1
    UBool didUpdate = false;
178
1
    if (U_FAILURE(*pErr)) {
179
0
        return false;
180
0
    }
181
182
    /*  For the assignment, other threads must cleanly see either the old            */
183
    /*    or the new, not some partially initialized new.  The old can not be        */
184
    /*    deleted - someone may still have a pointer to it lying around in           */
185
    /*    their locals.                                                              */
186
1
    UDatamemory_assign(newCommonData, pData);
187
1
    umtx_lock(nullptr);
188
1
    for (i = 0; i < UPRV_LENGTHOF(gCommonICUDataArray); ++i) {
189
1
        if (gCommonICUDataArray[i] == nullptr) {
190
1
            gCommonICUDataArray[i] = newCommonData;
191
1
            didUpdate = true;
192
1
            break;
193
1
        } else if (gCommonICUDataArray[i]->pHeader == pData->pHeader) {
194
            /* The same data pointer is already in the array. */
195
0
            break;
196
0
        }
197
1
    }
198
1
    umtx_unlock(nullptr);
199
200
1
    if (i == UPRV_LENGTHOF(gCommonICUDataArray) && warn) {
201
0
        *pErr = U_USING_DEFAULT_WARNING;
202
0
    }
203
1
    if (didUpdate) {
204
1
        ucln_common_registerCleanup(UCLN_COMMON_UDATA, udata_cleanup);
205
1
    } else {
206
0
        uprv_free(newCommonData);
207
0
    }
208
1
    return didUpdate;
209
1
}
210
211
#if !defined(ICU_DATA_DIR_WINDOWS)
212
213
static UBool
214
1
setCommonICUDataPointer(const void *pData, UBool /*warn*/, UErrorCode *pErrorCode) {
215
1
    UDataMemory tData;
216
1
    UDataMemory_init(&tData);
217
1
    UDataMemory_setData(&tData, pData);
218
1
    udata_checkCommonData(&tData, pErrorCode);
219
1
    return setCommonICUData(&tData, false, pErrorCode);
220
1
}
221
222
#endif
223
224
static const char *
225
0
findBasename(const char *path) {
226
0
    const char *basename=uprv_strrchr(path, U_FILE_SEP_CHAR);
227
0
    if(basename==nullptr) {
228
0
        return path;
229
0
    } else {
230
0
        return basename+1;
231
0
    }
232
0
}
233
234
#ifdef UDATA_DEBUG
235
static const char *
236
packageNameFromPath(const char *path)
237
{
238
    if((path == nullptr) || (*path == 0)) {
239
        return U_ICUDATA_NAME;
240
    }
241
242
    path = findBasename(path);
243
244
    if((path == nullptr) || (*path == 0)) {
245
        return U_ICUDATA_NAME;
246
    }
247
248
    return path;
249
}
250
#endif
251
252
/*----------------------------------------------------------------------*
253
 *                                                                      *
254
 *   Cache for common data                                              *
255
 *      Functions for looking up or adding entries to a cache of        *
256
 *      data that has been previously opened.  Avoids a potentially     *
257
 *      expensive operation of re-opening the data for subsequent       *
258
 *      uses.                                                           *
259
 *                                                                      *
260
 *      Data remains cached for the duration of the process.            *
261
 *                                                                      *
262
 *----------------------------------------------------------------------*/
263
264
typedef struct DataCacheElement {
265
    char          *name;
266
    UDataMemory   *item;
267
} DataCacheElement;
268
269
270
271
/*
272
 * Deleter function for DataCacheElements.
273
 *         udata cleanup function closes the hash table; hash table in turn calls back to
274
 *         here for each entry.
275
 */
276
0
static void U_CALLCONV DataCacheElement_deleter(void *pDCEl) {
277
0
    DataCacheElement* p = static_cast<DataCacheElement*>(pDCEl);
278
0
    udata_close(p->item);              /* unmaps storage */
279
0
    uprv_free(p->name);                /* delete the hash key string. */
280
0
    uprv_free(pDCEl);                  /* delete 'this'          */
281
0
}
282
283
0
static void U_CALLCONV udata_initHashTable(UErrorCode &err) {
284
0
    U_ASSERT(gCommonDataCache == nullptr);
285
0
    gCommonDataCache = uhash_open(uhash_hashChars, uhash_compareChars, nullptr, &err);
286
0
    if (U_FAILURE(err)) {
287
0
       return;
288
0
    }
289
0
    U_ASSERT(gCommonDataCache != nullptr);
290
0
    uhash_setValueDeleter(gCommonDataCache, DataCacheElement_deleter);
291
0
    ucln_common_registerCleanup(UCLN_COMMON_UDATA, udata_cleanup);
292
0
}
293
294
 /*   udata_getCacheHashTable()
295
  *     Get the hash table used to store the data cache entries.
296
  *     Lazy create it if it doesn't yet exist.
297
  */
298
0
static UHashtable *udata_getHashTable(UErrorCode &err) {
299
0
    umtx_initOnce(gCommonDataCacheInitOnce, &udata_initHashTable, err);
300
0
    return gCommonDataCache;
301
0
}
302
303
304
305
static UDataMemory *udata_findCachedData(const char *path, UErrorCode &err)
306
0
{
307
0
    UHashtable        *htable;
308
0
    UDataMemory       *retVal = nullptr;
309
0
    DataCacheElement  *el;
310
0
    const char        *baseName;
311
312
0
    htable = udata_getHashTable(err);
313
0
    if (U_FAILURE(err)) {
314
0
        return nullptr;
315
0
    }
316
317
0
    baseName = findBasename(path);   /* Cache remembers only the base name, not the full path. */
318
0
    umtx_lock(nullptr);
319
0
    el = static_cast<DataCacheElement*>(uhash_get(htable, baseName));
320
0
    umtx_unlock(nullptr);
321
0
    if (el != nullptr) {
322
0
        retVal = el->item;
323
0
    }
324
#ifdef UDATA_DEBUG
325
    fprintf(stderr, "Cache: [%s] -> %p\n", baseName, (void*) retVal);
326
#endif
327
0
    return retVal;
328
0
}
329
330
331
0
static UDataMemory *udata_cacheDataItem(const char *path, UDataMemory *item, UErrorCode *pErr) {
332
0
    DataCacheElement *newElement;
333
0
    const char       *baseName;
334
0
    int32_t           nameLen;
335
0
    UHashtable       *htable;
336
0
    DataCacheElement *oldValue = nullptr;
337
0
    UErrorCode        subErr = U_ZERO_ERROR;
338
339
0
    htable = udata_getHashTable(*pErr);
340
0
    if (U_FAILURE(*pErr)) {
341
0
        return nullptr;
342
0
    }
343
344
    /* Create a new DataCacheElement - the thingy we store in the hash table -
345
     * and copy the supplied path and UDataMemoryItems into it.
346
     */
347
0
    newElement = static_cast<DataCacheElement*>(uprv_malloc(sizeof(DataCacheElement)));
348
0
    if (newElement == nullptr) {
349
0
        *pErr = U_MEMORY_ALLOCATION_ERROR;
350
0
        return nullptr;
351
0
    }
352
0
    newElement->item = UDataMemory_createNewInstance(pErr);
353
0
    if (U_FAILURE(*pErr)) {
354
0
        uprv_free(newElement);
355
0
        return nullptr;
356
0
    }
357
0
    UDatamemory_assign(newElement->item, item);
358
359
0
    baseName = findBasename(path);
360
0
    nameLen = static_cast<int32_t>(uprv_strlen(baseName));
361
0
    newElement->name = static_cast<char*>(uprv_malloc(nameLen + 1));
362
0
    if (newElement->name == nullptr) {
363
0
        *pErr = U_MEMORY_ALLOCATION_ERROR;
364
0
        uprv_free(newElement->item);
365
0
        uprv_free(newElement);
366
0
        return nullptr;
367
0
    }
368
0
    uprv_strcpy(newElement->name, baseName);
369
370
    /* Stick the new DataCacheElement into the hash table.
371
    */
372
0
    umtx_lock(nullptr);
373
0
    oldValue = static_cast<DataCacheElement*>(uhash_get(htable, path));
374
0
    if (oldValue != nullptr) {
375
0
        subErr = U_USING_DEFAULT_WARNING;
376
0
    }
377
0
    else {
378
0
        uhash_put(
379
0
            htable,
380
0
            newElement->name,               /* Key   */
381
0
            newElement,                     /* Value */
382
0
            &subErr);
383
0
    }
384
0
    umtx_unlock(nullptr);
385
386
#ifdef UDATA_DEBUG
387
    fprintf(stderr, "Cache: [%s] <<< %p : %s. vFunc=%p\n", newElement->name, 
388
    (void*) newElement->item, u_errorName(subErr), (void*) newElement->item->vFuncs);
389
#endif
390
391
0
    if (subErr == U_USING_DEFAULT_WARNING || U_FAILURE(subErr)) {
392
0
        *pErr = subErr; /* copy sub err unto fillin ONLY if something happens. */
393
0
        uprv_free(newElement->name);
394
0
        uprv_free(newElement->item);
395
0
        uprv_free(newElement);
396
0
        return oldValue ? oldValue->item : nullptr;
397
0
    }
398
399
0
    return newElement->item;
400
0
}
401
402
/*----------------------------------------------------------------------*==============
403
 *                                                                      *
404
 *  Path management.  Could be shared with other tools/etc if need be   *
405
 * later on.                                                            *
406
 *                                                                      *
407
 *----------------------------------------------------------------------*/
408
409
U_NAMESPACE_BEGIN
410
411
class UDataPathIterator
412
{
413
public:
414
    UDataPathIterator(const char *path, const char *pkg,
415
                      const char *item, const char *suffix, UBool doCheckLastFour,
416
                      UErrorCode *pErrorCode);
417
    const char *next(UErrorCode *pErrorCode);
418
419
private:
420
    const char *path;                              /* working path (u_icudata_Dir) */
421
    const char *nextPath;                          /* path following this one */
422
    const char *basename;                          /* item's basename (icudt22e_mt.res)*/
423
424
    StringPiece suffix;                            /* item suffix (can be null) */
425
426
    uint32_t    basenameLen;                       /* length of basename */
427
428
    CharString  itemPath;                          /* path passed in with item name */
429
    CharString  pathBuffer;                        /* output path for this it'ion */
430
    CharString  packageStub;                       /* example:  "/icudt28b". Will ignore that leaf in set paths. */
431
432
    UBool       checkLastFour;                     /* if true then allow paths such as '/foo/myapp.dat'
433
                                                    * to match, checks last 4 chars of suffix with
434
                                                    * last 4 of path, then previous chars. */
435
};
436
437
/**
438
 * @param iter    The iterator to be initialized. Its current state does not matter.
439
 * @param inPath  The full pathname to be iterated over.  If nullptr, defaults to U_ICUDATA_NAME 
440
 * @param pkg     Package which is being searched for, ex "icudt28l".  Will ignore leaf directories such as /icudt28l 
441
 * @param item    Item to be searched for.  Can include full path, such as /a/b/foo.dat 
442
 * @param inSuffix  Optional item suffix, if not-null (ex. ".dat") then 'path' can contain 'item' explicitly.
443
 *             Ex:   'stuff.dat' would be found in '/a/foo:/tmp/stuff.dat:/bar/baz' as item #2.   
444
 *                   '/blarg/stuff.dat' would also be found.
445
 *  Note: inSuffix may also be the 'item' being searched for as well, (ex: "ibm-5348_P100-1997.cnv"), in which case 
446
 *        the 'item' parameter is often the same as pkg. (Though sometimes might have a tree part as well, ex: "icudt62l-curr").
447
 */
448
UDataPathIterator::UDataPathIterator(const char *inPath, const char *pkg,
449
                                     const char *item, const char *inSuffix, UBool doCheckLastFour,
450
                                     UErrorCode *pErrorCode)
451
0
{
452
#ifdef UDATA_DEBUG
453
        fprintf(stderr, "SUFFIX1=%s PATH=%s\n", inSuffix, inPath);
454
#endif
455
    /** Path **/
456
0
    if(inPath == nullptr) {
457
0
        path = u_getDataDirectory();
458
0
    } else {
459
0
        path = inPath;
460
0
    }
461
462
    /** Package **/
463
0
    if(pkg != nullptr) {
464
0
      packageStub.append(U_FILE_SEP_CHAR, *pErrorCode).append(pkg, *pErrorCode);
465
#ifdef UDATA_DEBUG
466
      fprintf(stderr, "STUB=%s [%d]\n", packageStub.data(), packageStub.length());
467
#endif
468
0
    }
469
470
    /** Item **/
471
0
    basename = findBasename(item);
472
0
    basenameLen = static_cast<int32_t>(uprv_strlen(basename));
473
474
    /** Item path **/
475
0
    if(basename == item) {
476
0
        nextPath = path;
477
0
    } else {
478
0
        itemPath.append(item, static_cast<int32_t>(basename - item), *pErrorCode);
479
0
        nextPath = itemPath.data();
480
0
    }
481
#ifdef UDATA_DEBUG
482
    fprintf(stderr, "SUFFIX=%s [%p]\n", inSuffix, (void*) inSuffix);
483
#endif
484
485
    /** Suffix  **/
486
0
    if(inSuffix != nullptr) {
487
0
        suffix = inSuffix;
488
0
    } else {
489
0
        suffix = "";
490
0
    }
491
492
0
    checkLastFour = doCheckLastFour;
493
494
    /* pathBuffer will hold the output path strings returned by this iterator */
495
496
#ifdef UDATA_DEBUG
497
    fprintf(stderr, "0: init %s -> [path=%s], [base=%s], [suff=%s], [itempath=%s], [nextpath=%s], [checklast4=%s]\n",
498
            item,
499
            path,
500
            basename,
501
            suffix.data(),
502
            itemPath.data(),
503
            nextPath,
504
            checkLastFour?"true":"false");
505
#endif
506
0
}
507
508
/**
509
 * Get the next path on the list.
510
 *
511
 * @param iter The Iter to be used 
512
 * @param len  If set, pointer to the length of the returned path, for convenience. 
513
 * @return Pointer to the next path segment, or nullptr if there are no more.
514
 */
515
const char *UDataPathIterator::next(UErrorCode *pErrorCode)
516
0
{
517
0
    if(U_FAILURE(*pErrorCode)) {
518
0
        return nullptr;
519
0
    }
520
521
0
    const char *currentPath = nullptr;
522
0
    int32_t     pathLen = 0;
523
0
    const char *pathBasename;
524
525
0
    do
526
0
    {
527
0
        if( nextPath == nullptr ) {
528
0
            break;
529
0
        }
530
0
        currentPath = nextPath;
531
532
0
        if(nextPath == itemPath.data()) { /* we were processing item's path. */
533
0
            nextPath = path; /* start with regular path next tm. */
534
0
            pathLen = static_cast<int32_t>(uprv_strlen(currentPath));
535
0
        } else {
536
            /* fix up next for next time */
537
0
            nextPath = uprv_strchr(currentPath, U_PATH_SEP_CHAR);
538
0
            if(nextPath == nullptr) {
539
                /* segment: entire path */
540
0
                pathLen = static_cast<int32_t>(uprv_strlen(currentPath));
541
0
            } else {
542
                /* segment: until next segment */
543
0
                pathLen = static_cast<int32_t>(nextPath - currentPath);
544
                /* skip divider */
545
0
                nextPath ++;
546
0
            }
547
0
        }
548
549
0
        if(pathLen == 0) {
550
0
            continue;
551
0
        }
552
553
#ifdef UDATA_DEBUG
554
        fprintf(stderr, "rest of path (IDD) = %s\n", currentPath);
555
        fprintf(stderr, "                     ");
556
        { 
557
            int32_t qqq;
558
            for(qqq=0;qqq<pathLen;qqq++)
559
            {
560
                fprintf(stderr, " ");
561
            }
562
563
            fprintf(stderr, "^\n");
564
        }
565
#endif
566
0
        pathBuffer.clear().append(currentPath, pathLen, *pErrorCode);
567
568
        /* check for .dat files */
569
0
        pathBasename = findBasename(pathBuffer.data());
570
571
0
        if(checkLastFour && 
572
0
           (pathLen>=4) &&
573
0
           uprv_strncmp(pathBuffer.data() +(pathLen-4), suffix.data(), 4)==0 && /* suffix matches */
574
0
           uprv_strncmp(findBasename(pathBuffer.data()), basename, basenameLen)==0  && /* base matches */
575
0
           uprv_strlen(pathBasename)==(basenameLen+4)) { /* base+suffix = full len */
576
577
#ifdef UDATA_DEBUG
578
            fprintf(stderr, "Have %s file on the path: %s\n", suffix.data(), pathBuffer.data());
579
#endif
580
            /* do nothing */
581
0
        }
582
0
        else 
583
0
        {       /* regular dir path */
584
0
            if(pathBuffer[pathLen-1] != U_FILE_SEP_CHAR) {
585
0
                if((pathLen>=4) &&
586
0
                   uprv_strncmp(pathBuffer.data()+(pathLen-4), ".dat", 4) == 0)
587
0
                {
588
#ifdef UDATA_DEBUG
589
                    fprintf(stderr, "skipping non-directory .dat file %s\n", pathBuffer.data());
590
#endif
591
0
                    continue;
592
0
                }
593
594
                /* Check if it is a directory with the same name as our package */
595
0
                if(!packageStub.isEmpty() &&
596
0
                   (pathLen > packageStub.length()) &&
597
0
                   !uprv_strcmp(pathBuffer.data() + pathLen - packageStub.length(), packageStub.data())) {
598
#ifdef UDATA_DEBUG
599
                  fprintf(stderr, "Found stub %s (will add package %s of len %d)\n", packageStub.data(), basename, basenameLen);
600
#endif
601
0
                  pathBuffer.truncate(pathLen - packageStub.length());
602
0
                }
603
0
                pathBuffer.append(U_FILE_SEP_CHAR, *pErrorCode);
604
0
            }
605
606
            /* + basename */
607
0
            pathBuffer.append(packageStub.data()+1, packageStub.length()-1, *pErrorCode);
608
609
0
            if (!suffix.empty())  /* tack on suffix */
610
0
            {
611
0
                if (suffix.length() > 4) {
612
                    // If the suffix is actually an item ("ibm-5348_P100-1997.cnv") and not an extension (".res")
613
                    // then we need to ensure that the path ends with a separator.
614
0
                    pathBuffer.ensureEndsWithFileSeparator(*pErrorCode);
615
0
                }
616
0
                pathBuffer.append(suffix, *pErrorCode);
617
0
            }
618
0
        }
619
620
#ifdef UDATA_DEBUG
621
        fprintf(stderr, " -->  %s\n", pathBuffer.data());
622
#endif
623
624
0
        return pathBuffer.data();
625
626
0
    } while(path);
627
628
    /* fell way off the end */
629
0
    return nullptr;
630
0
}
631
632
U_NAMESPACE_END
633
634
/* ==================================================================================*/
635
636
637
/*----------------------------------------------------------------------*
638
 *                                                                      *
639
 *  Add a static reference to the common data library                   *
640
 *   Unless overridden by an explicit udata_setCommonData, this will be *
641
 *      our common data.                                                *
642
 *                                                                      *
643
 *----------------------------------------------------------------------*/
644
#if !defined(ICU_DATA_DIR_WINDOWS)
645
// When using the Windows system data, we expect only a single data file.
646
extern "C" const DataHeader U_DATA_API U_ICUDATA_ENTRY_POINT;
647
#endif
648
649
/*
650
 * This would be a good place for weak-linkage declarations of
651
 * partial-data-library access functions where each returns a pointer
652
 * to its data package, if it is linked in.
653
 */
654
/*
655
extern const void *uprv_getICUData_collation() ATTRIBUTE_WEAK;
656
extern const void *uprv_getICUData_conversion() ATTRIBUTE_WEAK;
657
*/
658
659
/*----------------------------------------------------------------------*
660
 *                                                                      *
661
 *   openCommonData   Attempt to open a common format (.dat) file       *
662
 *                    Map it into memory (if it's not there already)    *
663
 *                    and return a UDataMemory object for it.           *
664
 *                                                                      *
665
 *                    If the requested data is already open and cached  *
666
 *                       just return the cached UDataMem object.        *
667
 *                                                                      *
668
 *----------------------------------------------------------------------*/
669
static UDataMemory *
670
openCommonData(const char *path,          /*  Path from OpenChoice?          */
671
               int32_t commonDataIndex,   /*  ICU Data (index >= 0) if path == nullptr */
672
               UErrorCode *pErrorCode)
673
2
{
674
2
    UDataMemory tData;
675
2
    const char *pathBuffer;
676
2
    const char *inBasename;
677
678
2
    if (U_FAILURE(*pErrorCode)) {
679
0
        return nullptr;
680
0
    }
681
682
2
    UDataMemory_init(&tData);
683
684
    /* ??????? TODO revisit this */ 
685
2
    if (commonDataIndex >= 0) {
686
        /* "mini-cache" for common ICU data */
687
2
        if(commonDataIndex >= UPRV_LENGTHOF(gCommonICUDataArray)) {
688
0
            return nullptr;
689
0
        }
690
2
        {
691
2
            Mutex lock;
692
2
            if(gCommonICUDataArray[commonDataIndex] != nullptr) {
693
1
                return gCommonICUDataArray[commonDataIndex];
694
1
            }
695
1
#if !defined(ICU_DATA_DIR_WINDOWS)
696
// When using the Windows system data, we expect only a single data file.
697
1
            int32_t i;
698
1
            for(i = 0; i < commonDataIndex; ++i) {
699
0
                if(gCommonICUDataArray[i]->pHeader == &U_ICUDATA_ENTRY_POINT) {
700
                    /* The linked-in data is already in the list. */
701
0
                    return nullptr;
702
0
                }
703
0
            }
704
1
#endif
705
1
        }
706
707
        /* Add the linked-in data to the list. */
708
        /*
709
         * This is where we would check and call weakly linked partial-data-library
710
         * access functions.
711
         */
712
        /*
713
        if (uprv_getICUData_collation) {
714
            setCommonICUDataPointer(uprv_getICUData_collation(), false, pErrorCode);
715
        }
716
        if (uprv_getICUData_conversion) {
717
            setCommonICUDataPointer(uprv_getICUData_conversion(), false, pErrorCode);
718
        }
719
        */
720
1
#if !defined(ICU_DATA_DIR_WINDOWS)
721
// When using the Windows system data, we expect only a single data file.
722
1
        setCommonICUDataPointer(&U_ICUDATA_ENTRY_POINT, false, pErrorCode);
723
1
        {
724
1
            Mutex lock;
725
1
            return gCommonICUDataArray[commonDataIndex];
726
1
        }
727
1
#endif
728
1
    }
729
730
731
    /* request is NOT for ICU Data.  */
732
733
    /* Find the base name portion of the supplied path.   */
734
    /*   inBasename will be left pointing somewhere within the original path string.      */
735
0
    inBasename = findBasename(path);
736
#ifdef UDATA_DEBUG
737
    fprintf(stderr, "inBasename = %s\n", inBasename);
738
#endif
739
740
0
    if(*inBasename==0) {
741
        /* no basename.     This will happen if the original path was a directory name,   */
742
        /*    like  "a/b/c/".   (Fallback to separate files will still work.)             */
743
#ifdef UDATA_DEBUG
744
        fprintf(stderr, "ocd: no basename in %s, bailing.\n", path);
745
#endif
746
0
        if (U_SUCCESS(*pErrorCode)) {
747
0
            *pErrorCode=U_FILE_ACCESS_ERROR;
748
0
        }
749
0
        return nullptr;
750
0
    }
751
752
   /* Is the requested common data file already open and cached?                     */
753
   /*   Note that the cache is keyed by the base name only.  The rest of the path,   */
754
   /*     if any, is not considered.                                                 */
755
0
    UDataMemory  *dataToReturn = udata_findCachedData(inBasename, *pErrorCode);
756
0
    if (dataToReturn != nullptr || U_FAILURE(*pErrorCode)) {
757
0
        return dataToReturn;
758
0
    }
759
760
    /* Requested item is not in the cache.
761
     * Hunt it down, trying all the path locations
762
     */
763
764
0
    UDataPathIterator iter(u_getDataDirectory(), inBasename, path, ".dat", true, pErrorCode);
765
766
0
    while ((UDataMemory_isLoaded(&tData)==false) && (pathBuffer = iter.next(pErrorCode)) != nullptr)
767
0
    {
768
#ifdef UDATA_DEBUG
769
        fprintf(stderr, "ocd: trying path %s - ", pathBuffer);
770
#endif
771
0
        uprv_mapFile(&tData, pathBuffer, pErrorCode);
772
#ifdef UDATA_DEBUG
773
        fprintf(stderr, "%s\n", UDataMemory_isLoaded(&tData)?"LOADED":"not loaded");
774
#endif
775
0
    }
776
0
    if (U_FAILURE(*pErrorCode)) {
777
0
        return nullptr;
778
0
    }
779
780
0
    if (U_FAILURE(*pErrorCode)) {
781
0
        return nullptr;
782
0
    }
783
0
    if (!UDataMemory_isLoaded(&tData)) {
784
        /* no common data */
785
0
        *pErrorCode=U_FILE_ACCESS_ERROR;
786
0
        return nullptr;
787
0
    }
788
789
    /* we have mapped a file, check its header */
790
0
    udata_checkCommonData(&tData, pErrorCode);
791
792
793
    /* Cache the UDataMemory struct for this .dat file,
794
     *   so we won't need to hunt it down and map it again next time
795
     *   something is needed from it.                */
796
0
    return udata_cacheDataItem(inBasename, &tData, pErrorCode);
797
0
}
798
799
800
/*----------------------------------------------------------------------*
801
 *                                                                      *
802
 *   extendICUData   If the full set of ICU data was not loaded at      *
803
 *                   program startup, load it now.  This function will  *
804
 *                   be called when the lookup of an ICU data item in   *
805
 *                   the common ICU data fails.                         *
806
 *                                                                      *
807
 *                   return true if new data is loaded, false otherwise.*
808
 *                                                                      *
809
 *----------------------------------------------------------------------*/
810
static UBool extendICUData(UErrorCode *pErr)
811
0
{
812
0
    UDataMemory   *pData;
813
0
    UDataMemory   copyPData;
814
0
    UBool         didUpdate = false;
815
816
    /*
817
     * There is a chance for a race condition here.
818
     * Normally, ICU data is loaded from a DLL or via mmap() and
819
     * setCommonICUData() will detect if the same address is set twice.
820
     * If ICU is built with data loading via fread() then the address will
821
     * be different each time the common data is loaded and we may add
822
     * multiple copies of the data.
823
     * In this case, use a mutex to prevent the race.
824
     * Use a specific mutex to avoid nested locks of the global mutex.
825
     */
826
#if MAP_IMPLEMENTATION==MAP_STDIO
827
    static UMutex extendICUDataMutex;
828
    umtx_lock(&extendICUDataMutex);
829
#endif
830
0
    if(!umtx_loadAcquire(gHaveTriedToLoadCommonData)) {
831
        /* See if we can explicitly open a .dat file for the ICUData. */
832
0
        pData = openCommonData(
833
0
                   U_ICUDATA_NAME,            /*  "icudt20l" , for example.          */
834
0
                   -1,                        /*  Pretend we're not opening ICUData  */
835
0
                   pErr);
836
837
        /* How about if there is no pData, eh... */
838
839
0
       UDataMemory_init(&copyPData);
840
0
       if(pData != nullptr) {
841
0
          UDatamemory_assign(&copyPData, pData);
842
0
          copyPData.map = nullptr;     /* The mapping for this data is owned by the hash table */
843
0
          copyPData.mapAddr = nullptr; /*   which will unmap it when ICU is shut down.         */
844
                                       /* CommonICUData is also unmapped when ICU is shut down.*/
845
                                       /* To avoid unmapping the data twice, zero out the map  */
846
                                       /*   fields in the UDataMemory that we're assigning     */
847
                                       /*   to CommonICUData.                                  */
848
849
0
          didUpdate = /* no longer using this result */
850
0
              setCommonICUData(&copyPData,/*  The new common data.                                */
851
0
                       false,             /*  No warnings if write didn't happen                  */
852
0
                       pErr);             /*  setCommonICUData honors errors; NOP if error set    */
853
0
        }
854
855
0
        umtx_storeRelease(gHaveTriedToLoadCommonData, 1);
856
0
    }
857
858
0
    didUpdate = findCommonICUDataByName(U_ICUDATA_NAME, *pErr);  /* Return 'true' when a racing writes out the extended                 */
859
                                                          /* data after another thread has failed to see it (in openCommonData), so     */
860
                                                          /* extended data can be examined.                                             */
861
                                                          /* Also handles a race through here before gHaveTriedToLoadCommonData is set. */
862
863
#if MAP_IMPLEMENTATION==MAP_STDIO
864
    umtx_unlock(&extendICUDataMutex);
865
#endif
866
0
    return didUpdate;               /* Return true if ICUData pointer was updated.   */
867
                                    /*   (Could potentially have been done by another thread racing */
868
                                    /*   us through here, but that's fine, we still return true    */
869
                                    /*   so that current thread will also examine extended data.   */
870
0
}
871
872
/*----------------------------------------------------------------------*
873
 *                                                                      *
874
 *   udata_setCommonData                                                *
875
 *                                                                      *
876
 *----------------------------------------------------------------------*/
877
U_CAPI void U_EXPORT2
878
0
udata_setCommonData(const void *data, UErrorCode *pErrorCode) {
879
0
    UDataMemory dataMemory;
880
881
0
    if(pErrorCode==nullptr || U_FAILURE(*pErrorCode)) {
882
0
        return;
883
0
    }
884
885
0
    if(data==nullptr) {
886
0
        *pErrorCode=U_ILLEGAL_ARGUMENT_ERROR;
887
0
        return;
888
0
    }
889
890
    /* set the data pointer and test for validity */
891
0
    UDataMemory_init(&dataMemory);
892
0
    UDataMemory_setData(&dataMemory, data);
893
0
    udata_checkCommonData(&dataMemory, pErrorCode);
894
0
    if (U_FAILURE(*pErrorCode)) {return;}
895
896
    /* we have good data */
897
    /* Set it up as the ICU Common Data.  */
898
0
    setCommonICUData(&dataMemory, true, pErrorCode);
899
0
}
900
901
/*---------------------------------------------------------------------------
902
 *
903
 *  udata_setAppData
904
 *
905
 *---------------------------------------------------------------------------- */
906
U_CAPI void U_EXPORT2
907
udata_setAppData(const char *path, const void *data, UErrorCode *err)
908
0
{
909
0
    UDataMemory     udm;
910
911
0
    if(err==nullptr || U_FAILURE(*err)) {
912
0
        return;
913
0
    }
914
0
    if(data==nullptr) {
915
0
        *err=U_ILLEGAL_ARGUMENT_ERROR;
916
0
        return;
917
0
    }
918
919
0
    UDataMemory_init(&udm);
920
0
    UDataMemory_setData(&udm, data);
921
0
    udata_checkCommonData(&udm, err);
922
0
    udata_cacheDataItem(path, &udm, err);
923
0
}
924
925
/*----------------------------------------------------------------------------*
926
 *                                                                            *
927
 *  checkDataItem     Given a freshly located/loaded data item, either        *
928
 *                    an entry in a common file or a separately loaded file,  *
929
 *                    sanity check its header, and see if the data is         *
930
 *                    acceptable to the app.                                  *
931
 *                    If the data is good, create and return a UDataMemory    *
932
 *                    object that can be returned to the application.         *
933
 *                    Return nullptr on any sort of failure.                     *
934
 *                                                                            *
935
 *----------------------------------------------------------------------------*/
936
static UDataMemory *
937
checkDataItem
938
(
939
 const DataHeader         *pHeader,         /* The data item to be checked.                */
940
 UDataMemoryIsAcceptable  *isAcceptable,    /* App's call-back function                    */
941
 void                     *context,         /*   pass-thru param for above.                */
942
 const char               *type,            /*   pass-thru param for above.                */
943
 const char               *name,            /*   pass-thru param for above.                */
944
 UErrorCode               *nonFatalErr,     /* Error code if this data was not acceptable  */
945
                                            /*   but openChoice should continue with       */
946
                                            /*   trying to get data from fallback path.    */
947
 UErrorCode               *fatalErr         /* Bad error, caller should return immediately */
948
 )
949
2
{
950
2
    UDataMemory  *rDataMem = nullptr;          /* the new UDataMemory, to be returned.        */
951
952
2
    if (U_FAILURE(*fatalErr)) {
953
0
        return nullptr;
954
0
    }
955
956
2
    if(pHeader->dataHeader.magic1==0xda &&
957
2
        pHeader->dataHeader.magic2==0x27 &&
958
2
        (isAcceptable==nullptr || isAcceptable(context, type, name, &pHeader->info))
959
2
    ) {
960
2
        rDataMem=UDataMemory_createNewInstance(fatalErr);
961
2
        if (U_FAILURE(*fatalErr)) {
962
0
            return nullptr;
963
0
        }
964
2
        rDataMem->pHeader = pHeader;
965
2
    } else {
966
        /* the data is not acceptable, look further */
967
        /* If we eventually find something good, this errorcode will be */
968
        /*    cleared out.                                              */
969
0
        *nonFatalErr=U_INVALID_FORMAT_ERROR;
970
0
    }
971
2
    return rDataMem;
972
2
}
973
974
/**
975
 * @return 0 if not loaded, 1 if loaded or err 
976
 */
977
static UDataMemory *doLoadFromIndividualFiles(const char *pkgName, 
978
        const char *dataPath, const char *tocEntryPathSuffix,
979
            /* following arguments are the same as doOpenChoice itself */
980
            const char *path, const char *type, const char *name,
981
             UDataMemoryIsAcceptable *isAcceptable, void *context,
982
             UErrorCode *subErrorCode,
983
             UErrorCode *pErrorCode)
984
0
{
985
0
    const char         *pathBuffer;
986
0
    UDataMemory         dataMemory;
987
0
    UDataMemory *pEntryData;
988
989
    /* look in ind. files: package\nam.typ  ========================= */
990
    /* init path iterator for individual files */
991
0
    UDataPathIterator iter(dataPath, pkgName, path, tocEntryPathSuffix, false, pErrorCode);
992
993
0
    while ((pathBuffer = iter.next(pErrorCode)) != nullptr)
994
0
    {
995
#ifdef UDATA_DEBUG
996
        fprintf(stderr, "UDATA: trying individual file %s\n", pathBuffer);
997
#endif
998
0
        if (uprv_mapFile(&dataMemory, pathBuffer, pErrorCode))
999
0
        {
1000
0
            pEntryData = checkDataItem(dataMemory.pHeader, isAcceptable, context, type, name, subErrorCode, pErrorCode);
1001
0
            if (pEntryData != nullptr) {
1002
                /* Data is good.
1003
                *  Hand off ownership of the backing memory to the user's UDataMemory.
1004
                *  and return it.   */
1005
0
                pEntryData->mapAddr = dataMemory.mapAddr;
1006
0
                pEntryData->map     = dataMemory.map;
1007
1008
#ifdef UDATA_DEBUG
1009
                fprintf(stderr, "** Mapped file: %s\n", pathBuffer);
1010
#endif
1011
0
                return pEntryData;
1012
0
            }
1013
1014
            /* the data is not acceptable, or some error occurred.  Either way, unmap the memory */
1015
0
            udata_close(&dataMemory);
1016
1017
            /* If we had a nasty error, bail out completely.  */
1018
0
            if (U_FAILURE(*pErrorCode)) {
1019
0
                return nullptr;
1020
0
            }
1021
1022
            /* Otherwise remember that we found data but didn't like it for some reason  */
1023
0
            *subErrorCode=U_INVALID_FORMAT_ERROR;
1024
0
        }
1025
#ifdef UDATA_DEBUG
1026
        fprintf(stderr, "%s\n", UDataMemory_isLoaded(&dataMemory)?"LOADED":"not loaded");
1027
#endif
1028
0
    }
1029
0
    return nullptr;
1030
0
}
1031
1032
/**
1033
 * @return 0 if not loaded, 1 if loaded or err 
1034
 */
1035
static UDataMemory *doLoadFromCommonData(UBool isICUData, const char * /*pkgName*/, 
1036
        const char * /*dataPath*/, const char * /*tocEntryPathSuffix*/, const char *tocEntryName,
1037
            /* following arguments are the same as doOpenChoice itself */
1038
            const char *path, const char *type, const char *name,
1039
             UDataMemoryIsAcceptable *isAcceptable, void *context,
1040
             UErrorCode *subErrorCode,
1041
             UErrorCode *pErrorCode)
1042
2
{
1043
2
    UDataMemory        *pEntryData;
1044
2
    const DataHeader   *pHeader;
1045
2
    UDataMemory        *pCommonData;
1046
2
    int32_t            commonDataIndex;
1047
2
    UBool              checkedExtendedICUData = false;
1048
    /* try to get common data.  The loop is for platforms such as the 390 that do
1049
     *  not initially load the full set of ICU data.  If the lookup of an ICU data item
1050
     *  fails, the full (but slower to load) set is loaded, the and the loop repeats,
1051
     *  trying the lookup again.  Once the full set of ICU data is loaded, the loop wont
1052
     *  repeat because the full set will be checked the first time through.
1053
     *
1054
     *  The loop also handles the fallback to a .dat file if the application linked
1055
     *   to the stub data library rather than a real library.
1056
     */
1057
2
    for (commonDataIndex = isICUData ? 0 : -1;;) {
1058
2
        pCommonData=openCommonData(path, commonDataIndex, subErrorCode); /** search for pkg **/
1059
1060
2
        if(U_SUCCESS(*subErrorCode) && pCommonData!=nullptr) {
1061
2
            int32_t length;
1062
1063
            /* look up the data piece in the common data */
1064
2
            pHeader=pCommonData->vFuncs->Lookup(pCommonData, tocEntryName, &length, subErrorCode);
1065
#ifdef UDATA_DEBUG
1066
            fprintf(stderr, "%s: pHeader=%p - %s\n", tocEntryName, (void*) pHeader, u_errorName(*subErrorCode));
1067
#endif
1068
1069
2
            if(pHeader!=nullptr) {
1070
2
                pEntryData = checkDataItem(pHeader, isAcceptable, context, type, name, subErrorCode, pErrorCode);
1071
#ifdef UDATA_DEBUG
1072
                fprintf(stderr, "pEntryData=%p\n", (void*) pEntryData);
1073
#endif
1074
2
                if (U_FAILURE(*pErrorCode)) {
1075
0
                    return nullptr;
1076
0
                }
1077
2
                if (pEntryData != nullptr) {
1078
2
                    pEntryData->length = length;
1079
2
                    return pEntryData;
1080
2
                }
1081
2
            }
1082
2
        }
1083
        // If we failed due to being out-of-memory, then stop early and report the error.
1084
0
        if (*subErrorCode == U_MEMORY_ALLOCATION_ERROR) {
1085
0
            *pErrorCode = *subErrorCode;
1086
0
            return nullptr;
1087
0
        }
1088
        /* Data wasn't found.  If we were looking for an ICUData item and there is
1089
         * more data available, load it and try again,
1090
         * otherwise break out of this loop. */
1091
0
        if (!isICUData) {
1092
0
            return nullptr;
1093
0
        } else if (pCommonData != nullptr) {
1094
0
            ++commonDataIndex;  /* try the next data package */
1095
0
        } else if ((!checkedExtendedICUData) && extendICUData(subErrorCode)) {
1096
0
            checkedExtendedICUData = true;
1097
            /* try this data package slot again: it changed from nullptr to non-nullptr */
1098
0
        } else {
1099
0
            return nullptr;
1100
0
        }
1101
0
    }
1102
2
}
1103
1104
/*
1105
 * Identify the Time Zone resources that are subject to special override data loading.
1106
 */
1107
2
static UBool isTimeZoneFile(const char *name, const char *type) {
1108
2
    return ((uprv_strcmp(type, "res") == 0) &&
1109
2
            (uprv_strcmp(name, "zoneinfo64") == 0 ||
1110
2
             uprv_strcmp(name, "timezoneTypes") == 0 ||
1111
2
             uprv_strcmp(name, "windowsZones") == 0 ||
1112
2
             uprv_strcmp(name, "metaZones") == 0));
1113
2
}
1114
1115
/*
1116
 *  A note on the ownership of Mapped Memory
1117
 *
1118
 *  For common format files, ownership resides with the UDataMemory object
1119
 *    that lives in the cache of opened common data.  These UDataMemorys are private
1120
 *    to the udata implementation, and are never seen directly by users.
1121
 *
1122
 *    The UDataMemory objects returned to users will have the address of some desired
1123
 *    data within the mapped region, but they wont have the mapping info itself, and thus
1124
 *    won't cause anything to be removed from memory when they are closed.
1125
 *
1126
 *  For individual data files, the UDataMemory returned to the user holds the
1127
 *  information necessary to unmap the data on close.  If the user independently
1128
 *  opens the same data file twice, two completely independent mappings will be made.
1129
 *  (There is no cache of opened data items from individual files, only a cache of
1130
 *   opened Common Data files, that is, files containing a collection of data items.)
1131
 *
1132
 *  For common data passed in from the user via udata_setAppData() or
1133
 *  udata_setCommonData(), ownership remains with the user.
1134
 *
1135
 *  UDataMemory objects themselves, as opposed to the memory they describe,
1136
 *  can be anywhere - heap, stack/local or global.
1137
 *  They have a flag to indicate when they're heap allocated and thus
1138
 *  must be deleted when closed.
1139
 */
1140
1141
1142
/*----------------------------------------------------------------------------*
1143
 *                                                                            *
1144
 * main data loading functions                                                *
1145
 *                                                                            *
1146
 *----------------------------------------------------------------------------*/
1147
static UDataMemory *
1148
doOpenChoice(const char *path, const char *type, const char *name,
1149
             UDataMemoryIsAcceptable *isAcceptable, void *context,
1150
             UErrorCode *pErrorCode)
1151
2
{
1152
2
    UDataMemory         *retVal = nullptr;
1153
1154
2
    const char         *dataPath;
1155
1156
2
    int32_t             tocEntrySuffixIndex;
1157
2
    const char         *tocEntryPathSuffix;
1158
2
    UErrorCode          subErrorCode=U_ZERO_ERROR;
1159
2
    const char         *treeChar;
1160
1161
2
    UBool               isICUData = false;
1162
1163
1164
2
    FileTracer::traceOpen(path, type, name);
1165
1166
1167
    /* Is this path ICU data? */
1168
2
    if(path == nullptr ||
1169
2
       !strcmp(path, U_ICUDATA_ALIAS) ||  /* "ICUDATA" */
1170
2
       !uprv_strncmp(path, U_ICUDATA_NAME U_TREE_SEPARATOR_STRING, /* "icudt26e-" */
1171
2
                     uprv_strlen(U_ICUDATA_NAME U_TREE_SEPARATOR_STRING)) ||  
1172
2
       !uprv_strncmp(path, U_ICUDATA_ALIAS U_TREE_SEPARATOR_STRING, /* "ICUDATA-" */
1173
2
                     uprv_strlen(U_ICUDATA_ALIAS U_TREE_SEPARATOR_STRING))) {
1174
2
      isICUData = true;
1175
2
    }
1176
1177
#if (U_FILE_SEP_CHAR != U_FILE_ALT_SEP_CHAR)  /* Windows:  try "foo\bar" and "foo/bar" */
1178
    /* remap from alternate path char to the main one */
1179
    CharString altSepPath;
1180
    if(path) {
1181
        if(uprv_strchr(path,U_FILE_ALT_SEP_CHAR) != nullptr) {
1182
            altSepPath.append(path, *pErrorCode);
1183
            char *p;
1184
            while ((p = uprv_strchr(altSepPath.data(), U_FILE_ALT_SEP_CHAR)) != nullptr) {
1185
                *p = U_FILE_SEP_CHAR;
1186
            }
1187
#if defined (UDATA_DEBUG)
1188
            fprintf(stderr, "Changed path from [%s] to [%s]\n", path, altSepPath.data());
1189
#endif
1190
            path = altSepPath.data();
1191
        }
1192
    }
1193
#endif
1194
1195
2
    CharString tocEntryName; /* entry name in tree format. ex:  'icudt28b/coll/ar.res' */
1196
2
    CharString tocEntryPath; /* entry name in path format. ex:  'icudt28b\\coll\\ar.res' */
1197
1198
2
    CharString pkgName;
1199
2
    CharString treeName;
1200
1201
    /* ======= Set up strings */
1202
2
    if(path==nullptr) {
1203
2
        pkgName.append(U_ICUDATA_NAME, *pErrorCode);
1204
2
    } else {
1205
0
        const char *pkg;
1206
0
        const char *first;
1207
0
        pkg = uprv_strrchr(path, U_FILE_SEP_CHAR);
1208
0
        first = uprv_strchr(path, U_FILE_SEP_CHAR);
1209
0
        if(uprv_pathIsAbsolute(path) || (pkg != first)) { /* more than one slash in the path- not a tree name */
1210
            /* see if this is an /absolute/path/to/package  path */
1211
0
            if(pkg) {
1212
0
                pkgName.append(pkg+1, *pErrorCode);
1213
0
            } else {
1214
0
                pkgName.append(path, *pErrorCode);
1215
0
            }
1216
0
        } else {
1217
0
            treeChar = uprv_strchr(path, U_TREE_SEPARATOR);
1218
0
            if(treeChar) { 
1219
0
                treeName.append(treeChar+1, *pErrorCode); /* following '-' */
1220
0
                if(isICUData) {
1221
0
                    pkgName.append(U_ICUDATA_NAME, *pErrorCode);
1222
0
                } else {
1223
0
                    pkgName.append(path, static_cast<int32_t>(treeChar - path), *pErrorCode);
1224
0
                    if (first == nullptr) {
1225
                        /*
1226
                        This user data has no path, but there is a tree name.
1227
                        Look up the correct path from the data cache later.
1228
                        */
1229
0
                        path = pkgName.data();
1230
0
                    }
1231
0
                }
1232
0
            } else {
1233
0
                if(isICUData) {
1234
0
                    pkgName.append(U_ICUDATA_NAME, *pErrorCode);
1235
0
                } else {
1236
0
                    pkgName.append(path, *pErrorCode);
1237
0
                }
1238
0
            }
1239
0
        }
1240
0
    }
1241
1242
#ifdef UDATA_DEBUG
1243
    fprintf(stderr, " P=%s T=%s\n", pkgName.data(), treeName.data());
1244
#endif
1245
1246
    /* setting up the entry name and file name 
1247
     * Make up a full name by appending the type to the supplied
1248
     *  name, assuming that a type was supplied.
1249
     */
1250
1251
    /* prepend the package */
1252
2
    tocEntryName.append(pkgName, *pErrorCode);
1253
2
    tocEntryPath.append(pkgName, *pErrorCode);
1254
2
    tocEntrySuffixIndex = tocEntryName.length();
1255
1256
2
    if(!treeName.isEmpty()) {
1257
0
        tocEntryName.append(U_TREE_ENTRY_SEP_CHAR, *pErrorCode).append(treeName, *pErrorCode);
1258
0
        tocEntryPath.append(U_FILE_SEP_CHAR, *pErrorCode).append(treeName, *pErrorCode);
1259
0
    }
1260
1261
2
    tocEntryName.append(U_TREE_ENTRY_SEP_CHAR, *pErrorCode).append(name, *pErrorCode);
1262
2
    tocEntryPath.append(U_FILE_SEP_CHAR, *pErrorCode).append(name, *pErrorCode);
1263
2
    if(type!=nullptr && *type!=0) {
1264
2
        tocEntryName.append(".", *pErrorCode).append(type, *pErrorCode);
1265
2
        tocEntryPath.append(".", *pErrorCode).append(type, *pErrorCode);
1266
2
    }
1267
    // The +1 is for the U_FILE_SEP_CHAR that is always appended above.
1268
2
    tocEntryPathSuffix = tocEntryPath.data() + tocEntrySuffixIndex + 1; /* suffix starts here */
1269
1270
#ifdef UDATA_DEBUG
1271
    fprintf(stderr, " tocEntryName = %s\n", tocEntryName.data());
1272
    fprintf(stderr, " tocEntryPath = %s\n", tocEntryName.data());
1273
#endif
1274
1275
2
#if !defined(ICU_DATA_DIR_WINDOWS)
1276
2
    if(path == nullptr) {
1277
2
        path = COMMON_DATA_NAME; /* "icudt26e" */
1278
2
    }
1279
#else
1280
    // When using the Windows system data, we expects only a single data file.
1281
    path = COMMON_DATA_NAME; /* "icudt26e" */
1282
#endif
1283
1284
    /************************ Begin loop looking for ind. files ***************/
1285
#ifdef UDATA_DEBUG
1286
    fprintf(stderr, "IND: inBasename = %s, pkg=%s\n", "(n/a)", packageNameFromPath(path));
1287
#endif
1288
1289
    /* End of dealing with a null basename */
1290
2
    dataPath = u_getDataDirectory();
1291
1292
    /****    Time zone individual files override  */
1293
2
    if (isICUData && isTimeZoneFile(name, type)) {
1294
1
        const char *tzFilesDir = u_getTimeZoneFilesDirectory(pErrorCode);
1295
1
        if (tzFilesDir[0] != 0) {
1296
#ifdef UDATA_DEBUG
1297
            fprintf(stderr, "Trying Time Zone Files directory = %s\n", tzFilesDir);
1298
#endif
1299
0
            retVal = doLoadFromIndividualFiles(/* pkgName.data() */ "", tzFilesDir, tocEntryPathSuffix,
1300
0
                            /* path */ "", type, name, isAcceptable, context, &subErrorCode, pErrorCode);
1301
0
            if((retVal != nullptr) || U_FAILURE(*pErrorCode)) {
1302
0
                return retVal;
1303
0
            }
1304
0
        }
1305
1
    }
1306
1307
    /****    COMMON PACKAGE  - only if packages are first. */
1308
2
    if(gDataFileAccess == UDATA_PACKAGES_FIRST) {
1309
#ifdef UDATA_DEBUG
1310
        fprintf(stderr, "Trying packages (UDATA_PACKAGES_FIRST)\n");
1311
#endif
1312
        /* #2 */
1313
0
        retVal = doLoadFromCommonData(isICUData, 
1314
0
                            pkgName.data(), dataPath, tocEntryPathSuffix, tocEntryName.data(),
1315
0
                            path, type, name, isAcceptable, context, &subErrorCode, pErrorCode);
1316
0
        if((retVal != nullptr) || U_FAILURE(*pErrorCode)) {
1317
0
            return retVal;
1318
0
        }
1319
0
    }
1320
1321
    /****    INDIVIDUAL FILES  */
1322
2
    if((gDataFileAccess==UDATA_PACKAGES_FIRST) ||
1323
2
       (gDataFileAccess==UDATA_FILES_FIRST)) {
1324
#ifdef UDATA_DEBUG
1325
        fprintf(stderr, "Trying individual files\n");
1326
#endif
1327
        /* Check to make sure that there is a dataPath to iterate over */
1328
2
        if ((dataPath && *dataPath) || !isICUData) {
1329
0
            retVal = doLoadFromIndividualFiles(pkgName.data(), dataPath, tocEntryPathSuffix,
1330
0
                            path, type, name, isAcceptable, context, &subErrorCode, pErrorCode);
1331
0
            if((retVal != nullptr) || U_FAILURE(*pErrorCode)) {
1332
0
                return retVal;
1333
0
            }
1334
0
        }
1335
2
    }
1336
1337
    /****    COMMON PACKAGE  */
1338
2
    if((gDataFileAccess==UDATA_ONLY_PACKAGES) || 
1339
2
       (gDataFileAccess==UDATA_FILES_FIRST)) {
1340
#ifdef UDATA_DEBUG
1341
        fprintf(stderr, "Trying packages (UDATA_ONLY_PACKAGES || UDATA_FILES_FIRST)\n");
1342
#endif
1343
2
        retVal = doLoadFromCommonData(isICUData,
1344
2
                            pkgName.data(), dataPath, tocEntryPathSuffix, tocEntryName.data(),
1345
2
                            path, type, name, isAcceptable, context, &subErrorCode, pErrorCode);
1346
2
        if((retVal != nullptr) || U_FAILURE(*pErrorCode)) {
1347
2
            return retVal;
1348
2
        }
1349
2
    }
1350
    
1351
    /* Load from DLL.  If we haven't attempted package load, we also haven't had any chance to
1352
        try a DLL (static or setCommonData/etc)  load.
1353
         If we ever have a "UDATA_ONLY_FILES", add it to the or list here.  */  
1354
0
    if(gDataFileAccess==UDATA_NO_FILES) {
1355
#ifdef UDATA_DEBUG
1356
        fprintf(stderr, "Trying common data (UDATA_NO_FILES)\n");
1357
#endif
1358
0
        retVal = doLoadFromCommonData(isICUData,
1359
0
                            pkgName.data(), "", tocEntryPathSuffix, tocEntryName.data(),
1360
0
                            path, type, name, isAcceptable, context, &subErrorCode, pErrorCode);
1361
0
        if((retVal != nullptr) || U_FAILURE(*pErrorCode)) {
1362
0
            return retVal;
1363
0
        }
1364
0
    }
1365
1366
    /* data not found */
1367
0
    if(U_SUCCESS(*pErrorCode)) {
1368
0
        if(U_SUCCESS(subErrorCode)) {
1369
            /* file not found */
1370
0
            *pErrorCode=U_FILE_ACCESS_ERROR;
1371
0
        } else {
1372
            /* entry point not found or rejected */
1373
0
            *pErrorCode=subErrorCode;
1374
0
        }
1375
0
    }
1376
0
    return retVal;
1377
0
}
1378
1379
1380
1381
/* API ---------------------------------------------------------------------- */
1382
1383
U_CAPI UDataMemory * U_EXPORT2
1384
udata_open(const char *path, const char *type, const char *name,
1385
0
           UErrorCode *pErrorCode) {
1386
#ifdef UDATA_DEBUG
1387
  fprintf(stderr, "udata_open(): Opening: %s : %s . %s\n", (path?path:"nullptr"), name, type);
1388
    fflush(stderr);
1389
#endif
1390
1391
0
    if(pErrorCode==nullptr || U_FAILURE(*pErrorCode)) {
1392
0
        return nullptr;
1393
0
    } else if(name==nullptr || *name==0) {
1394
0
        *pErrorCode=U_ILLEGAL_ARGUMENT_ERROR;
1395
0
        return nullptr;
1396
0
    } else {
1397
0
        return doOpenChoice(path, type, name, nullptr, nullptr, pErrorCode);
1398
0
    }
1399
0
}
1400
1401
1402
1403
U_CAPI UDataMemory * U_EXPORT2
1404
udata_openChoice(const char *path, const char *type, const char *name,
1405
                 UDataMemoryIsAcceptable *isAcceptable, void *context,
1406
2
                 UErrorCode *pErrorCode) {
1407
#ifdef UDATA_DEBUG
1408
  fprintf(stderr, "udata_openChoice(): Opening: %s : %s . %s\n", (path?path:"nullptr"), name, type);
1409
#endif
1410
1411
2
    if(pErrorCode==nullptr || U_FAILURE(*pErrorCode)) {
1412
0
        return nullptr;
1413
2
    } else if(name==nullptr || *name==0 || isAcceptable==nullptr) {
1414
0
        *pErrorCode=U_ILLEGAL_ARGUMENT_ERROR;
1415
0
        return nullptr;
1416
2
    } else {
1417
2
        return doOpenChoice(path, type, name, isAcceptable, context, pErrorCode);
1418
2
    }
1419
2
}
1420
1421
1422
1423
U_CAPI void U_EXPORT2
1424
0
udata_getInfo(UDataMemory *pData, UDataInfo *pInfo) {
1425
0
    if(pInfo!=nullptr) {
1426
0
        if(pData!=nullptr && pData->pHeader!=nullptr) {
1427
0
            const UDataInfo *info=&pData->pHeader->info;
1428
0
            uint16_t dataInfoSize=udata_getInfoSize(info);
1429
0
            if(pInfo->size>dataInfoSize) {
1430
0
                pInfo->size=dataInfoSize;
1431
0
            }
1432
0
            uprv_memcpy((uint16_t *)pInfo+1, (const uint16_t *)info+1, pInfo->size-2);
1433
0
            if(info->isBigEndian!=U_IS_BIG_ENDIAN) {
1434
                /* opposite endianness */
1435
0
                uint16_t x=info->reservedWord;
1436
0
                pInfo->reservedWord=(uint16_t)((x<<8)|(x>>8));
1437
0
            }
1438
0
        } else {
1439
0
            pInfo->size=0;
1440
0
        }
1441
0
    }
1442
0
}
1443
1444
1445
U_CAPI void U_EXPORT2 udata_setFileAccess(UDataFileAccess access, UErrorCode * /*status*/)
1446
0
{
1447
    // Note: this function is documented as not thread safe.
1448
0
    gDataFileAccess = access;
1449
0
}