5 /* RPM - Copyright (C) 1995-2002 Red Hat Software */
7 /* Data written to file descriptors is in network byte order. */
8 /* Data read from file descriptors is expected to be in */
9 /* network byte order and is converted on the fly to host order. */
13 #include <rpm/rpmtypes.h>
14 #include <rpm/rpmstring.h>
15 #include "lib/header_internal.h"
23 static unsigned char const header_magic[8] = {
24 0x8e, 0xad, 0xe8, 0x01, 0x00, 0x00, 0x00, 0x00
28 * Alignment needed for header data types.
30 static const int typeAlign[16] = {
31 1, /*!< RPM_NULL_TYPE */
32 1, /*!< RPM_CHAR_TYPE */
33 1, /*!< RPM_INT8_TYPE */
34 2, /*!< RPM_INT16_TYPE */
35 4, /*!< RPM_INT32_TYPE */
36 8, /*!< RPM_INT64_TYPE */
37 1, /*!< RPM_STRING_TYPE */
38 1, /*!< RPM_BIN_TYPE */
39 1, /*!< RPM_STRING_ARRAY_TYPE */
40 1, /*!< RPM_I18NSTRING_TYPE */
50 * Size of header data types.
52 static const int typeSizes[16] = {
53 0, /*!< RPM_NULL_TYPE */
54 1, /*!< RPM_CHAR_TYPE */
55 1, /*!< RPM_INT8_TYPE */
56 2, /*!< RPM_INT16_TYPE */
57 4, /*!< RPM_INT32_TYPE */
58 8, /*!< RPM_INT64_TYPE */
59 -1, /*!< RPM_STRING_TYPE */
60 1, /*!< RPM_BIN_TYPE */
61 -1, /*!< RPM_STRING_ARRAY_TYPE */
62 -1, /*!< RPM_I18NSTRING_TYPE */
72 * Maximum no. of bytes permitted in a header.
74 static const size_t headerMaxbytes = (32*1024*1024);
77 * HEADER_EXT_TAG format function prototype.
78 * This is allowed to fail, which indicates the tag doesn't exist.
81 * @retval td tag data container
82 * @return 0 on success
84 typedef int (*headerTagTagFunction) (Header h, rpmtd td);
86 extern void *rpmHeaderTagFunc(rpmTag tag);
88 Header headerLink(Header h)
90 if (h == NULL) return NULL;
94 fprintf(stderr, "--> h %p ++ %d at %s:%u\n", h, h->nrefs, __FILE__, __LINE__);
99 Header headerUnlink(Header h)
101 if (h == NULL) return NULL;
103 fprintf(stderr, "--> h %p -- %d at %s:%u\n", h, h->nrefs, __FILE__, __LINE__);
108 Header headerFree(Header h)
110 (void) headerUnlink(h);
112 if (h == NULL || h->nrefs > 0)
113 return NULL; /* XXX return previous header? */
116 indexEntry entry = h->index;
118 for (i = 0; i < h->indexUsed; i++, entry++) {
119 if ((h->flags & HEADERFLAG_ALLOCATED) && ENTRY_IS_REGION(entry)) {
120 if (entry->length > 0) {
121 int32_t * ei = entry->data;
122 if ((ei - 2) == h->blob) h->blob = _free(h->blob);
125 } else if (!ENTRY_IN_REGION(entry)) {
126 entry->data = _free(entry->data);
130 h->index = _free(h->index);
137 Header headerNew(void)
139 Header h = xcalloc(1, sizeof(*h));
142 h->indexAlloced = INDEX_MALLOC_SIZE;
145 h->flags |= HEADERFLAG_SORTED;
147 h->index = (h->indexAlloced
148 ? xcalloc(h->indexAlloced, sizeof(*h->index))
152 return headerLink(h);
155 int headerVerifyInfo(int il, int dl, const void * pev, void * iv, int negate)
157 entryInfo pe = (entryInfo) pev;
161 for (i = 0; i < il; i++) {
162 info->tag = ntohl(pe[i].tag);
163 info->type = ntohl(pe[i].type);
164 info->offset = ntohl(pe[i].offset);
166 info->offset = -info->offset;
167 info->count = ntohl(pe[i].count);
169 if (hdrchkType(info->type))
171 if (hdrchkAlign(info->type, info->offset))
173 if (!negate && hdrchkRange(dl, info->offset))
175 if (hdrchkData(info->count))
184 static int indexCmp(const void * avp, const void * bvp)
186 indexEntry ap = (indexEntry) avp, bp = (indexEntry) bvp;
187 return (ap->info.tag - bp->info.tag);
190 void headerSort(Header h)
192 if (!(h->flags & HEADERFLAG_SORTED)) {
193 qsort(h->index, h->indexUsed, sizeof(*h->index), indexCmp);
194 h->flags |= HEADERFLAG_SORTED;
200 static int offsetCmp(const void * avp, const void * bvp)
202 indexEntry ap = (indexEntry) avp, bp = (indexEntry) bvp;
203 int rc = (ap->info.offset - bp->info.offset);
206 /* Within a region, entries sort by address. Added drips sort by tag. */
207 if (ap->info.offset < 0)
208 rc = (((char *)ap->data) - ((char *)bp->data));
210 rc = (ap->info.tag - bp->info.tag);
216 * Restore tags in header to original ordering.
219 void headerUnsort(Header h)
221 qsort(h->index, h->indexUsed, sizeof(*h->index), offsetCmp);
224 unsigned headerSizeof(Header h, enum hMagic magicp)
227 unsigned int size = 0;
228 unsigned int pad = 0;
237 case HEADER_MAGIC_YES:
238 size += sizeof(header_magic);
240 case HEADER_MAGIC_NO:
244 size += 2 * sizeof(int32_t); /* count of index entries */
246 for (i = 0, entry = h->index; i < h->indexUsed; i++, entry++) {
250 /* Regions go in as is ... */
251 if (ENTRY_IS_REGION(entry)) {
252 size += entry->length;
253 /* XXX Legacy regions do not include the region tag and data. */
254 if (i == 0 && (h->flags & HEADERFLAG_LEGACY))
255 size += sizeof(struct entryInfo_s) + entry->info.count;
259 /* ... and region elements are skipped. */
260 if (entry->info.offset < 0)
264 type = entry->info.type;
265 if (typeSizes[type] > 1) {
266 diff = typeSizes[type] - (size % typeSizes[type]);
267 if (diff != typeSizes[type]) {
273 size += sizeof(struct entryInfo_s) + entry->length;
280 * Return length of entry data.
281 * @param type entry data type
282 * @param p entry data
283 * @param count entry item count
284 * @param onDisk data is concatenated strings (with NUL's))?
285 * @param pend pointer to end of data (or NULL)
286 * @return no. bytes in data, -1 on failure
288 static int dataLength(rpmTagType type, rpm_constdata_t p, rpm_count_t count,
289 int onDisk, rpm_constdata_t pend)
291 const unsigned char * s = p;
292 const unsigned char * se = pend;
296 case RPM_STRING_TYPE:
304 length++; /* count nul terminator too. */
307 case RPM_STRING_ARRAY_TYPE:
308 case RPM_I18NSTRING_TYPE:
309 /* These are like RPM_STRING_TYPE, except they're *always* an array */
310 /* Compute sum of length of all strings, including nul terminators */
314 length++; /* count nul terminator too */
322 const char ** av = (const char **)p;
324 /* add one for null termination */
325 length += strlen(*av++) + 1;
331 if (typeSizes[type] == -1)
333 length = typeSizes[(type & 0xf)] * count;
334 if (length < 0 || (se && (s + length) > se))
343 * Swap int32_t and int16_t arrays within header region.
345 * This code is way more twisty than I would like.
347 * A bug with RPM_I18NSTRING_TYPE in rpm-2.5.x (fixed in August 1998)
348 * causes the offset and length of elements in a header region to disagree
349 * regarding the total length of the region data.
351 * The "fix" is to compute the size using both offset and length and
352 * return the larger of the two numbers as the size of the region.
353 * Kinda like computing left and right Riemann sums of the data elements
354 * to determine the size of a data structure, go figger :-).
356 * There's one other twist if a header region tag is in the set to be swabbed,
357 * as the data for a header region is located after all other tag data.
359 * @param entry header entry
360 * @param il no. of entries
361 * @param dl start no. bytes of data
362 * @param pe header physical entry pointer (swapped)
363 * @param dataStart header data start
364 * @param dataEnd header data end
365 * @param regionid region offset
366 * @return no. bytes of data in region, -1 on error
368 static int regionSwab(indexEntry entry, int il, int dl,
370 unsigned char * dataStart,
371 const unsigned char * dataEnd,
374 unsigned char * tprev = NULL;
375 unsigned char * t = NULL;
378 struct indexEntry_s ieprev;
380 memset(&ieprev, 0, sizeof(ieprev));
381 for (; il > 0; il--, pe++) {
382 struct indexEntry_s ie;
385 ie.info.tag = ntohl(pe->tag);
386 ie.info.type = ntohl(pe->type);
387 ie.info.count = ntohl(pe->count);
388 ie.info.offset = ntohl(pe->offset);
390 if (hdrchkType(ie.info.type))
392 if (hdrchkData(ie.info.count))
394 if (hdrchkData(ie.info.offset))
396 if (hdrchkAlign(ie.info.type, ie.info.offset))
399 ie.data = t = dataStart + ie.info.offset;
400 if (dataEnd && t >= dataEnd)
403 ie.length = dataLength(ie.info.type, ie.data, ie.info.count, 1, dataEnd);
404 if (ie.length < 0 || hdrchkData(ie.length))
410 ie.info.offset = regionid;
411 *entry = ie; /* structure assignment */
417 if (typeSizes[type] > 1) {
419 diff = typeSizes[type] - (dl % typeSizes[type]);
420 if (diff != typeSizes[type]) {
422 if (ieprev.info.type == RPM_I18NSTRING_TYPE)
423 ieprev.length += diff;
426 tdel = (tprev ? (t - tprev) : 0);
427 if (ieprev.info.type == RPM_I18NSTRING_TYPE)
428 tdel = ieprev.length;
430 if (ie.info.tag >= HEADER_I18NTABLE) {
434 /* XXX HEADER_IMAGE tags don't include region sub-tag. */
435 if (ie.info.tag == HEADER_IMAGE)
436 tprev -= REGION_TAG_COUNT;
439 /* Perform endian conversions */
440 switch (ntohl(pe->type)) {
442 { uint64_t * it = (uint64_t *)t;
443 for (; ie.info.count > 0; ie.info.count--, it += 1) {
444 if (dataEnd && ((unsigned char *)it) >= dataEnd)
448 t = (unsigned char *) it;
451 { int32_t * it = (int32_t *)t;
452 for (; ie.info.count > 0; ie.info.count--, it += 1) {
453 if (dataEnd && ((unsigned char *)it) >= dataEnd)
457 t = (unsigned char *) it;
460 { int16_t * it = (int16_t *) t;
461 for (; ie.info.count > 0; ie.info.count--, it += 1) {
462 if (dataEnd && ((unsigned char *)it) >= dataEnd)
466 t = (unsigned char *) it;
475 ieprev = ie; /* structure assignment */
478 tdel = (tprev ? (t - tprev) : 0);
482 * There are two hacks here:
483 * 1) tl is 16b (i.e. REGION_TAG_COUNT) short while doing headerReload().
484 * 2) the 8/98 rpm bug with inserting i18n tags needs to use tl, not dl.
486 if (tl+REGION_TAG_COUNT == dl)
487 tl += REGION_TAG_COUNT;
495 * @retval *lengthPtr no. bytes in unloaded header blob
496 * @return unloaded header blob (NULL on error)
498 static void * doHeaderUnload(Header h,
512 int drlen, ndribbles;
516 /* Sort entries by (offset,tag). */
519 /* Compute (il,dl) for all tags, including those deleted in region. */
521 drlen = ndribbles = driplen = ndrips = 0;
522 for (i = 0, entry = h->index; i < h->indexUsed; i++, entry++) {
523 if (ENTRY_IS_REGION(entry)) {
524 int32_t rdl = -entry->info.offset; /* negative offset */
525 int32_t ril = rdl/sizeof(*pe);
526 int rid = entry->info.offset;
529 dl += entry->rdlen + entry->info.count;
530 /* XXX Legacy regions do not include the region tag and data. */
531 if (i == 0 && (h->flags & HEADERFLAG_LEGACY))
534 /* Skip rest of entries in region, but account for dribbles. */
535 for (; i < h->indexUsed && entry->info.offset <= rid+1; i++, entry++) {
536 if (entry->info.offset <= rid)
540 type = entry->info.type;
541 if (typeSizes[type] > 1) {
543 diff = typeSizes[type] - (dl % typeSizes[type]);
544 if (diff != typeSizes[type]) {
553 drlen += entry->length;
561 /* Ignore deleted drips. */
562 if (entry->data == NULL || entry->length <= 0)
566 type = entry->info.type;
567 if (typeSizes[type] > 1) {
569 diff = typeSizes[type] - (dl % typeSizes[type]);
570 if (diff != typeSizes[type]) {
580 driplen += entry->length;
584 /* Sanity checks on header intro. */
585 if (hdrchkTags(il) || hdrchkData(dl))
588 len = sizeof(il) + sizeof(dl) + (il * sizeof(*pe)) + dl;
594 pe = (entryInfo) &ei[2];
595 dataStart = te = (char *) (pe + il);
598 for (i = 0, entry = h->index; i < h->indexUsed; i++, entry++) {
604 if (entry->data == NULL || entry->length <= 0)
607 t = (unsigned char*)te;
608 pe->tag = htonl(entry->info.tag);
609 pe->type = htonl(entry->info.type);
610 pe->count = htonl(entry->info.count);
612 if (ENTRY_IS_REGION(entry)) {
613 int32_t rdl = -entry->info.offset; /* negative offset */
614 int32_t ril = rdl/sizeof(*pe) + ndribbles;
615 int rid = entry->info.offset;
617 src = (char *)entry->data;
618 rdlen = entry->rdlen;
620 /* XXX Legacy regions do not include the region tag and data. */
621 if (i == 0 && (h->flags & HEADERFLAG_LEGACY)) {
625 memcpy(pe+1, src, rdl);
626 memcpy(te, src + rdl, rdlen);
629 pe->offset = htonl(te - dataStart);
632 stei[2] = htonl(-rdl-entry->info.count);
634 memcpy(te, stei, entry->info.count);
635 te += entry->info.count;
637 rdlen += entry->info.count;
639 count = regionSwab(NULL, ril, 0, pe, t, NULL, 0);
645 memcpy(pe+1, src + sizeof(*pe), ((ril-1) * sizeof(*pe)));
646 memcpy(te, src + (ril * sizeof(*pe)), rdlen+entry->info.count+drlen);
649 entryInfo se = (entryInfo)src;
650 int off = ntohl(se->offset);
651 pe->offset = (off) ? htonl(te - dataStart) : htonl(off);
653 te += entry->info.count + drlen;
655 count = regionSwab(NULL, ril, 0, pe, t, NULL, 0);
656 if (count != (rdlen + entry->info.count + drlen))
660 /* Skip rest of entries in region. */
661 while (i < h->indexUsed && entry->info.offset <= rid+1) {
671 /* Ignore deleted drips. */
672 if (entry->data == NULL || entry->length <= 0)
676 type = entry->info.type;
677 if (typeSizes[type] > 1) {
679 diff = typeSizes[type] - ((te - dataStart) % typeSizes[type]);
680 if (diff != typeSizes[type]) {
687 pe->offset = htonl(te - dataStart);
689 /* copy data w/ endian conversions */
690 switch (entry->info.type) {
692 count = entry->info.count;
695 *((uint64_t *)te) = htonll(*((uint64_t *)src));
696 te += sizeof(uint64_t);
697 src += sizeof(uint64_t);
702 count = entry->info.count;
705 *((int32_t *)te) = htonl(*((int32_t *)src));
706 te += sizeof(int32_t);
707 src += sizeof(int32_t);
712 count = entry->info.count;
715 *((int16_t *)te) = htons(*((int16_t *)src));
716 te += sizeof(int16_t);
717 src += sizeof(int16_t);
722 memcpy(te, entry->data, entry->length);
729 /* Insure that there are no memcpy underruns/overruns. */
730 if (((char *)pe) != dataStart)
732 if ((((char *)ei)+len) != te)
738 h->flags &= ~HEADERFLAG_SORTED;
748 void * headerUnload(Header h)
751 void * uh = doHeaderUnload(h, &length);
756 * Find matching (tag,type) entry in header.
758 * @param tag entry tag
759 * @param type entry type
760 * @return header entry
763 indexEntry findEntry(Header h, rpmTag tag, rpmTagType type)
765 indexEntry entry, entry2, last;
766 struct indexEntry_s key;
768 if (h == NULL) return NULL;
769 if (!(h->flags & HEADERFLAG_SORTED)) headerSort(h);
774 bsearch(&key, h->index, h->indexUsed, sizeof(*h->index), indexCmp);
778 if (type == RPM_NULL_TYPE)
782 while (entry->info.tag == tag && entry->info.type != type &&
783 entry > h->index) entry--;
785 if (entry->info.tag == tag && entry->info.type == type)
788 last = h->index + h->indexUsed;
789 /* FIX: entry2 = entry. Code looks bogus as well. */
790 while (entry2->info.tag == tag && entry2->info.type != type &&
791 entry2 < last) entry2++;
793 if (entry->info.tag == tag && entry->info.type == type)
799 int headerDel(Header h, rpmTag tag)
801 indexEntry last = h->index + h->indexUsed;
802 indexEntry entry, first;
805 entry = findEntry(h, tag, RPM_NULL_TYPE);
806 if (!entry) return 1;
808 /* Make sure entry points to the first occurence of this tag. */
809 while (entry > h->index && (entry - 1)->info.tag == tag)
812 /* Free data for tags being removed. */
813 for (first = entry; first < last; first++) {
815 if (first->info.tag != tag)
820 if (ENTRY_IN_REGION(first))
825 ne = (first - entry);
830 memmove(entry, first, (ne * sizeof(*entry)));
836 Header headerLoad(void * uh)
838 int32_t * ei = (int32_t *) uh;
839 int32_t il = ntohl(ei[0]); /* index length */
840 int32_t dl = ntohl(ei[1]); /* data length */
841 size_t pvlen = sizeof(il) + sizeof(dl) +
842 (il * sizeof(struct entryInfo_s)) + dl;
846 unsigned char * dataStart;
847 unsigned char * dataEnd;
852 /* Sanity checks on header intro. */
853 if (hdrchkTags(il) || hdrchkData(dl))
857 pe = (entryInfo) &ei[2];
858 dataStart = (unsigned char *) (pe + il);
859 dataEnd = dataStart + dl;
861 h = xcalloc(1, sizeof(*h));
863 h->indexAlloced = il + 1;
866 h->index = xcalloc(h->indexAlloced, sizeof(*h->index));
867 h->flags |= HEADERFLAG_SORTED;
873 if (!(htonl(pe->tag) < HEADER_I18NTABLE)) {
874 h->flags |= HEADERFLAG_LEGACY;
875 entry->info.type = REGION_TAG_TYPE;
876 entry->info.tag = HEADER_IMAGE;
877 entry->info.count = REGION_TAG_COUNT;
878 entry->info.offset = ((unsigned char *)pe - dataStart); /* negative offset */
881 entry->length = pvlen - sizeof(il) - sizeof(dl);
882 rdlen = regionSwab(entry+1, il, 0, pe, dataStart, dataEnd, entry->info.offset);
883 #if 0 /* XXX don't check, the 8/98 i18n bug fails here. */
887 entry->rdlen = rdlen;
894 h->flags &= ~HEADERFLAG_LEGACY;
896 entry->info.type = htonl(pe->type);
897 entry->info.count = htonl(pe->count);
899 if (hdrchkType(entry->info.type))
901 if (hdrchkTags(entry->info.count))
904 { int off = ntohl(pe->offset);
909 size_t nb = REGION_TAG_COUNT;
911 /* XXX Hmm, why the copy? */
912 memcpy(&stei, dataStart + off, nb);
913 rdl = -ntohl(stei[2]); /* negative offset */
914 ril = rdl/sizeof(*pe);
915 if (hdrchkTags(ril) || hdrchkData(rdl))
917 entry->info.tag = htonl(pe->tag);
920 rdl = (ril * sizeof(struct entryInfo_s));
921 entry->info.tag = HEADER_IMAGE;
924 entry->info.offset = -rdl; /* negative offset */
927 entry->length = pvlen - sizeof(il) - sizeof(dl);
928 rdlen = regionSwab(entry+1, ril-1, 0, pe+1, dataStart, dataEnd, entry->info.offset);
931 entry->rdlen = rdlen;
933 if (ril < h->indexUsed) {
934 indexEntry newEntry = entry + ril;
935 int ne = (h->indexUsed - ril);
936 int rid = entry->info.offset+1;
939 /* Load dribble entries from region. */
940 rc = regionSwab(newEntry, ne, 0, pe+ril, dataStart, dataEnd, rid);
945 { indexEntry firstEntry = newEntry;
946 int save = h->indexUsed;
949 /* Dribble entries replace duplicate region entries. */
951 for (j = 0; j < ne; j++, newEntry++) {
952 (void) headerDel(h, newEntry->info.tag);
953 if (newEntry->info.tag == RPMTAG_BASENAMES)
954 (void) headerDel(h, RPMTAG_OLDFILENAMES);
957 /* If any duplicate entries were replaced, move new entries down. */
958 if (h->indexUsed < (save - ne)) {
959 memmove(h->index + h->indexUsed, firstEntry,
960 (ne * sizeof(*entry)));
967 h->flags &= ~HEADERFLAG_SORTED;
974 h->index = _free(h->index);
980 Header headerReload(Header h, rpmTag tag)
984 void * uh = doHeaderUnload(h, &length);
994 if (nh->flags & HEADERFLAG_ALLOCATED)
996 nh->flags |= HEADERFLAG_ALLOCATED;
997 if (ENTRY_IS_REGION(nh->index)) {
998 if (tag == HEADER_SIGNATURES || tag == HEADER_IMMUTABLE)
999 nh->index[0].info.tag = tag;
1004 Header headerCopyLoad(const void * uh)
1006 int32_t * ei = (int32_t *) uh;
1007 int32_t il = ntohl(ei[0]); /* index length */
1008 int32_t dl = ntohl(ei[1]); /* data length */
1009 size_t pvlen = sizeof(il) + sizeof(dl) +
1010 (il * sizeof(struct entryInfo_s)) + dl;
1014 /* Sanity checks on header intro. */
1015 if (!(hdrchkTags(il) || hdrchkData(dl)) && pvlen < headerMaxbytes) {
1016 nuh = memcpy(xmalloc(pvlen), uh, pvlen);
1017 if ((h = headerLoad(nuh)) != NULL)
1018 h->flags |= HEADERFLAG_ALLOCATED;
1026 * Read (and load) header from file handle.
1027 * @param fd file handle
1028 * @param magicp read (and verify) 8 bytes of (magic, 0)?
1029 * @return header (or NULL on error)
1031 Header headerRead(FD_t fd, enum hMagic magicp)
1035 int32_t * ei = NULL;
1043 memset(block, 0, sizeof(block));
1045 if (magicp == HEADER_MAGIC_YES)
1049 if (timedRead(fd, (char *)block, i*sizeof(*block)) != (i * sizeof(*block)))
1054 if (magicp == HEADER_MAGIC_YES) {
1056 if (memcmp(&magic, header_magic, sizeof(magic)))
1058 reserved = block[i++];
1061 il = ntohl(block[i]); i++;
1062 dl = ntohl(block[i]); i++;
1064 len = sizeof(il) + sizeof(dl) + (il * sizeof(struct entryInfo_s)) + dl;
1066 /* Sanity checks on header intro. */
1067 if (hdrchkTags(il) || hdrchkData(dl) || len > headerMaxbytes)
1073 len -= sizeof(il) + sizeof(dl);
1076 if (timedRead(fd, (char *)&ei[2], len) != len)
1083 if (h->flags & HEADERFLAG_ALLOCATED)
1085 h->flags |= HEADERFLAG_ALLOCATED;
1091 int headerWrite(FD_t fd, Header h, enum hMagic magicp)
1099 uh = doHeaderUnload(h, &length);
1103 case HEADER_MAGIC_YES:
1104 nb = Fwrite(header_magic, sizeof(char), sizeof(header_magic), fd);
1105 if (nb != sizeof(header_magic))
1108 case HEADER_MAGIC_NO:
1112 nb = Fwrite(uh, sizeof(char), length, fd);
1116 return (nb == length ? 0 : 1);
1119 int headerIsEntry(Header h, rpmTag tag)
1121 /* FIX: h modified by sort. */
1122 return (findEntry(h, tag, RPM_NULL_TYPE) ? 1 : 0);
1127 * Retrieve data from header entry.
1128 * Relevant flags (others are ignored), if neither is set allocation
1129 * behavior depends on data type(!)
1130 * HEADERGET_MINMEM: return pointers to header memory
1131 * HEADERGET_ALLOC: always return malloced memory, overrides MINMEM
1133 * @todo Permit retrieval of regions other than HEADER_IMUTABLE.
1134 * @param entry header entry
1135 * @param td tag data container
1136 * @param minMem string pointers refer to header memory?
1137 * @param flags flags to control memory allocation
1138 * @return 1 on success, otherwise error.
1140 static int copyTdEntry(const indexEntry entry, rpmtd td, headerGetFlags flags)
1142 rpm_count_t count = entry->info.count;
1143 int rc = 1; /* XXX 1 on success. */
1144 /* ALLOC overrides MINMEM */
1145 int allocMem = flags & HEADERGET_ALLOC;
1146 int minMem = allocMem ? 0 : flags & HEADERGET_MINMEM;
1149 switch (entry->info.type) {
1152 * XXX This only works for
1153 * XXX "sealed" HEADER_IMMUTABLE/HEADER_SIGNATURES/HEADER_IMAGE.
1154 * XXX This will *not* work for unsealed legacy HEADER_IMAGE (i.e.
1155 * XXX a legacy header freshly read, but not yet unloaded to the rpmdb).
1157 if (ENTRY_IS_REGION(entry)) {
1158 int32_t * ei = ((int32_t *)entry->data) - 2;
1159 entryInfo pe = (entryInfo) (ei + 2);
1160 unsigned char * dataStart = (unsigned char *) (pe + ntohl(ei[0]));
1161 int32_t rdl = -entry->info.offset; /* negative offset */
1162 int32_t ril = rdl/sizeof(*pe);
1165 count = 2 * sizeof(*ei) + (ril * sizeof(*pe)) + rdl;
1166 if (entry->info.tag == HEADER_IMAGE) {
1170 count += REGION_TAG_COUNT;
1171 rdl += REGION_TAG_COUNT;
1174 td->data = xmalloc(count);
1175 ei = (int32_t *) td->data;
1179 pe = (entryInfo) memcpy(ei + 2, pe, (ril * sizeof(*pe)));
1181 dataStart = (unsigned char *) memcpy(pe + ril, dataStart, rdl);
1183 rc = regionSwab(NULL, ril, 0, pe, dataStart, dataStart + rdl, 0);
1184 /* XXX 1 on success. */
1185 rc = (rc < 0) ? 0 : 1;
1187 count = entry->length;
1189 ? memcpy(xmalloc(count), entry->data, count)
1193 case RPM_STRING_TYPE:
1195 td->data = allocMem ? xstrdup(entry->data) : entry->data;
1198 case RPM_STRING_ARRAY_TYPE:
1199 case RPM_I18NSTRING_TYPE:
1200 { const char ** ptrEntry;
1201 int tableSize = count * sizeof(char *);
1206 td->data = xmalloc(tableSize);
1207 ptrEntry = (const char **) td->data;
1210 t = xmalloc(tableSize + entry->length);
1211 td->data = (void *)t;
1212 ptrEntry = (const char **) td->data;
1214 memcpy(t, entry->data, entry->length);
1216 for (i = 0; i < count; i++) {
1224 case RPM_INT16_TYPE:
1225 case RPM_INT32_TYPE:
1226 case RPM_INT64_TYPE:
1228 td->data = xmalloc(entry->length);
1229 memcpy(td->data, entry->data, entry->length);
1231 td->data = entry->data;
1235 /* WTH? Don't mess with unknown data types... */
1240 td->type = entry->info.type;
1243 td->flags = RPMTD_IMMUTABLE;
1244 if (td->data && entry->data != td->data) {
1245 td->flags |= RPMTD_ALLOCED;
1252 * Does locale match entry in header i18n table?
1255 * The range [l,le) contains the next locale to match:
1256 * ll[_CC][.EEEEE][@dddd]
1258 * ll ISO language code (in lowercase).
1259 * CC (optional) ISO coutnry code (in uppercase).
1260 * EEEEE (optional) encoding (not really standardized).
1261 * dddd (optional) dialect.
1264 * @param td header i18n table data, NUL terminated
1265 * @param l start of locale to match
1266 * @param le end of locale to match
1267 * @return 1 on good match, 2 on weak match, 0 on no match
1269 static int headerMatchLocale(const char *td, const char *l, const char *le)
1273 /* First try a complete match. */
1274 if (strlen(td) == (le-l) && !strncmp(td, l, (le - l)))
1277 /* Next, try stripping optional dialect and matching. */
1278 for (fe = l; fe < le && *fe != '@'; fe++)
1280 if (fe < le && !strncmp(td, l, (fe - l)))
1283 /* Next, try stripping optional codeset and matching. */
1284 for (fe = l; fe < le && *fe != '.'; fe++)
1286 if (fe < le && !strncmp(td, l, (fe - l)))
1289 /* Finally, try stripping optional country code and matching. */
1290 for (fe = l; fe < le && *fe != '_'; fe++)
1292 if (fe < le && !strncmp(td, l, (fe - l)))
1299 * Return i18n string from header that matches locale.
1301 * @param entry i18n string data
1302 * @retval td tag data container
1303 * @param flags flags to control allocation
1306 static int copyI18NEntry(Header h, indexEntry entry, rpmtd td,
1307 headerGetFlags flags)
1309 const char *lang, *l, *le;
1312 td->type = RPM_STRING_TYPE;
1314 /* if no match, just return the first string */
1315 td->data = entry->data;
1317 /* XXX Drepper sez' this is the order. */
1318 if ((lang = getenv("LANGUAGE")) == NULL &&
1319 (lang = getenv("LC_ALL")) == NULL &&
1320 (lang = getenv("LC_MESSAGES")) == NULL &&
1321 (lang = getenv("LANG")) == NULL)
1324 if ((table = findEntry(h, HEADER_I18NTABLE, RPM_STRING_ARRAY_TYPE)) == NULL)
1327 for (l = lang; *l != '\0'; l = le) {
1329 char *ed, *ed_weak = NULL;
1332 while (*l && *l == ':') /* skip leading colons */
1336 for (le = l; *le && *le != ':'; le++) /* find end of this locale */
1339 /* For each entry in the header ... */
1340 for (langNum = 0, t = table->data, ed = entry->data;
1341 langNum < entry->info.count;
1342 langNum++, t += strlen(t) + 1, ed += strlen(ed) + 1) {
1344 int match = headerMatchLocale(t, l, le);
1348 } else if (match == 2) {
1359 if (flags & HEADERGET_ALLOC) {
1360 td->data = xstrdup(td->data);
1367 * Retrieve tag data from header.
1369 * @param tag tag to retrieve
1370 * @retval td tag data container
1371 * @param flags flags to control retrieval
1372 * @return 1 on success, 0 on not found
1374 static int intGetTdEntry(Header h, rpmTag tag, rpmtd td, headerGetFlags flags)
1380 /* ensure clean state */
1383 /* First find the tag */
1384 /* FIX: h modified by sort. */
1385 entry = findEntry(h, tag, RPM_NULL_TYPE);
1386 if (entry == NULL) {
1387 /* Td is zeroed above, just return... */
1391 if (flags & HEADERGET_RAW) {
1392 rc = copyTdEntry(entry, td, flags);
1394 switch (entry->info.type) {
1395 case RPM_I18NSTRING_TYPE:
1396 rc = copyI18NEntry(h, entry, td, flags);
1399 rc = copyTdEntry(entry, td, flags);
1404 /* XXX 1 on success */
1405 return ((rc == 1) ? 1 : 0);
1409 * XXX temporary kludgery until tag extensions have been converted to
1410 * take rpmtd as argument
1412 static int intGetTagExt(Header h, rpmTag tag, rpmtd td, headerTagTagFunction tagfunc)
1416 rc = tagfunc(h, td);
1421 int headerGet(Header h, rpmTag tag, rpmtd td, headerGetFlags flags)
1424 headerTagTagFunction tagfunc = NULL;
1428 if (flags & HEADERGET_EXT) {
1429 tagfunc = rpmHeaderTagFunc(tag);
1433 rc = intGetTagExt(h, tag, td, tagfunc);
1435 rc = intGetTdEntry(h, tag, td, flags);
1438 assert(tag == td->tag);
1444 static void copyData(rpmTagType type, rpm_data_t dstPtr,
1445 rpm_constdata_t srcPtr, rpm_count_t cnt, int dataLength)
1448 case RPM_STRING_ARRAY_TYPE:
1449 case RPM_I18NSTRING_TYPE:
1450 { const char ** av = (const char **) srcPtr;
1453 while (cnt-- > 0 && dataLength > 0) {
1455 if ((s = *av++) == NULL)
1459 } while (s[-1] && --dataLength > 0);
1464 memmove(dstPtr, srcPtr, dataLength);
1470 * Return (malloc'ed) copy of entry data.
1471 * @param type entry data type
1472 * @param p entry data
1473 * @param c entry item count
1474 * @retval lengthPtr no. bytes in returned data
1475 * @return (malloc'ed) copy of entry data, NULL on error
1478 grabData(rpmTagType type, rpm_constdata_t p, rpm_count_t c, int * lengthPtr)
1480 rpm_data_t data = NULL;
1483 length = dataLength(type, p, c, 0, NULL);
1485 data = xmalloc(length);
1486 copyData(type, data, p, c, length);
1490 *lengthPtr = length;
1494 static int intAddEntry(Header h, rpmtd td)
1500 /* Count must always be >= 1 for headerAddEntry. */
1504 if (hdrchkType(td->type))
1506 if (hdrchkData(td->count))
1510 data = grabData(td->type, td->data, td->count, &length);
1511 if (data == NULL || length <= 0)
1514 /* Allocate more index space if necessary */
1515 if (h->indexUsed == h->indexAlloced) {
1516 h->indexAlloced += INDEX_MALLOC_SIZE;
1517 h->index = xrealloc(h->index, h->indexAlloced * sizeof(*h->index));
1520 /* Fill in the index */
1521 entry = h->index + h->indexUsed;
1522 entry->info.tag = td->tag;
1523 entry->info.type = td->type;
1524 entry->info.count = td->count;
1525 entry->info.offset = 0;
1527 entry->length = length;
1529 if (h->indexUsed > 0 && td->tag < h->index[h->indexUsed-1].info.tag)
1530 h->flags &= ~HEADERFLAG_SORTED;
1536 static int intAppendEntry(Header h, rpmtd td)
1541 if (td->type == RPM_STRING_TYPE || td->type == RPM_I18NSTRING_TYPE) {
1542 /* we can't do this */
1546 /* Find the tag entry in the header. */
1547 entry = findEntry(h, td->tag, td->type);
1551 length = dataLength(td->type, td->data, td->count, 0, NULL);
1555 if (ENTRY_IN_REGION(entry)) {
1556 char * t = xmalloc(entry->length + length);
1557 memcpy(t, entry->data, entry->length);
1559 entry->info.offset = 0;
1561 entry->data = xrealloc(entry->data, entry->length + length);
1563 copyData(td->type, ((char *) entry->data) + entry->length,
1564 td->data, td->count, length);
1566 entry->length += length;
1568 entry->info.count += td->count;
1573 int headerPut(Header h, rpmtd td, headerPutFlags flags)
1578 if (flags & HEADERPUT_APPEND) {
1579 rc = findEntry(h, td->tag, td->type) ?
1580 intAppendEntry(h, td) :
1583 rc = intAddEntry(h, td);
1589 * Sanity check data types against tag table before putting. Assume
1590 * append on all array-types.
1592 static int headerPutType(Header h, rpmTag tag, rpmTagType reqtype,
1593 rpm_constdata_t data, rpm_count_t size)
1596 rpmTagType type = rpmTagGetType(tag);
1597 headerPutFlags flags = HEADERPUT_APPEND;
1600 /* Basic sanity checks: type must match and there must be data to put */
1601 if ((type & RPM_MASK_TYPE) != reqtype
1602 || size < 1 || data == NULL || h == NULL) {
1607 * Non-array types can't be appended to. Binary types use size
1608 * for data length, for other non-array types size must be 1.
1610 if ((type & RPM_MASK_RETURN_TYPE) != RPM_ARRAY_RETURN_TYPE) {
1611 flags = HEADERPUT_DEFAULT;
1612 if ((type & RPM_MASK_TYPE) != RPM_BIN_TYPE && size != 1) {
1620 td.type = type & RPM_MASK_TYPE;
1621 td.data = (void *) data;
1624 valid = headerPut(h, &td, flags);
1630 int headerPutString(Header h, rpmTag tag, const char *val)
1632 rpmTagType type = rpmTagGetType(tag) & RPM_MASK_TYPE;
1633 const void *sptr = NULL;
1635 /* string arrays expect char **, arrange that */
1636 if (type == RPM_STRING_ARRAY_TYPE || type == RPM_I18NSTRING_TYPE) {
1638 } else if (type == RPM_STRING_TYPE) {
1644 return headerPutType(h, tag, type, sptr, 1);
1647 int headerPutStringArray(Header h, rpmTag tag, const char **array, rpm_count_t size)
1649 return headerPutType(h, tag, RPM_STRING_ARRAY_TYPE, array, size);
1652 int headerPutChar(Header h, rpmTag tag, char *val, rpm_count_t size)
1654 return headerPutType(h, tag, RPM_CHAR_TYPE, val, size);
1657 int headerPutUint8(Header h, rpmTag tag, uint8_t *val, rpm_count_t size)
1659 return headerPutType(h, tag, RPM_INT8_TYPE, val, size);
1662 int headerPutUint16(Header h, rpmTag tag, uint16_t *val, rpm_count_t size)
1664 return headerPutType(h, tag, RPM_INT16_TYPE, val, size);
1667 int headerPutUint32(Header h, rpmTag tag, uint32_t *val, rpm_count_t size)
1669 return headerPutType(h, tag, RPM_INT32_TYPE, val, size);
1672 int headerPutUint64(Header h, rpmTag tag, uint64_t *val, rpm_count_t size)
1674 return headerPutType(h, tag, RPM_INT64_TYPE, val, size);
1677 int headerPutBin(Header h, rpmTag tag, uint8_t *val, rpm_count_t size)
1679 return headerPutType(h, tag, RPM_BIN_TYPE, val, size);
1682 int headerAddI18NString(Header h, rpmTag tag, const char * string,
1685 indexEntry table, entry;
1686 const char ** strArray;
1689 rpm_count_t i, langNum;
1692 table = findEntry(h, HEADER_I18NTABLE, RPM_STRING_ARRAY_TYPE);
1693 entry = findEntry(h, tag, RPM_I18NSTRING_TYPE);
1695 if (!table && entry)
1696 return 0; /* this shouldn't ever happen!! */
1698 if (!table && !entry) {
1699 const char * charArray[2];
1700 rpm_count_t count = 0;
1702 if (!lang || (lang[0] == 'C' && lang[1] == '\0')) {
1703 charArray[count++] = "C";
1705 charArray[count++] = "C";
1706 charArray[count++] = lang;
1710 td.tag = HEADER_I18NTABLE;
1711 td.type = RPM_STRING_ARRAY_TYPE;
1712 td.data = (void *) charArray;
1714 if (!headerPut(h, &td, HEADERPUT_DEFAULT))
1716 table = findEntry(h, HEADER_I18NTABLE, RPM_STRING_ARRAY_TYPE);
1721 if (!lang) lang = "C";
1723 { const char * l = table->data;
1724 for (langNum = 0; langNum < table->info.count; langNum++) {
1725 if (!strcmp(l, lang)) break;
1730 if (langNum >= table->info.count) {
1731 length = strlen(lang) + 1;
1732 if (ENTRY_IN_REGION(table)) {
1733 char * t = xmalloc(table->length + length);
1734 memcpy(t, table->data, table->length);
1736 table->info.offset = 0;
1738 table->data = xrealloc(table->data, table->length + length);
1739 memmove(((char *)table->data) + table->length, lang, length);
1740 table->length += length;
1741 table->info.count++;
1747 strArray = xmalloc(sizeof(*strArray) * (langNum + 1));
1748 for (i = 0; i < langNum; i++)
1750 strArray[langNum] = string;
1754 td.type = RPM_I18NSTRING_TYPE;
1756 td.count = langNum + 1;
1757 rc = headerPut(h, &td, HEADERPUT_DEFAULT);
1760 } else if (langNum >= entry->info.count) {
1761 ghosts = langNum - entry->info.count;
1763 length = strlen(string) + 1 + ghosts;
1764 if (ENTRY_IN_REGION(entry)) {
1765 char * t = xmalloc(entry->length + length);
1766 memcpy(t, entry->data, entry->length);
1768 entry->info.offset = 0;
1770 entry->data = xrealloc(entry->data, entry->length + length);
1772 memset(((char *)entry->data) + entry->length, '\0', ghosts);
1773 memmove(((char *)entry->data) + entry->length + ghosts, string, strlen(string)+1);
1775 entry->length += length;
1776 entry->info.count = langNum + 1;
1778 char *b, *be, *e, *ee, *t;
1781 /* Set beginning/end pointers to previous data */
1782 b = be = e = ee = entry->data;
1783 for (i = 0; i < table->info.count; i++) {
1786 ee += strlen(ee) + 1;
1791 /* Get storage for new buffer */
1793 sn = strlen(string) + 1;
1795 length = bn + sn + en;
1796 t = buf = xmalloc(length);
1798 /* Copy values into new storage */
1801 memcpy(t, string, sn);
1806 /* Replace i18N string array */
1807 entry->length -= strlen(be) + 1;
1808 entry->length += sn;
1810 if (ENTRY_IN_REGION(entry)) {
1811 entry->info.offset = 0;
1813 entry->data = _free(entry->data);
1820 int headerMod(Header h, rpmtd td)
1827 /* First find the tag */
1828 entry = findEntry(h, td->tag, td->type);
1833 data = grabData(td->type, td->data, td->count, &length);
1834 if (data == NULL || length <= 0)
1837 /* make sure entry points to the first occurence of this tag */
1838 while (entry > h->index && (entry - 1)->info.tag == td->tag)
1841 /* free after we've grabbed the new data in case the two are intertwined;
1842 that's a bad idea but at least we won't break */
1843 oldData = entry->data;
1845 entry->info.count = td->count;
1846 entry->info.type = td->type;
1848 entry->length = length;
1850 if (ENTRY_IN_REGION(entry)) {
1851 entry->info.offset = 0;
1853 oldData = _free(oldData);
1859 * Header tag iterator data structure.
1861 struct headerIterator_s {
1862 Header h; /*!< Header being iterated. */
1863 int next_index; /*!< Next tag index. */
1866 HeaderIterator headerFreeIterator(HeaderIterator hi)
1869 hi->h = headerFree(hi->h);
1875 HeaderIterator headerInitIterator(Header h)
1877 HeaderIterator hi = xmalloc(sizeof(*hi));
1881 hi->h = headerLink(h);
1886 int headerNext(HeaderIterator hi, rpmtd td)
1889 int slot = hi->next_index;
1890 indexEntry entry = NULL;
1896 for (slot = hi->next_index; slot < h->indexUsed; slot++) {
1897 entry = h->index + slot;
1898 if (!ENTRY_IS_REGION(entry))
1901 hi->next_index = slot;
1902 if (entry == NULL || slot >= h->indexUsed)
1908 td->tag = entry->info.tag;
1910 rc = copyTdEntry(entry, td, HEADERGET_DEFAULT);
1912 /* XXX 1 on success */
1913 return ((rc == 1) ? 1 : 0);
1917 * Duplicate a header.
1919 * @return new header instance
1921 Header headerCopy(Header h)
1923 Header nh = headerNew();
1927 hi = headerInitIterator(h);
1928 while (headerNext(hi, &td)) {
1929 if (rpmtdCount(&td) > 0) {
1930 (void) headerPut(nh, &td, HEADERPUT_DEFAULT);
1934 hi = headerFreeIterator(hi);
1936 return headerReload(nh, HEADER_IMAGE);
1939 void headerCopyTags(Header headerFrom, Header headerTo,
1940 const rpmTag * tagstocopy)
1945 if (headerFrom == headerTo)
1948 for (p = tagstocopy; *p != 0; p++) {
1949 if (headerIsEntry(headerTo, *p))
1951 if (!headerGet(headerFrom, *p, &td, HEADERGET_MINMEM))
1953 (void) headerPut(headerTo, &td, HEADERPUT_DEFAULT);
1958 unsigned int headerGetInstance(Header h)
1960 return h ? h->instance : 0;
1963 void headerSetInstance(Header h, unsigned int instance)
1965 h->instance = instance;