Merge lp:~epics-core/epics-base/array-opt into lp:~epics-core/epics-base/3.15

[mdavidsaver]

Allow device support code to safely replace BPTR for waveform, aai, and aao recordtypes. This avoids a copy when moving array data into and out of a record.

[lp:~epics-core/epics-base/array-opt]

12400. By mdavidsaver on 2013-04-02

Don't need void* cast

Implicit case from void** to void*
is allowed.

12401. By mdavidsaver on 2013-04-02

update release notes

[Andrew Johnson (anj)]

Looks good, merging...

review: Approve

=== modified file 'documentation/RELEASE_NOTES.html'
--- documentation/RELEASE_NOTES.html	2013-03-15 20:23:55 +0000
+++ documentation/RELEASE_NOTES.html	2013-04-02 21:10:26 +0000
@@ -15,6 +15,7 @@
 <h2 align="center">Changes between 3.15.0.1 and 3.15.0.2</h2>
 <!-- Insert new items immediately below here ... -->
 
+<<<<<<< TREE
 <h3>Spin-locks API added</h3>
 
 <p>The new header file epicsSpin.h adds a portable spin-locks API which is
@@ -34,6 +35,24 @@
 hostnames that begin with one or more digits. The epicsSockResolveTest program
 was added to check this functionality.</p>
 
+=======
+<h3>Array field memory mangement</h3>
+
+<p>This allows array data to be moved, without copying, into and out of the
+value (aka BPTR) field of the waveform, aai, and aao types.</p>
+
+<p>Making use of this feature involves replacing the pointer stored in the BPTR
+field with another (user allocated) pointer. The basic rules are:</p>
+
+<ol>
+    <li>BPTR, and the memory it is currently pointing to, can only be accessed
+      while the record is locked.</li>
+    <li>NELM may not be changed.</li>
+    <li>BPTR must always point to a piece of memory large enough to accommodate
+      the maximum number of elements (as given by the NELM field).</li>
+</ol>
+
+>>>>>>> MERGE-SOURCE
 <h3>mbboDirect and mbbiDirect records</h3>
 
 <p>These record types have undergone some significant rework, and will behave

=== modified file 'src/ioc/db/dbAccess.c'
--- src/ioc/db/dbAccess.c	2012-10-29 06:20:56 +0000
+++ src/ioc/db/dbAccess.c	2013-04-02 21:10:26 +0000
@@ -780,6 +780,7 @@
     void *pbuffer, long *options, long *nRequest, void *pflin)
 {
     char *pbuf = pbuffer;
+    void *pfieldsave;
     db_field_log *pfl = (db_field_log *)pflin;
     short field_type;
     long no_elements;
@@ -815,6 +816,13 @@
         return S_db_badDbrtype;
     }
 
+    /* For array field, the rset function
+     * get_array_info() is allowed to modify
+     * paddr->pfield.  So we store the original
+     * value and restore it later.
+     */
+    pfieldsave = paddr->pfield;
+
     /* check for array */
     if ((!pfl || pfl->type == dbfl_type_rec) &&
         paddr->special == SPC_DBADDR &&
@@ -860,7 +868,8 @@
             sprintf(message, "dbGet: Missing conversion for [%d][%d]\n",
                     field_type, dbrType);
             recGblDbaddrError(S_db_badDbrtype, paddr, message);
-            return S_db_badDbrtype;
+            status = S_db_badDbrtype;
+            goto done;
         }
         /* convert database field  and place it in the buffer */
         if (n <= 0) {
@@ -880,6 +889,8 @@
             status = convert(&localAddr, pbuf, n, no_elements, offset);
         }
     }
+done:
+    paddr->pfield = pfieldsave;
     return status;
 }
 

=== modified file 'src/std/filters/arr.c'
--- src/std/filters/arr.c	2012-07-17 19:33:31 +0000
+++ src/std/filters/arr.c	2013-04-02 21:10:26 +0000
@@ -104,7 +104,9 @@
         if (chan->addr.special == SPC_DBADDR &&
             nSource > 1 &&
             (prset = dbGetRset(&chan->addr)) &&
-            prset->get_array_info) {
+            prset->get_array_info)
+        {
+            void *pfieldsave = chan->addr.pfield;
             prec = dbChannelRecord(chan);
             dbScanLock(prec);
             prset->get_array_info(&chan->addr, &nSource, &offset);
@@ -126,6 +128,7 @@
                 pfl->u.r.field = pdst;
             }
             dbScanUnlock(prec);
+            chan->addr.pfield = pfieldsave;
         }
 
     /* Extract from buffer */

=== modified file 'src/std/rec/aaiRecord.c'
--- src/std/rec/aaiRecord.c	2012-01-21 21:20:11 +0000
+++ src/std/rec/aaiRecord.c	2013-04-02 21:10:26 +0000
@@ -183,7 +183,6 @@
 {
     aaiRecord *prec = (aaiRecord *)paddr->precord;
 
-    paddr->pfield         = prec->bptr;
     paddr->no_elements    = prec->nelm;
     paddr->field_type     = prec->ftvl;
     paddr->field_size     = dbValueSize(prec->ftvl);
@@ -195,6 +194,7 @@
 {
     aaiRecord *prec = (aaiRecord *)paddr->precord;
 
+    paddr->pfield = prec->bptr;
     *no_elements =  prec->nord;
     *offset = 0;
     return 0;
@@ -308,7 +308,7 @@
     }
 
     if (monitor_mask)
-        db_post_events(prec, prec->bptr, monitor_mask);
+        db_post_events(prec, &prec->val, monitor_mask);
 }
 
 static long readValue(aaiRecord *prec)

=== modified file 'src/std/rec/aaoRecord.c'
--- src/std/rec/aaoRecord.c	2012-01-21 21:20:11 +0000
+++ src/std/rec/aaoRecord.c	2013-04-02 21:10:26 +0000
@@ -183,7 +183,6 @@
 {
     aaoRecord *prec = (aaoRecord *)paddr->precord;
 
-    paddr->pfield         = prec->bptr;
     paddr->no_elements    = prec->nelm;
     paddr->field_type     = prec->ftvl;
     paddr->field_size     = dbValueSize(prec->ftvl);
@@ -195,6 +194,7 @@
 {
     aaoRecord *prec = (aaoRecord *)paddr->precord;
 
+    paddr->pfield = prec->bptr;
     *no_elements =  prec->nord;
     *offset = 0;
     return 0;
@@ -308,7 +308,7 @@
     }
 
     if (monitor_mask)
-        db_post_events(prec, prec->bptr, monitor_mask);
+        db_post_events(prec, &prec->val, monitor_mask);
 }
 
 static long writeValue(aaoRecord *prec)

=== modified file 'src/std/rec/waveformRecord.c'
--- src/std/rec/waveformRecord.c	2012-07-07 20:54:31 +0000
+++ src/std/rec/waveformRecord.c	2013-04-02 21:10:26 +0000
@@ -163,7 +163,6 @@
 {
     waveformRecord *prec = (waveformRecord *) paddr->precord;
 
-    paddr->pfield = prec->bptr;
     paddr->no_elements = prec->nelm;
     paddr->field_type = prec->ftvl;
     paddr->field_size = dbValueSize(prec->ftvl);
@@ -176,6 +175,7 @@
 {
     waveformRecord *prec = (waveformRecord *) paddr->precord;
 
+    paddr->pfield = prec->bptr;
     *no_elements = prec->nord;
     *offset = 0;
 
@@ -300,7 +300,7 @@
     }
 
     if (monitor_mask) {
-        db_post_events(prec, prec->bptr, monitor_mask);
+        db_post_events(prec, &prec->val, monitor_mask);
     }
 }