3 DB_File.xs -- Perl 5 interface to Berkeley DB
5 written by Paul Marquess (pmarquess@bfsec.bt.co.uk)
6 last modified 23rd June 1994
9 All comments/suggestions/problems are welcome
21 #ifndef DBXS_HASH_TYPE
22 #define DBXS_HASH_TYPE u_int32_t
25 #ifndef DBXS_PREFIX_TYPE
26 #define DBXS_PREFIX_TYPE size_t
45 #define db_DESTROY(db) (db->close)(db)
46 #define db_DELETE(db, key, flags) (db->del)(db, &key, flags)
47 #define db_STORE(db, key, value, flags) (db->put)(db, &key, &value, flags)
48 #define db_FETCH(db, key, flags) (db->get)(db, &key, &value, flags)
50 #define db_close(db) (db->close)(db)
51 #define db_del(db, key, flags) (db->del)(db, &key, flags)
52 #define db_fd(db) (db->fd)(db)
53 #define db_put(db, key, value, flags) (db->put)(db, &key, &value, flags)
54 #define db_get(db, key, value, flags) (db->get)(db, &key, &value, flags)
55 #define db_seq(db, key, value, flags) (db->seq)(db, &key, &value, flags)
56 #define db_sync(db, flags) (db->sync)(db, flags)
59 #define OutputValue(arg, name) \
60 { if (RETVAL == 0) sv_setpvn(arg, name.data, name.size) ; }
62 #define OutputKey(arg, name) \
65 if (db->close != DB_recno_close) \
66 sv_setpvn(arg, name.data, name.size); \
68 sv_setiv(arg, (I32)*(I32*)name.data - 1); \
72 /* Internal Global Data */
74 static recno_t Value ;
75 static int (*DB_recno_close)() = NULL ;
77 static CallBackInfo hash_callback = { 0 } ;
78 static CallBackInfo compare_callback = { 0 } ;
79 static CallBackInfo prefix_callback = { 0 } ;
83 btree_compare(key1, key2)
88 void * data1, * data2 ;
95 /* As newSVpv will assume that the data pointer is a null terminated C
96 string if the size parameter is 0, make sure that data points to an
97 empty string if the length is 0
109 PUSHs(sv_2mortal(newSVpv(data1,key1->size)));
110 PUSHs(sv_2mortal(newSVpv(data2,key2->size)));
113 count = perl_call_sv(compare_callback.sub, G_SCALAR);
118 croak ("DB_File btree_compare: expected 1 return value from %s, got %d\n", count) ;
129 static DBXS_PREFIX_TYPE
130 btree_prefix(key1, key2)
135 void * data1, * data2 ;
142 /* As newSVpv will assume that the data pointer is a null terminated C
143 string if the size parameter is 0, make sure that data points to an
144 empty string if the length is 0
156 PUSHs(sv_2mortal(newSVpv(data1,key1->size)));
157 PUSHs(sv_2mortal(newSVpv(data2,key2->size)));
160 count = perl_call_sv(prefix_callback.sub, G_SCALAR);
165 croak ("DB_File btree_prefix: expected 1 return value from %s, got %d\n", count) ;
176 static DBXS_HASH_TYPE
189 XPUSHs(sv_2mortal(newSVpv((char*)data,size)));
192 count = perl_call_sv(hash_callback.sub, G_SCALAR);
197 croak ("DB_File hash_cb: expected 1 return value from %s, got %d\n", count) ;
215 printf ("HASH Info\n") ;
216 printf (" hash = %s\n", (hash.hash != NULL ? "redefined" : "default")) ;
217 printf (" bsize = %d\n", hash.bsize) ;
218 printf (" ffactor = %d\n", hash.ffactor) ;
219 printf (" nelem = %d\n", hash.nelem) ;
220 printf (" cachesize = %d\n", hash.cachesize) ;
221 printf (" lorder = %d\n", hash.lorder) ;
229 printf ("RECNO Info\n") ;
230 printf (" flags = %d\n", recno.flags) ;
231 printf (" cachesize = %d\n", recno.cachesize) ;
232 printf (" psize = %d\n", recno.psize) ;
233 printf (" lorder = %d\n", recno.lorder) ;
234 printf (" reclen = %d\n", recno.reclen) ;
235 printf (" bval = %d\n", recno.bval) ;
236 printf (" bfname = %s\n", recno.bfname) ;
242 printf ("BTREE Info\n") ;
243 printf (" compare = %s\n", (btree.compare ? "redefined" : "default")) ;
244 printf (" prefix = %s\n", (btree.prefix ? "redefined" : "default")) ;
245 printf (" flags = %d\n", btree.flags) ;
246 printf (" cachesize = %d\n", btree.cachesize) ;
247 printf (" psize = %d\n", btree.psize) ;
248 printf (" maxkeypage = %d\n", btree.maxkeypage) ;
249 printf (" minkeypage = %d\n", btree.minkeypage) ;
250 printf (" lorder = %d\n", btree.lorder) ;
255 #define PrintRecno(recno)
256 #define PrintHash(hash)
257 #define PrintBtree(btree)
270 RETVAL = (db->seq)(db, &key, &value, R_LAST) ;
272 RETVAL = *(I32 *)key.data ;
273 else if (RETVAL == 1) /* No key means empty file */
280 ParseOpenInfo(name, flags, mode, sv, string)
291 void * openinfo = NULL ;
292 DBTYPE type = DB_HASH ;
298 croak ("type parameter is not a reference") ;
300 action = (HV*)SvRV(sv);
301 if (sv_isa(sv, "DB_File::HASHINFO"))
304 openinfo = (void*)&info ;
306 svp = hv_fetch(action, "hash", 4, FALSE);
308 if (svp && SvOK(*svp))
310 info.hash.hash = hash_cb ;
311 hash_callback.sub = *svp ;
314 info.hash.hash = NULL ;
316 svp = hv_fetch(action, "bsize", 5, FALSE);
317 info.hash.bsize = svp ? SvIV(*svp) : 0;
319 svp = hv_fetch(action, "ffactor", 7, FALSE);
320 info.hash.ffactor = svp ? SvIV(*svp) : 0;
322 svp = hv_fetch(action, "nelem", 5, FALSE);
323 info.hash.nelem = svp ? SvIV(*svp) : 0;
325 svp = hv_fetch(action, "cachesize", 9, FALSE);
326 info.hash.cachesize = svp ? SvIV(*svp) : 0;
328 svp = hv_fetch(action, "lorder", 6, FALSE);
329 info.hash.lorder = svp ? SvIV(*svp) : 0;
333 else if (sv_isa(sv, "DB_File::BTREEINFO"))
336 openinfo = (void*)&info ;
338 svp = hv_fetch(action, "compare", 7, FALSE);
339 if (svp && SvOK(*svp))
341 info.btree.compare = btree_compare ;
342 compare_callback.sub = *svp ;
345 info.btree.compare = NULL ;
347 svp = hv_fetch(action, "prefix", 6, FALSE);
348 if (svp && SvOK(*svp))
350 info.btree.prefix = btree_prefix ;
351 prefix_callback.sub = *svp ;
354 info.btree.prefix = NULL ;
356 svp = hv_fetch(action, "flags", 5, FALSE);
357 info.btree.flags = svp ? SvIV(*svp) : 0;
359 svp = hv_fetch(action, "cachesize", 9, FALSE);
360 info.btree.cachesize = svp ? SvIV(*svp) : 0;
362 svp = hv_fetch(action, "minkeypage", 10, FALSE);
363 info.btree.minkeypage = svp ? SvIV(*svp) : 0;
365 svp = hv_fetch(action, "maxkeypage", 10, FALSE);
366 info.btree.maxkeypage = svp ? SvIV(*svp) : 0;
368 svp = hv_fetch(action, "psize", 5, FALSE);
369 info.btree.psize = svp ? SvIV(*svp) : 0;
371 svp = hv_fetch(action, "lorder", 6, FALSE);
372 info.btree.lorder = svp ? SvIV(*svp) : 0;
377 else if (sv_isa(sv, "DB_File::RECNOINFO"))
380 openinfo = (void *)&info ;
382 svp = hv_fetch(action, "flags", 5, FALSE);
383 info.recno.flags = (u_long) svp ? SvIV(*svp) : 0;
385 svp = hv_fetch(action, "cachesize", 9, FALSE);
386 info.recno.cachesize = (u_int) svp ? SvIV(*svp) : 0;
388 svp = hv_fetch(action, "psize", 5, FALSE);
389 info.recno.psize = (int) svp ? SvIV(*svp) : 0;
391 svp = hv_fetch(action, "lorder", 6, FALSE);
392 info.recno.lorder = (int) svp ? SvIV(*svp) : 0;
394 svp = hv_fetch(action, "reclen", 6, FALSE);
395 info.recno.reclen = (size_t) svp ? SvIV(*svp) : 0;
397 svp = hv_fetch(action, "bval", 4, FALSE);
398 if (svp && SvOK(*svp))
401 info.recno.bval = (u_char)*SvPV(*svp, na) ;
403 info.recno.bval = (u_char)(unsigned long) SvIV(*svp) ;
407 if (info.recno.flags & R_FIXEDLEN)
408 info.recno.bval = (u_char) ' ' ;
410 info.recno.bval = (u_char) '\n' ;
413 svp = hv_fetch(action, "bfname", 6, FALSE);
414 info.recno.bfname = (char *) svp ? SvPV(*svp,na) : 0;
419 croak("type is not of type DB_File::HASHINFO, DB_File::BTREEINFO or DB_File::RECNOINFO");
423 RETVAL = dbopen(name, flags, mode, type, openinfo) ;
426 croak("DB_File::%s failed, reason: %s", string, Strerror(errno)) ;
428 /* kludge mode on: RETVAL->type for DB_RECNO is set to DB_BTREE
429 so remember a DB_RECNO by saving the address
430 of one of it's internal routines
432 if (type == DB_RECNO)
433 DB_recno_close = RETVAL->close ;
444 croak("DB_File::%s not implemented on this architecture", s);
458 if (strEQ(name, "BTREEMAGIC"))
464 if (strEQ(name, "BTREEVERSION"))
474 if (strEQ(name, "DB_LOCK"))
480 if (strEQ(name, "DB_SHMEM"))
486 if (strEQ(name, "DB_TXN"))
500 if (strEQ(name, "HASHMAGIC"))
506 if (strEQ(name, "HASHVERSION"))
522 if (strEQ(name, "MAX_PAGE_NUMBER"))
523 #ifdef MAX_PAGE_NUMBER
524 return (U32)MAX_PAGE_NUMBER;
528 if (strEQ(name, "MAX_PAGE_OFFSET"))
529 #ifdef MAX_PAGE_OFFSET
530 return MAX_PAGE_OFFSET;
534 if (strEQ(name, "MAX_REC_NUMBER"))
535 #ifdef MAX_REC_NUMBER
536 return (U32)MAX_REC_NUMBER;
550 if (strEQ(name, "RET_ERROR"))
556 if (strEQ(name, "RET_SPECIAL"))
562 if (strEQ(name, "RET_SUCCESS"))
568 if (strEQ(name, "R_CURSOR"))
574 if (strEQ(name, "R_DUP"))
580 if (strEQ(name, "R_FIRST"))
586 if (strEQ(name, "R_FIXEDLEN"))
592 if (strEQ(name, "R_IAFTER"))
598 if (strEQ(name, "R_IBEFORE"))
604 if (strEQ(name, "R_LAST"))
610 if (strEQ(name, "R_NEXT"))
616 if (strEQ(name, "R_NOKEY"))
622 if (strEQ(name, "R_NOOVERWRITE"))
624 return R_NOOVERWRITE;
628 if (strEQ(name, "R_PREV"))
634 if (strEQ(name, "R_RECNOSYNC"))
640 if (strEQ(name, "R_SETCURSOR"))
646 if (strEQ(name, "R_SNAPSHOT"))
670 if (strEQ(name, "__R_UNUSED"))
686 MODULE = DB_File PACKAGE = DB_File PREFIX = db_
695 db_TIEHASH(dbtype, name=undef, flags=O_RDWR, mode=0640, type=DB_HASH)
701 char * name = (char *) NULL ;
702 SV * sv = (SV *) NULL ;
704 if (items >= 2 && SvOK(ST(1)))
705 name = (char*) SvPV(ST(1), na) ;
710 RETVAL = ParseOpenInfo(name, flags, mode, sv, "new") ;
716 newXS("DB_File::TIEARRAY", XS_DB_File_db_TIEHASH, file);
724 db_DELETE(db, key, flags=0)
730 db_FETCH(db, key, flags=0)
738 RETVAL = (db->get)(db, &key, &value, flags) ;
739 ST(0) = sv_newmortal();
741 sv_setpvn(ST(0), value.data, value.size);
745 db_STORE(db, key, value, flags=0)
760 RETVAL = (db->seq)(db, &key, &value, R_FIRST) ;
761 ST(0) = sv_newmortal();
764 if (db->type != DB_RECNO)
765 sv_setpvn(ST(0), key.data, key.size);
767 sv_setiv(ST(0), (I32)*(I32*)key.data - 1);
779 RETVAL = (db->seq)(db, &key, &value, R_NEXT) ;
780 ST(0) = sv_newmortal();
783 if (db->type != DB_RECNO)
784 sv_setpvn(ST(0), key.data, key.size);
786 sv_setiv(ST(0), (I32)*(I32*)key.data - 1);
791 # These would be nice for RECNO
805 for (i = items-1 ; i > 0 ; --i)
807 value.data = SvPV(ST(i), na) ;
811 key.size = sizeof(int) ;
812 RETVAL = (db->put)(db, &key, &value, R_IBEFORE) ;
828 /* First get the final value */
829 RETVAL = (db->seq)(db, &key, &value, R_LAST) ;
830 ST(0) = sv_newmortal();
834 RETVAL = (db->del)(db, &key, R_CURSOR) ;
836 sv_setpvn(ST(0), value.data, value.size);
848 /* get the first value */
849 RETVAL = (db->seq)(db, &key, &value, R_FIRST) ;
850 ST(0) = sv_newmortal();
854 RETVAL = (db->del)(db, &key, R_CURSOR) ;
856 sv_setpvn(ST(0), value.data, value.size);
870 /* Set the Cursor to the Last element */
871 RETVAL = (db->seq)(db, &key, &value, R_LAST) ;
874 /* for (i = 1 ; i < items ; ++i) */
875 for (i = items - 1 ; i > 0 ; --i)
877 value.data = SvPV(ST(i), na) ;
879 RETVAL = (db->put)(db, &key, &value, R_IAFTER) ;
893 RETVAL = GetArrayLength(db) ;
899 # Now provide an interface to the rest of the DB functionality
903 db_del(db, key, flags=0)
910 db_get(db, key, value, flags=0)
919 db_put(db, key, value, flags=0)
925 key if (flags & (R_IAFTER|R_IBEFORE)) OutputKey(ST(1), key);
938 db_seq(db, key, value, flags)