Skip to content

Logger safe async io #245

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

Merged
merged 14 commits into from
Nov 26, 2020
Merged

Logger safe async io #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
716d2f5
Fixed minor formatting of output
wclodius2 Nov 16, 2020
1fa3a3e
Added logger to the index
wclodius2 Nov 16, 2020
d1f143e
Documented changes in the stdlib_logger.f90 API
wclodius2 Nov 16, 2020
3fdcb73
Typo fixes and thread/asynchronous IO safety.
wclodius2 Nov 16, 2020
786aaa4
Fixed indexing and unused variables
wclodius2 Nov 16, 2020
cbb80a5
Merge remote-tracking branch 'upstream/master' into logger-safe-async-io
milancurcic Nov 16, 2020
0b17754
Update src/stdlib_logger.f90
jvdp1 Nov 17, 2020
42f60df
Update doc/specs/stdlib_logger.md
jvdp1 Nov 17, 2020
92cfe4c
Apply suggestions from code review
jvdp1 Nov 17, 2020
0b95dbb
Apply suggestions from code review
jvdp1 Nov 17, 2020
5e68920
Fixed up log_error and log_io_error
wclodius2 Nov 17, 2020
0853039
Documented attempt to make code thread and asynchronous I/O safe
wclodius2 Nov 24, 2020
381c3fe
Revised discussion of thread safety
wclodius2 Nov 24, 2020
e5bc47f
Merge remote-tracking branch 'origin/master' into logger-safe-async-io
wclodius2 Nov 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/specs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This is and index/directory of the specifications (specs) for each new module/fe
- [error](./stdlib_error.html) - Catching and handling errors
- [IO](./stdlib_io.html) - Input/output helper & convenience
- [linalg](./stdlib_linalg.html) - Linear Algebra
- [logger](./stdlib_logger.html) - Runtime logging system
- [optval](./stdlib_optval.html) - Fallback value for optional arguments
- [quadrature](./stdlib_quadrature.html) - Numerical integration
- [stats](./stdlib_stats.html) - Descriptive Statistics
Expand Down
64 changes: 41 additions & 23 deletions doc/specs/stdlib_logger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ The logger variables have the option to:
* indent subsequent lines of the messages; and
* format the text to fit within a maximum column width.

While every effort has been made to make the code process and
asynchronous I/O safe, it is always best to have each process write to
its own dedicated logger file.
For thread parallelism (e.g., with OpenMP), it is advised to put the
logger call in a guarding region (e.g., in an OpenMP critical region).

Comment on lines +37 to +42
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@milancurcic
Are you satisfied with this note that covers multi-thread and multi-process programs? If yes, I am ok to merge this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'm happy with it so I'll go ahead and merge. Thank you all.

Note: Loggers of type `logger_type` normally report their messages to I/O
units in the internal list termed `log_units`. However if `log_units`
is empty then the messages go to the `output_unit` of the intrinsic
Expand Down Expand Up @@ -75,14 +81,16 @@ significant events encountered during the execution of a program.

### Private attributes

| Attribute | Type | Description | Initial value
|------------------|---------------|-------------------------------------------------|--------------
| `add_blank_line` | Logical | Flag to precede output with a blank line | `.false.`
| `indent_lines` | Logical | Flag to indent subsequent lines by four columns | `.true.`
| `log_units` | Integer array | List of I/O units used for output | empty
| `max_width` | Integer | Maximum column width of output | 0
| `time_stamp` | Logical | Flag to precede output by a time stamp | `.true.`
| `units` | Integer | Count of the number of active output units | 0
| Attribute | Type | Description | Initial value |
|------------------|---------------|-------------------------------------------------|--------------|
| `add_blank_line` | Logical | Flag to precede output with a blank line | `.false.` |
| `buffer` | Character(:) | Buffer to build output string | Unallocated |
| `indent_lines` | Logical | Flag to indent subsequent lines by four columns | `.true.` |
| `len_buffer` | Integer | Number of valid characters in buffer | 0 |
| `log_units` | Integer array | List of I/O units used for output | Unallocated |
| `max_width` | Integer | Maximum column width of output | 0 |
| `time_stamp` | Logical | Flag to precede output by a time stamp | `.true.` |
| `units` | Integer | Count of the number of active output units | 0 |

## The `stdlib_logger` variable

Expand Down Expand Up @@ -285,7 +293,7 @@ Pure subroutine

#### Arguments

`self`: shall be a scalar variable of type `logger_type`. It is an
`self`: shall be a scalar expression of type `logger_type`. It is an
`intent(in)` argument. It shall be the logger whose configuration is reported.

`add_blank_line` (optional): shall be a scalar default logical
Expand Down Expand Up @@ -416,11 +424,13 @@ Subroutine

#### Arguments

`self`: shall be a scalar expression of type `logger_type`. It is an
`intent(in)` argument. It is the logger used to send the message.
`self`: shall be a scalar variable of type `logger_type`. It is an
`intent(inout)` argument. It is the logger used to send the message.

`message`: shall be a scalar default character expression. It is an
`intent(in)` argument.
`intent(in)` argument.

* Note `message` may have embedded new_line calls.

`module` (optional): shall be a scalar default character
expression. It is an `intent(in)` argument. It should be the name of
Expand Down Expand Up @@ -497,12 +507,14 @@ Subroutine

#### Arguments

`self`: shall be a scalar expression of type `logger_type`. It is an
`intent(in)` argument. It is the logger used to send the message.
`self`: shall be a scalar variable of type `logger_type`. It is an
`intent(inout)` argument. It is the logger used to send the message.

`message`: shall be a scalar default character expression. It is an
`intent(in)` argument.

* Note `message` may have embedded new_line calls.

`module` (optional): shall be a scalar default character
expression. It is an `intent(in)` argument. It should be the name of
the module containing the `log_information` call.
Expand Down Expand Up @@ -566,12 +578,14 @@ written.
Subroutine

#### Arguments
`self`: shall be a scalar expression of type `logger_type`. It is an
`intent(in)` argument. It is the logger used to send the message.
`self`: shall be a scalar variable of type `logger_type`. It is an
`intent(inout)` argument. It is the logger used to send the message.

`message`: shall be a scalar default character expression. It is an
`intent(in)` argument.

* Note `message` may have embedded new_line calls.

`module` (optional): shall be a scalar default character
expression. It is an `intent(in)` argument. It should be the name of
the module containing the `log_io_error` call.
Expand Down Expand Up @@ -642,12 +656,14 @@ Subroutine

#### Arguments

`self`: shall be a scalar expression of type `logger_type`. It is an
`intent(in)` argument. It is the logger used to send the message.
`self`: shall be a scalar variable of type `logger_type`. It is an
`intent(inout)` argument. It is the logger used to send the message.

`message`: shall be a scalar default character expression. It is an
`intent(in)` argument.

* Note `message` may have embedded new_line calls.

`module` (optional): shall be a scalar default character
expression. It is an `intent(in)` argument. It should be the name of
the module containing the `log_message` call.
Expand Down Expand Up @@ -716,8 +732,8 @@ Subroutine

#### Arguments

`self`: shall be a scalar expression of type `logger_type`. It is an
`intent(in)` argument. It is the logger used to send the message.
`self`: shall be a scalar variable of type `logger_type`. It is an
`intent(inout)` argument. It is the logger used to send the message.

`line`: shall be a scalar default character expression. It is an
`intent(in)` argument. It should be the line of text in which the
Expand Down Expand Up @@ -862,12 +878,14 @@ Subroutine

#### Arguments

`self`: shall be a scalar expression of type `logger_type`. It is an
`intent(in)` argument. It is the logger used to send the message.
`self`: shall be a scalar variable of type `logger_type`. It is an
`intent(inout)` argument. It is the logger used to send the message.

`message`: shall be a scalar default character expression. It is an
`intent(in)` argument.

* Note `message` may have embedded new_line calls.

`module`: (optional) shall be a scalar default character
expression. It is an `intent(in)` argument. It should be the name of
the module containing the `log_warning` call.
Expand Down Expand Up @@ -925,7 +943,7 @@ Subroutine

#### Arguments

`self`: shall be a scalar expression of type `logger_type`. It is an
`self`: shall be a scalar variable of type `logger_type`. It is an
`intent(inout)` argument. It is the logger whose `log_units` is to be
modified.

Expand Down
Loading