2 * tclrrd.c -- A TCL interpreter extension to access the RRD library.
4 * Copyright (c) 1999,2000 Frank Strauss, Technical University of Braunschweig.
6 * Thread-safe code copyright (c) 2005 Oleg Derevenetz, CenterTelecom Voronezh ISP.
8 * See the file "COPYING" for information on usage and redistribution
9 * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
22 #include "../../src/rrd_tool.h"
23 #include "../../src/rrd_format.h"
25 /* support pre-8.4 tcl */
31 extern int Tclrrd_Init(
33 extern int Tclrrd_SafeInit(
38 * some rrd_XXX() and new thread-safe versions of Rrd_XXX()
39 * functions might modify the argv strings passed to it.
40 * Hence, we need to do some preparation before
41 * calling the rrd library functions.
43 static char **getopt_init(
50 argv2 = calloc(argc, sizeof(char *));
51 for (i = 0; i < argc; i++) {
52 argv2[i] = strdup(argv[i]);
57 static void getopt_cleanup(
63 for (i = 0; i < argc; i++) {
64 if (argv2[i] != NULL) {
71 static void getopt_free_element(
77 if (argv2[argn] != NULL) {
83 static void getopt_squieeze(
89 int i, null_i = 0, argc_tmp = *argc;
91 for (i = 0; i < argc_tmp; i++) {
92 if (argv2[i] == NULL) {
95 argv2[null_i++] = argv2[i];
102 /* Thread-safe version */
103 static int Rrd_Create(
104 ClientData clientData,
107 CONST84 char *argv[])
111 char *parsetime_error = NULL;
112 time_t last_up = time(NULL) - 10;
114 unsigned long int pdp_step = 300;
115 struct rrd_time_value last_up_tv;
117 argv2 = getopt_init(argc, argv);
119 for (argv_i = 1; argv_i < argc; argv_i++) {
120 if (!strcmp(argv2[argv_i], "--start") || !strcmp(argv2[argv_i], "-b")) {
121 if (argv_i++ >= argc) {
122 Tcl_AppendResult(interp, "RRD Error: option '",
123 argv2[argv_i - 1], "' needs an argument",
125 getopt_cleanup(argc, argv2);
128 if ((parsetime_error = parsetime(argv2[argv_i], &last_up_tv))) {
129 Tcl_AppendResult(interp, "RRD Error: invalid time format: '",
130 argv2[argv_i], "'", (char *) NULL);
131 getopt_cleanup(argc, argv2);
134 if (last_up_tv.type == RELATIVE_TO_END_TIME ||
135 last_up_tv.type == RELATIVE_TO_START_TIME) {
136 Tcl_AppendResult(interp,
137 "RRD Error: specifying time relative to the 'start' ",
138 "or 'end' makes no sense here",
140 getopt_cleanup(argc, argv2);
143 last_up = mktime(&last_up_tv.tm) +last_up_tv.offset;
144 if (last_up < 3600 * 24 * 365 * 10) {
145 Tcl_AppendResult(interp,
146 "RRD Error: the first entry to the RRD should be after 1980",
148 getopt_cleanup(argc, argv2);
151 getopt_free_element(argv2, argv_i - 1);
152 getopt_free_element(argv2, argv_i);
153 } else if (!strcmp(argv2[argv_i], "--step")
154 || !strcmp(argv2[argv_i], "-s")) {
155 if (argv_i++ >= argc) {
156 Tcl_AppendResult(interp, "RRD Error: option '",
157 argv2[argv_i - 1], "' needs an argument",
159 getopt_cleanup(argc, argv2);
162 long_tmp = atol(argv2[argv_i]);
164 Tcl_AppendResult(interp,
165 "RRD Error: step size should be no less than one second",
167 getopt_cleanup(argc, argv2);
171 getopt_free_element(argv2, argv_i - 1);
172 getopt_free_element(argv2, argv_i);
173 } else if (!strcmp(argv2[argv_i], "--")) {
174 getopt_free_element(argv2, argv_i);
176 } else if (argv2[argv_i][0] == '-') {
177 Tcl_AppendResult(interp, "RRD Error: unknown option '",
178 argv2[argv_i], "'", (char *) NULL);
179 getopt_cleanup(argc, argv2);
184 getopt_squieeze(&argc, argv2);
187 Tcl_AppendResult(interp, "RRD Error: needs rrd filename",
189 getopt_cleanup(argc, argv2);
193 rrd_create_r(argv2[1], pdp_step, last_up, argc - 2, argv2 + 2);
195 getopt_cleanup(argc, argv2);
197 if (rrd_test_error()) {
198 Tcl_AppendResult(interp, "RRD Error: ",
199 rrd_get_error(), (char *) NULL);
209 /* Thread-safe version */
211 ClientData clientData,
214 CONST84 char *argv[])
217 Tcl_AppendResult(interp, "RRD Error: needs rrd filename",
222 rrd_dump_r(argv[1], NULL);
224 /* NOTE: rrd_dump() writes to stdout. No interaction with TCL. */
226 if (rrd_test_error()) {
227 Tcl_AppendResult(interp, "RRD Error: ",
228 rrd_get_error(), (char *) NULL);
238 /* Thread-safe version */
240 ClientData clientData,
243 CONST84 char *argv[])
248 Tcl_AppendResult(interp, "RRD Error: needs rrd filename",
253 t = rrd_last_r(argv[1]);
255 if (rrd_test_error()) {
256 Tcl_AppendResult(interp, "RRD Error: ",
257 rrd_get_error(), (char *) NULL);
262 Tcl_SetIntObj(Tcl_GetObjResult(interp), t);
269 /* Thread-safe version */
270 static int Rrd_Update(
271 ClientData clientData,
274 CONST84 char *argv[])
277 char **argv2, *template = NULL;
279 argv2 = getopt_init(argc, argv);
281 for (argv_i = 1; argv_i < argc; argv_i++) {
282 if (!strcmp(argv2[argv_i], "--template")
283 || !strcmp(argv2[argv_i], "-t")) {
284 if (argv_i++ >= argc) {
285 Tcl_AppendResult(interp, "RRD Error: option '",
286 argv2[argv_i - 1], "' needs an argument",
288 if (template != NULL) {
291 getopt_cleanup(argc, argv2);
294 if (template != NULL) {
297 template = strdup(argv2[argv_i]);
298 getopt_free_element(argv2, argv_i - 1);
299 getopt_free_element(argv2, argv_i);
300 } else if (!strcmp(argv2[argv_i], "--")) {
301 getopt_free_element(argv2, argv_i);
303 } else if (argv2[argv_i][0] == '-') {
304 Tcl_AppendResult(interp, "RRD Error: unknown option '",
305 argv2[argv_i], "'", (char *) NULL);
306 if (template != NULL) {
309 getopt_cleanup(argc, argv2);
314 getopt_squieeze(&argc, argv2);
317 Tcl_AppendResult(interp, "RRD Error: needs rrd filename",
319 if (template != NULL) {
322 getopt_cleanup(argc, argv2);
326 rrd_update_r(argv2[1], template, argc - 2, argv2 + 2);
328 if (template != NULL) {
331 getopt_cleanup(argc, argv2);
333 if (rrd_test_error()) {
334 Tcl_AppendResult(interp, "RRD Error: ",
335 rrd_get_error(), (char *) NULL);
343 static int Rrd_Lastupdate(
344 ClientData clientData,
347 CONST84 char *argv[])
355 unsigned long ds_cnt, i;
357 argv2 = getopt_init(argc, argv);
358 if (rrd_lastupdate(argc - 1, argv2, &last_update,
359 &ds_cnt, &ds_namv, &last_ds) == 0) {
360 listPtr = Tcl_GetObjResult(interp);
361 for (i = 0; i < ds_cnt; i++) {
362 sprintf(s, " %28s", ds_namv[i]);
363 Tcl_ListObjAppendElement(interp, listPtr,
364 Tcl_NewStringObj(s, -1));
365 sprintf(s, "\n\n%10lu:", last_update);
366 Tcl_ListObjAppendElement(interp, listPtr,
367 Tcl_NewStringObj(s, -1));
368 for (i = 0; i < ds_cnt; i++) {
369 sprintf(s, " %s", last_ds[i]);
370 Tcl_ListObjAppendElement(interp, listPtr,
371 Tcl_NewStringObj(s, -1));
376 Tcl_ListObjAppendElement(interp, listPtr,
377 Tcl_NewStringObj(s, -1));
385 static int Rrd_Fetch(
386 ClientData clientData,
389 CONST84 char *argv[])
391 time_t start, end, j;
392 unsigned long step, ds_cnt, i, ii;
393 rrd_value_t *data, *datai;
399 argv2 = getopt_init(argc, argv);
400 if (rrd_fetch(argc, argv2, &start, &end, &step,
401 &ds_cnt, &ds_namv, &data) != -1) {
403 listPtr = Tcl_GetObjResult(interp);
404 for (j = start; j <= end; j += step) {
405 for (ii = 0; ii < ds_cnt; ii++) {
406 sprintf(s, "%.2f", *(datai++));
407 Tcl_ListObjAppendElement(interp, listPtr,
408 Tcl_NewStringObj(s, -1));
411 for (i = 0; i < ds_cnt; i++)
416 getopt_cleanup(argc, argv2);
418 if (rrd_test_error()) {
419 Tcl_AppendResult(interp, "RRD Error: ",
420 rrd_get_error(), (char *) NULL);
430 static int Rrd_Graph(
431 ClientData clientData,
434 CONST84 char *argv[])
440 char **calcpr = NULL;
441 int rc, xsize, ysize;
448 * If the "filename" is a Tcl fileID, then arrange for rrd_graph() to write to
449 * that file descriptor. Will this work with windoze? I have no idea.
451 if ((channel = Tcl_GetChannel(interp, argv[1], &mode)) != NULL) {
453 * It >is< a Tcl fileID
455 if (!(mode & TCL_WRITABLE)) {
456 Tcl_AppendResult(interp, "channel \"", argv[1],
457 "\" wasn't opened for writing", (char *) NULL);
461 * Must flush channel to make sure any buffered data is written before
462 * rrd_graph() writes to the stream
464 if (Tcl_Flush(channel) != TCL_OK) {
465 Tcl_AppendResult(interp, "flush failed for \"", argv[1], "\": ",
466 strerror(Tcl_GetErrno()), (char *) NULL);
469 if (Tcl_GetChannelHandle(channel, TCL_WRITABLE, &fd1) != TCL_OK) {
470 Tcl_AppendResult(interp,
471 "cannot get file descriptor associated with \"",
472 argv[1], "\"", (char *) NULL);
476 * Must dup() file descriptor so we can fclose(stream), otherwise the fclose()
477 * would close Tcl's file descriptor
479 if ((fd2 = dup((int) fd1)) == -1) {
480 Tcl_AppendResult(interp,
481 "dup() failed for file descriptor associated with \"",
482 argv[1], "\": ", strerror(errno), (char *) NULL);
486 * rrd_graph() wants a FILE*
488 if ((stream = fdopen(fd2, "wb")) == NULL) {
489 Tcl_AppendResult(interp,
490 "fdopen() failed for file descriptor associated with \"",
491 argv[1], "\": ", strerror(errno), (char *) NULL);
492 close(fd2); /* plug potential file descriptor leak */
498 argv2 = getopt_init(argc, argv);
501 Tcl_ResetResult(interp); /* clear error from Tcl_GetChannel() */
502 argv2 = getopt_init(argc, argv);
505 rc = rrd_graph(argc, argv2, &calcpr, &xsize, &ysize, stream, &ymin,
507 getopt_cleanup(argc, argv2);
510 fclose(stream); /* plug potential malloc & file descriptor leak */
513 sprintf(dimensions, "%d %d", xsize, ysize);
514 Tcl_AppendResult(interp, dimensions, (char *) NULL);
519 for (i = 0; calcpr[i]; i++) {
520 printf("%s\n", calcpr[i]);
528 if (rrd_test_error()) {
529 Tcl_AppendResult(interp, "RRD Error: ",
530 rrd_get_error(), (char *) NULL);
541 ClientData clientData,
544 CONST84 char *argv[])
548 argv2 = getopt_init(argc, argv);
549 rrd_tune(argc, argv2);
550 getopt_cleanup(argc, argv2);
552 if (rrd_test_error()) {
553 Tcl_AppendResult(interp, "RRD Error: ",
554 rrd_get_error(), (char *) NULL);
564 static int Rrd_Resize(
565 ClientData clientData,
568 CONST84 char *argv[])
572 argv2 = getopt_init(argc, argv);
573 rrd_resize(argc, argv2);
574 getopt_cleanup(argc, argv2);
576 if (rrd_test_error()) {
577 Tcl_AppendResult(interp, "RRD Error: ",
578 rrd_get_error(), (char *) NULL);
588 static int Rrd_Restore(
589 ClientData clientData,
592 CONST84 char *argv[])
596 argv2 = getopt_init(argc, argv);
597 rrd_restore(argc, argv2);
598 getopt_cleanup(argc, argv2);
600 if (rrd_test_error()) {
601 Tcl_AppendResult(interp, "RRD Error: ",
602 rrd_get_error(), (char *) NULL);
613 * The following structure defines the commands in the Rrd extension.
617 char *name; /* Name of the command. */
618 Tcl_CmdProc *proc; /* Procedure for command. */
619 int hide; /* Hide if safe interpreter */
622 static CmdInfo rrdCmds[] = {
623 {"Rrd::create", Rrd_Create, 1}, /* Thread-safe version */
624 {"Rrd::dump", Rrd_Dump, 0}, /* Thread-safe version */
625 {"Rrd::last", Rrd_Last, 0}, /* Thread-safe version */
626 {"Rrd::lastupdate", Rrd_Lastupdate, 0}, /* Thread-safe version */
627 {"Rrd::update", Rrd_Update, 1}, /* Thread-safe version */
628 {"Rrd::fetch", Rrd_Fetch, 0},
629 {"Rrd::graph", Rrd_Graph, 1}, /* Due to RRD's API, a safe
630 interpreter cannot create
631 a graph since it writes to
632 a filename supplied by the
634 {"Rrd::tune", Rrd_Tune, 1},
635 {"Rrd::resize", Rrd_Resize, 1},
636 {"Rrd::restore", Rrd_Restore, 1},
637 {(char *) NULL, (Tcl_CmdProc *) NULL, 0}
649 if (Tcl_InitStubs(interp, TCL_VERSION, 0) == NULL)
652 if (Tcl_PkgRequire(interp, "Tcl", TCL_VERSION, 1) == NULL) {
657 * Why a global array? In keeping with the Rrd:: namespace, why
658 * not simply create a normal variable Rrd::version and set it?
660 Tcl_SetVar2(interp, "rrd", "version", VERSION, TCL_GLOBAL_ONLY);
662 for (cmdInfoPtr = rrdCmds; cmdInfoPtr->name != NULL; cmdInfoPtr++) {
664 * Check if the command already exists and return an error
665 * to ensure we detect name clashes while loading the Rrd
668 if (Tcl_GetCommandInfo(interp, cmdInfoPtr->name, &info)) {
669 Tcl_AppendResult(interp, "command \"", cmdInfoPtr->name,
670 "\" already exists", (char *) NULL);
673 if (safe && cmdInfoPtr->hide) {
676 * Turns out the one cannot hide a command in a namespace
677 * due to a limitation of Tcl, one can only hide global
678 * commands. Thus, if we created the commands without
679 * the Rrd:: namespace in a safe interpreter, then the
680 * "unsafe" commands could be hidden -- which would allow
681 * an owning interpreter either un-hiding them or doing
682 * an "interp invokehidden". If the Rrd:: namespace is
683 * used, then it's still possible for the owning interpreter
684 * to fake out the missing commands:
686 * # Make all Rrd::* commands available in master interperter
687 * package require Rrd
688 * set safe [interp create -safe]
689 * # Make safe Rrd::* commands available in safe interperter
690 * interp invokehidden $safe -global load ./tclrrd1.2.11.so
691 * # Provide the safe interpreter with the missing commands
692 * $safe alias Rrd::update do_update $safe
693 * proc do_update {which_interp $args} {
694 * # Do some checking maybe...
696 * return [eval Rrd::update $args]
699 * Our solution for now is to just not create the "unsafe"
700 * commands in a safe interpreter.
702 if (Tcl_HideCommand(interp, cmdInfoPtr->name, cmdInfoPtr->name) !=
707 Tcl_CreateCommand(interp, cmdInfoPtr->name, cmdInfoPtr->proc,
708 (ClientData) NULL, (Tcl_CmdDeleteProc *) NULL);
711 if (Tcl_PkgProvide(interp, "Rrd", VERSION) != TCL_OK) {
721 return init(interp, 0);
725 * See the comments above and note how few commands are considered "safe"...
726 * Using rrdtool in a safe interpreter has very limited functionality. It's
727 * tempting to just return TCL_ERROR and forget about it.
732 return init(interp, 1);