Back to home page

Enduro/X

 
 

    


0001 # endurox
0002 EnduroX is Open Source Middleware Platform for Distributed Transaction Processing
0003 
0004 Platform provides X/Open XATMI and XA APIs for C/C++ applications. EnduroX can be considered as replacement for Oracle(R) Tuxedo(R), Jboss Blacktie (Narayan), Hitachi OpenTP1 and other XATMI middlewares.
0005 
0006 EnduroX provides SOA architecture for C/C++ applications and allows to cluster application in fault tolerant way over multiple physical servers. EnduroX provides Oracle(R) Tuxedo(R) FML/FML32 library emulation, including boolean expressions. Other Tuxedo specific APIs are supported, such as tpforward() and work with distributed transactions (tpbegin(), tpcommit(), etc.).
0007 
0008 EnduroX have binddings for:
0009 - Golang (client & server)
0010 - PHP (client)
0011 - Perl (client & server)
0012 - Python (client & server)
0013 - Node.js (client)
0014 
0015 ![Alt text](doc/Endurox-product.jpg?raw=true "Enduro/x overview")
0016 
0017 # Load balancing
0018 
0019 ![Alt text](doc/endurox-load-balance.jpg?raw=true "Enduro/x service load balancer")
0020 
0021 Supported operating system: GNU/Linux, starting from 2.6.12 kernel (needed for POSIX Queues). Starting with Enduro/X Version 3.1.2 IBM AIX (6.1 and 7.1), Oracle Solaris 11, MAC OS X (experimental) and Cygwin (experimental) support is added. Supported compilers: gcc, LLVM clang, IBM xlC.
0022 
0023 - Build and installation guides are located at: www.endurox.org/dokuwiki
0024 
0025 - Support forum: http://www.endurox.org/projects/endurox/boards
0026 
0027 - Binary builds (RPMs & DEBs) for various platforms are here: http://www.endurox.org/projects/endurox/files
0028 
0029 - Documentation available here: http://www.endurox.org/dokuwiki/doku.php
0030 
0031 - Source corss reference: http://www.silodev.com/lxr/source
0032 
0033 PS, feel free to contact me at madars@mavimax.com. I will gladly help you to get EnduroX running ;)
0034 
0035 # Call/message forwarding
0036 
0037 ## Instead of doing calls to each server separately...
0038 
0039 ![Alt text](doc/exforward_tpcall.png?raw=true "Classical service orchestration")
0040 
0041 This is typciall way for example if doing micro-services with HTTP/REST. You need to do the calls to each service separately. And that is extra overhead to system (multiple returns) and the caller must orchestrate the all calls.
0042 
0043 ## ...Enduro/X offers much effective way - tpforward() where request is passed around the system
0044 
0045 ![Alt text](doc/exforward_forward.png?raw=true "Enhanced service orchestration by forwarding the call")
0046 
0047 In this case the destination service orchestrates the system, it is up to service to choose the next service which will continue the call processing. The caller is not aware of final service which will do the reply back (tpreturn()).
0048 
0049 Note that service after doing "tpforward()" becomes idle and can consume next call.
0050 
0051 # High availability and self healing
0052 
0053 Enduro/X is capable of detecting stalled/hanged XATMI servers and gracefully can reboot them. The ping times are configurable on per server basis. In case if main daemon dies, it is possible to configure special XATMI server named "tprecover" which monitors "ndrxd" and vice versa, ndrxd can monitor tprecover. Thus if any of these services are not cleanly shut down, then system will heal it self, and boot service/daemons back.
0054 
0055 The ndrxd learning mode is some period of time (configurable) in which ndrxd will request all the system for active servers and their services, to get back the view of the system and be in control. Note that system is able to work even with out ndrxd, but at that time no server healing and management will be done.
0056 
0057 ![Alt text](doc/server_monitoring_and_recovery.png?raw=true "Enduro/X high availability facility")
0058 
0059 # Real time system patching
0060 
0061 It is possible to patch the Enduro/X system (update stateless XATMI servers) without service interruption. This is achieved by following scheme:
0062 
0063 ![Alt text](doc/rt-patching.png?raw=true "Enduro/X real time patching")
0064 
0065 # Performance
0066 
0067 Due to fact that Enduro/X uses memory based queues, performance numbers are quite high:
0068 
0069 ## ATMI client calls server in async way (tpacall(), no reply from server)
0070 
0071 ![Alt text](doc/benchmark/04_tpacall.png?raw=true "Local tpcall() performance")
0072 
0073 
0074 ## Local one client calls server, and gets back response:
0075 
0076 ![Alt text](doc/benchmark/01_tpcall.png?raw=true "Local tpcall() performance")
0077 
0078 ## Multiple clients calls multiple servers
0079 
0080 ![Alt text](doc/benchmark/03_tpcall_threads.png?raw=true "Multiprocessing tpcall() performance")
0081 
0082 ## Single client calls single server via network (two app servers bridged)
0083 
0084 ![Alt text](doc/benchmark/02_tpcall_network.png?raw=true "Network tpcall() performance")
0085 
0086 ## Persistent storage (message enqueue to disk via tpenqueue())
0087 The number here are lower because messages are being saved to disk. Also internally XA transaction is used, which also requires logging to stable storage.
0088 
0089 ![Alt text](doc/benchmark/05_persistent_storage.png?raw=true "Network tpenqueue() performance")
0090 
0091 # Releases
0092 
0093 - Version 2.5.1 released on 18/05/2016. Support for transactional persistent message queues. Provides APIs: tpenqueue(), tpdequeue() and command line management tools. See doc/persistent_message_queues_overview.adoc, doc/manpage/tmqueue.adoc, doc/manpage/xadmin.adoc, doc/manpage/q.config.adoc. Use cases can be seen under atmitests/test028_tmq
0094 
0095 - Version 3.1.2 released on 25/06/2016. Added support for other Unix systems. Currently production grade support is provided for following operating systems: GNU/Linux, FreeBSD, IBM AIX and Oracle Solaris. MAC OS X and Cygwin versions are considered as experimental. FreeBSD installation guides are located at doc/freebsd_notes.adoc, AIX install guide: doc/aix_notes.adoc, Solaris install guide: doc/solaris_notes.adoc and OS X guide: doc/osx_notes.adoc. Also with this version lot of core processing bug fixes are made.
0096 
0097 - Version 3.2.1 released on 06/07/2016. Major UBF optimization. Now for each data type memory offset is maintained. For fixed data types (short, long, char, float, double) binary search is performend when field is read from buffer.
0098 
0099 - Version 3.2.2 released on 15/07/2016. Bugfixes for UBF binary search. Added UBF benchmarking scripts and documents.
0100 
0101 - Version 3.3.1 released on 05/09/2016. Implemented common configuration engine (can use ini files in alternative to environment variables, debug config and persistent queue config).
0102 
0103 - Version 3.3.2 released on 01/10/2016. Works on TP logger, user accessible logging framework. Set of tplog\* functions.
0104 
0105 - Version 3.3.5 released on 10/01/2017. Fixes for RPM build and install on Red-hat enterprise linux platform.
0106 
0107 - Version 3.3.6 released on 12/01/2017. Fixes for integration mode, changes in tpcontinue().
0108 
0109 - Version 3.4.1 released on 13/01/2017. New ATMI server flag for developer - reloadonchange - if cksum change changed on binary issue sreload.
0110 
0111 - Version 3.4.2 released on 20/01/2017. Network protocol framing moved from 2 bytes to 4 bytes.
0112 
0113 - Version 3.4.3 released on 26/01/2017. Memory leak fixes for tmsrv and tmqueue servers.
0114 
0115 - Version 3.4.4 released on 26/01/2017. Works on documentation. Fixes on PScript.
0116 
0117 - Version 3.4.5 released on 14/02/2017. Fixes in generators.
0118 
0119 - Version 3.5.1 released on 03/03/2017. Updates on tpreturn() - more correct processing as in Tuxedo, free up return buffer + free up auto buffer.
0120 
0121 - Version 3.5.2 released on 24/03/2017. Bug #105 fix. Abort transaction if it was in "preparing" stage, and tmsrv loaded it from logfile. Meaning that caller alaready do not wait for tpcommit() anymore and got inconclusive results, thus better to abort. 
0122 
0123 - Version 3.5.3 released on 26/03/2017. Fixes for Solaris, Sun Studio (SUNPRO) compiler
0124 
0125 - Version 3.5.4 released on 01/03/2017. Fixed bug #108 - possible CPM crash
0126 
0127 - Version 3.5.5 released on 23/03/2017. Works Feature #113 - mqd_t use as file descriptor - for quick poll operations.
0128 
0129 - Version 3.5.6 released on 02/04/2017. Fixed issues with possible deadlock for poll mode on bridge service calls. Fixed issuw with 25 day uptime problem for bridges on 32bit platfroms - the messages becomes expired on target server. Issues: #112, #145, #140, #139, #113
0130 
0131 - Version 3.5.7 release on 23/04/2017. Fixed Bug #148 (Bdelall corrupts ubf buffer)
0132 Bug #110 (tpbridge does not report connection status to ndrxd after ndrxd is restarted for recovery)
0133 
0134 - Version 3.5.9 released on 22/06/2017. Bug fix #160 - retry xa_start with xa_close/xa_open. New env variable NDRX_XA_FLAGS, tag "RECON".
0135 
0136 - Version 4.0.1 released on 29/06/2017. Multi-threaded bridge implementation. tpnotify(), tpbroadcast(), tpsetunsol(), tpchkunsol() API implementation.
0137 
0138 - Version 4.0.2 released on 19/07/2017. Fixed ndrxd core dump issue Bug #174.
0139 
0140 - Version 4.0.3 released on 26/07/2017. Fixes of #176 #178. NDRX_DUMP, UBF_DUMP fixes.
0141 
0142 - Version 4.0.4 released on 29/07/2017. Feature #162 - added evt_mib.h
0143 
0144 - Version 4.0.5 released on 01/08/2017. Feature #180 - refactoring code towards ISO/IEC 9899:201x standard.
0145 
0146 - Version 5.0.1 released on 21/08/2017. Feature #96 - Typed View support, Bug #182 - fix in bridge protocol.
0147 
0148 - Version 5.0.2 released on 22/08/2017. Bug #183
0149 
0150 - Version 5.0.3 released on 22/08/2017. Bug #186
0151 
0152 - Version 5.0.4 released on 22/08/2017. Bug #186
0153 
0154 - Version 5.0.5 released on 27/08/2017. Bug #184, Bug #191, Bug #190, Bug #192, Bug #193
0155 
0156 - Version 5.0.6 released on 28/08/2017. Bug #195
0157 
0158 - Version 5.0.7 released on 01/09/2017. Feature #161 - tmsrv database pings & automatic reconnecting in case of network failures.
0159 
0160 - Version 5.0.8 released on 17/09/2017. Works on dynamic view access. #99, #206, #207, #210
0161 
0162 - Version 5.0.9 released on 27/09/2017. (development) Works on #224
0163 
0164 - Version 5.0.10 released on 13/10/2017. (stable) Feature #232, Feature #231, -O2 optimization by default
0165 
0166 - Version 5.1.1  released on 13/10/2017. (development) Feature #127, Bug #229, Feature #230, Bug #234, Feature #244, Bug #243, Feature #248, Bug #240, Bug #238 - basically big message size support (over the 64K)
0167 
0168 # Build configurations
0169 
0170 ## Configure make with: 
0171 
0172 $ cmake -DCMAKE_INSTALL_PREFIX:PATH=`pwd`/dist .
0173 
0174 ### Flags:
0175 
0176 - To disable GPG_ME, pass additional flag to cmake '-DDEFINE_DISABLEGPGME=ON'
0177 - To disable documentation building add '-DDEFINE_DISABLEDOC=ON'
0178 - To enable poll() use instead of epoll() in Linux use '-DDEFINE_FORCEPOLL=ON'
0179 - To disable platform script building use '-DDEFINE_DISABLEPSCRIPT=ON'
0180 - To do release build, use '-DDEFINE_RELEASEBUILD=ON'
0181 - To force use emulated message queue, add '-DDEFINE_FORCEEMQ=ON'
0182 - To log the memory allocation to user log add '-DNDRX_MEMORY_DEBUG=1' 
0183 - To trace of the Object-API use '-DNDRX_OAPI_DEBUG=1' 
0184 - To enable file descriptor based treating of the queues '-DDEFINE_FORCEFDPOLL=ON'
0185 - To trace of the Semaphore handling use '-DNDRX_SEM_DEBUG=1'