Shifting toward C99

From Mpich
Jump to: navigation, search

Motivating reasons

  • Third party components are shifting to C99.
hwloc is required in MPICH and it requires C99.
ucx is optional in MPICH and it requires C99.
libfabric is optional in MPICH and it requires C99.
CH4 device requires either ucx or libfabric.
  • C99 requirement simplifies portability burden.
    • <stdbool.h>, <stdint.h>, <complex.h>
    • restrict pointers and inline functions
    • __VA_ARGS__
  • C99 allows better code readability
    • declaring variables close to its context
    • defining loop variables within the loop syntax
  • While we are looking at C99, certain features in C11 are also quite attractive:
    • Static assertions
    • Anonymous structures and unions

Potential impact

The main concern of shifting to C99 is that certain platforms with absent or less-complete C99 compiler support will not be able to build MPICH.

Reference compiler quirks page for the status of compiler support.

MPICH specific C99 features

Even as we shifting to C99 requirement, we are not opening the flood gate to allow all C99 features into the codebase. The full support of C99 features may put unnecessary restrictions on compilers. By limiting allowed C99 features, we intend to support as many compilers as we can. In addition, even when certain feature may not be supported by a particular compiler, the limited feature allowance may still provide feasible path for back porting.

The standardized data type support -- stdbool.h, stdint.h, complex.h -- are in. These features can be tested by configure and worked around with portability libraries; however, with growing code base, inconsistency in the portablity handling can creep in. Requiring minimum C99 support can greatly simplify the code.

Mixing variable declarations and code are case dependent. In general, we prefers to have variables all declared at the top of scope. However, for temporary variables that are only meaningful over partial code scope, we would like to have them defined where they are being used.

We generally prefer loop variables defined in the for-loop line, as they will have no context outside the loop.

We still prefer C block comments. C++ style inline comments do not bring more readability other than save on typing.

C99 feature compiler matrix

C99 feature list:

  • inline
  • restrict
  • __func__
  • in-code variable declaration
  • for-loop variable declaration
  • single-line comment
  • bool in stdbool.h
  • stdint.h
  • variadic macro
  • compound literal
  • designated initialization
  • flexible last array member in structure
  • snprintf

Tested compilers (with `-O2` for inline to work):

  • gcc-4.7.2 (debian-7): All pass. Requires `-std=c99` for "for-loop variable declaration" and "restrict".
  • gcc-7.3.0 (ubuntu-18.04): All pass.
  • clang-3.4 (ubuntu-14.04): All pass. Requires `-std=c99` for "for-loop variable declaration" and "restrict".
  • clang (MacOS Mojave): All pass.
  • pgcc (16.9): All pass.
  • icc (17.0): All pass. Requires `-std=c99` for "for-loop variable declaration" and "restrict".
  • xlc (16.1.1): All pass.

Following compilers we do not officially support:

  • Microsoft Visual Studio 2017 (cl ver.19.16): Mostly pass. `restrict` keyword is not recognized.