3 DB_File.xs -- Perl 5 interface to Berkeley DB
5 written by Paul Marquess (pmarquess@bfsec.bt.co.uk)
6 last modified 19th May 1995
9 All comments/suggestions/problems are welcome
13 0.2 - No longer bombs out if dbopen returns an error.
40 #define db_DESTROY(db) (db->close)(db)
41 #define db_DELETE(db, key, flags) (db->del)(db, &key, flags)
42 #define db_STORE(db, key, value, flags) (db->put)(db, &key, &value, flags)
43 #define db_FETCH(db, key, flags) (db->get)(db, &key, &value, flags)
45 #define db_close(db) (db->close)(db)
46 #define db_del(db, key, flags) (db->del)(db, &key, flags)
47 #define db_fd(db) (db->fd)(db)
48 #define db_put(db, key, value, flags) (db->put)(db, &key, &value, flags)
49 #define db_get(db, key, value, flags) (db->get)(db, &key, &value, flags)
50 #define db_seq(db, key, value, flags) (db->seq)(db, &key, &value, flags)
51 #define db_sync(db, flags) (db->sync)(db, flags)
54 #define OutputValue(arg, name) \
55 { if (RETVAL == 0) sv_setpvn(arg, name.data, name.size) ; }
57 #define OutputKey(arg, name) \
60 if (db->close != DB_recno_close) \
61 sv_setpvn(arg, name.data, name.size); \
63 sv_setiv(arg, (I32)*(I32*)name.data - 1); \
67 /* Internal Global Data */
69 static recno_t Value ;
70 static int (*DB_recno_close)() = NULL ;
72 static CallBackInfo hash_callback = { 0 } ;
73 static CallBackInfo compare_callback = { 0 } ;
74 static CallBackInfo prefix_callback = { 0 } ;
78 btree_compare(key1, key2)
83 void * data1, * data2 ;
90 /* As newSVpv will assume that the data pointer is a null terminated C
91 string if the size parameter is 0, make sure that data points to an
92 empty string if the length is 0
104 PUSHs(sv_2mortal(newSVpv(data1,key1->size)));
105 PUSHs(sv_2mortal(newSVpv(data2,key2->size)));
108 count = perl_call_sv(compare_callback.sub, G_SCALAR);
113 croak ("DB_File btree_compare: expected 1 return value from %s, got %d\n", count) ;
125 btree_prefix(key1, key2)
130 void * data1, * data2 ;
137 /* As newSVpv will assume that the data pointer is a null terminated C
138 string if the size parameter is 0, make sure that data points to an
139 empty string if the length is 0
151 PUSHs(sv_2mortal(newSVpv(data1,key1->size)));
152 PUSHs(sv_2mortal(newSVpv(data2,key2->size)));
155 count = perl_call_sv(prefix_callback.sub, G_SCALAR);
160 croak ("DB_File btree_prefix: expected 1 return value from %s, got %d\n", count) ;
184 XPUSHs(sv_2mortal(newSVpv((char*)data,size)));
187 count = perl_call_sv(hash_callback.sub, G_SCALAR);
192 croak ("DB_File hash_cb: expected 1 return value from %s, got %d\n", count) ;
210 printf ("HASH Info\n") ;
211 printf (" hash = %s\n", (hash.hash != NULL ? "redefined" : "default")) ;
212 printf (" bsize = %d\n", hash.bsize) ;
213 printf (" ffactor = %d\n", hash.ffactor) ;
214 printf (" nelem = %d\n", hash.nelem) ;
215 printf (" cachesize = %d\n", hash.cachesize) ;
216 printf (" lorder = %d\n", hash.lorder) ;
224 printf ("RECNO Info\n") ;
225 printf (" flags = %d\n", recno.flags) ;
226 printf (" cachesize = %d\n", recno.cachesize) ;
227 printf (" psize = %d\n", recno.psize) ;
228 printf (" lorder = %d\n", recno.lorder) ;
229 printf (" reclen = %d\n", recno.reclen) ;
230 printf (" bval = %d\n", recno.bval) ;
231 printf (" bfname = %s\n", recno.bfname) ;
237 printf ("BTREE Info\n") ;
238 printf (" compare = %s\n", (btree.compare ? "redefined" : "default")) ;
239 printf (" prefix = %s\n", (btree.prefix ? "redefined" : "default")) ;
240 printf (" flags = %d\n", btree.flags) ;
241 printf (" cachesize = %d\n", btree.cachesize) ;
242 printf (" psize = %d\n", btree.psize) ;
243 printf (" maxkeypage = %d\n", btree.maxkeypage) ;
244 printf (" minkeypage = %d\n", btree.minkeypage) ;
245 printf (" lorder = %d\n", btree.lorder) ;
250 #define PrintRecno(recno)
251 #define PrintHash(hash)
252 #define PrintBtree(btree)
265 RETVAL = (db->seq)(db, &key, &value, R_LAST) ;
267 RETVAL = *(I32 *)key.data ;
268 else if (RETVAL == 1) /* No key means empty file */
275 ParseOpenInfo(name, flags, mode, sv, string)
286 void * openinfo = NULL ;
287 DBTYPE type = DB_HASH ;
293 croak ("type parameter is not a reference") ;
295 action = (HV*)SvRV(sv);
296 if (sv_isa(sv, "DB_File::HASHINFO"))
299 openinfo = (void*)&info ;
301 svp = hv_fetch(action, "hash", 4, FALSE);
303 if (svp && SvOK(*svp))
305 info.hash.hash = hash_cb ;
306 hash_callback.sub = *svp ;
309 info.hash.hash = NULL ;
311 svp = hv_fetch(action, "bsize", 5, FALSE);
312 info.hash.bsize = svp ? SvIV(*svp) : 0;
314 svp = hv_fetch(action, "ffactor", 7, FALSE);
315 info.hash.ffactor = svp ? SvIV(*svp) : 0;
317 svp = hv_fetch(action, "nelem", 5, FALSE);
318 info.hash.nelem = svp ? SvIV(*svp) : 0;
320 svp = hv_fetch(action, "cachesize", 9, FALSE);
321 info.hash.cachesize = svp ? SvIV(*svp) : 0;
323 svp = hv_fetch(action, "lorder", 6, FALSE);
324 info.hash.lorder = svp ? SvIV(*svp) : 0;
328 else if (sv_isa(sv, "DB_File::BTREEINFO"))
331 openinfo = (void*)&info ;
333 svp = hv_fetch(action, "compare", 7, FALSE);
334 if (svp && SvOK(*svp))
336 info.btree.compare = btree_compare ;
337 compare_callback.sub = *svp ;
340 info.btree.compare = NULL ;
342 svp = hv_fetch(action, "prefix", 6, FALSE);
343 if (svp && SvOK(*svp))
345 info.btree.prefix = btree_prefix ;
346 prefix_callback.sub = *svp ;
349 info.btree.prefix = NULL ;
351 svp = hv_fetch(action, "flags", 5, FALSE);
352 info.btree.flags = svp ? SvIV(*svp) : 0;
354 svp = hv_fetch(action, "cachesize", 9, FALSE);
355 info.btree.cachesize = svp ? SvIV(*svp) : 0;
357 svp = hv_fetch(action, "minkeypage", 10, FALSE);
358 info.btree.minkeypage = svp ? SvIV(*svp) : 0;
360 svp = hv_fetch(action, "maxkeypage", 10, FALSE);
361 info.btree.maxkeypage = svp ? SvIV(*svp) : 0;
363 svp = hv_fetch(action, "psize", 5, FALSE);
364 info.btree.psize = svp ? SvIV(*svp) : 0;
366 svp = hv_fetch(action, "lorder", 6, FALSE);
367 info.btree.lorder = svp ? SvIV(*svp) : 0;
372 else if (sv_isa(sv, "DB_File::RECNOINFO"))
375 openinfo = (void *)&info ;
377 svp = hv_fetch(action, "flags", 5, FALSE);
378 info.recno.flags = (u_long) svp ? SvIV(*svp) : 0;
380 svp = hv_fetch(action, "cachesize", 9, FALSE);
381 info.recno.cachesize = (u_int) svp ? SvIV(*svp) : 0;
383 svp = hv_fetch(action, "psize", 5, FALSE);
384 info.recno.psize = (int) svp ? SvIV(*svp) : 0;
386 svp = hv_fetch(action, "lorder", 6, FALSE);
387 info.recno.lorder = (int) svp ? SvIV(*svp) : 0;
389 svp = hv_fetch(action, "reclen", 6, FALSE);
390 info.recno.reclen = (size_t) svp ? SvIV(*svp) : 0;
392 svp = hv_fetch(action, "bval", 4, FALSE);
393 if (svp && SvOK(*svp))
396 info.recno.bval = (u_char)*SvPV(*svp, na) ;
398 info.recno.bval = (u_char)(unsigned long) SvIV(*svp) ;
402 if (info.recno.flags & R_FIXEDLEN)
403 info.recno.bval = (u_char) ' ' ;
405 info.recno.bval = (u_char) '\n' ;
408 svp = hv_fetch(action, "bfname", 6, FALSE);
409 info.recno.bfname = (char *) svp ? SvPV(*svp,na) : 0;
414 croak("type is not of type DB_File::HASHINFO, DB_File::BTREEINFO or DB_File::RECNOINFO");
418 RETVAL = dbopen(name, flags, mode, type, openinfo) ;
420 /* kludge mode on: RETVAL->type for DB_RECNO is set to DB_BTREE
421 so remember a DB_RECNO by saving the address
422 of one of it's internal routines
424 if (RETVAL && type == DB_RECNO)
425 DB_recno_close = RETVAL->close ;
436 croak("DB_File::%s not implemented on this architecture", s);
450 if (strEQ(name, "BTREEMAGIC"))
456 if (strEQ(name, "BTREEVERSION"))
466 if (strEQ(name, "DB_LOCK"))
472 if (strEQ(name, "DB_SHMEM"))
478 if (strEQ(name, "DB_TXN"))
492 if (strEQ(name, "HASHMAGIC"))
498 if (strEQ(name, "HASHVERSION"))
514 if (strEQ(name, "MAX_PAGE_NUMBER"))
515 #ifdef MAX_PAGE_NUMBER
516 return (U32)MAX_PAGE_NUMBER;
520 if (strEQ(name, "MAX_PAGE_OFFSET"))
521 #ifdef MAX_PAGE_OFFSET
522 return MAX_PAGE_OFFSET;
526 if (strEQ(name, "MAX_REC_NUMBER"))
527 #ifdef MAX_REC_NUMBER
528 return (U32)MAX_REC_NUMBER;
542 if (strEQ(name, "RET_ERROR"))
548 if (strEQ(name, "RET_SPECIAL"))
554 if (strEQ(name, "RET_SUCCESS"))
560 if (strEQ(name, "R_CURSOR"))
566 if (strEQ(name, "R_DUP"))
572 if (strEQ(name, "R_FIRST"))
578 if (strEQ(name, "R_FIXEDLEN"))
584 if (strEQ(name, "R_IAFTER"))
590 if (strEQ(name, "R_IBEFORE"))
596 if (strEQ(name, "R_LAST"))
602 if (strEQ(name, "R_NEXT"))
608 if (strEQ(name, "R_NOKEY"))
614 if (strEQ(name, "R_NOOVERWRITE"))
616 return R_NOOVERWRITE;
620 if (strEQ(name, "R_PREV"))
626 if (strEQ(name, "R_RECNOSYNC"))
632 if (strEQ(name, "R_SETCURSOR"))
638 if (strEQ(name, "R_SNAPSHOT"))
662 if (strEQ(name, "__R_UNUSED"))
678 MODULE = DB_File PACKAGE = DB_File PREFIX = db_
687 db_TIEHASH(dbtype, name=undef, flags=O_RDWR, mode=0640, type=DB_HASH)
693 char * name = (char *) NULL ;
694 SV * sv = (SV *) NULL ;
696 if (items >= 2 && SvOK(ST(1)))
697 name = (char*) SvPV(ST(1), na) ;
702 RETVAL = ParseOpenInfo(name, flags, mode, sv, "new") ;
708 newXS("DB_File::TIEARRAY", XS_DB_File_db_TIEHASH, file);
716 db_DELETE(db, key, flags=0)
722 db_FETCH(db, key, flags=0)
730 RETVAL = (db->get)(db, &key, &value, flags) ;
731 ST(0) = sv_newmortal();
733 sv_setpvn(ST(0), value.data, value.size);
737 db_STORE(db, key, value, flags=0)
752 RETVAL = (db->seq)(db, &key, &value, R_FIRST) ;
753 ST(0) = sv_newmortal();
756 if (db->type != DB_RECNO)
757 sv_setpvn(ST(0), key.data, key.size);
759 sv_setiv(ST(0), (I32)*(I32*)key.data - 1);
771 RETVAL = (db->seq)(db, &key, &value, R_NEXT) ;
772 ST(0) = sv_newmortal();
775 if (db->type != DB_RECNO)
776 sv_setpvn(ST(0), key.data, key.size);
778 sv_setiv(ST(0), (I32)*(I32*)key.data - 1);
783 # These would be nice for RECNO
797 for (i = items-1 ; i > 0 ; --i)
799 value.data = SvPV(ST(i), na) ;
803 key.size = sizeof(int) ;
804 RETVAL = (db->put)(db, &key, &value, R_IBEFORE) ;
820 /* First get the final value */
821 RETVAL = (db->seq)(db, &key, &value, R_LAST) ;
822 ST(0) = sv_newmortal();
826 RETVAL = (db->del)(db, &key, R_CURSOR) ;
828 sv_setpvn(ST(0), value.data, value.size);
840 /* get the first value */
841 RETVAL = (db->seq)(db, &key, &value, R_FIRST) ;
842 ST(0) = sv_newmortal();
846 RETVAL = (db->del)(db, &key, R_CURSOR) ;
848 sv_setpvn(ST(0), value.data, value.size);
862 /* Set the Cursor to the Last element */
863 RETVAL = (db->seq)(db, &key, &value, R_LAST) ;
866 /* for (i = 1 ; i < items ; ++i) */
867 for (i = items - 1 ; i > 0 ; --i)
869 value.data = SvPV(ST(i), na) ;
871 RETVAL = (db->put)(db, &key, &value, R_IAFTER) ;
885 RETVAL = GetArrayLength(db) ;
891 # Now provide an interface to the rest of the DB functionality
895 db_del(db, key, flags=0)
902 db_get(db, key, value, flags=0)
911 db_put(db, key, value, flags=0)
917 key if (flags & (R_IAFTER|R_IBEFORE)) OutputKey(ST(1), key);
930 db_seq(db, key, value, flags)