Changelog
The midas git repository uses tags to denote specific releases. Tags are of the format midas-YEAR-MONTH-SUFFIX
, e.g. midas-2019-06-b
. This page details the major changes in each release, and highlights how to update client code to adapt to any changes that are not backwards-compatible.
2019-06
Releases midas-2019-06-a
, midas-2019-06-b
.
Relevant elog entries - 1564 (midas-2019-06 with cmake and c++) and 1526 (How to convert C midas frontends to C++).
Improvements
- Migration from C to C++. You will have to make changes to your clients (see upgrade guide below).
- Ability to compile using cmake/cmake3 as well as make. To use cmake, you can either build manually with
mkdir build; cd build; cmake ..; make; make install
, or use the handy shortcutmake cmake3
. Note that the location where libraries and executables are built has changed - the OS-specific subdirectories (e.g./linux/lib
) has been replaced by a common/lib
and/bin
. - mxml and mscb are now included as git submodules. See the "upgrade guide" instructions for how to checkout the latest version of these modules.
Bug fixes
- 183 - mhttpd could write garbage to midas.log, which would break webpages that try to show messages
- 181 - race condition between msequencer and mhttpd could make sequencer webpage buttons useless
- 171 - make RPC calls more thread-safe
- 180 - addition of strcomb1 which is thread-safe; strcomb will be deprecated
- 179 - don't try to send an ODB dump to mlogger's ROOT output, as it would crash mlogger
- 184 - don't trap the user in an error loop if elog doesn't exist
- Minor fixes and stability improvements
Known issues
- cmake/cmake3 - ZLIB support is not detected, so gzipped files cannot be written by the logger. Will be fixed in the next release, or you can update midas to a commit after August 2.
- mxml can segfault due to a double free. Will be fixed in the next release, or you can update mxml to commit f6fc49d:
cd mxml; git checkout f6fc49d; cd ..
and re-compile midas.
Upgrade guide
Updating midas
# Grab the new code git checkout develop git pull git checkout midas-2019-06-b git pull git submodule update --init # this will checkout correct versions of mxml and mscb # Tidy up the old build - be sure to delete the deprecated linux directory! make clean make cclean rm -rf linux/bin rm -rf linux/lib rmdir linux # Build the new midas make cmake3 # or "make cmake" on ubuntu and macos
If you have a script that sets up environment variables, you should change PATH
from $MIDASSYS/linux/bin
to $MIDASSYS/bin
.
You should then restart mserver
, mlogger
, mhttpd
, and any other midas programs that you run.
Cleanup old packages that are now submodules
As mxml and mscb are included as submodules now, you can remove the external packages that were downloaded previously (assuming they aren't used by other experiments on the same machine). E.g.
rm -r $HOME/packages/mxml # new location $MIDASSYS/mxml rm -r $HOME/packages/mscb # new location $MIDASSYS/mscb
Update experiment frontends
The migration from C to C++ is one of the biggest user-facing changes in midas for a long time. Unfortunately it requires manual work from experimenters to update their client code:
- Update your Makefile
- Update library search path for code that links against libmidas or mfe.o (
$MIDASSYS/linux/lib
becomes$MIDASSYS/lib
) - If you reference mxml in your Makefile, change the include path to
$MIDASSYS/mxml
- If you explicitly have the compiler as
gcc
, change it tog++
- Update library search path for code that links against libmidas or mfe.o (
- Update frontend code to use mfe.h and build as C++
- Add
#include "mfe.h"
after includingmidas.h
- Remove
extern C
brackets around mfe-related code. Ideally there should be noextern C
brackets anywhere. - Ensure that
frontend_name
andfrontend_file_name
areconst char*
rather thanchar*
. - If you define your own global
HNDLE hDB
, change it toextern HNDLE hDB
to pick up the one provided by mfe. - Ensure that
poll_event
andinterrupt_configure()
useINT
rather thanINT[]
for thesource
argument. - If you use
extern int frontend_index
, change it to use theget_frontend_index()
function from mfe.h instead. - Ensure that the last argument to
bk_create
is cast to(void**)
- Add
- Try to compile, and fix any more compilation errors. Examples may include:
- Duplicate or mismatched declarations of functions defined in mfe.h (fix the mismatched declarations in your code)
bool debug
colliding with declaration in mfe.h (suggest to rename the variable in the client)- Return value of
malloc()
etc needs to be cast to the correct data type (e.g.char* s = (char*)malloc(...)
)
An example diff of a frontend is:
#include "midas.h" + #include "mfe.h" #include "msystem.h" #include "utils1.h" - #ifdef __cplusplus - extern "C" { - #endif - char *frontend_name = FE_NAME; + const char *frontend_name = FE_NAME; - HNDLE hDB; + extern HNDLE hDB; - #ifdef __cplusplus - } - #endif - extern "C" int frontend_index; INT frontend_init() { - printf("We are running as frontend index %d", frontend_index); + printf("We are running as frontend index %d", get_frontend_index()); return SUCCESS; } - extern "C" INT interrupt_configure(INT cmd, INT[] source, PTYPE adr) { + INT interrupt_configure(INT cmd, INT source, PTYPE adr) { return 0; }
2019-05
Releases midas-2019-05-cxx
and midas-2019-05-before-cmake
were development tags that are not intended to be used more widely.
2019-03
Releases midas-2019-03-f
through midas-2019-03-h
.
Relevant elog entries: 1513 (midas-2019-03-f), 1530 (midas-2019-03-g), 1543 (midas-2019-03-h).
Improvements
To be written...
Bug fixes
To be written...
Known issues
To be written...
Upgrade guide
To be written...