1 /* This file is part of the Zebra server.
2 Copyright (C) 1995-2008 Index Data
4 Zebra is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Format of first block
26 * Format of subsequent blocks
30 * Format of each record
32 * (length, data) - pairs
33 * length = 0 if same as previous
40 #include <yaz/yaz-util.h>
41 #include <idzebra/bfile.h>
48 #define REC_BLOCK_TYPES 2
49 #define REC_HEAD_MAGIC "recindex"
54 int compression_method;
58 char *data_fname[REC_BLOCK_TYPES];
59 BFile data_BFile[REC_BLOCK_TYPES];
64 struct record_cache_entry *record_cache;
69 int compression_chunk_size;
76 zint block_size[REC_BLOCK_TYPES];
77 zint block_free[REC_BLOCK_TYPES];
78 zint block_last[REC_BLOCK_TYPES];
79 zint block_used[REC_BLOCK_TYPES];
80 zint block_move[REC_BLOCK_TYPES];
90 enum recordCacheFlag { recordFlagNop, recordFlagWrite, recordFlagNew,
93 struct record_cache_entry {
95 enum recordCacheFlag flag;
98 struct record_index_entry {
99 zint next; /* first block of record info / next free entry */
100 int size; /* size of record or 0 if free entry */
103 Record rec_cp(Record rec);
105 /* Modify argument to if below: 1=normal, 0=sysno testing */
107 /* If this is used sysno are not converted (no testing) */
108 #define FAKE_OFFSET 0
109 #define USUAL_RANGE 6000000000LL
112 /* Use a fake > 2^32 offset so we can test for proper 64-bit handling */
113 #define FAKE_OFFSET 6000000000LL
114 #define USUAL_RANGE 2000000000LL
117 static zint rec_sysno_to_ext(zint sysno)
119 assert(sysno >= 0 && sysno <= USUAL_RANGE);
120 return sysno + FAKE_OFFSET;
123 zint rec_sysno_to_int(zint sysno)
125 assert(sysno >= FAKE_OFFSET && sysno <= FAKE_OFFSET + USUAL_RANGE);
126 return sysno - FAKE_OFFSET;
129 static void rec_tmp_expand(Records p, int size)
131 if (p->tmp_size < size + 2048 ||
132 p->tmp_size < p->head.block_size[REC_BLOCK_TYPES-1]*2)
135 p->tmp_size = size + (int)
136 (p->head.block_size[REC_BLOCK_TYPES-1])*2 + 2048;
137 p->tmp_buf = (char *) xmalloc(p->tmp_size);
141 static ZEBRA_RES rec_release_blocks(Records p, zint sysno)
143 struct record_index_entry entry;
145 char block_and_ref[sizeof(zint) + sizeof(short)];
149 if (recindex_read_indx(p->recindex, sysno, &entry, sizeof(entry), 1) != 1)
152 freeblock = entry.next;
153 assert(freeblock > 0);
154 dst_type = CAST_ZINT_TO_INT(freeblock & 7);
155 assert(dst_type < REC_BLOCK_TYPES);
156 freeblock = freeblock / 8;
159 if (bf_read(p->data_BFile[dst_type], freeblock, 0,
160 first ? sizeof(block_and_ref) : sizeof(zint),
163 yaz_log(YLOG_FATAL|YLOG_ERRNO, "read in rec_del_single");
169 memcpy(&ref, block_and_ref + sizeof(freeblock), sizeof(ref));
171 memcpy(block_and_ref + sizeof(freeblock), &ref, sizeof(ref));
174 if (bf_write(p->data_BFile[dst_type], freeblock, 0,
175 sizeof(block_and_ref), block_and_ref))
177 yaz_log(YLOG_FATAL|YLOG_ERRNO, "write in rec_del_single");
185 if (bf_write(p->data_BFile[dst_type], freeblock, 0, sizeof(freeblock),
186 &p->head.block_free[dst_type]))
188 yaz_log(YLOG_FATAL|YLOG_ERRNO, "write in rec_del_single");
191 p->head.block_free[dst_type] = freeblock;
192 memcpy(&freeblock, block_and_ref, sizeof(freeblock));
194 p->head.block_used[dst_type]--;
196 p->head.total_bytes -= entry.size;
200 static ZEBRA_RES rec_delete_single(Records p, Record rec)
202 struct record_index_entry entry;
204 /* all data in entry must be reset, since it's written verbatim */
205 memset(&entry, '\0', sizeof(entry));
206 if (rec_release_blocks(p, rec_sysno_to_int(rec->sysno)) != ZEBRA_OK)
209 yaz_log(YLOG_LOG, "rec_delete_single sysno=" ZINT_FORMAT, rec->sysno);
210 entry.next = p->head.index_free;
212 p->head.index_free = rec_sysno_to_int(rec->sysno);
213 recindex_write_indx(p->recindex, rec_sysno_to_int(rec->sysno), &entry, sizeof(entry));
217 static ZEBRA_RES rec_write_tmp_buf(Records p, int size, zint *sysnos)
219 struct record_index_entry entry;
221 char *cptr = p->tmp_buf;
222 zint block_prev = -1, block_free;
226 /* all data in entry must be reset, since it's written verbatim */
227 memset(&entry, '\0', sizeof(entry));
229 for (i = 1; i<REC_BLOCK_TYPES; i++)
230 if (size >= p->head.block_move[i])
232 while (no_written < size)
234 block_free = p->head.block_free[dst_type];
237 if (bf_read(p->data_BFile[dst_type],
238 block_free, 0, sizeof(*p->head.block_free),
239 &p->head.block_free[dst_type]) != 1)
241 yaz_log(YLOG_FATAL|YLOG_ERRNO, "read in %s at free block "
243 p->data_fname[dst_type], block_free);
248 block_free = p->head.block_last[dst_type]++;
249 if (block_prev == -1)
251 entry.next = block_free*8 + dst_type;
253 p->head.total_bytes += size;
256 recindex_write_indx(p->recindex, *sysnos, &entry, sizeof(entry));
262 memcpy(cptr, &block_free, sizeof(block_free));
263 bf_write(p->data_BFile[dst_type], block_prev, 0, 0, cptr);
264 cptr = p->tmp_buf + no_written;
266 block_prev = block_free;
267 no_written += CAST_ZINT_TO_INT(p->head.block_size[dst_type])
269 p->head.block_used[dst_type]++;
271 assert(block_prev != -1);
273 memcpy(cptr, &block_free, sizeof(block_free));
274 bf_write(p->data_BFile[dst_type], block_prev, 0,
275 sizeof(block_free) + (p->tmp_buf+size) - cptr, cptr);
279 Records rec_open(BFiles bfs, int rw, int compression_method)
284 ZEBRA_RES ret = ZEBRA_OK;
286 p = (Records) xmalloc(sizeof(*p));
287 memset(&p->head, '\0', sizeof(p->head));
288 p->compression_method = compression_method;
291 p->tmp_buf = (char *) xmalloc(p->tmp_size);
292 p->compression_chunk_size = 0;
293 p->recindex = recindex_open(bfs, rw, 0 /* 1=isamb for recindex */);
294 r = recindex_read_head(p->recindex, p->tmp_buf);
298 memcpy(p->head.magic, REC_HEAD_MAGIC, sizeof(p->head.magic));
299 sprintf(p->head.version, "%3d", REC_VERSION);
300 p->head.index_free = 0;
301 p->head.index_last = 1;
302 p->head.no_records = 0;
303 p->head.total_bytes = 0;
304 for (i = 0; i<REC_BLOCK_TYPES; i++)
306 p->head.block_free[i] = 0;
307 p->head.block_last[i] = 1;
308 p->head.block_used[i] = 0;
310 p->head.block_size[0] = 128;
311 p->head.block_move[0] = 0;
312 for (i = 1; i<REC_BLOCK_TYPES; i++)
314 p->head.block_size[i] = p->head.block_size[i-1] * 4;
315 p->head.block_move[i] = p->head.block_size[i] * 24;
319 if (recindex_write_head(p->recindex,
320 &p->head, sizeof(p->head)) != ZEBRA_OK)
325 memcpy(&p->head, p->tmp_buf, sizeof(p->head));
326 if (memcmp(p->head.magic, REC_HEAD_MAGIC, sizeof(p->head.magic)))
328 yaz_log(YLOG_FATAL, "file %s has bad format",
329 recindex_get_fname(p->recindex));
332 version = atoi(p->head.version);
333 if (version != REC_VERSION)
335 yaz_log(YLOG_FATAL, "file %s is version %d, but version"
337 recindex_get_fname(p->recindex), version, REC_VERSION);
340 p->compression_chunk_size = 90000; /* good for BZIP2 */
343 for (i = 0; i<REC_BLOCK_TYPES; i++)
346 sprintf(str, "recd%c", i + 'A');
347 p->data_fname[i] = (char *) xmalloc(strlen(str)+1);
348 strcpy(p->data_fname[i], str);
349 p->data_BFile[i] = NULL;
351 for (i = 0; i<REC_BLOCK_TYPES; i++)
353 if (!(p->data_BFile[i] =
354 bf_open(bfs, p->data_fname[i],
355 CAST_ZINT_TO_INT(p->head.block_size[i]), rw)))
357 yaz_log(YLOG_FATAL|YLOG_ERRNO, "bf_open %s", p->data_fname[i]);
364 p->record_cache = (struct record_cache_entry *)
365 xmalloc(sizeof(*p->record_cache)*p->cache_max);
366 zebra_mutex_init(&p->mutex);
367 if (ret == ZEBRA_FAIL)
372 static void rec_encode_unsigned(unsigned n, unsigned char *buf, int *len)
377 buf[*len] = 128 + (n & 127);
385 static void rec_decode_unsigned(unsigned *np, unsigned char *buf, int *len)
391 while (buf[*len] > 127)
393 n += w*(buf[*len] & 127);
402 static void rec_encode_zint(zint n, unsigned char *buf, int *len)
407 buf[*len] = (unsigned) (128 + (n & 127));
411 buf[*len] = (unsigned) n;
415 static void rec_decode_zint(zint *np, unsigned char *buf, int *len)
421 while (buf[*len] > 127)
423 n += w*(buf[*len] & 127);
432 static void rec_cache_flush_block1(Records p, Record rec, Record last_rec,
433 char **out_buf, int *out_size,
439 for (i = 0; i<REC_NO_INFO; i++)
441 if (*out_offset + CAST_ZINT_TO_INT(rec->size[i]) + 20 > *out_size)
443 int new_size = *out_offset + rec->size[i] + 65536;
444 char *np = (char *) xmalloc(new_size);
446 memcpy(np, *out_buf, *out_offset);
448 *out_size = new_size;
453 rec_encode_zint(rec_sysno_to_int(rec->sysno),
454 (unsigned char *) *out_buf + *out_offset, &len);
455 (*out_offset) += len;
457 if (rec->size[i] == 0)
459 rec_encode_unsigned(1, (unsigned char *) *out_buf + *out_offset,
461 (*out_offset) += len;
463 else if (last_rec && rec->size[i] == last_rec->size[i] &&
464 !memcmp(rec->info[i], last_rec->info[i], rec->size[i]))
466 rec_encode_unsigned(0, (unsigned char *) *out_buf + *out_offset,
468 (*out_offset) += len;
472 rec_encode_unsigned(rec->size[i]+1,
473 (unsigned char *) *out_buf + *out_offset,
475 (*out_offset) += len;
476 memcpy(*out_buf + *out_offset, rec->info[i], rec->size[i]);
477 (*out_offset) += rec->size[i];
482 static ZEBRA_RES rec_write_multiple(Records p, int saveCount)
486 char compression_method;
490 char *out_buf = (char *) xmalloc(out_size);
491 zint *sysnos = (zint *) xmalloc(sizeof(*sysnos) * (p->cache_cur + 1));
492 zint *sysnop = sysnos;
493 ZEBRA_RES ret = ZEBRA_OK;
495 for (i = 0; i<p->cache_cur - saveCount; i++)
497 struct record_cache_entry *e = p->record_cache + i;
501 rec_cache_flush_block1(p, e->rec, last_rec, &out_buf,
502 &out_size, &out_offset);
503 *sysnop++ = rec_sysno_to_int(e->rec->sysno);
505 e->flag = recordFlagNop;
508 case recordFlagWrite:
509 if (rec_release_blocks(p, rec_sysno_to_int(e->rec->sysno))
513 rec_cache_flush_block1(p, e->rec, last_rec, &out_buf,
514 &out_size, &out_offset);
515 *sysnop++ = rec_sysno_to_int(e->rec->sysno);
517 e->flag = recordFlagNop;
520 case recordFlagDelete:
521 if (rec_delete_single(p, e->rec) != ZEBRA_OK)
524 e->flag = recordFlagNop;
534 unsigned int csize = 0; /* indicate compression "not performed yet" */
535 compression_method = p->compression_method;
536 switch (compression_method)
538 case REC_COMPRESS_BZIP2:
540 csize = out_offset + (out_offset >> 6) + 620;
541 rec_tmp_expand(p, csize);
542 #ifdef BZ_CONFIG_ERROR
543 i = BZ2_bzBuffToBuffCompress
545 i = bzBuffToBuffCompress
547 (p->tmp_buf+sizeof(zint)+sizeof(short)+
549 &csize, out_buf, out_offset, 1, 0, 30);
552 yaz_log(YLOG_WARN, "bzBuffToBuffCompress error code=%d", i);
555 yaz_log(YLOG_LOG, "compress %4d %5d %5d", ref_count, out_offset,
559 case REC_COMPRESS_NONE:
564 /* either no compression or compression not supported ... */
566 rec_tmp_expand(p, csize);
567 memcpy(p->tmp_buf + sizeof(zint) + sizeof(short) + sizeof(char),
568 out_buf, out_offset);
570 compression_method = REC_COMPRESS_NONE;
572 memcpy(p->tmp_buf + sizeof(zint), &ref_count, sizeof(ref_count));
573 memcpy(p->tmp_buf + sizeof(zint)+sizeof(short),
574 &compression_method, sizeof(compression_method));
576 /* -------- compression */
577 if (rec_write_tmp_buf(p, csize + sizeof(short) + sizeof(char), sysnos)
586 static ZEBRA_RES rec_cache_flush(Records p, int saveCount)
591 if (saveCount >= p->cache_cur)
594 ret = rec_write_multiple(p, saveCount);
596 for (i = 0; i<p->cache_cur - saveCount; i++)
598 struct record_cache_entry *e = p->record_cache + i;
601 /* i still being used ... */
602 for (j = 0; j<saveCount; j++, i++)
603 memcpy(p->record_cache+j, p->record_cache+i,
604 sizeof(*p->record_cache));
605 p->cache_cur = saveCount;
609 static Record *rec_cache_lookup(Records p, zint sysno,
610 enum recordCacheFlag flag)
613 for (i = 0; i<p->cache_cur; i++)
615 struct record_cache_entry *e = p->record_cache + i;
616 if (e->rec->sysno == sysno)
618 if (flag != recordFlagNop && e->flag == recordFlagNop)
626 static ZEBRA_RES rec_cache_insert(Records p, Record rec, enum recordCacheFlag flag)
628 struct record_cache_entry *e;
629 ZEBRA_RES ret = ZEBRA_OK;
631 if (p->cache_cur == p->cache_max)
632 ret = rec_cache_flush(p, 1);
633 else if (p->cache_cur > 0)
637 for (i = 0; i<p->cache_cur; i++)
639 Record r = (p->record_cache + i)->rec;
640 for (j = 0; j<REC_NO_INFO; j++)
643 if (used > p->compression_chunk_size)
644 ret = rec_cache_flush(p, 1);
646 assert(p->cache_cur < p->cache_max);
648 e = p->record_cache + (p->cache_cur)++;
650 e->rec = rec_cp(rec);
654 ZEBRA_RES rec_close(Records *pp)
658 ZEBRA_RES ret = ZEBRA_OK;
663 zebra_mutex_destroy(&p->mutex);
664 if (rec_cache_flush(p, 0) != ZEBRA_OK)
667 xfree(p->record_cache);
671 if (recindex_write_head(p->recindex, &p->head, sizeof(p->head)) != ZEBRA_OK)
675 recindex_close(p->recindex);
677 for (i = 0; i<REC_BLOCK_TYPES; i++)
679 if (p->data_BFile[i])
680 bf_close(p->data_BFile[i]);
681 xfree(p->data_fname[i]);
689 static Record rec_get_int(Records p, zint sysno)
693 struct record_index_entry entry;
700 unsigned int bz_size;
702 char compression_method;
707 if ((recp = rec_cache_lookup(p, sysno, recordFlagNop)))
708 return rec_cp(*recp);
710 if (recindex_read_indx(p->recindex, rec_sysno_to_int(sysno), &entry, sizeof(entry), 1) < 1)
711 return NULL; /* record is not there! */
714 return NULL; /* record is deleted */
716 dst_type = (int) (entry.next & 7);
717 assert(dst_type < REC_BLOCK_TYPES);
718 freeblock = entry.next / 8;
720 assert(freeblock > 0);
722 rec_tmp_expand(p, entry.size);
725 r = bf_read(p->data_BFile[dst_type], freeblock, 0, 0, cptr);
728 memcpy(&freeblock, cptr, sizeof(freeblock));
734 cptr += p->head.block_size[dst_type] - sizeof(freeblock);
736 memcpy(&tmp, cptr, sizeof(tmp));
737 r = bf_read(p->data_BFile[dst_type], freeblock, 0, 0, cptr);
740 memcpy(&freeblock, cptr, sizeof(freeblock));
741 memcpy(cptr, &tmp, sizeof(tmp));
744 rec = (Record) xmalloc(sizeof(*rec));
746 memcpy(&compression_method, p->tmp_buf + sizeof(zint) + sizeof(short),
747 sizeof(compression_method));
748 in_buf = p->tmp_buf + sizeof(zint) + sizeof(short) + sizeof(char);
749 in_size = entry.size - sizeof(short) - sizeof(char);
750 switch (compression_method)
752 case REC_COMPRESS_BZIP2:
754 bz_size = entry.size * 20 + 100;
757 bz_buf = (char *) xmalloc(bz_size);
758 #ifdef BZ_CONFIG_ERROR
759 i = BZ2_bzBuffToBuffDecompress
761 i = bzBuffToBuffDecompress
763 (bz_buf, &bz_size, in_buf, in_size, 0, 0);
764 yaz_log(YLOG_LOG, "decompress %5d %5d", in_size, bz_size);
767 yaz_log(YLOG_LOG, "failed");
774 yaz_log(YLOG_FATAL, "cannot decompress record(s) in BZIP2 format");
778 case REC_COMPRESS_NONE:
781 for (i = 0; i<REC_NO_INFO; i++)
784 nptr = in_buf; /* skip ref count */
785 while (nptr < in_buf + in_size)
789 rec_decode_zint(&this_sysno, (unsigned char *) nptr, &len);
792 for (i = 0; i < REC_NO_INFO; i++)
794 unsigned int this_size;
795 rec_decode_unsigned(&this_size, (unsigned char *) nptr, &len);
800 rec->size[i] = this_size-1;
805 nptr += rec->size[i];
810 if (this_sysno == rec_sysno_to_int(sysno))
813 for (i = 0; i<REC_NO_INFO; i++)
815 if (rec->info[i] && rec->size[i])
817 char *np = xmalloc(rec->size[i]+1);
818 memcpy(np, rec->info[i], rec->size[i]);
819 np[rec->size[i]] = '\0';
824 assert(rec->info[i] == 0);
825 assert(rec->size[i] == 0);
829 if (rec_cache_insert(p, rec, recordFlagNop) != ZEBRA_OK)
834 Record rec_get(Records p, zint sysno)
837 zebra_mutex_lock(&p->mutex);
839 rec = rec_get_int(p, sysno);
840 zebra_mutex_unlock(&p->mutex);
844 Record rec_get_root(Records p)
846 return rec_get(p, rec_sysno_to_ext(1));
849 static Record rec_new_int(Records p)
856 rec = (Record) xmalloc(sizeof(*rec));
857 if (1 || p->head.index_free == 0)
858 sysno = (p->head.index_last)++;
861 struct record_index_entry entry;
863 if (recindex_read_indx(p->recindex, p->head.index_free, &entry, sizeof(entry), 0) < 1)
868 sysno = p->head.index_free;
869 p->head.index_free = entry.next;
871 (p->head.no_records)++;
872 rec->sysno = rec_sysno_to_ext(sysno);
873 for (i = 0; i < REC_NO_INFO; i++)
878 rec_cache_insert(p, rec, recordFlagNew);
882 Record rec_new(Records p)
885 zebra_mutex_lock(&p->mutex);
887 rec = rec_new_int(p);
888 zebra_mutex_unlock(&p->mutex);
892 ZEBRA_RES rec_del(Records p, Record *recpp)
895 ZEBRA_RES ret = ZEBRA_OK;
897 zebra_mutex_lock(&p->mutex);
898 (p->head.no_records)--;
899 if ((recp = rec_cache_lookup(p, (*recpp)->sysno, recordFlagDelete)))
906 ret = rec_cache_insert(p, *recpp, recordFlagDelete);
909 zebra_mutex_unlock(&p->mutex);
914 ZEBRA_RES rec_put(Records p, Record *recpp)
917 ZEBRA_RES ret = ZEBRA_OK;
919 zebra_mutex_lock(&p->mutex);
920 if ((recp = rec_cache_lookup(p, (*recpp)->sysno, recordFlagWrite)))
927 ret = rec_cache_insert(p, *recpp, recordFlagWrite);
930 zebra_mutex_unlock(&p->mutex);
935 void rec_free(Record *recpp)
941 for (i = 0; i < REC_NO_INFO; i++)
942 xfree((*recpp)->info[i]);
947 Record rec_cp(Record rec)
952 n = (Record) xmalloc(sizeof(*n));
953 n->sysno = rec->sysno;
954 for (i = 0; i < REC_NO_INFO; i++)
962 n->size[i] = rec->size[i];
963 n->info[i] = (char *) xmalloc(rec->size[i]+1);
964 memcpy(n->info[i], rec->info[i], rec->size[i]);
965 n->info[i][rec->size[i]] = '\0';
971 char *rec_strdup(const char *s, size_t *len)
981 p = (char *) xmalloc(*len);
986 void rec_prstat(Records records)
989 zint total_bytes = 0;
992 "Total records %8" ZINT_FORMAT0,
993 records->head.no_records);
995 for (i = 0; i< REC_BLOCK_TYPES; i++)
997 yaz_log (YLOG_LOG, "Record blocks of size "ZINT_FORMAT,
998 records->head.block_size[i]);
1000 " Used/Total/Bytes used "
1001 ZINT_FORMAT "/" ZINT_FORMAT "/" ZINT_FORMAT,
1002 records->head.block_used[i], records->head.block_last[i]-1,
1003 records->head.block_used[i] * records->head.block_size[i]);
1005 records->head.block_used[i] * records->head.block_size[i];
1008 "Total size of record index in bytes %8" ZINT_FORMAT0,
1009 records->head.total_bytes);
1011 "Total size with overhead %8" ZINT_FORMAT0,
1018 * indent-tabs-mode: nil
1020 * vim: shiftwidth=4 tabstop=8 expandtab