Added tcl support

Author: jayantom

.gitignore

@@ -7,4 +7,7 @@ lib*.so
 *~
 
 #Build directories
-x86_64/lib64
+x86_64/lib64
+
+#Generated header file
+include/sknobs.h

legacy_notes/RELEASE_NOTES

@@ -0,0 +1,61 @@
+0.25
+  - Limit use of "long" data type.
+  - Fix bug, ensuring that seed value is representable in 32 bits
+
+0.24
+  - Use getcwd() instead of $PWD.
+  - Use /dev/urandom instead of time() if it exists for the implicit seed
+    value if no explicit seed is specified.
+
+0.23
+  - Handle '+='.  Now an error.  This is a bit inconsistent with bare '+'
+    handling (a warning).  Consider making both either errors or warnings in 
+    the future.
+  - Move atol() usage to strto*().  Check errno for errors.
+  - Weights are treated as unsigned values.  This avoids the foggy semantics
+    of negative weights.
+  - Seed sources now can supply either signed or unsigned values.  In prior
+    releases, on a 32-bit platform, if a seed value was specified as a "large"
+    32-bit unsigned value (>LONG_MAX) the atol() call was saturating the value
+    to LONG_MAX.  In this release, seed value strings are converted to 64-bit
+    unsigned values, and then the lower 32-bits are used.
+  - All messages now indicate sknobs as the source.
+
+0.22
+  - Handle bare '+' gracefully.  Warn and ignore.
+
+0.21
+  - Fix corruption issue when encountering strings > 8KB.
+
+0.20
+  - In c, add install dependency on libsknobs.so.
+  - Fixed bug in parsing -f args from files if the delimiter flavor is
+    set to "crnl".
+  - Improve clean target in src/python.
+
+0.19
+  - Add new way of tokenizing a string to get knobs.  Search for "token" in
+    doc/README for an explanation.  This feature enables whitespace in knob
+    string values!  Default behavior is backward compatible.
+
+0.18
+  - Default target in src/c/ is now libsknobs.a and libsknobs.so.  To run
+    test, use "test" target.
+  - Better perl install.  Still installs locally: not to site-packages.
+  - Verilog install is just sknobs.sv.  DPI users should point to libsknobs.so.
+  - DPI and VPI tests for Questa (see "testquesta_dpi" and "testquesta_vpi" 
+    targets.  Haven't touched VCS.
+  - VPI sknobs iterate now works on 64-bit platform.  Use vpiHexStrVal to pass
+    iterator pointer (sknobsvpi.c).
+
+0.17
+  - Remove all generated files from tarball.  Still need distclean target to
+  automate this.  
+  - Remove random old versions of sknobs.c and patch output from src/c.
+  - Python test now works without SKNOBS_HOME set.
+  - Tweaks to vcs and questa test targets.  Neither robust.
+  - Enhancements to VPI code from Sankalp.
+
+0.16
+  - Change to src/c/sknobs.c.
+  - Cleaning up error handling.

src/Makefile

@@ -11,8 +11,8 @@ clean:
 	#$(MAKE) -C perl clean
 
 build: 
-	echo $(ARCH)
-	echo $(CURDIR)
+	@echo ARCH=$(ARCH)
+	@echo CURDIR=$(CURDIR)
 	$(MAKE) -C c
 	$(MAKE) -C tcl
 	#$(MAKE) -C python

src/c/Makefile

@@ -1,6 +1,5 @@
 CFLAGS = -fPIC -Wall -Werror
-
-INSTALL_LIB=lib
+INSTALL_LIB=lib64
 
 default: libsknobs.a libsknobs.so
 

src/c/sknobs.c

@@ -1,11 +1,5 @@
 ////////////////////////////////////////////////////////////////////////////
 // C implementation of knobs
-//
-// $Revision: #1 $
-// $Author: jscheid $
-// $Date: 2010/04/28 $
-// $Id: //depot/users/jscheid/src/sknobs/0.25/src/c/sknobs.c#1 $
-//
 ////////////////////////////////////////////////////////////////////////////
 
 #include <stdio.h>

src/tcl/Makefile

@@ -0,0 +1,29 @@
+SWIG = swig
+DEBUG = -g
+CFLAGS = -fPIC -I../c 
+TCL_CFLAGS = -I/usr/include/tcl
+INSTALL_LIB=lib64
+
+default: sknobs.so
+
+# TCL interface built as swig wrapper around C interface
+sknobs_wrap.c: sknobs.i
+	$(SWIG) -I../c -includeall -tcl $<
+
+sknobs_wrap.o: sknobs_wrap.c
+	$(CC) $(CFLAGS) $(TCL_CFLAGS) -c -o $@ $<
+
+sknobs.so: sknobs_wrap.o
+	gcc -shared $(CFLAGS) $^ ../c/libsknobs.a -o $@
+
+install: sknobs.so
+	install -D sknobs.so $(PREFIX)/$(ARCH)/$(INSTALL_LIB}/tcl/sknobs.so
+
+test: sknobs.so
+	./testsknobs +abc=5 +xyz=10
+
+# clean up
+clean:
+	$(RM) *.o *.a *~ *.so
+	$(RM) sknobs_wrap.*
+

src/tcl/README

@@ -0,0 +1,22 @@
+// This tells SWIG to treat char ** as a special case
+%typemap(in) (int argc, char **argv) {
+    Tcl_Obj **listobjv;
+    int       nitems;
+    int       i;
+    if (Tcl_ListObjGetElements(interp, $input, &nitems, &listobjv) == TCL_ERROR) {
+        return TCL_ERROR;
+    }
+    $1 = (char **) malloc((nitems+1)*sizeof(char *));
+    for (i = 0; i < nitems; i++) {
+      $2[i] = Tcl_GetStringFromObj(listobjv[i],0);
+    }
+    $1[i] = 0;
+}
+
+// This gives SWIG some cleanup code that will get called after the function call
+%typemap(freearg) (int argc, char **argv) {
+  if ($2) {
+     free($2);
+  }
+
+}

src/tcl/sknobs.h

@@ -0,0 +1,33 @@
+
+ int sknobs_init(int argc, char **argv);
+ void sknobs_close(void);
+
+ int sknobs_add(char *pattern, char *value, char *comment);
+ int sknobs_load(int argc, char *argv[], char *comment);
+ int sknobs_load_string(char *name, char *buffer, char *comment);
+ int sknobs_load_file(char *filename);
+ int sknobs_load_file_if_exists(char *filename);
+
+ int sknobs_exists(char *name);
+
+typedef void *sknobs_iterator_p;
+ sknobs_iterator_p sknobs_iterate(char *name);
+ int sknobs_iterator_next(sknobs_iterator_p iterator);
+ char *sknobs_iterator_get_string(sknobs_iterator_p iterator);
+
+ char *sknobs_get_string(char *name, char *defaultValue);
+ char *sknobs_find_file(char *filename);
+ char *sknobs_get_filename(char *name, char *defaultValue);
+
+ unsigned long long sknobs_get_value(char *name, unsigned long long defaultValue);
+ unsigned long long sknobs_get_dynamic_value(char *name, unsigned long long defaultValue);
+
+ void sknobs_set_string(char *name, char *value);
+ void sknobs_set_value(char *name, unsigned long long value);
+ void sknobs_set_seed(long value);
+
+ unsigned long long sknobs_eval(char *expr);
+
+ void sknobs_dump(void);
+ void sknobs_save(char *filename);
+

src/tcl/sknobs.i

@@ -0,0 +1,36 @@
+%module sknobs
+
+// This tells SWIG to treat char ** as a special case
+%typemap(in) (int argc, char **argv) {
+    Tcl_Obj **listobjv;
+    int       nitems;
+    int       i;
+    if (Tcl_ListObjLength(interp, $input, &nitems) == TCL_ERROR) {
+	return TCL_ERROR;
+    }
+    if (Tcl_ListObjGetElements(interp, $input, &nitems, &listobjv) == TCL_ERROR) {
+        return TCL_ERROR;
+    }
+    $2 = (char **) malloc((nitems+2)*sizeof(char *));
+    $2[0] = "sknobs";
+    for (i = 0; i < nitems; i++) {
+      $2[i+1] = Tcl_GetStringFromObj(listobjv[i],0);
+    }
+    $2[i+1] = 0;
+    $1 = nitems+1;
+}
+
+// This gives SWIG some cleanup code that will get called after the function call
+%typemap(freearg) (int argc, char **argv) {
+  if ($2) {
+     free($2);
+  }
+
+}
+
+#include "sknobs.h"
+
+%{
+#include "sknobs.h"
+%}
+