2
* See the file LICENSE for redistribution information.
4
* Copyright (c) 1999-2001
5
* Sleepycat Software. All rights reserved.
11
static const char revid[] = "$Id: tcl_lock.c,v 11.27 2001/07/03 19:04:11 krinsky Exp $";
14
#ifndef NO_SYSTEM_INCLUDES
15
#include <sys/types.h>
26
* Prototypes for procedures defined later in this file:
28
static int lock_Cmd __P((ClientData, Tcl_Interp *, int, Tcl_Obj * CONST*));
29
static int _LockMode __P((Tcl_Interp *, Tcl_Obj *, db_lockmode_t *));
30
static int _GetThisLock __P((Tcl_Interp *, DB_ENV *, u_int32_t,
31
u_int32_t, DBT *, db_lockmode_t, char *));
32
static void _LockPutInfo __P((Tcl_Interp *, db_lockop_t, DB_LOCK *,
35
static char *lkmode[] = {
36
"ng", "read", "write",
37
"iwrite", "iread", "iwr",
41
LK_NG, LK_READ, LK_WRITE,
42
LK_IWRITE, LK_IREAD, LK_IWR
48
* PUBLIC: int tcl_LockDetect __P((Tcl_Interp *, int,
49
* PUBLIC: Tcl_Obj * CONST*, DB_ENV *));
52
tcl_LockDetect(interp, objc, objv, envp)
53
Tcl_Interp *interp; /* Interpreter */
54
int objc; /* How many arguments? */
55
Tcl_Obj *CONST objv[]; /* The argument objects */
56
DB_ENV *envp; /* Environment pointer */
58
static char *ldopts[] = {
77
u_int32_t flag, policy;
78
int i, optindex, result, ret;
84
if (Tcl_GetIndexFromObj(interp, objv[i],
85
ldopts, "option", TCL_EXACT, &optindex) != TCL_OK)
86
return (IS_HELP(objv[i]));
88
switch ((enum ldopts)optindex) {
91
policy = DB_LOCK_DEFAULT;
95
policy = DB_LOCK_MAXLOCKS;
99
policy = DB_LOCK_MINWRITE;
103
policy = DB_LOCK_MINLOCKS;
107
policy = DB_LOCK_OLDEST;
111
policy = DB_LOCK_YOUNGEST;
115
policy = DB_LOCK_RANDOM;
121
ret = lock_detect(envp, flag, policy, NULL);
122
result = _ReturnSetup(interp, ret, "lock detect");
129
* PUBLIC: int tcl_LockGet __P((Tcl_Interp *, int,
130
* PUBLIC: Tcl_Obj * CONST*, DB_ENV *));
133
tcl_LockGet(interp, objc, objv, envp)
134
Tcl_Interp *interp; /* Interpreter */
135
int objc; /* How many arguments? */
136
Tcl_Obj *CONST objv[]; /* The argument objects */
137
DB_ENV *envp; /* Environment pointer */
139
static char *lgopts[] = {
149
u_int32_t flag, lockid;
150
int itmp, optindex, result;
151
char newname[MSG_SIZE];
154
memset(newname, 0, MSG_SIZE);
155
if (objc != 5 && objc != 6) {
156
Tcl_WrongNumArgs(interp, 2, objv, "?-nowait? mode id obj");
160
* Work back from required args.
162
* Second last is lock id.
163
* Third last is lock mode.
165
memset(&obj, 0, sizeof(obj));
168
_GetUInt32(interp, objv[objc-2], &lockid)) != TCL_OK)
173
* Tcl 8.1 Tcl_GetByteArrayFromObj/Tcl_GetIntFromObj bug.
175
* The line below was originally before the Tcl_GetIntFromObj.
177
* There is a bug in Tcl 8.1 and byte arrays in that if it happens
178
* to use an object as both a byte array and something else like
179
* an int, and you've done a Tcl_GetByteArrayFromObj, then you
180
* do a Tcl_GetIntFromObj, your memory is deleted.
182
* Workaround is to make sure all Tcl_GetByteArrayFromObj calls
185
obj.data = Tcl_GetByteArrayFromObj(objv[objc-1], &itmp);
187
if ((result = _LockMode(interp, objv[(objc - 3)], &mode)) != TCL_OK)
191
* Any left over arg is the flag.
195
if (Tcl_GetIndexFromObj(interp, objv[(objc - 4)],
196
lgopts, "option", TCL_EXACT, &optindex) != TCL_OK)
197
return (IS_HELP(objv[(objc - 4)]));
198
switch ((enum lgopts)optindex) {
200
flag |= DB_LOCK_NOWAIT;
205
result = _GetThisLock(interp, envp, lockid, flag, &obj, mode, newname);
206
if (result == TCL_OK) {
207
res = Tcl_NewStringObj(newname, strlen(newname));
208
Tcl_SetObjResult(interp, res);
216
* PUBLIC: int tcl_LockStat __P((Tcl_Interp *, int,
217
* PUBLIC: Tcl_Obj * CONST*, DB_ENV *));
220
tcl_LockStat(interp, objc, objv, envp)
221
Tcl_Interp *interp; /* Interpreter */
222
int objc; /* How many arguments? */
223
Tcl_Obj *CONST objv[]; /* The argument objects */
224
DB_ENV *envp; /* Environment pointer */
232
* No args for this. Error if there are some.
235
Tcl_WrongNumArgs(interp, 2, objv, NULL);
239
ret = lock_stat(envp, &sp);
240
result = _ReturnSetup(interp, ret, "lock stat");
241
if (result == TCL_ERROR)
244
* Have our stats, now construct the name value
245
* list pairs and free up the memory.
249
* MAKE_STAT_LIST assumes 'res' and 'error' label.
251
MAKE_STAT_LIST("Region size", sp->st_regsize);
252
MAKE_STAT_LIST("Max locks", sp->st_maxlocks);
253
MAKE_STAT_LIST("Max lockers", sp->st_maxlockers);
254
MAKE_STAT_LIST("Max objects", sp->st_maxobjects);
255
MAKE_STAT_LIST("Lock modes", sp->st_nmodes);
256
MAKE_STAT_LIST("Current number of locks", sp->st_nlocks);
257
MAKE_STAT_LIST("Maximum number of locks so far", sp->st_maxnlocks);
258
MAKE_STAT_LIST("Current number of lockers", sp->st_nlockers);
259
MAKE_STAT_LIST("Maximum number of lockers so far", sp->st_maxnlockers);
260
MAKE_STAT_LIST("Current number of objects", sp->st_nobjects);
261
MAKE_STAT_LIST("Maximum number of objects so far", sp->st_maxnobjects);
262
MAKE_STAT_LIST("Number of conflicts", sp->st_nconflicts);
263
MAKE_STAT_LIST("Lock requests", sp->st_nrequests);
264
MAKE_STAT_LIST("Lock releases", sp->st_nreleases);
265
MAKE_STAT_LIST("Deadlocks detected", sp->st_ndeadlocks);
266
MAKE_STAT_LIST("Number of region lock waits", sp->st_region_wait);
267
MAKE_STAT_LIST("Number of region lock nowaits", sp->st_region_nowait);
268
Tcl_SetObjResult(interp, res);
270
__os_free(envp, sp, sizeof(*sp));
276
* Implements the "lock" widget.
279
lock_Cmd(clientData, interp, objc, objv)
280
ClientData clientData; /* Lock handle */
281
Tcl_Interp *interp; /* Interpreter */
282
int objc; /* How many arguments? */
283
Tcl_Obj *CONST objv[]; /* The argument objects */
285
static char *lkcmds[] = {
295
int cmdindex, result, ret;
297
Tcl_ResetResult(interp);
298
lock = (DB_LOCK *)clientData;
299
lkip = _PtrToInfo((void *)lock);
303
Tcl_SetResult(interp, "NULL lock", TCL_STATIC);
307
Tcl_SetResult(interp, "NULL lock info pointer", TCL_STATIC);
311
env = NAME_TO_ENV(lkip->i_parent->i_name);
313
* No args for this. Error if there are some.
316
Tcl_WrongNumArgs(interp, 2, objv, NULL);
320
* Get the command name index from the object based on the dbcmds
323
if (Tcl_GetIndexFromObj(interp,
324
objv[1], lkcmds, "command", TCL_EXACT, &cmdindex) != TCL_OK)
325
return (IS_HELP(objv[1]));
327
switch ((enum lkcmds)cmdindex) {
330
ret = lock_put(env, lock);
331
result = _ReturnSetup(interp, ret, "lock put");
332
(void)Tcl_DeleteCommand(interp, lkip->i_name);
334
__os_free(env, lock, sizeof(DB_LOCK));
343
* PUBLIC: int tcl_LockVec __P((Tcl_Interp *, int, Tcl_Obj * CONST*, DB_ENV *));
346
tcl_LockVec(interp, objc, objv, envp)
347
Tcl_Interp *interp; /* Interpreter */
348
int objc; /* How many arguments? */
349
Tcl_Obj *CONST objv[]; /* The argument objects */
350
DB_ENV *envp; /* environment pointer */
352
static char *lvopts[] = {
359
static char *lkops[] = {
360
"get", "put", "put_all", "put_obj",
364
LKGET, LKPUT, LKPUTALL, LKPUTOBJ
369
Tcl_Obj **myobjv, *res, *thisop;
370
u_int32_t flag, lockid;
371
int i, itmp, myobjc, optindex, result, ret;
372
char *lockname, msg[MSG_SIZE], newname[MSG_SIZE];
375
memset(newname, 0, MSG_SIZE);
379
* If -nowait is given, it MUST be first arg.
381
if (Tcl_GetIndexFromObj(interp, objv[2],
382
lvopts, "option", TCL_EXACT, &optindex) == TCL_OK) {
383
switch ((enum lvopts)optindex) {
385
flag |= DB_LOCK_NOWAIT;
390
if (IS_HELP(objv[2]) == TCL_OK)
392
Tcl_ResetResult(interp);
397
* Our next arg MUST be the locker ID.
399
result = _GetUInt32(interp, objv[i++], &lockid);
400
if (result != TCL_OK)
404
* All other remaining args are operation tuples.
405
* Go through sequentially to decode, execute and build
406
* up list of return values.
408
res = Tcl_NewListObj(0, NULL);
411
* Get the list of the tuple.
414
result = Tcl_ListObjGetElements(interp, objv[i],
416
if (result == TCL_OK)
421
* First we will set up the list of requests.
422
* We will make a "second pass" after we get back
423
* the results from the lock_vec call to create
426
if (Tcl_GetIndexFromObj(interp, myobjv[0],
427
lkops, "option", TCL_EXACT, &optindex) != TCL_OK) {
428
result = IS_HELP(myobjv[0]);
431
switch ((enum lkops)optindex) {
434
Tcl_WrongNumArgs(interp, 1, myobjv,
439
result = _LockMode(interp, myobjv[2], &list.mode);
440
if (result != TCL_OK)
444
* Tcl 8.1 Tcl_GetByteArrayFromObj/Tcl_GetIntFromObj
447
* There is a bug in Tcl 8.1 and byte arrays in that if
448
* it happens to use an object as both a byte array and
449
* something else like an int, and you've done a
450
* Tcl_GetByteArrayFromObj, then you do a
451
* Tcl_GetIntFromObj, your memory is deleted.
453
* Workaround is to make sure all
454
* Tcl_GetByteArrayFromObj calls are done last.
456
obj.data = Tcl_GetByteArrayFromObj(myobjv[1], &itmp);
458
ret = _GetThisLock(interp, envp, lockid, flag,
459
&obj, list.mode, newname);
461
result = _ReturnSetup(interp, ret, "lock vec");
462
thisop = Tcl_NewIntObj(ret);
463
(void)Tcl_ListObjAppendElement(interp, res,
467
thisop = Tcl_NewStringObj(newname, strlen(newname));
468
(void)Tcl_ListObjAppendElement(interp, res, thisop);
472
Tcl_WrongNumArgs(interp, 1, myobjv,
477
list.op = DB_LOCK_PUT;
478
lockname = Tcl_GetStringFromObj(myobjv[1], NULL);
479
lock = NAME_TO_LOCK(lockname);
481
snprintf(msg, MSG_SIZE, "Invalid lock: %s\n",
483
Tcl_SetResult(interp, msg, TCL_VOLATILE);
491
Tcl_WrongNumArgs(interp, 1, myobjv,
496
list.op = DB_LOCK_PUT_ALL;
500
Tcl_WrongNumArgs(interp, 1, myobjv,
505
list.op = DB_LOCK_PUT_OBJ;
506
obj.data = Tcl_GetByteArrayFromObj(myobjv[1], &itmp);
512
* We get here, we have set up our request, now call
516
ret = lock_vec(envp, lockid, flag, &list, 1, NULL);
518
* Now deal with whether or not the operation succeeded.
519
* Get's were done above, all these are only puts.
521
thisop = Tcl_NewIntObj(ret);
522
result = Tcl_ListObjAppendElement(interp, res, thisop);
523
if (ret != 0 && result == TCL_OK)
524
result = _ReturnSetup(interp, ret, "lock put");
526
* We did a put of some kind. Since we did that,
527
* we have to delete the commands associated with
528
* any of the locks we just put.
530
_LockPutInfo(interp, list.op, lock, lockid, &obj);
533
if (result == TCL_OK && res)
534
Tcl_SetObjResult(interp, res);
540
_LockMode(interp, obj, mode)
547
if (Tcl_GetIndexFromObj(interp, obj, lkmode, "option",
548
TCL_EXACT, &optindex) != TCL_OK)
549
return (IS_HELP(obj));
550
switch ((enum lkmode)optindex) {
555
*mode = DB_LOCK_READ;
558
*mode = DB_LOCK_WRITE;
561
*mode = DB_LOCK_IREAD;
564
*mode = DB_LOCK_IWRITE;
574
_LockPutInfo(interp, op, lock, lockid, objp)
581
DBTCL_INFO *p, *nextp;
584
for (p = LIST_FIRST(&__db_infohead); p != NULL; p = nextp) {
586
nextp = LIST_NEXT(p, entries);
587
if ((op == DB_LOCK_PUT && (p->i_lock == lock)) ||
588
(op == DB_LOCK_PUT_ALL && p->i_locker == lockid) ||
589
(op == DB_LOCK_PUT_OBJ && p->i_lockobj.data &&
590
memcmp(p->i_lockobj.data, objp->data, objp->size) == 0))
593
(void)Tcl_DeleteCommand(interp, p->i_name);
594
__os_free(NULL, p->i_lock, sizeof(DB_LOCK));
601
_GetThisLock(interp, envp, lockid, flag, objp, mode, newname)
602
Tcl_Interp *interp; /* Interpreter */
603
DB_ENV *envp; /* Env handle */
604
u_int32_t lockid; /* Locker ID */
605
u_int32_t flag; /* Lock flag */
606
DBT *objp; /* Object to lock */
607
db_lockmode_t mode; /* Lock mode */
608
char *newname; /* New command name */
611
DBTCL_INFO *envip, *ip;
615
envip = _PtrToInfo((void *)envp);
617
Tcl_SetResult(interp, "Could not find env info\n", TCL_STATIC);
620
snprintf(newname, MSG_SIZE, "%s.lock%d",
621
envip->i_name, envip->i_envlockid);
622
ip = _NewInfo(interp, NULL, newname, I_LOCK);
624
Tcl_SetResult(interp, "Could not set up info",
628
ret = __os_malloc(envp, sizeof(DB_LOCK), &lock);
630
Tcl_SetResult(interp, db_strerror(ret), TCL_STATIC);
634
ret = lock_get(envp, lockid, flag, objp, mode, lock);
635
result = _ReturnSetup(interp, ret, "lock get");
636
if (result == TCL_ERROR) {
637
__os_free(envp, lock, sizeof(DB_LOCK));
642
* Success. Set up return. Set up new info
643
* and command widget for this lock.
645
ret = __os_malloc(envp, objp->size, &ip->i_lockobj.data);
647
Tcl_SetResult(interp, "Could not duplicate obj",
649
(void)lock_put(envp, lock);
650
__os_free(envp, lock, sizeof(DB_LOCK));
655
memcpy(ip->i_lockobj.data, objp->data, objp->size);
656
ip->i_lockobj.size = objp->size;
657
envip->i_envlockid++;
658
ip->i_parent = envip;
659
ip->i_locker = lockid;
660
_SetInfoData(ip, lock);
661
Tcl_CreateObjCommand(interp, newname,
662
(Tcl_ObjCmdProc *)lock_Cmd, (ClientData)lock, NULL);