Is it safe for more than one goroutine to print to stdout?
Asked Answered
G

3

49

I have multiple goroutines in my program, each of which makes calls to fmt.Println without any explicit synchronization. Is this safe (i.e., will each line appear separately without data corruption), or do I need to create another goroutine with synchronization specifically to handle printing?

Goblin answered 4/2, 2013 at 19:31 Comment(3)
It seems it's not totally guaranteed safe : groups.google.com/forum/?fromgroups=#!msg/golang-nuts/…Coligny
Are you using more than one thread? Have you set GOMAXPROCS > 1?Rebound
I have not, but I'd like to know if what I'm doing is threadsafe in the general case.Goblin
T
29

No it's not safe even though you may not sometimes observe any troubles. IIRC, the fmt package tries to be on the safe side, so probably intermixing of some sort may occur but no process crash, hopefully.

This is an instance of a more universal Go documentation rule: Things are not safe for concurrent access unless specified otherwise or where obvious from context.

One can have a safe version of a nice subset of fmt.Print* functionality using the log package with some small initial setup.

Taylor answered 4/2, 2013 at 20:6 Comment(2)
with some small initial setup means what?Edora
It means you have to setup a new logger instance with the wanted Writer etc. For more info read the docs golang.org/pkg/log/#NewPerceive
E
19

Everything fmt does falls back to w.Write() as can be seen here. Because there's no locking around it, everything falls back to the implementation of Write(). As there is still no locking (for Stdout at least), there is no guarantee your output will not be mixed.

I'd recommend using a global log routine.

Furthermore, if you simply want to log data, use the log package, which locks access to the output properly. See the implementation for reference.

Epigastrium answered 4/2, 2013 at 20:3 Comment(3)
Well, it does seem like most things in fmt builds the string in an internal buffer, and call Write() once for each call to fmt.XXX - which will end up in one native write() call, which should be atomicAndrocles
There is a buffer object, pp, yes. But I don't see where the call to Write is locked, which is necessary for this to be thread safe.Epigastrium
@nos, IIUC write(2) is only atomic for the amount of bytes the device driver (or the underlying software stack) accepted. I mean, you might need several calls to write all your data, and in this case interleaving might occur naturally.Ardyce
M
13

The common methods (fmt.printLine) are not safe. However, there are methods that are.

log.Logger is "goroutine safe": https://golang.org/pkg/log/#Logger

Something like this will create a stdout logger that can be used from any go routine safely.

logger := log.New(os.Stdout, "", 0)

Mechling answered 10/4, 2017 at 15:38 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.