mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-21 08:39:46 +08:00
751300ec59
This is a follow up to PR https://github.com/Unidata/netcdf-c/pull/1173 Sorry that it is so big, but leak suppression can be complex. This PR fixes all remaining memory leaks -- as determined by -fsanitize=address, and with the exceptions noted below. Unfortunately. there remains a significant leak that I cannot solve. It involves vlens, and it is unclear if the leak is occurring in the netcdf-c library or the HDF5 library. I have added a check_PROGRAM to the ncdump directory to show the problem. The program is called tst_vlen_demo.c To exercise it, build the netcdf library with -fsanitize=address enabled. Then go into ncdump and do a "make clean check". This should build tst_vlen_demo without actually executing it. Then do the command "./tst_vlen_demo" to see the output of the memory checker. Note the the lost malloc is deep in the HDF5 library (in H5Tvlen.c). I am temporarily working around this error in the following way. 1. I modified several test scripts to not execute known vlen tests that fail as described above. 2. Added an environment variable called NC_VLEN_NOTEST. If set, then those specific tests are suppressed. This should mean that the --disable-utilities option to ./configure should not need to be set to get a memory leak clean build. This should allow for detection of any new leaks. Note: I used an environment variable rather than a ./configure option to control the vlen tests. This is because it is temporary (I hope) and because it is a bit tricky for shell scripts to access ./configure options. Finally, as before, this only been tested with netcdf-4 and hdf5 support.
90 lines
3.5 KiB
CMake
90 lines
3.5 KiB
CMake
#####
|
|
# Build doxygen documentation, if need be.
|
|
#####
|
|
IF(ENABLE_DOXYGEN)
|
|
# The following is redundant but does not hurt anything.
|
|
|
|
FILE(GLOB COPY_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.html ${CMAKE_CURRENT_SOURCE_DIR}/images ${CMAKE_CURRENT_SOURCE_DIR}/*.doc ${CMAKE_CURRENT_SOURCE_DIR}/*.xml ${CMAKE_CURRENT_SOURCE_DIR}/*.m4 ${CMAKE_CURRENT_SOURCE_DIR}/*.texi ${CMAKE_SOURCE_DIR}/oc2/auth.html.in)
|
|
FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
|
|
|
|
# Set abs_top_srcdir to work with the autotools
|
|
# doxyfile template.
|
|
SET(abs_top_srcdir ${CMAKE_SOURCE_DIR})
|
|
SET(abs_builddir ${CMAKE_CURRENT_BINARY_DIR})
|
|
|
|
# Create general and guide doxyfiles.
|
|
CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
|
|
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
|
|
|
# Generate User Documentation
|
|
ADD_CUSTOM_TARGET(doc_all ALL
|
|
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/auth.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/obsolete/fan_utils.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating API Documentation" VERBATIM)
|
|
|
|
# Create auth.html with some sed commands.
|
|
ADD_CUSTOM_TARGET(oc2-auth
|
|
|
|
cat ${CMAKE_SOURCE_DIR}/oc2/auth.html.in | sed -e "/<OC>/d" | sed -e "s|^<NC>||" | sed -e "s|zz|netcdf|g" -e "s|ZZ|netCDF|g" | sed -e "/stylesheet/r${CMAKE_SOURCE_DIR}/oc2/oc.css" -e "/stylesheet/d" > ${CMAKE_CURRENT_SOURCE_DIR}/auth.html
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/auth.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
VERBATIM
|
|
)
|
|
|
|
# If ENABLE_DOXYGEN_LATEX_OUTPUT is true, automatically build
|
|
# the PDF files.
|
|
IF(ENABLE_DOXYGEN_PDF_OUTPUT)
|
|
# Process 'main' netcdf documentation.
|
|
FIND_PROGRAM(NC_MAKE NAMES make)
|
|
FIND_PROGRAM(NC_PDFLATEX NAMES pdflatex)
|
|
IF(NOT NC_MAKE OR NOT NC_PDFLATEX)
|
|
MESSAGE(WARNING "Unable to locate 'make' and/or 'pdflatex' program. Unable to build pdf documentation.")
|
|
ELSE()
|
|
ADD_CUSTOM_TARGET(doc_all_pdf ALL
|
|
make
|
|
COMMAND mv refman.pdf ../netcdf.pdf
|
|
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/latex_main"
|
|
COMMENT "Building NetCDF PDF Documentation" VERBATIM
|
|
)
|
|
|
|
INSTALL(FILES "${CMAKE_CURRENT_BINARY_DIR}/netcdf.pdf"
|
|
"${CMAKE_CURRENT_BINARY_DIR}/netcdf-guide.pdf"
|
|
"${CMAKE_CURRENT_BINARY_DIR}/netcdf-tutorial.pdf"
|
|
DESTINATION "${CMAKE_INSTALL_DOCDIR}/pdf"
|
|
|
|
COMPONENT documentation)
|
|
|
|
ENDIF()
|
|
|
|
ENDIF()
|
|
|
|
|
|
# Copy the image files used by markdown documentation
|
|
# manually.
|
|
FILE(GLOB IMG_FILES ${CMAKE_CURRENT_BINARY_DIR}/images/*.jpg
|
|
${CMAKE_CURRENT_BINARY_DIR}/images/*.png)
|
|
|
|
FILE(COPY ${IMG_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html)
|
|
|
|
INSTALL(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/"
|
|
DESTINATION "${CMAKE_INSTALL_DOCDIR}/html"
|
|
COMPONENT documentation)
|
|
|
|
ENDIF(ENABLE_DOXYGEN)
|
|
|
|
# Should match list in Makefile.am
|
|
SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST}
|
|
netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html
|
|
mainpage.dox tutorial.dox guide.dox types.dox cdl.dox
|
|
architecture.dox internal.dox windows-binaries.md
|
|
building-with-cmake.md CMakeLists.txt groups.dox install.md notes.md
|
|
install-fortran.md all-error-codes.md credits.md auth.md
|
|
obsolete/fan_utils.html bestpractices.md filters.md indexing.md
|
|
inmemory.md DAP2.dox attribute_conventions.md FAQ.md
|
|
file_format_specifications.md known_problems.md
|
|
COPYRIGHT.dox user_defined_formats.md DAP4.md DAP4.dox)
|
|
|
|
ADD_EXTRA_DIST("${CUR_EXTRA_DIST}")
|