ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/BDB/BDB.xs
Revision: 1.44
Committed: Wed Jul 9 21:00:13 2008 UTC (15 years, 10 months ago) by root
Branch: MAIN
Changes since 1.43: +9 -0 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 #include "xthread.h"
2
3 #include <errno.h>
4
5 #include "EXTERN.h"
6 #include "perl.h"
7 #include "XSUB.h"
8
9 // perl stupidly defines these as macros, breaking
10 // lots and lots of code.
11 #undef open
12 #undef close
13 #undef abort
14 #undef malloc
15 #undef free
16 #undef send
17
18 #include <stddef.h>
19 #include <stdlib.h>
20 #include <errno.h>
21 #include <sys/types.h>
22 #include <limits.h>
23 #include <fcntl.h>
24
25 #ifndef _WIN32
26 # include <sys/time.h>
27 # include <unistd.h>
28 #endif
29
30 #include <db.h>
31
32 #if DB_VERSION_MAJOR < 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR < 4)
33 # error you need Berkeley DB 4.4 or newer installed
34 #endif
35
36 /* number of seconds after which idle threads exit */
37 #define IDLE_TIMEOUT 10
38
39 typedef DB_ENV DB_ENV_ornull;
40 typedef DB_TXN DB_TXN_ornull;
41 typedef DBC DBC_ornull;
42 typedef DB DB_ornull;
43 typedef DB_SEQUENCE DB_SEQUENCE_ornull;
44
45 typedef DB_ENV DB_ENV_ornuked;
46 typedef DB_TXN DB_TXN_ornuked;
47 typedef DBC DBC_ornuked;
48 typedef DB DB_ornuked;
49 typedef DB_SEQUENCE DB_SEQUENCE_ornuked;
50
51 typedef SV SV8; /* byte-sv, used for argument-checking */
52 typedef char *bdb_filename;
53
54 static SV *prepare_cb;
55
56 #if DB_VERSION_MINOR >= 6
57 # define c_close close
58 # define c_count count
59 # define c_del del
60 # define c_dup dup
61 # define c_get get
62 # define c_pget pget
63 # define c_put put
64 #endif
65
66 static char *
67 get_bdb_filename (SV *sv)
68 {
69 if (!SvOK (sv))
70 return 0;
71
72 #if _WIN32
73 /* win32 madness + win32 perl absolutely brokenness make for horrible hacks */
74 {
75 STRLEN len;
76 char *src = SvPVbyte (sv, len);
77 SV *t1 = sv_newmortal ();
78 SV *t2 = sv_newmortal ();
79
80 sv_upgrade (t1, SVt_PV); SvPOK_only (t1); SvGROW (t1, len * 16 + 1);
81 sv_upgrade (t2, SVt_PV); SvPOK_only (t2); SvGROW (t2, len * 16 + 1);
82
83 len = MultiByteToWideChar (CP_ACP, 0, src, len, (WCHAR *)SvPVX (t1), SvLEN (t1) / sizeof (WCHAR));
84 len = WideCharToMultiByte (CP_UTF8, 0, (WCHAR *)SvPVX (t1), len, SvPVX (t2), SvLEN (t2), 0, 0);
85 SvPOK_only (t2);
86 SvPVX (t2)[len] = 0;
87 SvCUR_set (t2, len);
88
89 return SvPVX (t2);
90 }
91 #else
92 return SvPVbyte_nolen (sv);
93 #endif
94 }
95
96 static void
97 debug_errcall (const DB_ENV *dbenv, const char *errpfx, const char *msg)
98 {
99 printf ("err[%s]\n", msg);
100 }
101
102 static void
103 debug_msgcall (const DB_ENV *dbenv, const char *msg)
104 {
105 printf ("msg[%s]\n", msg);
106 }
107
108 static char *
109 strdup_ornull (const char *s)
110 {
111 return s ? strdup (s) : 0;
112 }
113
114 static void
115 sv_to_dbt (DBT *dbt, SV *sv)
116 {
117 STRLEN len;
118 char *data = SvPVbyte (sv, len);
119
120 dbt->data = malloc (len);
121 memcpy (dbt->data, data, len);
122 dbt->size = len;
123 dbt->flags = DB_DBT_REALLOC;
124 }
125
126 static void
127 dbt_to_sv (SV *sv, DBT *dbt)
128 {
129 if (sv)
130 {
131 SvREADONLY_off (sv);
132 sv_setpvn_mg (sv, dbt->data, dbt->size);
133 SvREFCNT_dec (sv);
134 }
135
136 free (dbt->data);
137 }
138
139 enum {
140 REQ_QUIT,
141 REQ_ENV_OPEN, REQ_ENV_CLOSE, REQ_ENV_TXN_CHECKPOINT, REQ_ENV_LOCK_DETECT,
142 REQ_ENV_MEMP_SYNC, REQ_ENV_MEMP_TRICKLE, REQ_ENV_DBREMOVE, REQ_ENV_DBRENAME,
143 REQ_DB_OPEN, REQ_DB_CLOSE, REQ_DB_COMPACT, REQ_DB_SYNC, REQ_DB_UPGRADE,
144 REQ_DB_PUT, REQ_DB_GET, REQ_DB_PGET, REQ_DB_DEL, REQ_DB_KEY_RANGE,
145 REQ_TXN_COMMIT, REQ_TXN_ABORT, REQ_TXN_FINISH,
146 REQ_C_CLOSE, REQ_C_COUNT, REQ_C_PUT, REQ_C_GET, REQ_C_PGET, REQ_C_DEL,
147 REQ_SEQ_OPEN, REQ_SEQ_CLOSE, REQ_SEQ_GET, REQ_SEQ_REMOVE,
148 };
149
150 typedef struct bdb_cb
151 {
152 struct bdb_cb *volatile next;
153 SV *callback;
154 int type, pri, result;
155
156 DB_ENV *env;
157 DB *db;
158 DB_TXN *txn;
159 DBC *dbc;
160
161 UV uv1;
162 int int1, int2;
163 U32 uint1, uint2;
164 char *buf1, *buf2, *buf3;
165 SV *sv1, *sv2, *sv3;
166
167 DBT dbt1, dbt2, dbt3;
168 DB_KEY_RANGE key_range;
169 DB_SEQUENCE *seq;
170 db_seq_t seq_t;
171 } bdb_cb;
172
173 typedef bdb_cb *bdb_req;
174
175 enum {
176 PRI_MIN = -4,
177 PRI_MAX = 4,
178
179 DEFAULT_PRI = 0,
180 PRI_BIAS = -PRI_MIN,
181 NUM_PRI = PRI_MAX + PRI_BIAS + 1,
182 };
183
184 #define AIO_TICKS ((1000000 + 1023) >> 10)
185
186 static SV *on_next_submit;
187
188 static unsigned int max_poll_time = 0;
189 static unsigned int max_poll_reqs = 0;
190
191 /* calculcate time difference in ~1/AIO_TICKS of a second */
192 static int tvdiff (struct timeval *tv1, struct timeval *tv2)
193 {
194 return (tv2->tv_sec - tv1->tv_sec ) * AIO_TICKS
195 + ((tv2->tv_usec - tv1->tv_usec) >> 10);
196 }
197
198 static int next_pri = DEFAULT_PRI + PRI_BIAS;
199
200 static unsigned int started, idle, wanted;
201
202 /* worker threads management */
203 static mutex_t wrklock = X_MUTEX_INIT;
204
205 typedef struct worker {
206 /* locked by wrklock */
207 struct worker *prev, *next;
208
209 thread_t tid;
210
211 /* locked by reslock, reqlock or wrklock */
212 bdb_req req; /* currently processed request */
213 void *dbuf;
214 DIR *dirp;
215 } worker;
216
217 static worker wrk_first = { &wrk_first, &wrk_first, 0 };
218
219 static void worker_clear (worker *wrk)
220 {
221 }
222
223 static void worker_free (worker *wrk)
224 {
225 wrk->next->prev = wrk->prev;
226 wrk->prev->next = wrk->next;
227
228 free (wrk);
229 }
230
231 static volatile unsigned int nreqs, nready, npending;
232 static volatile unsigned int max_idle = 4;
233 static volatile unsigned int max_outstanding = 0xffffffff;
234 static int respipe_osf [2], respipe [2] = { -1, -1 };
235
236 static mutex_t reslock = X_MUTEX_INIT;
237 static mutex_t reqlock = X_MUTEX_INIT;
238 static cond_t reqwait = X_COND_INIT;
239
240 #if WORDACCESS_UNSAFE
241
242 static unsigned int get_nready (void)
243 {
244 unsigned int retval;
245
246 X_LOCK (reqlock);
247 retval = nready;
248 X_UNLOCK (reqlock);
249
250 return retval;
251 }
252
253 static unsigned int get_npending (void)
254 {
255 unsigned int retval;
256
257 X_LOCK (reslock);
258 retval = npending;
259 X_UNLOCK (reslock);
260
261 return retval;
262 }
263
264 static unsigned int get_nthreads (void)
265 {
266 unsigned int retval;
267
268 X_LOCK (wrklock);
269 retval = started;
270 X_UNLOCK (wrklock);
271
272 return retval;
273 }
274
275 #else
276
277 # define get_nready() nready
278 # define get_npending() npending
279 # define get_nthreads() started
280
281 #endif
282
283 /*
284 * a somewhat faster data structure might be nice, but
285 * with 8 priorities this actually needs <20 insns
286 * per shift, the most expensive operation.
287 */
288 typedef struct {
289 bdb_req qs[NUM_PRI], qe[NUM_PRI]; /* qstart, qend */
290 int size;
291 } reqq;
292
293 static reqq req_queue;
294 static reqq res_queue;
295
296 int reqq_push (reqq *q, bdb_req req)
297 {
298 int pri = req->pri;
299 req->next = 0;
300
301 if (q->qe[pri])
302 {
303 q->qe[pri]->next = req;
304 q->qe[pri] = req;
305 }
306 else
307 q->qe[pri] = q->qs[pri] = req;
308
309 return q->size++;
310 }
311
312 bdb_req reqq_shift (reqq *q)
313 {
314 int pri;
315
316 if (!q->size)
317 return 0;
318
319 --q->size;
320
321 for (pri = NUM_PRI; pri--; )
322 {
323 bdb_req req = q->qs[pri];
324
325 if (req)
326 {
327 if (!(q->qs[pri] = req->next))
328 q->qe[pri] = 0;
329
330 return req;
331 }
332 }
333
334 abort ();
335 }
336
337 static int poll_cb (void);
338 static void req_free (bdb_req req);
339 static void req_cancel (bdb_req req);
340
341 static int req_invoke (bdb_req req)
342 {
343 dSP;
344
345 if (req->callback)
346 {
347 ENTER;
348 SAVETMPS;
349 PUSHMARK (SP);
350
351 switch (req->type)
352 {
353 case REQ_DB_CLOSE:
354 SvREFCNT_dec (req->sv1);
355 break;
356
357 case REQ_DB_GET:
358 case REQ_DB_PGET:
359 dbt_to_sv (req->sv3, &req->dbt3);
360 break;
361
362 case REQ_C_GET:
363 case REQ_C_PGET:
364 dbt_to_sv (req->sv1, &req->dbt1);
365 dbt_to_sv (req->sv2, &req->dbt2);
366 dbt_to_sv (req->sv3, &req->dbt3);
367 break;
368
369 case REQ_DB_PUT:
370 case REQ_C_PUT:
371 dbt_to_sv (0, &req->dbt1);
372 dbt_to_sv (0, &req->dbt2);
373 break;
374
375 case REQ_DB_KEY_RANGE:
376 {
377 AV *av = newAV ();
378
379 av_push (av, newSVnv (req->key_range.less));
380 av_push (av, newSVnv (req->key_range.equal));
381 av_push (av, newSVnv (req->key_range.greater));
382
383 SvREADONLY_off (req->sv1);
384 sv_setsv_mg (req->sv1, newRV_noinc ((SV *)av));
385 SvREFCNT_dec (req->sv1);
386 }
387 break;
388
389 case REQ_SEQ_GET:
390 SvREADONLY_off (req->sv1);
391
392 if (sizeof (IV) > 4)
393 sv_setiv_mg (req->sv1, (IV)req->seq_t);
394 else
395 sv_setnv_mg (req->sv1, (NV)req->seq_t);
396
397 SvREFCNT_dec (req->sv1);
398 break;
399 }
400
401 errno = req->result;
402
403 PUTBACK;
404 call_sv (req->callback, G_VOID | G_EVAL);
405 SPAGAIN;
406
407 FREETMPS;
408 LEAVE;
409 }
410
411 return !SvTRUE (ERRSV);
412 }
413
414 static void req_free (bdb_req req)
415 {
416 SvREFCNT_dec (req->callback);
417
418 free (req->buf1);
419 free (req->buf2);
420 free (req->buf3);
421
422 Safefree (req);
423 }
424
425 #ifdef USE_SOCKETS_AS_HANDLES
426 # define TO_SOCKET(x) (win32_get_osfhandle (x))
427 #else
428 # define TO_SOCKET(x) (x)
429 #endif
430
431 static void
432 create_respipe (void)
433 {
434 #ifdef _WIN32
435 int arg; /* argg */
436 #endif
437 int old_readfd = respipe [0];
438
439 if (respipe [1] >= 0)
440 respipe_close (TO_SOCKET (respipe [1]));
441
442 #ifdef _WIN32
443 if (PerlSock_socketpair (AF_UNIX, SOCK_STREAM, 0, respipe))
444 #else
445 if (pipe (respipe))
446 #endif
447 croak ("unable to initialize result pipe");
448
449 if (old_readfd >= 0)
450 {
451 if (dup2 (TO_SOCKET (respipe [0]), TO_SOCKET (old_readfd)) < 0)
452 croak ("unable to initialize result pipe(2)");
453
454 respipe_close (respipe [0]);
455 respipe [0] = old_readfd;
456 }
457
458 #ifdef _WIN32
459 arg = 1;
460 if (ioctlsocket (TO_SOCKET (respipe [0]), FIONBIO, &arg)
461 || ioctlsocket (TO_SOCKET (respipe [1]), FIONBIO, &arg))
462 #else
463 if (fcntl (respipe [0], F_SETFL, O_NONBLOCK)
464 || fcntl (respipe [1], F_SETFL, O_NONBLOCK))
465 #endif
466 croak ("unable to initialize result pipe(3)");
467
468 respipe_osf [0] = TO_SOCKET (respipe [0]);
469 respipe_osf [1] = TO_SOCKET (respipe [1]);
470 }
471
472 X_THREAD_PROC (bdb_proc);
473
474 static void start_thread (void)
475 {
476 worker *wrk = calloc (1, sizeof (worker));
477
478 if (!wrk)
479 croak ("unable to allocate worker thread data");
480
481 X_LOCK (wrklock);
482 if (thread_create (&wrk->tid, bdb_proc, (void *)wrk))
483 {
484 wrk->prev = &wrk_first;
485 wrk->next = wrk_first.next;
486 wrk_first.next->prev = wrk;
487 wrk_first.next = wrk;
488 ++started;
489 }
490 else
491 free (wrk);
492
493 X_UNLOCK (wrklock);
494 }
495
496 static void maybe_start_thread (void)
497 {
498 if (get_nthreads () >= wanted)
499 return;
500
501 /* todo: maybe use idle here, but might be less exact */
502 if (0 <= (int)get_nthreads () + (int)get_npending () - (int)nreqs)
503 return;
504
505 start_thread ();
506 }
507
508 static void req_send (bdb_req req)
509 {
510 SV *wait_callback = 0;
511
512 if (on_next_submit)
513 {
514 dSP;
515 SV *cb = sv_2mortal (on_next_submit);
516
517 on_next_submit = 0;
518
519 PUSHMARK (SP);
520 PUTBACK;
521 call_sv (cb, G_DISCARD | G_EVAL);
522 }
523
524 // synthesize callback if none given
525 if (!req->callback)
526 {
527 int count;
528
529 dSP;
530 PUSHMARK (SP);
531 PUTBACK;
532 count = call_sv (prepare_cb, G_ARRAY);
533 SPAGAIN;
534
535 if (count != 2)
536 croak ("prepare callback must return exactly two values\n");
537
538 wait_callback = POPs;
539 SvREFCNT_dec (req->callback);
540 req->callback = SvREFCNT_inc (POPs);
541 }
542
543 ++nreqs;
544
545 X_LOCK (reqlock);
546 ++nready;
547 reqq_push (&req_queue, req);
548 X_COND_SIGNAL (reqwait);
549 X_UNLOCK (reqlock);
550
551 maybe_start_thread ();
552
553 if (wait_callback)
554 {
555 dSP;
556 PUSHMARK (SP);
557 PUTBACK;
558 call_sv (wait_callback, G_DISCARD);
559 }
560 }
561
562 static void end_thread (void)
563 {
564 bdb_req req;
565
566 Newz (0, req, 1, bdb_cb);
567
568 req->type = REQ_QUIT;
569 req->pri = PRI_MAX + PRI_BIAS;
570
571 X_LOCK (reqlock);
572 reqq_push (&req_queue, req);
573 X_COND_SIGNAL (reqwait);
574 X_UNLOCK (reqlock);
575
576 X_LOCK (wrklock);
577 --started;
578 X_UNLOCK (wrklock);
579 }
580
581 static void set_max_idle (int nthreads)
582 {
583 if (WORDACCESS_UNSAFE) X_LOCK (reqlock);
584 max_idle = nthreads <= 0 ? 1 : nthreads;
585 if (WORDACCESS_UNSAFE) X_UNLOCK (reqlock);
586 }
587
588 static void min_parallel (int nthreads)
589 {
590 if (wanted < nthreads)
591 wanted = nthreads;
592 }
593
594 static void max_parallel (int nthreads)
595 {
596 if (wanted > nthreads)
597 wanted = nthreads;
598
599 while (started > wanted)
600 end_thread ();
601 }
602
603 static void poll_wait (void)
604 {
605 fd_set rfd;
606
607 while (nreqs)
608 {
609 int size;
610 if (WORDACCESS_UNSAFE) X_LOCK (reslock);
611 size = res_queue.size;
612 if (WORDACCESS_UNSAFE) X_UNLOCK (reslock);
613
614 if (size)
615 return;
616
617 maybe_start_thread ();
618
619 FD_ZERO (&rfd);
620 FD_SET (respipe [0], &rfd);
621
622 PerlSock_select (respipe [0] + 1, &rfd, 0, 0, 0);
623 }
624 }
625
626 static int poll_cb (void)
627 {
628 dSP;
629 int count = 0;
630 int maxreqs = max_poll_reqs;
631 int do_croak = 0;
632 struct timeval tv_start, tv_now;
633 bdb_req req;
634
635 if (max_poll_time)
636 gettimeofday (&tv_start, 0);
637
638 for (;;)
639 {
640 for (;;)
641 {
642 maybe_start_thread ();
643
644 X_LOCK (reslock);
645 req = reqq_shift (&res_queue);
646
647 if (req)
648 {
649 --npending;
650
651 if (!res_queue.size)
652 {
653 /* read any signals sent by the worker threads */
654 char buf [4];
655 while (respipe_read (respipe [0], buf, 4) == 4)
656 ;
657 }
658 }
659
660 X_UNLOCK (reslock);
661
662 if (!req)
663 break;
664
665 --nreqs;
666
667 if (!req_invoke (req))
668 {
669 req_free (req);
670 croak (0);
671 }
672
673 count++;
674
675 req_free (req);
676
677 if (maxreqs && !--maxreqs)
678 break;
679
680 if (max_poll_time)
681 {
682 gettimeofday (&tv_now, 0);
683
684 if (tvdiff (&tv_start, &tv_now) >= max_poll_time)
685 break;
686 }
687 }
688
689 if (nreqs <= max_outstanding)
690 break;
691
692 poll_wait ();
693
694 ++maxreqs;
695 }
696
697 return count;
698 }
699
700 /*****************************************************************************/
701
702 X_THREAD_PROC (bdb_proc)
703 {
704 bdb_req req;
705 struct timespec ts;
706 worker *self = (worker *)thr_arg;
707
708 /* try to distribute timeouts somewhat evenly */
709 ts.tv_nsec = ((unsigned long)self & 1023UL) * (1000000000UL / 1024UL);
710
711 for (;;)
712 {
713 ts.tv_sec = time (0) + IDLE_TIMEOUT;
714
715 X_LOCK (reqlock);
716
717 for (;;)
718 {
719 self->req = req = reqq_shift (&req_queue);
720
721 if (req)
722 break;
723
724 ++idle;
725
726 if (X_COND_TIMEDWAIT (reqwait, reqlock, ts)
727 == ETIMEDOUT)
728 {
729 if (idle > max_idle)
730 {
731 --idle;
732 X_UNLOCK (reqlock);
733 X_LOCK (wrklock);
734 --started;
735 X_UNLOCK (wrklock);
736 goto quit;
737 }
738
739 /* we are allowed to idle, so do so without any timeout */
740 X_COND_WAIT (reqwait, reqlock);
741 ts.tv_sec = time (0) + IDLE_TIMEOUT;
742 }
743
744 --idle;
745 }
746
747 --nready;
748
749 X_UNLOCK (reqlock);
750
751 switch (req->type)
752 {
753 case REQ_QUIT:
754 req->result = ENOSYS;
755 goto quit;
756
757 case REQ_ENV_OPEN:
758 req->result = req->env->open (req->env, req->buf1, req->uint1, req->int1);
759 break;
760
761 case REQ_ENV_CLOSE:
762 req->result = req->env->close (req->env, req->uint1);
763 break;
764
765 case REQ_ENV_TXN_CHECKPOINT:
766 req->result = req->env->txn_checkpoint (req->env, req->uint1, req->int1, req->uint2);
767 break;
768
769 case REQ_ENV_LOCK_DETECT:
770 req->result = req->env->lock_detect (req->env, req->uint1, req->uint2, &req->int1);
771 break;
772
773 case REQ_ENV_MEMP_SYNC:
774 req->result = req->env->memp_sync (req->env, 0);
775 break;
776
777 case REQ_ENV_MEMP_TRICKLE:
778 req->result = req->env->memp_trickle (req->env, req->int1, &req->int2);
779 break;
780
781 case REQ_ENV_DBREMOVE:
782 req->result = req->env->dbremove (req->env, req->txn, req->buf1, req->buf2, req->uint1);
783 break;
784
785 case REQ_ENV_DBRENAME:
786 req->result = req->env->dbrename (req->env, req->txn, req->buf1, req->buf2, req->buf3, req->uint1);
787 break;
788
789 case REQ_DB_OPEN:
790 req->result = req->db->open (req->db, req->txn, req->buf1, req->buf2, req->int1, req->uint1, req->int2);
791 break;
792
793 case REQ_DB_CLOSE:
794 req->result = req->db->close (req->db, req->uint1);
795 break;
796
797 case REQ_DB_COMPACT:
798 req->result = req->db->compact (req->db, req->txn, &req->dbt1, &req->dbt2, 0, req->uint1, 0);
799 break;
800
801 case REQ_DB_SYNC:
802 req->result = req->db->sync (req->db, req->uint1);
803 break;
804
805 case REQ_DB_UPGRADE:
806 req->result = req->db->upgrade (req->db, req->buf1, req->uint1);
807 break;
808
809 case REQ_DB_PUT:
810 req->result = req->db->put (req->db, req->txn, &req->dbt1, &req->dbt2, req->uint1);
811 break;
812
813 case REQ_DB_GET:
814 req->result = req->db->get (req->db, req->txn, &req->dbt1, &req->dbt3, req->uint1);
815 break;
816
817 case REQ_DB_PGET:
818 req->result = req->db->pget (req->db, req->txn, &req->dbt1, &req->dbt2, &req->dbt3, req->uint1);
819 break;
820
821 case REQ_DB_DEL:
822 req->result = req->db->del (req->db, req->txn, &req->dbt1, req->uint1);
823 break;
824
825 case REQ_DB_KEY_RANGE:
826 req->result = req->db->key_range (req->db, req->txn, &req->dbt1, &req->key_range, req->uint1);
827 break;
828
829 case REQ_TXN_COMMIT:
830 req->result = req->txn->commit (req->txn, req->uint1);
831 break;
832
833 case REQ_TXN_ABORT:
834 req->result = req->txn->abort (req->txn);
835 break;
836
837 case REQ_TXN_FINISH:
838 if (req->txn->flags & TXN_DEADLOCK)
839 {
840 req->result = req->txn->abort (req->txn);
841 if (!req->result)
842 req->result = DB_LOCK_DEADLOCK;
843 }
844 else
845 req->result = req->txn->commit (req->txn, req->uint1);
846 break;
847
848 case REQ_C_CLOSE:
849 req->result = req->dbc->c_close (req->dbc);
850 break;
851
852 case REQ_C_COUNT:
853 {
854 db_recno_t recno;
855 req->result = req->dbc->c_count (req->dbc, &recno, req->uint1);
856 req->uv1 = recno;
857 }
858 break;
859
860 case REQ_C_PUT:
861 req->result = req->dbc->c_put (req->dbc, &req->dbt1, &req->dbt2, req->uint1);
862 break;
863
864 case REQ_C_GET:
865 req->result = req->dbc->c_get (req->dbc, &req->dbt1, &req->dbt3, req->uint1);
866 break;
867
868 case REQ_C_PGET:
869 req->result = req->dbc->c_pget (req->dbc, &req->dbt1, &req->dbt2, &req->dbt3, req->uint1);
870 break;
871
872 case REQ_C_DEL:
873 req->result = req->dbc->c_del (req->dbc, req->uint1);
874 break;
875
876 case REQ_SEQ_OPEN:
877 req->result = req->seq->open (req->seq, req->txn, &req->dbt1, req->uint1);
878 break;
879
880 case REQ_SEQ_CLOSE:
881 req->result = req->seq->close (req->seq, req->uint1);
882 break;
883
884 case REQ_SEQ_GET:
885 req->result = req->seq->get (req->seq, req->txn, req->int1, &req->seq_t, req->uint1);
886 break;
887
888 case REQ_SEQ_REMOVE:
889 req->result = req->seq->remove (req->seq, req->txn, req->uint1);
890 break;
891
892 default:
893 req->result = ENOSYS;
894 break;
895 }
896
897 if (req->txn && (req->result > 0 || req->result == DB_LOCK_NOTGRANTED))
898 req->txn->flags |= TXN_DEADLOCK;
899
900 X_LOCK (reslock);
901
902 ++npending;
903
904 if (!reqq_push (&res_queue, req))
905 /* write a dummy byte to the pipe so fh becomes ready */
906 respipe_write (respipe_osf [1], (const void *)&respipe_osf, 1);
907
908 self->req = 0;
909 worker_clear (self);
910
911 X_UNLOCK (reslock);
912 }
913
914 quit:
915 X_LOCK (wrklock);
916 worker_free (self);
917 X_UNLOCK (wrklock);
918
919 return 0;
920 }
921
922 /*****************************************************************************/
923
924 static void atfork_prepare (void)
925 {
926 X_LOCK (wrklock);
927 X_LOCK (reqlock);
928 X_LOCK (reslock);
929 }
930
931 static void atfork_parent (void)
932 {
933 X_UNLOCK (reslock);
934 X_UNLOCK (reqlock);
935 X_UNLOCK (wrklock);
936 }
937
938 static void atfork_child (void)
939 {
940 bdb_req prv;
941
942 while (prv = reqq_shift (&req_queue))
943 req_free (prv);
944
945 while (prv = reqq_shift (&res_queue))
946 req_free (prv);
947
948 while (wrk_first.next != &wrk_first)
949 {
950 worker *wrk = wrk_first.next;
951
952 if (wrk->req)
953 req_free (wrk->req);
954
955 worker_clear (wrk);
956 worker_free (wrk);
957 }
958
959 started = 0;
960 idle = 0;
961 nreqs = 0;
962 nready = 0;
963 npending = 0;
964
965 create_respipe ();
966
967 atfork_parent ();
968 }
969
970 #define dREQ(reqtype) \
971 bdb_req req; \
972 int req_pri = next_pri; \
973 next_pri = DEFAULT_PRI + PRI_BIAS; \
974 \
975 if (callback && SvOK (callback)) \
976 croak ("callback has illegal type or extra arguments"); \
977 \
978 Newz (0, req, 1, bdb_cb); \
979 if (!req) \
980 croak ("out of memory during bdb_req allocation"); \
981 \
982 req->callback = cb ? SvREFCNT_inc (cb) : 0; \
983 req->type = (reqtype); \
984 req->pri = req_pri
985
986 #define REQ_SEND \
987 req_send (req)
988
989 #define SvPTR(var, arg, type, class, nullok) \
990 if (!SvOK (arg)) \
991 { \
992 if (nullok != 1) \
993 croak (# var " must be a " # class " object, not undef"); \
994 \
995 (var) = 0; \
996 } \
997 else if (sv_derived_from ((arg), # class)) \
998 { \
999 IV tmp = SvIV ((SV*) SvRV (arg)); \
1000 (var) = INT2PTR (type, tmp); \
1001 if (!var && nullok != 2) \
1002 croak (# var " is not a valid " # class " object anymore"); \
1003 } \
1004 else \
1005 croak (# var " is not of type " # class);
1006
1007 static void
1008 ptr_nuke (SV *sv)
1009 {
1010 assert (SvROK (sv));
1011 sv_setiv (SvRV (sv), 0);
1012 }
1013
1014 static int
1015 errno_get (pTHX_ SV *sv, MAGIC *mg)
1016 {
1017 if (*mg->mg_ptr == '!') // should always be the case
1018 if (-30999 <= errno && errno <= -30800)
1019 {
1020 sv_setnv (sv, (NV)errno);
1021 sv_setpv (sv, db_strerror (errno));
1022 SvNOK_on (sv); /* what a wonderful hack! */
1023 // ^^^ copied from perl sources
1024 return 0;
1025 }
1026
1027 return PL_vtbl_sv.svt_get (aTHX_ sv, mg);
1028 }
1029
1030 static MGVTBL vtbl_errno;
1031
1032 // this wonderful hack :( patches perl's $! variable to support our errno values
1033 static void
1034 patch_errno (void)
1035 {
1036 SV *sv;
1037 MAGIC *mg;
1038
1039 if (!(sv = get_sv ("!", 1)))
1040 return;
1041
1042 if (!(mg = mg_find (sv, PERL_MAGIC_sv)))
1043 return;
1044
1045 if (mg->mg_virtual != &PL_vtbl_sv)
1046 return;
1047
1048 vtbl_errno = PL_vtbl_sv;
1049 vtbl_errno.svt_get = errno_get;
1050 mg->mg_virtual = &vtbl_errno;
1051 }
1052
1053 #if __GNUC__ >= 4
1054 # define noinline __attribute__ ((noinline))
1055 #else
1056 # define noinline
1057 #endif
1058
1059 static noinline SV *
1060 pop_callback (I32 *ritems, SV *sv)
1061 {
1062 if (SvROK (sv))
1063 {
1064 HV *st;
1065 GV *gvp;
1066 CV *cv;
1067 const char *name;
1068
1069 /* forgive me */
1070 if (SvTYPE (SvRV (sv)) == SVt_PVMG
1071 && (st = SvSTASH (SvRV (sv)))
1072 && (name = HvNAME_get (st))
1073 && (name [0] == 'B' && name [1] == 'D' && name [2] == 'B' && name [3] == ':'))
1074 return 0;
1075
1076 if ((cv = sv_2cv (sv, &st, &gvp, 0)))
1077 {
1078 --*ritems;
1079 return (SV *)cv;
1080 }
1081 }
1082
1083 return 0;
1084 }
1085
1086 #define CALLBACK SV *cb = pop_callback (&items, ST (items - 1));
1087
1088 MODULE = BDB PACKAGE = BDB
1089
1090 PROTOTYPES: ENABLE
1091
1092 BOOT:
1093 {
1094 HV *stash = gv_stashpv ("BDB", 1);
1095
1096 static const struct {
1097 const char *name;
1098 IV iv;
1099 } *civ, const_iv[] = {
1100 #define const_iv(name) { # name, (IV)DB_ ## name },
1101 const_iv (RPCCLIENT)
1102 const_iv (INIT_CDB)
1103 const_iv (INIT_LOCK)
1104 const_iv (INIT_LOG)
1105 const_iv (INIT_MPOOL)
1106 const_iv (INIT_REP)
1107 const_iv (INIT_TXN)
1108 const_iv (RECOVER)
1109 const_iv (INIT_TXN)
1110 const_iv (RECOVER_FATAL)
1111 const_iv (CREATE)
1112 const_iv (RDONLY)
1113 const_iv (USE_ENVIRON)
1114 const_iv (USE_ENVIRON_ROOT)
1115 const_iv (LOCKDOWN)
1116 const_iv (PRIVATE)
1117 const_iv (REGISTER)
1118 const_iv (SYSTEM_MEM)
1119 const_iv (AUTO_COMMIT)
1120 const_iv (CDB_ALLDB)
1121 const_iv (DIRECT_DB)
1122 const_iv (DSYNC_DB)
1123 const_iv (NOLOCKING)
1124 const_iv (NOMMAP)
1125 const_iv (NOPANIC)
1126 const_iv (OVERWRITE)
1127 const_iv (PANIC_ENVIRONMENT)
1128 const_iv (REGION_INIT)
1129 const_iv (TIME_NOTGRANTED)
1130 const_iv (TXN_NOSYNC)
1131 const_iv (TXN_NOT_DURABLE)
1132 const_iv (TXN_WRITE_NOSYNC)
1133 const_iv (WRITECURSOR)
1134 const_iv (YIELDCPU)
1135 const_iv (ENCRYPT_AES)
1136 const_iv (XA_CREATE)
1137 const_iv (BTREE)
1138 const_iv (HASH)
1139 const_iv (QUEUE)
1140 const_iv (RECNO)
1141 const_iv (UNKNOWN)
1142 const_iv (EXCL)
1143 const_iv (READ_COMMITTED)
1144 const_iv (READ_UNCOMMITTED)
1145 const_iv (TRUNCATE)
1146 const_iv (NOSYNC)
1147 const_iv (CHKSUM)
1148 const_iv (ENCRYPT)
1149 const_iv (DUP)
1150 const_iv (DUPSORT)
1151 const_iv (RECNUM)
1152 const_iv (RENUMBER)
1153 const_iv (REVSPLITOFF)
1154 const_iv (INORDER)
1155 const_iv (CONSUME)
1156 const_iv (CONSUME_WAIT)
1157 const_iv (GET_BOTH)
1158 const_iv (GET_BOTH_RANGE)
1159 //const_iv (SET_RECNO)
1160 //const_iv (MULTIPLE)
1161 const_iv (SNAPSHOT)
1162 const_iv (JOIN_ITEM)
1163 const_iv (JOIN_NOSORT)
1164 const_iv (RMW)
1165
1166 const_iv (NOTFOUND)
1167 const_iv (KEYEMPTY)
1168 const_iv (LOCK_DEADLOCK)
1169 const_iv (LOCK_NOTGRANTED)
1170 const_iv (RUNRECOVERY)
1171 const_iv (OLD_VERSION)
1172 const_iv (REP_HANDLE_DEAD)
1173 const_iv (REP_LOCKOUT)
1174 const_iv (SECONDARY_BAD)
1175
1176 const_iv (FREE_SPACE)
1177 const_iv (FREELIST_ONLY)
1178
1179 const_iv (APPEND)
1180 const_iv (NODUPDATA)
1181 const_iv (NOOVERWRITE)
1182
1183 const_iv (TXN_NOWAIT)
1184 const_iv (TXN_SYNC)
1185
1186 const_iv (SET_LOCK_TIMEOUT)
1187 const_iv (SET_TXN_TIMEOUT)
1188
1189 const_iv (FIRST)
1190 const_iv (NEXT)
1191 const_iv (NEXT_DUP)
1192 const_iv (NEXT_NODUP)
1193 const_iv (PREV)
1194 const_iv (PREV_NODUP)
1195 const_iv (SET)
1196 const_iv (SET_RANGE)
1197 const_iv (LAST)
1198 const_iv (BEFORE)
1199 const_iv (AFTER)
1200 const_iv (CURRENT)
1201 const_iv (KEYFIRST)
1202 const_iv (KEYLAST)
1203 const_iv (NODUPDATA)
1204
1205 const_iv (FORCE)
1206
1207 const_iv (LOCK_DEFAULT)
1208 const_iv (LOCK_EXPIRE)
1209 const_iv (LOCK_MAXLOCKS)
1210 const_iv (LOCK_MAXWRITE)
1211 const_iv (LOCK_MINLOCKS)
1212 const_iv (LOCK_MINWRITE)
1213 const_iv (LOCK_OLDEST)
1214 const_iv (LOCK_RANDOM)
1215 const_iv (LOCK_YOUNGEST)
1216
1217 const_iv (SEQ_DEC)
1218 const_iv (SEQ_INC)
1219 const_iv (SEQ_WRAP)
1220
1221 const_iv (BUFFER_SMALL)
1222 const_iv (DONOTINDEX)
1223 const_iv (KEYEMPTY )
1224 const_iv (KEYEXIST )
1225 const_iv (LOCK_DEADLOCK)
1226 const_iv (LOCK_NOTGRANTED)
1227 const_iv (LOG_BUFFER_FULL)
1228 const_iv (NOSERVER)
1229 const_iv (NOSERVER_HOME)
1230 const_iv (NOSERVER_ID)
1231 const_iv (NOTFOUND)
1232 const_iv (PAGE_NOTFOUND)
1233 const_iv (REP_DUPMASTER)
1234 const_iv (REP_HANDLE_DEAD)
1235 const_iv (REP_HOLDELECTION)
1236 const_iv (REP_IGNORE)
1237 const_iv (REP_ISPERM)
1238 const_iv (REP_JOIN_FAILURE)
1239 const_iv (REP_LOCKOUT)
1240 const_iv (REP_NEWMASTER)
1241 const_iv (REP_NEWSITE)
1242 const_iv (REP_NOTPERM)
1243 const_iv (REP_UNAVAIL)
1244 const_iv (RUNRECOVERY)
1245 const_iv (SECONDARY_BAD)
1246 const_iv (VERIFY_BAD)
1247 const_iv (VERSION_MISMATCH)
1248
1249 const_iv (VERB_DEADLOCK)
1250 const_iv (VERB_RECOVERY)
1251 const_iv (VERB_REGISTER)
1252 const_iv (VERB_REPLICATION)
1253 const_iv (VERB_WAITSFOR)
1254
1255 const_iv (VERSION_MAJOR)
1256 const_iv (VERSION_MINOR)
1257 const_iv (VERSION_PATCH)
1258 #if DB_VERSION_MINOR >= 5
1259 const_iv (MULTIVERSION)
1260 const_iv (TXN_SNAPSHOT)
1261 #endif
1262 #if DB_VERSION_MINOR >= 6
1263 const_iv (PREV_DUP)
1264 const_iv (PRIORITY_UNCHANGED)
1265 const_iv (PRIORITY_VERY_LOW)
1266 const_iv (PRIORITY_LOW)
1267 const_iv (PRIORITY_DEFAULT)
1268 const_iv (PRIORITY_HIGH)
1269 const_iv (PRIORITY_VERY_HIGH)
1270 #endif
1271 #if DB_VERSION_MINOR >= 7
1272 const_iv (LOG_DIRECT)
1273 const_iv (LOG_DSYNC)
1274 const_iv (LOG_AUTO_REMOVE)
1275 const_iv (LOG_IN_MEMORY)
1276 const_iv (LOG_ZERO)
1277 #else
1278 const_iv (DIRECT_LOG)
1279 const_iv (DSYNC_LOG)
1280 const_iv (LOG_AUTOREMOVE)
1281 const_iv (LOG_INMEMORY)
1282 #endif
1283 };
1284
1285 for (civ = const_iv + sizeof (const_iv) / sizeof (const_iv [0]); civ-- > const_iv; )
1286 newCONSTSUB (stash, (char *)civ->name, newSViv (civ->iv));
1287
1288 {
1289 /* we currently only allow version, minor-version and patchlevel to go up to 255 */
1290 char vstring[3] = { DB_VERSION_MAJOR, DB_VERSION_MINOR, DB_VERSION_PATCH };
1291
1292 newCONSTSUB (stash, "VERSION_v", newSVpvn (vstring, 3));
1293 }
1294
1295 newCONSTSUB (stash, "VERSION_STRING", newSVpv (DB_VERSION_STRING, 0));
1296
1297 create_respipe ();
1298
1299 X_THREAD_ATFORK (atfork_prepare, atfork_parent, atfork_child);
1300 patch_errno ();
1301 }
1302
1303 void
1304 max_poll_reqs (int nreqs)
1305 PROTOTYPE: $
1306 CODE:
1307 max_poll_reqs = nreqs;
1308
1309 void
1310 max_poll_time (double nseconds)
1311 PROTOTYPE: $
1312 CODE:
1313 max_poll_time = nseconds * AIO_TICKS;
1314
1315 void
1316 min_parallel (int nthreads)
1317 PROTOTYPE: $
1318
1319 void
1320 max_parallel (int nthreads)
1321 PROTOTYPE: $
1322
1323 void
1324 max_idle (int nthreads)
1325 PROTOTYPE: $
1326 CODE:
1327 set_max_idle (nthreads);
1328
1329 int
1330 max_outstanding (int maxreqs)
1331 PROTOTYPE: $
1332 CODE:
1333 RETVAL = max_outstanding;
1334 max_outstanding = maxreqs;
1335 OUTPUT:
1336 RETVAL
1337
1338 int
1339 dbreq_pri (int pri = 0)
1340 PROTOTYPE: ;$
1341 CODE:
1342 RETVAL = next_pri - PRI_BIAS;
1343 if (items > 0)
1344 {
1345 if (pri < PRI_MIN) pri = PRI_MIN;
1346 if (pri > PRI_MAX) pri = PRI_MAX;
1347 next_pri = pri + PRI_BIAS;
1348 }
1349 OUTPUT:
1350 RETVAL
1351
1352 void
1353 dbreq_nice (int nice = 0)
1354 CODE:
1355 nice = next_pri - nice;
1356 if (nice < PRI_MIN) nice = PRI_MIN;
1357 if (nice > PRI_MAX) nice = PRI_MAX;
1358 next_pri = nice + PRI_BIAS;
1359
1360 void
1361 flush ()
1362 PROTOTYPE:
1363 CODE:
1364 while (nreqs)
1365 {
1366 poll_wait ();
1367 poll_cb ();
1368 }
1369
1370 int
1371 poll ()
1372 PROTOTYPE:
1373 CODE:
1374 poll_wait ();
1375 RETVAL = poll_cb ();
1376 OUTPUT:
1377 RETVAL
1378
1379 int
1380 poll_fileno ()
1381 PROTOTYPE:
1382 CODE:
1383 RETVAL = respipe [0];
1384 OUTPUT:
1385 RETVAL
1386
1387 int
1388 poll_cb (...)
1389 PROTOTYPE:
1390 CODE:
1391 RETVAL = poll_cb ();
1392 OUTPUT:
1393 RETVAL
1394
1395 void
1396 poll_wait ()
1397 PROTOTYPE:
1398 CODE:
1399 poll_wait ();
1400
1401 int
1402 nreqs ()
1403 PROTOTYPE:
1404 CODE:
1405 RETVAL = nreqs;
1406 OUTPUT:
1407 RETVAL
1408
1409 int
1410 nready ()
1411 PROTOTYPE:
1412 CODE:
1413 RETVAL = get_nready ();
1414 OUTPUT:
1415 RETVAL
1416
1417 int
1418 npending ()
1419 PROTOTYPE:
1420 CODE:
1421 RETVAL = get_npending ();
1422 OUTPUT:
1423 RETVAL
1424
1425 int
1426 nthreads ()
1427 PROTOTYPE:
1428 CODE:
1429 if (WORDACCESS_UNSAFE) X_LOCK (wrklock);
1430 RETVAL = started;
1431 if (WORDACCESS_UNSAFE) X_UNLOCK (wrklock);
1432 OUTPUT:
1433 RETVAL
1434
1435 void
1436 set_sync_prepare (SV *cb)
1437 PROTOTYPE: &
1438 CODE:
1439 SvREFCNT_dec (prepare_cb);
1440 prepare_cb = newSVsv (cb);
1441
1442 char *
1443 strerror (int errorno = errno)
1444 PROTOTYPE: ;$
1445 CODE:
1446 RETVAL = db_strerror (errorno);
1447 OUTPUT:
1448 RETVAL
1449
1450 void _on_next_submit (SV *cb)
1451 CODE:
1452 SvREFCNT_dec (on_next_submit);
1453 on_next_submit = SvOK (cb) ? newSVsv (cb) : 0;
1454
1455 DB_ENV *
1456 db_env_create (U32 env_flags = 0)
1457 CODE:
1458 {
1459 errno = db_env_create (&RETVAL, env_flags);
1460 if (errno)
1461 croak ("db_env_create: %s", db_strerror (errno));
1462
1463 if (0)
1464 {
1465 RETVAL->set_errcall (RETVAL, debug_errcall);
1466 RETVAL->set_msgcall (RETVAL, debug_msgcall);
1467 }
1468 }
1469 OUTPUT:
1470 RETVAL
1471
1472 void
1473 db_env_open (DB_ENV *env, bdb_filename db_home, U32 open_flags, int mode, SV *callback = 0)
1474 PREINIT:
1475 CALLBACK
1476 CODE:
1477 {
1478 dREQ (REQ_ENV_OPEN);
1479 req->env = env;
1480 req->uint1 = open_flags | DB_THREAD;
1481 req->int1 = mode;
1482 req->buf1 = strdup_ornull (db_home);
1483 REQ_SEND;
1484 }
1485
1486 void
1487 db_env_close (DB_ENV *env, U32 flags = 0, SV *callback = 0)
1488 PREINIT:
1489 CALLBACK
1490 CODE:
1491 {
1492 dREQ (REQ_ENV_CLOSE);
1493 req->env = env;
1494 req->uint1 = flags;
1495 REQ_SEND;
1496 ptr_nuke (ST (0));
1497 }
1498
1499 void
1500 db_env_txn_checkpoint (DB_ENV *env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV *callback = 0)
1501 PREINIT:
1502 CALLBACK
1503 CODE:
1504 {
1505 dREQ (REQ_ENV_TXN_CHECKPOINT);
1506 req->env = env;
1507 req->uint1 = kbyte;
1508 req->int1 = min;
1509 req->uint2 = flags;
1510 REQ_SEND;
1511 }
1512
1513 void
1514 db_env_lock_detect (DB_ENV *env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV *dummy = 0, SV *callback = 0)
1515 PREINIT:
1516 CALLBACK
1517 CODE:
1518 {
1519 dREQ (REQ_ENV_LOCK_DETECT);
1520 req->env = env;
1521 req->uint1 = flags;
1522 req->uint2 = atype;
1523 /* req->int2 = 0; dummy */
1524 REQ_SEND;
1525 }
1526
1527 void
1528 db_env_memp_sync (DB_ENV *env, SV *dummy = 0, SV *callback = 0)
1529 PREINIT:
1530 CALLBACK
1531 CODE:
1532 {
1533 dREQ (REQ_ENV_MEMP_SYNC);
1534 req->env = env;
1535 REQ_SEND;
1536 }
1537
1538 void
1539 db_env_memp_trickle (DB_ENV *env, int percent, SV *dummy = 0, SV *callback = 0)
1540 PREINIT:
1541 CALLBACK
1542 CODE:
1543 {
1544 dREQ (REQ_ENV_MEMP_TRICKLE);
1545 req->env = env;
1546 req->int1 = percent;
1547 REQ_SEND;
1548 }
1549
1550 void
1551 db_env_dbremove (DB_ENV *env, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, U32 flags = 0, SV *callback = 0)
1552 PREINIT:
1553 CALLBACK
1554 CODE:
1555 {
1556 dREQ (REQ_ENV_DBREMOVE);
1557 req->env = env;
1558 req->buf1 = strdup_ornull (file);
1559 req->buf2 = strdup_ornull (database);
1560 req->uint1 = flags;
1561 REQ_SEND;
1562 }
1563
1564 void
1565 db_env_dbrename (DB_ENV *env, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, bdb_filename newname, U32 flags = 0, SV *callback = 0)
1566 PREINIT:
1567 CALLBACK
1568 CODE:
1569 {
1570 dREQ (REQ_ENV_DBRENAME);
1571 req->env = env;
1572 req->buf1 = strdup_ornull (file);
1573 req->buf2 = strdup_ornull (database);
1574 req->buf3 = strdup_ornull (newname);
1575 req->uint1 = flags;
1576 REQ_SEND;
1577 }
1578
1579 DB *
1580 db_create (DB_ENV *env = 0, U32 flags = 0)
1581 CODE:
1582 {
1583 errno = db_create (&RETVAL, env, flags);
1584 if (errno)
1585 croak ("db_create: %s", db_strerror (errno));
1586
1587 if (RETVAL)
1588 RETVAL->app_private = (void *)newSVsv (ST (0));
1589 }
1590 OUTPUT:
1591 RETVAL
1592
1593 void
1594 db_open (DB *db, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, int type, U32 flags, int mode, SV *callback = 0)
1595 PREINIT:
1596 CALLBACK
1597 CODE:
1598 {
1599 dREQ (REQ_DB_OPEN);
1600 req->db = db;
1601 req->txn = txnid;
1602 req->buf1 = strdup_ornull (file);
1603 req->buf2 = strdup_ornull (database);
1604 req->int1 = type;
1605 req->uint1 = flags | DB_THREAD;
1606 req->int2 = mode;
1607 REQ_SEND;
1608 }
1609
1610 void
1611 db_close (DB *db, U32 flags = 0, SV *callback = 0)
1612 PREINIT:
1613 CALLBACK
1614 CODE:
1615 {
1616 dREQ (REQ_DB_CLOSE);
1617 req->db = db;
1618 req->uint1 = flags;
1619 req->sv1 = (SV *)db->app_private;
1620 REQ_SEND;
1621 ptr_nuke (ST (0));
1622 }
1623
1624 void
1625 db_compact (DB *db, DB_TXN_ornull *txn = 0, SV *start = 0, SV *stop = 0, SV *unused1 = 0, U32 flags = DB_FREE_SPACE, SV *unused2 = 0, SV *callback = 0)
1626 PREINIT:
1627 CALLBACK
1628 CODE:
1629 {
1630 dREQ (REQ_DB_COMPACT);
1631 req->db = db;
1632 req->txn = txn;
1633 sv_to_dbt (&req->dbt1, start);
1634 sv_to_dbt (&req->dbt2, stop);
1635 req->uint1 = flags;
1636 REQ_SEND;
1637 }
1638
1639 void
1640 db_sync (DB *db, U32 flags = 0, SV *callback = 0)
1641 PREINIT:
1642 CALLBACK
1643 CODE:
1644 {
1645 dREQ (REQ_DB_SYNC);
1646 req->db = db;
1647 req->uint1 = flags;
1648 REQ_SEND;
1649 }
1650
1651 void
1652 db_upgrade (DB *db, bdb_filename file, U32 flags = 0, SV *callback = 0)
1653 PREINIT:
1654 CALLBACK
1655 CODE:
1656 {
1657 dREQ (REQ_DB_SYNC);
1658 req->db = db;
1659 req->buf1 = strdup (file);
1660 req->uint1 = flags;
1661 REQ_SEND;
1662 }
1663
1664 void
1665 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = 0)
1666 PREINIT:
1667 CALLBACK
1668 CODE:
1669 {
1670 dREQ (REQ_DB_KEY_RANGE);
1671 req->db = db;
1672 req->txn = txn;
1673 sv_to_dbt (&req->dbt1, key);
1674 req->uint1 = flags;
1675 req->sv1 = SvREFCNT_inc (key_range); SvREADONLY_on (key_range);
1676 REQ_SEND;
1677 }
1678
1679 void
1680 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = 0)
1681 PREINIT:
1682 CALLBACK
1683 CODE:
1684 {
1685 dREQ (REQ_DB_PUT);
1686 req->db = db;
1687 req->txn = txn;
1688 sv_to_dbt (&req->dbt1, key);
1689 sv_to_dbt (&req->dbt2, data);
1690 req->uint1 = flags;
1691 REQ_SEND;
1692 }
1693
1694 void
1695 db_get (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = 0)
1696 PREINIT:
1697 CALLBACK
1698 CODE:
1699 if (SvREADONLY (data))
1700 croak ("can't modify read-only data scalar in db_get");
1701 {
1702 dREQ (REQ_DB_GET);
1703 req->db = db;
1704 req->txn = txn;
1705 req->uint1 = flags;
1706 sv_to_dbt (&req->dbt1, key);
1707 req->dbt3.flags = DB_DBT_MALLOC;
1708 req->sv3 = SvREFCNT_inc (data); SvREADONLY_on (data);
1709 REQ_SEND;
1710 }
1711
1712 void
1713 db_pget (DB *db, DB_TXN_ornull *txn, SV *key, SV *pkey, SV *data, U32 flags = 0, SV *callback = 0)
1714 PREINIT:
1715 CALLBACK
1716 CODE:
1717 if (SvREADONLY (data))
1718 croak ("can't modify read-only data scalar in db_pget");
1719 {
1720 dREQ (REQ_DB_PGET);
1721 req->db = db;
1722 req->txn = txn;
1723 req->uint1 = flags;
1724 sv_to_dbt (&req->dbt1, key);
1725 sv_to_dbt (&req->dbt2, pkey);
1726 req->dbt3.flags = DB_DBT_MALLOC;
1727 req->sv3 = SvREFCNT_inc (data); SvREADONLY_on (data);
1728 REQ_SEND;
1729 }
1730
1731 void
1732 db_del (DB *db, DB_TXN_ornull *txn, SV *key, U32 flags = 0, SV *callback = 0)
1733 PREINIT:
1734 CALLBACK
1735 CODE:
1736 {
1737 dREQ (REQ_DB_DEL);
1738 req->db = db;
1739 req->txn = txn;
1740 req->uint1 = flags;
1741 sv_to_dbt (&req->dbt1, key);
1742 REQ_SEND;
1743 }
1744
1745 void
1746 db_txn_commit (DB_TXN *txn, U32 flags = 0, SV *callback = 0)
1747 PREINIT:
1748 CALLBACK
1749 CODE:
1750 {
1751 dREQ (REQ_TXN_COMMIT);
1752 req->txn = txn;
1753 req->uint1 = flags;
1754 REQ_SEND;
1755 ptr_nuke (ST (0));
1756 }
1757
1758 void
1759 db_txn_abort (DB_TXN *txn, SV *callback = 0)
1760 PREINIT:
1761 CALLBACK
1762 CODE:
1763 {
1764 dREQ (REQ_TXN_ABORT);
1765 req->txn = txn;
1766 REQ_SEND;
1767 ptr_nuke (ST (0));
1768 }
1769
1770 void
1771 db_txn_finish (DB_TXN *txn, U32 flags = 0, SV *callback = 0)
1772 PREINIT:
1773 CALLBACK
1774 CODE:
1775 {
1776 dREQ (REQ_TXN_FINISH);
1777 req->txn = txn;
1778 req->uint1 = flags;
1779 REQ_SEND;
1780 ptr_nuke (ST (0));
1781 }
1782
1783 void
1784 db_c_close (DBC *dbc, SV *callback = 0)
1785 PREINIT:
1786 CALLBACK
1787 CODE:
1788 {
1789 dREQ (REQ_C_CLOSE);
1790 req->dbc = dbc;
1791 REQ_SEND;
1792 ptr_nuke (ST (0));
1793 }
1794
1795 void
1796 db_c_count (DBC *dbc, SV *count, U32 flags = 0, SV *callback = 0)
1797 PREINIT:
1798 CALLBACK
1799 CODE:
1800 {
1801 dREQ (REQ_C_COUNT);
1802 req->dbc = dbc;
1803 req->sv1 = SvREFCNT_inc (count);
1804 REQ_SEND;
1805 }
1806
1807 void
1808 db_c_put (DBC *dbc, SV *key, SV *data, U32 flags = 0, SV *callback = 0)
1809 PREINIT:
1810 CALLBACK
1811 CODE:
1812 {
1813 dREQ (REQ_C_PUT);
1814 req->dbc = dbc;
1815 sv_to_dbt (&req->dbt1, key);
1816 sv_to_dbt (&req->dbt2, data);
1817 req->uint1 = flags;
1818 REQ_SEND;
1819 }
1820
1821 void
1822 db_c_get (DBC *dbc, SV *key, SV *data, U32 flags = 0, SV *callback = 0)
1823 PREINIT:
1824 CALLBACK
1825 CODE:
1826 {
1827 dREQ (REQ_C_GET);
1828 req->dbc = dbc;
1829 req->uint1 = flags;
1830 if ((flags & DB_SET) == DB_SET
1831 || (flags & DB_SET_RANGE) == DB_SET_RANGE)
1832 sv_to_dbt (&req->dbt1, key);
1833 else
1834 req->dbt1.flags = DB_DBT_MALLOC;
1835
1836 req->sv1 = SvREFCNT_inc (key); SvREADONLY_on (key);
1837
1838 if ((flags & DB_GET_BOTH) == DB_GET_BOTH
1839 || (flags & DB_GET_BOTH_RANGE) == DB_GET_BOTH_RANGE)
1840 sv_to_dbt (&req->dbt3, data);
1841 else
1842 req->dbt3.flags = DB_DBT_MALLOC;
1843
1844 req->sv3 = SvREFCNT_inc (data); SvREADONLY_on (data);
1845 REQ_SEND;
1846 }
1847
1848 void
1849 db_c_pget (DBC *dbc, SV *key, SV *pkey, SV *data, U32 flags = 0, SV *callback = 0)
1850 PREINIT:
1851 CALLBACK
1852 CODE:
1853 {
1854 dREQ (REQ_C_PGET);
1855 req->dbc = dbc;
1856 req->uint1 = flags;
1857 if ((flags & DB_SET) == DB_SET
1858 || (flags & DB_SET_RANGE) == DB_SET_RANGE)
1859 sv_to_dbt (&req->dbt1, key);
1860 else
1861 req->dbt1.flags = DB_DBT_MALLOC;
1862
1863 req->sv1 = SvREFCNT_inc (key); SvREADONLY_on (key);
1864
1865 req->dbt2.flags = DB_DBT_MALLOC;
1866 req->sv2 = SvREFCNT_inc (pkey); SvREADONLY_on (pkey);
1867
1868 if ((flags & DB_GET_BOTH) == DB_GET_BOTH
1869 || (flags & DB_GET_BOTH_RANGE) == DB_GET_BOTH_RANGE)
1870 sv_to_dbt (&req->dbt3, data);
1871 else
1872 req->dbt3.flags = DB_DBT_MALLOC;
1873
1874 req->sv3 = SvREFCNT_inc (data); SvREADONLY_on (data);
1875 REQ_SEND;
1876 }
1877
1878 void
1879 db_c_del (DBC *dbc, U32 flags = 0, SV *callback = 0)
1880 PREINIT:
1881 CALLBACK
1882 CODE:
1883 {
1884 dREQ (REQ_C_DEL);
1885 req->dbc = dbc;
1886 req->uint1 = flags;
1887 REQ_SEND;
1888 }
1889
1890
1891 void
1892 db_sequence_open (DB_SEQUENCE *seq, DB_TXN_ornull *txnid, SV *key, U32 flags = 0, SV *callback = 0)
1893 PREINIT:
1894 CALLBACK
1895 CODE:
1896 {
1897 dREQ (REQ_SEQ_OPEN);
1898 req->seq = seq;
1899 req->txn = txnid;
1900 req->uint1 = flags | DB_THREAD;
1901 sv_to_dbt (&req->dbt1, key);
1902 REQ_SEND;
1903 }
1904
1905 void
1906 db_sequence_close (DB_SEQUENCE *seq, U32 flags = 0, SV *callback = 0)
1907 PREINIT:
1908 CALLBACK
1909 CODE:
1910 {
1911 dREQ (REQ_SEQ_CLOSE);
1912 req->seq = seq;
1913 req->uint1 = flags;
1914 REQ_SEND;
1915 ptr_nuke (ST (0));
1916 }
1917
1918 void
1919 db_sequence_get (DB_SEQUENCE *seq, DB_TXN_ornull *txnid, int delta, SV *seq_value, U32 flags = DB_TXN_NOSYNC, SV *callback = 0)
1920 PREINIT:
1921 CALLBACK
1922 CODE:
1923 {
1924 dREQ (REQ_SEQ_GET);
1925 req->seq = seq;
1926 req->txn = txnid;
1927 req->int1 = delta;
1928 req->uint1 = flags;
1929 req->sv1 = SvREFCNT_inc (seq_value); SvREADONLY_on (seq_value);
1930 REQ_SEND;
1931 }
1932
1933 void
1934 db_sequence_remove (DB_SEQUENCE *seq, DB_TXN_ornull *txnid = 0, U32 flags = 0, SV *callback = 0)
1935 PREINIT:
1936 CALLBACK
1937 CODE:
1938 {
1939 dREQ (REQ_SEQ_REMOVE);
1940 req->seq = seq;
1941 req->txn = txnid;
1942 req->uint1 = flags;
1943 REQ_SEND;
1944 }
1945
1946
1947 MODULE = BDB PACKAGE = BDB::Env
1948
1949 void
1950 DESTROY (DB_ENV_ornuked *env)
1951 CODE:
1952 if (env)
1953 env->close (env, 0);
1954
1955 int set_data_dir (DB_ENV *env, const char *dir)
1956 CODE:
1957 RETVAL = env->set_data_dir (env, dir);
1958 OUTPUT:
1959 RETVAL
1960
1961 int set_tmp_dir (DB_ENV *env, const char *dir)
1962 CODE:
1963 RETVAL = env->set_tmp_dir (env, dir);
1964 OUTPUT:
1965 RETVAL
1966
1967 int set_lg_dir (DB_ENV *env, const char *dir)
1968 CODE:
1969 RETVAL = env->set_lg_dir (env, dir);
1970 OUTPUT:
1971 RETVAL
1972
1973 int set_shm_key (DB_ENV *env, long shm_key)
1974 CODE:
1975 RETVAL = env->set_shm_key (env, shm_key);
1976 OUTPUT:
1977 RETVAL
1978
1979 int set_cachesize (DB_ENV *env, U32 gbytes, U32 bytes, int ncache = 0)
1980 CODE:
1981 RETVAL = env->set_cachesize (env, gbytes, bytes, ncache);
1982 OUTPUT:
1983 RETVAL
1984
1985 int set_flags (DB_ENV *env, U32 flags, int onoff = 1)
1986 CODE:
1987 RETVAL = env->set_flags (env, flags, onoff);
1988 OUTPUT:
1989 RETVAL
1990
1991 #if DB_VERSION_MINOR >= 7
1992
1993 int set_intermediate_dir_mode (DB_ENV *env, const char *mode)
1994 CODE:
1995 RETVAL = env->set_intermediate_dir_mode (env, mode);
1996 OUTPUT:
1997 RETVAL
1998
1999 int log_set_config (DB_ENV *env, U32 flags, int onoff = 1)
2000 CODE:
2001 RETVAL = env->log_set_config (env, flags, onoff);
2002 OUTPUT:
2003 RETVAL
2004
2005 #endif
2006
2007
2008 void set_errfile (DB_ENV *env, FILE *errfile = 0)
2009 CODE:
2010 env->set_errfile (env, errfile);
2011
2012 void set_msgfile (DB_ENV *env, FILE *msgfile = 0)
2013 CODE:
2014 env->set_msgfile (env, msgfile);
2015
2016 int set_verbose (DB_ENV *env, U32 which = -1, int onoff = 1)
2017 CODE:
2018 RETVAL = env->set_verbose (env, which, onoff);
2019 OUTPUT:
2020 RETVAL
2021
2022 int set_encrypt (DB_ENV *env, const char *password, U32 flags = 0)
2023 CODE:
2024 RETVAL = env->set_encrypt (env, password, flags);
2025 OUTPUT:
2026 RETVAL
2027
2028 int set_timeout (DB_ENV *env, NV timeout, U32 flags = DB_SET_TXN_TIMEOUT)
2029 CODE:
2030 RETVAL = env->set_timeout (env, timeout * 1000000, flags);
2031 OUTPUT:
2032 RETVAL
2033
2034 int set_mp_max_openfd (DB_ENV *env, int maxopenfd);
2035 CODE:
2036 RETVAL = env->set_mp_max_openfd (env, maxopenfd);
2037 OUTPUT:
2038 RETVAL
2039
2040 int set_mp_max_write (DB_ENV *env, int maxwrite, int maxwrite_sleep);
2041 CODE:
2042 RETVAL = env->set_mp_max_write (env, maxwrite, maxwrite_sleep);
2043 OUTPUT:
2044 RETVAL
2045
2046 int set_mp_mmapsize (DB_ENV *env, int mmapsize_mb)
2047 CODE:
2048 RETVAL = env->set_mp_mmapsize (env, ((size_t)mmapsize_mb) << 20);
2049 OUTPUT:
2050 RETVAL
2051
2052 int set_lk_detect (DB_ENV *env, U32 detect = DB_LOCK_DEFAULT)
2053 CODE:
2054 RETVAL = env->set_lk_detect (env, detect);
2055 OUTPUT:
2056 RETVAL
2057
2058 int set_lk_max_lockers (DB_ENV *env, U32 max)
2059 CODE:
2060 RETVAL = env->set_lk_max_lockers (env, max);
2061 OUTPUT:
2062 RETVAL
2063
2064 int set_lk_max_locks (DB_ENV *env, U32 max)
2065 CODE:
2066 RETVAL = env->set_lk_max_locks (env, max);
2067 OUTPUT:
2068 RETVAL
2069
2070 int set_lk_max_objects (DB_ENV *env, U32 max)
2071 CODE:
2072 RETVAL = env->set_lk_max_objects (env, max);
2073 OUTPUT:
2074 RETVAL
2075
2076 int set_lg_bsize (DB_ENV *env, U32 max)
2077 CODE:
2078 RETVAL = env->set_lg_bsize (env, max);
2079 OUTPUT:
2080 RETVAL
2081
2082 int set_lg_max (DB_ENV *env, U32 max)
2083 CODE:
2084 RETVAL = env->set_lg_max (env, max);
2085 OUTPUT:
2086 RETVAL
2087
2088 int mutex_set_max (DB_ENV *env, U32 max)
2089 CODE:
2090 RETVAL = env->mutex_set_max (env, max);
2091 OUTPUT:
2092 RETVAL
2093
2094 int mutex_set_increment (DB_ENV *env, U32 increment)
2095 CODE:
2096 RETVAL = env->mutex_set_increment (env, increment);
2097 OUTPUT:
2098 RETVAL
2099
2100 int mutex_set_tas_spins (DB_ENV *env, U32 tas_spins)
2101 CODE:
2102 RETVAL = env->mutex_set_tas_spins (env, tas_spins);
2103 OUTPUT:
2104 RETVAL
2105
2106 int mutex_set_align (DB_ENV *env, U32 align)
2107 CODE:
2108 RETVAL = env->mutex_set_align (env, align);
2109 OUTPUT:
2110 RETVAL
2111
2112 DB_TXN *
2113 txn_begin (DB_ENV *env, DB_TXN_ornull *parent = 0, U32 flags = 0)
2114 CODE:
2115 errno = env->txn_begin (env, parent, &RETVAL, flags);
2116 if (errno)
2117 croak ("DB_ENV->txn_begin: %s", db_strerror (errno));
2118 OUTPUT:
2119 RETVAL
2120
2121 DB_TXN *
2122 cdsgroup_begin (DB_ENV *env)
2123 CODE:
2124 errno = env->cdsgroup_begin (env, &RETVAL);
2125 if (errno)
2126 croak ("DB_ENV->cdsgroup_begin: %s", db_strerror (errno));
2127 OUTPUT:
2128 RETVAL
2129
2130 MODULE = BDB PACKAGE = BDB::Db
2131
2132 void
2133 DESTROY (DB_ornuked *db)
2134 CODE:
2135 if (db)
2136 {
2137 SV *env = (SV *)db->app_private;
2138 db->close (db, 0);
2139 SvREFCNT_dec (env);
2140 }
2141
2142 int set_cachesize (DB *db, U32 gbytes, U32 bytes, int ncache = 0)
2143 CODE:
2144 RETVAL = db->set_cachesize (db, gbytes, bytes, ncache);
2145 OUTPUT:
2146 RETVAL
2147
2148 int set_flags (DB *db, U32 flags)
2149 CODE:
2150 RETVAL = db->set_flags (db, flags);
2151 OUTPUT:
2152 RETVAL
2153
2154 int set_encrypt (DB *db, const char *password, U32 flags)
2155 CODE:
2156 RETVAL = db->set_encrypt (db, password, flags);
2157 OUTPUT:
2158 RETVAL
2159
2160 int set_lorder (DB *db, int lorder)
2161 CODE:
2162 RETVAL = db->set_lorder (db, lorder);
2163 OUTPUT:
2164 RETVAL
2165
2166 int set_bt_minkey (DB *db, U32 minkey)
2167 CODE:
2168 RETVAL = db->set_bt_minkey (db, minkey);
2169 OUTPUT:
2170 RETVAL
2171
2172 int set_re_delim (DB *db, int delim)
2173 CODE:
2174 RETVAL = db->set_re_delim (db, delim);
2175 OUTPUT:
2176 RETVAL
2177
2178 int set_re_pad (DB *db, int re_pad)
2179 CODE:
2180 RETVAL = db->set_re_pad (db, re_pad);
2181 OUTPUT:
2182 RETVAL
2183
2184 int set_re_source (DB *db, char *source)
2185 CODE:
2186 RETVAL = db->set_re_source (db, source);
2187 OUTPUT:
2188 RETVAL
2189
2190 int set_re_len (DB *db, U32 re_len)
2191 CODE:
2192 RETVAL = db->set_re_len (db, re_len);
2193 OUTPUT:
2194 RETVAL
2195
2196 int set_h_ffactor (DB *db, U32 h_ffactor)
2197 CODE:
2198 RETVAL = db->set_h_ffactor (db, h_ffactor);
2199 OUTPUT:
2200 RETVAL
2201
2202 int set_h_nelem (DB *db, U32 h_nelem)
2203 CODE:
2204 RETVAL = db->set_h_nelem (db, h_nelem);
2205 OUTPUT:
2206 RETVAL
2207
2208 int set_q_extentsize (DB *db, U32 extentsize)
2209 CODE:
2210 RETVAL = db->set_q_extentsize (db, extentsize);
2211 OUTPUT:
2212 RETVAL
2213
2214 DBC *
2215 cursor (DB *db, DB_TXN_ornull *txn = 0, U32 flags = 0)
2216 CODE:
2217 errno = db->cursor (db, txn, &RETVAL, flags);
2218 if (errno)
2219 croak ("DB->cursor: %s", db_strerror (errno));
2220 OUTPUT:
2221 RETVAL
2222
2223 DB_SEQUENCE *
2224 sequence (DB *db, U32 flags = 0)
2225 CODE:
2226 {
2227 errno = db_sequence_create (&RETVAL, db, flags);
2228 if (errno)
2229 croak ("db_sequence_create: %s", db_strerror (errno));
2230 }
2231 OUTPUT:
2232 RETVAL
2233
2234
2235 MODULE = BDB PACKAGE = BDB::Txn
2236
2237 void
2238 DESTROY (DB_TXN_ornuked *txn)
2239 CODE:
2240 if (txn)
2241 txn->abort (txn);
2242
2243 int set_timeout (DB_TXN *txn, NV timeout, U32 flags = DB_SET_TXN_TIMEOUT)
2244 CODE:
2245 RETVAL = txn->set_timeout (txn, timeout * 1000000, flags);
2246 OUTPUT:
2247 RETVAL
2248
2249 int failed (DB_TXN *txn)
2250 CODE:
2251 RETVAL = !!(txn->flags & TXN_DEADLOCK);
2252 OUTPUT:
2253 RETVAL
2254
2255
2256 MODULE = BDB PACKAGE = BDB::Cursor
2257
2258 void
2259 DESTROY (DBC_ornuked *dbc)
2260 CODE:
2261 if (dbc)
2262 dbc->c_close (dbc);
2263
2264 #if DB_VERSION_MINOR >= 6
2265
2266 int set_priority (DBC *dbc, int priority)
2267 CODE:
2268 dbc->set_priority (dbc, priority);
2269
2270 #endif
2271
2272 MODULE = BDB PACKAGE = BDB::Sequence
2273
2274 void
2275 DESTROY (DB_SEQUENCE_ornuked *seq)
2276 CODE:
2277 if (seq)
2278 seq->close (seq, 0);
2279
2280 int initial_value (DB_SEQUENCE *seq, db_seq_t value)
2281 CODE:
2282 RETVAL = seq->initial_value (seq, value);
2283 OUTPUT:
2284 RETVAL
2285
2286 int set_cachesize (DB_SEQUENCE *seq, U32 size)
2287 CODE:
2288 RETVAL = seq->set_cachesize (seq, size);
2289 OUTPUT:
2290 RETVAL
2291
2292 int set_flags (DB_SEQUENCE *seq, U32 flags)
2293 CODE:
2294 RETVAL = seq->set_flags (seq, flags);
2295 OUTPUT:
2296 RETVAL
2297
2298 int set_range (DB_SEQUENCE *seq, db_seq_t min, db_seq_t max)
2299 CODE:
2300 RETVAL = seq->set_range (seq, min, max);
2301 OUTPUT:
2302 RETVAL
2303
2304