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(
75 if (argv2[argn] != NULL) {
81 static void getopt_squieeze(
85 int i, null_i = 0, argc_tmp = *argc;
87 for (i = 0; i < argc_tmp; i++) {
88 if (argv2[i] == NULL) {
91 argv2[null_i++] = argv2[i];
98 /* Thread-safe version */
99 static int Rrd_Create(
100 ClientData clientData,
103 CONST84 char *argv[])
107 char *parsetime_error = NULL;
108 time_t last_up = time(NULL) - 10;
110 unsigned long int pdp_step = 300;
111 struct rrd_time_value last_up_tv;
113 argv2 = getopt_init(argc, argv);
115 for (argv_i = 1; argv_i < argc; argv_i++) {
116 if (!strcmp(argv2[argv_i], "--start") || !strcmp(argv2[argv_i], "-b")) {
117 if (argv_i++ >= argc) {
118 Tcl_AppendResult(interp, "RRD Error: option '",
119 argv2[argv_i - 1], "' needs an argument",
121 getopt_cleanup(argc, argv2);
124 if ((parsetime_error = parsetime(argv2[argv_i], &last_up_tv))) {
125 Tcl_AppendResult(interp, "RRD Error: invalid time format: '",
126 argv2[argv_i], "'", (char *) NULL);
127 getopt_cleanup(argc, argv2);
130 if (last_up_tv.type == RELATIVE_TO_END_TIME ||
131 last_up_tv.type == RELATIVE_TO_START_TIME) {
132 Tcl_AppendResult(interp,
133 "RRD Error: specifying time relative to the 'start' ",
134 "or 'end' makes no sense here",
136 getopt_cleanup(argc, argv2);
139 last_up = mktime(&last_up_tv.tm) +last_up_tv.offset;
140 if (last_up < 3600 * 24 * 365 * 10) {
141 Tcl_AppendResult(interp,
142 "RRD Error: the first entry to the RRD should be after 1980",
144 getopt_cleanup(argc, argv2);
147 getopt_free_element(argv2, argv_i - 1);
148 getopt_free_element(argv2, argv_i);
149 } else if (!strcmp(argv2[argv_i], "--step")
150 || !strcmp(argv2[argv_i], "-s")) {
151 if (argv_i++ >= argc) {
152 Tcl_AppendResult(interp, "RRD Error: option '",
153 argv2[argv_i - 1], "' needs an argument",
155 getopt_cleanup(argc, argv2);
158 long_tmp = atol(argv2[argv_i]);
160 Tcl_AppendResult(interp,
161 "RRD Error: step size should be no less than one second",
163 getopt_cleanup(argc, argv2);
167 getopt_free_element(argv2, argv_i - 1);
168 getopt_free_element(argv2, argv_i);
169 } else if (!strcmp(argv2[argv_i], "--")) {
170 getopt_free_element(argv2, argv_i);
172 } else if (argv2[argv_i][0] == '-') {
173 Tcl_AppendResult(interp, "RRD Error: unknown option '",
174 argv2[argv_i], "'", (char *) NULL);
175 getopt_cleanup(argc, argv2);
180 getopt_squieeze(&argc, argv2);
183 Tcl_AppendResult(interp, "RRD Error: needs rrd filename",
185 getopt_cleanup(argc, argv2);
189 rrd_create_r(argv2[1], pdp_step, last_up, argc - 2, argv2 + 2);
191 getopt_cleanup(argc, argv2);
193 if (rrd_test_error()) {
194 Tcl_AppendResult(interp, "RRD Error: ",
195 rrd_get_error(), (char *) NULL);
205 /* Thread-safe version */
207 ClientData clientData,
210 CONST84 char *argv[])
213 Tcl_AppendResult(interp, "RRD Error: needs rrd filename",
218 rrd_dump_r(argv[1], NULL);
220 /* NOTE: rrd_dump() writes to stdout. No interaction with TCL. */
222 if (rrd_test_error()) {
223 Tcl_AppendResult(interp, "RRD Error: ",
224 rrd_get_error(), (char *) NULL);
234 /* Thread-safe version */
236 ClientData clientData,
239 CONST84 char *argv[])
244 Tcl_AppendResult(interp, "RRD Error: needs rrd filename",
249 t = rrd_last_r(argv[1]);
251 if (rrd_test_error()) {
252 Tcl_AppendResult(interp, "RRD Error: ",
253 rrd_get_error(), (char *) NULL);
258 Tcl_SetIntObj(Tcl_GetObjResult(interp), t);
265 /* Thread-safe version */
266 static int Rrd_Update(
267 ClientData clientData,
270 CONST84 char *argv[])
273 char **argv2, *template = NULL;
275 argv2 = getopt_init(argc, argv);
277 for (argv_i = 1; argv_i < argc; argv_i++) {
278 if (!strcmp(argv2[argv_i], "--template")
279 || !strcmp(argv2[argv_i], "-t")) {
280 if (argv_i++ >= argc) {
281 Tcl_AppendResult(interp, "RRD Error: option '",
282 argv2[argv_i - 1], "' needs an argument",
284 if (template != NULL) {
287 getopt_cleanup(argc, argv2);
290 if (template != NULL) {
293 template = strdup(argv2[argv_i]);
294 getopt_free_element(argv2, argv_i - 1);
295 getopt_free_element(argv2, argv_i);
296 } else if (!strcmp(argv2[argv_i], "--")) {
297 getopt_free_element(argv2, argv_i);
299 } else if (argv2[argv_i][0] == '-') {
300 Tcl_AppendResult(interp, "RRD Error: unknown option '",
301 argv2[argv_i], "'", (char *) NULL);
302 if (template != NULL) {
305 getopt_cleanup(argc, argv2);
310 getopt_squieeze(&argc, argv2);
313 Tcl_AppendResult(interp, "RRD Error: needs rrd filename",
315 if (template != NULL) {
318 getopt_cleanup(argc, argv2);
322 rrd_update_r(argv2[1], template, argc - 2, argv2 + 2);
324 if (template != NULL) {
327 getopt_cleanup(argc, argv2);
329 if (rrd_test_error()) {
330 Tcl_AppendResult(interp, "RRD Error: ",
331 rrd_get_error(), (char *) NULL);
339 static int Rrd_Lastupdate(
340 ClientData clientData,
343 CONST84 char *argv[])
351 unsigned long ds_cnt, i;
353 argv2 = getopt_init(argc, argv);
354 if (rrd_lastupdate(argc - 1, argv2, &last_update,
355 &ds_cnt, &ds_namv, &last_ds) == 0) {
356 listPtr = Tcl_GetObjResult(interp);
357 for (i = 0; i < ds_cnt; i++) {
358 sprintf(s, " %28s", ds_namv[i]);
359 Tcl_ListObjAppendElement(interp, listPtr,
360 Tcl_NewStringObj(s, -1));
361 sprintf(s, "\n\n%10lu:", last_update);
362 Tcl_ListObjAppendElement(interp, listPtr,
363 Tcl_NewStringObj(s, -1));
364 for (i = 0; i < ds_cnt; i++) {
365 sprintf(s, " %s", last_ds[i]);
366 Tcl_ListObjAppendElement(interp, listPtr,
367 Tcl_NewStringObj(s, -1));
372 Tcl_ListObjAppendElement(interp, listPtr,
373 Tcl_NewStringObj(s, -1));
381 static int Rrd_Fetch(
382 ClientData clientData,
385 CONST84 char *argv[])
387 time_t start, end, j;
388 unsigned long step, ds_cnt, i, ii;
389 rrd_value_t *data, *datai;
395 argv2 = getopt_init(argc, argv);
396 if (rrd_fetch(argc, argv2, &start, &end, &step,
397 &ds_cnt, &ds_namv, &data) != -1) {
399 listPtr = Tcl_GetObjResult(interp);
400 for (j = start; j <= end; j += step) {
401 for (ii = 0; ii < ds_cnt; ii++) {
402 sprintf(s, "%.2f", *(datai++));
403 Tcl_ListObjAppendElement(interp, listPtr,
404 Tcl_NewStringObj(s, -1));
407 for (i = 0; i < ds_cnt; i++)
412 getopt_cleanup(argc, argv2);
414 if (rrd_test_error()) {
415 Tcl_AppendResult(interp, "RRD Error: ",
416 rrd_get_error(), (char *) NULL);
426 static int Rrd_Graph(
427 ClientData clientData,
430 CONST84 char *argv[])
436 char **calcpr = NULL;
437 int rc, xsize, ysize;
444 * If the "filename" is a Tcl fileID, then arrange for rrd_graph() to write to
445 * that file descriptor. Will this work with windoze? I have no idea.
447 if ((channel = Tcl_GetChannel(interp, argv[1], &mode)) != NULL) {
449 * It >is< a Tcl fileID
451 if (!(mode & TCL_WRITABLE)) {
452 Tcl_AppendResult(interp, "channel \"", argv[1],
453 "\" wasn't opened for writing", (char *) NULL);
457 * Must flush channel to make sure any buffered data is written before
458 * rrd_graph() writes to the stream
460 if (Tcl_Flush(channel) != TCL_OK) {
461 Tcl_AppendResult(interp, "flush failed for \"", argv[1], "\": ",
462 strerror(Tcl_GetErrno()), (char *) NULL);
465 if (Tcl_GetChannelHandle(channel, TCL_WRITABLE, &fd1) != TCL_OK) {
466 Tcl_AppendResult(interp,
467 "cannot get file descriptor associated with \"",
468 argv[1], "\"", (char *) NULL);
472 * Must dup() file descriptor so we can fclose(stream), otherwise the fclose()
473 * would close Tcl's file descriptor
475 if ((fd2 = dup((int) fd1)) == -1) {
476 Tcl_AppendResult(interp,
477 "dup() failed for file descriptor associated with \"",
478 argv[1], "\": ", strerror(errno), (char *) NULL);
482 * rrd_graph() wants a FILE*
484 if ((stream = fdopen(fd2, "wb")) == NULL) {
485 Tcl_AppendResult(interp,
486 "fdopen() failed for file descriptor associated with \"",
487 argv[1], "\": ", strerror(errno), (char *) NULL);
488 close(fd2); /* plug potential file descriptor leak */
494 argv2 = getopt_init(argc, argv);
497 Tcl_ResetResult(interp); /* clear error from Tcl_GetChannel() */
498 argv2 = getopt_init(argc, argv);
501 rc = rrd_graph(argc, argv2, &calcpr, &xsize, &ysize, stream, &ymin,
503 getopt_cleanup(argc, argv2);
506 fclose(stream); /* plug potential malloc & file descriptor leak */
509 sprintf(dimensions, "%d %d", xsize, ysize);
510 Tcl_AppendResult(interp, dimensions, (char *) NULL);
515 for (i = 0; calcpr[i]; i++) {
516 printf("%s\n", calcpr[i]);
524 if (rrd_test_error()) {
525 Tcl_AppendResult(interp, "RRD Error: ",
526 rrd_get_error(), (char *) NULL);
537 ClientData clientData,
540 CONST84 char *argv[])
544 argv2 = getopt_init(argc, argv);
545 rrd_tune(argc, argv2);
546 getopt_cleanup(argc, argv2);
548 if (rrd_test_error()) {
549 Tcl_AppendResult(interp, "RRD Error: ",
550 rrd_get_error(), (char *) NULL);
560 static int Rrd_Resize(
561 ClientData clientData,
564 CONST84 char *argv[])
568 argv2 = getopt_init(argc, argv);
569 rrd_resize(argc, argv2);
570 getopt_cleanup(argc, argv2);
572 if (rrd_test_error()) {
573 Tcl_AppendResult(interp, "RRD Error: ",
574 rrd_get_error(), (char *) NULL);
584 static int Rrd_Restore(
585 ClientData clientData,
588 CONST84 char *argv[])
592 argv2 = getopt_init(argc, argv);
593 rrd_restore(argc, argv2);
594 getopt_cleanup(argc, argv2);
596 if (rrd_test_error()) {
597 Tcl_AppendResult(interp, "RRD Error: ",
598 rrd_get_error(), (char *) NULL);
609 * The following structure defines the commands in the Rrd extension.
613 char *name; /* Name of the command. */
614 Tcl_CmdProc *proc; /* Procedure for command. */
615 int hide; /* Hide if safe interpreter */
618 static CmdInfo rrdCmds[] = {
619 {"Rrd::create", Rrd_Create, 1}, /* Thread-safe version */
620 {"Rrd::dump", Rrd_Dump, 0}, /* Thread-safe version */
621 {"Rrd::last", Rrd_Last, 0}, /* Thread-safe version */
622 {"Rrd::lastupdate", Rrd_Lastupdate, 0}, /* Thread-safe version */
623 {"Rrd::update", Rrd_Update, 1}, /* Thread-safe version */
624 {"Rrd::fetch", Rrd_Fetch, 0},
625 {"Rrd::graph", Rrd_Graph, 1}, /* Due to RRD's API, a safe
626 interpreter cannot create
627 a graph since it writes to
628 a filename supplied by the
630 {"Rrd::tune", Rrd_Tune, 1},
631 {"Rrd::resize", Rrd_Resize, 1},
632 {"Rrd::restore", Rrd_Restore, 1},
633 {(char *) NULL, (Tcl_CmdProc *) NULL, 0}
645 if (Tcl_InitStubs(interp, TCL_VERSION, 0) == NULL)
648 if (Tcl_PkgRequire(interp, "Tcl", TCL_VERSION, 1) == NULL) {
653 * Why a global array? In keeping with the Rrd:: namespace, why
654 * not simply create a normal variable Rrd::version and set it?
656 Tcl_SetVar2(interp, "rrd", "version", VERSION, TCL_GLOBAL_ONLY);
658 for (cmdInfoPtr = rrdCmds; cmdInfoPtr->name != NULL; cmdInfoPtr++) {
660 * Check if the command already exists and return an error
661 * to ensure we detect name clashes while loading the Rrd
664 if (Tcl_GetCommandInfo(interp, cmdInfoPtr->name, &info)) {
665 Tcl_AppendResult(interp, "command \"", cmdInfoPtr->name,
666 "\" already exists", (char *) NULL);
669 if (safe && cmdInfoPtr->hide) {
672 * Turns out the one cannot hide a command in a namespace
673 * due to a limitation of Tcl, one can only hide global
674 * commands. Thus, if we created the commands without
675 * the Rrd:: namespace in a safe interpreter, then the
676 * "unsafe" commands could be hidden -- which would allow
677 * an owning interpreter either un-hiding them or doing
678 * an "interp invokehidden". If the Rrd:: namespace is
679 * used, then it's still possible for the owning interpreter
680 * to fake out the missing commands:
682 * # Make all Rrd::* commands available in master interperter
683 * package require Rrd
684 * set safe [interp create -safe]
685 * # Make safe Rrd::* commands available in safe interperter
686 * interp invokehidden $safe -global load ./tclrrd1.2.11.so
687 * # Provide the safe interpreter with the missing commands
688 * $safe alias Rrd::update do_update $safe
689 * proc do_update {which_interp $args} {
690 * # Do some checking maybe...
692 * return [eval Rrd::update $args]
695 * Our solution for now is to just not create the "unsafe"
696 * commands in a safe interpreter.
698 if (Tcl_HideCommand(interp, cmdInfoPtr->name, cmdInfoPtr->name) !=
703 Tcl_CreateCommand(interp, cmdInfoPtr->name, cmdInfoPtr->proc,
704 (ClientData) NULL, (Tcl_CmdDeleteProc *) NULL);
707 if (Tcl_PkgProvide(interp, "Rrd", VERSION) != TCL_OK) {
717 return init(interp, 0);
721 * See the comments above and note how few commands are considered "safe"...
722 * Using rrdtool in a safe interpreter has very limited functionality. It's
723 * tempting to just return TCL_ERROR and forget about it.
728 return init(interp, 1);