EPICSWIKI - User contributions [en]

https://wiki-ext.aps.anl.gov/epics/api.php?action=feedcontributions&feedformat=atom&user=MichaelDavidsaver EPICSWIKI - User contributions [en] 2026-06-04T10:09:28Z User contributions MediaWiki 1.36.1 https://wiki-ext.aps.anl.gov/epics/index.php?title=RSRV_Configuration_Test_Plan&diff=3781 RSRV Configuration Test Plan 2016-02-16T20:44:46Z

<p>MichaelDavidsaver: fix usage of 'ip addr' to set the broadcast address</p> <hr /> <div>= Scope =<br /> <br /> This document describes some of the possible network configurations for RSRV and the expected results<br /> with the RSRV interface binding changes https://code.launchpad.net/~epics-core/epics-base/rsrvbindiface.<br /> <br /> The expected results are given as the output various IOC shell commands (eg. epicsParamShow/casr/dbcar).<br /> <br /> Note that the output of ''dbcar "" 8'' is quite verbose.<br /> Searching for the string ''Search Destination List'' in the output is suggested.<br /> <br /> = Preparation =<br /> <br /> This testing should be done on a computer with more than one physical/virtual network interface in additional to the loopback.<br /> <br /> On Linux additional tun/tap virtual interfaces can easily be added.<br /> In the following examples the addresses ''10.5.1.1'' and ''10.5.2.1'' name two such interfacess.<br /> Additional interfaces may be present.<br /> <br /> Using tunctl/ifconfig<br /> <br /> <pre>tunctl -t tap0<br /> ifconfig tap0 10.5.1.1/24 up<br /> tunctl -t tap1<br /> ifconfig tap1 10.5.2.1/24 up</pre><br /> <br /> or using 'ip'<br /> <br /> <pre>ip tuntap add dev tap0 mode tap<br /> ip addr add 10.5.1.1/24 broadcast 10.5.1.255 dev tap0<br /> ip tuntap add dev tap1 mode tap<br /> ip addr add 10.5.2.1/24 broadcast 10.5.2.255 dev tap1</pre><br /> <br /> These can later be removed<br /> <br /> <pre>tunctl -d tap0<br /> tunctl -d tap1</pre><br /> <br /> or<br /> <br /> <pre>ip tuntap del dev tap0 mode tap<br /> ip tuntap del dev tap1 mode tap</pre><br /> <br /> == Test IOC ==<br /> <br /> In addition to inspecting the output of the iocsh commands,<br /> it is recommended to test a live softIoc.<br /> <br /> <pre>cat << EOF > test.db<br /> record(calc, "test") {<br /> field(SCAN, "1 second")<br /> field(CALC, "VAL+1")<br /> field(FLNK, "invalid")<br /> }<br /> EOF</pre><br /> <br /> Each Test section includes an example invocation of ''softIoc'' and several ''caget''.<br /> <br /> = Tests =<br /> <br /> == Test #1 Defaults ==<br /> <br /> The default configuration is for RSRV is to bind to the wildcard interface (0.0.0.0),<br /> and for libca to search on all local interfaces.<br /> <br /> <pre>./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> A warning "Identical process variable names on multiple servers" should be seen. <br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST is undefined<br /> EPICS_CA_AUTO_ADDR_LIST: YES<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Sending CAS-beacons to 4 addresses:<br /> 10.5.1.255:5065<br /> 10.5.2.255:5065<br /> 127.255.255.255:5065<br /> <local address>:5065<br /> </pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 4 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> == Test #2 Client address list only ==<br /> <br /> Bind the server to the wildcard address.<br /> Client searches only on a sub-set of interfaces.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work on either interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Sending CAS-beacons to 4 addresses:<br /> 10.5.1.255:5065<br /> 10.5.2.255:5065<br /> 127.255.255.255:5065<br /> <local address>:5065<br /> </pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #3 Client and Server on a single interface ==<br /> <br /> RSRV binds to a single interface, and libca only searches on this interface.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> Sending CAS-beacons to 1 address:<br /> 10.5.1.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #4 Client and Server on a multiple interfaces ==<br /> <br /> RSRV binds to two interfaces, and libca only searches on these interfaces.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST="10.5.1.1 10.5.2.1" \<br /> EPICS_CA_ADDR_LIST="10.5.1.255 10.5.2.255" \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 and 10.5.2.255 interfaces, and fail on any others.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1 10.5.2.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> CAS-TCP server on 10.5.2.1:5064 with<br /> CAS-UDP unicast name server on 10.5.2.1:5064<br /> CAS-UDP broadcast name server on 10.5.2.255:5064<br /> Sending CAS-beacons to 2 addresses:<br /> 10.5.1.255:5065<br /> 10.5.2.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 2 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #5 Client and Server on different, single, interfaces ==<br /> <br /> RSRV binds to one interface, and libca only searches on another interface.<br /> This is a "gateway"-like situation.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Additionally, the IOC's CA client will only search on 10.5.2.255.<br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> Sending CAS-beacons to 1 address:<br /> 10.5.1.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #6 IPv4 Multicast for search and beacons ==<br /> <br /> Server bound to wildcard. Searches and beacons only with multicast.<br /> In addtional a multicast address is specified for name search and beacon messages.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client searches using the specified multicast address will succeed.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Searches using other multicast addresses will fail.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.10 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 224.0.2.9<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 224.0.2.9<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Monitoring 1 multicast address:<br /> 224.0.2.9:5064<br /> Sending CAS-beacons to 4 addresses:<br /> 10.5.1.255:5065<br /> 10.5.2.255:5065<br /> 127.255.255.255:5065<br /> <local address>:5065<br /> </pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> ... no destinations for local interfaces<br /> UDP Search destination "224.0.2.9:5064"<br /> ...</pre></div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RSRV_Configuration_Test_Plan&diff=3778 RSRV Configuration Test Plan 2016-01-28T01:45:59Z

<p>MichaelDavidsaver: /* Test #6 IPv4 Multicast for search and beacons */</p> <hr /> <div>= Scope =<br /> <br /> This document describes some of the possible network configurations for RSRV and the expected results<br /> with the RSRV interface binding changes https://code.launchpad.net/~epics-core/epics-base/rsrvbindiface.<br /> <br /> The expected results are given as the output various IOC shell commands (eg. epicsParamShow/casr/dbcar).<br /> <br /> Note that the output of ''dbcar "" 8'' is quite verbose.<br /> Searching for the string ''Search Destination List'' in the output is suggested.<br /> <br /> = Preparation =<br /> <br /> This testing should be done on a computer with more than one physical/virtual network interface in additional to the loopback.<br /> <br /> On Linux additional tun/tap virtual interfaces can easily be added.<br /> In the following examples the addresses ''10.5.1.1'' and ''10.5.2.1'' name two such interfacess.<br /> Additional interfaces may be present.<br /> <br /> <pre>ip tuntap add dev tap0 mode tap<br /> ip addr add 10.5.1.1/24 dev tap0<br /> ip tuntap add dev tap1 mode tap<br /> ip addr add 10.5.2.1/24 dev tap1</pre><br /> <br /> These can later be removed<br /> <br /> <pre>ip tuntap del dev tap0 mode tap<br /> ip tuntap del dev tap1 mode tap</pre><br /> <br /> == Test IOC ==<br /> <br /> In addition to inspecting the output of the iocsh commands,<br /> it is recommended to test a live softIoc.<br /> <br /> <pre>cat << EOF > test.db<br /> record(calc, "test") {<br /> field(SCAN, "1 second")<br /> field(CALC, "VAL+1")<br /> field(FLNK, "invalid")<br /> }<br /> EOF</pre><br /> <br /> Each Test section includes an example invocation of ''softIoc'' and several ''caget''.<br /> <br /> = Tests =<br /> <br /> == Test #1 Defaults ==<br /> <br /> The default configuration is for RSRV is to bind to the wildcard interface (0.0.0.0),<br /> and for libca to search on all local interfaces.<br /> <br /> <pre>./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> A warning "Identical process variable names on multiple servers" should be seen. <br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST is undefined<br /> EPICS_CA_AUTO_ADDR_LIST: YES<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Sending CAS-beacons to 4 addresses:<br /> 10.5.1.255:5065<br /> 10.5.2.255:5065<br /> 127.255.255.255:5065<br /> <local address>:5065<br /> </pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 4 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> == Test #2 Client address list only ==<br /> <br /> Bind the server to the wildcard address.<br /> Client searches only on a sub-set of interfaces.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work on either interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Sending CAS-beacons to 1 address:<br /> 10.5.1.255:5065<br /> </pre><br /> <b style="color:red">ANJ: Is this beacon list right?</b><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #3 Client and Server on a single interface ==<br /> <br /> RSRV binds to a single interface, and libca only searches on this interface.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> Sending CAS-beacons to 1 address:<br /> 10.5.1.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #4 Client and Server on a multiple interfaces ==<br /> <br /> RSRV binds to two interfaces, and libca only searches on these interfaces.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST="10.5.1.1 10.5.2.1" \<br /> EPICS_CA_ADDR_LIST="10.5.1.255 10.5.2.255" \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 and 10.5.2.255 interfaces, and fail on any others.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1 10.5.2.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> CAS-TCP server on 10.5.2.1:5064 with<br /> CAS-UDP unicast name server on 10.5.2.1:5064<br /> CAS-UDP broadcast name server on 10.5.2.255:5064<br /> Sending CAS-beacons to 2 addresses:<br /> 10.5.1.255:5065<br /> 10.5.2.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 2 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #5 Client and Server on different, single, interfaces ==<br /> <br /> RSRV binds to one interface, and libca only searches on another interface.<br /> This is a "gateway"-like situation.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Additionally, the IOC's CA client will only search on 10.5.2.255.<br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> Sending CAS-beacons to 1 address:<br /> 10.5.1.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #6 IPv4 Multicast for search and beacons ==<br /> <br /> Server bound to wildcard. Searches and beacons only with multicast.<br /> In addtional a multicast address is specified for name search and beacon messages.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client searches using the specified multicast address will succeed.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Searches using other multicast addresses will fail.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.10 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 224.0.2.9<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 224.0.2.9<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Monitoring 1 multicast address:<br /> 224.0.2.9:5064<br /> Sending CAS-beacons to 1 address:<br /> 224.0.2.9:5065<br /> </pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> ... no destinations for local interfaces<br /> UDP Search destination "224.0.2.9:5064"<br /> ...</pre></div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RSRV_Configuration_Test_Plan&diff=3777 RSRV Configuration Test Plan 2016-01-28T01:45:44Z

<p>MichaelDavidsaver: /* Test #6 IPv4 Multicast for search and beacons */</p> <hr /> <div>= Scope =<br /> <br /> This document describes some of the possible network configurations for RSRV and the expected results<br /> with the RSRV interface binding changes https://code.launchpad.net/~epics-core/epics-base/rsrvbindiface.<br /> <br /> The expected results are given as the output various IOC shell commands (eg. epicsParamShow/casr/dbcar).<br /> <br /> Note that the output of ''dbcar "" 8'' is quite verbose.<br /> Searching for the string ''Search Destination List'' in the output is suggested.<br /> <br /> = Preparation =<br /> <br /> This testing should be done on a computer with more than one physical/virtual network interface in additional to the loopback.<br /> <br /> On Linux additional tun/tap virtual interfaces can easily be added.<br /> In the following examples the addresses ''10.5.1.1'' and ''10.5.2.1'' name two such interfacess.<br /> Additional interfaces may be present.<br /> <br /> <pre>ip tuntap add dev tap0 mode tap<br /> ip addr add 10.5.1.1/24 dev tap0<br /> ip tuntap add dev tap1 mode tap<br /> ip addr add 10.5.2.1/24 dev tap1</pre><br /> <br /> These can later be removed<br /> <br /> <pre>ip tuntap del dev tap0 mode tap<br /> ip tuntap del dev tap1 mode tap</pre><br /> <br /> == Test IOC ==<br /> <br /> In addition to inspecting the output of the iocsh commands,<br /> it is recommended to test a live softIoc.<br /> <br /> <pre>cat << EOF > test.db<br /> record(calc, "test") {<br /> field(SCAN, "1 second")<br /> field(CALC, "VAL+1")<br /> field(FLNK, "invalid")<br /> }<br /> EOF</pre><br /> <br /> Each Test section includes an example invocation of ''softIoc'' and several ''caget''.<br /> <br /> = Tests =<br /> <br /> == Test #1 Defaults ==<br /> <br /> The default configuration is for RSRV is to bind to the wildcard interface (0.0.0.0),<br /> and for libca to search on all local interfaces.<br /> <br /> <pre>./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> A warning "Identical process variable names on multiple servers" should be seen. <br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST is undefined<br /> EPICS_CA_AUTO_ADDR_LIST: YES<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Sending CAS-beacons to 4 addresses:<br /> 10.5.1.255:5065<br /> 10.5.2.255:5065<br /> 127.255.255.255:5065<br /> <local address>:5065<br /> </pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 4 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> == Test #2 Client address list only ==<br /> <br /> Bind the server to the wildcard address.<br /> Client searches only on a sub-set of interfaces.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work on either interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Sending CAS-beacons to 1 address:<br /> 10.5.1.255:5065<br /> </pre><br /> <b style="color:red">ANJ: Is this beacon list right?</b><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #3 Client and Server on a single interface ==<br /> <br /> RSRV binds to a single interface, and libca only searches on this interface.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> Sending CAS-beacons to 1 address:<br /> 10.5.1.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #4 Client and Server on a multiple interfaces ==<br /> <br /> RSRV binds to two interfaces, and libca only searches on these interfaces.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST="10.5.1.1 10.5.2.1" \<br /> EPICS_CA_ADDR_LIST="10.5.1.255 10.5.2.255" \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 and 10.5.2.255 interfaces, and fail on any others.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1 10.5.2.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> CAS-TCP server on 10.5.2.1:5064 with<br /> CAS-UDP unicast name server on 10.5.2.1:5064<br /> CAS-UDP broadcast name server on 10.5.2.255:5064<br /> Sending CAS-beacons to 2 addresses:<br /> 10.5.1.255:5065<br /> 10.5.2.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 2 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #5 Client and Server on different, single, interfaces ==<br /> <br /> RSRV binds to one interface, and libca only searches on another interface.<br /> This is a "gateway"-like situation.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Additionally, the IOC's CA client will only search on 10.5.2.255.<br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 10.5.1.1:5064 with<br /> CAS-UDP unicast name server on 10.5.1.1:5064<br /> CAS-UDP broadcast name server on 10.5.1.255:5064<br /> Sending CAS-beacons to 1 address:<br /> 10.5.1.255:5065<br /> </pre><br /> <br /> Note that on Windows targets only one CAS-UDP name server address will be listed.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #6 IPv4 Multicast for search and beacons ==<br /> <br /> Server bound to wildcard. Searches and beacons only with multicast.<br /> In addtional a multicast address is specified for name search and beacon messages.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client searches using the specified multicast address will succeed.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Searches not using other multicast addresses will fail.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.10 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 224.0.2.9<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 224.0.2.9<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 1 ===<br /> <br /> <pre>...<br /> CAS-TCP server on 0.0.0.0:5064 with<br /> CAS-UDP name server on 0.0.0.0:5064<br /> Monitoring 1 multicast address:<br /> 224.0.2.9:5064<br /> Sending CAS-beacons to 1 address:<br /> 224.0.2.9:5065<br /> </pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> ... no destinations for local interfaces<br /> UDP Search destination "224.0.2.9:5064"<br /> ...</pre></div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RSRV_Configuration_Test_Plan&diff=3775 RSRV Configuration Test Plan 2016-01-23T21:01:26Z

<p>MichaelDavidsaver: </p> <hr /> <div>= Scope =<br /> <br /> This document describes some of the possible network configurations for RSRV and the expected results<br /> with the RSRV interface binding changes https://code.launchpad.net/~epics-core/epics-base/rsrvbindiface.<br /> <br /> The expected results are given as the output various IOC shell commands (eg. epicsParamShow/casr/dbcar).<br /> <br /> Note that the output of ''dbcar "" 8'' is quite verbose.<br /> Searching for the string ''Search Destination List'' in the output is suggested.<br /> <br /> = Preparation =<br /> <br /> This testing should be done on a computer with more than one physical/virtual network interface in additional to the loopback.<br /> <br /> On Linux additional tun/tap virtual interfaces can easily be added.<br /> In the following examples the addresses ''10.5.1.1'' and ''10.5.2.1'' name two such interfacess.<br /> Additional interfaces may be present.<br /> <br /> <pre>ip tuntap add dev tap0 mode tap<br /> ip addr add 10.5.1.1/24 dev tap0<br /> ip tuntap add dev tap1 mode tap<br /> ip addr add 10.5.2.1/24 dev tap1</pre><br /> <br /> These can later be removed<br /> <br /> <pre>ip tuntap del dev tap0 mode tap<br /> ip tuntap del dev tap1 mode tap</pre><br /> <br /> == Test IOC ==<br /> <br /> In addition to inspecting the output of the iocsh commands,<br /> it is recommended to test a live softIoc.<br /> <br /> <pre>cat << EOF > test.db<br /> record(calc, "test") {<br /> field(SCAN, "1 second")<br /> field(INPA, "test")<br /> field(CALC, "A+1")<br /> field(FLNK, "invalid")<br /> }</pre><br /> <br /> Each Test section includes an example invokation of ''softIoc'' and several ''caget''.<br /> <br /> = Tests =<br /> <br /> == Test #1 Defaults ==<br /> <br /> The default configuration is for RSRV is to bind to the wildcard interface (0.0.0.0),<br /> and for libca to search on all local interfaces.<br /> <br /> <pre>./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> A warning "Identical process variable names on multiple servers" should be seen. <br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST is undefined<br /> EPICS_CA_AUTO_ADDR_LIST: YES<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 4 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> == Test #2 Client address list only ==<br /> <br /> Bind the server to the wildcard address.<br /> Client searches only on a sub-set of interfaces.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work on either interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> Beacon destination 10.5.1.255:5065<br /> ... no more destinations<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #3 Client and Server on a single interface ==<br /> <br /> RSRV binds to a single interface, and libca only searches on this interface.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Beacon destination 10.5.1.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #4 Client and Server on a multiple interfaces ==<br /> <br /> RSRV binds to two interfaces, and libca only searches on these interfaces.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST="10.5.1.1 10.5.2.1" \<br /> EPICS_CA_ADDR_LIST="10.5.1.255 10.5.2.255" \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 and 10.5.2.255 interfaces, and fail on any others.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1 10.5.2.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Server interface 10.5.2.1:5064<br /> UDP receiver 1 10.5.2.1:5064<br /> UDP receiver 2 10.5.2.255:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 2 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #5 Client and Server on different, single, interfaces ==<br /> <br /> RSRV binds to one interface, and libca only searches on another interface.<br /> This is a "gateway"-like situation.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Additionally, the IOC's CA client will only search on 10.5.2.255.<br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Beacon destination 10.5.2.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #6 IPv4 Multicast for search and beacons ==<br /> <br /> Server bound to wildcard. Searches and beacons only with multicast.<br /> In addtional a multicast address is specified for name search and beacon messages.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client searches using multicast will succeed.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Searches not using multicast will fail.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 224.0.2.9<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 224.0.2.9<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> MCast receiver 224.0.2.9:5064<br /> Beacon destination 224.0.2.9:5065<br /> ... no destinations for local interfaces<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> ... no destinations for local interfaces<br /> UDP Search destination "224.0.2.9:5064"<br /> ...</pre></div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RSRV_Configuration_Test_Plan&diff=3774 RSRV Configuration Test Plan 2016-01-23T20:53:27Z

<p>MichaelDavidsaver: </p> <hr /> <div>= Scope =<br /> <br /> This document describes some of the possible network configurations for RSRV and the expected results<br /> with the RSRV interface binding changes https://code.launchpad.net/~epics-core/epics-base/rsrvbindiface.<br /> <br /> The expected results are given as the output various IOC shell commands (eg. epicsParamShow/casr/dbcar).<br /> <br /> Note that the output of ''dbcar "" 8'' is quite verbose.<br /> Searching for the string ''Search Destination List'' in the output is suggested.<br /> <br /> = Preparation =<br /> <br /> This testing should be done on a computer with more than one physical/virtual network interface in additional to the loopback.<br /> <br /> On Linux additional tun/tap virtual interfaces can easily be added.<br /> In the following examples the addresses ''10.5.1.1'' and ''10.5.2.1'' name two such interfacess.<br /> Additional interfaces may be present.<br /> <br /> <pre>ip tuntap add dev tap0 mode tap<br /> ip addr add 10.5.1.1/24 dev tap0<br /> ip tuntap add dev tap1 mode tap<br /> ip addr add 10.5.2.1/24 dev tap1</pre><br /> <br /> These can later be removed<br /> <br /> <pre>ip tuntap del dev tap0 mode tap<br /> ip tuntap del dev tap1 mode tap</pre><br /> <br /> == Test IOC ==<br /> <br /> In addition to inspecting the output of the iocsh commands,<br /> it is recommended to test a live softIoc.<br /> <br /> <pre>cat << EOF > test.db<br /> record(calc, "test") {<br /> field(SCAN, "1 second")<br /> field(INPA, "test")<br /> field(CALC, "A+1")<br /> field(FLNK, "invalid")<br /> }</pre><br /> <br /> Each Test section includes an example invokation of ''softIoc'' and several ''caget''.<br /> <br /> = Tests =<br /> <br /> == Test #1 Defaults ==<br /> <br /> The default configuration is for RSRV is to bind to the wildcard interface (0.0.0.0),<br /> and for libca to search on all local interfaces.<br /> <br /> <pre>./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> A warning "Identical process variable names on multiple servers" should be seen. <br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST is undefined<br /> EPICS_CA_AUTO_ADDR_LIST: YES<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 4 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> == Test #2 Client address list only ==<br /> <br /> Bind the server to the wildcard address.<br /> Client searches only on a sub-set of interfaces.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work on either interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> Beacon destination 10.5.1.255:5065<br /> ... no more destinations<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #3 Client and Server on a single interface ==<br /> <br /> RSRV binds to a single interface, and libca only searches on this interface.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Beacon destination 10.5.1.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #4 Client and Server on a multiple interfaces ==<br /> <br /> RSRV binds to two interfaces, and libca only searches on these interfaces.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST="10.5.1.1 10.5.2.1" \<br /> EPICS_CA_ADDR_LIST="10.5.1.255 10.5.2.255" \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 and 10.5.2.255 interfaces, and fail on any others.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1 10.5.2.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Server interface 10.5.2.1:5064<br /> UDP receiver 1 10.5.2.1:5064<br /> UDP receiver 2 10.5.2.255:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 2 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #5 Client and Server on different, single, interfaces ==<br /> <br /> RSRV binds to one interface, and libca only searches on another interface.<br /> This is a "gateway"-like situation.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Additionally, the IOC's CA client will only search on 10.5.2.255.<br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Beacon destination 10.5.2.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #6 IPv4 Multicast for search and beacons ==<br /> <br /> Server bound to wildcard, and client searches only with multicast.<br /> In addtional a multicast address is specified for name search and beacon messages.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client searches using multicast will succeed.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Searches not using multicast will fail.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 224.0.2.9<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 224.0.2.9<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> MCast destination 224.0.2.9:5064<br /> Beacon destination 224.0.2.9:5065<br /> ... no destinations for local interfaces<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> ... no destinations for local interfaces<br /> UDP Search destination "224.0.2.9:5064"<br /> ...</pre></div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RSRV_Configuration_Test_Plan&diff=3773 RSRV Configuration Test Plan 2016-01-23T20:15:26Z

<p>MichaelDavidsaver: </p> <hr /> <div>= Scope =<br /> <br /> This document describes some of the possible network configurations for RSRV and the expected results<br /> with the RSRV interface binding changes https://code.launchpad.net/~epics-core/epics-base/rsrvbindiface.<br /> <br /> The expected results are given as the output various IOC shell commands (eg. epicsParamShow/casr/dbcar).<br /> <br /> Note that the output of ''dbcar "" 8'' is quite verbose.<br /> Searching for the string ''Search Destination List'' in the output is suggested.<br /> <br /> = Preparation =<br /> <br /> This testing should be done on a computer with more than one physical/virtual network interface in additional to the loopback.<br /> <br /> On Linux additional tun/tap virtual interfaces can easily be added.<br /> In the following examples the addresses ''10.5.1.1'' and ''10.5.2.1'' name two such interfacess.<br /> Additional interfaces may be present.<br /> <br /> <pre>ip tuntap add dev tap0 mode tap<br /> ip addr add 10.5.1.1/24 dev tap0<br /> ip tuntap add dev tap1 mode tap<br /> ip addr add 10.5.2.1/24 dev tap1</pre><br /> <br /> These can later be removed<br /> <br /> <pre>ip tuntap del dev tap0 mode tap<br /> ip tuntap del dev tap1 mode tap</pre><br /> <br /> == Test IOC ==<br /> <br /> In addition to inspecting the output of the iocsh commands,<br /> it is recommended to test a live softIoc.<br /> <br /> <pre>cat << EOF > test.db<br /> record(calc, "test") {<br /> field(SCAN, "1 second")<br /> field(INPA, "test")<br /> field(CALC, "A+1")<br /> field(FLNK, "invalid")<br /> }</pre><br /> <br /> Each Test section includes an example invokation of ''softIoc'' and several ''caget''.<br /> <br /> = Tests =<br /> <br /> == Test #1 Defaults ==<br /> <br /> The default configuration is for RSRV is to bind to the wildcard interface (0.0.0.0),<br /> and for libca to search on all local interfaces.<br /> <br /> <pre>./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> A warning "Identical process variable names on multiple servers" should be seen. <br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST is undefined<br /> EPICS_CA_AUTO_ADDR_LIST: YES<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 4 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> == Test #2 Client address list only ==<br /> <br /> Bind the server to the wildcard address.<br /> Client searches only on a sub-set of interfaces.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work on either interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #3 Client and Server on a single interface ==<br /> <br /> RSRV binds to a single interface, and libca only searches on this interface.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Beacon destination 10.5.1.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.1.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #4 Client and Server on a multiple interfaces ==<br /> <br /> RSRV binds to two interfaces, and libca only searches on these interfaces.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST="10.5.1.1 10.5.1.2" \<br /> EPICS_CA_ADDR_LIST="10.5.1.255 10.5.2.255" \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 and 10.5.2.255 interfaces, and fail on any others.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.1.255 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1 10.5.1.2<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Server interface 10.5.2.1:5064<br /> UDP receiver 1 10.5.2.1:5064<br /> UDP receiver 2 10.5.2.255:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 2 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #5 Client and Server on different, single, interfaces ==<br /> <br /> RSRV binds to one interface, and libca only searches on another interface.<br /> This is a "gateway"-like situation.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=10.5.1.1 \<br /> EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client gets should work only when the 10.5.1.255 interface.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.1.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> and fail on any other interface<br /> <br /> <pre>EPICS_CA_ADDR_LIST=10.5.2.255 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Additionally, the IOC's CA client will only search on 10.5.2.255.<br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 10.5.2.255<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 10.5.1.1<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 10.5.1.1:5064<br /> UDP receiver 1 10.5.1.1:5064<br /> UDP receiver 2 10.5.1.255:5064<br /> Beacon destination 10.5.1.255:5065<br /> ... no other destinations<br /> ...</pre><br /> <br /> Note that "UDP receiver 2" will not be present for Windows targets as it is *nix specific.<br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> UDP Search destination "10.5.2.255:5064"<br /> ... No more destinations<br /> ...</pre><br /> <br /> == Test #6 IPv4 Multicast for search and beacons ==<br /> <br /> Server bound to wildcard, and client searches only with multicast.<br /> In addtional a multicast address is specified for name search and beacon messages.<br /> <br /> <pre>EPICS_CAS_INTF_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/softIoc -d test.db</pre><br /> <br /> Client searches using multicast will succeed.<br /> <br /> <pre>EPICS_CA_ADDR_LIST=224.0.2.9 \<br /> EPICS_CA_AUTO_ADDR_LIST=NO \<br /> ./bin/linux-x86/caget test</pre><br /> <br /> Searches not using multicast will fail.<br /> <br /> <pre>./bin/linux-x86/caget test</pre><br /> <br /> === epicsParamShow ===<br /> <br /> <pre>EPICS_CA_ADDR_LIST: 224.0.2.9<br /> EPICS_CA_AUTO_ADDR_LIST: NO<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST: 224.0.2.9<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined</pre><br /> <br /> <br /> === casr 2 ===<br /> <br /> <pre>Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> MCast destination 224.0.2.9:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... one for remaining local interfaces<br /> ...</pre><br /> <br /> === dbcar "" 8 ===<br /> <br /> <pre>...<br /> Search Destination List with 1 items<br /> ... no destinations for local interfaces<br /> UDP Search destination "224.0.2.9:5064"<br /> ...</pre></div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RSRV_Configuration_Test_Plan&diff=3772 RSRV Configuration Test Plan 2016-01-23T19:35:26Z

<p>MichaelDavidsaver: Created page with "= Scope = This document describes some of the possible network configurations for RSRV and the expected results. The expected results are given as the output various IOC shell ..."</p> <hr /> <div>= Scope =<br /> <br /> This document describes some of the possible network configurations for RSRV and the expected results.<br /> <br /> The expected results are given as the output various IOC shell commands (eg. epicsParamShow/casr/dbcar).<br /> <br /> = Preparation =<br /> <br /> This testing should be done on a computer with more than one physical/virtual network interface in additional to the loopback.<br /> <br /> On Linux additional tun/tap virtual interfaces can easily be added.<br /> In the following examples the addresses ''10.5.1.1'' and ''10.5.2.1'' name two such interfacess.<br /> Additional interfaces may be present.<br /> <br /> <pre><br /> ip tuntap add dev tap0 mode tap<br /> ip addr add 10.5.1.1/24 dev tap5<br /> ip tuntap add dev tap1 mode tap<br /> ip addr add 10.5.2.1/24 dev tap5<br /> </pre><br /> <br /> These can later be removed<br /> <br /> <pre><br /> ip tuntap del dev tap0 mode tap<br /> ip tuntap del dev tap1 mode tap<br /> </pre><br /> <br /> = Tests =<br /> <br /> == Test #1 Defaults ==<br /> <br /> The default configuration is for RSRV is to bind to the wildcard interface (0.0.0.0),<br /> and for libca to search on all local interfaces.<br /> <br /> === epicsParamShow ===<br /> <br /> <pre><br /> EPICS_CA_ADDR_LIST is undefined<br /> EPICS_CA_AUTO_ADDR_LIST: YES<br /> EPICS_CA_NAME_SERVERS is undefined<br /> EPICS_CAS_INTF_ADDR_LIST is undefined<br /> EPICS_CAS_AUTO_BEACON_ADDR_LIST is undefined<br /> EPICS_CAS_BEACON_ADDR_LIST is undefined<br /> </pre><br /> <br /> <br /> === casr 2 ===<br /> <br /> <pre><br /> Server interface 0.0.0.0:5064<br /> UDP receiver 1 0.0.0.0:5064<br /> Beacon destination 10.5.1.255:5065<br /> Beacon destination 10.5.2.255:5065<br /> ... one for remaining local interfaces<br /> ...<br /> </pre><br /> <br /> === dbcar '' 8 ===<br /> <br /> <pre><br /> ...<br /> Search Destination List with 4 items<br /> UDP Search destination "10.5.1.255:5064"<br /> UDP Search destination "10.5.2.255:5064"<br /> ... one for remaining local interfaces<br /> ...<br /> </pre></div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Core_Developer_Pages&diff=3771 Core Developer Pages 2016-01-23T19:20:02Z

<p>MichaelDavidsaver: </p> <hr /> <div>== Developing EPICS Base ==<br /> <br /> * [[How to check out EPICS Base with Bazaar]]<br /> * [[Style Guide for Bazaar commit messages]]<br /> <br /> == Development Plans ==<br /> <br /> * [[Future Development Ideas]]<br /> * [[Merging Branches into 3.15]]<br /> <br /> == Testing ==<br /> <br /> * [[RSRV Configuration Test Plan]]</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_find_which_IOC_provides_a_PV&diff=3763 How to find which IOC provides a PV 2015-02-10T17:25:17Z

<p>MichaelDavidsaver: </p> <hr /> <div>= How to find where an IOC is running which provides a PV name. =<br /> <br /> This process is for IOCs running on Linux servers.<br /> <br /> == Step 1: Find Host and TCP port ==<br /> <br /> The ''cainfo'' command will tell you which host is serving a particular PV, and which TCP port number on that host is used.<br /> <br /> $ cainfo LN-TS{EVR:1A-SFP}Pwr:RX-I<br /> LN-TS{EVR:1A-SFP}Pwr:RX-I<br /> State: connected<br /> Host: 10.0.152.111:5064<br /> Access: read, write<br /> Native data type: DBF_DOUBLE<br /> Request type: DBR_DOUBLE<br /> Element count: 1<br /> <br /> Here we see that the PV "LN-TS{EVR:1A-SFP}Pwr:RX-I" is served from port number 5064 of 10.0.152.111.<br /> <br /> $ cainfo LN-RF{AMP:1}Amp-Sts<br /> LN-RF{AMP:1}Amp-Sts<br /> State: connected<br /> Host: linacioc01.cs.nsls2.local:36349<br /> Access: read, write<br /> Native data type: DBF_ENUM<br /> Request type: DBR_ENUM<br /> Element count: 1<br /> <br /> Here is another example where the hostname is shown instead of an IP address. Also this server has more than one IOC, and the one in question is using port 36349.<br /> <br /> == Step 2: Find which process is using a TCP port (Linux only) ==<br /> <br /> Super-user (root) permission is required to find which Linux process is bound to a particular TCP port.<br /> <br /> To continue the example from above. On the server linacioc01.cs.nsls2.local we run:<br /> <br /> $ sudo netstat -tlpn | grep 36349<br /> tcp 0 0 0.0.0.0:36349 0.0.0.0:* LISTEN 4627/s7ioc<br /> <br /> This tells us that TCP port 36349 is bound by process ID (PID) 4627, which has the process name of 's7ioc'.<br /> <br /> == Step 3: Find information about a process (Linux only) ==<br /> <br /> The ''ps'' command can give some information, including the command used to start the process. This often contains enough information to identify where the IOC's files can be found.<br /> <br /> $ ps aux|grep 4627<br /> softioc 4627 1.5 0.0 93748 6616 pts/23 Ssl+ Jan07 744:18 ../../bin/linux-x86/s7ioc /epics/iocs/RF-CONTROL/iocBoot/iocrf-control/st.cmd<br /> <br /> There are several pieces of information available under /proc which are useful.<br /> The entry '/proc/<pid>/cwd' is a symbolic link to the current working directory of the process.<br /> There is also '/proc/<pid>/exe' which links to the executable.<br /> <br /> $ sudo ls -l /proc/4627/cwd<br /> lrwxrwxrwx 1 softioc softioc 0 Feb 10 11:49 /proc/4627/cwd -> /epics/iocs/RF-CONTROL<br /> $ sudo ls -l /proc/4627/exe<br /> lrwxrwxrwx 1 softioc softioc 0 Jan 7 09:58 /proc/4627/exe -> /epics/iocs/RF-CONTROL/bin/linux-x86/s7ioc<br /> <br /> == Additional: Finding the procServ/screen running an IOC (Linux only) ==<br /> <br /> The ''ps'' command can also tell us the PID of the parent of the IOC process.<br /> The techniques of step 3 can also be applied to the parent.<br /> <br /> $ ps -eo pid,ppid,user,cmd|grep 4627<br /> 4627 4566 softioc ../../bin/linux-x86/s7ioc /epics/iocs/RF-CONTROL/iocBoot/iocrf-control/st.cmd<br /> <br /> The parent PID in the second column is 4566.<br /> <br /> $ ps aux|grep 4566<br /> softioc 4566 0.0 0.0 3452 592 ? Ss Jan07 2:18 /usr/bin/procServ -q -c /epics/iocs/RF-CONTROL/iocBoot/iocrf-control -i ^D^C^] -p /var/run/softioc-RF-CONTROL.pid -n RF-CONTROL --restrict --logfile=/var/log/softioc-RF-CONTROL.log 4057 /epics/iocs/RF-CONTROL/iocBoot/iocrf-control/st.cmd<br /> <br /> And to complete the circle, and get access to the IOC console, we find which TCP port this procServ instance is bound to.<br /> <br /> $ sudo netstat -tlpn|grep 4566<br /> tcp 0 0 127.0.0.1:4057 0.0.0.0:* LISTEN 4566/procServ<br /> $ telnet localhost 4057<br /> epics> dbpr LN-RF{AMP:1}Amp-Sts<br /> ASG: DESC: Ampl.500 MHz E-Source DISA: 0 <br /> DISP: 0 DISV: 1 NAME: LN-RF{AMP:1}Amp-Sts <br /> RVAL: 16 SEVR: NO_ALARM STAT: NO_ALARM SVAL: 0 <br /> TPRO: 0 VAL: 1</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_find_which_IOC_provides_a_PV&diff=3762 How to find which IOC provides a PV 2015-02-10T17:11:11Z

<p>MichaelDavidsaver: </p> <hr /> <div>= How to find where an IOC is running which provides a PV name. =<br /> <br /> This process is for IOCs running on Linux servers.<br /> <br /> == Step 1: Find Host and TCP port ==<br /> <br /> The ''cainfo'' command will tell you which host is serving a particular PV, and which TCP port number on that host is used.<br /> <br /> $ cainfo LN-TS{EVR:1A-SFP}Pwr:RX-I<br /> LN-TS{EVR:1A-SFP}Pwr:RX-I<br /> State: connected<br /> Host: 10.0.152.111:5064<br /> Access: read, write<br /> Native data type: DBF_DOUBLE<br /> Request type: DBR_DOUBLE<br /> Element count: 1<br /> <br /> Here we see that the PV "LN-TS{EVR:1A-SFP}Pwr:RX-I" is served from port number 5064 of 10.0.152.111.<br /> <br /> $ cainfo LN-RF{Amp:1]On-Set<br /> LN-RF{Amp:1]On-Set<br /> State: connected<br /> Host: linacioc01.cs.nsls2.local:36349<br /> Access: read, write<br /> Native data type: DBF_ENUM<br /> Request type: DBR_ENUM<br /> Element count: 1<br /> <br /> Here is another example where the hostname is shown instead of an IP address. Also this server has more than one IOC, and the one in question is using port 36349.<br /> <br /> == Step 2: Find which process is using a TCP port (Linux only) ==<br /> <br /> Super-user (root) permission is required to find which Linux process is bound to a particular TCP port.<br /> <br /> To continue the example from above. On the server linacioc01.cs.nsls2.local we run:<br /> <br /> $ sudo netstat -tlpn | grep 36349<br /> tcp 0 0 0.0.0.0:36349 0.0.0.0:* LISTEN 4627/s7ioc<br /> <br /> This tells us that TCP port 36349 is bound by process ID (PID) 4627, which has the process name of 's7ioc'.<br /> <br /> == Step 3: Find information about a process (Linux only) ==<br /> <br /> The ''ps'' command can give some information, including the command used to start the process. This often contains enough information to identify where the IOC's files can be found.<br /> <br /> $ ps aux|grep 4627<br /> softioc 4627 1.5 0.0 93748 6616 pts/23 Ssl+ Jan07 744:18 ../../bin/linux-x86/s7ioc /epics/iocs/RF-CONTROL/iocBoot/iocrf-control/st.cmd<br /> <br /> There are several pieces of information available under /proc which are useful.<br /> The entry '/proc/<pid>/cwd' is a symbolic link to the current working directory of the process.<br /> There is also '/proc/<pid>/exe' which links to the executable.<br /> <br /> $ sudo ls -l /proc/4627/cwd<br /> lrwxrwxrwx 1 softioc softioc 0 Feb 10 11:49 /proc/4627/cwd -> /epics/iocs/RF-CONTROL<br /> $ sudo ls -l /proc/4627/exe<br /> lrwxrwxrwx 1 softioc softioc 0 Jan 7 09:58 /proc/4627/exe -> /epics/iocs/RF-CONTROL/bin/linux-x86/s7ioc<br /> <br /> == Additional: Finding the procServ/screen running an IOC (Linux only) ==<br /> <br /> The ''ps'' command can also tell us the PID of the parent of the IOC process.<br /> The techniques of step 3 can also be applied to the parent.<br /> <br /> $ ps -eo pid,ppid,user,cmd|grep 4627<br /> 4627 4566 softioc ../../bin/linux-x86/s7ioc /epics/iocs/RF-CONTROL/iocBoot/iocrf-control/st.cmd<br /> <br /> The parent PID in the second column is 4566.<br /> <br /> $ ps aux|grep 4566<br /> softioc 4566 0.0 0.0 3452 592 ? Ss Jan07 2:18 /usr/bin/procServ -q -c /epics/iocs/RF-CONTROL/iocBoot/iocrf-control -i ^D^C^] -p /var/run/softioc-RF-CONTROL.pid -n RF-CONTROL --restrict --logfile=/var/log/softioc-RF-CONTROL.log 4057 /epics/iocs/RF-CONTROL/iocBoot/iocrf-control/st.cmd</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_find_which_IOC_provides_a_PV&diff=3761 How to find which IOC provides a PV 2015-02-10T17:01:30Z

<p>MichaelDavidsaver: </p> <hr /> <div>How to find where an IOC is running which provides a PV name. This process is for IOCs running on Linux servers.<br /> <br /> == Step 1: Find Host and TCP port ==<br /> <br /> The ''cainfo'' command will tell you which host is serving a particular PV, and which TCP port number on that host is used.<br /> <br /> $ cainfo LN-TS{EVR:1A-SFP}Pwr:RX-I<br /> LN-TS{EVR:1A-SFP}Pwr:RX-I<br /> State: connected<br /> Host: 10.0.152.111:5064<br /> Access: read, write<br /> Native data type: DBF_DOUBLE<br /> Request type: DBR_DOUBLE<br /> Element count: 1<br /> <br /> Here we see that the PV "LN-TS{EVR:1A-SFP}Pwr:RX-I" is served from port number 5064 of 10.0.152.111.<br /> <br /> $ cainfo LN-RF{Amp:1]On-Set<br /> LN-RF{Amp:1]On-Set<br /> State: connected<br /> Host: linacioc01.cs.nsls2.local:36349<br /> Access: read, write<br /> Native data type: DBF_ENUM<br /> Request type: DBR_ENUM<br /> Element count: 1<br /> <br /> Here is another example where the hostname is shown instead of an IP address. Also this server has more than one IOC, and the one in question is using port 36349.<br /> <br /> == Step 2: Find which process is using a TCP port (Linux only) ==<br /> <br /> Super-user (root) permission is required to find which Linux process is bound to a particular TCP port.<br /> <br /> To continue the example from above. On the server linacioc01.cs.nsls2.local we run:<br /> <br /> $ sudo netstat -tlpn | grep 36349<br /> tcp 0 0 0.0.0.0:36349 0.0.0.0:* LISTEN 4627/s7ioc<br /> <br /> This tells us that TCP port 36349 is bound by process ID (PID) 4627, which has the process name of 's7ioc'.<br /> <br /> == Step 3: Find information about a process (Linux only) ==<br /> <br /> The ''ps'' command can give some information, including the command used to start the process. This often contains enough information to identify where the IOC's files can be found.<br /> <br /> $ ps aux|grep 4627<br /> softioc 4627 1.5 0.0 93748 6616 pts/23 Ssl+ Jan07 744:18 ../../bin/linux-x86/s7ioc /epics/iocs/RF-CONTROL/iocBoot/iocrf-control/st.cmd<br /> <br /> There are several pieces of information available under /proc which are useful.<br /> The entry '/proc/<pid>/cwd' is a symbolic link to the current working directory of the process.<br /> There is also '/proc/<pid>/exe' which links to the executable.<br /> <br /> $ sudo ls -l /proc/4627/cwd<br /> lrwxrwxrwx 1 softioc softioc 0 Feb 10 11:49 /proc/4627/cwd -> /epics/iocs/RF-CONTROL<br /> $ sudo ls -l /proc/4627/exe<br /> lrwxrwxrwx 1 softioc softioc 0 Jan 7 09:58 /proc/4627/exe -> /epics/iocs/RF-CONTROL/bin/linux-x86/s7ioc</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_find_which_IOC_provides_a_PV&diff=3760 How to find which IOC provides a PV 2015-02-10T16:54:04Z

<p>MichaelDavidsaver: Created page with "How to find where an IOC is running which provides a PV name. This process is for IOCs running on Linux servers. == Step 1: Find Host and TCP port == The ''cainfo'' command wi..."</p> <hr /> <div>How to find where an IOC is running which provides a PV name. This process is for IOCs running on Linux servers.<br /> <br /> == Step 1: Find Host and TCP port ==<br /> <br /> The ''cainfo'' command will tell you which host is serving a particular PV, and which TCP port number on that host is used.<br /> <br /> $ cainfo LN-TS{EVR:1A-SFP}Pwr:RX-I<br /> LN-TS{EVR:1A-SFP}Pwr:RX-I<br /> State: connected<br /> Host: 10.0.152.111:5064<br /> Access: read, write<br /> Native data type: DBF_DOUBLE<br /> Request type: DBR_DOUBLE<br /> Element count: 1<br /> <br /> Here we see that the PV "LN-TS{EVR:1A-SFP}Pwr:RX-I" is served from port number 5064 of 10.0.152.111.<br /> <br /> $ cainfo LN-RF{Amp:1]On-Set<br /> LN-RF{Amp:1]On-Set<br /> State: connected<br /> Host: linacioc01.cs.nsls2.local:36349<br /> Access: read, write<br /> Native data type: DBF_ENUM<br /> Request type: DBR_ENUM<br /> Element count: 1<br /> <br /> Here is another example where the hostname is shown instead of an IP address. Also this server has more than one IOC, and the one in question is using port 36349.<br /> <br /> == Step 2: Find which process is using a TCP port (Linux only) ==<br /> <br /> Super-user (root) permission is required to find which Linux process is bound to a particular TCP port.<br /> <br /> To continue the example from above. On the server linacioc01.cs.nsls2.local we run:<br /> <br /> $ sudo netstat -tlpn | grep 36349<br /> tcp 0 0 0.0.0.0:36349 0.0.0.0:* LISTEN 4627/s7ioc<br /> <br /> This tells us that TCP port 36349 is bound by process ID (PID) 4627, which has the process name of 's7ioc'.<br /> <br /> == Step 3: Find information about a process (Linux only) ==<br /> <br /> The ''ps'' command can give some information, including the command used to start the process. This often contains enough information to identify where the IOC's files can be found.<br /> <br /> $ ps aux|grep 4627<br /> softioc 4627 1.5 0.0 93748 6616 pts/23 Ssl+ Jan07 744:18 ../../bin/linux-x86/s7ioc /epics/iocs/RF-CONTROL/iocBoot/iocrf-control/st.cmd<br /> <br /> There are several pieces of information available under /proc which are useful.<br /> The entry '/proc/<pid>/cwd' is a symbolic link to the current working directory of the process.<br /> There is also '/proc/<pid>/exe' which links to the executable.<br /> <br /> $ sudo ls -l /proc/4627/cwd<br /> lrwxrwxrwx 1 softioc softioc 0 Feb 10 11:49 /proc/4627/cwd -> /direct/linacioc01_iocs/RF-CONTROL<br /> $ sudo ls -l /proc/4627/exe<br /> lrwxrwxrwx 1 softioc softioc 0 Jan 7 09:58 /proc/4627/exe -> /direct/linacioc01_iocs/RF-CONTROL/bin/linux-x86/s7ioc</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=HowTo_Documents&diff=3759 HowTo Documents 2015-02-10T16:02:57Z

<p>MichaelDavidsaver: </p> <hr /> <div>This is a directory of various How-To documents written by members of the EPICS collaboration. Contributions to this page are most welcome!<br /> <br /> === EPICS Base on Different Architectures and Operating Systems ===<br /> <br /> * [http://www.aps.anl.gov/epics/base/RTEMS/tutorial/ Getting Started with EPICS on RTEMS]<br /> * [[HowToPC104|Getting Started with R3.14.7 on a PC104 running Linux]]<br /> * [[How To Port EPICS to a new OS/Architecture]]<br /> * [[How To Use Posix Thread Priority Scheduling under Linux]]<br /> * [[How To cross compile EPICS and a IOC to an old x86 Linux system]]<br /> * [http://prjemian.github.io/epicspi/ Installing EPICS on a Raspberry Pi]<br /> <br /> === Drivers and Device Support ===<br /> <br /> * [http://www.aps.anl.gov/epics/modules/soft/asyn/HowToDoSerial_StreamDevice.html How To Do Serial (using Asyn Driver and StreamDevice)] (also covers VXI-11)<br /> * [http://www.aps.anl.gov/epics/modules/soft/asyn/R4-15/HowToDoSerial/tutorial.pdf How To Do Serial (using Asyn Driver and devGPIB)]<br /> * [[How to make your EPICS driver operating system independent]]<br /> * [[How To Write Device Support that uses Asyn Driver]] ''(Incomplete!)''<br /> * [[How to use GPIB ports with linux-gpib and StreamDevice]]<br /> * [[How to avoid copying arrays with waveformRecord]]<br /> <br /> === Applications ===<br /> <br /> * [[Common Database patterns]]<br /> * [[How To Install Channel Archiver On Scientific Linux]]<br /> * [[What PV Save and Restore Tools are available]]<br /> * [[How to Add a New Breakpoint Table]]<br /> * [["Best Practice" Guidelines]]<br /> * [[How do I get EPICS applications to work with a Mac OS X firewall?]]<br /> <br /> === Infrastructure and Other Stuff ===<br /> <br /> * [[How To Set Up a Linux Box as an IOC Boot Server]]<br /> * [[How To Set Up a Mirror of the EPICS Web Site]]<br /> * [[How to Set Up a Soft IOC Framework on Linux]]<br /> * [[How to Configure Channel Access]]<br /> * [[How to Make Channel Access Reach Multiple Soft IOCs on a Linux Host]]<br /> * [[How to Set Up Console Access and Logging for VME and Soft IOCs]]<br /> * [[How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network]]<br /> * [[How to find which IOC provides a PV]]<br /> <br /> === Collaboration Stuff ===<br /> <br /> * [[How to run an EPICS Collaboration Meeting]]</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_avoid_copying_arrays_with_waveformRecord&diff=3713 How to avoid copying arrays with waveformRecord 2013-02-19T20:13:34Z

<p>MichaelDavidsaver: </p> <hr /> <div>== Introduction ==<br /> <br /> This page describes how to use the<br /> [https://code.launchpad.net/~epics-core/epics-base/array-opt array field memory management]<br /> feature to be introduced in EPICS 3.15.1 (not yet released).<br /> This allows array data to be moved into and out of the value (aka BPTR) field<br /> of the waveform, aai, and aao types.<br /> <br /> Making use of this feature involves replacing the pointer stored in the BPTR field with another (user allocated) pointer. The basic rules are:<br /> <br /> # BPTR, and the memory it is currently pointing to, can only be accessed while the record is locked.<br /> # NELM may not be changed.<br /> # BPTR must always point to a piece of memory large enough to accommodate the maximum number of elements (as given by the NELM field).<br /> <br /> Rule #1 means that it is only safe to read, write, or de-reference the BPTR field from a device support function, or after manually calling dbScanLock().<br /> Rule #3 means that BPTR can never be set to NULL, and when replacing BPTR, the replacement must be allocated large enough for the worst case.<br /> An external client may put an array of up to NELM elements to the field at almost any time.<br /> <br /> <br /> === Prerequisites ===<br /> <br /> A version of EPICS Base with this feature.<br /> <br /> == Example ==<br /> <br /> /* Demonstration of using custom allocation for waveformRecord buffers.<br /> *<br /> * Requires EPICS Base with the array field memory management patch<br /> * https://code.launchpad.net/~epics-core/epics-base/array-opt<br /> *<br /> * This example makes inefficient use of malloc() and<br /> * free(). This is done to make clear where new memory appears.<br /> * In reality a free list should be used.<br /> *<br /> * Also be aware that this example will use 100% of the time of one CPU core.<br /> * However, this will be spread across available cores.<br /> *<br /> * To use this example include the following in a DBD file:<br /> *<br /> * device(waveform,CONSTANT,devWfZeroCopy,"Zero Copy Demo")<br /> *<br /> * Also include a record instance<br /> *<br /> * record(waveform, "$(NAME)") {<br /> * field(DTYP, "Zero Copy Demo")<br /> * field(FTVL, "SHORT")<br /> * field(NELM, "100")<br /> * field(SCAN, "I/O Intr")<br /> * }<br /> */<br /> <br /> #include <errlog.h><br /> #include <initHooks.h><br /> #include <ellLib.h><br /> #include <devSup.h><br /> #include <dbDefs.h><br /> #include <dbAccess.h><br /> #include <cantProceed.h><br /> #include <epicsTypes.h><br /> #include <epicsMutex.h><br /> #include <epicsEvent.h><br /> #include <epicsThread.h><br /> #include <menuFtype.h><br /> #include <dbScan.h><br /> <br /> #include <waveformRecord.h><br /> <br /> static ELLLIST allPvt = ELLLIST_INIT;<br /> <br /> struct devicePvt {<br /> ELLNODE node;<br /> <br /> /* synchronize access to this structure */<br /> epicsMutexId lock;<br /> /* wakeup the worker when another update is needed */<br /> epicsEventId wakeup;<br /> /* notify the scanner thread when another update is available */<br /> IOSCANPVT scan;<br /> <br /> /* the next update */<br /> void *nextBuffer;<br /> epicsUInt32 maxbytes, numbytes;<br /> };<br /> <br /> static void startWorkers(initHookState);<br /> <br /> static long init(int phase)<br /> {<br /> if(phase!=0)<br /> return 0;<br /> initHookRegister(&startWorkers);<br /> return 0;<br /> }<br /> <br /> static long init_record(waveformRecord *prec)<br /> {<br /> struct devicePvt *priv;<br /> if(prec->ftvl!=menuFtypeSHORT) {<br /> errlogPrintf("%s.FTVL must be set to SHORT for this example\n", prec->name);<br /> return 0;<br /> }<br /> <br /> /* cleanup array allocated by record support.<br /> * Not necessary since we use calloc()/free(),<br /> * but needed when allocating in other ways.<br /> */<br /> free(prec->bptr);<br /> prec->bptr = callocMustSucceed(prec->nelm, dbValueSize(prec->ftvl), "first buf");<br /> <br /> priv = callocMustSucceed(1, sizeof(*priv), "init_record devWfZeroCopy");<br /> priv->lock = epicsMutexMustCreate();<br /> priv->wakeup = epicsEventMustCreate(epicsEventFull);<br /> scanIoInit(&priv->scan);<br /> priv->maxbytes = prec->nelm*dbValueSize(prec->ftvl);<br /> <br /> ellAdd(&allPvt, &priv->node);<br /> <br /> prec->dpvt = priv;<br /> return 0;<br /> }<br /> <br /> static void worker(void*);<br /> <br /> static void startWorkers(initHookState state)<br /> {<br /> ELLNODE *cur;<br /> /* Don't start worker threads until<br /> * it is safe to call scanIoRequest()<br /> */<br /> if(state!=initHookAfterInterruptAccept)<br /> return;<br /> for(cur=ellFirst(&allPvt); cur; cur=ellNext(cur))<br /> {<br /> struct devicePvt *priv = CONTAINER(cur, struct devicePvt, node);<br /> epicsThreadMustCreate("wfworker",<br /> epicsThreadPriorityHigh,<br /> epicsThreadGetStackSize(epicsThreadStackSmall),<br /> &worker, priv);<br /> }<br /> }<br /> <br /> static void worker(void* raw)<br /> {<br /> struct devicePvt *priv=raw;<br /> void *buf = NULL;<br /> epicsUInt32 nbytes = priv->maxbytes;<br /> <br /> while(1) {<br /> <br /> if(!buf) {<br /> /* allocate and initialize a new buffer for later (local) use */<br /> size_t i;<br /> epicsInt16 *ibuf;<br /> buf = callocMustSucceed(1, nbytes, "buffer");<br /> ibuf = (epicsInt16*)buf;<br /> for(i=0; i<nbytes/2; i++)<br /> {<br /> ibuf[i] = rand();<br /> }<br /> }<br /> <br /> /* wait for Event signal when record is scanning 'I/O Intr',<br /> * and timeout when record is scanning periodic<br /> */<br /> if(epicsEventWaitWithTimeout(priv->wakeup, 1.0)==epicsEventError) {<br /> cantProceed("worker encountered an error waiting for wakeup\n");<br /> }<br /> <br /> epicsMutexMustLock(priv->lock);<br /> <br /> if(!priv->nextBuffer) {<br /> /* make the local buffer available to the read_wf function */<br /> priv->nextBuffer = buf;<br /> buf = NULL;<br /> priv->numbytes = priv->maxbytes;<br /> scanIoRequest(priv->scan);<br /> }<br /> <br /> epicsMutexUnlock(priv->lock);<br /> }<br /> }<br /> <br /> static long get_iointr_info(int dir, dbCommon *prec, IOSCANPVT *scan)<br /> {<br /> struct devicePvt *priv=prec->dpvt;<br /> if(!priv)<br /> return 0;<br /> *scan = priv->scan;<br /> /* wakeup the worker when this thread is placed in the I/O scan list */<br /> if(dir==0)<br /> epicsEventSignal(priv->wakeup);<br /> return 0;<br /> }<br /> <br /> static long read_wf(waveformRecord *prec)<br /> {<br /> struct devicePvt *priv=prec->dpvt;<br /> if(!priv)<br /> return 0;<br /> <br /> epicsMutexMustLock(priv->lock);<br /> <br /> if(priv->nextBuffer) {<br /> /* an update is available, so claim it. */<br /> <br /> if(prec->bptr)<br /> free(prec->bptr);<br /> <br /> prec->bptr = priv->nextBuffer; /* no memcpy! */<br /> priv->nextBuffer = NULL;<br /> prec->nord = priv->numbytes / dbValueSize(prec->ftvl);<br /> <br /> epicsEventSignal(priv->wakeup);<br /> }<br /> <br /> epicsMutexUnlock(priv->lock);<br /> <br /> assert(prec->bptr);<br /> <br /> return 0;<br /> }<br /> <br /> static<br /> struct dset5 {<br /> dset com;<br /> DEVSUPFUN read;<br /> } devWfZeroCopy = {<br /> {5, NULL,<br /> &init,<br /> &init_record,<br /> &get_iointr_info<br /> },<br /> &read_wf<br /> };<br /> <br /> #include <epicsExport.h><br /> <br /> epicsExportAddress(dset, devWfZeroCopy);</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_avoid_copying_arrays_with_waveformRecord&diff=3712 How to avoid copying arrays with waveformRecord 2013-02-19T20:08:46Z

<p>MichaelDavidsaver: </p> <hr /> <div>== Introduction ==<br /> <br /> This page describes how to use the<br /> [https://code.launchpad.net/~epics-core/epics-base/array-opt array field memory management]<br /> feature to be introduced in EPICS 3.15.1 (not yet released).<br /> This allows array data to be moved into and out of the value (aka BPTR) field<br /> of the waveform, aai, and aao types.<br /> <br /> Making use of this feature involves replacing the pointer stored in the BPTR field with another (user allocated) pointer. The basic rules are:<br /> <br /> # BPTR, and the memory it is currently pointing to, can only be accessed while the record is locked.<br /> # NELM may not be changed.<br /> # BPTR must always point to a piece of memory large enough to accommodate the maximum number of elements (as given by the NELM field).<br /> <br /> Rule #1 means that it is only safe to read, write, or de-reference the BPTR field from a device support function, or after manually calling dbScanLock().<br /> Rule #3 means that BPTR can never be set to NULL, and when replacing BPTR, the replacement must be allocated large enough for the worst case.<br /> An external client may put an array of up to NELM elements to the field at almost any time.<br /> <br /> <br /> === Prerequisites ===<br /> <br /> A version of EPICS Base with this feature.<br /> <br /> == Examples ==<br /> <br /> Two pieces of example code are available.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_avoid_copying_arrays_with_waveformRecord&diff=3711 How to avoid copying arrays with waveformRecord 2013-02-19T15:45:48Z

<p>MichaelDavidsaver: </p> <hr /> <div>== Introduction ==<br /> <br /> This page describes how to use the<br /> [https://code.launchpad.net/~epics-core/epics-base/array-opt array field memory management]<br /> feature to be introduced in EPICS 3.15.1 (not yet released).<br /> This allows array data to be moved into and out of the value (aka BPTR) field<br /> of the waveform, aai, and aao types.<br /> <br /> Making use of this feature involves replacing the pointer stored in the BPTR field with another (user allocated) pointer. The basic rules are:<br /> <br /> # BPTR, and the memory it is currently pointing to, can only be accessed while the record is locked.<br /> # NELM may not be changed.<br /> # BPTR must always point to a piece of memory large enough to accommodate the maximum number of elements (as given by the NELM field).<br /> <br /> Rule #1 means that it is only safe to read, write, or de-reference the BPTR field from a device support function, or after manually calling dbScanLock().<br /> Rule #3 means that BPTR can never be set to NULL, and when replacing BPTR, the replacement must be allocated large enough for the worst case.<br /> An external client may put an array of up to NELM elements to the field at almost any time.<br /> <br /> <br /> === Prerequisites ===<br /> <br /> A version of EPICS Base with this feature.<br /> <br /> == Example ==</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_avoid_copying_arrays_with_waveformRecord&diff=3710 How to avoid copying arrays with waveformRecord 2013-02-19T15:43:30Z

<p>MichaelDavidsaver: </p> <hr /> <div>== Introduction ==<br /> <br /> This page describes how to use the<br /> [https://code.launchpad.net/~epics-core/epics-base/array-opt array field memory management]<br /> feature to be introduced in EPICS 3.15.1 (not yet released).<br /> This allows array data to be moved into and out of the value (aka BPTR) field<br /> of the waveform, aai, and aao types.<br /> <br /> Making use of this feature involves replacing the pointer stored in the BPTR field with another (user allocated) pointer. The basic rules are:<br /> <br /> # BPTR and the memory it is currently pointing to can only be accessed while the record is locked.<br /> # NELM may not be changed.<br /> # BPTR must always point to a piece of memory large enough to accommodate the maximum number of elements (as given by the NELM field).<br /> <br /> Rule #1 means that it is only safe to read, write, or de-reference the BPTR field from a device support function, or after manually calling dbScanLock().<br /> Rule #3 means that BPTR can never be set to NULL, and when replacing BPTR, the replacement must be allocated large enough for the worst case.<br /> An external client may put an array of up to NELM elements to the field at almost any time.<br /> <br /> <br /> === Prerequisites ===<br /> <br /> A version of EPICS Base with this feature.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=How_to_avoid_copying_arrays_with_waveformRecord&diff=3709 How to avoid copying arrays with waveformRecord 2013-02-19T15:38:18Z

<p>MichaelDavidsaver: Created page with "== Introduction == This page describes how to use the [https://code.launchpad.net/~epics-core/epics-base/array-opt array field memory management] feature to be introduced in EPI..."</p> <hr /> <div>== Introduction ==<br /> <br /> This page describes how to use the<br /> [https://code.launchpad.net/~epics-core/epics-base/array-opt array field memory management]<br /> feature to be introduced in EPICS 3.15.1 (not yet released).<br /> This allows array data to be moved into and out of the value (aka BPTR) field<br /> of the waveform, aai, and aao types.<br /> <br /> == Prerequisites ==<br /> <br /> A version of EPICS Base with this feature.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=HowTo_Documents&diff=3708 HowTo Documents 2013-02-19T15:32:17Z

<p>MichaelDavidsaver: /* Drivers and Device Support */</p> <hr /> <div>This is a directory of various How-To documents written by members of the EPICS collaboration. Contributions to this page are most welcome!<br /> <br /> === EPICS Base on Different Architectures and Operating Systems ===<br /> <br /> * [http://www.aps.anl.gov/epics/base/RTEMS/tutorial/ Getting Started with EPICS on RTEMS]<br /> * [[HowToPC104|Getting Started with R3.14.7 on a PC104 running Linux]]<br /> * [[How To Port EPICS to a new OS/Architecture]]<br /> * [[How To Use Posix Thread Priority Scheduling under Linux]]<br /> * [[How To cross compile EPICS and a IOC to an old x86 Linux system]]<br /> <br /> === Drivers and Device Support ===<br /> <br /> * [http://www.aps.anl.gov/epics/modules/soft/asyn/HowToDoSerial_StreamDevice.html How To Do Serial (using Asyn Driver and StreamDevice)] (also covers VXI-11)<br /> * [http://www.aps.anl.gov/epics/modules/soft/asyn/R4-15/HowToDoSerial/tutorial.pdf How To Do Serial (using Asyn Driver and devGPIB)]<br /> * [[How to make your EPICS driver operating system independent]]<br /> * [[How To Write Device Support that uses Asyn Driver]] ''(Incomplete!)''<br /> * [[How to use GPIB ports with linux-gpib and StreamDevice]]<br /> * [[How to avoid copying arrays with waveformRecord]]<br /> <br /> === Applications ===<br /> <br /> * [[Common Database patterns]]<br /> * [[How To Install Channel Archiver On Scientific Linux]]<br /> * [[What PV Save and Restore Tools are available]]<br /> * [[How to Add a New Breakpoint Table]]<br /> * [["Best Practice" Guidelines]]<br /> * [[How do I get EPICS applications to work with a Mac OS X firewall?]]<br /> <br /> === Infrastructure and Other Stuff ===<br /> <br /> * [[How To Set Up a Linux Box as an IOC Boot Server]]<br /> * [[How To Set Up a Mirror of the EPICS Web Site]]<br /> * [[How to Set Up a Soft IOC Framework on Linux]]<br /> * [[How to Set Up Console Access and Logging for VME and Soft IOCs]]<br /> * [[How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network]]<br /> <br /> === Collaboration Stuff ===<br /> <br /> * [[How to run an EPICS Collaboration Meeting]]</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RRM_3-14_dbCommon&diff=2859 RRM 3-14 dbCommon 2010-09-27T19:13:14Z

<p>MichaelDavidsaver: TSE missing meaning of event codes</p> <hr /> <div>[[RRM 3-14|EPICS Record Reference Manual]]<br /> <br /> <br /> == Fields Common to All Record Types ==<br /> <br /> === Introduction ===<br /> <br /> This chapter contains a description of fields that are common to all records. These fields are defined in dbcommon.dbd.<br /> <br /> === Scan Fields ===<br /> <br /> These fields contain information related to how and when a record processes. For a further explanation of these record processing and these fields, see Scanning Specification, Chapter 1, 1. A few records have unique fields that also affect how they process. These fields, if any, will be listed and explained in the chapter for each record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><br /> <TR><br /> <TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<br /> <TH>PP<TR><br /> <TD>SCAN<TD>GBLCHOICE<TD>Yes<TD>Passive<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PINI<TD>GBLCHOICE<TD>Yes<TD>No<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PHAS<TD>SHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>EVNT<TD>SHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PRIO<TD>GBLCHOICE<TD>Yes<TD>Low<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>DISV<TD>SHORT<TD>Yes<TD>1<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>DISA<TD>SHORT<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>SDIS<TD>INLINK<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>N/A<TD>No<TR><br /> <TD>PROC<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>DISS<TD>GBLCHOICE<TD>Yes<TD>No Alarm<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>LCNT<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PACT<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>FLNK<TD>FWDLINK<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>N/A<TD>No&nbsp;<TR><br /> <TD>SPVT<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD></TABLE><br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>SCAN<TD>Scanning Rate<TD>This can be one of the periodic intervals (<CODE>.1 second</CODE>, <CODE>.2 second</CODE>, <CODE>.5 second</CODE>, <CODE>1 second</CODE>, <CODE>2 second</CODE>, <CODE>5 second</CODE>, <CODE>10 second</CODE>, <CODE>I/O Intr</CODE>, <CODE>Event</CODE>, or <CODE>Passive</CODE>.<TR><br /> <TD>PINI<TD>Process at Initialization<TD>If this field is set to YES during database configuration, then the record is processed once at IOC initialization (before the normal scan tasks are started).<TR><br /> <TD>PHAS<TD>Scan Phase Number<TD>This field orders the records within a specific SCAN group. This is not meaningful for passive records. All records of a specified phase are processed before those with higher phase number. Whenever possible it is better to use linked passive records to enforce the order of processing rather than phase number.<TR><br /> <TD>EVNT<TD>Event Number<TD>Event number for scan type SCAN_EVENT. All records with scan type event and the same EVNT value will be processed when a call to post_event for EVNT is made. The call to post_event is: post_event(short event_number)<TR><br /> <TD>PRIO<TD>Priority<TD>Scheduling priority for processing I/O Event scanned records and asynchronous record completion tasks.<TR><br /> <TD>DISV<TD>Disable Value<TD>If DISV=DISA, then the record will be disabled, i.e. dbProcess will not process the record.<TR><br /> <TD>DISA<TD>Scan Disable Input Link Value<TD>This is the value that is compared with DISV to determine if the record is disabled. Its value is obtained via SDIS if SDIS is a database or channel access link. If SDIS is not a database or channel access link, then DISA can be set via dbPutField or dbPutLink.<TR><br /> <TD>SDIS<TD>Scan Disable Input Link<TD>An input link from which to obtain a value for DISA. This field is ignored unless it is a database link or a channel access link. If it is a database or a channel access link, dbProcess calls dbGetLink to obtain a value for DISA before deciding to call the processing routine.<TR><br /> <TD>PROC<TD>Process Record<TD>A record will be processed whenever a dbPutField is directed to this field.<TR><br /> <TD>DISS<TD>Disable Alarm Severity<TD>When this record is disabled, it will be put into alarm with this severity and a status of DISABLE_ALARM.<TR><br /> <TD>LSET<TD>Lock Set<TD>The lock set to which this record belongs. All records linked in any way via input, output, or forward database links belong to the same lock set. Lock sets are determined at IOC initialization time, and are updated whenever a database link is added, removed or altered.<TR><br /> <TD>LCNT<TD>Lock Count<TD>The number of times in succession dbProcess finds the record active, i.e. PACT is TRUE. If dbProcess finds the record active MAX_LOCK (currently set to 10) times in succession, it raises a SCAN_ALARM.<TR><br /> <TD>PACT<TD>Processing Active<TD>See Application Developers Guide for details on usage. PACT is TRUE while the record is being processed. For asynchronous records PACT can be TRUE from the time record processing is started until the asynchronous completion occurs. As long as PACT is TRUE, dbProcess will not call the record processing routine.<TR><br /> <TD>FLNK<TD>Forward Link<TD>This field is a database link. If FLNK is specified, processing this record will force a processing of the scan passive forward link record.<TR><br /> <TD>SPVT<TD>Scan Private<TD>This field is for private use of the scanning system.</TABLE><br /> <br /> === Alarm Fields ===<br /> <br /> These fields indicate the status and severity of alarms, or else determine the how and when alarms are triggered. For a further explanation of database alarms, see Alarm Specification, Chapter 1, 4. Of course, many records have alarm-related fields not common to all records. These fields are listed and explained in the appropriate chapter on each record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>STAT<TD>GBLCHOICE<TD>No<TD>UDF_ALARM<TD>Yes<TD>No<TD>Yes<TD><TR><br /> <TD>SEVR<TD>GBLCHOICE<TD>No<TD>INVALID_ALARM<TD>Yes<TD>No<TD>Yes<TD><TR><br /> <TD>NSTA<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD>No<TD><TR><br /> <TD>NSEV<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD>No<TD><TR><br /> <TD>ACKS<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD><TD>&nbsp;<TR><br /> <TD>ACKT<TD>GBLCHOICE<TD>No<TD>Yes<TD>Yes<TD>No<TD><TD>&nbsp;<TR><br /> <TD>UDF<TD>UCHAR<TD>No<TD>1<TD>Yes<TD>Yes<TD>No<TD>Yes</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>STAT<TD>Current Alarm Status<TD rowspan=4>These four fields are the alarm status and severity fields. STAT and SEVR are the values seen outside database access. NSTA and NSEV are the fields the database access, record support, and device support use to set new alarm status and severity values. Whenever any software component discovers an alarm condition, it uses the following macro function: recGblSetSevr(precord,new_status,new_severity) This ensures that the current alarm severity is set equal to the highest outstanding alarm. The file alarm.h defines all allowed alarm status and severity values.<TR><br /> <TD>SEVR<TD>Current Alarm Severity<TR><br /> <TD>NSTA<TD>New Alarm Status<TR><br /> <TD>NSEV<TD>New Alarm Severity<TR><br /> <TD>ACKS<TD>Alarm Acknowledge Severity<TD>Highest severity unacknowledged alarm<TR><br /> <TD>ACKT<TD>Alarm Acknowledge Transient<TD>Is it necessary to acknowledge transient alarms?<TR><br /> <TD>UDF<TD>VAL Undefined<TD>This indicates that the record has never been processed or its value is UnDeFined. Typically this is caused by a failure in device support, a record that has never been processed, or where the VAL field currently contains a NaN (not a number). UDF is initialized to TRUE at IOC initialization. Record and device support routines which write to the VAL field are responsible for setting UDF.</TABLE><br /> <br /> === Device Fields ===<br /> <br /> These fields contain information about the device and record support used by a record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>RSET<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DSET<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DPVT<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;</TABLE><br /> <br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>RSET<TD>Address of Record Support Entry Table<TD>See Application Developers Guide for details on usage.<TR><br /> <TD>DSET<TD>Address of Device Support Entry Table<TD>This address of the device support entry table for this record. The value of this field is determined at IOC initialization time. Record support routines use this field to locate their device support routines.<TR><br /> <TD>DPVT<TD>Device Private<TD>This field is for private use of the device support modules.</TABLE><br /> <br /> === Debugging Fields ===<br /> <br /> These fields can aid in the debugging process.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>TPRO<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>BKPT<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>TPRO<TD>Trace Processing<TD>If this field is set 1, a message is printed each time this record is processed and a message is printed for each record processed as a result of this record being processed<TR><br /> <TD>BKPT<TD>BreakPoint<TD>Indicates if there is a breakpoint set at this record. This supports setting a debug breakpoint in the record processing. STEP through database processing can be supported using this.</TABLE><br /> <br /> === Miscellaneous Fields ===<br /> <br /> These are miscellaneous fields common to all record types.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>NAME<TD>STRING [61]<TD>Yes<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DESC<TD>STRING [41]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>ASG<TD>STRING [29]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>&nbsp;<TR><br /> <TD>TSE<TD>SHORT<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>&nbsp;<TR><br /> <TD>TSEL<TD>INLINK<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>?<TD>No<TR><br /> <TD>DTYP<TD>DEVCHOICE<TD>Yes<TD>Soft Record Support<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>MLOK<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>MLIS<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DISP<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>Yes<TD>No<TR><br /> <TD>PUTF<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>RPRO<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>ASP<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PPN<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PPNR<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>RDES<TD>NO_ACCESS<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TR><br /> <TD>TIME<TD>NOACCESS<TD>No<TD>8<TD>Option<TD>No<TD>No<TD>No</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>NAME<TD>Record Name<TD>A 60 character record name supplied by the application developer. This name is the means of identifying a specific record. It must have a unique value across all IOCs attached to the same local area subnet, and should use only this limited set of characters: <tt>a-z A-Z 0-9 _ - : [ ] &lt; &gt; ;</tt><TR><br /> <TD>DESC<TD>Description<TD>An arbitrary 40 character record description supplied by the application developer.<TR><br /> <TD>ASG<TD>Access Security Group<TD>A character string value defining the access security group for this record. If left NULL, the record is placed in group DEFAULT.<TR><br /> <TD>TSEL<TD>Time Stamp Event Link<TD>An input link for obtaining the time stamp. If this link references the .TIME field of a record then the time stamp of the referenced record becomes the time stamp for this record as well. If any other field is referenced, the field value is read and stored in the .TSE field which is then used to acquire a timestamp.<TR><br /> <TD>TSE<TD>Time Stamp Event<TD>This indicates the mechanism to use to get the time stamp. '0' - call get time as before '-1' - call the time stamp driver and use the best source available. '-2' - the device support provides the time stamp from the hardware. Values between 1-255 request the time of the last occurance of a generalTime event.<br /> <TR><br /> <TD>DTYP<TD>Device Type<TD>This field specifies the device type for the record. Each record type has its own set of device support routines which are specified in devSup.ASCII. If a record type does not have any associated device support, DTYP and DSET are meaningless.<TR><br /> <TD>MLOK<TD>Monitor Lock<TD>The lock used by the monitor routines when the monitor list is being used. The list is locked whenever monitors are being scheduled, invoked, or when monitors are being added to or removed from the list. This field is accessed only by the dbEvent routines.<TR><br /> <TD>MLIS<TD>Monitor List<TD>This is the head of the list of monitors connected to this record. Each record support module is responsible for triggering monitors for any fields that change as a result of record processing. Monitors are present if mlis count is greater than zero. The call to trigger monitors is: db_post_event(precord,&amp;data,mask), where "mask" is some combination of DBE_ALARM, DBE_VALUE, and DBE_LOG.<TR><br /> <TD>DISP<TD>Disable putFields<TD>If this field is set to TRUE, then all dbPutFields (normally issued by channel access) directed to this record are ignored except to the field DISP itself.<TR><br /> <TD>PUTF<TD>dbPutField Process<TD>Did dbPutField cause the current record processing?<TR><br /> <TD>RPRO<TD>Reprocess<TD>Reprocess record when current processing completes.<TR><br /> <TD>ASP<TD>Access Security Private<TD>&nbsp;<TR><br /> <TD>PPN<TD>Address of putNotify<TD>Address of putNotify callback.<TR><br /> <TD>PPNR<TD>Next Record for putNotify<TD>Next record for PutNotify.<TR><br /> <TD>RDES<TD>Address of dbRecordType<TD>&nbsp;<TR><br /> <TD>TIME<TD>Time<TD>The time when this record was last processed, in standard format.</TABLE><br /> <br /> <br /> ----<br /> <br /> <br /> EPICS Record Reference Manual - 19 MAY 1998</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RRM_3-14_dbCommon&diff=1871 RRM 3-14 dbCommon 2010-09-27T19:11:49Z

<p>MichaelDavidsaver: switch order of TSE and TSEL. TSEL comes first</p> <hr /> <div>[[RRM 3-14|EPICS Record Reference Manual]]<br /> <br /> <br /> == Fields Common to All Record Types ==<br /> <br /> === Introduction ===<br /> <br /> This chapter contains a description of fields that are common to all records. These fields are defined in dbcommon.dbd.<br /> <br /> === Scan Fields ===<br /> <br /> These fields contain information related to how and when a record processes. For a further explanation of these record processing and these fields, see Scanning Specification, Chapter 1, 1. A few records have unique fields that also affect how they process. These fields, if any, will be listed and explained in the chapter for each record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><br /> <TR><br /> <TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<br /> <TH>PP<TR><br /> <TD>SCAN<TD>GBLCHOICE<TD>Yes<TD>Passive<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PINI<TD>GBLCHOICE<TD>Yes<TD>No<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PHAS<TD>SHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>EVNT<TD>SHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PRIO<TD>GBLCHOICE<TD>Yes<TD>Low<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>DISV<TD>SHORT<TD>Yes<TD>1<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>DISA<TD>SHORT<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>SDIS<TD>INLINK<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>N/A<TD>No<TR><br /> <TD>PROC<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>DISS<TD>GBLCHOICE<TD>Yes<TD>No Alarm<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>LCNT<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PACT<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>FLNK<TD>FWDLINK<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>N/A<TD>No&nbsp;<TR><br /> <TD>SPVT<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD></TABLE><br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>SCAN<TD>Scanning Rate<TD>This can be one of the periodic intervals (<CODE>.1 second</CODE>, <CODE>.2 second</CODE>, <CODE>.5 second</CODE>, <CODE>1 second</CODE>, <CODE>2 second</CODE>, <CODE>5 second</CODE>, <CODE>10 second</CODE>, <CODE>I/O Intr</CODE>, <CODE>Event</CODE>, or <CODE>Passive</CODE>.<TR><br /> <TD>PINI<TD>Process at Initialization<TD>If this field is set to YES during database configuration, then the record is processed once at IOC initialization (before the normal scan tasks are started).<TR><br /> <TD>PHAS<TD>Scan Phase Number<TD>This field orders the records within a specific SCAN group. This is not meaningful for passive records. All records of a specified phase are processed before those with higher phase number. Whenever possible it is better to use linked passive records to enforce the order of processing rather than phase number.<TR><br /> <TD>EVNT<TD>Event Number<TD>Event number for scan type SCAN_EVENT. All records with scan type event and the same EVNT value will be processed when a call to post_event for EVNT is made. The call to post_event is: post_event(short event_number)<TR><br /> <TD>PRIO<TD>Priority<TD>Scheduling priority for processing I/O Event scanned records and asynchronous record completion tasks.<TR><br /> <TD>DISV<TD>Disable Value<TD>If DISV=DISA, then the record will be disabled, i.e. dbProcess will not process the record.<TR><br /> <TD>DISA<TD>Scan Disable Input Link Value<TD>This is the value that is compared with DISV to determine if the record is disabled. Its value is obtained via SDIS if SDIS is a database or channel access link. If SDIS is not a database or channel access link, then DISA can be set via dbPutField or dbPutLink.<TR><br /> <TD>SDIS<TD>Scan Disable Input Link<TD>An input link from which to obtain a value for DISA. This field is ignored unless it is a database link or a channel access link. If it is a database or a channel access link, dbProcess calls dbGetLink to obtain a value for DISA before deciding to call the processing routine.<TR><br /> <TD>PROC<TD>Process Record<TD>A record will be processed whenever a dbPutField is directed to this field.<TR><br /> <TD>DISS<TD>Disable Alarm Severity<TD>When this record is disabled, it will be put into alarm with this severity and a status of DISABLE_ALARM.<TR><br /> <TD>LSET<TD>Lock Set<TD>The lock set to which this record belongs. All records linked in any way via input, output, or forward database links belong to the same lock set. Lock sets are determined at IOC initialization time, and are updated whenever a database link is added, removed or altered.<TR><br /> <TD>LCNT<TD>Lock Count<TD>The number of times in succession dbProcess finds the record active, i.e. PACT is TRUE. If dbProcess finds the record active MAX_LOCK (currently set to 10) times in succession, it raises a SCAN_ALARM.<TR><br /> <TD>PACT<TD>Processing Active<TD>See Application Developers Guide for details on usage. PACT is TRUE while the record is being processed. For asynchronous records PACT can be TRUE from the time record processing is started until the asynchronous completion occurs. As long as PACT is TRUE, dbProcess will not call the record processing routine.<TR><br /> <TD>FLNK<TD>Forward Link<TD>This field is a database link. If FLNK is specified, processing this record will force a processing of the scan passive forward link record.<TR><br /> <TD>SPVT<TD>Scan Private<TD>This field is for private use of the scanning system.</TABLE><br /> <br /> === Alarm Fields ===<br /> <br /> These fields indicate the status and severity of alarms, or else determine the how and when alarms are triggered. For a further explanation of database alarms, see Alarm Specification, Chapter 1, 4. Of course, many records have alarm-related fields not common to all records. These fields are listed and explained in the appropriate chapter on each record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>STAT<TD>GBLCHOICE<TD>No<TD>UDF_ALARM<TD>Yes<TD>No<TD>Yes<TD><TR><br /> <TD>SEVR<TD>GBLCHOICE<TD>No<TD>INVALID_ALARM<TD>Yes<TD>No<TD>Yes<TD><TR><br /> <TD>NSTA<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD>No<TD><TR><br /> <TD>NSEV<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD>No<TD><TR><br /> <TD>ACKS<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD><TD>&nbsp;<TR><br /> <TD>ACKT<TD>GBLCHOICE<TD>No<TD>Yes<TD>Yes<TD>No<TD><TD>&nbsp;<TR><br /> <TD>UDF<TD>UCHAR<TD>No<TD>1<TD>Yes<TD>Yes<TD>No<TD>Yes</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>STAT<TD>Current Alarm Status<TD rowspan=4>These four fields are the alarm status and severity fields. STAT and SEVR are the values seen outside database access. NSTA and NSEV are the fields the database access, record support, and device support use to set new alarm status and severity values. Whenever any software component discovers an alarm condition, it uses the following macro function: recGblSetSevr(precord,new_status,new_severity) This ensures that the current alarm severity is set equal to the highest outstanding alarm. The file alarm.h defines all allowed alarm status and severity values.<TR><br /> <TD>SEVR<TD>Current Alarm Severity<TR><br /> <TD>NSTA<TD>New Alarm Status<TR><br /> <TD>NSEV<TD>New Alarm Severity<TR><br /> <TD>ACKS<TD>Alarm Acknowledge Severity<TD>Highest severity unacknowledged alarm<TR><br /> <TD>ACKT<TD>Alarm Acknowledge Transient<TD>Is it necessary to acknowledge transient alarms?<TR><br /> <TD>UDF<TD>VAL Undefined<TD>This indicates that the record has never been processed or its value is UnDeFined. Typically this is caused by a failure in device support, a record that has never been processed, or where the VAL field currently contains a NaN (not a number). UDF is initialized to TRUE at IOC initialization. Record and device support routines which write to the VAL field are responsible for setting UDF.</TABLE><br /> <br /> === Device Fields ===<br /> <br /> These fields contain information about the device and record support used by a record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>RSET<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DSET<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DPVT<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;</TABLE><br /> <br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>RSET<TD>Address of Record Support Entry Table<TD>See Application Developers Guide for details on usage.<TR><br /> <TD>DSET<TD>Address of Device Support Entry Table<TD>This address of the device support entry table for this record. The value of this field is determined at IOC initialization time. Record support routines use this field to locate their device support routines.<TR><br /> <TD>DPVT<TD>Device Private<TD>This field is for private use of the device support modules.</TABLE><br /> <br /> === Debugging Fields ===<br /> <br /> These fields can aid in the debugging process.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>TPRO<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>BKPT<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>TPRO<TD>Trace Processing<TD>If this field is set 1, a message is printed each time this record is processed and a message is printed for each record processed as a result of this record being processed<TR><br /> <TD>BKPT<TD>BreakPoint<TD>Indicates if there is a breakpoint set at this record. This supports setting a debug breakpoint in the record processing. STEP through database processing can be supported using this.</TABLE><br /> <br /> === Miscellaneous Fields ===<br /> <br /> These are miscellaneous fields common to all record types.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>NAME<TD>STRING [61]<TD>Yes<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DESC<TD>STRING [41]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>ASG<TD>STRING [29]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>&nbsp;<TR><br /> <TD>TSE<TD>SHORT<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>&nbsp;<TR><br /> <TD>TSEL<TD>INLINK<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>?<TD>No<TR><br /> <TD>DTYP<TD>DEVCHOICE<TD>Yes<TD>Soft Record Support<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>MLOK<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>MLIS<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DISP<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>Yes<TD>No<TR><br /> <TD>PUTF<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>RPRO<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>ASP<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PPN<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PPNR<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>RDES<TD>NO_ACCESS<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TR><br /> <TD>TIME<TD>NOACCESS<TD>No<TD>8<TD>Option<TD>No<TD>No<TD>No</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>NAME<TD>Record Name<TD>A 60 character record name supplied by the application developer. This name is the means of identifying a specific record. It must have a unique value across all IOCs attached to the same local area subnet, and should use only this limited set of characters: <tt>a-z A-Z 0-9 _ - : [ ] &lt; &gt; ;</tt><TR><br /> <TD>DESC<TD>Description<TD>An arbitrary 40 character record description supplied by the application developer.<TR><br /> <TD>ASG<TD>Access Security Group<TD>A character string value defining the access security group for this record. If left NULL, the record is placed in group DEFAULT.<TR><br /> <TD>TSEL<TD>Time Stamp Event Link<TD>An input link for obtaining the time stamp. If this link references the .TIME field of a record then the time stamp of the referenced record becomes the time stamp for this record as well. If any other field is referenced, the field value is read and stored in the .TSE field which is then used to acquire a timestamp.<TR><br /> <TD>TSE<TD>Time Stamp Event<TD>This indicates the mechanism to use to get the time stamp. '0' - call get time as before '-1' - call the time stamp driver and use the best source available. '-2' - the device support provides the time stamp from the hardware.<TR><br /> <TD>DTYP<TD>Device Type<TD>This field specifies the device type for the record. Each record type has its own set of device support routines which are specified in devSup.ASCII. If a record type does not have any associated device support, DTYP and DSET are meaningless.<TR><br /> <TD>MLOK<TD>Monitor Lock<TD>The lock used by the monitor routines when the monitor list is being used. The list is locked whenever monitors are being scheduled, invoked, or when monitors are being added to or removed from the list. This field is accessed only by the dbEvent routines.<TR><br /> <TD>MLIS<TD>Monitor List<TD>This is the head of the list of monitors connected to this record. Each record support module is responsible for triggering monitors for any fields that change as a result of record processing. Monitors are present if mlis count is greater than zero. The call to trigger monitors is: db_post_event(precord,&amp;data,mask), where "mask" is some combination of DBE_ALARM, DBE_VALUE, and DBE_LOG.<TR><br /> <TD>DISP<TD>Disable putFields<TD>If this field is set to TRUE, then all dbPutFields (normally issued by channel access) directed to this record are ignored except to the field DISP itself.<TR><br /> <TD>PUTF<TD>dbPutField Process<TD>Did dbPutField cause the current record processing?<TR><br /> <TD>RPRO<TD>Reprocess<TD>Reprocess record when current processing completes.<TR><br /> <TD>ASP<TD>Access Security Private<TD>&nbsp;<TR><br /> <TD>PPN<TD>Address of putNotify<TD>Address of putNotify callback.<TR><br /> <TD>PPNR<TD>Next Record for putNotify<TD>Next record for PutNotify.<TR><br /> <TD>RDES<TD>Address of dbRecordType<TD>&nbsp;<TR><br /> <TD>TIME<TD>Time<TD>The time when this record was last processed, in standard format.</TABLE><br /> <br /> <br /> ----<br /> <br /> <br /> EPICS Record Reference Manual - 19 MAY 1998</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RRM_3-14_dbCommon&diff=1870 RRM 3-14 dbCommon 2010-09-27T19:10:57Z

<p>MichaelDavidsaver: TSEL missing behavour with TIME vs. other fields</p> <hr /> <div>[[RRM 3-14|EPICS Record Reference Manual]]<br /> <br /> <br /> == Fields Common to All Record Types ==<br /> <br /> === Introduction ===<br /> <br /> This chapter contains a description of fields that are common to all records. These fields are defined in dbcommon.dbd.<br /> <br /> === Scan Fields ===<br /> <br /> These fields contain information related to how and when a record processes. For a further explanation of these record processing and these fields, see Scanning Specification, Chapter 1, 1. A few records have unique fields that also affect how they process. These fields, if any, will be listed and explained in the chapter for each record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><br /> <TR><br /> <TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<br /> <TH>PP<TR><br /> <TD>SCAN<TD>GBLCHOICE<TD>Yes<TD>Passive<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PINI<TD>GBLCHOICE<TD>Yes<TD>No<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PHAS<TD>SHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>EVNT<TD>SHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PRIO<TD>GBLCHOICE<TD>Yes<TD>Low<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>DISV<TD>SHORT<TD>Yes<TD>1<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>DISA<TD>SHORT<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>SDIS<TD>INLINK<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>N/A<TD>No<TR><br /> <TD>PROC<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>DISS<TD>GBLCHOICE<TD>Yes<TD>No Alarm<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>LCNT<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PACT<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>FLNK<TD>FWDLINK<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>N/A<TD>No&nbsp;<TR><br /> <TD>SPVT<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD></TABLE><br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>SCAN<TD>Scanning Rate<TD>This can be one of the periodic intervals (<CODE>.1 second</CODE>, <CODE>.2 second</CODE>, <CODE>.5 second</CODE>, <CODE>1 second</CODE>, <CODE>2 second</CODE>, <CODE>5 second</CODE>, <CODE>10 second</CODE>, <CODE>I/O Intr</CODE>, <CODE>Event</CODE>, or <CODE>Passive</CODE>.<TR><br /> <TD>PINI<TD>Process at Initialization<TD>If this field is set to YES during database configuration, then the record is processed once at IOC initialization (before the normal scan tasks are started).<TR><br /> <TD>PHAS<TD>Scan Phase Number<TD>This field orders the records within a specific SCAN group. This is not meaningful for passive records. All records of a specified phase are processed before those with higher phase number. Whenever possible it is better to use linked passive records to enforce the order of processing rather than phase number.<TR><br /> <TD>EVNT<TD>Event Number<TD>Event number for scan type SCAN_EVENT. All records with scan type event and the same EVNT value will be processed when a call to post_event for EVNT is made. The call to post_event is: post_event(short event_number)<TR><br /> <TD>PRIO<TD>Priority<TD>Scheduling priority for processing I/O Event scanned records and asynchronous record completion tasks.<TR><br /> <TD>DISV<TD>Disable Value<TD>If DISV=DISA, then the record will be disabled, i.e. dbProcess will not process the record.<TR><br /> <TD>DISA<TD>Scan Disable Input Link Value<TD>This is the value that is compared with DISV to determine if the record is disabled. Its value is obtained via SDIS if SDIS is a database or channel access link. If SDIS is not a database or channel access link, then DISA can be set via dbPutField or dbPutLink.<TR><br /> <TD>SDIS<TD>Scan Disable Input Link<TD>An input link from which to obtain a value for DISA. This field is ignored unless it is a database link or a channel access link. If it is a database or a channel access link, dbProcess calls dbGetLink to obtain a value for DISA before deciding to call the processing routine.<TR><br /> <TD>PROC<TD>Process Record<TD>A record will be processed whenever a dbPutField is directed to this field.<TR><br /> <TD>DISS<TD>Disable Alarm Severity<TD>When this record is disabled, it will be put into alarm with this severity and a status of DISABLE_ALARM.<TR><br /> <TD>LSET<TD>Lock Set<TD>The lock set to which this record belongs. All records linked in any way via input, output, or forward database links belong to the same lock set. Lock sets are determined at IOC initialization time, and are updated whenever a database link is added, removed or altered.<TR><br /> <TD>LCNT<TD>Lock Count<TD>The number of times in succession dbProcess finds the record active, i.e. PACT is TRUE. If dbProcess finds the record active MAX_LOCK (currently set to 10) times in succession, it raises a SCAN_ALARM.<TR><br /> <TD>PACT<TD>Processing Active<TD>See Application Developers Guide for details on usage. PACT is TRUE while the record is being processed. For asynchronous records PACT can be TRUE from the time record processing is started until the asynchronous completion occurs. As long as PACT is TRUE, dbProcess will not call the record processing routine.<TR><br /> <TD>FLNK<TD>Forward Link<TD>This field is a database link. If FLNK is specified, processing this record will force a processing of the scan passive forward link record.<TR><br /> <TD>SPVT<TD>Scan Private<TD>This field is for private use of the scanning system.</TABLE><br /> <br /> === Alarm Fields ===<br /> <br /> These fields indicate the status and severity of alarms, or else determine the how and when alarms are triggered. For a further explanation of database alarms, see Alarm Specification, Chapter 1, 4. Of course, many records have alarm-related fields not common to all records. These fields are listed and explained in the appropriate chapter on each record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>STAT<TD>GBLCHOICE<TD>No<TD>UDF_ALARM<TD>Yes<TD>No<TD>Yes<TD><TR><br /> <TD>SEVR<TD>GBLCHOICE<TD>No<TD>INVALID_ALARM<TD>Yes<TD>No<TD>Yes<TD><TR><br /> <TD>NSTA<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD>No<TD><TR><br /> <TD>NSEV<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD>No<TD><TR><br /> <TD>ACKS<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD><TD>&nbsp;<TR><br /> <TD>ACKT<TD>GBLCHOICE<TD>No<TD>Yes<TD>Yes<TD>No<TD><TD>&nbsp;<TR><br /> <TD>UDF<TD>UCHAR<TD>No<TD>1<TD>Yes<TD>Yes<TD>No<TD>Yes</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>STAT<TD>Current Alarm Status<TD rowspan=4>These four fields are the alarm status and severity fields. STAT and SEVR are the values seen outside database access. NSTA and NSEV are the fields the database access, record support, and device support use to set new alarm status and severity values. Whenever any software component discovers an alarm condition, it uses the following macro function: recGblSetSevr(precord,new_status,new_severity) This ensures that the current alarm severity is set equal to the highest outstanding alarm. The file alarm.h defines all allowed alarm status and severity values.<TR><br /> <TD>SEVR<TD>Current Alarm Severity<TR><br /> <TD>NSTA<TD>New Alarm Status<TR><br /> <TD>NSEV<TD>New Alarm Severity<TR><br /> <TD>ACKS<TD>Alarm Acknowledge Severity<TD>Highest severity unacknowledged alarm<TR><br /> <TD>ACKT<TD>Alarm Acknowledge Transient<TD>Is it necessary to acknowledge transient alarms?<TR><br /> <TD>UDF<TD>VAL Undefined<TD>This indicates that the record has never been processed or its value is UnDeFined. Typically this is caused by a failure in device support, a record that has never been processed, or where the VAL field currently contains a NaN (not a number). UDF is initialized to TRUE at IOC initialization. Record and device support routines which write to the VAL field are responsible for setting UDF.</TABLE><br /> <br /> === Device Fields ===<br /> <br /> These fields contain information about the device and record support used by a record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>RSET<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DSET<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DPVT<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;</TABLE><br /> <br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>RSET<TD>Address of Record Support Entry Table<TD>See Application Developers Guide for details on usage.<TR><br /> <TD>DSET<TD>Address of Device Support Entry Table<TD>This address of the device support entry table for this record. The value of this field is determined at IOC initialization time. Record support routines use this field to locate their device support routines.<TR><br /> <TD>DPVT<TD>Device Private<TD>This field is for private use of the device support modules.</TABLE><br /> <br /> === Debugging Fields ===<br /> <br /> These fields can aid in the debugging process.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>TPRO<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>BKPT<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>TPRO<TD>Trace Processing<TD>If this field is set 1, a message is printed each time this record is processed and a message is printed for each record processed as a result of this record being processed<TR><br /> <TD>BKPT<TD>BreakPoint<TD>Indicates if there is a breakpoint set at this record. This supports setting a debug breakpoint in the record processing. STEP through database processing can be supported using this.</TABLE><br /> <br /> === Miscellaneous Fields ===<br /> <br /> These are miscellaneous fields common to all record types.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>NAME<TD>STRING [61]<TD>Yes<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DESC<TD>STRING [41]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>ASG<TD>STRING [29]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>&nbsp;<TR><br /> <TD>TSE<TD>SHORT<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>&nbsp;<TR><br /> <TD>TSEL<TD>INLINK<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>?<TD>No<TR><br /> <TD>DTYP<TD>DEVCHOICE<TD>Yes<TD>Soft Record Support<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>MLOK<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>MLIS<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DISP<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>Yes<TD>No<TR><br /> <TD>PUTF<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>RPRO<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>ASP<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PPN<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PPNR<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>RDES<TD>NO_ACCESS<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TR><br /> <TD>TIME<TD>NOACCESS<TD>No<TD>8<TD>Option<TD>No<TD>No<TD>No</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>NAME<TD>Record Name<TD>A 60 character record name supplied by the application developer. This name is the means of identifying a specific record. It must have a unique value across all IOCs attached to the same local area subnet, and should use only this limited set of characters: <tt>a-z A-Z 0-9 _ - : [ ] &lt; &gt; ;</tt><TR><br /> <TD>DESC<TD>Description<TD>An arbitrary 40 character record description supplied by the application developer.<TR><br /> <TD>ASG<TD>Access Security Group<TD>A character string value defining the access security group for this record. If left NULL, the record is placed in group DEFAULT.<TR><br /> <TD>TSE<TD>Time Stamp Event<TD>This indicates the mechanism to use to get the time stamp. '0' - call get time as before '-1' - call the time stamp driver and use the best source available. '-2' - the device support provides the time stamp from the hardware.<TR><br /> <TD>TSEL<TD>Time Stamp Event Link<TD>An input link for obtaining the time stamp. If this link references the .TIME field of a record then the time stamp of the referenced record becomes the time stamp for this record as well. If any other field is referenced, the field value is read and stored in the .TSE field which is then used to acquire a timestamp.<TR><br /> <TD>DTYP<TD>Device Type<TD>This field specifies the device type for the record. Each record type has its own set of device support routines which are specified in devSup.ASCII. If a record type does not have any associated device support, DTYP and DSET are meaningless.<TR><br /> <TD>MLOK<TD>Monitor Lock<TD>The lock used by the monitor routines when the monitor list is being used. The list is locked whenever monitors are being scheduled, invoked, or when monitors are being added to or removed from the list. This field is accessed only by the dbEvent routines.<TR><br /> <TD>MLIS<TD>Monitor List<TD>This is the head of the list of monitors connected to this record. Each record support module is responsible for triggering monitors for any fields that change as a result of record processing. Monitors are present if mlis count is greater than zero. The call to trigger monitors is: db_post_event(precord,&amp;data,mask), where "mask" is some combination of DBE_ALARM, DBE_VALUE, and DBE_LOG.<TR><br /> <TD>DISP<TD>Disable putFields<TD>If this field is set to TRUE, then all dbPutFields (normally issued by channel access) directed to this record are ignored except to the field DISP itself.<TR><br /> <TD>PUTF<TD>dbPutField Process<TD>Did dbPutField cause the current record processing?<TR><br /> <TD>RPRO<TD>Reprocess<TD>Reprocess record when current processing completes.<TR><br /> <TD>ASP<TD>Access Security Private<TD>&nbsp;<TR><br /> <TD>PPN<TD>Address of putNotify<TD>Address of putNotify callback.<TR><br /> <TD>PPNR<TD>Next Record for putNotify<TD>Next record for PutNotify.<TR><br /> <TD>RDES<TD>Address of dbRecordType<TD>&nbsp;<TR><br /> <TD>TIME<TD>Time<TD>The time when this record was last processed, in standard format.</TABLE><br /> <br /> <br /> ----<br /> <br /> <br /> EPICS Record Reference Manual - 19 MAY 1998</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RRM_3-14_dbCommon&diff=1869 RRM 3-14 dbCommon 2010-09-17T15:48:52Z

<p>MichaelDavidsaver: TSE field special values are negative (-1 and -2)</p> <hr /> <div>[[RRM 3-14|EPICS Record Reference Manual]]<br /> <br /> <br /> == Fields Common to All Record Types ==<br /> <br /> === Introduction ===<br /> <br /> This chapter contains a description of fields that are common to all records. These fields are defined in dbcommon.dbd.<br /> <br /> === Scan Fields ===<br /> <br /> These fields contain information related to how and when a record processes. For a further explanation of these record processing and these fields, see Scanning Specification, Chapter 1, 1. A few records have unique fields that also affect how they process. These fields, if any, will be listed and explained in the chapter for each record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><br /> <TR><br /> <TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<br /> <TH>PP<TR><br /> <TD>SCAN<TD>GBLCHOICE<TD>Yes<TD>Passive<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PINI<TD>GBLCHOICE<TD>Yes<TD>No<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PHAS<TD>SHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>EVNT<TD>SHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>PRIO<TD>GBLCHOICE<TD>Yes<TD>Low<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>DISV<TD>SHORT<TD>Yes<TD>1<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>DISA<TD>SHORT<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>SDIS<TD>INLINK<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>N/A<TD>No<TR><br /> <TD>PROC<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>DISS<TD>GBLCHOICE<TD>Yes<TD>No Alarm<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>LCNT<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PACT<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>FLNK<TD>FWDLINK<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>N/A<TD>No&nbsp;<TR><br /> <TD>SPVT<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD></TABLE><br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>SCAN<TD>Scanning Rate<TD>This can be one of the periodic intervals (<CODE>.1 second</CODE>, <CODE>.2 second</CODE>, <CODE>.5 second</CODE>, <CODE>1 second</CODE>, <CODE>2 second</CODE>, <CODE>5 second</CODE>, <CODE>10 second</CODE>, <CODE>I/O Intr</CODE>, <CODE>Event</CODE>, or <CODE>Passive</CODE>.<TR><br /> <TD>PINI<TD>Process at Initialization<TD>If this field is set to YES during database configuration, then the record is processed once at IOC initialization (before the normal scan tasks are started).<TR><br /> <TD>PHAS<TD>Scan Phase Number<TD>This field orders the records within a specific SCAN group. This is not meaningful for passive records. All records of a specified phase are processed before those with higher phase number. Whenever possible it is better to use linked passive records to enforce the order of processing rather than phase number.<TR><br /> <TD>EVNT<TD>Event Number<TD>Event number for scan type SCAN_EVENT. All records with scan type event and the same EVNT value will be processed when a call to post_event for EVNT is made. The call to post_event is: post_event(short event_number)<TR><br /> <TD>PRIO<TD>Priority<TD>Scheduling priority for processing I/O Event scanned records and asynchronous record completion tasks.<TR><br /> <TD>DISV<TD>Disable Value<TD>If DISV=DISA, then the record will be disabled, i.e. dbProcess will not process the record.<TR><br /> <TD>DISA<TD>Scan Disable Input Link Value<TD>This is the value that is compared with DISV to determine if the record is disabled. Its value is obtained via SDIS if SDIS is a database or channel access link. If SDIS is not a database or channel access link, then DISA can be set via dbPutField or dbPutLink.<TR><br /> <TD>SDIS<TD>Scan Disable Input Link<TD>An input link from which to obtain a value for DISA. This field is ignored unless it is a database link or a channel access link. If it is a database or a channel access link, dbProcess calls dbGetLink to obtain a value for DISA before deciding to call the processing routine.<TR><br /> <TD>PROC<TD>Process Record<TD>A record will be processed whenever a dbPutField is directed to this field.<TR><br /> <TD>DISS<TD>Disable Alarm Severity<TD>When this record is disabled, it will be put into alarm with this severity and a status of DISABLE_ALARM.<TR><br /> <TD>LSET<TD>Lock Set<TD>The lock set to which this record belongs. All records linked in any way via input, output, or forward database links belong to the same lock set. Lock sets are determined at IOC initialization time, and are updated whenever a database link is added, removed or altered.<TR><br /> <TD>LCNT<TD>Lock Count<TD>The number of times in succession dbProcess finds the record active, i.e. PACT is TRUE. If dbProcess finds the record active MAX_LOCK (currently set to 10) times in succession, it raises a SCAN_ALARM.<TR><br /> <TD>PACT<TD>Processing Active<TD>See Application Developers Guide for details on usage. PACT is TRUE while the record is being processed. For asynchronous records PACT can be TRUE from the time record processing is started until the asynchronous completion occurs. As long as PACT is TRUE, dbProcess will not call the record processing routine.<TR><br /> <TD>FLNK<TD>Forward Link<TD>This field is a database link. If FLNK is specified, processing this record will force a processing of the scan passive forward link record.<TR><br /> <TD>SPVT<TD>Scan Private<TD>This field is for private use of the scanning system.</TABLE><br /> <br /> === Alarm Fields ===<br /> <br /> These fields indicate the status and severity of alarms, or else determine the how and when alarms are triggered. For a further explanation of database alarms, see Alarm Specification, Chapter 1, 4. Of course, many records have alarm-related fields not common to all records. These fields are listed and explained in the appropriate chapter on each record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>STAT<TD>GBLCHOICE<TD>No<TD>UDF_ALARM<TD>Yes<TD>No<TD>Yes<TD><TR><br /> <TD>SEVR<TD>GBLCHOICE<TD>No<TD>INVALID_ALARM<TD>Yes<TD>No<TD>Yes<TD><TR><br /> <TD>NSTA<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD>No<TD><TR><br /> <TD>NSEV<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD>No<TD><TR><br /> <TD>ACKS<TD>GBLCHOICE<TD>No<TD>No Alarm<TD>Yes<TD>No<TD><TD>&nbsp;<TR><br /> <TD>ACKT<TD>GBLCHOICE<TD>No<TD>Yes<TD>Yes<TD>No<TD><TD>&nbsp;<TR><br /> <TD>UDF<TD>UCHAR<TD>No<TD>1<TD>Yes<TD>Yes<TD>No<TD>Yes</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>STAT<TD>Current Alarm Status<TD rowspan=4>These four fields are the alarm status and severity fields. STAT and SEVR are the values seen outside database access. NSTA and NSEV are the fields the database access, record support, and device support use to set new alarm status and severity values. Whenever any software component discovers an alarm condition, it uses the following macro function: recGblSetSevr(precord,new_status,new_severity) This ensures that the current alarm severity is set equal to the highest outstanding alarm. The file alarm.h defines all allowed alarm status and severity values.<TR><br /> <TD>SEVR<TD>Current Alarm Severity<TR><br /> <TD>NSTA<TD>New Alarm Status<TR><br /> <TD>NSEV<TD>New Alarm Severity<TR><br /> <TD>ACKS<TD>Alarm Acknowledge Severity<TD>Highest severity unacknowledged alarm<TR><br /> <TD>ACKT<TD>Alarm Acknowledge Transient<TD>Is it necessary to acknowledge transient alarms?<TR><br /> <TD>UDF<TD>VAL Undefined<TD>This indicates that the record has never been processed or its value is UnDeFined. Typically this is caused by a failure in device support, a record that has never been processed, or where the VAL field currently contains a NaN (not a number). UDF is initialized to TRUE at IOC initialization. Record and device support routines which write to the VAL field are responsible for setting UDF.</TABLE><br /> <br /> === Device Fields ===<br /> <br /> These fields contain information about the device and record support used by a record.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>RSET<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DSET<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DPVT<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;</TABLE><br /> <br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>RSET<TD>Address of Record Support Entry Table<TD>See Application Developers Guide for details on usage.<TR><br /> <TD>DSET<TD>Address of Device Support Entry Table<TD>This address of the device support entry table for this record. The value of this field is determined at IOC initialization time. Record support routines use this field to locate their device support routines.<TR><br /> <TD>DPVT<TD>Device Private<TD>This field is for private use of the device support modules.</TABLE><br /> <br /> === Debugging Fields ===<br /> <br /> These fields can aid in the debugging process.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>TPRO<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>BKPT<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>TPRO<TD>Trace Processing<TD>If this field is set 1, a message is printed each time this record is processed and a message is printed for each record processed as a result of this record being processed<TR><br /> <TD>BKPT<TD>BreakPoint<TD>Indicates if there is a breakpoint set at this record. This supports setting a debug breakpoint in the record processing. STEP through database processing can be supported using this.</TABLE><br /> <br /> === Miscellaneous Fields ===<br /> <br /> These are miscellaneous fields common to all record types.<br /> <br /> ==== Field Summary ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Field<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>NAME<TD>STRING [61]<TD>Yes<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DESC<TD>STRING [41]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>ASG<TD>STRING [29]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>&nbsp;<TR><br /> <TD>TSE<TD>SHORT<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>&nbsp;<TR><br /> <TD>TSEL<TD>INLINK<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>?<TD>No<TR><br /> <TD>DTYP<TD>DEVCHOICE<TD>Yes<TD>Soft Record Support<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>MLOK<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>MLIS<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>DISP<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>Yes<TD>Yes<TD>No<TR><br /> <TD>PUTF<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>RPRO<TD>UCHAR<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>ASP<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PPN<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>PPNR<TD>NOACCESS<TD>No<TD>4<TD>No<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>RDES<TD>NO_ACCESS<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TD>&nbsp;<TR><br /> <TD>TIME<TD>NOACCESS<TD>No<TD>8<TD>Option<TD>No<TD>No<TD>No</TABLE><br /> <br /> ==== Field Description ====<br /> <br /> <br /> <TABLE BORDER="1"><TH>Name<TH>Summary<TH>Description<TR><br /> <TD>NAME<TD>Record Name<TD>A 60 character record name supplied by the application developer. This name is the means of identifying a specific record. It must have a unique value across all IOCs attached to the same local area subnet, and should use only this limited set of characters: <tt>a-z A-Z 0-9 _ - : [ ] &lt; &gt; ;</tt><TR><br /> <TD>DESC<TD>Description<TD>An arbitrary 40 character record description supplied by the application developer.<TR><br /> <TD>ASG<TD>Access Security Group<TD>A character string value defining the access security group for this record. If left NULL, the record is placed in group DEFAULT.<TR><br /> <TD>TSE<TD>Time Stamp Event<TD>This indicates the mechanism to use to get the time stamp. '0' - call get time as before '-1' - call the time stamp driver and use the best source available. '-2' - the device support provides the time stamp from the hardware.<TR><br /> <TD>TSEL<TD>Time Stamp Event Link<TD>An input link for obtaining the time stamp. If this link is defined the time stamp of the referenced record becomes the time stamp for this record as well. This mechanism allows things like calculation records to use the time stamp from a device support routine that has an event time stamp for instance.<TR><br /> <TD>DTYP<TD>Device Type<TD>This field specifies the device type for the record. Each record type has its own set of device support routines which are specified in devSup.ASCII. If a record type does not have any associated device support, DTYP and DSET are meaningless.<TR><br /> <TD>MLOK<TD>Monitor Lock<TD>The lock used by the monitor routines when the monitor list is being used. The list is locked whenever monitors are being scheduled, invoked, or when monitors are being added to or removed from the list. This field is accessed only by the dbEvent routines.<TR><br /> <TD>MLIS<TD>Monitor List<TD>This is the head of the list of monitors connected to this record. Each record support module is responsible for triggering monitors for any fields that change as a result of record processing. Monitors are present if mlis count is greater than zero. The call to trigger monitors is: db_post_event(precord,&amp;data,mask), where "mask" is some combination of DBE_ALARM, DBE_VALUE, and DBE_LOG.<TR><br /> <TD>DISP<TD>Disable putFields<TD>If this field is set to TRUE, then all dbPutFields (normally issued by channel access) directed to this record are ignored except to the field DISP itself.<TR><br /> <TD>PUTF<TD>dbPutField Process<TD>Did dbPutField cause the current record processing?<TR><br /> <TD>RPRO<TD>Reprocess<TD>Reprocess record when current processing completes.<TR><br /> <TD>ASP<TD>Access Security Private<TD>&nbsp;<TR><br /> <TD>PPN<TD>Address of putNotify<TD>Address of putNotify callback.<TR><br /> <TD>PPNR<TD>Next Record for putNotify<TD>Next record for PutNotify.<TR><br /> <TD>RDES<TD>Address of dbRecordType<TD>&nbsp;<TR><br /> <TD>TIME<TD>Time<TD>The time when this record was last processed, in standard format.</TABLE><br /> <br /> <br /> ----<br /> <br /> <br /> EPICS Record Reference Manual - 19 MAY 1998</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Epicsparamconf&diff=2935 Epicsparamconf 2010-06-29T18:00:14Z

<p>MichaelDavidsaver: /* INI style section headers '\s*\^\+\]\s*$' */</p> <hr /> <div>= EPICS Config Parameters API =<br /> <br /> Author: Michael Davidsaver <mdavidsaver@bnl.gov><br /> Date: June 2010<br /> <br /> == Purpose ==<br /> <br /> Proposal for 3.15 series<br /> <br /> Replace the API in envDefs.h with a more general purpose startup config.<br /> <br /> * New parameters can be created at runtime by applications outside of Base (ie EDM).<br /> * Provide a specification for a configuration mechanism which can be shared by all EPICS implimentations.<br /> * Values will be taken from configuration file(s) in addition to the nvironment.<br /> * Supports types: String, Int32, Double, and InetAddr (IPv4).<br /> * Transparent handling of parameter arrays.<br /> <br /> == API ==<br /> <br /> === Types ===<br /> <br /> enum paramType {<br /> paramTypeInvalid,<br /> paramTypeString,<br /> paramTypeInt32,<br /> paramTypeDouble,<br /> paramTypeInetAddr<br /> };<br /> <br /> === Creation ===<br /> <br /> int<br /> paramArrayCreate(const char* name, paramType tp, epicsUInt32 maxelem, char sep, epicsUInt32 opt);<br /> <br /> #define paramCreate(name,tp,opt) paramArrayCreate(name,tp,1,NULL,opt)<br /> <br /> Creates a new parameter with the given value type. If number of elements is >1 and<br /> a separator string is not given then the default separator (OS dependent) is used.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Include environment variable in search path<br /> |-<br /> |1<br /> |Store value in environment variable<br /> |-<br /> |2<br /> |Don't strip leading and trailing whitespace<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name already exists<br /> |-<br /> | -2<br /> |Invalid arguments (ie nelem==0)<br /> |-<br /> | -3<br /> |Insufficient memory<br /> |}<br /> <br /> === Setting ===<br /> <br /> int<br /> paramArraySetString(const char* name, epicsUInt32 nelem, const char* const* val, epicsUInt32 opt)<br /> /* 3 more for other types */<br /> <br /> #define paramSetString(name, val, opt) paramArraySetString(name, 1, &(val), opt)<br /> /* 3 more for other types */<br /> <br /> Sets the value of an already created parameter. A value of NULL will clear the<br /> parameter value/default.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> bit #<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Set default. Overwrite the default value instead of the final value.<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name does not exist<br /> |}<br /> <br /> === Getting ===<br /> <br /> extern const void* paramNone;<br /> extern const void* paramConvertFail;<br /> extern const void* paramNotReal;<br /> <br /> INLINE epicsBoolean<br /> paramValidValue(const void* V)<br /> {<br /> switch(V) {<br /> case NULL:<br /> case paramNone:<br /> case paramConvertFail:<br /> case paramNotReal:<br /> return epicsFalse;<br /> default:<br /> return epicsTrue;<br /> }<br /> }<br /> <br /> const char* const*<br /> paramArrayGetString(const char* name, epicsUInt32 *nelem, epicsUInt32 opt);<br /> /* 3 more for other types */<br /> <br /> INLINE const char*<br /> paramGetString(const char* name, epicsUInt32 opt)<br /> {<br /> epicsUInt32 N;<br /> const char* const* V=paramArrayGetString(name, 1, opt);<br /> if (!paramValidValue((const void*)V)) return (const char*)V;<br /> else return *V;<br /> }<br /> /* 3 more for other types */<br /> <br /> Gets the value of an already created parameter<br /> <br /> Note: Type-safe Getters will also be provided (ie paramArrayGetDouble())<br /> <br /> Note: Type paramTypeString returns C type const char* const*.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |paramNone<br /> |Value not found<br /> |-<br /> |paramNotReal<br /> |Parameter name does not exist<br /> |-<br /> |paramConvertFail<br /> |Value could not be converted to requested type<br /> |-<br /> |NULL<br /> |Zero length array (nelems also set to 0)<br /> |-<br /> |others<br /> |Value pointer (dependent of type)<br /> |}<br /> <br /> === Misc ===<br /> <br /> paramType<br /> paramGetType(const char* name);<br /> <br /> Get type of parameter or paramTypeInvalid if parameter does not exist.<br /> <br /> epicsUInt32<br /> paramGetNElem(const char* name);<br /> <br /> Get number of entries or 0 if parameter does not exist (use paramGetType()<br /> to distinguish between a 0 length array and an invalid name).<br /> <br /> char<br /> paramGetSep(const char* name);<br /> <br /> Get seperator string or NULL if parameter does not exist.<br /> <br /> void<br /> paramVisitAll(void *arg, void (*fnptr)(void*, const char* name));<br /> <br /> Get a callback for each parameter.<br /> <br /> void<br /> paramShowAll(int verbose);<br /> <br /> Print parameter info to standard out. Argument controls verbosity (larger -> more detail).<br /> <br /> == Values ==<br /> <br /> All values are stored as strings, but may be requested as any type.<br /> <br /> Parameters can have the special value paramNone. This is distinct from a zero length array.<br /> When created all parameters initially have paramNone as a default value.<br /> <br /> == Value Reread ==<br /> <br /> The value of a parameter is determined when its value is retrieved with paramArrayGet()<br /> and stored for future use. Unless the reread option is given further calls to paramArrayGet()<br /> will return the same value. If the reread option is given then paramArrayGet() will<br /> start a new search and store the (possible different) value for future use.<br /> <br /> If a parameter is ever to be reread then the reread option must be given when<br /> the parameter is created.<br /> <br /> Note: Rereading a parameter invalidates all value pointers previously returned.<br /> <br /> == Search Path ==<br /> <br /> Value may be found in the following locations. The first value found will be used.<br /> <br /> # Current value<br /> # Environment<br /> # Files (OS dependent)<br /> # Default value<br /> <br /> The file search path is defined by the environment variable (EPICS_CONF_PATH).<br /> The default value is set in CONFIG_ENV at compile time. Since this parameter<br /> is read before the first file is searched it can not be specified in a file.<br /> <br /> Entries in the search path may use arbitrary environment variables (macLib syntax).<br /> <br /> === Default UNIX-like search path ===<br /> <br /> # ./epics.conf<br /> # $HOME/epics.conf<br /> # $EPICS_BASE/epics.conf<br /> # /etc/epics.conf<br /> <br /> === Default Windows search path ===<br /> <br /> # .\epics.conf<br /> # $USERPROFILE\epics.conf<br /> # $EPICS_BASE\epics.conf<br /> # $ALLUSERSPROFILE\epics.conf<br /> <br /> ==== On windows xp ====<br /> <br /> USERPROFILE=C:\Documents and Settings\username<br /> ALLUSERSPROFILE=C:\Documents and Settings\All Users<br /> <br /> ==== On windows vista/7 ====<br /> <br /> USERPROFILE=C:\Users\username<br /> ALLUSERSPROFILE=C:\ProgramData<br /> <br /> === Default VxWorks and RTEMS search path ===<br /> <br /> None<br /> <br /> == Config File Syntax ==<br /> <br /> Files specifying parameter values shall have lines of the following format.<br /> Lines may be seperated by one of the valid EOL combinations (cr, lf, cr+lf, lf+cr).<br /> <br /> === Blank lines '^\s*$' ===<br /> <br /> Ignored<br /> <br /> === Comments '^\s*#.*$' ===<br /> <br /> Ignored<br /> <br /> === key value pairs '^\s*[^\s=]+\s*=.*$' ===<br /> <br /> When parsing files key names can contain any non-whitespace charactor except '='.<br /> However, keys being stored in the environment must also be valid environment variable names.<br /> <br /> === INI style section headers '\s*\[ [^\] ]+\]\s*$' ===<br /> <br /> Reserved for future use. Parsing stops when the first section header is found.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Epicsparamconf&diff=1859 Epicsparamconf 2010-06-29T17:59:29Z

<p>MichaelDavidsaver: /* INI style section headers '\s*\[[^\[]+\]\s*$' */</p> <hr /> <div>= EPICS Config Parameters API =<br /> <br /> Author: Michael Davidsaver <mdavidsaver@bnl.gov><br /> Date: June 2010<br /> <br /> == Purpose ==<br /> <br /> Proposal for 3.15 series<br /> <br /> Replace the API in envDefs.h with a more general purpose startup config.<br /> <br /> * New parameters can be created at runtime by applications outside of Base (ie EDM).<br /> * Provide a specification for a configuration mechanism which can be shared by all EPICS implimentations.<br /> * Values will be taken from configuration file(s) in addition to the nvironment.<br /> * Supports types: String, Int32, Double, and InetAddr (IPv4).<br /> * Transparent handling of parameter arrays.<br /> <br /> == API ==<br /> <br /> === Types ===<br /> <br /> enum paramType {<br /> paramTypeInvalid,<br /> paramTypeString,<br /> paramTypeInt32,<br /> paramTypeDouble,<br /> paramTypeInetAddr<br /> };<br /> <br /> === Creation ===<br /> <br /> int<br /> paramArrayCreate(const char* name, paramType tp, epicsUInt32 maxelem, char sep, epicsUInt32 opt);<br /> <br /> #define paramCreate(name,tp,opt) paramArrayCreate(name,tp,1,NULL,opt)<br /> <br /> Creates a new parameter with the given value type. If number of elements is >1 and<br /> a separator string is not given then the default separator (OS dependent) is used.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Include environment variable in search path<br /> |-<br /> |1<br /> |Store value in environment variable<br /> |-<br /> |2<br /> |Don't strip leading and trailing whitespace<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name already exists<br /> |-<br /> | -2<br /> |Invalid arguments (ie nelem==0)<br /> |-<br /> | -3<br /> |Insufficient memory<br /> |}<br /> <br /> === Setting ===<br /> <br /> int<br /> paramArraySetString(const char* name, epicsUInt32 nelem, const char* const* val, epicsUInt32 opt)<br /> /* 3 more for other types */<br /> <br /> #define paramSetString(name, val, opt) paramArraySetString(name, 1, &(val), opt)<br /> /* 3 more for other types */<br /> <br /> Sets the value of an already created parameter. A value of NULL will clear the<br /> parameter value/default.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> bit #<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Set default. Overwrite the default value instead of the final value.<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name does not exist<br /> |}<br /> <br /> === Getting ===<br /> <br /> extern const void* paramNone;<br /> extern const void* paramConvertFail;<br /> extern const void* paramNotReal;<br /> <br /> INLINE epicsBoolean<br /> paramValidValue(const void* V)<br /> {<br /> switch(V) {<br /> case NULL:<br /> case paramNone:<br /> case paramConvertFail:<br /> case paramNotReal:<br /> return epicsFalse;<br /> default:<br /> return epicsTrue;<br /> }<br /> }<br /> <br /> const char* const*<br /> paramArrayGetString(const char* name, epicsUInt32 *nelem, epicsUInt32 opt);<br /> /* 3 more for other types */<br /> <br /> INLINE const char*<br /> paramGetString(const char* name, epicsUInt32 opt)<br /> {<br /> epicsUInt32 N;<br /> const char* const* V=paramArrayGetString(name, 1, opt);<br /> if (!paramValidValue((const void*)V)) return (const char*)V;<br /> else return *V;<br /> }<br /> /* 3 more for other types */<br /> <br /> Gets the value of an already created parameter<br /> <br /> Note: Type-safe Getters will also be provided (ie paramArrayGetDouble())<br /> <br /> Note: Type paramTypeString returns C type const char* const*.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |paramNone<br /> |Value not found<br /> |-<br /> |paramNotReal<br /> |Parameter name does not exist<br /> |-<br /> |paramConvertFail<br /> |Value could not be converted to requested type<br /> |-<br /> |NULL<br /> |Zero length array (nelems also set to 0)<br /> |-<br /> |others<br /> |Value pointer (dependent of type)<br /> |}<br /> <br /> === Misc ===<br /> <br /> paramType<br /> paramGetType(const char* name);<br /> <br /> Get type of parameter or paramTypeInvalid if parameter does not exist.<br /> <br /> epicsUInt32<br /> paramGetNElem(const char* name);<br /> <br /> Get number of entries or 0 if parameter does not exist (use paramGetType()<br /> to distinguish between a 0 length array and an invalid name).<br /> <br /> char<br /> paramGetSep(const char* name);<br /> <br /> Get seperator string or NULL if parameter does not exist.<br /> <br /> void<br /> paramVisitAll(void *arg, void (*fnptr)(void*, const char* name));<br /> <br /> Get a callback for each parameter.<br /> <br /> void<br /> paramShowAll(int verbose);<br /> <br /> Print parameter info to standard out. Argument controls verbosity (larger -> more detail).<br /> <br /> == Values ==<br /> <br /> All values are stored as strings, but may be requested as any type.<br /> <br /> Parameters can have the special value paramNone. This is distinct from a zero length array.<br /> When created all parameters initially have paramNone as a default value.<br /> <br /> == Value Reread ==<br /> <br /> The value of a parameter is determined when its value is retrieved with paramArrayGet()<br /> and stored for future use. Unless the reread option is given further calls to paramArrayGet()<br /> will return the same value. If the reread option is given then paramArrayGet() will<br /> start a new search and store the (possible different) value for future use.<br /> <br /> If a parameter is ever to be reread then the reread option must be given when<br /> the parameter is created.<br /> <br /> Note: Rereading a parameter invalidates all value pointers previously returned.<br /> <br /> == Search Path ==<br /> <br /> Value may be found in the following locations. The first value found will be used.<br /> <br /> # Current value<br /> # Environment<br /> # Files (OS dependent)<br /> # Default value<br /> <br /> The file search path is defined by the environment variable (EPICS_CONF_PATH).<br /> The default value is set in CONFIG_ENV at compile time. Since this parameter<br /> is read before the first file is searched it can not be specified in a file.<br /> <br /> Entries in the search path may use arbitrary environment variables (macLib syntax).<br /> <br /> === Default UNIX-like search path ===<br /> <br /> # ./epics.conf<br /> # $HOME/epics.conf<br /> # $EPICS_BASE/epics.conf<br /> # /etc/epics.conf<br /> <br /> === Default Windows search path ===<br /> <br /> # .\epics.conf<br /> # $USERPROFILE\epics.conf<br /> # $EPICS_BASE\epics.conf<br /> # $ALLUSERSPROFILE\epics.conf<br /> <br /> ==== On windows xp ====<br /> <br /> USERPROFILE=C:\Documents and Settings\username<br /> ALLUSERSPROFILE=C:\Documents and Settings\All Users<br /> <br /> ==== On windows vista/7 ====<br /> <br /> USERPROFILE=C:\Users\username<br /> ALLUSERSPROFILE=C:\ProgramData<br /> <br /> === Default VxWorks and RTEMS search path ===<br /> <br /> None<br /> <br /> == Config File Syntax ==<br /> <br /> Files specifying parameter values shall have lines of the following format.<br /> Lines may be seperated by one of the valid EOL combinations (cr, lf, cr+lf, lf+cr).<br /> <br /> === Blank lines '^\s*$' ===<br /> <br /> Ignored<br /> <br /> === Comments '^\s*#.*$' ===<br /> <br /> Ignored<br /> <br /> === key value pairs '^\s*[^\s=]+\s*=.*$' ===<br /> <br /> When parsing files key names can contain any non-whitespace charactor except '='.<br /> However, keys being stored in the environment must also be valid environment variable names.<br /> <br /> === INI style section headers '\s*\[[^\]]+\]\s*$' ===<br /> <br /> Reserved for future use. Parsing stops when the first section header is found.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Epicsparamconf&diff=1858 Epicsparamconf 2010-06-29T17:57:56Z

<p>MichaelDavidsaver: /* Setting */</p> <hr /> <div>= EPICS Config Parameters API =<br /> <br /> Author: Michael Davidsaver <mdavidsaver@bnl.gov><br /> Date: June 2010<br /> <br /> == Purpose ==<br /> <br /> Proposal for 3.15 series<br /> <br /> Replace the API in envDefs.h with a more general purpose startup config.<br /> <br /> * New parameters can be created at runtime by applications outside of Base (ie EDM).<br /> * Provide a specification for a configuration mechanism which can be shared by all EPICS implimentations.<br /> * Values will be taken from configuration file(s) in addition to the nvironment.<br /> * Supports types: String, Int32, Double, and InetAddr (IPv4).<br /> * Transparent handling of parameter arrays.<br /> <br /> == API ==<br /> <br /> === Types ===<br /> <br /> enum paramType {<br /> paramTypeInvalid,<br /> paramTypeString,<br /> paramTypeInt32,<br /> paramTypeDouble,<br /> paramTypeInetAddr<br /> };<br /> <br /> === Creation ===<br /> <br /> int<br /> paramArrayCreate(const char* name, paramType tp, epicsUInt32 maxelem, char sep, epicsUInt32 opt);<br /> <br /> #define paramCreate(name,tp,opt) paramArrayCreate(name,tp,1,NULL,opt)<br /> <br /> Creates a new parameter with the given value type. If number of elements is >1 and<br /> a separator string is not given then the default separator (OS dependent) is used.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Include environment variable in search path<br /> |-<br /> |1<br /> |Store value in environment variable<br /> |-<br /> |2<br /> |Don't strip leading and trailing whitespace<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name already exists<br /> |-<br /> | -2<br /> |Invalid arguments (ie nelem==0)<br /> |-<br /> | -3<br /> |Insufficient memory<br /> |}<br /> <br /> === Setting ===<br /> <br /> int<br /> paramArraySetString(const char* name, epicsUInt32 nelem, const char* const* val, epicsUInt32 opt)<br /> /* 3 more for other types */<br /> <br /> #define paramSetString(name, val, opt) paramArraySetString(name, 1, &(val), opt)<br /> /* 3 more for other types */<br /> <br /> Sets the value of an already created parameter. A value of NULL will clear the<br /> parameter value/default.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> bit #<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Set default. Overwrite the default value instead of the final value.<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name does not exist<br /> |}<br /> <br /> === Getting ===<br /> <br /> extern const void* paramNone;<br /> extern const void* paramConvertFail;<br /> extern const void* paramNotReal;<br /> <br /> INLINE epicsBoolean<br /> paramValidValue(const void* V)<br /> {<br /> switch(V) {<br /> case NULL:<br /> case paramNone:<br /> case paramConvertFail:<br /> case paramNotReal:<br /> return epicsFalse;<br /> default:<br /> return epicsTrue;<br /> }<br /> }<br /> <br /> const char* const*<br /> paramArrayGetString(const char* name, epicsUInt32 *nelem, epicsUInt32 opt);<br /> /* 3 more for other types */<br /> <br /> INLINE const char*<br /> paramGetString(const char* name, epicsUInt32 opt)<br /> {<br /> epicsUInt32 N;<br /> const char* const* V=paramArrayGetString(name, 1, opt);<br /> if (!paramValidValue((const void*)V)) return (const char*)V;<br /> else return *V;<br /> }<br /> /* 3 more for other types */<br /> <br /> Gets the value of an already created parameter<br /> <br /> Note: Type-safe Getters will also be provided (ie paramArrayGetDouble())<br /> <br /> Note: Type paramTypeString returns C type const char* const*.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |paramNone<br /> |Value not found<br /> |-<br /> |paramNotReal<br /> |Parameter name does not exist<br /> |-<br /> |paramConvertFail<br /> |Value could not be converted to requested type<br /> |-<br /> |NULL<br /> |Zero length array (nelems also set to 0)<br /> |-<br /> |others<br /> |Value pointer (dependent of type)<br /> |}<br /> <br /> === Misc ===<br /> <br /> paramType<br /> paramGetType(const char* name);<br /> <br /> Get type of parameter or paramTypeInvalid if parameter does not exist.<br /> <br /> epicsUInt32<br /> paramGetNElem(const char* name);<br /> <br /> Get number of entries or 0 if parameter does not exist (use paramGetType()<br /> to distinguish between a 0 length array and an invalid name).<br /> <br /> char<br /> paramGetSep(const char* name);<br /> <br /> Get seperator string or NULL if parameter does not exist.<br /> <br /> void<br /> paramVisitAll(void *arg, void (*fnptr)(void*, const char* name));<br /> <br /> Get a callback for each parameter.<br /> <br /> void<br /> paramShowAll(int verbose);<br /> <br /> Print parameter info to standard out. Argument controls verbosity (larger -> more detail).<br /> <br /> == Values ==<br /> <br /> All values are stored as strings, but may be requested as any type.<br /> <br /> Parameters can have the special value paramNone. This is distinct from a zero length array.<br /> When created all parameters initially have paramNone as a default value.<br /> <br /> == Value Reread ==<br /> <br /> The value of a parameter is determined when its value is retrieved with paramArrayGet()<br /> and stored for future use. Unless the reread option is given further calls to paramArrayGet()<br /> will return the same value. If the reread option is given then paramArrayGet() will<br /> start a new search and store the (possible different) value for future use.<br /> <br /> If a parameter is ever to be reread then the reread option must be given when<br /> the parameter is created.<br /> <br /> Note: Rereading a parameter invalidates all value pointers previously returned.<br /> <br /> == Search Path ==<br /> <br /> Value may be found in the following locations. The first value found will be used.<br /> <br /> # Current value<br /> # Environment<br /> # Files (OS dependent)<br /> # Default value<br /> <br /> The file search path is defined by the environment variable (EPICS_CONF_PATH).<br /> The default value is set in CONFIG_ENV at compile time. Since this parameter<br /> is read before the first file is searched it can not be specified in a file.<br /> <br /> Entries in the search path may use arbitrary environment variables (macLib syntax).<br /> <br /> === Default UNIX-like search path ===<br /> <br /> # ./epics.conf<br /> # $HOME/epics.conf<br /> # $EPICS_BASE/epics.conf<br /> # /etc/epics.conf<br /> <br /> === Default Windows search path ===<br /> <br /> # .\epics.conf<br /> # $USERPROFILE\epics.conf<br /> # $EPICS_BASE\epics.conf<br /> # $ALLUSERSPROFILE\epics.conf<br /> <br /> ==== On windows xp ====<br /> <br /> USERPROFILE=C:\Documents and Settings\username<br /> ALLUSERSPROFILE=C:\Documents and Settings\All Users<br /> <br /> ==== On windows vista/7 ====<br /> <br /> USERPROFILE=C:\Users\username<br /> ALLUSERSPROFILE=C:\ProgramData<br /> <br /> === Default VxWorks and RTEMS search path ===<br /> <br /> None<br /> <br /> == Config File Syntax ==<br /> <br /> Files specifying parameter values shall have lines of the following format.<br /> Lines may be seperated by one of the valid EOL combinations (cr, lf, cr+lf, lf+cr).<br /> <br /> === Blank lines '^\s*$' ===<br /> <br /> Ignored<br /> <br /> === Comments '^\s*#.*$' ===<br /> <br /> Ignored<br /> <br /> === key value pairs '^\s*[^\s=]+\s*=.*$' ===<br /> <br /> When parsing files key names can contain any non-whitespace charactor except '='.<br /> However, keys being stored in the environment must also be valid environment variable names.<br /> <br /> === INI style section headers '\s*\[[^\[]+\]\s*$' ===<br /> <br /> Reserved for future use. Parsing stops when the first section header is found.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Epicsparamconf&diff=1857 Epicsparamconf 2010-06-29T17:56:46Z

<p>MichaelDavidsaver: return values are negative</p> <hr /> <div>= EPICS Config Parameters API =<br /> <br /> Author: Michael Davidsaver <mdavidsaver@bnl.gov><br /> Date: June 2010<br /> <br /> == Purpose ==<br /> <br /> Proposal for 3.15 series<br /> <br /> Replace the API in envDefs.h with a more general purpose startup config.<br /> <br /> * New parameters can be created at runtime by applications outside of Base (ie EDM).<br /> * Provide a specification for a configuration mechanism which can be shared by all EPICS implimentations.<br /> * Values will be taken from configuration file(s) in addition to the nvironment.<br /> * Supports types: String, Int32, Double, and InetAddr (IPv4).<br /> * Transparent handling of parameter arrays.<br /> <br /> == API ==<br /> <br /> === Types ===<br /> <br /> enum paramType {<br /> paramTypeInvalid,<br /> paramTypeString,<br /> paramTypeInt32,<br /> paramTypeDouble,<br /> paramTypeInetAddr<br /> };<br /> <br /> === Creation ===<br /> <br /> int<br /> paramArrayCreate(const char* name, paramType tp, epicsUInt32 maxelem, char sep, epicsUInt32 opt);<br /> <br /> #define paramCreate(name,tp,opt) paramArrayCreate(name,tp,1,NULL,opt)<br /> <br /> Creates a new parameter with the given value type. If number of elements is >1 and<br /> a separator string is not given then the default separator (OS dependent) is used.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Include environment variable in search path<br /> |-<br /> |1<br /> |Store value in environment variable<br /> |-<br /> |2<br /> |Don't strip leading and trailing whitespace<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name already exists<br /> |-<br /> | -2<br /> |Invalid arguments (ie nelem==0)<br /> |-<br /> | -3<br /> |Insufficient memory<br /> |}<br /> <br /> === Setting ===<br /> <br /> int<br /> paramArraySetString(const char* name, epicsUInt32 nelem, const char* const* val, epicsUInt32 opt)<br /> /* 3 more for other types */<br /> <br /> #define paramSetString(name, val, opt) paramArraySetString(name, 1, &(val), opt)<br /> /* 3 more for other types */<br /> <br /> Sets the value of an already created parameter. A value of NULL will clear the<br /> parameter value/default.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> bit #<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Set default. Overwrite the default value instead of the final value.<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name does not exist<br /> |-<br /> | -3<br /> |Allow the value to be modified/reread (use carefully)<br /> |}<br /> <br /> === Getting ===<br /> <br /> extern const void* paramNone;<br /> extern const void* paramConvertFail;<br /> extern const void* paramNotReal;<br /> <br /> INLINE epicsBoolean<br /> paramValidValue(const void* V)<br /> {<br /> switch(V) {<br /> case NULL:<br /> case paramNone:<br /> case paramConvertFail:<br /> case paramNotReal:<br /> return epicsFalse;<br /> default:<br /> return epicsTrue;<br /> }<br /> }<br /> <br /> const char* const*<br /> paramArrayGetString(const char* name, epicsUInt32 *nelem, epicsUInt32 opt);<br /> /* 3 more for other types */<br /> <br /> INLINE const char*<br /> paramGetString(const char* name, epicsUInt32 opt)<br /> {<br /> epicsUInt32 N;<br /> const char* const* V=paramArrayGetString(name, 1, opt);<br /> if (!paramValidValue((const void*)V)) return (const char*)V;<br /> else return *V;<br /> }<br /> /* 3 more for other types */<br /> <br /> Gets the value of an already created parameter<br /> <br /> Note: Type-safe Getters will also be provided (ie paramArrayGetDouble())<br /> <br /> Note: Type paramTypeString returns C type const char* const*.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |paramNone<br /> |Value not found<br /> |-<br /> |paramNotReal<br /> |Parameter name does not exist<br /> |-<br /> |paramConvertFail<br /> |Value could not be converted to requested type<br /> |-<br /> |NULL<br /> |Zero length array (nelems also set to 0)<br /> |-<br /> |others<br /> |Value pointer (dependent of type)<br /> |}<br /> <br /> === Misc ===<br /> <br /> paramType<br /> paramGetType(const char* name);<br /> <br /> Get type of parameter or paramTypeInvalid if parameter does not exist.<br /> <br /> epicsUInt32<br /> paramGetNElem(const char* name);<br /> <br /> Get number of entries or 0 if parameter does not exist (use paramGetType()<br /> to distinguish between a 0 length array and an invalid name).<br /> <br /> char<br /> paramGetSep(const char* name);<br /> <br /> Get seperator string or NULL if parameter does not exist.<br /> <br /> void<br /> paramVisitAll(void *arg, void (*fnptr)(void*, const char* name));<br /> <br /> Get a callback for each parameter.<br /> <br /> void<br /> paramShowAll(int verbose);<br /> <br /> Print parameter info to standard out. Argument controls verbosity (larger -> more detail).<br /> <br /> == Values ==<br /> <br /> All values are stored as strings, but may be requested as any type.<br /> <br /> Parameters can have the special value paramNone. This is distinct from a zero length array.<br /> When created all parameters initially have paramNone as a default value.<br /> <br /> == Value Reread ==<br /> <br /> The value of a parameter is determined when its value is retrieved with paramArrayGet()<br /> and stored for future use. Unless the reread option is given further calls to paramArrayGet()<br /> will return the same value. If the reread option is given then paramArrayGet() will<br /> start a new search and store the (possible different) value for future use.<br /> <br /> If a parameter is ever to be reread then the reread option must be given when<br /> the parameter is created.<br /> <br /> Note: Rereading a parameter invalidates all value pointers previously returned.<br /> <br /> == Search Path ==<br /> <br /> Value may be found in the following locations. The first value found will be used.<br /> <br /> # Current value<br /> # Environment<br /> # Files (OS dependent)<br /> # Default value<br /> <br /> The file search path is defined by the environment variable (EPICS_CONF_PATH).<br /> The default value is set in CONFIG_ENV at compile time. Since this parameter<br /> is read before the first file is searched it can not be specified in a file.<br /> <br /> Entries in the search path may use arbitrary environment variables (macLib syntax).<br /> <br /> === Default UNIX-like search path ===<br /> <br /> # ./epics.conf<br /> # $HOME/epics.conf<br /> # $EPICS_BASE/epics.conf<br /> # /etc/epics.conf<br /> <br /> === Default Windows search path ===<br /> <br /> # .\epics.conf<br /> # $USERPROFILE\epics.conf<br /> # $EPICS_BASE\epics.conf<br /> # $ALLUSERSPROFILE\epics.conf<br /> <br /> ==== On windows xp ====<br /> <br /> USERPROFILE=C:\Documents and Settings\username<br /> ALLUSERSPROFILE=C:\Documents and Settings\All Users<br /> <br /> ==== On windows vista/7 ====<br /> <br /> USERPROFILE=C:\Users\username<br /> ALLUSERSPROFILE=C:\ProgramData<br /> <br /> === Default VxWorks and RTEMS search path ===<br /> <br /> None<br /> <br /> == Config File Syntax ==<br /> <br /> Files specifying parameter values shall have lines of the following format.<br /> Lines may be seperated by one of the valid EOL combinations (cr, lf, cr+lf, lf+cr).<br /> <br /> === Blank lines '^\s*$' ===<br /> <br /> Ignored<br /> <br /> === Comments '^\s*#.*$' ===<br /> <br /> Ignored<br /> <br /> === key value pairs '^\s*[^\s=]+\s*=.*$' ===<br /> <br /> When parsing files key names can contain any non-whitespace charactor except '='.<br /> However, keys being stored in the environment must also be valid environment variable names.<br /> <br /> === INI style section headers '\s*\[[^\[]+\]\s*$' ===<br /> <br /> Reserved for future use. Parsing stops when the first section header is found.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Epicsparamconf&diff=1856 Epicsparamconf 2010-06-29T16:24:29Z

<p>MichaelDavidsaver: </p> <hr /> <div>= EPICS Config Parameters API =<br /> <br /> Author: Michael Davidsaver <mdavidsaver@bnl.gov><br /> Date: June 2010<br /> <br /> == Purpose ==<br /> <br /> Proposal for 3.15 series<br /> <br /> Replace the API in envDefs.h with a more general purpose startup config.<br /> <br /> * New parameters can be created at runtime by applications outside of Base (ie EDM).<br /> * Provide a specification for a configuration mechanism which can be shared by all EPICS implimentations.<br /> * Values will be taken from configuration file(s) in addition to the nvironment.<br /> * Supports types: String, Int32, Double, and InetAddr (IPv4).<br /> * Transparent handling of parameter arrays.<br /> <br /> == API ==<br /> <br /> === Types ===<br /> <br /> enum paramType {<br /> paramTypeInvalid,<br /> paramTypeString,<br /> paramTypeInt32,<br /> paramTypeDouble,<br /> paramTypeInetAddr<br /> };<br /> <br /> === Creation ===<br /> <br /> int<br /> paramArrayCreate(const char* name, paramType tp, epicsUInt32 maxelem, char sep, epicsUInt32 opt);<br /> <br /> #define paramCreate(name,tp,opt) paramArrayCreate(name,tp,1,NULL,opt)<br /> <br /> Creates a new parameter with the given value type. If number of elements is >1 and<br /> a separator string is not given then the default separator (OS dependent) is used.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Include environment variable in search path<br /> |-<br /> |1<br /> |Store value in environment variable<br /> |-<br /> |2<br /> |Don't strip leading and trailing whitespace<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> | -1<br /> |parameter name already exists<br /> |-<br /> | -2<br /> |Invalid arguments (ie nelem==0)<br /> |-<br /> | -3<br /> |Insufficient memory<br /> |}<br /> <br /> === Setting ===<br /> <br /> int<br /> paramArraySetString(const char* name, epicsUInt32 nelem, const char* const* val, epicsUInt32 opt)<br /> /* 3 more for other types */<br /> <br /> #define paramSetString(name, val, opt) paramArraySetString(name, 1, &(val), opt)<br /> /* 3 more for other types */<br /> <br /> Sets the value of an already created parameter. A value of NULL will clear the<br /> parameter value/default.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> bit #<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Set default. Overwrite the default value instead of the final value.<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |0<br /> |Ok<br /> |-<br /> |1<br /> |parameter name does not exist<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |}<br /> <br /> === Getting ===<br /> <br /> extern const void* paramNone;<br /> extern const void* paramConvertFail;<br /> extern const void* paramNotReal;<br /> <br /> INLINE epicsBoolean<br /> paramValidValue(const void* V)<br /> {<br /> switch(V) {<br /> case NULL:<br /> case paramNone:<br /> case paramConvertFail:<br /> case paramNotReal:<br /> return epicsFalse;<br /> default:<br /> return epicsTrue;<br /> }<br /> }<br /> <br /> const char* const*<br /> paramArrayGetString(const char* name, epicsUInt32 *nelem, epicsUInt32 opt);<br /> /* 3 more for other types */<br /> <br /> INLINE const char*<br /> paramGetString(const char* name, epicsUInt32 opt)<br /> {<br /> epicsUInt32 N;<br /> const char* const* V=paramArrayGetString(name, 1, opt);<br /> if (!paramValidValue((const void*)V)) return (const char*)V;<br /> else return *V;<br /> }<br /> /* 3 more for other types */<br /> <br /> Gets the value of an already created parameter<br /> <br /> Note: Type-safe Getters will also be provided (ie paramArrayGetDouble())<br /> <br /> Note: Type paramTypeString returns C type const char* const*.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> {| border="1"<br /> !Code<br /> !<br /> |-<br /> |paramNone<br /> |Value not found<br /> |-<br /> |paramNotReal<br /> |Parameter name does not exist<br /> |-<br /> |paramConvertFail<br /> |Value could not be converted to requested type<br /> |-<br /> |NULL<br /> |Zero length array (nelems also set to 0)<br /> |-<br /> |others<br /> |Value pointer (dependent of type)<br /> |}<br /> <br /> === Misc ===<br /> <br /> paramType<br /> paramGetType(const char* name);<br /> <br /> Get type of parameter or paramTypeInvalid if parameter does not exist.<br /> <br /> epicsUInt32<br /> paramGetNElem(const char* name);<br /> <br /> Get number of entries or 0 if parameter does not exist (use paramGetType()<br /> to distinguish between a 0 length array and an invalid name).<br /> <br /> char<br /> paramGetSep(const char* name);<br /> <br /> Get seperator string or NULL if parameter does not exist.<br /> <br /> void<br /> paramVisitAll(void *arg, void (*fnptr)(void*, const char* name));<br /> <br /> Get a callback for each parameter.<br /> <br /> void<br /> paramShowAll(int verbose);<br /> <br /> Print parameter info to standard out. Argument controls verbosity (larger -> more detail).<br /> <br /> == Values ==<br /> <br /> All values are stored as strings, but may be requested as any type.<br /> <br /> Parameters can have the special value paramNone. This is distinct from a zero length array.<br /> When created all parameters initially have paramNone as a default value.<br /> <br /> == Value Reread ==<br /> <br /> The value of a parameter is determined when its value is retrieved with paramArrayGet()<br /> and stored for future use. Unless the reread option is given further calls to paramArrayGet()<br /> will return the same value. If the reread option is given then paramArrayGet() will<br /> start a new search and store the (possible different) value for future use.<br /> <br /> If a parameter is ever to be reread then the reread option must be given when<br /> the parameter is created.<br /> <br /> Note: Rereading a parameter invalidates all value pointers previously returned.<br /> <br /> == Search Path ==<br /> <br /> Value may be found in the following locations. The first value found will be used.<br /> <br /> # Current value<br /> # Environment<br /> # Files (OS dependent)<br /> # Default value<br /> <br /> The file search path is defined by the environment variable (EPICS_CONF_PATH).<br /> The default value is set in CONFIG_ENV at compile time. Since this parameter<br /> is read before the first file is searched it can not be specified in a file.<br /> <br /> Entries in the search path may use arbitrary environment variables (macLib syntax).<br /> <br /> === Default UNIX-like search path ===<br /> <br /> # ./epics.conf<br /> # $HOME/epics.conf<br /> # $EPICS_BASE/epics.conf<br /> # /etc/epics.conf<br /> <br /> === Default Windows search path ===<br /> <br /> # .\epics.conf<br /> # $USERPROFILE\epics.conf<br /> # $EPICS_BASE\epics.conf<br /> # $ALLUSERSPROFILE\epics.conf<br /> <br /> ==== On windows xp ====<br /> <br /> USERPROFILE=C:\Documents and Settings\username<br /> ALLUSERSPROFILE=C:\Documents and Settings\All Users<br /> <br /> ==== On windows vista/7 ====<br /> <br /> USERPROFILE=C:\Users\username<br /> ALLUSERSPROFILE=C:\ProgramData<br /> <br /> === Default VxWorks and RTEMS search path ===<br /> <br /> None<br /> <br /> == Config File Syntax ==<br /> <br /> Files specifying parameter values shall have lines of the following format.<br /> Lines may be seperated by one of the valid EOL combinations (cr, lf, cr+lf, lf+cr).<br /> <br /> === Blank lines '^\s*$' ===<br /> <br /> Ignored<br /> <br /> === Comments '^\s*#.*$' ===<br /> <br /> Ignored<br /> <br /> === key value pairs '^\s*[^\s=]+\s*=.*$' ===<br /> <br /> When parsing files key names can contain any non-whitespace charactor except '='.<br /> However, keys being stored in the environment must also be valid environment variable names.<br /> <br /> === INI style section headers '\s*\[[^\[]+\]\s*$' ===<br /> <br /> Reserved for future use. Parsing stops when the first section header is found.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Epicsparamconf&diff=1855 Epicsparamconf 2010-06-29T16:17:19Z

<p>MichaelDavidsaver: </p> <hr /> <div>= EPICS Config Parameters API =<br /> <br /> Author: Michael Davidsaver <mdavidsaver@bnl.gov><br /> Date: June 2010<br /> <br /> == Purpose ==<br /> <br /> Proposal for 3.15 series<br /> <br /> Replace the API in envDefs.h with a more general purpose startup config.<br /> <br /> * New parameters can be created at runtime by applications outside of Base (ie EDM).<br /> * Provide a specification for a configuration mechanism which can be shared by all EPICS implimentations.<br /> * Values will be taken from configuration file(s) in addition to the nvironment.<br /> * Supports types: String, Int32, Double, and InetAddr (IPv4).<br /> * Transparent handling of parameter arrays.<br /> <br /> == API ==<br /> <br /> === Types ===<br /> <br /> enum paramType {<br /> paramTypeInvalid,<br /> paramTypeString,<br /> paramTypeInt32,<br /> paramTypeDouble,<br /> paramTypeInetAddr<br /> };<br /> <br /> === Creation ===<br /> <br /> int<br /> paramArrayCreate(const char* name, paramType tp, epicsUInt32 maxelem, char sep, epicsUInt32 opt);<br /> <br /> #define paramCreate(name,tp,opt) paramArrayCreate(name,tp,1,NULL,opt)<br /> <br /> Creates a new parameter with the given value type. If number of elements is >1 and<br /> a separator string is not given then the default separator (OS dependent) is used.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> {| border="1"<br /> !bit #<br /> !<br /> |-<br /> |0<br /> |Include environment variable in search path<br /> |-<br /> |1<br /> |Store value in environment variable<br /> |-<br /> |2<br /> |Don't strip leading and trailing whitespace<br /> |-<br /> |3<br /> |Allow the value to be modified/reread (use carefully)<br /> |-<br /> |4<br /> |Debug print when searching<br /> |}<br /> <br /> ==== RETURN ====<br /> <br /> 0 :: Ok<br /> -1 :: parameter name already exists<br /> -2 :: Invalid arguments (ie nelem==0)<br /> -3 :: Insufficient memory<br /> <br /> === Setting ===<br /> <br /> int<br /> paramArraySetString(const char* name, epicsUInt32 nelem, const char* const* val, epicsUInt32 opt)<br /> /* 3 more for other types */<br /> <br /> #define paramSetString(name, val, opt) paramArraySetString(name, 1, &(val), opt)<br /> /* 3 more for other types */<br /> <br /> Sets the value of an already created parameter. A value of NULL will clear the<br /> parameter value/default.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> bit #<br /> <br /> 0 :: Set default. Overwrite the default value instead of the final value.<br /> <br /> ==== RETURN ====<br /> <br /> 0 :: ok<br /> 1 :: parameter name does not exist<br /> 3 :: Allow the value to be modified/reread (use carefully)<br /> <br /> === Getting ===<br /> <br /> extern const void* paramNone;<br /> extern const void* paramConvertFail;<br /> extern const void* paramNotReal;<br /> <br /> INLINE epicsBoolean<br /> paramValidValue(const void* V)<br /> {<br /> switch(V) {<br /> case NULL:<br /> case paramNone:<br /> case paramConvertFail:<br /> case paramNotReal:<br /> return epicsFalse;<br /> default:<br /> return epicsTrue;<br /> }<br /> }<br /> <br /> const char* const*<br /> paramArrayGetString(const char* name, epicsUInt32 *nelem, epicsUInt32 opt);<br /> /* 3 more for other types */<br /> <br /> INLINE const char*<br /> paramGetString(const char* name, epicsUInt32 opt)<br /> {<br /> epicsUInt32 N;<br /> const char* const* V=paramArrayGetString(name, 1, opt);<br /> if (!paramValidValue((const void*)V)) return (const char*)V;<br /> else return *V;<br /> }<br /> /* 3 more for other types */<br /> <br /> Gets the value of an already created parameter<br /> <br /> Note: Type-safe Getters will also be provided (ie paramArrayGetDouble())<br /> <br /> Note: Type paramTypeString returns C type const char* const*.<br /> <br /> The bit mask 'opt' defines the following bits.<br /> <br /> bit #<br /> <br /> 3 :: Allow the value to be modified/reread (use carefully)<br /> 4 :: Debug print when searching<br /> <br /> ==== RETURN ====<br /> <br /> paramNone - Value not found<br /> paramNotReal - Parameter name does not exist<br /> paramConvertFail - Value could not be converted to requested type<br /> NULL - Zero length array (nelems also set to 0)<br /> others - Value pointer (dependent of type)<br /> <br /> === Misc ===<br /> <br /> paramType<br /> paramGetType(const char* name);<br /> <br /> Get type of parameter or paramTypeInvalid if parameter does not exist.<br /> <br /> epicsUInt32<br /> paramGetNElem(const char* name);<br /> <br /> Get number of entries or 0 if parameter does not exist (use paramGetType()<br /> to distinguish between a 0 length array and an invalid name).<br /> <br /> char<br /> paramGetSep(const char* name);<br /> <br /> Get seperator string or NULL if parameter does not exist.<br /> <br /> void<br /> paramVisitAll(void *arg, void (*fnptr)(void*, const char* name));<br /> <br /> Get a callback for each parameter.<br /> <br /> void<br /> paramShowAll(int verbose);<br /> <br /> Print parameter info to standard out. Argument controls verbosity (larger -> more detail).<br /> <br /> == Values ==<br /> <br /> All values are stored as strings, but may be requested as any type.<br /> <br /> Parameters can have the special value paramNone. This is distinct from a zero length array.<br /> When created all parameters initially have paramNone as a default value.<br /> <br /> == Value Reread ==<br /> <br /> The value of a parameter is determined when its value is retrieved with paramArrayGet()<br /> and stored for future use. Unless the reread option is given further calls to paramArrayGet()<br /> will return the same value. If the reread option is given then paramArrayGet() will<br /> start a new search and store the (possible different) value for future use.<br /> <br /> If a parameter is ever to be reread then the reread option must be given when<br /> the parameter is created.<br /> <br /> Note: Rereading a parameter invalidates all value pointers previously returned.<br /> <br /> == Search Path ==<br /> <br /> Value may be found in the following locations. The first value found will be used.<br /> <br /> # Current value<br /> # Environment<br /> # Files (OS dependent)<br /> # Default value<br /> <br /> The file search path is defined by the environment variable (EPICS_CONF_PATH).<br /> The default value is set in CONFIG_ENV at compile time. Since this parameter<br /> is read before the first file is searched it can not be specified in a file.<br /> <br /> Entries in the search path may use arbitrary environment variables (macLib syntax).<br /> <br /> === Default UNIX-like search path ===<br /> <br /> # ./epics.conf<br /> # $HOME/epics.conf<br /> # $EPICS_BASE/epics.conf<br /> # /etc/epics.conf<br /> <br /> === Default Windows search path ===<br /> <br /> # .\epics.conf<br /> # $USERPROFILE\epics.conf<br /> # $EPICS_BASE\epics.conf<br /> # $ALLUSERSPROFILE\epics.conf<br /> <br /> ==== On windows xp ====<br /> <br /> USERPROFILE=C:\Documents and Settings\username<br /> ALLUSERSPROFILE=C:\Documents and Settings\All Users<br /> <br /> ==== On windows vista/7 ====<br /> <br /> USERPROFILE=C:\Users\username<br /> ALLUSERSPROFILE=C:\ProgramData<br /> <br /> === Default VxWorks and RTEMS search path ===<br /> <br /> None<br /> <br /> == Config File Syntax ==<br /> <br /> Files specifying parameter values shall have lines of the following format.<br /> Lines may be seperated by one of the valid EOL combinations (cr, lf, cr+lf, lf+cr).<br /> <br /> === Blank lines '^\s*$' ===<br /> <br /> Ignored<br /> <br /> === Comments '^\s*#.*$' ===<br /> <br /> Ignored<br /> <br /> === key value pairs '^\s*[^\s=]+\s*=.*$' ===<br /> <br /> When parsing files key names can contain any non-whitespace charactor except '='.<br /> However, keys being stored in the environment must also be valid environment variable names.<br /> <br /> === INI style section headers '\s*\[[^\[]+\]\s*$' ===<br /> <br /> Reserved for future use. Parsing stops when the first section header is found.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Common_Database_patterns&diff=2934 Common Database patterns 2010-04-23T17:59:21Z

<p>MichaelDavidsaver: add pull alarm status w/ SDIS</p> <hr /> <div>== Pull Alarm Status w/o Data ==<br /> <br /> This is useful to bring alarm status in without affecting the value<br /> stored in a record. In the following example the alarm status of '''$(P):set'''<br /> is fetched by '''$(P):rbv''' when it is processed, but the value is read from<br /> a different record.<br /> <br /> record(bo, "$(P):set") {<br /> field(OSEV, "MAJOR")<br /> field(FLNK, "$(P):rbv")<br /> }<br /> <br /> record(bi, "$(P):rbv") {<br /> field(SDIS, "$(P):set NPP MS")<br /> field(DISV, "-1")<br /> field(INP , "$(P):some:other:record")<br /> }<br /> <br /> == Combined Setting and Readback ==<br /> <br /> Use when a single PV is desired. Could be used to show the results of rounding in a float to fixed precision conversion.<br /> <br /> In the following example the value read from a 'bi' is inverted so that the associated 'bo' acts as a toggle.<br /> <br /> record(bi, "$(P):rbv") {<br /> field(DTYP, "...")<br /> field(INP , "...")<br /> field(PINI, "YES")<br /> field(FLNK, "$(P):inv")<br /> }<br /> <br /> record(calcout, "$(P):inv")<br /> field(CALC, "!A")<br /> field(INPA, "$(P):rbv")<br /> field(OUT , "$(P) NPP")<br /> }<br /> <br /> record(bo, "$(P)") {<br /> field(DTYP, "...")<br /> field(OUT , "...")<br /> field(FLNK, "$(P):rbv")<br /> }<br /> <br /> The important point is the <i>NPP</i> modifier on output link of the 'calcout' record. This updates the <i>VAL</i> field of the 'bo' record (and posts monitors) without processing it.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=RRM_3-14_Binary_Output&diff=2875 RRM 3-14 Binary Output 2010-04-23T17:51:36Z

<p>MichaelDavidsaver: add note about returning 2 from init_record</p> <hr /> <div>[[RRM 3-14|EPICS Record Reference Manual]]<br /> <br /> <br /> = bo - Binary Output =<br /> <br /> The normal use for this record type is to store a simple bit (0 or 1) value to be sent to a Digital Output module. It can also be used to write binary values into other records via database or channel access links. This record can implement both latched and momentary binary outputs depending on how the HIGH field is configured.<br /> <br /> == Parameter Fields ==<br /> <br /> The binary output's fields fall into the following categories:<br /> <br /> * scan parameters<br /> * convert and write parameters<br /> * operator display parameters<br /> * alarm parameters<br /> * run-time parameters<br /> <br /> === Scan Parameters ===<br /> <br /> The binary output record has the standard fields for specifying under what circumstances the record will be processed. These fields are listed in [[RRM 3-14 dbCommon#Scan Fields|Scan Fields]]. In addition, [[RRM 3-14 Concepts#Scanning Specification|Scanning Specification]] explains how these fields are used. Note that I/O event scanning is only supported for those card types that interrupt. <br /> <br /> <br /> === Desired Output Parameters ===<br /> <br /> The binary output record must specify where its desired output originates. The desired output needs to be in engineering units.<br /> <br /> The first field that determines where the desired output originates is the output mode select (OMSL) field, which can have two possible values: <CODE>closed_loop</CODE> or <CODE>supervisory</CODE>. If <CODE>supervisory</CODE> is specified, the value in the VAL field can be set externally via dbPuts at run-time. If <CODE>closed_loop</CODE> is specified, the VAL field's value is obtained from the address specified in the desired output location (DOL) field which can be either a database link or a channel access link. To achieve continuous control, a database link to a control algorithm record should be entered in the DOL field.<br /> <br /> [[RRM 3-14 Concepts#Address Specification|Address Specification]] presents more information on database addresses and links. [[RRM 3-14 Concepts#Scanning Specification|Scanning Specification]] explains the effect of database linkage on scanning.<br /> <br /> <TABLE BORDER="1"><br /> <TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>DOL<TD>Desired Output Location (Input Link)<TD>INLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR><br /> <TD>OMSL<TD>Output Mode Select<TD>[[RRM 3-14 Menu Choices#menuOmsl|menuOmsl]]<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<br /> </TABLE><br /> <br /> === Convert and Write Parameters ===<br /> <br /> These parameters are used to determine where the binary output writes to and how to convert the engineering units to a raw signal. After VAL is set and forced to be either 1 or 0, as the result of either a dbPut or a new value being retrieved from the link in the DOL field, then what happens next depends on which device support routine is used and how the HIGH field is configured.<br /> <br /> If the <CODE>Soft Channel</CODE> device support routine is specified, then the device support routine writes the VAL field's value to the address specified in the OUT field. Otherwise, RVAL is the value finally written by the device support routines after being converted.<br /> <br /> If VAL is equal to 0, then the record processing routine sets RVAL equal to zero. When VAL is not equal to 0, then RVAL is set equal to the value contained in the MASK field. (MASK is set by the device support routines and is of no concern to the user.) Also when VAL is not 0 and after RVAL is set equal to MASK, the record processing routine checks to see if the HIGH field is greater than 0. If it is, then the routine will process the record again with VAL set to 0 after the number of seconds specified by HIGH. Thus, HIGH implements a momentary output which changes the state of the device back to 0 after ''N'' number of seconds.<br /> <br /> <TABLE BORDER="1"><br /> <TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>DTYP<TD>Device Type<TD>DEVCHOICE<TD>Yes<TD>0<TD>Yes<TD>No<TD>No<TD>&nbsp;<TR><br /> <TD>OUT<TD>Output Link<TD>OUTLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR><br /> <TD>VAL<TD>Value Field<TD>ENUM<TD>No<TD>0<TD>Yes<TD>Yes<TD>Yes<TD>Yes<TR><br /> <TD>RVAL<TD>Raw Data Value<TD>ULONG<TD>No<TD>0<TD>Yes<TD>Yes<TD>Yes<TD>Yes<TR><br /> <TD>HIGH<TD>Seconds to Hold High<TD>FLOAT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>ZNAM<TD>Zero Name<TD>STRING [20]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>ONAM<TD>One Name<TD>STRING [20]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>Yes<br /> </TABLE><br /> <br /> <br /> ==== Conversion Parameters ====<br /> <br /> The ZNAM field has the string that corresponds to the 0 state, and the ONAM field holds the string that corresponds to the 1 state. These fields, other than being used to tell the operator what each state represents, are used to perform conversions if the value fetched by DOL is a string. If it is, VAL is set to the state correspond to that string. For instance, if the value fetched is the string "Off" and the ZNAM string is "Off," then VAL is set to 0.<br /> <br /> After VAL is set, if VAL is equal to 0, then the record processing routine sets RVAL equal to zero. When VAL is not equal to 0, then RVAL is set equal to the value contained in the MASK field. (MASK is set by the device support routines and is of no concern to the user.) Also when VAL is equal to 1 and after RVAL is set equal to MASK, the record processing routine checks to see if the HIGH field is greater than 0. If it is, then the routine process the record again with VAL=0 after the number of seconds specified by HIGH. Thus, HIGH implements a latched output which changes the state of the device or link to 1, then changes it back to 0 after N number of seconds.<br /> <br /> <TABLE BORDER="1"><br /> <TD>ZNAM<TD>ASCII string defining state zero<TR><br /> <TD>ONAM<TD>ASCII string defining state one<TR><br /> <TD>HIGH<TD>If this value is greater than zero, then whenever VAL is set equal to 1, it is reset to zero after HIGH seconds.<br /> </TABLE><br /> <br /> <br /> ==== Output Specification ====<br /> <br /> The OUT field specifies where the binary output record writes its output. It must specify the address of an I/O card if the record sends its output to hardware, and the DTYP field must contain a the corresponding device support module. Be aware that the address format differs according to the I/O bus used. See [[RRM 3-14 Concepts#Address Specification|Address Specification]] for information on the format of hardware addresses. You can see a list of the device support modules currently supported at the user's local site by using the <CODE>dbst</CODE> utility in R3.13.<br /> <br /> Otherwise, if the record is configured to use the soft device support modules, then it can be either a database link, a channel access link, or a constant. Be aware that nothing will be written when OUT is a constant. See [[RRM 3-14 Concepts#Address Specification|Address Specification]] for information on the format of database and channel access addresses. Also, see [[#Device Support For Soft Records|Device Support For Soft Records]] in this chapter for more on output to other records.<br /> <br /> === Operator Display Parameters ===<br /> <br /> These parameters are used to present meaningful data to the operator. The <CODE>get_enum_str</CODE> record support routine can retrieve the state string corresponding to the VAL's state. So if the value is 1, <CODE>get_enum_str</CODE> will return the string in the ONAM field; and if 0, <CODE>get_enum_str</CODE> will return the ZNAM string.<br /> <br /> See [[RRM 3-14 dbCommon#Fields Common to All Record Types|Fields Common to All Record Types]] for more on the record name (NAME) and description (DESC) fields.<br /> <br /> <TABLE BORDER="1"><br /> <TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>ZNAM<TD>Zero Name<TD>STRING [20]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>ONAM<TD>One Name<TD>STRING [20]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>NAME<TD>Record Name<TD>STRING [29]<TD>Yes<TD>0<TD>Yes<TD>No<TD>No<TD>No<TR><br /> <TD>DESC<TD>Description<TD>STRING [29]<TD>Yes<TD>Null<TD>Yes<TD>Yes<TD>No<TD>No<br /> </TABLE><br /> <br /> <br /> === Alarm Parameters ===<br /> <br /> These parameters are used to determine the binary output's alarm condition and to determine the severity of that condition. The possible alarm conditions for binary outputs are the SCAN, READ , INVALID, and state alarms. The user can configure the state alarm conditions using these fields.<br /> <br /> The possible values for these fields are <CODE>NO_ALARM</CODE>, <CODE>MINOR</CODE>, and <CODE>MAJOR</CODE>. The ZSV holds the severity for the zero state; OSV for the one state. COSV is used to cause an alarm whenever the state changes between the states (0-1, or 1-0) and its severity is configured as MINOR or MAJOR.<br /> <br /> See [[RRM 3-14 Common#Invalid Alarm Output Action|Invalid Alarm Output Action]] for more information on the IVOA and IVOV fields. [[RRM 3-14 dbCommon#Alarm Fields|Alarm Fields]] lists other fields related to a alarms that are common to all record types.<br /> <br /> <TABLE BORDER="1"><br /> <TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>ZSV<TD>Zero Severity<TD>[[RRM 3-14 Menu Choices#menuAlarmSevr|menuAlarmSevr]]<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>OSV<TD>One Severity<TD>[[RRM 3-14 Menu Choices#menuAlarmSevr|menuAlarmSevr]]<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>COSV<TD>Change of State Severity<TD>[[RRM 3-14 Menu Choices#menuAlarmSevr|menuAlarmSevr]]<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>Yes<TR><br /> <TD>IVOA<TD>Invalid Alarm<TD>[[RRM 3-14 Menu Choices#menuIvoa|menuIvoa]]<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>IVOV<TD>Invalid Alarm Output Value<TD>USHORT<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<br /> </TABLE><br /> <br /> === Run-Time and Simulation Mode Parameters ===<br /> <br /> These parameters are used by the run-time code for processing the binary output. They are not configurable using a configuration tool. They represent the current state of the binary output.<br /> <br /> ORAW is used to determine if monitors should be triggered for RVAL at the same time they are triggered for VAL.<br /> <br /> MASK is given a value by the device support routines and should not concern the user.<br /> <br /> The RBV field is also set by device support. It is the actual read back value obtained from the hardware itself or from the associated device driver. The ORBV field is used to decide if monitors should be triggered for RBV at the same time monitors are triggered for changes in VAL. <br /> <br /> The LALM field holds the value of the last occurrence of the change of state alarm. It is used to implement the change of state alarm, and thus only has meaning if COSV is MINOR or MAJOR.<br /> <br /> The MLST is used by the <CODE>process</CODE> record support routine to determine if archive and value change monitors are invoked. They are if MLST is not equal to VAL.<br /> <br /> The WPDT field is a private field for honoring seconds to hold HIGH.<br /> <br /> <TABLE BORDER="1"><br /> <TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>ORAW<TD>Old Raw Value<TD>ULONG<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>No<TR><br /> <TD>MASK<TD>Hardware Mask<TD>ULONG<TD>No<TD>compute<TD>Yes<TD>No<TD>No<TD>No<TR><br /> <TD>RBV<TD>Readback Value<TD>ULONG<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>No<TR><br /> <TD>ORBV<TD>Old Readback Value<TD>ULONG<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>No<TR><br /> <TD>LALM<TD>Last Alarmed Value<TD>USHORT<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>No<TR><br /> <TD>MLST<TD>Last Monitored Value<TD>USHORT<TD>No<TD>0<TD>Yes<TD>No<TD>No<TD>No<TR><br /> <TD>RPVT<TD>Record Private<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>No<TR><br /> <TD>WDPT<TD>Watchdog Pointer<TD>NOACCESS<TD>No<TD>0<TD>No<TD>No<TD>No<TD>No<br /> </TABLE><br /> <br /> The following fields are used to operate the binary output in the simulation mode. See [[RRM 3-14 Common#Fields Common to Many Record Types|Fields Common to Many Record Types]] for more information on these fields.<br /> <br /> <TABLE BORDER="1"><br /> <TH>Field<TH>Summary<TH>Type<TH>DCT<TH>Initial<TH>Access<TH>Modify<TH>Rec Proc Monitor<TH>PP<TR><br /> <TD>SIOL<TD>Simulation Value Location<TD>INLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR><br /> <TD>SIML<TD>Simulation Mode Location<TD>INLINK<TD>Yes<TD>0<TD>No<TD>No<TD>N/A<TD>No<TR><br /> <TD>SIMM<TD>Simulation Mode<TD>[[RRM 3-14 Menu Choices#menuSimm|menuSimm]]<TD>No<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<TR><br /> <TD>SIMS<TD>Simulation Mode Alarm Severity<TD>[[RRM 3-14 Menu Choices#menuAlarmSevr|menuAlarmSevr]]<TD>Yes<TD>0<TD>Yes<TD>Yes<TD>No<TD>No<br /> </TABLE><br /> <br /> == Record Support ==<br /> <br /> === Record Support Routines ===<br /> <br /> <br /> ==== init_record ====<br /> <br /> This routine initializes SIMM if SIML is a constant or creates a channel access link if SIML is PV_LINK. If SIOL is PV_LINK a channel access link is created .<br /> <br /> This routine next checks to see that device support is available. The routine next checks to see if the device support write routine is defined.<br /> <br /> If either device support or the device support write routine does not exist, an error message is issued and processing is terminated.<br /> <br /> If DOL is a constant, then VAL is initialized to 1 if its value is nonzero or initialized to 0 if DOL is zero, and UDF is set to FALSE.<br /> <br /> If device support includes init_record, it is called. VAL is set using RVAL, and UDF is set to FALSE.<br /> <br /> <br /> ==== process ====<br /> <br /> See next section.<br /> <br /> ==== get_value ====<br /> <br /> Fills in the values of struct valueDes so that they refer to VAL.<br /> <br /> ==== get_enum_str ====<br /> <br /> Retrieves ASCII string corresponding to VAL.<br /> <br /> ==== get_enum_strs ====<br /> <br /> Retrieves ASCII strings for ZNAM and ONAM.<br /> <br /> ==== put_enum_str ====<br /> <br /> Checks if string matches ZNAM or ONAM, and if it does, sets VAL.<br /> <br /> === Record Processing ===<br /> <br /> Routine process implements the following algorithm:<br /> <br /> # Check to see that the appropriate device support module exists. If it doesn't, an error message is issued and processing is terminated with the PACT field still set to TRUE. This ensures that processes will no longer be called for this record. Thus error storms will not occur.<br /> # If PACT is FALSE<br /> #* if DOL is DB_LINK and OMSL is CLOSED_LOOP<br /> #** get value from DOL<br /> #** check for link alarm<br /> #** force VAL to be 0 or 1<br /> #** if MASK is defined<br /> #*** if VAL is 0 set RVAL = 0<br /> #** else set RVAL = MASK<br /> # Check alarms: This routine checks to see if the new VAL causes the alarm status and severity to change. If so, NSEV, NSTA and LALM are set.<br /> # Check severity and write the new value. See [[RRM 3-14 Common#Invalid Alarm Output Action|Invalid Alarm Output Action]] for more information on how INVALID alarms affect output.<br /> # If PACT has been changed to TRUE, the device support write output routine has started but has not completed writing the new value. In this case, the processing routine merely returns, leaving PACT TRUE.<br /> # Check WAIT. If VAL is 1 and WAIT is greater than 0, process again with a VAL=0 after WAIT seconds.<br /> # Check to see if monitors should be invoked.<br /> #* Alarm monitors are invoked if the alarm status or severity has changed.<br /> #* Archive and value change monitors are invoked if MLST is not equal to VAL.<br /> #* Monitors for RVAL and for RBV are checked whenever other monitors are invoked.<br /> #* NSEV and NSTA are reset to 0.<br /> # Scan forward link if necessary, set PACT FALSE, and return.<br /> <br /> <br /> == Device Support ==<br /> <br /> === Fields Of Interest To Device Support ===<br /> <br /> Each binary output record must have an associated set of device support routines. The primary responsibility of the device support routines is to write a new value whenever write_bo is called. The device support routines are primarily interested in the following fields:<br /> <br /> <TABLE BORDER="1"><br /> <TH>Name<TH>Summary<TH>Description<TR><br /> <TD>PACT<TD>Processing Active<TD rowspan=4>See [[RRM 3-14 dbCommon#Fields Common to All Record Types|Fields Common to All Record Types]] for an explanation of these fields.<TR><br /> <TD>DPVT<TD>Device Private<TR><br /> <TD>NSEV<TD>New Alarm Severity<TR><br /> <TD>NSTA<TD>New Alarm Status<TR><br /> <TD>VAL<TD>Value Field<TD>This field is only of interest to device support routines that do not use MASK and RVAL.<TR><br /> <TD>OUT<TD>Output Link<TD>This field is used by the device support routines to locate its output.<TR><br /> <TD>RVAL<TD>Raw Data Value<TD>If MASK is defined then record support sets RVAL=(0,MASK) if VAL is (0, not zero).<TR><br /> <TD>MASK<TD>Hardware mask.<TD>The device support module must set this field. Not that if VAL is 1, then record processing sets RVAL = MASK.<TR><br /> <TD>RBV<TD>Read Back Value<TD>This is the actual read back value obtained from the hardware itself or from the associated device driver. It is the responsibility of the device support routine to give this field a value.<br /> </TABLE><br /> <br /> <br /> === Device Support routines ===<br /> <br /> Device support consists of the following routines:<br /> <br /> ==== report ====<br /> <br /> report(FILE fp, paddr)<br /> <br /> Not currently used.<br /> <br /> ==== init ====<br /> <br /> init()<br /> <br /> This routine is called once during IOC initialization.<br /> <br /> ==== init_record ====<br /> <br /> init_record(precord)<br /> <br /> This routine is optional. If provided, it is called by the record support init_record routine. It should determine MASK if it is needed.<br /> <br /> * 0: Success. RVAL modified (VAL will be set accordingly)<br /> * 2: Success. VAL modified<br /> * other: Error.<br /> <br /> ==== get_ioint_info ====<br /> <br /> get_ioint_info(int cmd,struct dbCommon *precord,IOSCANPVT *ppvt)<br /> <br /> This routine is called by the ioEventScan system each time the record is added or deleted from an I/O event scan list. cmd has the value (0,1) if the record is being (added to, deleted from) an I/O event list. It must be provided for any device type that can use the ioEvent scanner.<br /> <br /> ==== write_bo ====<br /> <br /> write_bo(precord)<br /> <br /> This routine must output an new value. It returns the following values:<br /> <br /> * 0: Success.<br /> * other: Error.<br /> <br /> === Device Support For Soft Records ===<br /> <br /> Two soft device support modules <CODE>Soft Channel</CODE> and <CODE>Raw Soft Channel</CODE> are provided for output records not related to actual hardware devices. The OUT link type must be either a CONSTANT, DB_LINK, or CA_LINK.<br /> <br /> ==== Soft Channel ====<br /> <br /> This module writes the current value of VAL.<br /> <br /> If the OUT link type is PV_LINK, then dbCaAddInlink is called by init_record. init_record always returns a value of 2, which means that no conversion will ever be attempted. write_bo calls recGblPutLinkValue to write the current value of VAL. See [[RRM 3-14 Common#Soft Output|Soft Output]] for details.<br /> <br /> ==== Raw Soft Channel ====<br /> <br /> This module is like the previous except that it writes the current value of RVAL.<br /> <br /> <br /> ----<br /> <br /> <br /> EPICS Record Reference Manual - 19 MAY 1998</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=Common_Database_patterns&diff=1851 Common Database patterns 2010-03-23T16:35:39Z

<p>MichaelDavidsaver: </p> <hr /> <div>== Combined Setting and Readback ==<br /> <br /> Use when a single PV is desired. Could be used to show the results of rounding in a float to fixed precision conversion.<br /> <br /> In the following example the value read from a 'bi' is inverted so that the associated 'bo' acts as a toggle.<br /> <br /> record(bi, "$(P):rbv") {<br /> field(DTYP, "...")<br /> field(INP , "...")<br /> field(PINI, "YES")<br /> field(FLNK, "$(P):inv")<br /> }<br /> <br /> record(calcout, "$(P):inv")<br /> field(CALC, "!A")<br /> field(INPA, "$(P):rbv")<br /> field(OUT , "$(P) NPP")<br /> }<br /> <br /> record(bo, "$(P)") {<br /> field(DTYP, "...")<br /> field(OUT , "...")<br /> field(FLNK, "$(P):rbv")<br /> }<br /> <br /> The important point is the <i>NPP</i> modifier on output link of the 'calcout' record. This updates the <i>VAL</i> field of the 'bo' record (and posts monitors) without processing it.</div>

MichaelDavidsaver https://wiki-ext.aps.anl.gov/epics/index.php?title=HowTo_Documents&diff=1797 HowTo Documents 2010-03-23T16:22:38Z

<p>MichaelDavidsaver: Link to database patterns page</p> <hr /> <div>This is a directory of various How-To documents written by members of the EPICS collaboration. Contributions to this page are most welcome!<br /> <br /> === EPICS Base on Different Architectures and Operating Systems ===<br /> <br /> * [http://www.aps.anl.gov/epics/base/RTEMS/tutorial/ Getting Started with EPICS on RTEMS]<br /> * [[HowToPC104|Getting Started with R3.14.7 on a PC104 running Linux]]<br /> * [[How To Port EPICS to a new OS/Architecture]]<br /> <br /> === Drivers and Device Support ===<br /> <br /> * [http://www.aps.anl.gov/epics/modules/soft/asyn/R4-8/tutorial.html How To Do Serial (using Asyn Driver)]<br /> * [http://www.aps.anl.gov/epics/modules/soft/asyn/BeginnerGuideToASYN-VXI11.pdf Beginners Guide to using VXI-11 (with Asyn Driver)]<br /> * [[How to make your EPICS driver operating system independent]]<br /> * [[How To Write Device Support that uses Asyn Driver]] ''(Incomplete!)''<br /> * [[How to use GPIB ports with linux-gpib and StreamDevice]]<br /> * [[Common Database patterns]]<br /> <br /> === Applications ===<br /> <br /> * [[How To Install Channel Archiver On Scientific Linux]]<br /> * [[What PV Save and Restore Tools are available]]<br /> <br /> === Infrastructure and Other Stuff ===<br /> <br /> * [[How To Set Up a Linux Box as an IOC Boot Server]]<br /> * [[How To Set Up a Mirror of the EPICS Web Site]]<br /> * [[How to Set Up a Soft IOC Framework on Linux]]<br /> * [[How to Set Up Console Access and Logging for VME and Soft IOCs]]<br /> * [[How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network]]<br /> <br /> === Collaboration Stuff ===<br /> <br /> * [[How to run an EPICS Collaboration Meeting]]</div>

MichaelDavidsaver