[jira] [Created] (FLINK-17723) Written design for flink threading model and guarantees made to the various structual components

["John Lonergan (Jira)" <ji...@apache.org>]

John Lonergan created FLINK-17723:
-------------------------------------

             Summary: Written design for flink threading model and guarantees made to the various structual components
                 Key: FLINK-17723
                 URL: https://issues.apache.org/jira/browse/FLINK-17723
             Project: Flink
          Issue Type: Improvement
          Components: Documentation
            Reporter: John Lonergan


Do we have a written design for the threading model including the guarantees made by the core framework in terms of threading and concurrency.

Looking at various existing components such as JDBC and file sinks and other non-core facilities.

Having some difficulty understanding the intended design.

Want to understand the assumptions I can make about when certain functions will be called (for example JDBCOutputFormat  open vs flush vs writeRecord vs close) and whether this will always be from the same thread or some other thread, or whether they might be called concurrently, in order to verify the correctness of the code. 

What guarantees are there?

Does a certain reference need a volatile or even a synchronisation or not.

What's the design for threading?

If the intended design is not written down then we have to infer it from the code and we will definitiely come to different conclusions and thus bugs and leaks. and other avoidable horrors.

It's really hard writing good MT code and a strong design is necessary to provide a framework for the code.

Some info here https://flink.apache.org/contributing/code-style-and-quality-common.html#concurrency-and-threading , but this isn't a design and doesn't say how it's meant to work. However that page does agree that writing MT code is very hard and this just underlines the need for a strong and detailed design for this aspect. 

==

Another supporting example. 
When I see code like this ...

```
FileOutputFormat
    
   public void close() throws IOException {
		final FSDataOutputStream s = this.stream;
		if (s != null) {
			this.stream = null;
			s.close();
		}
	}
```

My feeling is that someone else wasn't sure what the right approach was.

I can only guess that the author was concerned that someone else was going to call the function concurrently, or mess with the class state by some other means. And, if that were true then would this code even be MT safe - who knows? Ought there be a volatile in there or a plain old sync or perhaps none of the caution is needed at all (framework guarantees preventing the need).

I find if worrying that I see a lot of code in the project that is similarly uncertain and inconsistent.




--
This message was sent by Atlassian Jira
(v8.3.4#803005)