Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reentrancy and thread-safety #346

Closed
Tracked by #349
dschlaep opened this issue Feb 20, 2023 · 0 comments
Closed
Tracked by #349

Reentrancy and thread-safety #346

dschlaep opened this issue Feb 20, 2023 · 0 comments
Assignees
@dschlaep @N1ckP3rsl3y
Labels
closed_and_not_yet_released enhancement
Milestone
Release v7.1.0

Comments

@dschlaep
Copy link
Member

dschlaep commented Feb 20, 2023 •
edited
Loading

Convert SOILWAT2 to be reentrant and thread-safe

For instance:

  • global variables, e.g., SW_Weather, SW_Site

    • replace with variables local to main() (SW_Main.c, sw_maintest.cc, etc.)
    • consider a new "meta-"/"super-" struct that holds all these currently global variables
    • pass by reference as function arguments

  • functions that return a pointer to static data, e.g., DirName()

  • module-level local variables

    • replace with function-level local variable, e.g., MyFilename
    • move to a new/existing struct and create instance in main() (see section "global variables"), e.g., memoized_G_o

  • "static const" variables should not be a problem per se

  • "static" functions should not be a problem per se

this is not an exhaustive list
@dschlaep dschlaep mentioned this issue Apr 3, 2023
Merged
1 task
@dschlaep dschlaep mentioned this issue Jun 5, 2023
Merged
2 tasks
@dschlaep dschlaep added this to the Release v7.1.0 milestone Jun 5, 2023
@dschlaep dschlaep mentioned this issue Jun 9, 2023
Merged
1 task
dschlaep added a commit that referenced this issue Aug 4, 2023
@dschlaep
Merge pull request #351 from DrylandEcology/release/devel_v7.1.0
2c5900d 
Development for v7.1.0

* Simulation output remains the same as the previous version.

* Prepare for SOILWAT2 to become thread-safe and reentrant (#346; @N1ckP3rsl3y)
    * Definition clarifications
        * Thread-safe - Multiple threads (a future SOILWAT2 development)
          will not influence each other unintentionally. Here, we implemented
          structures to enable thread-local storage, i.e., each thread operates
          on local data structures or with static data.
        * Reentrant - The ability to correctly execute any part of the program
          by multiple threads simultaneously but independently from others.
    * All non-static variables are replaced by local variables;
      functions gained arguments to pass local variables by reference
      (replacing global variables).
    * New main abstract types
        * SW_ALL - Contains the existing structures that are relevant
          for the simulation itself, e.g., SW_MODEL, SW_SOILWAT, SW_WEATHER.
        * PATH_INFO - Holds information about location of input and output data,
          e.g., directories, file paths to input data.
        * SW_OUTPUT_POINTERS - Points to requested output subroutines.
        * LOG_INFO - Manages information for logging warnings and errors.

* Tests now require `c++14` and utilize `googletest` `v1.14.0` (issue #339).

* Bugfixes
    * Fix an error where a pointer was freed even though it was not allocated
      (issue #356; @dschlaep).
    * Fix memory leak in test of `SW_VPD_construct()` (issue #205; @dschlaep).

Changes to inputs
* The output separator `OUTSEP` has been unused since the switch (`v4.0.0`)
  from writing free-form text files to `"csv"` spreadsheets
  (where the separator is fixed to a comma); the occurrence of
  `OUTSEP` in `"outsetup.in"` is now deprecated and triggers a warning.
@dschlaep dschlaep mentioned this issue Oct 16, 2023
Merged
dschlaep added a commit that referenced this issue Oct 24, 2023
@dschlaep
Merge pull request #372 from DrylandEcology/release/devel_v7.2.0
5b236ec 
Release/devel v7.2.0

* SOILWAT2 now handles errors more gracefully (#346; @N1ckP3rsl3y, @dschlaep).
    * Code no longer crashes on error immediately (except for STEPWAT2).
    * Code stores messages of warnings and error status.
    * All functions now check for errors and return early
      (after cleaning up memory).

* SOILWAT2 now defines its own structure for random numbers (#373; @dschlaep).
  This allows to hide implementation details, i.e., STEPWAT2 will no
  longer need to interact directly with `pcg` and rSOILWAT2 will no longer
  depend on `pcg` which it never has used.

* New `sw_strtok()` is thread-safe and replaces not thread-safe `strtok()`
  (#376; @N1ckP3rsl3y).

* Obsolete code in DEBUG_MEM* sections is removed (#369; @dschlaep).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dschlaep dschlaep

@N1ckP3rsl3y N1ckP3rsl3y

Labels
closed_and_not_yet_released enhancement
Projects
None yet
Milestone
Release v7.1.0
Development

No branches or pull requests
2 participants
@dschlaep @N1ckP3rsl3y