diff --git a/.gitignore b/.gitignore index 32d403a9..67218f60 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,6 @@ CMakeDoxy* # temp unit files fort.* + +# generated subroutines +Source/INCLUDE/*.F90.inc diff --git a/CMakeLists.txt b/CMakeLists.txt index 1df4518a..a6eacb37 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,6 +40,10 @@ set(CMAKE_CONFIGURATION_TYPES CACHE STRING "" FORCE ) +if(NOT CMAKE_BUILD_TYPE) + set(CMAKE_BUILD_TYPE "Debug") +endif() + # suppress cmake warnings for superlu if(NOT DEFINED CMAKE_SUPPRESS_DEVELOPER_WARNINGS) set(CMAKE_SUPPRESS_DEVELOPER_WARNINGS 1 CACHE INTERNAL "No dev warnings") @@ -85,6 +89,7 @@ set(SUPERLU_MT_PATCHES_DIR "${PROJECT_SOURCE_DIR}/superlu_mt_patches") set(METIS_DIR "${PROJECT_SOURCE_DIR}/metis/METIS") set(GKLIB_DIR "${PROJECT_SOURCE_DIR}/metis/GKlib") set(METIS_PATCHES_DIR "${PROJECT_SOURCE_DIR}/metis/metis_patches") +set(GKLIB_PATCHES_DIR "${PROJECT_SOURCE_DIR}/metis/gklib_patches") if(NOT DEFINED TPL_ENABLE_METISLIB) set(TPL_ENABLE_METISLIB ON CACHE BOOL "Enable METIS for SuperLU") @@ -99,6 +104,22 @@ if(TPL_ENABLE_METISLIB) message(FATAL_ERROR "The METIS submodule was not downloaded.") endif() + message(STATUS "Applying patches to GKlib...") + file(GLOB_RECURSE GKLIB_PATCH_FILES RELATIVE "${GKLIB_PATCHES_DIR}" "${GKLIB_PATCHES_DIR}/*") + + foreach(file IN LISTS GKLIB_PATCH_FILES) + set(src "${GKLIB_PATCHES_DIR}/${file}") + set(dst "${GKLIB_DIR}/${file}") + + get_filename_component(dst_dir "${dst}" DIRECTORY) + file(MAKE_DIRECTORY "${dst_dir}") + + message(STATUS " Patching: ${file}") + file(COPY "${src}" DESTINATION "${dst_dir}") + endforeach() + + message(STATUS "GKlib patched.") + message(STATUS "Applying patches to METIS...") file(GLOB_RECURSE METIS_PATCH_FILES RELATIVE "${METIS_PATCHES_DIR}" "${METIS_PATCHES_DIR}/*") @@ -120,11 +141,16 @@ if(TPL_ENABLE_METISLIB) set(METIS_BUILD_PROGRAMS OFF CACHE BOOL "Build METIS command line programs" FORCE) set(GKLIB_PATH "${GKLIB_DIR}" CACHE PATH "GKlib source directory" FORCE) - add_subdirectory("${GKLIB_DIR}" "${CMAKE_BINARY_DIR}/metis/GKlib") - add_subdirectory("${METIS_DIR}" "${CMAKE_BINARY_DIR}/metis/METIS") + # Use a binary directory that is disjoint from the source tree. The MYSTRAN + # build is performed in-source (CMAKE_BINARY_DIR == CMAKE_SOURCE_DIR), so + # using "${CMAKE_BINARY_DIR}/metis/METIS" would make METIS' binary dir alias + # its source dir and cause the patched CMakeLists.txt to overwrite the source + # include/metis.h on every reconfigure (forcing a full METIS rebuild). + add_subdirectory("${GKLIB_DIR}" "${PROJECT_BINARY_DIR}/GKlib") + add_subdirectory("${METIS_DIR}" "${PROJECT_BINARY_DIR}/METIS") set(TPL_METIS_LIBRARIES "${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/libmetis.a;${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/libGKlib.a" CACHE STRING "METIS static libraries" FORCE) - set(TPL_METIS_INCLUDE_DIRS "${CMAKE_BINARY_DIR}/metis/METIS/include" CACHE PATH "METIS include directory" FORCE) + set(TPL_METIS_INCLUDE_DIRS "${PROJECT_BINARY_DIR}/METIS/include" CACHE PATH "METIS include directory" FORCE) message(STATUS "Applying patches to SUPERLU...") file(GLOB_RECURSE SUPERLU_PATCH_FILES RELATIVE "${SUPERLU_PATCHES_DIR}" "${SUPERLU_PATCHES_DIR}/*") @@ -140,7 +166,7 @@ if(TPL_ENABLE_METISLIB) file(COPY "${src}" DESTINATION "${dst_dir}") endforeach() - message(STATUS "SUPERLU patched for METIS") + message(STATUS "SuperLU patched.") endif() set(enable_examples OFF FORCE) @@ -343,7 +369,9 @@ if(NOT BLAS_FOUND) foreach(fname IN LISTS blas_fns) # message(STATUS "Checking for BLAS subr ${fname}") + set(CMAKE_REQUIRED_QUIET TRUE) check_function_exists("${fname}" BLAS_FN_EXISTS) + unset(CMAKE_REQUIRED_QUIET) set(BLAS_FN_EXISTS CACHE "1" STRING) if(NOT BLAS_FN_EXISTS) @@ -413,11 +441,270 @@ if(WIN32) target_sources(mystran PRIVATE mystran.rc) endif() +# ----------------------------------------------------------------------- +# Static library tracking +# +# For every library that is statically linked into mystran we: +# 1. Record a compile-time preprocessor symbol (_STATIC_) +# 2. Record a human-readable filename for the status message +# +# After populating the lists we apply the definitions, print a summary, +# and warn for any symbol not referenced in PRINT_BUILD_INFO.F90. +# ----------------------------------------------------------------------- +set(_MYSTRAN_STATIC_DEFS "") +set(_MYSTRAN_STATIC_NAMES "") + +# f2c is always built and linked as a static archive +list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_F2C) +list(APPEND _MYSTRAN_STATIC_NAMES libf2c.a) + +if(USE_SUPERLU_MT) + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_SUPERLU_MT) + + if(WIN32) + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_WINPTHREAD) + list(APPEND _MYSTRAN_STATIC_NAMES libwinpthread.a) + else() + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_PTHREAD) + + # no name because it's part of glibc + endif() + + if(PLAT STREQUAL "_OPENMP") + list(APPEND _MYSTRAN_STATIC_NAMES libsuperlu_mt_OPENMP.a) + + if(WIN32) + # On Windows the gomp runtime is force-linked as a static archive + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_GOMP) + list(APPEND _MYSTRAN_STATIC_NAMES libgomp.a) + endif() + elseif(PLAT STREQUAL "_PTHREAD") + list(APPEND _MYSTRAN_STATIC_NAMES libsuperlu_mt_PTHREAD.a) + endif() +else() + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_SUPERLU) + list(APPEND _MYSTRAN_STATIC_NAMES libsuperlu.a) +endif() + +if(TPL_ENABLE_METISLIB) + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_METIS) + list(APPEND _MYSTRAN_STATIC_NAMES libmetis.a) + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_GKLIB) + list(APPEND _MYSTRAN_STATIC_NAMES libGKlib.a) + + if(NOT WIN32) + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_REGEX) + + # only on linux because on windows we build embedded gkegex. + # no name because it's part of glibc. + endif() +endif() + +# Local BLAS functions are compiled directly into the binary when the +# system does not provide them; treat them as a bundled static object +if(MISSING_FNS_TOTAL GREATER 0) + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_BLAS) + list(APPEND _MYSTRAN_STATIC_NAMES libblas_local.a) +endif() + +# On Windows the -static linker flag pulls in Fortran and C runtimes too +if(WIN32) + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_GFORTRAN) + list(APPEND _MYSTRAN_STATIC_NAMES libgfortran.a) + list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_GCC) + list(APPEND _MYSTRAN_STATIC_NAMES libgcc.a) +endif() + +# Apply preprocessor definitions to the mystran compilation +foreach(_def IN LISTS _MYSTRAN_STATIC_DEFS) + target_compile_definitions(mystran PRIVATE ${_def}) +endforeach() + +# Print a human-readable summary at configure time +list(JOIN _MYSTRAN_STATIC_NAMES ", " _STATIC_NAMES_STR) +message(STATUS "Static libraries linked in: ${_STATIC_NAMES_STR}") + +# force some libraries +list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_LAPACK) +list(APPEND _MYSTRAN_STATIC_DEFS _STATIC_ARPACK) + +# ----------------------------------------------------------------------- +# License file associations +# +# Map each _STATIC_ suffix to a license file path (relative to +# PROJECT_SOURCE_DIR). CMake will: +# - define _STATIC__LICENSE for the Fortran preprocessor +# - generate a SUBROUTINE PRINT_LICENSE_(IUNIT) that writes the +# license text line-by-line to whatever unit number is passed in +# +# Add new entries here whenever a new statically-linked library is added. +# ----------------------------------------------------------------------- +set(_MYSTRAN_LICENSE_MAP + "F2C:f2c/Notice:libf2c:Fortran-to-C runtime support library" + "SUPERLU:superlu/License.txt:SuperLU:sparse solver" + "SUPERLU_MT:superlu_mt/License.txt:SuperLU_MT:multi-threaded sparse solver" + "METIS:metis/METIS/LICENSE:METIS:graph partitioner for SuperLU" + "GKLIB:metis/GKlib/LICENSE.txt:GKlib:utility library for METIS" + "BLAS:extra_licenses/blas-lapack.txt:BLAS:embedded subset of reference BLAS" + "LAPACK:extra_licenses/blas-lapack.txt:LAPACK:linear algebra library" + "ARPACK:extra_licenses/arpack.txt:ARPACK:Lanczos eigensolver implementation" + "GOMP:extra_licenses/gpl-3.0-with-gcc-exception.txt:libgomp:GNU OpenMP runtime" + "GFORTRAN:extra_licenses/gpl-3.0-with-gcc-exception.txt:libgfortran:GNU Fortran runtime" + "GCC:extra_licenses/gpl-3.0-with-gcc-exception.txt:libgcc:GNU C runtime" + "WINPTHREAD:extra_licenses/libwinpthread.txt:libwinpthread:Windows POSIX threads, used by SuperLU_MT" + "PTHREAD:extra_licenses/lgpl-2.1.txt:libpthread:POSIX threads, used by SuperLU_MT" + "REGEX:extra_licenses/lgpl-2.1.txt:libregex:POSIX regexes, used by GKlib" +) + +# Generate STATIC_LICENSES_GENERATED.F90 in the build directory +set(_GEN_LIC_FILE "${CMAKE_SOURCE_DIR}/INCLUDE/STATIC_LICENSES_GENERATED.F90.inc") +set(_GEN_LIC_CONTENT "! AUTO-GENERATED by CMakeLists.txt -- DO NOT EDIT\n") +set(_MYSTRAN_LICENSED_NAMES "") + +# ---- MYSTRAN's own license (always emitted, no #ifdef guard) ---- +set(_MYSTRAN_OWN_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE.txt") + +if(EXISTS "${_MYSTRAN_OWN_LICENSE}") + file(STRINGS "${_MYSTRAN_OWN_LICENSE}" _mlic_lines NEWLINE_CONSUME) + string(REPLACE "\n" ";" _mlic_lines "${_mlic_lines}") + string(APPEND _GEN_LIC_CONTENT + "\nSUBROUTINE PRINT_LICENSE_MYSTRAN(IUNIT)\n" + " IMPLICIT NONE\n" + " INTEGER, INTENT(IN) :: IUNIT\n" + ) + + foreach(_line IN LISTS _mlic_lines) + string(REPLACE "'" "''" _line_esc "${_line}") + string(REPLACE "\\" "\\\\" _line_esc "${_line_esc}") + string(APPEND _GEN_LIC_CONTENT + " WRITE(IUNIT,'(A)') '${_line_esc}'\n" + ) + endforeach() + + string(APPEND _GEN_LIC_CONTENT + "END SUBROUTINE PRINT_LICENSE_MYSTRAN\n" + ) +else() + message(WARNING "MYSTRAN license file not found: ${_MYSTRAN_OWN_LICENSE}") +endif() + +foreach(_entry IN LISTS _MYSTRAN_LICENSE_MAP) + string(REPLACE ":" ";" _pair "${_entry}") + list(GET _pair 0 _lname) + list(GET _pair 1 _lpath) + list(LENGTH _pair _pair_len) + + if(_pair_len GREATER 2) + list(GET _pair 2 _llibname) + else() + set(_llibname "${_lname}") + endif() + + if(_pair_len GREATER 3) + list(GET _pair 3 _ldesc) + else() + set(_ldesc "") + endif() + + set(_MYSTRAN_LIBNAME_${_lname} "${_llibname}") + set(_MYSTRAN_DESC_${_lname} "${_ldesc}") + set(_lfile "${PROJECT_SOURCE_DIR}/${_lpath}") + + if(EXISTS "${_lfile}") + # Read the license file line by line + file(STRINGS "${_lfile}" _lic_lines NEWLINE_CONSUME) + + # file(STRINGS) may return the whole file as one item when using + # NEWLINE_CONSUME; split on actual newlines ourselves + string(REPLACE "\n" ";" _lic_lines "${_lic_lines}") + + string(APPEND _GEN_LIC_CONTENT + "\nSUBROUTINE PRINT_LICENSE_${_lname}(IUNIT)\n" + " IMPLICIT NONE\n" + " INTEGER, INTENT(IN) :: IUNIT\n" + ) + + foreach(_line IN LISTS _lic_lines) + # Escape Fortran string delimiters: ' -> '' + string(REPLACE "'" "''" _line_esc "${_line}") + + # Escape backslashes that CMake would otherwise swallow + string(REPLACE "\\" "\\\\" _line_esc "${_line_esc}") + string(APPEND _GEN_LIC_CONTENT + " WRITE(IUNIT,'(A)') '${_line_esc}'\n" + ) + endforeach() + + string(APPEND _GEN_LIC_CONTENT + "END SUBROUTINE PRINT_LICENSE_${_lname}\n" + ) + + list(APPEND _MYSTRAN_LICENSED_NAMES "${_lname}") + else() + message(WARNING + "License file for _STATIC_${_lname} not found: ${_lfile}\n" + " '_STATIC_${_lname}_LICENSE' will NOT be defined." + ) + endif() +endforeach() + +# Append PRINT_ALL_LICENSES: MYSTRAN first, then delegates to each PRINT_LICENSE_* under its #ifdef guard +string(APPEND _GEN_LIC_CONTENT + "\nSUBROUTINE PRINT_ALL_LICENSES(IUNIT)\n" + " IMPLICIT NONE\n" + " INTEGER, INTENT(IN) :: IUNIT\n" + + # " WRITE(IUNIT,'(A)') '========================================================'\n" + # " WRITE(IUNIT,'(A)') ' MYSTRAN '\n" + " WRITE(IUNIT,'(A)') '========================================================'\n" + " CALL PRINT_LICENSE_MYSTRAN(IUNIT)\n" + " WRITE(IUNIT,'(A)') ' '\n" +) + +foreach(_lname IN LISTS _MYSTRAN_LICENSED_NAMES) + set(_llibname "${_MYSTRAN_LIBNAME_${_lname}}") + set(_ldesc "${_MYSTRAN_DESC_${_lname}}") + string(APPEND _GEN_LIC_CONTENT + "#ifdef _STATIC_${_lname}\n" + " WRITE(IUNIT,'(A)') '========================================================'\n" + " WRITE(IUNIT,'(A)') ' ${_llibname} -- ${_ldesc}'\n" + " WRITE(IUNIT,'(A)') '========================================================'\n" + " CALL PRINT_LICENSE_${_lname}(IUNIT)\n" + " WRITE(IUNIT,'(A)') ' '\n" + "#endif\n" + ) +endforeach() + +string(APPEND _GEN_LIC_CONTENT + "END SUBROUTINE PRINT_ALL_LICENSES\n" +) + +file(WRITE "${_GEN_LIC_FILE}" "${_GEN_LIC_CONTENT}") +message(STATUS "Generated license subroutines: ${_GEN_LIC_FILE}") + +# Warn if any statically-linked library lacks a license mapping. +# Runtime and utility libs with no separate OSS license file are exempt. +set(_LICENSE_EXEMPT_LIBS) + +foreach(_def IN LISTS _MYSTRAN_STATIC_DEFS) + string(REPLACE "_STATIC_" "" _lname "${_def}") + + if(NOT _lname IN_LIST _MYSTRAN_LICENSED_NAMES) + if(NOT _lname IN_LIST _LICENSE_EXEMPT_LIBS) + message(WARNING + "No license file is mapped for '${_def}'. " + "Add an entry to _MYSTRAN_LICENSE_MAP in CMakeLists.txt." + ) + endif() + endif() +endforeach() + if(CMAKE_COMPILER_IS_GNUCC) set(CMAKE_Fortran_FLAGS "-Wall -Wextra \ -Wno-unused-variable -Wno-unused-label -Wno-unused-parameter -Wno-tabs \ -Wno-compare-reals -Wno-character-truncation -Wno-unused-dummy-argument \ - -Wmaybe-uninitialized -Wrealloc-lhs -fbounds-check -fcheck=all") + -Wmaybe-uninitialized -Wrealloc-lhs -fbounds-check -fcheck=all \ + -ffree-line-length-none") set(CMAKE_Fortran_FLAGS_DEBUG "-g -O0 -fcheck=all -fbacktrace -fbounds-check \ -fno-inline -fno-ipa-sra -fno-ipa-cp -fno-optimize-sibling-calls") @@ -447,6 +734,145 @@ if(CMAKE_COMPILER_IS_GNUCC) set(CMAKE_SHARED_LINKER_FLAGS_PROFILING "") endif() +# ----------------------------------------------------------------------- +# Build metadata generated file +# +# Generates BUILD_INFO_GENERATED.F90.inc with: +# PRINT_BUILD_CONSTANTS(IUNIT) - timestamp, compiler, flags, solver info +# PRINT_STATIC_LIB_LIST(IUNIT) - names of all statically linked libraries +# ----------------------------------------------------------------------- + +# Build timestamp captured at configure time (local clock) +string(TIMESTAMP _BUILD_TIMESTAMP "%Y-%m-%d %H:%M:%S UTC" UTC) + +set(_BUILD_TYPE_DISPLAY "${CMAKE_BUILD_TYPE}") + +if(NOT _BUILD_TYPE_DISPLAY) + set(_BUILD_TYPE_DISPLAY "(not specified)") +endif() + +# Effective Fortran flags = base flags + build-type-specific flags +string(TOUPPER "${CMAKE_BUILD_TYPE}" _BT_UPPER) +set(_FC_FLAGS "${CMAKE_Fortran_FLAGS}") + +if(_BT_UPPER AND DEFINED CMAKE_Fortran_FLAGS_${_BT_UPPER}) + string(APPEND _FC_FLAGS " ${CMAKE_Fortran_FLAGS_${_BT_UPPER}}") +endif() + +string(REPLACE "\n" " " _FC_FLAGS "${_FC_FLAGS}") +string(REGEX REPLACE " +" " " _FC_FLAGS "${_FC_FLAGS}") +string(STRIP "${_FC_FLAGS}" _FC_FLAGS) +string(REPLACE "'" "''" _FC_FLAGS "${_FC_FLAGS}") + +# Effective C flags +set(_CC_FLAGS "${CMAKE_C_FLAGS}") + +if(_BT_UPPER AND DEFINED CMAKE_C_FLAGS_${_BT_UPPER}) + string(APPEND _CC_FLAGS " ${CMAKE_C_FLAGS_${_BT_UPPER}}") +endif() + +string(REPLACE "\n" " " _CC_FLAGS "${_CC_FLAGS}") +string(REGEX REPLACE " +" " " _CC_FLAGS "${_CC_FLAGS}") +string(STRIP "${_CC_FLAGS}" _CC_FLAGS) +string(REPLACE "'" "''" _CC_FLAGS "${_CC_FLAGS}") + +# Compiler identity strings +set(_FC_DISPLAY "${CMAKE_Fortran_COMPILER_ID} ${CMAKE_Fortran_COMPILER_VERSION}") +set(_CC_DISPLAY "${CMAKE_C_COMPILER_ID} ${CMAKE_C_COMPILER_VERSION}") +string(REPLACE "'" "''" _FC_PATH "${CMAKE_Fortran_COMPILER}") +string(REPLACE "'" "''" _CC_PATH "${CMAKE_C_COMPILER}") + +# Sparse solver variant +if(USE_SUPERLU_MT) + if(PLAT STREQUAL "_OPENMP") + set(_SLU_VARIANT "SuperLU_MT (OpenMP)") + else() + set(_SLU_VARIANT "SuperLU_MT (pthreads)") + endif() +else() + set(_SLU_VARIANT "SuperLU (single-threaded)") +endif() + +# BLAS source +if(BLAS_FOUND) + set(_BLAS_INFO "System BLAS: ${TPL_BLAS_LIBRARIES}") + string(REPLACE "'" "''" _BLAS_INFO "${_BLAS_INFO}") +elseif(MISSING_FNS_TOTAL GREATER 0) + set(_BLAS_INFO "CBLAS + built-in subset (${MISSING_FNS_TOTAL} routine(s) compiled in)") +else() + set(_BLAS_INFO "System BLAS") +endif() + +# METIS +if(TPL_ENABLE_METISLIB) + set(_METIS_INFO "Enabled") +else() + set(_METIS_INFO "Disabled") +endif() + +set(_GEN_BLD_FILE "${CMAKE_SOURCE_DIR}/INCLUDE/BUILD_INFO_GENERATED.F90.inc") +set(_GEN_BLD_CONTENT "! AUTO-GENERATED by CMakeLists.txt -- DO NOT EDIT\n") + +# PRINT_BUILD_CONSTANTS subroutine +string(APPEND _GEN_BLD_CONTENT + "\nSUBROUTINE PRINT_BUILD_CONSTANTS(IUNIT)\n" + " IMPLICIT NONE\n" + " INTEGER, INTENT(IN) :: IUNIT\n" + " WRITE(IUNIT,'(A)') ' '\n" + " WRITE(IUNIT,'(A)') ' Build information:'\n" + " WRITE(IUNIT,'(A)') ' ------------------'\n" + " WRITE(IUNIT,'(A)') ' Build date (UTC) : ${_BUILD_TIMESTAMP}'\n" + " WRITE(IUNIT,'(A)') ' CMake build type : ${_BUILD_TYPE_DISPLAY}'\n" + " WRITE(IUNIT,'(A)') ' '\n" + " WRITE(IUNIT,'(A)') ' Fortran compiler : ${_FC_DISPLAY}'\n" + " WRITE(IUNIT,'(A)') ' Fortran path : ${_FC_PATH}'\n" + " WRITE(IUNIT,'(A)') ' Fortran flags : ${_FC_FLAGS}'\n" + " WRITE(IUNIT,'(A)') ' '\n" + " WRITE(IUNIT,'(A)') ' C compiler : ${_CC_DISPLAY}'\n" + " WRITE(IUNIT,'(A)') ' C compiler path : ${_CC_PATH}'\n" + " WRITE(IUNIT,'(A)') ' C flags : ${_CC_FLAGS}'\n" + " WRITE(IUNIT,'(A)') ' '\n" + " WRITE(IUNIT,'(A)') ' Sparse solver : ${_SLU_VARIANT}'\n" + " WRITE(IUNIT,'(A)') ' BLAS : ${_BLAS_INFO}'\n" + " WRITE(IUNIT,'(A)') ' METIS partitioner : ${_METIS_INFO}'\n" + "END SUBROUTINE PRINT_BUILD_CONSTANTS\n" +) + +# PRINT_STATIC_LIB_LIST subroutine +string(APPEND _GEN_BLD_CONTENT + "\nSUBROUTINE PRINT_STATIC_LIB_LIST(IUNIT)\n" + " IMPLICIT NONE\n" + " INTEGER, INTENT(IN) :: IUNIT\n" + " WRITE(IUNIT,'(A)') ' Static libraries compiled into this MYSTRAN binary:'\n" + " WRITE(IUNIT,'(A)') ' ----------------------------------------------------'\n" +) + +foreach(_def IN LISTS _MYSTRAN_STATIC_DEFS) + string(REPLACE "_STATIC_" "" _suffix "${_def}") + set(_libname "${_MYSTRAN_LIBNAME_${_suffix}}") + set(_desc "${_MYSTRAN_DESC_${_suffix}}") + + if(NOT _libname) + set(_libname "${_def}") + set(_desc "(no description)") + endif() + + string(REPLACE "'" "''" _libname_esc "${_libname}") + string(REPLACE "'" "''" _desc_esc "${_desc}") + + string(APPEND _GEN_BLD_CONTENT + " WRITE(IUNIT,'(3X,A,T20,A)') '${_libname_esc}', '(${_desc_esc})'\n" + ) +endforeach() + +string(APPEND _GEN_BLD_CONTENT + " WRITE(IUNIT,'(A)') ' '\n" + "END SUBROUTINE PRINT_STATIC_LIB_LIST\n" +) + +file(WRITE "${_GEN_BLD_FILE}" "${_GEN_BLD_CONTENT}") +message(STATUS "Generated build-info subroutines: ${_GEN_BLD_FILE}") + # issue a couple messages about compilation include(ProcessorCount) ProcessorCount(NCPU) diff --git a/Source/Interfaces/PRINT_BUILD_INFO_Interface.f90 b/Source/Interfaces/PRINT_BUILD_INFO_Interface.f90 new file mode 100644 index 00000000..7ddf9e2e --- /dev/null +++ b/Source/Interfaces/PRINT_BUILD_INFO_Interface.f90 @@ -0,0 +1,37 @@ +! ############################################################################################################################### +! Begin MIT license text. +! _______________________________________________________________________________________________________ + +! Copyright 2022 Dr William R Case, Jr (mystransolver@gmail.com) + +! Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +! associated documentation files (the "Software"), to deal in the Software without restriction, including +! without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +! copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to +! the following conditions: + +! The above copyright notice and this permission notice shall be included in all copies or substantial +! portions of the Software and documentation. + +! THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +! OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +! FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +! AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +! LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +! THE SOFTWARE. +! _______________________________________________________________________________________________________ + +! End MIT license text. + +MODULE PRINT_BUILD_INFO_Interface + + INTERFACE + + SUBROUTINE PRINT_BUILD_INFO (PRINT_LICENSES) + LOGICAL, INTENT(IN) :: PRINT_LICENSES + END SUBROUTINE PRINT_BUILD_INFO + + END INTERFACE + +END MODULE PRINT_BUILD_INFO_Interface diff --git a/Source/MAIN/MYSTRAN.f90 b/Source/MAIN/MYSTRAN.f90 index 9cf14d0b..2a5ba474 100644 --- a/Source/MAIN/MYSTRAN.f90 +++ b/Source/MAIN/MYSTRAN.f90 @@ -117,6 +117,8 @@ PROGRAM MYSTRAN REAL(DOUBLE) :: TIME_END ! Time job is ended REAL(DOUBLE) :: TIME_START ! Time job is started REAL(DOUBLE) , ALLOCATABLE :: UG_NORM(:,:) ! Norm of UG_COL vector + CHARACTER(LEN=LEN(INFILE)) :: ARG1 ! First argument. Used to check for --notice + INTEGER(LONG) :: NC_ARG1 ! Number of characters in ARG1. ! ********************************************************************************************************************************** EPS1 = EPSIL(1) @@ -136,14 +138,26 @@ PROGRAM MYSTRAN CALL TIME_INIT -! Read data in initialization file, MYSTRAN.INI, if it exists. - - CALL READ_INI ( INI_EXIST ) - ! Write logo and copyright notice to screen. Then write MYSTRAN start time/date WRITE(SC1,117) PROG_NAME, MYSTRAN_VER_NUM, MYSTRAN_VER_MONTH, MYSTRAN_VER_DAY, MYSTRAN_VER_YEAR, MYSTRAN_AUTHOR +! Check for --notice and --licenses + + CALL READ_CL (ARG1, NC_ARG1) + IF (NC_ARG1 == 9 .AND. ARG1(1:9) == "--version") THEN + CALL PRINT_BUILD_INFO (.FALSE.) + STOP + END IF + IF (NC_ARG1 == 10 .AND. ARG1(1:10) == "--licenses") THEN + CALL PRINT_BUILD_INFO (.TRUE.) + STOP + END IF + +! Read data in initialization file, MYSTRAN.INI, if it exists. + + CALL READ_INI ( INI_EXIST ) + CALL OURTIM CALL OURDAT WRITE(SC1,150) MONTH, DAY, YEAR, HOUR, MINUTE, SEC, SFRAC @@ -160,6 +174,9 @@ PROGRAM MYSTRAN ! Read input data filename (from command line) and calc LEN_INPUT_FNAME. CALL READ_INPUT_FILE_NAME ( INI_EXIST ) + + + IF (RESTART == 'N') THEN LEN_RESTART_FNAME = LEN_INPUT_FNAME ENDIF @@ -436,7 +453,7 @@ PROGRAM MYSTRAN 111 FORMAT(/' Initialization file ',A,' does not exist. internal defaults will be used',/) - 117 FORMAT(/,1X,A,' Version',5(1X,A)) + 117 FORMAT(1X,A,' Version',5(1X,A)) 150 FORMAT(/,' >> MYSTRAN BEGIN : ',I2,'/',I2,'/',I4,' at ',I2,':',I2,':',I2,'.',I3,'. The input file is:') diff --git a/Source/MAIN/PRINT_BUILD_INFO.F90 b/Source/MAIN/PRINT_BUILD_INFO.F90 new file mode 100644 index 00000000..95abdb72 --- /dev/null +++ b/Source/MAIN/PRINT_BUILD_INFO.F90 @@ -0,0 +1,56 @@ +! ################################################################################################################################## +! Begin MIT license text. +! _______________________________________________________________________________________________________ + +! Copyright 2022 Dr William R Case, Jr (mystransolver@gmail.com) + +! Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +! associated documentation files (the "Software"), to deal in the Software without restriction, including +! without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +! copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to +! the following conditions: + +! The above copyright notice and this permission notice shall be included in all copies or substantial +! portions of the Software and documentation. + +! THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +! OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +! FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +! AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +! LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +! THE SOFTWARE. +! _______________________________________________________________________________________________________ + +! End MIT license text. + +SUBROUTINE PRINT_BUILD_INFO (PRINT_LICENSES) + + USE IOUNT1, ONLY: SC1 + IMPLICIT NONE + + LOGICAL, INTENT(IN) :: PRINT_LICENSES + +! Non-license case: build metadata (timestamp, compiler, flags, solver) +! followed by the list of statically-linked libraries. +! +! License case: full OSS license text for every bundled library. +! +! All PRINT_* helpers are auto-generated by CMakeLists.txt at configure +! time into Source/INCLUDE/BUILD_INFO_GENERATED.F90.inc and +! Source/INCLUDE/STATIC_LICENSES_GENERATED.F90.inc. + + IF (.NOT. PRINT_LICENSES) THEN + CALL PRINT_BUILD_CONSTANTS(SC1) + WRITE(SC1,'(A)') ' ' + CALL PRINT_STATIC_LIB_LIST(SC1) + WRITE(SC1,'(A)') ' To see licenses for MYSTRAN and embedded libraries use --licenses.' + WRITE(SC1,'(A)') ' ' + ELSE + CALL PRINT_ALL_LICENSES(SC1) + END IF + +END SUBROUTINE PRINT_BUILD_INFO + +#include +#include diff --git a/Source/MAIN/READ_INI.f90 b/Source/MAIN/READ_INI.f90 index 8365d434..ffcf8f64 100644 --- a/Source/MAIN/READ_INI.f90 +++ b/Source/MAIN/READ_INI.f90 @@ -1077,7 +1077,7 @@ SUBROUTINE WRITE_INIFIL_MSG ( WHICH_MSG, INIFIL_NAME_LEN ) ENDIF ! ********************************************************************************************************************************** - 1001 FORMAT(' Optional Initialization file: ',/,1X,A) + 1001 FORMAT(/,/' Optional Initialization file: ',/,1X,A) 2000 FORMAT(1X,A) diff --git a/Source/USE_IFs/MYSTRAN_USE_IFs.f90 b/Source/USE_IFs/MYSTRAN_USE_IFs.f90 index 808dae01..329abc37 100644 --- a/Source/USE_IFs/MYSTRAN_USE_IFs.f90 +++ b/Source/USE_IFs/MYSTRAN_USE_IFs.f90 @@ -56,5 +56,7 @@ MODULE MYSTRAN_USE_IFs USE CLOSE_OUTFILES_Interface USE CLOSE_LIJFILES_Interface USE VECTOR_NORM_Interface + USE PRINT_BUILD_INFO_Interface + USE READ_CL_Interface END MODULE MYSTRAN_USE_IFs diff --git a/extra_licenses/arpack.txt b/extra_licenses/arpack.txt new file mode 100644 index 00000000..11a7df56 --- /dev/null +++ b/extra_licenses/arpack.txt @@ -0,0 +1,35 @@ +BSD Software License + +Pertains to ARPACK and P_ARPACK + +Copyright (c) 1996-2008 Rice University. +Developed by D.C. Sorensen, R.B. Lehoucq, C. Yang, and K. Maschhoff. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +- Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +- Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer listed + in this license in the documentation and/or other materials + provided with the distribution. + +- Neither the name of the copyright holders nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/extra_licenses/blas-lapack.txt b/extra_licenses/blas-lapack.txt new file mode 100644 index 00000000..9b379c9e --- /dev/null +++ b/extra_licenses/blas-lapack.txt @@ -0,0 +1,48 @@ +Copyright (c) 1992-2013 The University of Tennessee and The University + of Tennessee Research Foundation. All rights + reserved. +Copyright (c) 2000-2013 The University of California Berkeley. All + rights reserved. +Copyright (c) 2006-2013 The University of Colorado Denver. All rights + reserved. + +$COPYRIGHT$ + +Additional copyrights may follow + +$HEADER$ + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +- Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +- Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer listed + in this license in the documentation and/or other materials + provided with the distribution. + +- Neither the name of the copyright holders nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +The copyright holders provide no reassurances that the source code +provided does not infringe any patent, copyright, or any other +intellectual property rights of third parties. The copyright holders +disclaim any liability to any recipient for claims brought against +recipient by any third party for infringement of that parties +intellectual property rights. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/extra_licenses/gpl-3.0-with-gcc-exception.txt b/extra_licenses/gpl-3.0-with-gcc-exception.txt new file mode 100644 index 00000000..9b3fee2c --- /dev/null +++ b/extra_licenses/gpl-3.0-with-gcc-exception.txt @@ -0,0 +1,744 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + +--- + +GCC RUNTIME LIBRARY EXCEPTION + +Version 3.1, 31 March 2009 + +Copyright © 2009 Free Software Foundation, Inc. + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +This GCC Runtime Library Exception ("Exception") is an additional permission +under section 7 of the GNU General Public License, version 3 ("GPLv3"). It +applies to a given file (the "Runtime Library") that bears a notice placed by +the copyright holder of the file stating that the file is governed by GPLv3 +along with this Exception. + +When you use GCC to compile a program, GCC may combine portions of certain GCC +header files and runtime libraries with the compiled program. The purpose of +this Exception is to allow compilation of non-GPL (including proprietary) +programs to use, in this way, the header files and runtime libraries covered by +this Exception. +0. Definitions. + +A file is an "Independent Module" if it either requires the Runtime Library for +execution after a Compilation Process, or makes use of an interface provided by +the Runtime Library, but is not otherwise based on the Runtime Library. + +"GCC" means a version of the GNU Compiler Collection, with or without +modifications, governed by version 3 (or a specified later version) of the GNU +General Public License (GPL) with the option of using any subsequent versions +published by the FSF. + +"GPL-compatible Software" is software whose conditions of propagation, +modification and use would permit combination with GCC in accord with the +license of GCC. + +"Target Code" refers to output from any compiler for a real or virtual target +processor architecture, in executable form or suitable for input to an +assembler, loader, linker and/or execution phase. Notwithstanding that, Target +Code does not include data in any format that is used as a compiler intermediate +representation, or used for producing a compiler intermediate representation. + +The "Compilation Process" transforms code entirely represented in +non-intermediate languages designed for human-written code, and/or in Java +Virtual Machine byte code, into Target Code. Thus, for example, use of source +code generators and preprocessors need not be considered part of the Compilation +Process, since the Compilation Process can be understood as starting with the +output of the generators or preprocessors. + +A Compilation Process is "Eligible" if it is done using GCC, alone or with other +GPL-compatible software, or if it is done without using any work based on GCC. +For example, using non-GPL-compatible Software to optimize any GCC intermediate +representations would not qualify as an Eligible Compilation Process. + +1. Grant of Additional Permission. + +You have permission to propagate a work of Target Code formed by combining the +Runtime Library with Independent Modules, even if such propagation would +otherwise violate the terms of GPLv3, provided that all Target Code was +generated by Eligible Compilation Processes. You may then convey such a +combination under terms of your choice, consistent with the licensing of the +Independent Modules. + +2. No Weakening of GCC Copyleft. + +The availability of this Exception does not imply any general presumption that +third-party software is unaffected by the copyleft requirements of the license +of GCC. diff --git a/extra_licenses/lgpl-2.1.txt b/extra_licenses/lgpl-2.1.txt new file mode 100644 index 00000000..f6683e74 --- /dev/null +++ b/extra_licenses/lgpl-2.1.txt @@ -0,0 +1,501 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, see . + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Moe Ghoul, President of Vice + +That's all there is to it! diff --git a/extra_licenses/libwinpthread.txt b/extra_licenses/libwinpthread.txt new file mode 100644 index 00000000..35077012 --- /dev/null +++ b/extra_licenses/libwinpthread.txt @@ -0,0 +1,57 @@ +Copyright (c) 2011 mingw-w64 project + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +/* + * Parts of this library are derived by: + * + * Posix Threads library for Microsoft Windows + * + * Use at own risk, there is no implied warranty to this code. + * It uses undocumented features of Microsoft Windows that can change + * at any time in the future. + * + * (C) 2010 Lockless Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * + * * Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * * Neither the name of Lockless Inc. nor the names of its contributors may be + * used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AN + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE + * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ diff --git a/metis/gklib_patches/CMakeLists.txt b/metis/gklib_patches/CMakeLists.txt new file mode 100644 index 00000000..56594de0 --- /dev/null +++ b/metis/gklib_patches/CMakeLists.txt @@ -0,0 +1,254 @@ +cmake_minimum_required(VERSION 3.10) + +# ... +project(GKlib + VERSION 0.0.1 + LANGUAGES C) + +# include required CMake modules +include(CheckCCompilerFlag) +include(CheckCSourceCompiles) +include(CheckFunctionExists) +include(CheckIncludeFile) +include(CMakePackageConfigHelpers) +include(GNUInstallDirs) + +# force C99 because GKLib redefines true and false +set(CMAKE_C_STANDARD 99) + +# ------------------------------------------------------------------------------- +# OPTIONS +# ------------------------------------------------------------------------------- +option(ASSERT "turn asserts on" OFF) +option(ASSERT2 "additional assertions" OFF) +option(DEBUG "add debugging support" OFF) +option(GPROF "add gprof support" OFF) +option(GDB "add gdb support" OFF) +option(GKRAND "enable GKRAND support" OFF) +option(GKREGEX "enable GKREGEX support" OFF) +option(OPENMP "enable OpenMP support" OFF) +option(PCRE "enable PCRE support" OFF) +option(VALGRID "enable valgrind support" OFF) +option(NO_X86 "enable no-x86 support" OFF) +option(SHARED "enable shared support" OFF) + +if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) + option(GKLIB_BUILD_APPS "build the GKlib applications" ON) +else() + option(GKLIB_BUILD_APPS "build the GKlib applications" OFF) +endif() + +# Configure libmetis library. +if(SHARED) + set(GKLIB_LIBRARY_TYPE SHARED) +else() + set(GKLIB_LIBRARY_TYPE STATIC) +endif(SHARED) + +# ------------------------------------------------------------------------------- +# LIBRARY configuration +# ------------------------------------------------------------------------------- +add_library(${PROJECT_NAME} ${GKLIB_LIBRARY_TYPE}) + +target_sources(${PROJECT_NAME} + PRIVATE src/b64.c src/blas.c src/cache.c src/csr.c src/error.c src/evaluate.c + src/fkvkselect.c src/fs.c src/getopt.c src/gk_util.c src/gkregex.c + src/graph.c src/htable.c src/io.c src/itemsets.c src/mcore.c + src/memory.c src/pqueue.c src/random.c src/rw.c src/seq.c src/sort.c + src/string.c src/timers.c src/tokenizer.c + + # these are only included below so that they appear when using IDEs + include/GKlib.h include/gk_arch.h include/gk_defs.h + include/gk_externs.h include/gk_getopt.h include/gk_macros.h + include/gk_mkblas.h include/gk_mkmemory.h include/gk_mkpqueue.h + include/gk_mkpqueue2.h include/gk_mkrandom.h include/gk_mksort.h + include/gk_mkutils.h include/gk_proto.h include/gk_struct.h + include/gk_types.h include/gkregex.h include/gk_ms_inttypes.h + include/gk_ms_stat.h include/gk_ms_stdint.h + + # the following are shims for win32 systems + $<$:src/win32/adapt.c + include/win32/adapt.h>) + +target_compile_definitions(${PROJECT_NAME} + PUBLIC $<$:LINUX> + $<$:_POSIX_C_SOURCE=200809L>) + +target_include_directories(${PROJECT_NAME} + PUBLIC $ + $<$:$> + $) + +target_link_libraries(${PROJECT_NAME} + PUBLIC $<$>:m>) + +set_target_properties(${PROJECT_NAME} PROPERTIES + POSITION_INDEPENDENT_CODE ON + SOVERSION ${PROJECT_VERSION_MAJOR} + VERSION ${PROJECT_VERSION}) + +add_library(GKlib::GKlib ALIAS ${PROJECT_NAME}) + +# ------------------------------------------------------------------------------- +# OPTIONS configuration +# ------------------------------------------------------------------------------- +target_compile_definitions(${PROJECT_NAME} + PUBLIC $<$>:NDEBUG> + $<$>:NDEBUG2> + $<$:DEBUG> + $<$:GKRAND> + $<$:NO_X86> +) + +# ------------------------------------------------------------------------------- +# FEATURE AVAILABILITY checks +# ------------------------------------------------------------------------------- +check_include_file(execinfo.h HAVE_EXECINFO_H) +check_function_exists(getline HAVE_GETLINE) + +# regular expressions +if(PCRE) + check_include_file(pcreposix.h HAVE_PCREPOSIX_H) + + if(NOT HAVE_PCREPOSIX_H) + message(WARNING "PCRE was requested, but is not available") + endif() +endif() + +if(NOT HAVE_PCREPOSIX_H) + if(WIN32) + # MinGW ships regex.h but the implementations (regcomp/regexec/etc.) are not + # available without a third-party library. Force GKlib's bundled regex instead. + set(HAVE_REGEX_H FALSE) + set(USE_GKREGEX ON) + else() + check_include_file(regex.h HAVE_REGEX_H) + + if(NOT HAVE_REGEX_H) + set(USE_GKREGEX ON) + endif() + endif() +endif() + +# profiling support +if(GPROF) + check_c_compiler_flag("-pg" HAVE_GPROF_SUPPORT) + + if(NOT HAVE_GPROF_SUPPORT) + message(WARNING "GPROF support was requested, but is not available") + endif() +endif() + +# profiling support +if(GDB|DEBUG) + check_c_compiler_flag("-g" HAVE_GDB_SUPPORT) + + if(NOT HAVE_GDB_SUPPORT) + message(WARNING "GDB support was requested, but is not available") + endif() +endif() + +# openmp support +if(OPENMP) + find_package(OpenMP) + + if(NOT OpenMP_C_FOUND) + message(WARNING "OpenMP was requested, but is not available") + endif() +endif() + +# thread local storage +if(NOT DEFINED HAVE_TLS) + set(TLS_NAME "" CACHE INTERNAL "Thread local keyword") + + foreach(tls_name "__thread" "__declspec(thread)") + unset(HAVE_TLS CACHE) + check_c_source_compiles("${tls_name} int x; int main(void) { return 0; }" + HAVE_TLS) + + if(HAVE_TLS) + set(TLS_NAME ${tls_name} CACHE INTERNAL "Thread local keyword") + break() + else() + endif() + endforeach() +endif() + +target_compile_definitions(${PROJECT_NAME} + PUBLIC $<$:HAVE_EXEC_INFO_H> + $<$:USE_PCRE> + $<$,$>:HAVE_PCREPOSIX_H> + $<$:HAVE_REGEX_H> + $<$:USE_GKREGEX> + $<$:HAVE_GETLINE> + __thread=${TLS_NAME}) + +target_compile_options(${PROJECT_NAME} + PUBLIC $<$,$>:-pg>) + +target_compile_options(${PROJECT_NAME} + PUBLIC $<$,$>,$>:-g>) + +target_compile_options(${PROJECT_NAME} + PUBLIC $<$,$>>:-O3>) + +target_link_libraries(${PROJECT_NAME} + PUBLIC $<$:OpenMP::OpenMP_C>) + +# ------------------------------------------------------------------------------- +# APPS configuration +# ------------------------------------------------------------------------------- +if(GKLIB_BUILD_APPS) + add_subdirectory("apps") +endif() + +# ------------------------------------------------------------------------------- +# PACKAGE configuration +# ------------------------------------------------------------------------------- +# generate files +configure_package_config_file(GKlibConfig.cmake.in cmake/GKlibConfig.cmake + INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/GKlib) + +write_basic_package_version_file(cmake/GKlibConfigVersion.cmake + VERSION ${PROJECT_VERSION} + COMPATIBILITY SameMajorVersion) + +# install library +install(TARGETS ${PROJECT_NAME} EXPORT GKlibTargets + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + COMPONENT GKlib_Runtime + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + COMPONENT GKlib_Runtime + NAMELINK_SKIP + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + COMPONENT GKlib_Development + INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) + +# The previous install() command is repeated here to distinguish installations +# that include a namelink versus those that do not. Unfortunately, prior to +# CMake 3.12, when the NAMELINK_COMPONENT property was introduced, this was +# necessary to get the desired behavior. +if(SHARED) + install(TARGETS ${PROJECT_NAME} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + COMPONENT GKlib_Development + NAMELINK_ONLY) +endif() + +# install header files +install(DIRECTORY "${CMAKE_SOURCE_DIR}/include/" + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} + COMPONENT GKlib_Development) + +# install files necessary to use find_package() with GKlib +install(EXPORT GKlibTargets + FILE GKlibTargets.cmake + NAMESPACE GKlib:: + DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/GKlib + COMPONENT GKlib_Development) + +install( + FILES ${CMAKE_CURRENT_BINARY_DIR}/cmake/GKlibConfig.cmake + ${CMAKE_CURRENT_BINARY_DIR}/cmake/GKlibConfigVersion.cmake + DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/GKlib + COMPONENT GKlib_Development) diff --git a/metis/metis_patches/CMakeLists.txt b/metis/metis_patches/CMakeLists.txt index d0e12e72..ea563095 100644 --- a/metis/metis_patches/CMakeLists.txt +++ b/metis/metis_patches/CMakeLists.txt @@ -42,8 +42,21 @@ endif() set(METIS_GENERATED_INCLUDE_DIR "${CMAKE_CURRENT_BINARY_DIR}/include") file(MAKE_DIRECTORY "${METIS_GENERATED_INCLUDE_DIR}") file(READ "${CMAKE_CURRENT_SOURCE_DIR}/include/metis.h" _metis_public_header) -file(WRITE "${METIS_GENERATED_INCLUDE_DIR}/metis.h" +set(_metis_generated_header "#define IDXTYPEWIDTH ${_metis_idxwidth}\n#define REALTYPEWIDTH ${_metis_realwidth}\n${_metis_public_header}") +set(_metis_needs_write TRUE) + +if(EXISTS "${METIS_GENERATED_INCLUDE_DIR}/metis.h") + file(READ "${METIS_GENERATED_INCLUDE_DIR}/metis.h" _metis_existing_header) + + if(_metis_existing_header STREQUAL _metis_generated_header) + set(_metis_needs_write FALSE) + endif() +endif() + +if(_metis_needs_write) + file(WRITE "${METIS_GENERATED_INCLUDE_DIR}/metis.h" "${_metis_generated_header}") +endif() # Add include directories. # i.e., the -I equivalent diff --git a/superlu_patches/CMakeLists.txt b/superlu_patches/CMakeLists.txt new file mode 100644 index 00000000..5db5e79e --- /dev/null +++ b/superlu_patches/CMakeLists.txt @@ -0,0 +1,278 @@ +# Required version +cmake_minimum_required(VERSION 3.12) + +# Project Version +project(SuperLU C) +set(VERSION_MAJOR "7") +set(VERSION_MINOR "0") +set(VERSION_BugFix "1") +set(PROJECT_VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_BugFix}) + +# Compatibility to xSDK standard +# (Extreme-scale Scientific Software Development Kit) +# +# MESSAGE("\nProcess XSDK defaults ...") +# SET(USE_XSDK_DEFAULTS_DEFAULT TRUE) # Set to false if desired +# INCLUDE("cmake/XSDKDefaults.cmake") +set(USE_XSDK_DEFAULTS TRUE) + +# The XSDK standard does not allow using internally built BLAS +if(NOT "${enable_internal_blaslib}" STREQUAL "") + if(USE_XSDK_DEFAULTS) + set(enable_blaslib_xSDK OFF) + else() + set(enable_blaslib_xSDK ON) + endif() +else() + set(enable_blaslib_xSDK ${enable_internal_blaslib}) +endif() + +if(NOT "${enable_fortran}" STREQUAL "") + if(XSDK_ENABLE_Fortran) + set(enable_fortran_xSDK ON) + else() + set(enable_fortran_xSDK OFF) + endif() +else() + set(enable_fortran_xSDK ${enable_fortran}) +endif() + +# set up options +option(enable_internal_blaslib "Build the CBLAS library" ${enable_blaslib_xSDK}) +option(enable_single "Enable single precision library" ON) +option(enable_double "Enable double precision library" ON) +option(enable_complex "Enable single precision complex library" ON) +option(enable_complex16 "Enable double precision complex (complex16) library" ON) +option(enable_matlabmex "Build the Matlab mex library" OFF) +option(enable_doc "Add target 'doc' to build Doxygen documentation" OFF) +option(enable_examples "Build examples" ON) +option(enable_fortran "Build Fortran interface" ${enable_fortran_xSDK}) +option(enable_tests "Build tests" ON) +option(enable_compatibility_complex "Provide typdef 'complex' for compatibility with older SuperLU version" OFF) + +include(CTest) +include(GNUInstallDirs) +include(FeatureSummary) + +# ##################################################################### +# +# Usual initialization stuff +# +# ##################################################################### + +# set C standard to C99 without GNU extensions, if not specified by the user +if("${CMAKE_C_STANDARD}" STREQUAL "") + set(CMAKE_C_STANDARD 99) +endif() + +if("${CMAKE_C_EXTENSIONS}" STREQUAL "") + set(CMAKE_C_EXTENSIONS FALSE) +endif() + +# ---- set RPATH handling +# use, i.e. don't skip the full RPATH for the build tree +set(CMAKE_SKIP_BUILD_RPATH FALSE) + +# when building, don't use the install RPATH already +# (but later on when installing) +set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE) + +# the RPATH to be used when installing +set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib") + +# add the automatically determined parts of the RPATH +# which point to directories outside the build tree to the install RPATH +set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) + +set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) + +# ---- For shared library +if(BUILD_SHARED_LIBS) + message("-- SuperLU will be built as a shared library.") + set(PROJECT_NAME_LIB_EXPORT libsuperlu.so) +else() + message("-- SuperLU will be built as a static library.") + set(PROJECT_NAME_LIB_EXPORT libsuperlu.a) +endif() + +enable_language(C) + +if(enable_fortran) + enable_language(Fortran) +endif() + +set(SUPERLU_VERSION "${PROJECT_VERSION}") +set(SUPERLU_REV "${PROJECT_REV}") + +if(enable_compatibility_complex) + add_compile_definitions(SUPERLU_TYPEDEF_COMPLEX) +endif() + +# -- BLAS +option(TPL_ENABLE_INTERNAL_BLASLIB "Build the CBLAS library" ${enable_internal_blaslib}) +option(TPL_BLAS_LIBRARIES "List of absolute paths to blas libraries [].") + +# -- METIS +option(TPL_ENABLE_METISLIB "Build the METIS library" OFF) +option(TPL_METIS_LIBRARIES "List of absolute paths to METIS link libraries [].") +option(TPL_METIS_INCLUDE_DIRS "List of absolute paths to METIS include directories [].") + +# setup required compiler defines and options. +# # get_directory_property( DirDefs COMPILE_DEFINITIONS ) +# set(CMAKE_C_FLAGS "-DPRNTlevel=0 -DDEBUGlevel=0 ${CMAKE_C_FLAGS}") +set(CMAKE_C_FLAGS_RELEASE "-O3" CACHE STRING "") + +if(XSDK_INDEX_SIZE EQUAL 64) + message("-- Using 64 bit integer for index size.") +endif() + +if(MSVC) + add_compile_definitions(NOMINMAX _COMPLEX_DEFINED) + + # suppress compiler warnings that sprintf and similar functions are unsafe (e.g. C4996) + add_compile_definitions(_CRT_SECURE_NO_WARNINGS) +endif() + +# ##################################################################### +# +# Find packages +# +# ##################################################################### +# +# --------------------- BLAS --------------------- +if(NOT enable_internal_blaslib) + if(TPL_BLAS_LIBRARIES) + set(BLAS_FOUND TRUE) + else() + find_package(BLAS) + + if(BLAS_FOUND) + set(TPL_BLAS_LIBRARIES "${BLAS_LIBRARIES}" CACHE FILEPATH + "Set from FindBLAS.cmake BLAS_LIBRARIES." FORCE) + endif() + endif() +endif() + +if(BLAS_FOUND) + message("-- Using TPL_BLAS_LIBRARIES='${TPL_BLAS_LIBRARIES}'") + set(CMAKE_C_FLAGS "-DUSE_VENDOR_BLAS ${CMAKE_C_FLAGS}") + set(BLAS_LIB ${TPL_BLAS_LIBRARIES}) + + # fix up BLAS library name + string(REPLACE ";" " " BLAS_LIB_STR "${BLAS_LIB}") + set(BLAS_LIB_EXPORT ${BLAS_LIB_STR}) +else() + message("-- Did not find or specify BLAS so configure to build internal CBLAS ...") + add_subdirectory(CBLAS) + set(BLAS_LIB blas) + + if(BUILD_SHARED_LIBS) # export to be referenced by downstream makefile + set(BLAS_LIB_EXPORT ${CMAKE_INSTALL_PREFIX}/CBLAS/libblas.so) + else() + set(BLAS_LIB_EXPORT ${CMAKE_INSTALL_PREFIX}/CBLAS/libblas.a) + endif() +endif() + +# --------------------- METIS --------------------- +if(TPL_ENABLE_METISLIB) # # want to use metis + if(NOT TPL_METIS_LIBRARIES) + message(FATAL_ERROR "TPL_METIS_LIBRARIES option should be set for METIS support to be enabled.") + endif() + + if(NOT TPL_METIS_INCLUDE_DIRS) + message(FATAL_ERROR "TPL_METIS_INCLUDE_DIRS option be set for METIS support to be enabled.") + endif() + + foreach(dir ${TPL_METIS_INCLUDE_DIRS}) + if(NOT MINGW AND NOT EXISTS ${dir}) + message(FATAL_ERROR "METIS include directory not found: ${dir}") + endif() + + set(CMAKE_C_FLAGS "-I${dir} ${CMAKE_C_FLAGS}") + endforeach() + + message("-- Enabled support for METIS.") + set(METIS_FOUND TRUE) + + set(METIS_LIB ${TPL_METIS_LIBRARIES}) + + # fix up METIS library names + string(REPLACE ";" " " METIS_LIB_STR "${METIS_LIB}") + set(METIS_LIB_EXPORT ${METIS_LIB_STR}) +else() + message("-- Will not link with METIS.") +endif() + +if(TPL_ENABLE_METISLIB AND NOT METIS_FOUND) + find_package(METIS) + + if(METIS_FOUND) + set(METIS_LIB METIS::METIS) + set(TPL_METIS_INCLUDE_DIRS "") + endif() +endif() + +if(METIS_FOUND) + set(HAVE_METIS TRUE) +endif() + +if(MSVC) + find_package(WinGetOpt) +endif() + +# ##################################################################### +# +# Include directories +# +# ##################################################################### +include_directories(${CMAKE_BINARY_DIR}/SRC) # For superlu_config.h + +if(TPL_METIS_INCLUDE_DIRS) + include_directories(${TPL_METIS_INCLUDE_DIRS}) # # metis +endif() + +# Generate various configure files with proper definitions + +# file(WRITE "make.defs" "# can be exposed to users" +# ${CMAKE_C_COMPILER} ) +# configure_file(${CMAKE_SOURCE_DIR}/make.inc.in ${CMAKE_SOURCE_DIR}/make.inc) +configure_file(${SuperLU_SOURCE_DIR}/make.inc.in ${SuperLU_SOURCE_DIR}/make.inc) + +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/superlu.pc.in ${CMAKE_CURRENT_BINARY_DIR}/superlu.pc @ONLY) +install(FILES ${CMAKE_CURRENT_BINARY_DIR}/superlu.pc + DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) + +configure_file(${SuperLU_SOURCE_DIR}/SRC/superlu_config.h.in ${SuperLU_BINARY_DIR}/SRC/superlu_config.h) +configure_file(${SuperLU_SOURCE_DIR}/SRC/superlu_config.h.in ${SuperLU_SOURCE_DIR}/SRC/superlu_config.h) + +# Following is to configure a header file for FORTRAN code +configure_file(${SuperLU_SOURCE_DIR}/SRC/superlu_config.h.in ${SuperLU_BINARY_DIR}/FORTRAN/superlu_config.h) + +# ##################################################################### +# +# Add subdirectories +# +# ##################################################################### +add_subdirectory(SRC) + +# if(enable_matlabmex) +# add_subdirectory(MATLAB) +# endif() + +# if(enable_tests) +# enable_testing() +# add_subdirectory(TESTING) +# endif() +add_custom_target(examples) + +if(enable_fortran) + add_subdirectory(FORTRAN) +endif() + +# add_subdirectory(EXAMPLE) + +# To work around CMake bug #18708 that got fixed in 3.28.0, for +# older CMake disable finding Doxygen unless explicitly enabled +# if (enable_doc OR (CMAKE_VERSION VERSION_GREATER_EQUAL "3.28.0")) +# add_subdirectory(DOC) +# endif()