Merge lp:~info-martin-konrad/epics-gateway/putlog into lp:~epics-core/epics-gateway/original-trunk

[Martin Konrad]

Add option to compile in and use caPutLog

[Ralph Lange (ralph-lange)]

To me, this patch looks good.

I have not settled in well enough to have an environment to actually compile and test the code, though, so I would like Benjamin to also have a look and maybe take this for a test drive.

review: Approve (close look at the code, no testing)

[lp:~info-martin-konrad/epics-gateway/putlog]

182. By Martin Konrad on 2014-05-19

Add debug output for CAPUTLOG to Makefile

183. By Martin Konrad on 2014-05-19

Set USR_* instead of USR_*_DEFAULT if CAPUTLOG is defined

This makes sure these settings are added even if USR_*_<os> has
been defined.

[Ben Franksen (bfrk)]

Am Donnerstag, 15. Mai 2014, 07:23:18 schrieb Ralph Lange:
> Review: Approve close look at the code, no testing
>
> To me, this patch looks good.
>
> I have not settled in well enough to have an environment to actually compile
> and test the code, though, so I would like Benjamin to also have a look and
> maybe take this for a test drive.

Sorry for not answering sooner, I was extremely busy with a side project of
mine...

Looking at https://code.launchpad.net/~info-martin-konrad/epics-gateway/putlog/+merge/213921

I have the feeling what the page shows me is not the whole change. For
instance, I am not seeing any caPutLog includes being added. Or maybe I see
only the latest change on the branch and not the whole diff? How can I see
that?

BTW, is there a way to look at differences side-by-side in launchpad?

Sorry for my stupidity w.r.t. lp UI
Ben

________________________________

Helmholtz-Zentrum Berlin für Materialien und Energie GmbH

Mitglied der Hermann von Helmholtz-Gemeinschaft Deutscher Forschungszentren e.V.

Aufsichtsrat: Vorsitzender Prof. Dr. Dr. h.c. mult. Joachim Treusch, stv. Vorsitzende Dr. Beatrix Vierkorn-Rudolph
Geschäftsführung: Prof. Dr. Anke Rita Kaysser-Pyzalla, Thomas Frederking

Sitz Berlin, AG Charlottenburg, 89 HRB 5583

Postadresse:
Hahn-Meitner-Platz 1
D-14109 Berlin

http://www.helmholtz-berlin.de

[Martin Konrad (info-martin-konrad)]

Hi Ben,
> Looking at
> https://code.launchpad.net/~info-martin-konrad/epics-gateway/putlog/+merge/213921
>I have the feeling what the page shows me is not the whole change.
> For instance, I am not seeing any caPutLog includes being added.
Have a look at gateResources.cc lines 36 to 39.

> Or maybe I see only the latest change on the branch and not the whole
> diff? How can I see that?
Nope, there are 3 commits on this branch. One adds the new code and two
fix minor issues (I pushed them an hour ago). The merge view shows the
changes introduced by all three commits.

> Sorry for my stupidity w.r.t. lp UI
Sorry, cannot comment on that. LP is not for me either...

Martin

--
Martin Konrad
Control System Engineer
Facility for Rare Isotope Beams
Michigan State University
640 South Shaw Lane
East Lansing, MI 48824-1321, USA
Tel. [phone]
Email: <email address hidden>

[Ben Franksen (bfrk)]

Am Montag, 19. Mai 2014, 19:21:21 schrieb Martin Konrad:
> > Looking at
> > https://code.launchpad.net/~info-martin-konrad/epics-gateway/putlog/+merge
> > /213921>
> >I have the feeling what the page shows me is not the whole change.
> >
> > For instance, I am not seeing any caPutLog includes being added.
>
> Have a look at gateResources.cc lines 36 to 39.

Oops. Like I said, just stupidity on my side...

> > Or maybe I see only the latest change on the branch and not the whole
> > diff? How can I see that?
>
> Nope, there are 3 commits on this branch. One adds the new code and two
> fix minor issues (I pushed them an hour ago). The merge view shows the
> changes introduced by all three commits.

Thanks, I hoped that was the case.

So. I've taken a close look and it all looks pretty neat and tidy to me and
gets my full approval, as far as I am able to judge (disclaimer: I am not
deeply familiar with the gateway code).

Cheers
Ben
--
Perl: There Is More Than One Way To Do It
Python: There Is One Way To Do It
Haskell: There Is One Way To Do It, Up To Isomorphisµ

________________________________

Helmholtz-Zentrum Berlin für Materialien und Energie GmbH

Mitglied der Hermann von Helmholtz-Gemeinschaft Deutscher Forschungszentren e.V.

Aufsichtsrat: Vorsitzender Prof. Dr. Dr. h.c. mult. Joachim Treusch, stv. Vorsitzende Dr. Beatrix Vierkorn-Rudolph
Geschäftsführung: Prof. Dr. Anke Rita Kaysser-Pyzalla, Thomas Frederking

Sitz Berlin, AG Charlottenburg, 89 HRB 5583

Postadresse:
Hahn-Meitner-Platz 1
D-14109 Berlin

http://www.helmholtz-berlin.de

[Ralph Lange (ralph-lange)]

Finally I was able to compile and run a few tests.
Looks good!

review: Approve

[Martin Konrad (info-martin-konrad)]

> The proposal to merge lp:~info-martin-konrad/epics-gateway/putlog into lp:epics-gateway has been updated.
>
> Status: Approved => Merged
Ralph, are you planning to celebrate this with a new release?

--
Martin Konrad
Control System Engineer
Facility for Rare Isotope Beams
Michigan State University
640 South Shaw Lane
East Lansing, MI 48824-1321, USA
Tel. [phone]
Email: <email address hidden>

=== modified file 'Makefile'
--- Makefile	2009-09-17 15:45:45 +0000
+++ Makefile	2014-05-19 18:31:22 +0000
@@ -144,6 +144,14 @@
 # need access to casCtx.h
 USR_INCLUDES += -I$(EPICS_BASE)/src/cas/generic
 
+# To compile in caPutLog functionality, define the location of the caPutLog
+# module as 'CAPUTLOG' in the appropriate extensions configure/RELEASE* file
+ifdef CAPUTLOG
+  USR_LIBS += caPutLog dbIoc
+  USR_CXXFLAGS += -DWITH_CAPUTLOG
+  USR_CFLAGS += -DWITH_CAPUTLOG
+endif
+
 PROD_HOST = gateway
 
 
@@ -179,6 +187,7 @@
 	@echo ACC_SFLAGS_NO: $(ACC_SFLAGS_NO)
 	@echo SHARED_LIBRARIES: $(SHARED_LIBRARIES)
 	@echo DEBUGCMD: $(DEBUGCMD)
+	@echo CAPUTLOG: $(CAPUTLOG)
 
 # **************************** Emacs Editing Sequences *****************
 # Local Variables:

=== modified file 'gateResources.cc'
--- gateResources.cc	2011-04-05 21:28:22 +0000
+++ gateResources.cc	2014-05-19 18:31:22 +0000
@@ -41,6 +41,12 @@
 #include <gddAppTable.h>
 #include <dbMapper.h>
 
+#ifdef WITH_CAPUTLOG
+  #include <caPutLog.h>
+  #include <caPutLogTask.h>
+  #include <caPutLogAs.h>
+#endif
+
 // Global variables
 gateResources* global_resources;
 
@@ -108,6 +114,159 @@
 	return name;
 }
 
+#ifdef WITH_CAPUTLOG
+/*
+  We need to define these here, as caPutLog is using dbFldTypes.h defs for
+  DBR_xxx and our code is loading db_access.h defs elsewhere, and thse ARE
+  DIFFERENT.
+
+  DBR_FLOAT in db_access.h is 6, for example but in dbFldTypes.h that means a
+  DBR_ULONG.
+*/
+#define OUR_DBR_STRING   0
+#define OUR_DBR_CHAR     1
+#define OUR_DBR_UCHAR    2
+#define OUR_DBR_SHORT    3
+#define OUR_DBR_USHORT   4
+#define OUR_DBR_LONG     5
+#define OUR_DBR_ULONG    6
+#define OUR_DBR_FLOAT    7
+#define OUR_DBR_DOUBLE   8
+
+static int gddGetOurType(const gdd *gddVal)
+{
+  switch ( gddVal->primitiveType() ) {
+    case aitEnumInt8    : return(OUR_DBR_CHAR);
+    case aitEnumUint8   : return(OUR_DBR_UCHAR);
+    case aitEnumInt16   : return(OUR_DBR_SHORT);
+    case aitEnumEnum16  : return(OUR_DBR_USHORT);
+    case aitEnumUint16  : return(OUR_DBR_USHORT);
+    case aitEnumInt32   : return(OUR_DBR_LONG);
+    case aitEnumUint32  : return(OUR_DBR_ULONG);
+    case aitEnumFloat32 : return(OUR_DBR_FLOAT);
+    case aitEnumFloat64 : return(OUR_DBR_DOUBLE);
+    case aitEnumFixedString:
+    case aitEnumString:
+    default:
+      return(OUR_DBR_STRING);
+  }
+}
+
+static int gddToVALUE(const gdd *gddVal, short ourdbrtype, VALUE *valueStruct)
+{
+  memset(valueStruct,0,sizeof(VALUE));
+  switch (ourdbrtype) {
+    case OUR_DBR_CHAR: {
+          aitInt8 x;
+          gddVal->get(x);
+          valueStruct->v_char = x;
+        }
+        return(0);
+
+    case OUR_DBR_UCHAR: {
+          aitUint8 x;
+          gddVal->get(x);
+          valueStruct->v_uchar = x;
+        }
+        return(0);
+
+    case OUR_DBR_SHORT: {
+          aitInt16 x;
+          gddVal->get(x);
+          valueStruct->v_short = x;
+        }
+        return(0);
+
+    case OUR_DBR_USHORT: {
+          aitUint16 x;
+          gddVal->get(x);
+          valueStruct->v_ushort = x;
+        }
+        return(0);
+
+    case OUR_DBR_LONG: {
+          aitInt32 x;
+          gddVal->get(x);
+          valueStruct->v_long = x;
+        }
+        return(0);
+
+    case OUR_DBR_ULONG: {
+          aitUint32 x;
+          gddVal->get(x);
+          valueStruct->v_ulong = x;
+        }
+        return(0);
+
+    case OUR_DBR_FLOAT: {
+          aitFloat32 x;
+          gddVal->get(x);
+          valueStruct->v_float = x;
+        }
+        return(0);
+
+    case OUR_DBR_DOUBLE: {
+          aitFloat64 x;
+          gddVal->get(x);
+          valueStruct->v_double = x;
+        }
+        return(0);
+
+    case OUR_DBR_STRING:
+    default: {
+          aitString x;
+          gddVal->get(x);
+          int len = strlen(x);
+          int siz = sizeof(valueStruct->v_string);
+          if (len >= siz) {
+            strncpy(valueStruct->v_string,x,siz-1);
+            valueStruct->v_string[siz-1] = 0;
+          } else {
+            strcpy(valueStruct->v_string,x);
+          }
+          return(0);
+        }
+  }
+}
+
+static char *debugVALUEString(VALUE *v, int ourdbrtype, char *buffer)
+{
+  switch (ourdbrtype) {
+    case OUR_DBR_CHAR:
+      sprintf(buffer,"v_char %d",v->v_char);
+      break;
+    case OUR_DBR_UCHAR:
+      sprintf(buffer,"v_uchar %d",v->v_uchar);
+      break;
+    case OUR_DBR_SHORT:
+      sprintf(buffer,"v_short %hd",v->v_short);
+      break;
+    case OUR_DBR_USHORT:
+      sprintf(buffer,"v_ushort %hu",v->v_ushort);
+      break;
+    case OUR_DBR_LONG:
+      sprintf(buffer,"v_long %ld",v->v_long);
+      break;
+    case OUR_DBR_ULONG:
+      sprintf(buffer,"v_ulong %lu",v->v_ulong);
+      break;
+    case OUR_DBR_FLOAT:
+      sprintf(buffer,"v_float %g",v->v_float);
+      break;
+    case OUR_DBR_DOUBLE:
+      sprintf(buffer,"v_double %g",v->v_double);
+      break;
+    case OUR_DBR_STRING:
+      sprintf(buffer,"v_string '%s'",v->v_string);
+      break;
+    default:
+      sprintf(buffer,"unknown type %d",ourdbrtype);
+  }
+  return(buffer);
+}
+
+#endif // WITH_CAPUTLOG
+
 gateResources::gateResources(void)
 {
 	as = NULL;
@@ -130,6 +289,9 @@
     
 	// Miscellaneous initializations
 	putlog_file=NULL;
+#ifdef WITH_CAPUTLOG
+    caputlog_address=NULL;
+#endif
 	putlogFp=NULL;
 	report_file=strDup(GATE_REPORT_FILE);
     debug_level=0;
@@ -168,6 +330,10 @@
 	if(command_file) delete [] command_file;
 	if(putlog_file) delete [] putlog_file;
 	if(report_file) delete [] report_file;
+#ifdef WITH_CAPUTLOG
+    caPutLog_Term();
+	if (caputlog_address) delete [] caputlog_address;
+#endif
 }
 
 int gateResources::appValue=0;
@@ -207,6 +373,62 @@
 	return 0;
 }
 
+#ifdef WITH_CAPUTLOG
+int gateResources::setCaPutlogAddress(const char* address)
+{
+	if (caputlog_address) {
+      delete [] caputlog_address;
+    }
+	caputlog_address = strDup(address);
+    return 0;
+}
+
+int gateResources::caPutLog_Init(void)
+{
+  if (caputlog_address) {
+    return caPutLogInit(caputlog_address,caPutLogAll);
+  }
+  return 1;
+}
+
+void gateResources::caPutLog_Term(void)
+{
+  caPutLogTaskStop();
+}
+
+void gateResources::caPutLog_Send
+     (const char *user,
+      const char *host,
+      const char *pvname,
+      const gdd *old_value,
+      const gdd *new_value)
+{
+  if ((! new_value) || (new_value->primitiveType() == aitEnumInvalid)) return;
+
+  // get memory for a LOGDATA item from caPutLog's free list
+  LOGDATA *pdata = caPutLogDataCalloc();
+  if (pdata == NULL) {
+    errlogPrintf("gateResources::caPutLogSend: memory allocation failed\n");
+    return;
+  }
+  strcpy(pdata->userid,user);
+  strcpy(pdata->hostid,host);
+  strcpy(pdata->pv_name,pvname);
+  pdata->pfield = (void *) pvname;
+  pdata->type = gddGetOurType(new_value);
+  gddToVALUE(new_value,pdata->type,&pdata->new_value.value);
+  new_value->getTimeStamp(&pdata->new_value.time);
+  if ((old_value) && (old_value->primitiveType() != aitEnumInvalid) && (gddGetOurType(old_value) == pdata->type)) {
+    gddToVALUE(old_value,pdata->type,&pdata->old_value);
+  } else {
+    // if no usable old_value provided, fill in data.old_value with copy of new value
+    // as there's no way to flag a VALUE struct as invalid
+    memcpy(&pdata->old_value,&pdata->new_value.value,sizeof(VALUE));
+  }
+  caPutLogTaskSend(pdata);
+}
+#endif // WITH_CAPUTLOG
+
 int gateResources::setReportFile(const char* file)
 {
 	if(report_file) delete [] report_file;

=== modified file 'gateResources.h'
--- gateResources.h	2007-07-10 20:08:21 +0000
+++ gateResources.h	2014-05-19 18:31:22 +0000
@@ -49,6 +49,7 @@
 #endif
 
 #include "cadef.h"
+#include "gdd.h"
 
 #include "gateVersion.h"
 
@@ -132,6 +133,19 @@
 	gateAs* getAs(void);
 	bool isAsSetUp(void) const { return as?true:false; }
 
+#ifdef WITH_CAPUTLOG
+	int setCaPutlogAddress(const char* address);
+	const char* caputlogAddress(void) const	{ return caputlog_address?caputlog_address:"NULL"; }
+    int hasCaPutlogAddress(void) const { return caputlog_address?1:0; }
+	int caPutLog_Init(void);
+    void caPutLog_Send(const char *user,
+                       const char *host,
+                       const char *pvname,
+                       const gdd *old_value,
+                       const gdd *new_value);
+	void caPutLog_Term(void);
+#endif
+
 	// here for convenience
 	static int appValue;
 	static int appEnum;
@@ -144,6 +158,9 @@
 
 private:
 	char *access_file, *pvlist_file, *command_file, *putlog_file, *report_file;
+#ifdef WITH_CAPUTLOG
+    char *caputlog_address;
+#endif
 	int debug_level, ro;
 	bool serverMode;
 	bool cacheMode;

=== modified file 'gateStat.cc'
--- gateStat.cc	2005-02-11 22:55:10 +0000
+++ gateStat.cc	2014-05-19 18:31:22 +0000
@@ -92,6 +92,15 @@
 			  pStat && pStat->getName()?pStat->getName():"Unknown");
 			fflush(fp);
 		}
+#ifdef WITH_CAPUTLOG
+        if (global_resources->hasCaPutlogAddress()) {
+          global_resources->caPutLog_Send(asclient->user() ? asclient->user() : "Unknown",
+                                          asclient->host() ? asclient->host() : "Unknown",
+                                          (pStat && pStat->getName()) ? pStat->getName() : "Unknown",
+                                          (pStat) ? pStat->pvData() : NULL,
+                                          &value);
+        }
+#endif
 	}
 	
 	// Call the non-virtual-function write() in the gateStat

=== modified file 'gateStat.h'
--- gateStat.h	2004-06-11 15:29:57 +0000
+++ gateStat.h	2014-05-19 18:31:22 +0000
@@ -78,6 +78,8 @@
 	
 	void report(FILE *fp);
 
+    gdd* pvData(void) const { return value; }
+
 protected:
 	gdd *value;
 	gdd *attr;

=== modified file 'gateVc.cc'
--- gateVc.cc	2009-08-31 19:57:25 +0000
+++ gateVc.cc	2014-05-19 18:31:22 +0000
@@ -244,6 +244,15 @@
 			  vc && vc->getName()?vc->getName():"Unknown");
 			fflush(fp);
 		}
+#ifdef WITH_CAPUTLOG
+        if (global_resources->hasCaPutlogAddress()) {
+          global_resources->caPutLog_Send(user ? user : "Unknown",
+                                          host ? host : "Unknown",
+                                          (vc && vc->getName()) ? vc->getName() : "Unknown",
+                                          (vc) ? vc->eventData() : NULL,
+                                          &value);
+        }
+#endif
 	}
 	
 	// Call the non-virtual-function write() in the gateVcData
@@ -271,6 +280,15 @@
 			  vc && vc->getName()?vc->getName():"Unknown");
 			fflush(fp);
 		}
+#ifdef WITH_CAPUTLOG
+        if (global_resources->hasCaPutlogAddress()) {
+          global_resources->caPutLog_Send(user ? user : "Unknown",
+                                          host ? host : "Unknown",
+                                          (vc && vc->getName()) ? vc->getName() : "Unknown",
+                                          (vc) ? vc->eventData() : NULL,
+                                          &value);
+        }
+#endif
 	}
 	
 	// Call the non-virtual-function write() in the gateVcData

=== modified file 'gateway.cc'
--- gateway.cc	2007-07-10 20:08:21 +0000
+++ gateway.cc	2014-05-19 18:31:22 +0000
@@ -102,6 +102,7 @@
 //	-access file_name = access security file
 //	-command file_name = USR1 command list file
 //	-putlog file_name = putlog file
+//  -caputlog = address (IP:port) for caPutLog server
 //	-report file_name = report file
 //	-home directory = the program's home directory
 //	-connect_timeout number = clear PV connect requests every number seconds
@@ -123,6 +124,7 @@
 //	process variable list file = gateway.pvlist
 //	USR1 command list file = gateway.command
 //	putlog file = gateway.putlog
+//  caputlog address = none, not used
 //	report file = gateway.report
 //	log file = gateway.log
 //	debug level = 0 (none)
@@ -166,7 +168,9 @@
 #define PARM_SERVER_IGNORE_IP 25
 #define PARM_CACHE 			  26
 #define PARM_ARCHIVE		  27
-
+#ifdef WITH_CAPUTLOG
+  #define PARM_CAPUTLOG       28
+#endif
 
 #define HOME_DIR_SIZE    300
 
@@ -184,6 +188,9 @@
 static const char *log_file=NULL;
 static const char *putlog_file=NULL;
 static const char *report_file=NULL;
+#ifdef WITH_CAPUTLOG
+static const char *caputlog_address=NULL;
+#endif
 #ifndef WIN32
 static pid_t parent_pid;
 #endif
@@ -205,6 +212,9 @@
     { "-access",              7, PARM_ACCESS,      "file_name" },
     { "-command",             8, PARM_COMMAND,     "file_name" },
     { "-putlog",              7, PARM_PUTLOG,      "file_name" },
+#ifdef WITH_CAPUTLOG
+    { "-caputlog",            9, PARM_CAPUTLOG,    "address (ip:port)" },
+#endif
     { "-report",              7, PARM_REPORT,      "file_name" },
     { "-home",                5, PARM_HOME,        "directory" },
     { "-sip",                 4, PARM_SERVER_IP,   "IP_address" },
@@ -423,6 +433,9 @@
 	fprintf(fp,"# pvlist file=<%s>\n",global_resources->listFile());
 	fprintf(fp,"# command file=<%s>\n",global_resources->commandFile());
 	fprintf(fp,"# putlog file=<%s>\n",global_resources->putlogFile());
+#ifdef WITH_CAPUTLOG
+	fprintf(fp,"# caputlog address=<%s>\n",global_resources->caputlogAddress());
+#endif
 	fprintf(fp,"# report file=<%s>\n",global_resources->reportFile());
 	fprintf(fp,"# debug level=%d\n",global_resources->debugLevel());
 	fprintf(fp,"# dead timeout=%ld\n",global_resources->deadTimeout());
@@ -622,6 +635,22 @@
 	system("printenv | grep EPICS");
 	fflush(stdout); fflush(stderr);
 #endif
+    // start caPutLog in global_resources, if user defined a caPutLog ip:port address
+#ifdef WITH_CAPUTLOG
+    if (global_resources->hasCaPutlogAddress()) {
+  	  int caputlog_status = global_resources->caPutLog_Init();
+      if (caputlog_status != 0) {
+        fprintf(stderr,"%s global_resources caPutLogInit failed, aborting\n",timeStamp());
+        fflush(stdout);
+        fflush(stderr);
+        if (server) {
+          delete server;
+          server = NULL;
+        }
+        return 1;
+      }
+    }
+#endif
 
 	// Start the gateServer
 	try {
@@ -834,6 +863,18 @@
 						}
 					}
 					break;
+#ifdef WITH_CAPUTLOG
+				case PARM_CAPUTLOG:
+					if(++i>=argc) no_error=0;
+					else {
+						if(argv[i][0]=='-') no_error=0;
+						else {
+							caputlog_address=argv[i];
+							not_done=0;
+						}
+					}
+					break;
+#endif
 				case PARM_REPORT:
 					if(++i>=argc) no_error=0;
 					else {
@@ -1062,6 +1103,9 @@
 		fprintf(stderr,"\tpvlist=%s\n",gr->listFile());
 		fprintf(stderr,"\tcommand=%s\n",gr->commandFile());
 		fprintf(stderr,"\tputlog=%s\n",gr->putlogFile());
+#ifdef WITH_CAPUTLOG
+		fprintf(stderr,"\tcaputlog=%s\n",gr->caputlogAddress());
+#endif
 		fprintf(stderr,"\treport=%s\n",gr->reportFile());
 		fprintf(stderr,"\tdead=%ld\n",gr->deadTimeout());
 		fprintf(stderr,"\tconnect=%ld\n",gr->connectTimeout());
@@ -1113,6 +1157,9 @@
 	if(pvlist_file)			gr->setListFile(pvlist_file);
 	if(command_file)		gr->setCommandFile(command_file);
 	if(putlog_file)	    	gr->setPutlogFile(putlog_file);
+#ifdef WITH_CAPUTLOG
+	if(caputlog_address)  	gr->setCaPutlogAddress(caputlog_address);
+#endif
 	if(report_file)	    	gr->setReportFile(report_file);
 	
 	//set caching and archive mode 
@@ -1263,6 +1310,9 @@
 		fprintf(stderr," list file = <%s>\n",gr->listFile());
 		fprintf(stderr," command file = <%s>\n",gr->commandFile());
 		fprintf(stderr," putlog file = <%s>\n",gr->putlogFile());
+#ifdef WITH_CAPUTLOG
+		fprintf(stderr," caputlog address = <%s>\n",gr->caputlogAddress());
+#endif
 		fprintf(stderr," report file = <%s>\n",gr->reportFile());
 		fprintf(stderr," debug level = %d\n",gr->debugLevel());
 		fprintf(stderr," connect timeout = %ld\n",gr->connectTimeout());